Skip to main content
POST
/
data-planes
/
{data_plane_id}
/
compute-pools
Create a compute pool
curl --request POST \
  --url https://api-dev.narrative.io/data-planes/{data_plane_id}/compute-pools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": {
    "type": "snowflake_warehouse",
    "name": "<string>",
    "alias": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "name": "<string>",
  "display_name": "<string>",
  "provider": {
    "type": "snowflake_warehouse",
    "size": "x_small",
    "warehouse_type": "standard",
    "auto_suspend": 123,
    "auto_resume": true,
    "min_cluster_count": 123,
    "max_cluster_count": 123,
    "scaling_policy": "standard",
    "max_concurrency_level": 123,
    "statement_queued_timeout_in_seconds": 123,
    "statement_timeout_in_seconds": 123,
    "enable_query_acceleration": true,
    "query_acceleration_max_scale_factor": 123,
    "resource_constraint": "<string>",
    "comment": "<string>"
  },
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "collaborators": {
    "use": {
      "type": "all"
    }
  }
}
'
{
  "type": "owned",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "company_id": 123,
  "data_plane_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": {
    "type": "snowflake_warehouse",
    "name": "<string>",
    "alias": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "name": "<string>",
  "display_name": "<string>",
  "status": "active",
  "created_at": "2023-11-07T05:31:56Z",
  "tags": [
    "<string>"
  ],
  "provider": {
    "type": "snowflake_warehouse",
    "size": "x_small",
    "warehouse_type": "standard",
    "auto_suspend": 123,
    "auto_resume": true,
    "min_cluster_count": 123,
    "max_cluster_count": 123,
    "scaling_policy": "standard",
    "max_concurrency_level": 123,
    "statement_queued_timeout_in_seconds": 123,
    "statement_timeout_in_seconds": 123,
    "enable_query_acceleration": true,
    "query_acceleration_max_scale_factor": 123,
    "resource_constraint": "<string>",
    "comment": "<string>"
  },
  "collaborators": {
    "use": {
      "type": "all"
    }
  },
  "description": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

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

The data plane this compute pool belongs to.

Body

application/json
external_id
object
required
name
string
required

A unique slug identifier for the compute pool within a (company, data plane) scope.

display_name
string
required

A human-readable name for the compute pool.

provider
object
required
description
string

An optional description of the compute pool.

tags
string[]
collaborators
object

Response

Created

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