config/show

GET/config/show

Fetch a published config version, draft, or the live config. Requires the configuration:read permission.

Request

cURL

curl -X GET "https://provisioning.cloudx.io/api/v1/config/show" \
  -H "Authorization: Bearer $CLOUDX_API_KEY"

Query parameters

Name	Type	Description
`id`	`string`	Configuration row ID. Can address a published version or draft.
`version`	`integer<int32>`	Published configuration version number.
`draft`	`boolean`	Whether to return the account draft. If multiple drafts exist, use `id` instead.
`consistent`	`boolean`	Whether to read from the primary database instead of the regional replica. Set it when reading a config straight after publishing or editing it, so the response cannot trail that write by the replica lag.

Responses

Config data and metadata.

{
  "id": "<string>",
  "account_id": "<string>",
  "kind": "live",
  "version_number": 123,
  "version_label": "<string>",
  "created_at": "<string>",
  "created_by_user_id": "<string>",
  "created_by_name": "<string>",
  "yaml": "<string>",
  "data": {}
}

200Config data and metadata.

Field	Type	Description
`id`required	`string`
`account_id`required	`string`
`kind`required	`string`
`version_number`	`integer<int32>`
`version_label`	`string`
`created_at`required	`string`
`created_by_user_id`	`string`
`created_by_name`	`string`
`yaml`required	`string`
`data`required	`object`

400Invalid request parameters.

Field	Type	Description
`error`required	`string`

401Unauthorized.

Field	Type	Description
`error`required	`string`

403Forbidden.

Field	Type	Description
`error`required	`string`

404Config not found.

Field	Type	Description
`error`required	`string`

500Internal server error.

Field	Type	Description
`error`required	`string`