Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Instana Maintenance Configuration API

### Maintenance WindowsMaintenance windows allow you to mute alerts.### Types of Maintenance Configurations**One-Time**: Executed once at a fixed scheduled time, after which the configuration expires.**Recurrent**: Executed on a schedule basis (e.g., daily, weekly, monthly, or yearly).### Pausing or Resuming Maintenance ConfigurationsMaintenance windows can be paused or resumed.If a maintenance configuration is paused, alerts for the events matching the scope of the configuration will no longer be muted.

Instana Maintenance Configuration API is one of 62 APIs that Instana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Maintenance Configuration. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 6 paths, and defines 11 schemas. It is described by OpenAPI 3.0.1, at version 1.307.1417.

Requests are made against 2 base URLs: https://{unit}-{tenant}.instana.io, https://{domain}.

10 operations 6 paths 11 schemas 2 DELETE4 GET4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.307.1417
Servers
https://{unit}-{tenant}.instana.io
https://{domain}
Authentication
API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Instana Maintenance Configuration API declares 1 security scheme for authenticating requests. An API key is passed in the header as authorization (ApiKeyAuth).

  • ApiKeyAuth — Example bash curl --request GET \ --url https://test-instana.instana.io/api/application-monitoring/catalog/metrics \ --header 'authorization: apiToken xxxxxxxx…

Paths & Operations 10

Across 6 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Maintenance Configuration 10

Maintenance Windows Maintenance windows allow you to mute alerts. Types of Maintenance Configurations One-Time: Executed once at a fixed scheduled time, after which the configurat…

GET
/api/settings/maintenancedeprecated
All maintenance configurations
getMaintenanceConfigs → 200
DELETE
/api/settings/maintenance/{id}deprecated
Delete maintenance configuration
deleteMaintenanceConfig 1 param → default
GET
/api/settings/maintenance/{id}deprecated
Maintenance configuration
getMaintenanceConfig 1 param → 200
PUT
/api/settings/maintenance/{id}deprecated
Create or update maintenance configuration
putMaintenanceConfig 1 param body → 200202400
GET
/api/settings/v2/maintenance
All maintenance configurations
getMaintenanceConfigsV2 → 200
DELETE
/api/settings/v2/maintenance/{id}
Delete maintenance configuration
deleteMaintenanceConfigV2 1 param → default
GET
/api/settings/v2/maintenance/{id}
Get maintenance configuration
getMaintenanceConfigV2 1 param → 200
PUT
/api/settings/v2/maintenance/{id}
Create or update maintenance configuration
putMaintenanceConfigV2 1 param body → 200202400422
PUT
/api/settings/v2/maintenance/{id}/pause
Pause maintenance configuration
pauseRecurrentMaintenanceConfiguration 1 param → 200
PUT
/api/settings/v2/maintenance/{id}/resume
Resume maintenance configuration
resumeRecurrentMaintenanceConfiguration 1 param → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ValidatedMaintenanceConfigV2WithStateAndOccurrence (13 properties), MaintenanceConfigV2WithStateAndOccurrence (11 properties), MaintenanceConfigV2 (8 properties), ValidatedMaintenanceConfigWithStatus (7 properties). Each schema is shown below with its type and property counts.

MaintenanceConfigV2
object
8 properties 4 required
MaintenanceConfigWithLastUpdated
object
5 properties 3 required
ValidatedMaintenanceConfigWithStatus
object
7 properties 4 required
MaintenanceWindow
object
A set of time periods when the Maintenance Window Configuration is active.
3 properties 1 required
MaintenanceConfigScheduling
object
Time scheduling of the Maintenance Window configurations.
3 properties 3 required
TagFilterExpressionElement
object
Boolean expression of tag filters to define the scope of relevant calls.
1 property 1 required
Occurrence
object
Time window of the Maintence Window configuration occurrences.
2 properties
Duration
object
2 properties 2 required
MaintenanceConfig
object
4 properties 3 required
ValidatedMaintenanceConfigV2WithStateAndOccurrence
object
13 properties 5 required
MaintenanceConfigV2WithStateAndOccurrence
object
11 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

instana-maintenance-configuration-api-openapi.yml Raw ↑

Other APIs Instana publishes across the network.

Instana Action Catalog API
Instana Action History API
Instana AI Management API
Instana Apdex Report API
Instana Apdex Settings API
Instana API Token API
Instana Application Alert Configuration API
Instana Application Analyze API
Instana Application Catalog API
Instana Application Metrics API
Instana Application Resources API
Instana Application Settings API