Read agent frozen state
GET
/api/v1/settings/frozen-state
const url = 'https://api.ultimateteam.ai/api/v1/settings/frozen-state';const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.ultimateteam.ai/api/v1/settings/frozen-state \ --header 'X-API-Key: <X-API-Key>'Return whether all agents are currently paused (frozen) for the tenant. frozen=True when at least one agent exists and every agent’s status is ‘paused’. Use this to initialise the Emergency Freeze UI without relying on transient client-side state.
Authorizations
Section titled “Authorizations”Responses
Section titled “ Responses ”Successful Response
Media typeapplication/json
FrozenStateResponse
Response shape for GET /settings/frozen-state.
object
data
required
Data
object
key
additional properties
any
Examplegenerated
{ "data": {}}