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 Host Agent API

Endpoints of this group can be used to list and configure host agents.

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

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

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

8 operations 8 paths 3 schemas 5 GET3 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 Host Agent 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 8

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

Host Agent 8

Endpoints of this group can be used to list and configure host agents.

GET
/api/host-agent
Query host agent snapshots
searchHostAgents 5 params → 200
POST
/api/host-agent/configuration
Update agent configuration by query
updateConfigurationByQuery 5 params body → default
GET
/api/host-agent/{hostId}/clr-logs
Agent CLR download logs
getAgentClrLogs 2 params → default
POST
/api/host-agent/{hostId}/configuration
Update agent configuration by host
updateConfigurationByHost 1 param body → default
GET
/api/host-agent/{hostId}/logs
Agent download logs
getAgentLogs 3 params → default
GET
/api/host-agent/{hostId}/support-info
Agent download support information
getAgentSupportInformation 2 params → default
POST
/api/host-agent/{hostId}/update
Agent update
updateAgent 1 param → default
GET
/api/host-agent/{id}
Get host agent snapshot details
getAgentSnapshot 3 params → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are SnapshotItem (8 properties), AgentConfigurationUpdate (3 properties), SnapshotResult (1 property). Each schema is shown below with its type and property counts.

AgentConfigurationUpdate
object
3 properties
SnapshotItem
object
Detail information for requested snapshots.
8 properties
SnapshotResult
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

instana-host-agent-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