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 Action Catalog API

The Action Catalog API from Instana — 5 operation(s) for action catalog.

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

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

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

6 operations 5 paths 21 schemas 4 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 Action Catalog 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 6

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

Action Catalog 6
GET
/api/automation/actions
Get all automation actions.
getActions → 200403500
GET
/api/automation/actions/{id}
Get an automation action by ID.
getActionByID 1 param → 200403404
GET
/api/automation/ai/action/match
Get action matches by application ID or snapshot ID.
getActionMatchesByIdAndTimeWindow 4 params → 200400403500
POST
/api/automation/ai/action/match
Get automation actions that match the incidents or issues.
getActionMatches 1 param body → 200403500
PUT
/api/automation/parameters/dynamic
Resolve dynamic parameter values
resolve body → 200500
GET
/api/automation/parameters/dynamic/catalog
Get tag catalog for dynamic parameters
getDynamicParametersTagCatalog → 200500

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Action (10 properties), Tag (9 properties), Parameter (8 properties), TagTreeLevel (7 properties). Each schema is shown below with its type and property counts.

Policy
object
6 properties 4 required
Trigger
object
The trigger is the Instana event or Smart Alert that defines the initial conditions that must be met for the policy to apply on the actions in typeConfiguratio…
5 properties 1 required
MetaData
object
Action metadata.
5 properties
TypeConfiguration
object
List of configurations that contains the list of actions to run and the mode (automatic or manual) in which the policy is run.
3 properties 2 required
Field
object
List of fields that describe an action.
5 properties 3 required
RunConfiguration
object
Action run configuration.
1 property 1 required
Condition
object
This applies to only automatic policy type. A Dynamic Focus Query that selects a list of entities on which the policy is run.
1 property
TagCatalog
object
2 properties 2 required
PolicyRunnable
object
Runnable associated with the policy. It can be a workflow or action. Currently only supports action.
3 properties 3 required
Tag
object
List of queryable tags available in a tagTree. Eg: call.erroneous. Consider these tags as attributes of a tagTree. Eg: Call tagTree has have Erroneous, Call na…
9 properties 2 required
TagTreeNode
object
Children tags of tagTree
3 properties
ActionConfiguration
object
List of action configurations.
3 properties 1 required
DynamicParameter
object
List of dynamic parameters
4 properties
TagTreeLevel
object
The name of the tag dataset (tagTree) which can contain one or more tags as its attributes or children. Eg: Call. Consider this as the root of the tree where i…
7 properties 2 required
ActionSearchSpace
object
4 properties 1 required
ParameterValue
object
List of action input parameters.
2 properties 2 required
Parameter
object
List of inputs to the action.
8 properties 3 required
Action
object
Automation action definition. When this is used in policy creation request, only id should be specified.
10 properties 5 required
PolicyScheduling
object
Scheduling information for a scheduled policy.
2 properties 1 required
GetDynamicParameterValues
object
3 properties 3 required
ActionMatch
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

instana-action-catalog-api-openapi.yml Raw ↑

Other APIs Instana publishes across the network.

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