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 Custom Entities API

The Custom Entities API from Instana — 2 operation(s) for custom entities.

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

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

This API exposes 5 operations across 2 paths, and defines 8 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 2 paths 8 schemas 1 DELETE2 GET1 POST1 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 Custom Entities 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 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Custom Entities 5
GET
/api/custom-entitytypes
List custom Entity Type Definition
listCustomEntities → 200
POST
/api/custom-entitytypes
Create a Custom Entity type
createCustomEntities body → 200
DELETE
/api/custom-entitytypes/{id}
Delete a Custom Entity Type
deleteCustomEntity 1 param body → 200
GET
/api/custom-entitytypes/{id}
Get custom Entity Types
getCustomEntity 1 param → 200
PUT
/api/custom-entitytypes/{id}
Update a Custom Entity Type
updateCustomEntity 1 param body → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are CustomMetric (9 properties), Widget (8 properties), CustomEntityModel (6 properties), CustomDependency (6 properties). Each schema is shown below with its type and property counts.

CustomMetric
object
9 properties
Widget
object
8 properties 3 required
CustomDashboard
object
4 properties 4 required
CustomEntityModel
object
6 properties 3 required
CustomDependency
object
6 properties
TagFilterExpressionElement
object
Boolean expression of tag filters to define the scope of relevant calls.
1 property 1 required
CustomEntityWithMetadata
object
4 properties 2 required
AccessRule
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

instana-custom-entities-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