Deployments

A deployment is composed of one or multiple replicas.

List deployments

GET

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments

List all deployments in the specified region, for a given Scaleway Project. By default, the deployments returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as tags and name. For the name parameter, the value you provide will be checked against the whole name string to see if it includes the string you put in the parameter.

List deployments › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

List deployments › query Parameters

tags

string[]

List deployments with a given tag.

name

string

Lists deployments that match a name pattern.

order_by

string · enum

Criteria to use when ordering deployment listings.

Enum values:

created_at_desc

created_at_asc

name_asc

name_desc

Default: created_at_desc

organization_id

string

Organization ID the deployment belongs to. (UUID format)

project_id

string

Project ID the deployment belongs to. (UUID format)

page

integer · int32

page_size

integer · uint32

List deployments › Responses

200

scaleway.datawarehouse.v1beta1.ListDeploymentsResponse

scaleway.datawarehouse.v1beta1.Deployment[]

List of all deployments available in an Organization or Project.

total_count

integer · uint64

Total count of deployments available in an Organization or Project.

GET/datawarehouse/v1beta1/regions/{region}/deployments

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/datawarehouse/v1beta1/regions/{region}/deployments"

Example Responses

{
  "deployments": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "name": "name",
      "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
      "project_id": "6170692e-7363-616c-6577-61792e636f6d",
      "status": "unknown_status",
      "tags": [
        "string"
      ],
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "version": "version",
      "replica_count": 0,
      "shard_count": 0,
      "cpu_min": 0,
      "cpu_max": 0,
      "endpoints": [
        {
          "id": "6170692e-7363-616c-6577-61792e636f6d",
          "dns_record": "dns_record",
          "services": [
            {
              "protocol": "unknown_protocol",
              "port": 0
            }
          ],
          "private_network": {
            "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
          },
          "public": {}
        }
      ],
      "ram_per_cpu": 0,
      "region": "region"
    }
  ],
  "total_count": 0
}

json

application/json

Create a deployment

POST

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments

Create a new deployment.

Create a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

Create a deployment › Request Body

project_id

string

The Project ID on which the deployment will be created.

name

string

Name of the deployment.

tags

string[]

Tags to apply to the deployment.

version

string

ClickHouse® version to use for the deployment.

replica_count

integer · uint32

Number of replicas for the deployment.

shard_count

integer · uint32

Number of shard for the deployment.

password

string

Password for the initial user.

cpu_min

integer · uint32

Minimum CPU count for the deployment.

cpu_max

integer · uint32

Maximum CPU count for the deployment.

scaleway.datawarehouse.v1beta1.EndpointSpec[]

Endpoints to associate with the deployment.

ram_per_cpu

integer · uint32

RAM per CPU count for the deployment (in GB).

Create a deployment › Responses

200

scaleway.datawarehouse.v1beta1.Deployment

id

string

Unique identifier. (UUID format)

name

string

Name of the deployment.

organization_id

string

Organization ID. (UUID format)

project_id

string

Project ID. (UUID format)

status

string · enum

Status of the deployment.

Enum values:

unknown_status

ready

creating

configuring

deleting

error

locked

locking

Default: unknown_status

tags

string[]

List of tags applied to the deployment.

created_at

string · date-time

Creation date of the deployment. (RFC 3339 format)

updated_at

string · date-time

Last modification date of the deployment. (RFC 3339 format)

version

string

ClickHouse® version.

replica_count

integer · uint32

Number of replicas for the deployment.

shard_count

integer · uint32

Number of shards for the deployment.

cpu_min

integer · uint32

Minimum CPU count for the deployment.

cpu_max

integer · uint32

Maximum CPU count for the deployment.

scaleway.datawarehouse.v1beta1.Endpoint[]

List of endpoints associated with the deployment.

ram_per_cpu

integer · uint32

RAM per CPU count for the deployment (in GB).

region

string

Region of the deployment.

