Skip to main content

Overview

Observability endpoints

Available Operations

  • list - List observability destinations
  • create - Create an observability destination
  • delete - Delete an observability destination
  • get - Get an observability destination
  • update - Update an observability destination

list

List the observability destinations configured for the authenticated entity’s default workspace, or a workspace-scoped management key’s own workspace. Use the workspace_id query parameter to scope the result to a different workspace. A workspace-scoped management key can only list its own workspace; any other workspace_id returns 403. Only destinations with stable release status are surfaced — destinations of other types are excluded. Management key required.

Example Usage

Parameters

Response

operations.ListObservabilityDestinationsResponse

Errors

create

Create a new observability destination. A maximum of 5 enabled destinations per workspace, across all types, is allowed; disabled destinations do not count. A workspace already above the cap keeps its enabled destinations but cannot create or enable more until fewer than 5 are enabled. Defaults to the authenticated entity’s default workspace, or a workspace-scoped management key’s own workspace; use the workspace_id body field to scope to a different workspace. A workspace-scoped management key can only create in its own workspace; any other workspace_id returns 403. Management key required.

Example Usage

Parameters

Response

components.CreateObservabilityDestinationResponse

Errors

delete

Delete an existing observability destination. This performs a soft delete. A workspace-scoped management key only reaches destinations in its own workspace; any other id returns 404. Management key required.

Example Usage

Parameters

Response

components.DeleteObservabilityDestinationResponse

Errors

get

Fetch a single observability destination by its UUID. A workspace-scoped management key only reaches destinations in its own workspace; any other id returns 404. Management key required.

Example Usage

Parameters

Response

components.GetObservabilityDestinationResponse

Errors

update

Update an existing observability destination. Only the fields provided in the request body are updated. Enabling a disabled destination returns 400 while the workspace already has 5 enabled destinations. A workspace-scoped management key only reaches destinations in its own workspace; any other id returns 404. Management key required.

Example Usage

Parameters

Response

components.UpdateObservabilityDestinationResponse

Errors