Skip to main content
POST
Create a data plane

Authorizations

Authorization
string
header
required

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

Body

application/json
display_name
string
required

Human-readable name, trimmed of surrounding whitespace. Must be non-empty and at most 64 characters once trimmed. The limit is set by what the platform UI can display: its data plane picker shows roughly 51 characters before it ellipsizes.

Required string length: 1 - 64
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.

tags
string[]
required
Minimum string length: 1
description
string | null

Optional description, trimmed of surrounding whitespace. At most 2048 characters once trimmed.

Maximum string length: 2048
collaborators
object | null

Who else may use the data plane. Nobody, when omitted or null.

Response

Created. The new data plane, which the caller always owns. Its compute_pools list is empty.

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