Skip to main content
POST
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

Body

application/json
schema
object
required

The schema to check against the config's stored schema — a JSON Schema document or typed-code source (typescript/protobuf/python/go/rust). Read-only: nothing is mutated.

Response

200 - application/json

Resource created

inSync
boolean
required

True when the supplied schema is canonically identical to the config's stored schema.

fingerprint
string
required

Canonical fingerprint of the config's stored schema.

incomingFingerprint
string
required

Canonical fingerprint of the supplied schema.

drift
object

Present only when inSync is false.

ancestorOwnedFields
object[]

Supplied fields an ancestor config already owns ("base wins"). Subtract these from drift.contract adds when round-tripping a full effective schema.

warnings
object[]