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

The Apdex Settings API from Instana — 3 operation(s) for apdex settings.

Instana Apdex 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 Apdex Settings. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 3 paths, and defines 4 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}.

5 operations 3 paths 4 schemas 1 DELETE3 GET1 POST

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 Apdex 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 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Apdex Settings 5
GET
/api/settings/apdex
Get All Apdex Configurations
getAllApdexConfigurations → 200
POST
/api/settings/apdex
Create Apdex Configuration
createApdexConfiguration body → 200
GET
/api/settings/apdex/{entityType}/{entityId}
Get all Apdex configurations for entity type and entity id
getApdexConfigurationsForEntityTypeAndId 2 params → 200400
DELETE
/api/settings/apdex/{id}
Delete Apdex Configuration
deleteApdexConfiguration 1 param → 204
GET
/api/settings/apdex/{id}
Get Apdex Configuration
getApdexConfiguration 1 param → 200404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ApdexConfiguration (4 properties), ApdexEntity (4 properties), ApdexConfigurationInput (2 properties), TagFilterExpressionElement (1 property). Each schema is shown below with its type and property counts.

TagFilterExpressionElement
object
Boolean expression of tag filters to define the scope of relevant calls.
1 property 1 required
ApdexEntity
object
Entity which holds the information of Apdex Configuration
4 properties 3 required
ApdexConfiguration
object
4 properties 3 required
ApdexConfigurationInput
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

instana-apdex-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 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
Instana Application Topology API