Skip to main content
GET
Get one key's write contract

Authorizations

Authorization
string
header
required

A bearer JWT issued by the platform's Access Manager (plugin-auth / lib-auth). Authorization is deny-all by default: the application must be configured with an authorizer, and when authentication is enabled it enforces per-namespace role-based access control on top of a valid, platform-scoped (non-tenant) identity. Machine callers obtain a token via the Access Manager client-credentials flow.

Path Parameters

namespace
string
required

The Systemplane namespace. Rails and plugins use runtime_config, tenant_policy, or operational_registry; some applications register a single application-named namespace instead.

Example:

"runtime_config"

key
string
required

The registered key within the namespace. Keys are flat, dot-delimited identifiers; a key may itself contain / segments.

Example:

"tenancy.ispb_organization_bindings"

Response

The key's write contract.

The full write contract for one registered key.

catalogVersion
string
required

The catalog schema version.

Example:

"systemplane.catalog.v1"

service
string
required

The application that serves this catalog.

Example:

"matcher"

namespace
string
required

The namespace the key belongs to.

Example:

"tenant_policy"

key
string
required

The registered key.

Example:

"tenancy.ispb_organization_bindings"

kind
string
required

The value kind the key accepts.

Example:

"object"

tenantScoped
boolean
required

Whether the key's value is resolved per tenant.

Example:

false

runtimeClass
string
required

When a change takes effect.

Example:

"read_live"

redaction
string
required

The redaction policy applied to the value on read.

Example:

"mask"

hasValidator
boolean
required

Whether the key has a server-side write validator.

Example:

true

description
string
required

A human-readable description of the key.

Example:

"Tenant-scoped JSON object keyed by ISPB"

detailUrl
string
required

The relative URL of this detail resource.

Example:

"/system/-/catalog/tenant_policy/tenancy.ispb_organization_bindings"

schema
object
required

The JSON schema the value is validated against.

write
object
required

The write descriptor for a key — the request you send to change it.

defaultValue
any

The key's default value. Untyped — matches the key's kind.

rules
string[]

Human-readable semantic validation rules beyond the JSON schema. Omitted when there are none.

Example:
examples
object[]

Valid example values for the key. Omitted when there are none.

Maximum array length: 10