Get a config version
const url = 'https://example.com/v1/ns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/config/example?view=user';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://example.com/v1/ns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/config/example?view=user' \ --header 'Authorization: Bearer <token>'Returns bare YAML by default. Send Accept: application/json+yaml
for a JSON envelope with metadata.
?view=effective returns the post-inheritance merged document —
the same version with every section inherited from parent
namespaces resolved in, i.e. what the switch actually runs.
?view=user (the default) returns the author-written YAML. In
the JSON envelope the effective body arrives in
effective_config_yaml; the bare-YAML response returns whichever
body matches the view.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Namespace UUID
Config version: ULID, ‘latest’, ‘running’, or a tag name
Query Parameters
Section titled “Query Parameters”Which rendering to return: user (author’s YAML, default) or effective (post-merge document the switch runs).
Responses
Section titled “Responses”OK
Returned for GET config when Accept is application/json+yaml.
Exactly one body field is populated per response: the default
(?view=user) fills user_config_yaml; ?view=effective fills
effective_config_yaml with the post-inheritance merged document
the switch runs. The unused field is omitted.
object
The author-written YAML. Present for the default user view; omitted when ?view=effective was requested.
The post-merge effective YAML with all inherited parent sections resolved. Present only when ?view=effective was requested.
Examplegenerated
{ "success": true, "version": "example", "parent_version": "example", "tag": "example", "description": "example", "config_schema_version": 1, "user_config_yaml": "example", "effective_config_yaml": "example"}default
Section titled “default”Error response
RFC 7807 Problem Details
object
Problem type slug URI
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example"}