Ctrl+K

Freeze the enterprise

post/api/v2/enterprise/{enterpriseId}/freeze

Path Parameters

  • enterpriseIdstringRequired
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$

Request Body

duration string <number>required
Seconds to freeze the enterpise for
Default: 3600

200 Response

timeOne of
When the freeze started
expiresOne of
When the freeze will end

400 Response

One of
name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

401 Response