Cloud and BYOC for Orca Agent Engine are in Private Preview — request an invite
Docs
runorca.ai
Get startedBuildRunGovernObserveReferenceAPI
ObservabilityWorkspace observability

Rotate workspace credentials

Admin listener only. Required API-key scope: observability:rotate. Organization keys with org:admin also qualify; OIDC requires org:admin. See the observability administration guide for replacement, precondition and exporter restrictions.

POST/v1/organizations/workspaces/{workspaceId}/agent_observability:rotate_credentials

Authorization

x-api-key<token>

Organization admin key (orca_admin_...). Not a Workspace or platform key.

In: header

Path Parameters

workspaceId*string
Length1 <= length <= 100

Header Parameters

idempotency-key*string
if-match*string

Request Body

application/json

Body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/organizations/workspaces/string/agent_observability:rotate_credentials" \  -H "idempotency-key: string" \  -H "if-match: string" \  -H "Content-Type: application/json" \  -d '{    "credentials": {      "type": "basic",      "username": "string",      "password": "string"    }  }'
{  "type": "agent_observability",  "scope": "workspace",  "organization_id": "string",  "workspace_id": "string",  "configured": {    "mode": "inherit",    "capture_ceiling": "metadata_only",    "binding": {      "id": "string",      "scope": "organization",      "organization_id": "string",      "workspace_id": "string",      "target": {        "adapter_type": "otlp_http",        "external_project_id": "string",        "endpoint_kind": "traces_endpoint",        "endpoint_class": "public",        "endpoint_url": "string"      },      "status": "active",      "config": {        "version": 1,        "semantic_profile": "otel_genai",        "protocol": "http/protobuf",        "compression": "none",        "timeout_ms": 1,        "environment": "string",        "release": "string",        "capture_mode": "metadata_only",        "sample_rate": 0,        "config_schema_version": 1      },      "credential": {        "configured": true,        "version": 1,        "key_hint": "string",        "rotated_at": "2019-08-24T14:15:22Z"      }    }  },  "effective": {    "source": "organization_default",    "status": "enabled",    "disabled_reason": "string",    "capture_mode": "metadata_only",    "binding": {      "id": "string",      "scope": "organization",      "organization_id": "string",      "workspace_id": "string",      "target": {        "adapter_type": "otlp_http",        "external_project_id": "string",        "endpoint_kind": "traces_endpoint",        "endpoint_class": "public",        "endpoint_url": "string"      },      "status": "active",      "config": {        "version": 1,        "semantic_profile": "otel_genai",        "protocol": "http/protobuf",        "compression": "none",        "timeout_ms": 1,        "environment": "string",        "release": "string",        "capture_mode": "metadata_only",        "sample_rate": 0,        "config_schema_version": 1      },      "credential": {        "configured": true,        "version": 1,        "key_hint": "string",        "rotated_at": "2019-08-24T14:15:22Z"      }    }  }}

Put workspace observability PUT

Admin listener only. Required API-key scope: observability:write. Organization keys with org:admin also qualify; OIDC requires org:admin. See the observability administration guide for replacement, precondition and exporter restrictions.

Get policy GET

Admin listener only. Required API-key scope: platform:admin. Platform credentials cannot call organization routes. See the observability administration guide for replacement, precondition and exporter restrictions.