Deleting a tenant


Deleting a tenant is not a reversible operation and results in the following:

  • All sub-tenants are deleted.

  • All user accounts within this tenant and all its sub-tenants are deleted.

  • All services enabled within this tenant and all its sub-tenants stop operating.

  • All service-related data (e.g., backups, synced files) of this tenant and all its sub-tenants are deleted.

  1. Authenticate to the cloud platform via the Python shell.

    The following variables should be available now:

    >>> base_url  # the base URL of the API
    >>> auth  # the 'Authorization' header value with the access token
    {'Authorization': 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6ImMwMD...'}
    >>> tenant_id  # the UUID of the tenant to which the token provides access
  2. Assign either of the following values to the tenant_id variable – the UUID of a sub-tenant created via the API or a sub-tenant found by its name:

    >>> tenant_id = created_tenant_id
    >>> tenant_id
  3. Disable the tenant as described in steps 3-7 of “Disabling a tenant”.

  4. Obtain the number of the latest tenant revision. You will have to specify this number in a subsequent request to the tenant. This is required to manage concurrent tenant modifications.

    1. Fetch the tenant information as described in steps 3-5 of “Fetching information about an individual tenant”. As the result, you should have a tenant variable with the tenant object.

    2. Define a variable named tenant_version, and then assign the value of the version key from the tenant object to this variable:

      >>> tenant_version = tenant['version']
      >>> tenant_version
  5. Send a DELETE request to the /tenants/{tenant_id} endpoint. The endpoint URL must contain a version query parameter set to the number of the latest tenant revision:

    >>> params = {'version': tenant_version}
    >>> response = requests.delete(f'{base_url}/tenants/{tenant_id}', headers=auth, params=params)
  6. Check the status code of the response:

    >>> response.status_code

    Status code 204 means that the platform has deleted the tenant.

    A different status code means that an error has occurred. For the details, refer to “Status and error codes”.