Skip to main content
GET
Get service by id or key

Authorizations

Authorization
string
header
required

An organization API key (obs_pub_…) sent as Authorization: Bearer <key>. Each key carries scopes; an endpoint lists the scope it needs. read:change_events is reserved: keys can carry it, but no endpoint needs it yet.

Scopes

read:services

Path Parameters

id
string
required

The service's id, or its key in config documents (its config_key, or the key config export gives one made in the console).

Response

ok

id
string<uuid>
required
name
string
required
created_at
string<date-time>
required
description
string | null
config_key
string | null

The service's key in config documents (null for one made in the console and never applied from config). Per-key DELETE takes this.

managed_by
enum<string>

config: owned by config apply (prune and per-key delete may remove it). console: made in the console; config apply adopts it when a document names it.

Available options:
config,
console
suspended
boolean

true while the service is suspended because the organization is over its plan's limit (after a 7-day grace). Nothing is deleted; it is read-only until the person chooses it as active in Billing or upgrades. Writes return 403 item_suspended_plan.

suspended_at
string<date-time> | null

When the suspension started.

key
string

GET /services/{id} and PUT only: the service's key in config documents (its config_key, or the key config export gives a console service). PUT /services/{key} takes it.

metrics
object[]

The metrics this service groups: its member metrics (added in the console or with services[].metrics in a config document, via: member) and the metrics its SLOs measure (via: slo). A metric that is both is listed once as a member with slo: true.