data_planes

Delete a data plane

Changed on

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}

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/orgs/current/data-planes/{id}
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Organization-Id
    • or HTTP bearer

Path parameters

idstring uuid required

Data plane ID

Response

Data plane deprovisioning started

api_urlstring
created_atstring
idstring
maintenance_windowstring
namestring
regionstring
status'requested' | 'provisioning' | 'provisioning_failed' | 'active' | 'updating' | 'inactive' | 'deprovisioning' | 'deleted' | 'revoked'
status_updated_atstring

Changes

  • e45f16e950dcRevision changes
    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status

  • 1a8ee9358d81Revision changes
    • info

      endpoint added