Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1430332272.3 KB

Retrieves the status history for a single instrumentation configuration during a specified time range. The response lists when the configuration was ACTIVE, READY, ERROR, or DISABLED.

If no status or time window is provided, the operation defaults to ACTIVE events from the last hour.

post/get-instrumentation-configuration-status

Request body

InstrumentationType'BREAKPOINT' | 'PROBE' required

Type of instrumentation configuration

Servicestring required

Service name for the instrumentation configuration.

Environmentstring required

Environment name for the instrumentation configuration.

SignalType'SNAPSHOT' required
<p>The telemetry signal type for instrumentation.</p> <ul> <li> <p> <code>SNAPSHOT</code> - Captures a snapshot of the instrumentation point.</p> </li> </ul>
Status'READY' | 'ERROR' | 'ACTIVE' | 'DISABLED'
<p>The status of an instrumentation configuration on a host.</p> <ul> <li> <p> <code>READY</code> - The configuration has been applied but has not been hit yet.</p> </li> <li> <p> <code>ERROR</code> - Applying the configuration failed; see the error cause.</p> </li> <li> <p> <code>ACTIVE</code> - The configuration has been hit and is capturing data.</p> </li> <li> <p> <code>DISABLED</code> - The configuration was disabled, for example because a limit was reached.</p> </li> </ul>
StartTimestring date-time

The start of the time range to retrieve status events for. <code>StartTime</code> and <code>EndTime</code> must both be provided together or both be omitted. When both are omitted, the time range defaults to the last hour.

EndTimestring date-time

The end of the time range to retrieve status events for. <code>StartTime</code> and <code>EndTime</code> must both be provided together or both be omitted. When both are omitted, the time range defaults to the last hour.

MaxResultsinteger

The maximum number of status events to return in one call. The default is 60.

NextTokenstring

Use the token returned by a previous call to retrieve the next page of status events.

Response

Success

Servicestring required

The service name echoed from the request.

Environmentstring required

The environment echoed from the request.

SignalType'SNAPSHOT' required

The telemetry signal type echoed from the request.

Status'READY' | 'ERROR' | 'ACTIVE' | 'DISABLED' required

The status that was queried. If not specified in the request, this is <code>ACTIVE</code>.

NextTokenstring

Pagination token to continue retrieving status events.