Skip to main content
PATCH
Re-pin a subscription's schema major

Authorizations

Authorization
string
header
required

A bearer JWT issued by plugin-auth (lib-auth). The tenant identity is resolved from the validated token claims; the /v1 surface never reads a tenant from the body, path, or query. Machine callers obtain a token via the plugin-auth client-credentials flow. The /admin surface authorizes against an operator scope and carries no tenant context.

Headers

X-Idempotency
string
required

A client-chosen unique key that makes this mutation at-most-once. A mutation sent without it is rejected before any write with 400 missing_idempotency_key. Reusing the same key with an identical request replays the original response byte-for-byte (with X-Idempotency-Replayed: true); reusing it with a different request body returns 409 idempotency_conflict. To re-drive a corrected request, mint a new key.

Path Parameters

id
string<uuid>
required

The unique identifier of the subscription (UUIDv7).

Body

application/json

The narrow re-pin body. Exactly one field, schema_major: an integer >= 1 re-pins to the versioned topic; null clears the pin. Any other field or an empty body is rejected with 422 validation_error.

schema_major
integer | null
required

The schema major to pin, or null to follow the base topic. A value < 1 is rejected.

Example:

2

Response

The re-pin succeeded (no body).