POST/datawarehouse/v1beta1/regions/{region}/deployments

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "cpu_max": 42,
    "cpu_min": 42,
    "name": "string",
    "password": "string",
    "project_id": "string",
    "ram_per_cpu": 42,
    "replica_count": 42,
    "version": "string"
  }' \
  "https://api.scaleway.com/datawarehouse/v1beta1/regions/{region}/deployments"

Example Request Body

{
  "project_id": "project_id",
  "name": "name",
  "tags": [
    "string"
  ],
  "version": "version",
  "replica_count": 0,
  "shard_count": 0,
  "password": "password",
  "cpu_min": 0,
  "cpu_max": 0,
  "endpoints": [
    {
      "public": {},
      "private_network": {
        "private_network_id": "private_network_id"
      }
    }
  ],
  "ram_per_cpu": 0
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "version": "version",
  "replica_count": 0,
  "shard_count": 0,
  "cpu_min": 0,
  "cpu_max": 0,
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "services": [
        {
          "protocol": "unknown_protocol",
          "port": 0
        }
      ],
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public": {}
    }
  ],
  "ram_per_cpu": 0,
  "region": "region"
}

json

application/json

Get a deployment

GET

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}

Retrieve information about a given deployment, specified by the region and deployment_id parameters. Its full details, including name, status are returned in the response object.

Get a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment.

Get a deployment › Responses

200

scaleway.datawarehouse.v1beta1.Deployment

id

string

Unique identifier. (UUID format)

name

string

Name of the deployment.

organization_id

string

Organization ID. (UUID format)

project_id

string

Project ID. (UUID format)

status

string · enum

Status of the deployment.

Enum values:

unknown_status

ready

creating

configuring

deleting

error

locked

locking

Default: unknown_status

tags

string[]

List of tags applied to the deployment.

created_at

string · date-time

Creation date of the deployment. (RFC 3339 format)

updated_at

string · date-time

Last modification date of the deployment. (RFC 3339 format)

version

string

ClickHouse® version.

replica_count

integer · uint32

Number of replicas for the deployment.

shard_count

integer · uint32

Number of shards for the deployment.

cpu_min

integer · uint32

Minimum CPU count for the deployment.

cpu_max

integer · uint32

Maximum CPU count for the deployment.

scaleway.datawarehouse.v1beta1.Endpoint[]

List of endpoints associated with the deployment.

ram_per_cpu

integer · uint32

RAM per CPU count for the deployment (in GB).

region

string

Region of the deployment.

GET/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "version": "version",
  "replica_count": 0,
  "shard_count": 0,
  "cpu_min": 0,
  "cpu_max": 0,
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "services": [
        {
          "protocol": "unknown_protocol",
          "port": 0
        }
      ],
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public": {}
    }
  ],
  "ram_per_cpu": 0,
  "region": "region"
}

json

application/json

Delete a deployment

DELETE

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}

Delete a given deployment, specified by the region and deployment_id parameters. Deleting a deployment is permanent, and cannot be undone. Upon deletion, all your data will be lost.

Delete a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment to delete.

Delete a deployment › Responses

200

scaleway.datawarehouse.v1beta1.Deployment

id

string

Unique identifier. (UUID format)

name

string

Name of the deployment.

organization_id

string

Organization ID. (UUID format)

project_id

string

Project ID. (UUID format)

status

string · enum

Status of the deployment.

Enum values:

unknown_status

ready

creating

configuring

deleting

error

locked

locking

Default: unknown_status

tags

string[]

List of tags applied to the deployment.

created_at

string · date-time

Creation date of the deployment. (RFC 3339 format)

updated_at

string · date-time

Last modification date of the deployment. (RFC 3339 format)

version

string

ClickHouse® version.

replica_count

integer · uint32

Number of replicas for the deployment.

shard_count

integer · uint32

Number of shards for the deployment.

cpu_min

integer · uint32

Minimum CPU count for the deployment.

cpu_max

integer · uint32

Maximum CPU count for the deployment.

scaleway.datawarehouse.v1beta1.Endpoint[]

List of endpoints associated with the deployment.

ram_per_cpu

integer · uint32

