Skip to main content
POST
Decommission a tenant

Authorizations

Authorization
string
header
required

A machine-client token from POST /v1/auth/client-token. Reads need the pulse.read scope; provisioning and tenant updates need pulse.write, which the token only carries when requested_scopes asks for it. Creating, changing, disabling and resetting MFA for users, and the tenant sign-in policy, need a signed-in user's token instead: they reject API-key tokens.

Path Parameters

tenantId
string<uuid>
required

The tenant to decommission: a tenant_id from List tenants (GET /v1/msp/admin/tenants).

Body

application/json

Send {} when you do not use an idempotency key: the body itself is required.

idempotency_key
null | string
required

A unique value, such as a UUID v4, that you generate per decommission. Retrying with a key that was already accepted returns the original job instead of queuing another. An Idempotency-Key header, when sent, takes precedence over this field.

Response

OK

A tenant lifecycle job, returned by Provision a tenant, Get a provisioning job's status and Decommission a tenant. Jobs run asynchronously: poll Get a provisioning job's status (GET /v1/msp/provisioning/jobs/{jobId}) with job_id until status is deployed (create), decommissioned (decommission) or failed.

tenant_id
string<uuid>
required

The tenant the job is for. After a create, use it as tenantId in the other endpoints.

tenant_number
required

The tenant's number, as shown to support staff.

job_id
string<uuid>
required

The job's id. Pass it to Get a provisioning job's status.

status
string
required

The job's status: queued | leased | running | deployed | decommissioned | failed.

  • queued: accepted, waiting for a worker. A new create or decommission always starts here.
  • leased / running: a worker has picked it up.
  • deployed: the tenant is ready and its status is now active.
  • decommissioned: the tenant is removed and its status is now deleted.
  • failed: the job did not complete.
tenant_host
string
required

The tenant's host name, for example cc4a1b2c.cyrisma.com.

registration_key
null | string
required

The tenant's agent registration key: 32 upper-case hexadecimal characters. Agents installed for this tenant register with it.

orchestrator_wake_succeeded
null | boolean
required

Internal. Always null in these responses; ignore it.