Skip to content

governance module route (requires governance:killswitch:admin)

POST
/v1/m/governance/killswitch
curl --request POST \
--url https://example.com/v1/m/governance/killswitch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "reason": "example", "scope_kind": "example", "scope_ref": "example" }'

Engages a stop across the estate or over one named agent scope.

X-Olivares-Tenant
string format: uuid

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

Media type application/json
object
reason
required

Mandatory incident reason, trimmed and capped at 4096 bytes.

string
/.*\S.*/
scope_kind
required

Case-insensitive after trimming: estate or agent.

string
scope_ref
Any of:

Must be empty for estate and non-blank for agent; credential-free and capped at 4096 bytes.

string
Example generated
{
"reason": "example",
"scope_kind": "example",
"scope_ref": "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
{}

Rate limited

Media type application/json
object
Example generated
{}