Skip to content
UltimateTeam.ai Docs

Initiate break-glass recovery

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

Create a pending break-glass recovery request for human approval.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
BreakGlassRequestCreate

Request model for initiating a break-glass recovery.

object
agent_role
required
Agent Role

The agent role whose vault to recover

string
<= 100 characters
reason
required
Reason

Detailed justification for the break-glass request

string
>= 10 characters
Examplegenerated
{
  "agent_role": "example",
  "reason": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “201”

Successful Response

Media typeapplication/json
BreakGlassRequestResponse

Response model for a break-glass recovery request.

object
agent_role
required
Agent Role
string
approved_at
required
Any of:
string format: date-time
approved_by
required
Any of:
string format: uuid
completed_at
required
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
entries_recovered
required
Any of:
integer
id
required
Id
string format: uuid
reason
required
Reason
string
requester_id
required
Requester Id
string format: uuid
status
required
Status
string
tenant_id
required
Tenant Id
string format: uuid
Examplegenerated
{
  "agent_role": "example",
  "approved_at": "2026-04-15T12:00:00Z",
  "approved_by": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "completed_at": "2026-04-15T12:00:00Z",
  "created_at": "2026-04-15T12:00:00Z",
  "entries_recovered": 1,
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "reason": "example",
  "requester_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "status": "example",
  "tenant_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

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