Maintenance windows environment API
This API is deprecated. Use the Settings API with the Maintenance windows (builtin:alerting.maintenance-window) schema instead.
Dynatrace uses maintenance windows to ensure accurate monitoring data during planned maintenance of your systems.
The Maintenance windows API enables you to use 3rd party tools to manage maintenance windows and downtimes within a monitored environment. You can:
- Get all the maintenance windows in your environment with the GET all maintenance windows call.
- Create or update a maintenance window with the POST a maintenance window call.
- List the details of a specific maintenance window with the GET a maintenance window call.
- Delete a specific maintenance window with the DELETE a maintenance window call.
GET all maintenance windows
Lists all maintenance windows (and their parameters) available in your Dynatrace environment.
The request produces an application/json payload.
| GET | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v1/maintenance |
| Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/maintenance |
Authentication
To execute this request, you need an access token with MaintenanceWindows scope.
To learn how to obtain and use it, see Tokens and authentication.
The start timestamp of the inquiry timeframe, in UTC milliseconds.
If not set, the current time is used.
The end timestamp of the inquiry timeframe, in UTC milliseconds.
If not set, all maintenance windows beginning after the from timestamp will be returned.
The type of the maintenance window to return.
If Unknown or not set, all maintenance windows are returned.
PlannedUnknownUnplanned
The returns an array of such objects, each representing a maintenance window.
Response codes
Response body objects
The ResponseBody object
The MaintenanceWindow object
Parameters of the maintenance window.
A short description of the maintenance purpose.
The ID of the maintenance window.
An object defining date, time, and recurrence of the maintenance window.
An object defining the scope of your maintenance window.
You can specify particular Dynatrace entities or matching rules for dynamic formation of the scope.
If no scope is specified, the maintenance applies to the entire environment.
To specify the scope at least one entity or matching rule must be specified.
Alerting during maintenance is enabled (false) or disabled (true).
Problem detection during maintenance is enabled (false) or disabled (true).
The type of the maintenance: planned or unplanned.
PlannedUnplanned
The MaintenanceWindowSchedule object
An object defining date, time, and recurrence of the maintenance window.
The end date and time of the maintenance window in the yyyy-MM-dd HH:mm format.
The start date and time of the maintenance window in the yyyy-MM-dd HH:mm format.
The time zone of the start and end time. Default time zone is UTC.
You can user either UTC offset UTC+01:00 format or the IANA Time Zone Database format.
Recurrence of the schedule.
DayMonthOnceWeek
The MaintenanceWindowRecurrence object
The recurrence of the maintenance window.
The day of the week for weekly maintenance.
The format is the full name of the day in upper case, for example WEDNESDAY.
FRIDAYMONDAYSATURDAYSUNDAYTHURSDAYTUESDAYWEDNESDAY
The day of the month for monthly maintenance.
The duration of the maintenance window in minutes.
The start time of the maintenance window. The format is HH:mm.
The MaintenanceWindowScope object
An object defining the scope of your maintenance window.
You can specify particular Dynatrace entities or matching rules for dynamic formation of the scope.
If no scope is specified, the maintenance applies to the entire environment.
To specify the scope at least one entity or matching rule must be specified.
Defines Dynatrace entities to be included in scope, for example hosts, services, process groups.
Allowed values are Dynatrace entity IDs.
An object defining a matching rule for dynamic scope formation. An empty rule matches for all entities.
The MonitoredEntityFilter object
Filters monitored entities by their type/tags.
The tag you want to use for matching.
You can use custom tags from the UI, AWS tags, Cloud Foundry tags, OpenShift/Kubernetes, and tags based on environment variables.
The type of the Dynatrace entities (for example, hosts or services) you want to pick up by matching.
APM_SECURITY_GATEWAYAPPLICATIONAPPLICATION_METHODAPPLICATION_METHOD_GROUPAPPMON_SERVERAPPMON_SYSTEM_PROFILEAUTO_SCALING_GROUPAUXILIARY_SYNTHETIC_TESTAWS_APPLICATION_LOAD_BALANCERAWS_AVAILABILITY_ZONEAWS_CREDENTIALSAWS_LAMBDA_FUNCTIONAWS_NETWORK_LOAD_BALANCERAZURE_API_MANAGEMENT_SERVICEAZURE_APPLICATION_GATEWAYAZURE_APP_SERVICE_PLANAZURE_COSMOS_DBAZURE_CREDENTIALSAZURE_EVENT_HUBAZURE_EVENT_HUB_NAMESPACEAZURE_FUNCTION_APPAZURE_IOT_HUBAZURE_LOAD_BALANCERAZURE_MGMT_GROUPAZURE_REDIS_CACHEAZURE_REGIONAZURE_SERVICE_BUS_NAMESPACEAZURE_SERVICE_BUS_QUEUEAZURE_SERVICE_BUS_TOPICAZURE_SQL_DATABASEAZURE_SQL_ELASTIC_POOLAZURE_SQL_SERVERAZURE_STORAGE_ACCOUNTAZURE_SUBSCRIPTIONAZURE_TENANTAZURE_VMAZURE_VM_SCALE_SETAZURE_WEB_APPBROWSERCF_APPLICATIONCF_FOUNDATIONCINDER_VOLUMECLOUD_APPLICATIONCLOUD_APPLICATION_INSTANCECLOUD_APPLICATION_NAMESPACECLOUD_NETWORK_INGRESSCLOUD_NETWORK_POLICYCONTAINER_GROUPCONTAINER_GROUP_INSTANCECUSTOM_APPLICATIONCUSTOM_DEVICECUSTOM_DEVICE_GROUPDCRUM_APPLICATIONDCRUM_SERVICEDCRUM_SERVICE_INSTANCEDEVICE_APPLICATION_METHODDEVICE_APPLICATION_METHOD_GROUPDISKDOCKER_CONTAINER_GROUPDOCKER_CONTAINER_GROUP_INSTANCEDYNAMO_DB_TABLEEBS_VOLUMEEC2_INSTANCEELASTIC_LOAD_BALANCERENVIRONMENTEXTERNAL_SYNTHETIC_TEST_STEPGCP_ZONEGEOLOCATIONGEOLOC_SITEGOOGLE_COMPUTE_ENGINEHOSTHOST_GROUPHTTP_CHECKHTTP_CHECK_STEPHYPERVISORHYPERVISOR_CLUSTERHYPERVISOR_DISKKUBERNETES_CLUSTERKUBERNETES_NODEKUBERNETES_SERVICEMOBILE_APPLICATIONMULTIPROTOCOL_MONITORNETWORK_INTERFACENEUTRON_SUBNETOPENSTACK_PROJECTOPENSTACK_REGIONOPENSTACK_VMOSPROCESS_GROUPPROCESS_GROUP_INSTANCEQUEUEQUEUE_INSTANCERELATIONAL_DATABASE_SERVICES3BUCKETSERVICESERVICE_INSTANCESERVICE_METHODSERVICE_METHOD_GROUPSWIFT_CONTAINERSYNTHETIC_LOCATIONSYNTHETIC_TESTSYNTHETIC_TEST_STEPVCENTERVIRTUALMACHINEVMWARE_DATACENTER
The UniversalTag object
The origin of the tag, such as AWS or Cloud Foundry. For custom tags use the CONTEXTLESS value.
The context is set for tags that are automatically imported by OneAgent (for example, from the AWS console or environment variables). It’s useful for determining the origin of tags when not manually defined, and it also helps to prevent clashes with other existing tags. If the tag is not automatically imported, CONTEXTLESS set.
AWSAWS_GENERICAZURECLOUD_FOUNDRYCONTEXTLESSENVIRONMENTGOOGLE_COMPUTE_ENGINEKUBERNETES
The key of the tag. For custom tags, put the tag value here.
The key allows categorization of multiple tags. It is possible that there are multiple values for a single key which will all be represented as standalone tags. Therefore, the key does not have the semantic of a map key but is more like a key of a key-value tuple. In some cases, for example custom tags, the key represents the actual tag value and the value field is not set – those are called valueless tags.
The value of the tag. Not applicable to custom tags.
If a tag does have a separate key and value (in the textual representation they are split by the colon ‘:’), this field is set with the actual value. Key-value pairs can occur for automatically imported tags and tags set by rules if extractors are used.
The UniversalTagKey object
AWSAWS_GENERICAZURECLOUD_FOUNDRYCONTEXTLESSENVIRONMENTGOOGLE_COMPUTE_ENGINEKUBERNETES
Response body JSON model
[{"description": "string","id": "string","schedule": {"maintenanceEnd": "string","maintenanceStart": "string","recurrence": {"day": "FRIDAY","dayOfMonth": 1,"duration": 1,"start": "string"},"timezoneId": "string","type": "Day"},"scope": {"entities": ["string"],"matches": [{"tags": [{"context": "AWS","key": "string","tagKey": {"context": "AWS","key": "string"},"value": "string"}],"type": "APM_SECURITY_GATEWAY"}]},"suppressAlerts": true,"suppressProblems": true,"type": "Planned"}]
In this example, the request queries all maintenance windows of the mySampleEnv environment.
Curl
curl -L -H "Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890" \"https://mySampleEnv.live.dynatrace.com/api/v1/maintenance"
Request URL
GET https://mySampleEnv.live.dynatrace.com/api/v1/maintenance?api-token=abcdefjhij1234567890
Response content
[{"id": "easyTravelDeployment","type": "Planned","description": "Monthly deployment of easyTravel update","suppressAlerts": true,"suppressProblems": false,"scope": {"entities": ["HOST-8CA800CE840E20E8"],"matches": [{"type": "PROCESS_GROUP","tags": [{"context": "CONTEXTLESS","key": "easyTravel"}]}]},"schedule": {"type": "Month","timezoneId": "Europe/Vienna","maintenanceStart": "2018-05-01 00:00","maintenanceEnd": "2018-10-01 00:00","recurrence": {"dayOfMonth": 8,"start": "01:00","duration": 90}}},{"id": "Planned maintenance works","type": "Planned","description": "","suppressAlerts": true,"suppressProblems": true,"scope": null,"schedule": {"type": "Once","timezoneId": "UTC","maintenanceStart": "2018-05-13 10:00","maintenanceEnd": "2018-10-01 12:00"}}]
Response code
200
POST a maintenance window
Creates or updates a maintenance window.
The request consumes an application/json payload.
| POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v1/maintenance |
| Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/maintenance |
Authentication
To execute this request, you need an access token with MaintenanceWindows scope.
To learn how to obtain and use it, see Tokens and authentication.
Request body objects
The MaintenanceWindow object
Parameters of the maintenance window.
A short description of the maintenance purpose.
The ID of the maintenance window.
An object defining date, time, and recurrence of the maintenance window.
An object defining the scope of your maintenance window.
You can specify particular Dynatrace entities or matching rules for dynamic formation of the scope.
If no scope is specified, the maintenance applies to the entire environment.
To specify the scope at least one entity or matching rule must be specified.
Alerting during maintenance is enabled (false) or disabled (true).
Problem detection during maintenance is enabled (false) or disabled (true).
The type of the maintenance: planned or unplanned.
PlannedUnplanned
The MaintenanceWindowSchedule object
An object defining date, time, and recurrence of the maintenance window.
The end date and time of the maintenance window in the yyyy-MM-dd HH:mm format.
The start date and time of the maintenance window in the yyyy-MM-dd HH:mm format.
The time zone of the start and end time. Default time zone is UTC.
You can user either UTC offset UTC+01:00 format or the IANA Time Zone Database format.
Recurrence of the schedule.
DayMonthOnceWeek
The MaintenanceWindowRecurrence object
The recurrence of the maintenance window.
The day of the week for weekly maintenance.
The format is the full name of the day in upper case, for example WEDNESDAY.
FRIDAYMONDAYSATURDAYSUNDAYTHURSDAYTUESDAYWEDNESDAY
The day of the month for monthly maintenance.
The duration of the maintenance window in minutes.
The start time of the maintenance window. The format is HH:mm.
The MaintenanceWindowScope object
An object defining the scope of your maintenance window.
You can specify particular Dynatrace entities or matching rules for dynamic formation of the scope.
If no scope is specified, the maintenance applies to the entire environment.
To specify the scope at least one entity or matching rule must be specified.
Defines Dynatrace entities to be included in scope, for example hosts, services, process groups.
Allowed values are Dynatrace entity IDs.
An object defining a matching rule for dynamic scope formation. An empty rule matches for all entities.
The MonitoredEntityFilter object
Filters monitored entities by their type/tags.
The tag you want to use for matching.
You can use custom tags from the UI, AWS tags, Cloud Foundry tags, OpenShift/Kubernetes, and tags based on environment variables.
The type of the Dynatrace entities (for example, hosts or services) you want to pick up by matching.
APM_SECURITY_GATEWAYAPPLICATIONAPPLICATION_METHODAPPLICATION_METHOD_GROUPAPPMON_SERVERAPPMON_SYSTEM_PROFILEAUTO_SCALING_GROUPAUXILIARY_SYNTHETIC_TESTAWS_APPLICATION_LOAD_BALANCERAWS_AVAILABILITY_ZONEAWS_CREDENTIALSAWS_LAMBDA_FUNCTIONAWS_NETWORK_LOAD_BALANCERAZURE_API_MANAGEMENT_SERVICEAZURE_APPLICATION_GATEWAYAZURE_APP_SERVICE_PLANAZURE_COSMOS_DBAZURE_CREDENTIALSAZURE_EVENT_HUBAZURE_EVENT_HUB_NAMESPACEAZURE_FUNCTION_APPAZURE_IOT_HUBAZURE_LOAD_BALANCERAZURE_MGMT_GROUPAZURE_REDIS_CACHEAZURE_REGIONAZURE_SERVICE_BUS_NAMESPACEAZURE_SERVICE_BUS_QUEUEAZURE_SERVICE_BUS_TOPICAZURE_SQL_DATABASEAZURE_SQL_ELASTIC_POOLAZURE_SQL_SERVERAZURE_STORAGE_ACCOUNTAZURE_SUBSCRIPTIONAZURE_TENANTAZURE_VMAZURE_VM_SCALE_SETAZURE_WEB_APPBROWSERCF_APPLICATIONCF_FOUNDATIONCINDER_VOLUMECLOUD_APPLICATIONCLOUD_APPLICATION_INSTANCECLOUD_APPLICATION_NAMESPACECLOUD_NETWORK_INGRESSCLOUD_NETWORK_POLICYCONTAINER_GROUPCONTAINER_GROUP_INSTANCECUSTOM_APPLICATIONCUSTOM_DEVICECUSTOM_DEVICE_GROUPDCRUM_APPLICATIONDCRUM_SERVICEDCRUM_SERVICE_INSTANCEDEVICE_APPLICATION_METHODDEVICE_APPLICATION_METHOD_GROUPDISKDOCKER_CONTAINER_GROUPDOCKER_CONTAINER_GROUP_INSTANCEDYNAMO_DB_TABLEEBS_VOLUMEEC2_INSTANCEELASTIC_LOAD_BALANCERENVIRONMENTEXTERNAL_SYNTHETIC_TEST_STEPGCP_ZONEGEOLOCATIONGEOLOC_SITEGOOGLE_COMPUTE_ENGINEHOSTHOST_GROUPHTTP_CHECKHTTP_CHECK_STEPHYPERVISORHYPERVISOR_CLUSTERHYPERVISOR_DISKKUBERNETES_CLUSTERKUBERNETES_NODEKUBERNETES_SERVICEMOBILE_APPLICATIONMULTIPROTOCOL_MONITORNETWORK_INTERFACENEUTRON_SUBNETOPENSTACK_PROJECTOPENSTACK_REGIONOPENSTACK_VMOSPROCESS_GROUPPROCESS_GROUP_INSTANCEQUEUEQUEUE_INSTANCERELATIONAL_DATABASE_SERVICES3BUCKETSERVICESERVICE_INSTANCESERVICE_METHODSERVICE_METHOD_GROUPSWIFT_CONTAINERSYNTHETIC_LOCATIONSYNTHETIC_TESTSYNTHETIC_TEST_STEPVCENTERVIRTUALMACHINEVMWARE_DATACENTER
The UniversalTag object
The origin of the tag, such as AWS or Cloud Foundry. For custom tags use the CONTEXTLESS value.
The context is set for tags that are automatically imported by OneAgent (for example, from the AWS console or environment variables). It’s useful for determining the origin of tags when not manually defined, and it also helps to prevent clashes with other existing tags. If the tag is not automatically imported, CONTEXTLESS set.
AWSAWS_GENERICAZURECLOUD_FOUNDRYCONTEXTLESSENVIRONMENTGOOGLE_COMPUTE_ENGINEKUBERNETES
The key of the tag. For custom tags, put the tag value here.
The key allows categorization of multiple tags. It is possible that there are multiple values for a single key which will all be represented as standalone tags. Therefore, the key does not have the semantic of a map key but is more like a key of a key-value tuple. In some cases, for example custom tags, the key represents the actual tag value and the value field is not set – those are called valueless tags.
The value of the tag. Not applicable to custom tags.
If a tag does have a separate key and value (in the textual representation they are split by the colon ‘:’), this field is set with the actual value. Key-value pairs can occur for automatically imported tags and tags set by rules if extractors are used.
The UniversalTagKey object
AWSAWS_GENERICAZURECLOUD_FOUNDRYCONTEXTLESSENVIRONMENTGOOGLE_COMPUTE_ENGINEKUBERNETES
Request body JSON model
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"description": "string","id": "string","schedule": {"maintenanceEnd": "string","maintenanceStart": "string","recurrence": {"day": "FRIDAY","dayOfMonth": 1,"duration": 1,"start": "string"},"timezoneId": "string","type": "Day"},"scope": {"entities": ["string"],"matches": [{"tags": [{"context": "AWS","key": "string","tagKey": {"context": "AWS","key": "string"},"value": "string"}],"type": "APM_SECURITY_GATEWAY"}]},"suppressAlerts": true,"suppressProblems": true,"type": "Planned"}
A successful request doesn't return any content.
In this example, the request creates the planned easyTravelDeployment maintenance window, which happens every 8th day of month between 01:00 and 02:30 am. It applies to host entity HOST-1A2B3C4E5F6G7H8I and all process groups that have the easyTravel tag. During the maintenance window, problems are detected but alerts are not triggered.
Curl
curl -L -H "Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890" \-H "Content-Type: application/json" \"https://mySampleEnv.live.dynatrace.com/api/v1/maintenance" \-d "{\"id\":\"easyTravelDeployment\",\"type\":\"Planned\",\"description\":\"Monthly deployment of easyTravel update\",\"suppressAlerts\":true,\"suppressProblems\":false,\"scope\":{\"entities\":[\"HOST-1A2B3C4E5F6G7H8I\"],\"matches\":[{\"type\":\"PROCESS_GROUP\",\"tags\":[{\"context\":\"CONTEXTLESS\",\"key\":\"easyTravel\"}]}]},\"schedule\":{\"type\":\"Month\",\"timezoneId\":\"Europe/Vienna\",\"maintenanceStart\":\"2018-05-0100:00\",\"maintenanceEnd\":\"2018-10-0100:00\",\"recurrence\":{\"dayOfMonth\":8,\"start\":\"01:00\",\"duration\":90}}}";
Request URL
POST https://mySampleEnv.live.dynatrace.com/api/v1/maintenance
Request body
{"id": "easyTravelDeployment","type": "Planned","description": "Monthly deployment of easyTravel update","suppressAlerts": true,"suppressProblems": false,"scope": {"entities": ["HOST-1A2B3C4E5F6G7H8I"],"matches": [{"type": "PROCESS_GROUP","tags": [{"context": "CONTEXTLESS","key": "easyTravel"}]}]},"schedule": {"type": "Month","timezoneId": "Europe/Vienna","maintenanceStart": "2018-05-01 00:00","maintenanceEnd": "2018-10-01 00:00","recurrence": {"dayOfMonth": 8,"start": "01:00","duration": 90}}}
Response code
204
GET a maintenance window
Lists all parameters of a maintenance window. You can also get the list of all maintenance windows (and their parameters) available in your Dynatrace environment.
The request produces an application/json payload.
| GET | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v1/maintenance/{uid} |
| Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/maintenance/{uid} |
Authentication
To execute this request, you need an access token with MaintenanceWindows scope.
To learn how to obtain and use it, see Tokens and authentication.
The ID of the required maintenance window.
The request for a particular maintenance window returns a JSON object containing all parameters of the maintenance window.
The request for all available maintenance windows returns an array of such objects.
Response codes
Response body objects
The MaintenanceWindow object
Parameters of the maintenance window.
A short description of the maintenance purpose.
The ID of the maintenance window.
An object defining date, time, and recurrence of the maintenance window.
An object defining the scope of your maintenance window.
You can specify particular Dynatrace entities or matching rules for dynamic formation of the scope.
If no scope is specified, the maintenance applies to the entire environment.
To specify the scope at least one entity or matching rule must be specified.
Alerting during maintenance is enabled (false) or disabled (true).
Problem detection during maintenance is enabled (false) or disabled (true).
The type of the maintenance: planned or unplanned.
PlannedUnplanned
The MaintenanceWindowSchedule object
An object defining date, time, and recurrence of the maintenance window.
The end date and time of the maintenance window in the yyyy-MM-dd HH:mm format.
The start date and time of the maintenance window in the yyyy-MM-dd HH:mm format.
The time zone of the start and end time. Default time zone is UTC.
You can user either UTC offset UTC+01:00 format or the IANA Time Zone Database format.
Recurrence of the schedule.
DayMonthOnceWeek
The MaintenanceWindowRecurrence object
The recurrence of the maintenance window.
The day of the week for weekly maintenance.
The format is the full name of the day in upper case, for example WEDNESDAY.
FRIDAYMONDAYSATURDAYSUNDAYTHURSDAYTUESDAYWEDNESDAY
The day of the month for monthly maintenance.
The duration of the maintenance window in minutes.
The start time of the maintenance window. The format is HH:mm.
The MaintenanceWindowScope object
An object defining the scope of your maintenance window.
You can specify particular Dynatrace entities or matching rules for dynamic formation of the scope.
If no scope is specified, the maintenance applies to the entire environment.
To specify the scope at least one entity or matching rule must be specified.
Defines Dynatrace entities to be included in scope, for example hosts, services, process groups.
Allowed values are Dynatrace entity IDs.
An object defining a matching rule for dynamic scope formation. An empty rule matches for all entities.
The MonitoredEntityFilter object
Filters monitored entities by their type/tags.
The tag you want to use for matching.
You can use custom tags from the UI, AWS tags, Cloud Foundry tags, OpenShift/Kubernetes, and tags based on environment variables.
The type of the Dynatrace entities (for example, hosts or services) you want to pick up by matching.
APM_SECURITY_GATEWAYAPPLICATIONAPPLICATION_METHODAPPLICATION_METHOD_GROUPAPPMON_SERVERAPPMON_SYSTEM_PROFILEAUTO_SCALING_GROUPAUXILIARY_SYNTHETIC_TESTAWS_APPLICATION_LOAD_BALANCERAWS_AVAILABILITY_ZONEAWS_CREDENTIALSAWS_LAMBDA_FUNCTIONAWS_NETWORK_LOAD_BALANCERAZURE_API_MANAGEMENT_SERVICEAZURE_APPLICATION_GATEWAYAZURE_APP_SERVICE_PLANAZURE_COSMOS_DBAZURE_CREDENTIALSAZURE_EVENT_HUBAZURE_EVENT_HUB_NAMESPACEAZURE_FUNCTION_APPAZURE_IOT_HUBAZURE_LOAD_BALANCERAZURE_MGMT_GROUPAZURE_REDIS_CACHEAZURE_REGIONAZURE_SERVICE_BUS_NAMESPACEAZURE_SERVICE_BUS_QUEUEAZURE_SERVICE_BUS_TOPICAZURE_SQL_DATABASEAZURE_SQL_ELASTIC_POOLAZURE_SQL_SERVERAZURE_STORAGE_ACCOUNTAZURE_SUBSCRIPTIONAZURE_TENANTAZURE_VMAZURE_VM_SCALE_SETAZURE_WEB_APPBROWSERCF_APPLICATIONCF_FOUNDATIONCINDER_VOLUMECLOUD_APPLICATIONCLOUD_APPLICATION_INSTANCECLOUD_APPLICATION_NAMESPACECLOUD_NETWORK_INGRESSCLOUD_NETWORK_POLICYCONTAINER_GROUPCONTAINER_GROUP_INSTANCECUSTOM_APPLICATIONCUSTOM_DEVICECUSTOM_DEVICE_GROUPDCRUM_APPLICATIONDCRUM_SERVICEDCRUM_SERVICE_INSTANCEDEVICE_APPLICATION_METHODDEVICE_APPLICATION_METHOD_GROUPDISKDOCKER_CONTAINER_GROUPDOCKER_CONTAINER_GROUP_INSTANCEDYNAMO_DB_TABLEEBS_VOLUMEEC2_INSTANCEELASTIC_LOAD_BALANCERENVIRONMENTEXTERNAL_SYNTHETIC_TEST_STEPGCP_ZONEGEOLOCATIONGEOLOC_SITEGOOGLE_COMPUTE_ENGINEHOSTHOST_GROUPHTTP_CHECKHTTP_CHECK_STEPHYPERVISORHYPERVISOR_CLUSTERHYPERVISOR_DISKKUBERNETES_CLUSTERKUBERNETES_NODEKUBERNETES_SERVICEMOBILE_APPLICATIONMULTIPROTOCOL_MONITORNETWORK_INTERFACENEUTRON_SUBNETOPENSTACK_PROJECTOPENSTACK_REGIONOPENSTACK_VMOSPROCESS_GROUPPROCESS_GROUP_INSTANCEQUEUEQUEUE_INSTANCERELATIONAL_DATABASE_SERVICES3BUCKETSERVICESERVICE_INSTANCESERVICE_METHODSERVICE_METHOD_GROUPSWIFT_CONTAINERSYNTHETIC_LOCATIONSYNTHETIC_TESTSYNTHETIC_TEST_STEPVCENTERVIRTUALMACHINEVMWARE_DATACENTER
The UniversalTag object
The origin of the tag, such as AWS or Cloud Foundry. For custom tags use the CONTEXTLESS value.
The context is set for tags that are automatically imported by OneAgent (for example, from the AWS console or environment variables). It’s useful for determining the origin of tags when not manually defined, and it also helps to prevent clashes with other existing tags. If the tag is not automatically imported, CONTEXTLESS set.
AWSAWS_GENERICAZURECLOUD_FOUNDRYCONTEXTLESSENVIRONMENTGOOGLE_COMPUTE_ENGINEKUBERNETES
The key of the tag. For custom tags, put the tag value here.
The key allows categorization of multiple tags. It is possible that there are multiple values for a single key which will all be represented as standalone tags. Therefore, the key does not have the semantic of a map key but is more like a key of a key-value tuple. In some cases, for example custom tags, the key represents the actual tag value and the value field is not set – those are called valueless tags.
The value of the tag. Not applicable to custom tags.
If a tag does have a separate key and value (in the textual representation they are split by the colon ‘:’), this field is set with the actual value. Key-value pairs can occur for automatically imported tags and tags set by rules if extractors are used.
The UniversalTagKey object
AWSAWS_GENERICAZURECLOUD_FOUNDRYCONTEXTLESSENVIRONMENTGOOGLE_COMPUTE_ENGINEKUBERNETES
Response body JSON model
{"description": "string","id": "string","schedule": {"maintenanceEnd": "string","maintenanceStart": "string","recurrence": {"day": "FRIDAY","dayOfMonth": 1,"duration": 1,"start": "string"},"timezoneId": "string","type": "Day"},"scope": {"entities": ["string"],"matches": [{"tags": [{"context": "AWS","key": "string","tagKey": {"context": "AWS","key": "string"},"value": "string"}],"type": "APM_SECURITY_GATEWAY"}]},"suppressAlerts": true,"suppressProblems": true,"type": "Planned"}
In this example, the request queries
Curl
Request URL
Response content
Response code
DELETE a maintenance window
Deletes the specified maintenance window. Deletion can't be undone.
| DELETE | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v1/maintenance/{uid} |
| Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/maintenance/{uid} |
Authentication
To execute this request, you need an access token with MaintenanceWindows scope.
To learn how to obtain and use it, see Tokens and authentication.
The ID of the maintenance window to delete.
A successful request doesn't return any content.
In this example, the request deletes the easyTravelDeployment maintenance window.
Curl
curl -X DELETE "Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890" \"https://mySampleEnv.live.dynatrace.com/api/v1/maintenance/easyTravelDeployment" \
Request URL
DELETE https://mySampleEnv.live.dynatrace.com/api/v1/maintenance/easyTravelDeployment?api-token=abcdefjhij1234567890
Response code
204