RAM per CPU count for the deployment (in GB).

region

string

Region of the deployment.

DELETE/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "version": "version",
  "replica_count": 0,
  "shard_count": 0,
  "cpu_min": 0,
  "cpu_max": 0,
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "services": [
        {
          "protocol": "unknown_protocol",
          "port": 0
        }
      ],
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public": {}
    }
  ],
  "ram_per_cpu": 0,
  "region": "region"
}

json

application/json

Update a deployment

PATCH

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}

Update the parameters of a deployment.

Update a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment to update.

Update a deployment › Request Body

name

string

Name of the deployment.

tags

string[]

Tags of a deployment.

cpu_min

integer · uint32

Minimum CPU count for the deployment.

cpu_max

integer · uint32

Maximum CPU count for the deployment.

replica_count

integer · uint32

Number of replicas for the deployment.

Update a deployment › Responses

200

scaleway.datawarehouse.v1beta1.Deployment

id

string

Unique identifier. (UUID format)

name

string

Name of the deployment.

organization_id

string

Organization ID. (UUID format)

project_id

string

Project ID. (UUID format)

status

string · enum

Status of the deployment.

Enum values:

unknown_status

ready

creating

configuring

deleting

error

locked

locking

Default: unknown_status

tags

string[]

List of tags applied to the deployment.

created_at

string · date-time

Creation date of the deployment. (RFC 3339 format)

updated_at

string · date-time

Last modification date of the deployment. (RFC 3339 format)

version

string

ClickHouse® version.

replica_count

integer · uint32

Number of replicas for the deployment.

shard_count

integer · uint32

Number of shards for the deployment.

cpu_min

integer · uint32

Minimum CPU count for the deployment.

cpu_max

integer · uint32

Maximum CPU count for the deployment.

scaleway.datawarehouse.v1beta1.Endpoint[]

List of endpoints associated with the deployment.

ram_per_cpu

integer · uint32

RAM per CPU count for the deployment (in GB).

region

string

Region of the deployment.

PATCH/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}"

Example Request Body

{
  "name": "name",
  "tags": [
    "string"
  ],
  "cpu_min": 0,
  "cpu_max": 0,
  "replica_count": 0
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "version": "version",
  "replica_count": 0,
  "shard_count": 0,
  "cpu_min": 0,
  "cpu_max": 0,
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "services": [
        {
          "protocol": "unknown_protocol",
          "port": 0
        }
      ],
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public": {}
    }
  ],
  "ram_per_cpu": 0,
  "region": "region"
}

json

application/json

Get deployment TLS certificate

GET

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/certificate

Retrieve the TLS certificate associated with a deployment.

Get deployment TLS certificate › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment.

Get deployment TLS certificate › Responses

200

scaleway.std.File

name

string

content_type

string

content

string

Start a deployment

POST

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/start

Start a stopped deployment.

Start a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment.

Start a deployment › Request Body

Start a deployment › Responses

200

scaleway.datawarehouse.v1beta1.Deployment

id

string

Unique identifier. (UUID format)

name

string

Name of the deployment.

organization_id

string

Organization ID. (UUID format)

project_id

string

Project ID. (UUID format)

status

string · enum

Status of the deployment.

Enum values:

unknown_status

ready

creating

configuring

deleting

error

locked

locking

Default: unknown_status

tags

string[]

List of tags applied to the deployment.

created_at

string · date-time

Creation date of the deployment. (RFC 3339 format)

updated_at

string · date-time

Last modification date of the deployment. (RFC 3339 format)

version

string

ClickHouse® version.

replica_count

integer · uint32

Number of replicas for the deployment.

shard_count

integer · uint32

Number of shards for the deployment.

cpu_min

integer · uint32

Minimum CPU count for the deployment.

cpu_max

integer · uint32

Maximum CPU count for the deployment.

scaleway.datawarehouse.v1beta1.Endpoint[]

List of endpoints associated with the deployment.

ram_per_cpu

integer · uint32

RAM per CPU count for the deployment (in GB).

region

string

Region of the deployment.

