Check if organization can be deleted

GET

/api/v1/organizations/{id}/deletion-check

const url = 'http://localhost:3000/api/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/deletion-check';
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 http://localhost:3000/api/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/deletion-check \
  --header 'X-API-Key: <X-API-Key>'

Returns blockers preventing deletion. Requires Super Admin privileges.

Authorizations

api-key
bearer

Parameters

Path Parameters

required

string format: uuid

Organization UUID

Responses

200

Deletion check completed

application/json

object

canDelete

required

Whether the organization can be deleted

boolean

blockers

required

List of blockers preventing deletion

Array<object>

object

type

required

Type of blocker

string

Allowed values: users devices deployments applications

count

required

Count of resources blocking deletion

number

message

required

Human-readable message

string

Example

{
  "blockers": [
    {
      "type": "users"
    }
  ]
}

401

Unauthorized

403

Forbidden - Super Admin required

404

Organization not found