Skip to main content
PATCH
Update a data plane

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

data_plane_id
string<uuid>
required

Body

application/json

Fields to change on a data plane. Every field is optional. A field that is omitted is left unchanged.

display_name
string | null

New display name. Omitting it, or sending null, leaves the current name in place; the name itself is never cleared. Trimmed of surrounding whitespace; must be non-empty and at most 64 characters once trimmed.

Required string length: 1 - 64
description
string | null

New description. Null clears the current description; omitting the field leaves it in place. Trimmed of surrounding whitespace; at most 2048 characters once trimmed.

Maximum string length: 2048

Response

OK. The updated data plane, which the caller always owns.

type
enum<string>
required
Available options:
owned
id
string<uuid>
required
company_id
integer<int64>
required

The id of an existing company

Example:

345

created_at
string<date-time>
required
display_name
string
required
external_id
string
required
platform
object
required

A data plane hosted in an AWS account. AWS data planes outside us-east-1 currently only run (and cancel) health_check jobs, and don't support dataset creation yet: other such requests are rejected with a 400.

status
enum<string>
required
Available options:
active,
archived
updated_at
string<date-time>
required
collaborators
object
required
compute_pools
object[]
required
is_narrative
boolean
required

True for the shared data plane Narrative operates. Use this rather than matching on display_name, which the owner can change.

description
string | null
last_heartbeat_at
string<date-time> | null
tags
string[] | null
default_compute_pool_id
string<uuid> | null