POST/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/start

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/start"

Example Request Body

{}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "version": "version",
  "replica_count": 0,
  "shard_count": 0,
  "cpu_min": 0,
  "cpu_max": 0,
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "services": [
        {
          "protocol": "unknown_protocol",
          "port": 0
        }
      ],
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public": {}
    }
  ],
  "ram_per_cpu": 0,
  "region": "region"
}

json

application/json

Stop a deployment

POST

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/stop

Stop a running deployment.

Stop a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment.

Stop a deployment › Request Body

Stop a deployment › Responses

200

scaleway.datawarehouse.v1beta1.Deployment

id

string

Unique identifier. (UUID format)

name

string

Name of the deployment.

organization_id

string

Organization ID. (UUID format)

project_id

string

Project ID. (UUID format)

status

string · enum

Status of the deployment.

Enum values:

unknown_status

ready

creating

configuring

deleting

error

locked

locking

Default: unknown_status

tags

string[]

List of tags applied to the deployment.

created_at

string · date-time

Creation date of the deployment. (RFC 3339 format)

updated_at

string · date-time

Last modification date of the deployment. (RFC 3339 format)

version

string

ClickHouse® version.

replica_count

integer · uint32

Number of replicas for the deployment.

shard_count

integer · uint32

Number of shards for the deployment.

cpu_min

integer · uint32

Minimum CPU count for the deployment.

cpu_max

integer · uint32

Maximum CPU count for the deployment.

scaleway.datawarehouse.v1beta1.Endpoint[]

List of endpoints associated with the deployment.

ram_per_cpu

integer · uint32

RAM per CPU count for the deployment (in GB).

region

string

Region of the deployment.

POST/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/stop

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/stop"

Example Request Body

{}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "version": "version",
  "replica_count": 0,
  "shard_count": 0,
  "cpu_min": 0,
  "cpu_max": 0,
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "services": [
        {
          "protocol": "unknown_protocol",
          "port": 0
        }
      ],
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public": {}
    }
  ],
  "ram_per_cpu": 0,
  "region": "region"
}

json

application/json

Presets

Data Warehouse API

Deployments

Download schema

A deployment is composed of one or multiple replicas.

List deployments

GET

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments

List deployments › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

List deployments › query Parameters

tags

string[]

List deployments with a given tag.

name

string

Lists deployments that match a name pattern.

order_by

string · enum

Criteria to use when ordering deployment listings.

Enum values:

created_at_desc

created_at_asc

name_asc

name_desc

Default: created_at_desc

organization_id

string

Organization ID the deployment belongs to. (UUID format)

project_id

string

Project ID the deployment belongs to. (UUID format)

page

integer · int32

page_size

integer · uint32

List deployments › Responses

200

scaleway.datawarehouse.v1beta1.ListDeploymentsResponse

scaleway.datawarehouse.v1beta1.Deployment[]

List of all deployments available in an Organization or Project.

total_count

integer · uint64

Total count of deployments available in an Organization or Project.

GET/datawarehouse/v1beta1/regions/{region}/deployments

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/datawarehouse/v1beta1/regions/{region}/deployments"

Example Responses

{
  "deployments": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "name": "name",
      "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
      "project_id": "6170692e-7363-616c-6577-61792e636f6d",
      "status": "unknown_status",
      "tags": [
        "string"
      ],
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "version": "version",
      "replica_count": 0,
      "shard_count": 0,
      "cpu_min": 0,
      "cpu_max": 0,
      "endpoints": [
        {
          "id": "6170692e-7363-616c-6577-61792e636f6d",
          "dns_record": "dns_record",
          "services": [
            {
              "protocol": "unknown_protocol",
              "port": 0
            }
          ],
          "private_network": {
            "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
          },
          "public": {}
        }
      ],
      "ram_per_cpu": 0,
      "region": "region"
    }
  ],
  "total_count": 0
}

json

application/json

Create a deployment

POST

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments

Create a new deployment.

Create a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

Create a deployment › Request Body

project_id

string

The Project ID on which the deployment will be created.

