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 Policies API

The Policies API from Instana — 3 operation(s) for policies.

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

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

This API exposes 6 operations across 3 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}.

6 operations 3 paths 13 schemas 1 DELETE2 GET2 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 Policies 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 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Policies 6
GET
/api/automation/policies
Get all automation policies.
getPolicies 4 params → 200403500
POST
/api/automation/policies
Create an automation policy.
addPolicy body → 201400403412500
POST
/api/automation/policies/bulk
Create automation policies.
addPolicies body → 201400403412500
DELETE
/api/automation/policies/{id}
Deletes an automation policy by identifier.
deletePolicy 1 param → 204403412
GET
/api/automation/policies/{id}
Get an automation policy by ID.
getPolicyByID 1 param → 200403404
PUT
/api/automation/policies/{id}
Updates an automation policy by identifier.
updatePolicy 1 param body → 200403412500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Action (10 properties), Parameter (8 properties), Policy (6 properties), Field (5 properties). Each schema is shown below with its type and property counts.

RunConfiguration
object
Action run configuration.
1 property 1 required
ParameterValue
object
List of action input parameters.
2 properties 2 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
MetaData
object
Action metadata.
5 properties
PolicyRunnable
object
Runnable associated with the policy. It can be a workflow or action. Currently only supports action.
3 properties 3 required
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
PolicyScheduling
object
Scheduling information for a scheduled policy.
2 properties 1 required
ActionConfiguration
object
List of action configurations.
3 properties 1 required
Action
object
Automation action definition. When this is used in policy creation request, only id should be specified.
10 properties 5 required
Parameter
object
List of inputs to the action.
8 properties 3 required
Field
object
List of fields that describe an action.
5 properties 3 required
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

instana-policies-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