Create a new data plane

Creates a new data plane object. Persists the rendered data plane spec, and returns 202 with the data plane in status=requested. Requires BYOC enabled org and org admin.

POST /orgs/current/data-planes

Error

A valid request URL is required to generate request examples

202

{
  "api_url": "<string>",
  "created_at": "<string>",
  "id": "<string>",
  "name": "<string>",
  "region": "<string>",
  "status_updated_at": "<string>",
  "workspaces": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "error": "<string>",
  "missing_permissions": [
    {
      "action": "<string>",
      "decision": "<string>",
      "resource_arn": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "error": "<string>",
  "missing_permissions": [
    {
      "action": "<string>",
      "decision": "<string>",
      "resource_arn": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "error": "<string>",
  "missing_permissions": [
    {
      "action": "<string>",
      "decision": "<string>",
      "resource_arn": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "error": "<string>",
  "missing_permissions": [
    {
      "action": "<string>",
      "decision": "<string>",
      "resource_arn": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "error": "<string>",
  "missing_permissions": [
    {
      "action": "<string>",
      "decision": "<string>",
      "resource_arn": "<string>"
    }
  ]
}

Authorizations

API KeyOrganization IDBearer Auth

X-API-Key · string · header · required

Body

application/json

external_id · string

name · string

public_load_balancer · boolean

region · string

role_arn · string

vpc_cidr · string

Response

202

application/json

Data plane requested

api_url · string

created_at · string

id · string

name · string

region · string

status · enum<string>

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

status_updated_at · string

workspaces · object[]

Show child attributes