name

string

Name of the deployment.

tags

string[]

Tags to apply to the deployment.

version

string

ClickHouse® version to use for the deployment.

replica_count

integer · uint32

Number of replicas for the deployment.

shard_count

integer · uint32

Number of shard for the deployment.

password

string

Password for the initial user.

cpu_min

integer · uint32

Minimum CPU count for the deployment.

cpu_max

integer · uint32

Maximum CPU count for the deployment.

scaleway.datawarehouse.v1beta1.EndpointSpec[]

Endpoints to associate with the deployment.

ram_per_cpu

integer · uint32

RAM per CPU count for the deployment (in GB).

Create a deployment › Responses

200

scaleway.datawarehouse.v1beta1.Deployment

id

string

Unique identifier. (UUID format)

name

string

Name of the deployment.

organization_id

string

Organization ID. (UUID format)

project_id

string

Project ID. (UUID format)

status

string · enum

Status of the deployment.

Enum values:

unknown_status

ready

creating

configuring

deleting

error

locked

locking

Default: unknown_status

tags

string[]

List of tags applied to the deployment.

created_at

string · date-time

Creation date of the deployment. (RFC 3339 format)

updated_at

string · date-time

Last modification date of the deployment. (RFC 3339 format)

version

string

ClickHouse® version.

replica_count

integer · uint32

Number of replicas for the deployment.

shard_count

integer · uint32

Number of shards for the deployment.

cpu_min

integer · uint32

Minimum CPU count for the deployment.

cpu_max

integer · uint32

Maximum CPU count for the deployment.

scaleway.datawarehouse.v1beta1.Endpoint[]

List of endpoints associated with the deployment.

ram_per_cpu

integer · uint32

RAM per CPU count for the deployment (in GB).

region

string

Region of the deployment.

POST/datawarehouse/v1beta1/regions/{region}/deployments

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "cpu_max": 42,
    "cpu_min": 42,
    "name": "string",
    "password": "string",
    "project_id": "string",
    "ram_per_cpu": 42,
    "replica_count": 42,
    "version": "string"
  }' \
  "https://api.scaleway.com/datawarehouse/v1beta1/regions/{region}/deployments"

Example Request Body

{
  "project_id": "project_id",
  "name": "name",
  "tags": [
    "string"
  ],
  "version": "version",
  "replica_count": 0,
  "shard_count": 0,
  "password": "password",
  "cpu_min": 0,
  "cpu_max": 0,
  "endpoints": [
    {
      "public": {},
      "private_network": {
        "private_network_id": "private_network_id"
      }
    }
  ],
  "ram_per_cpu": 0
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "version": "version",
  "replica_count": 0,
  "shard_count": 0,
  "cpu_min": 0,
  "cpu_max": 0,
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "services": [
        {
          "protocol": "unknown_protocol",
          "port": 0
        }
      ],
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public": {}
    }
  ],
  "ram_per_cpu": 0,
  "region": "region"
}

json

application/json

Get a deployment

GET

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}

Retrieve information about a given deployment, specified by the region and deployment_id parameters. Its full details, including name, status are returned in the response object.

Get a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment.

Get a deployment › Responses

200

scaleway.datawarehouse.v1beta1.Deployment

id

string

Unique identifier. (UUID format)

name

string

Name of the deployment.

organization_id

string

Organization ID. (UUID format)

project_id

string

Project ID. (UUID format)

status

string · enum

Status of the deployment.

Enum values:

unknown_status

ready

creating

configuring

deleting

error

locked

locking

Default: unknown_status

tags

string[]

List of tags applied to the deployment.

created_at

string · date-time

Creation date of the deployment. (RFC 3339 format)

updated_at

string · date-time

Last modification date of the deployment. (RFC 3339 format)

version

string

ClickHouse® version.

replica_count

integer · uint32

Number of replicas for the deployment.

shard_count

integer · uint32

Number of shards for the deployment.

cpu_min

integer · uint32

Minimum CPU count for the deployment.

cpu_max

integer · uint32

