GET /config/export

Export the org's config as a canonical apply document

Parameters

Name	In	Required	Type	Description
`all`	query	no	boolean	Include console-managed objects
`format`	query	no	string

curl -X GET "/api/v1/config/export" \
  -H "Authorization: Bearer YOUR_API_KEY"

{}

title: unauthenticated. No bearer token was sent, or the key is invalid or revoked. detail distinguishes the two.

title: forbidden. The key is valid but does not carry read:config.

title: rate_limited. A burst or daily limit was exceeded; detail names which. The body carries retry_after in seconds.

title: internal_error. An unhandled server error. Safe to retry.

Every error is an RFC 7807 problem detail served as application/problem+json:

{
  "type": "https://observer.example/problems/forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: read:config"
}

Branch on title, not on detail. See Errors and status codes for the full catalogue and the rate-limit headers.

Was this page helpful?