Delete a data plane

Verifies that the stored customer AWS role has delete permissions, that the stored Azure subscription is reachable, or that the stored GCP provisioner service account can be impersonated. Then removes linked workspaces and starts asynchronous deprovisioning for an active or provisioning_failed data plane owned by the caller’s organization. Azure and GCP data planes can also be deleted while provisioning. Requires BYOC to be enabled for the org and organization:infrastructure:manage.

DELETE /orgs/current/data-planes/{id}

Error

A valid request URL is required to generate request examples

202

{
  "api_url": "<string>",
  "created_at": "<string>",
  "firewall": {
    "allow_http": true,
    "allowed_cidrs": {},
    "allowed_domains": [
      "<string>"
    ]
  },
  "fleet_oidc": {
    "audience": "<string>",
    "email_claim": "<string>",
    "groups_claim": "<string>",
    "is_enabled": true,
    "issuer_url": "<string>",
    "provider": "<string>",
    "subject_claim": "<string>",
    "tenant_claim": "<string>",
    "tenant_mappings": {}
  },
  "id": "<string>",
  "maintenance_window": "<string>",
  "name": "<string>",
  "provisioning_settings": {
    "additional_tags": {},
    "azure_entra_tenant_id": "<string>",
    "byoiam": {
      "is_enabled": true
    },
    "byovpc": {
      "private_app_subnet_ids": [
        "<string>"
      ],
      "private_db_subnet_ids": [
        "<string>"
      ],
      "public_subnet_ids": [
        "<string>"
      ],
      "vpc_id": "<string>"
    },
    "cloud": "AWS",
    "gcp_project_id": "<string>",
    "is_eks_api_privatelink_disabled": true,
    "is_gcp_byoiam_enabled": true,
    "is_public_load_balancer": true,
    "provisioner_service_account": "<string>",
    "resource_group_id": "<string>",
    "role_arn": "<string>",
    "trace_storage": "CLICKHOUSE",
    "vpc_cidr": "<string>"
  },
  "region": "<string>",
  "status": "requested",
  "status_updated_at": "<string>",
  "ttl": {
    "enabled": true,
    "long_days": 123,
    "short_days": 123
  },
  "workspaces": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ]
}

Authorizations

API KeyOrganization IDBearer Auth

X-API-Key · string · header · required

Path Parameters

id · string<uuid> · required

Data plane ID

Response

202

application/json

Data plane deprovisioning started

api_url · string

created_at · string

firewall · object

Show child attributes

fleet_oidc · object

Show child attributes

id · string

maintenance_window · string

name · string

provisioning_settings · object

Show child attributes

region · string

status · enum<string>

Available options: requested, provisioning, provisioning_failed, active, updating, inactive, deprovisioning, deleted, revoked

status_updated_at · string

ttl · object

Show child attributes

workspaces · object[]

Show child attributes