Maximum CPU count for the deployment.

scaleway.datawarehouse.v1beta1.Endpoint[]

List of endpoints associated with the deployment.

ram_per_cpu

integer · uint32

RAM per CPU count for the deployment (in GB).

region

string

Region of the deployment.

GET/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "version": "version",
  "replica_count": 0,
  "shard_count": 0,
  "cpu_min": 0,
  "cpu_max": 0,
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "services": [
        {
          "protocol": "unknown_protocol",
          "port": 0
        }
      ],
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public": {}
    }
  ],
  "ram_per_cpu": 0,
  "region": "region"
}

json

application/json

Delete a deployment

DELETE

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}

Delete a given deployment, specified by the region and deployment_id parameters. Deleting a deployment is permanent, and cannot be undone. Upon deletion, all your data will be lost.

Delete a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment to delete.

Delete a deployment › Responses

200

scaleway.datawarehouse.v1beta1.Deployment

id

string

Unique identifier. (UUID format)

name

string

Name of the deployment.

organization_id

string

Organization ID. (UUID format)

project_id

string

Project ID. (UUID format)

status

string · enum

Status of the deployment.

Enum values:

unknown_status

ready

creating

configuring

deleting

error

locked

locking

Default: unknown_status

tags

string[]

List of tags applied to the deployment.

created_at

string · date-time

Creation date of the deployment. (RFC 3339 format)

updated_at

string · date-time

Last modification date of the deployment. (RFC 3339 format)

version

string

ClickHouse® version.

replica_count

integer · uint32

Number of replicas for the deployment.

shard_count

integer · uint32

Number of shards for the deployment.

cpu_min

integer · uint32

Minimum CPU count for the deployment.

cpu_max

integer · uint32

Maximum CPU count for the deployment.

scaleway.datawarehouse.v1beta1.Endpoint[]

List of endpoints associated with the deployment.

ram_per_cpu

integer · uint32

RAM per CPU count for the deployment (in GB).

region

string

Region of the deployment.

DELETE/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "version": "version",
  "replica_count": 0,
  "shard_count": 0,
  "cpu_min": 0,
  "cpu_max": 0,
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "services": [
        {
          "protocol": "unknown_protocol",
          "port": 0
        }
      ],
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public": {}
    }
  ],
  "ram_per_cpu": 0,
  "region": "region"
}

json

application/json

Update a deployment

PATCH

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}

Update the parameters of a deployment.

Update a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment to update.

Update a deployment › Request Body

name

string

Name of the deployment.

tags

string[]

Tags of a deployment.

cpu_min

integer · uint32

Minimum CPU count for the deployment.

cpu_max

integer · uint32

Maximum CPU count for the deployment.

replica_count

integer · uint32

Number of replicas for the deployment.

Update a deployment › Responses

200

scaleway.datawarehouse.v1beta1.Deployment

id

string

Unique identifier. (UUID format)

name

string

Name of the deployment.

organization_id

string

Organization ID. (UUID format)

project_id

string

Project ID. (UUID format)

status

string · enum

Status of the deployment.

Enum values:

unknown_status

ready

creating

configuring

deleting

error

locked

locking

Default: unknown_status

tags

string[]

List of tags applied to the deployment.

created_at

string · date-time

Creation date of the deployment. (RFC 3339 format)

updated_at

string · date-time

Last modification date of the deployment. (RFC 3339 format)

version

string

ClickHouse® version.

replica_count

integer · uint32

Number of replicas for the deployment.

shard_count

integer · uint32

Number of shards for the deployment.

cpu_min

integer · uint32

Minimum CPU count for the deployment.

cpu_max

integer · uint32

Maximum CPU count for the deployment.

scaleway.datawarehouse.v1beta1.Endpoint[]

List of endpoints associated with the deployment.

ram_per_cpu

integer · uint32

RAM per CPU count for the deployment (in GB).

region

string

Region of the deployment.

PATCH/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}"

Example Request Body

