Skip to main content

Properties

cluster_id?

optional cluster_id?: string

Description

Physical cluster to host this virtual dataplane. Omit to place it alongside the existing virtual dataplanes in this org; required when the org has none yet, or when its virtual dataplanes span more than one cluster.

dataplane_creator?

optional dataplane_creator?: string
Format: email

Description

Email of the user to grant the dataplane-creator membership to (API key actors only). A signed-in user does not see the new dataplane until their session refreshes, which happens on their next request to the control plane.

name

name: string

Description

Virtual dataplane display name. Allowed characters are letters, digits, space, underscore, hyphen, apostrophe and ampersand. The name must contain at least one letter or digit, and must not start with a space.

org_id

org_id: string

Description

The unique identifier of the organization the virtual data plane is created in