Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

If using Bearer auth, pass the Secret Key as the token:

Path Parameters

key
string
required

The key of the config

Query Parameters

format
enum<string>

Output format. json-schema (default) returns a JSON Schema document; typescript, protobuf, python (Pydantic), go, and rust (serde) render the schema as source in that language.

Available options:
json-schema,
typescript,
protobuf,
python,
go,
rust
effective

When true, includes fields inherited across the lineage (the family's accumulated schema). When false (default), returns only this config's own fields.

Allowed value: "true"
source
string

Render using a previously-captured source projection (its named types). Only affects the typed-code formats (typescript/protobuf/python/go/rust); ignored if the source has no projection.

Response

200 - application/json

Successful response

schema
object
required

The config's schema in the requested format: a JSON Schema document ({ type: "json-schema", value }) or rendered TypeScript source ({ type: "typescript", value }).

effective
boolean
required

True when the schema includes inherited fields accumulated across the lineage; false when it is only this config's own fields.

additionalProperties
boolean
required

Whether the config family permits extra keys.