Skip to content

Stops one spec generation from being the active desired state.

POST
/v1/m/sessions/protocol-binding-specs/{id}/disable
curl --request POST \
--url 'https://example.com/v1/m/sessions/protocol-binding-specs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/disable?mode=validate' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "plan_hash": "example" }'

Stops one spec generation from being the active desired state.

id
required
string format: uuid
/^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/

Path parameter id.

X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Idempotency-Key
string format: uuid

Canonical UUID required when mode=apply; reuse it only for an exact retry.

If-Plan-Hash
string
/^(sha256:)?[0-9A-Fa-f]{64}$/

SHA-256 plan hash required when mode=apply; apply must reproduce it. For state transitions it must agree with body.plan_hash when both are supplied.

If-Match
string
/^\"v[1-9][0-9]*\"$/

Strong ProtocolBindingSpec ETag required when mode=apply; when supplied in validate or plan it must match the current version.

mode
required
string
Allowed values: validate plan apply

Mandatory authoring phase. The server derives a fresh capability witness; validate and plan are observational, while apply revalidates and commits the spec transition.

Media type application/json

Optional spec-transition plan precondition. The body may be empty in validate and plan; apply still requires a matching plan hash through this field or If-Plan-Hash.

object
plan_hash

Optional plan precondition; it must agree with If-Plan-Hash when both are supplied.

string
/^(sha256:)?[0-9A-Fa-f]{64}$/
Example generated
{
"plan_hash": "example"
}

OK

Media type application/json
object
Example generated
{}

Bad request

Media type application/json
object
Example generated
{}

Unauthenticated

Media type application/json
object
Example generated
{}

Forbidden

Media type application/json
object
Example generated
{}

Not found

Media type application/json
object
Example generated
{}

Conflict / setup required

Media type application/json
object
Example generated
{}

ETag or plan precondition failed

Media type application/json
object
Example generated
{}

Apply precondition required

Media type application/json
object
Example generated
{}

Rate limited

Media type application/json
object
Example generated
{}

Required store is unavailable

Media type application/json
object
Example generated
{}