Skip to main content
POST
/
data-planes
Create a data plane
curl --request POST \
  --url https://api-dev.narrative.io/data-planes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "external_id": "<string>",
  "platform": {
    "type": "platform_aws",
    "region": "<string>"
  },
  "tags": [
    "<string>"
  ],
  "description": "<string>",
  "collaborators": {
    "participants": {
      "type": "all"
    }
  }
}
'
{
  "type": "owned",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "company_id": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "display_name": "<string>",
  "external_id": "<string>",
  "platform": {
    "type": "platform_aws",
    "region": "<string>"
  },
  "status": "active",
  "updated_at": "2023-11-07T05:31:56Z",
  "collaborators": {
    "participants": {
      "type": "all"
    }
  },
  "description": "<string>",
  "last_heartbeat_at": "2023-11-07T05:31:56Z",
  "tags": [
    "<string>"
  ]
}

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
external_id
string
required
platform
object
required
tags
string[]
required
description
string
collaborators
object

Response

200 - application/json

Created

type
enum<string>
required
Available options:
owned
id
string<uuid>
required
company_id
number
required
created_at
string<date-time>
required
display_name
string
required
external_id
string
required
platform
object
required
status
enum<string>
required
Available options:
active,
archived
updated_at
string<date-time>
required
collaborators
object
required
description
string
last_heartbeat_at
string<date-time>
tags
string[]