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

These APIs can be used to create, update, delete and fetch releases.## Mandatory Parameters when sending a request:1. **Create release** - `name` and `start` are mandatory parameters to create a release with Global scope. - `applications` is a mandatory parameter **along with** Global scope mandatory parameters tocreate a release with Application Perspective scope. - `services.name` is a mandatory parameter **along with** Global scope mandatory parameters tocreate a release with Service scope. - `services.scopedTo.applications` is a mandatory parameter **along with Service scope** mandatoryparameters to create a release with Service within an Application Perspective scope.2. **Delete release** - `releaseId` is a mandatory path parameter.3. **Get release** - `releaseId` is a mandatory path parameter.4. **Update release** - `releaseId` is a mandatory path parameter. - Same mandatory parameters as **Create release**.

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

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

This API exposes 5 operations across 2 paths, and defines 9 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 9 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 Releases 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.

Releases 5

These APIs can be used to create, update, delete and fetch releases. Mandatory Parameters when sending a request: 1. Create release - name and start are mandatory parameters to cr…

GET
/api/releases
Get all releases
getAllReleases 3 params → 200
POST
/api/releases
Create release
postRelease body → 200
DELETE
/api/releases/{releaseId}
Delete release
deleteRelease 1 param → default
GET
/api/releases/{releaseId}
Get release
getRelease 1 param → 200
PUT
/api/releases/{releaseId}
Update release
putRelease 1 param body → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are ReleaseWithMetadata (7 properties), ReleaseScope (4 properties), Release (4 properties), ServiceScopeWithMetadata (3 properties). Each schema is shown below with its type and property counts.

ReleaseWithMetadata
object
7 properties 2 required
ServiceScope
object
The list of services where the release can be viewed.
2 properties 1 required
ServiceScopedToWithMetadata
object
The release marker would be present in the service but not for other services within the Application perspective.
1 property 1 required
ApplicationScope
object
The list of application perspectives where the release can be viewed.
1 property 1 required
ReleaseScope
object
4 properties
ServiceScopedTo
object
The list of application perspectives where the service is present.
1 property 1 required
ApplicationScopeWithMetadata
object
The list of application perspectives where the release can be viewed.
2 properties 1 required
ServiceScopeWithMetadata
object
The list of services where the release can be viewed.
3 properties 1 required
Release
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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