Update data plane settings

Update specific settings for a data plane owned by the caller’s organization.

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

Error

A valid request URL is required to generate request examples

200

{
  "api_url": "<string>",
  "created_at": "<string>",
  "firewall": {
    "allowed_domains": [
      "<string>"
    ]
  },
  "id": "<string>",
  "maintenance_window": "<string>",
  "name": "<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 · required

Data plane ID

Body

application/json

firewall · object

Show child attributes

maintenance_window · string

MaintenanceWindow is the two-hour weekly maintenance window in UTC.

ttl · object

Show child attributes

Response

200

application/json

Updated data plane

api_url · string

created_at · string

firewall · object

Show child attributes

id · string

maintenance_window · string

name · string

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