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 Application Settings API

The API endpoints of this group provides a way to create, read, update, delete (CRUD) for various configuration settings. It includes:**Application Perspectives Configuration**Set of APIs which perform CRUD operations for Application Perspectives.**Endpoint Mapping Configuration**Set of APIs which perform CRUD operations when user wants to customise the endpoint mapping rules.**Service Mapping Configuration**Set of APIs which perform CRUD operations when user wants to customise the service mapping rules.**Manual Service Mapping Configuration**Set of **experimental** APIS which perform CRUD operations when user wants to tweak the service mapping rules when automatic service mapping rules gives undesired results.

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

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

This API exposes 27 operations across 11 paths, and defines 13 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}.

27 operations 11 paths 13 schemas 5 DELETE9 GET5 POST8 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 Application Settings 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 27

Across 11 paths, the API surfaces 27 operations — 5 DELETE, 9 GET, 5 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.

Application Settings 27

The API endpoints of this group provides a way to create, read, update, delete (CRUD) for various configuration settings. It includes: Application Perspectives Configuration Set o…

GET
/api/application-monitoring/settings/application
All Application configurations
getApplicationConfigs → 200
POST
/api/application-monitoring/settings/application
Add application configuration
addApplicationConfig body → 200
DELETE
/api/application-monitoring/settings/application/{id}
Delete application configuration
deleteApplicationConfig 1 param → 204401403
GET
/api/application-monitoring/settings/application/{id}
Application configuration
getApplicationConfig 1 param → 200403404
PUT
/api/application-monitoring/settings/application/{id}
Update application configuration
putApplicationConfig 1 param body → 200
GET
/api/application-monitoring/settings/endpoint
All Endpoint configurations
getEndpointConfigs → 200
POST
/api/application-monitoring/settings/endpoint
Create endpoint configuration
createEndpointConfig body → 200
DELETE
/api/application-monitoring/settings/endpoint/{id}
Delete endpoint configuration
deleteEndpointConfig 1 param → 204401403
GET
/api/application-monitoring/settings/endpoint/{id}
Endpoint configuration
getEndpointConfig 1 param → 200403404
PUT
/api/application-monitoring/settings/endpoint/{id}
Update endpoint configuration
updateEndpointConfig 1 param body → 200
GET
/api/application-monitoring/settings/http-endpointdeprecated
All HTTP endpoint configurations
getHttpEndpointConfigs → 200
POST
/api/application-monitoring/settings/http-endpointdeprecated
Create HTTP endpoint configuration
createHttpEndpointConfig body → 200
DELETE
/api/application-monitoring/settings/http-endpoint/{id}deprecated
Delete HTTP endpoint configuration
deleteHttpEndpointConfig 1 param → default
GET
/api/application-monitoring/settings/http-endpoint/{id}deprecated
HTTP Endpoint configuration
getHttpEndpointConfig 1 param → 200
PUT
/api/application-monitoring/settings/http-endpoint/{id}deprecated
Update HTTP endpoint configuration
updateHttpEndpointConfig 1 param body → 200
GET
/api/application-monitoring/settings/manual-service
All manual service configurations
getAllManualServiceConfigs → 200
POST
/api/application-monitoring/settings/manual-service
Add manual service configuration
addManualServiceConfig body → 200
PUT
/api/application-monitoring/settings/manual-service
Replace all manual service configurations
replaceAllManualServiceConfigs body → 200
DELETE
/api/application-monitoring/settings/manual-service/{id}
Delete manual service configuration
deleteManualServiceConfig 1 param → default
PUT
/api/application-monitoring/settings/manual-service/{id}
Update manual service configuration
updateManualServiceConfig 1 param body → 200
GET
/api/application-monitoring/settings/service
All service configurations
getServiceConfigs → 200
POST
/api/application-monitoring/settings/service
Add service configuration
addServiceConfig body → 200
PUT
/api/application-monitoring/settings/service
Replace all service configurations
replaceAll body → 200
PUT
/api/application-monitoring/settings/service/order
Order of service configuration
orderServiceConfig body → 204400401403
DELETE
/api/application-monitoring/settings/service/{id}
Delete service configuration
deleteServiceConfig 1 param → default
GET
/api/application-monitoring/settings/service/{id}
Service configuration
getServiceConfig 1 param → 200401403404
PUT
/api/application-monitoring/settings/service/{id}
Update service configuration
putServiceConfig 1 param body → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ApplicationConfig (7 properties), NewApplicationConfig (6 properties), ServiceConfig (6 properties), ManualServiceConfig (6 properties). Each schema is shown below with its type and property counts.

NewApplicationConfig
object
6 properties 4 required
HttpEndpointConfig
object
4 properties 2 required
NewManualServiceConfig
object
5 properties 1 required
ServiceMatchingRule
object
Calls will be matched with the array of key-value tags present in this field.
2 properties 2 required
ApplicationConfig
object
7 properties 5 required
HttpEndpointRule
object
Specify custom rule configuration apart from Instana predefined rules. This rule has the highest precedence. This is only available for HTTP endpoints.
3 properties 1 required
MatchExpressionDTO
object
Specify the expression to match, For example, endpoint.name contains health.
1 property 1 required
ServiceConfig
object
6 properties 5 required
HttpPathSegmentMatchingRule
object
A list of path segment matching rules, each defining how a segment of the HTTP path should be matched. Each object in this array represents a segment rule, all…
1 property 1 required
ManualServiceConfig
object
6 properties 2 required
TagFilterExpressionElement
object
Boolean expression of tag filters to define the scope of relevant calls.
1 property 1 required
AccessRule
object
3 properties 2 required
EndpointConfig
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

instana-application-settings-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 Topology API