Place an operator hold on an organization
PUT /v1/system/organizations/{organizationId}/holds/{holdKey} · SDK placeSystemOrganizationHold · CLI deployments system hold
Requires platform:admin. A machine service whose principal holds organization-holds calls it with SigV4 at /v1/system/services/organizations/{organizationId}/holds/{holdKey}.
tenantJwtAuthorizationBearer <token>Tenant JWT carrying organization, project, and environment claims.
organizationId*stringOrganization whose standing to read or change.
^[0-7][0-9A-HJKMNP-TV-Z]{25}$holdKey*stringThe caller's name for the hold, unique among the holds its source places.
^[a-z0-9][a-z0-9-]{0,62}$application/json- body
customerMessage*stringShown to the organization's members while the hold lasts.
length <= 500operatorNote?stringSeen only by operators and services; never by members.
length <= 500reason*stringpayment, abuse, policy, or manual. Enforcement derives how the organization halts from it.
"payment""abuse""policy""manual"SystemOrganizationStandingChangeResponse
application/json- response
changed*booleanfalse when the standing already matched the request, so nothing was written.
standing*curl -X PUT "https://example.com/v1/system/organizations/string/holds/string" \ -H "Content-Type: application/json" \ -d '{ "customerMessage": "string", "reason": "payment" }'{ "changed": true, "standing": { "dataBoundary": { "operatorNote": "string", "profile": "phi", "setAt": "2019-08-24T14:15:22Z", "setBy": { "kind": "operator", "principalId": "string" } }, "defaults": { "features": { "scim": true, "sso": true }, "operatorFundedModelSpendCeiling": "unlimited", "tenantLimits": { "activeSandboxes": 256, "apiRequestBurst": 1000, "apiRequestsPerSecond": 500, "concurrentRuns": 256 } }, "effective": { "features": { "scim": true, "sso": true }, "operatorFundedModelSpendCeiling": "unlimited", "tenantLimits": { "activeSandboxes": 256, "apiRequestBurst": 1000, "apiRequestsPerSecond": 500, "concurrentRuns": 256 } }, "egressAllowlist": [ { "note": "string", "origin": "string" } ], "grants": { "operator": { "entitlements": { "features": { "scim": true, "sso": true }, "operatorFundedModelSpendCeiling": "unlimited", "tenantLimits": { "activeSandboxes": 256, "apiRequestBurst": 1000, "apiRequestsPerSecond": 500, "concurrentRuns": 256 } }, "grantedAt": "2019-08-24T14:15:22Z", "grantedBy": { "kind": "operator", "principalId": "string" } }, "service": { "entitlements": { "features": { "scim": true, "sso": true }, "operatorFundedModelSpendCeiling": "unlimited", "tenantLimits": { "activeSandboxes": 256, "apiRequestBurst": 1000, "apiRequestsPerSecond": 500, "concurrentRuns": 256 } }, "grantedAt": "2019-08-24T14:15:22Z", "grantedBy": { "kind": "service", "service": "string" } } }, "holds": [ { "customerMessage": "string", "key": "string", "operatorNote": "string", "placedAt": "2019-08-24T14:15:22Z", "placedBy": { "kind": "operator", "principalId": "string" }, "reason": "payment", "source": "string" } ], "organizationId": "string", "state": "active", "suspendedAt": "2019-08-24T14:15:22Z", "version": 0 }}