Skip to content
UltimateTeam.ai Docs

Activate Kill Switch

POST
/api/v1/admin/kill-switch
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/admin/kill-switch \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "reason": "example", "tenant_id": "example" }'

Activate the emergency kill switch.

Halts all agent execution for a specific tenant or globally. Requires platform-operator access.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
KillSwitchRequest

Request body for activating the kill switch.

Attributes: tenant_id: Optional tenant to halt. If omitted, a global halt is activated. reason: Required human-readable reason for the halt.

object
reason
required
Reason

Reason for the emergency halt (min 10 chars).

string
>= 10 characters
tenant_id
Any of:
string
Examplegenerated
{
  "reason": "example",
  "tenant_id": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
KillSwitchResponse

Response body for kill switch operations.

Attributes: action: The action performed (halt, resume, status). scope: Whether the action is tenant-scoped or global. tenant_id: The tenant affected (None for global). active: Whether the kill switch is currently active. reason: The halt reason (empty if not active).

object
action
required
Action
string
active
required
Active
boolean
reason
Reason
string
""
scope
required
Scope
string
tenant_id
Any of:
string
Example
{
  "reason": ""
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}