{
  "name": "name",
  "tags": [
    "string"
  ],
  "cpu_min": 0,
  "cpu_max": 0,
  "replica_count": 0
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "version": "version",
  "replica_count": 0,
  "shard_count": 0,
  "cpu_min": 0,
  "cpu_max": 0,
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "services": [
        {
          "protocol": "unknown_protocol",
          "port": 0
        }
      ],
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public": {}
    }
  ],
  "ram_per_cpu": 0,
  "region": "region"
}

json

application/json

Get deployment TLS certificate

GET

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/certificate

Retrieve the TLS certificate associated with a deployment.

Get deployment TLS certificate › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment.

Get deployment TLS certificate › Responses

200

scaleway.std.File

name

string

content_type

string

content

string

Start a deployment

POST

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/start

Start a stopped deployment.

Start a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment.

Start a deployment › Request Body

Start a deployment › Responses

200

scaleway.datawarehouse.v1beta1.Deployment

id

string

Unique identifier. (UUID format)

name

string

Name of the deployment.

organization_id

string

Organization ID. (UUID format)

project_id

string

Project ID. (UUID format)

status

string · enum

Status of the deployment.

Enum values:

unknown_status

ready

creating

configuring

deleting

error

locked

locking

Default: unknown_status

tags

string[]

List of tags applied to the deployment.

created_at

string · date-time

Creation date of the deployment. (RFC 3339 format)

updated_at

string · date-time

Last modification date of the deployment. (RFC 3339 format)

version

string

ClickHouse® version.

replica_count

integer · uint32

Number of replicas for the deployment.

shard_count

integer · uint32

Number of shards for the deployment.

cpu_min

integer · uint32

Minimum CPU count for the deployment.

cpu_max

integer · uint32

Maximum CPU count for the deployment.

scaleway.datawarehouse.v1beta1.Endpoint[]

List of endpoints associated with the deployment.

ram_per_cpu

integer · uint32

RAM per CPU count for the deployment (in GB).

region

string

Region of the deployment.

POST/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/start

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/start"

Example Request Body

{}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "version": "version",
  "replica_count": 0,
  "shard_count": 0,
  "cpu_min": 0,
  "cpu_max": 0,
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "services": [
        {
          "protocol": "unknown_protocol",
          "port": 0
        }
      ],
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public": {}
    }
  ],
  "ram_per_cpu": 0,
  "region": "region"
}

json

application/json

Stop a deployment

POST

https://api.scaleway.com

/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/stop

Stop a running deployment.

Stop a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment.

Stop a deployment › Request Body

Stop a deployment › Responses

200

scaleway.datawarehouse.v1beta1.Deployment

id

string

Unique identifier. (UUID format)

name

string

Name of the deployment.

organization_id

string

Organization ID. (UUID format)

project_id

string

Project ID. (UUID format)

status

string · enum

Status of the deployment.

Enum values:

unknown_status

ready

creating

configuring

deleting

error

locked

locking

Default: unknown_status

tags

string[]

List of tags applied to the deployment.

created_at

string · date-time

Creation date of the deployment. (RFC 3339 format)

updated_at

string · date-time

Last modification date of the deployment. (RFC 3339 format)

version

string

ClickHouse® version.

replica_count

integer · uint32

Number of replicas for the deployment.

shard_count

integer · uint32

Number of shards for the deployment.

cpu_min

integer · uint32

Minimum CPU count for the deployment.

cpu_max

integer · uint32

Maximum CPU count for the deployment.

scaleway.datawarehouse.v1beta1.Endpoint[]

List of endpoints associated with the deployment.

ram_per_cpu

integer · uint32

RAM per CPU count for the deployment (in GB).

region

string

Region of the deployment.

POST/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/stop

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/stop"

Example Request Body

{}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "version": "version",
  "replica_count": 0,
  "shard_count": 0,
  "cpu_min": 0,
  "cpu_max": 0,
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "services": [
        {
          "protocol": "unknown_protocol",
          "port": 0
        }
      ],
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public": {}
    }
  ],
  "ram_per_cpu": 0,
  "region": "region"
}

json

application/json

Presets