Skip to content
UltimateTeam.ai Docs

Get Kill Switch Status

GET
/api/v1/admin/kill-switch/status
curl --request GET \
  --url https://api.ultimateteam.ai/api/v1/admin/kill-switch/status \
  --header 'X-API-Key: <X-API-Key>'

Check the current kill switch status.

Returns whether the kill switch is active for the given tenant or globally. Requires platform-operator access.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
tenant_id
Any of:
string

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"
    }
  ]
}