Kafka Clusters

id

string

UUID of the Kafka cluster. (UUID format)

name

string

Name of the Kafka cluster.

project_id

string

Project ID the Kafka cluster belongs to. (UUID format)

organization_id

string

Organisation ID the Kafka cluster belongs to. (UUID format)

status

string · enum

Status of the Kafka cluster.

Enum values:

unknown_status

ready

creating

configuring

deleting

error

locked

stopped

Default: unknown_status

version

string

Kafka version of the Kafka cluster.

tags

string[]

List of tags applied to the Kafka cluster.

Advanced settings of the Kafka cluster.

node_amount

integer · uint32

Number of nodes in Kafka cluster.

node_type

string

Node type of the Kafka cluster.

object

Volumes of the Kafka cluster.

List of Kafka cluster endpoints.

created_at

string · date-time

Creation date (must follow the ISO 8601 format). (RFC 3339 format)

updated_at

string · date-time

Last update date (must follow the ISO 8601 format). (RFC 3339 format)

region

string

Region the Kafka cluster is in.

multi_az

object

MultiAZ tell the cluster is deployed on multiple availability zones in the region.

object

MonoAZ details.

POST/kafka/v1alpha1/regions/{region}/clusters

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "node_amount": 42,
    "node_type": "string",
    "project_id": "string",
    "version": "string"
  }' \
  "https://api.scaleway.com/kafka/v1alpha1/regions/{region}/clusters"

Example Request Body

{
  "project_id": "project_id",
  "name": "name",
  "version": "version",
  "tags": [
    "string"
  ],
  "node_amount": 0,
  "node_type": "node_type",
  "volume": {
    "size_bytes": 0,
    "type": "unknown_type"
  },
  "endpoints": [
    {
      "public_network": {},
      "private_network": {
        "private_network_id": "private_network_id"
      }
    }
  ],
  "user_name": "user_name",
  "password": "password",
  "multi_az": {},
  "mono_az": {
    "zone": "zone"
  }
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "version": "version",
  "tags": [
    "string"
  ],
  "settings": [
    {
      "name": "name",
      "bool_value": true,
      "string_value": "string_value",
      "int_value": 0,
      "float_value": 0
    }
  ],
  "node_amount": 0,
  "node_type": "node_type",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0
  },
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_records": [
        "string"
      ],
      "port": 0,
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public_network": {}
    }
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "region": "region",
  "multi_az": {},
  "mono_az": {
    "zone": "zone"
  }
}

json

application/json

Get a Kafka cluster

GET

https://api.scaleway.com

/kafka/v1alpha1/regions/{region}/clusters/{cluster_id}

Retrieve information about a given Kafka cluster, specified by the region and cluster_id parameters. Its full details, including name, status, IP address and port, are returned in the response object.

Get a Kafka cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

cluster_id

string · required

UUID of the Kafka Cluster.

Get a Kafka cluster › Responses

200

id

string

UUID of the Kafka cluster. (UUID format)

name

string

Name of the Kafka cluster.

project_id

string

Project ID the Kafka cluster belongs to. (UUID format)

organization_id

string

Organisation ID the Kafka cluster belongs to. (UUID format)

status

string · enum

Status of the Kafka cluster.

Enum values:

unknown_status

ready

creating

configuring

deleting

error

locked

stopped

Default: unknown_status

version

string

Kafka version of the Kafka cluster.

tags

string[]

List of tags applied to the Kafka cluster.

Advanced settings of the Kafka cluster.

node_amount

integer · uint32

Number of nodes in Kafka cluster.

node_type

string

Node type of the Kafka cluster.

object

Volumes of the Kafka cluster.

List of Kafka cluster endpoints.

created_at

string · date-time

Creation date (must follow the ISO 8601 format). (RFC 3339 format)

updated_at

string · date-time

Last update date (must follow the ISO 8601 format). (RFC 3339 format)

region

string

Region the Kafka cluster is in.

multi_az

object

MultiAZ tell the cluster is deployed on multiple availability zones in the region.

object

MonoAZ details.

GET/kafka/v1alpha1/regions/{region}/clusters/{cluster_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/kafka/v1alpha1/regions/{region}/clusters/{cluster_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "version": "version",
  "tags": [
    "string"
  ],
  "settings": [
    {
      "name": "name",
      "bool_value": true,
      "string_value": "string_value",
      "int_value": 0,
      "float_value": 0
    }
  ],
  "node_amount": 0,
  "node_type": "node_type",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0
  },
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_records": [
        "string"
      ],
      "port": 0,
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public_network": {}
    }
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "region": "region",
  "multi_az": {},
  "mono_az": {
    "zone": "zone"
  }
}

json

application/json

Delete a Kafka cluster

DELETE

https://api.scaleway.com

/kafka/v1alpha1/regions/{region}/clusters/{cluster_id}

Delete a given Kafka cluster, specified by the region and cluster_id parameters. Deleting a Kafka cluster is permanent, and cannot be undone. Note that upon deletion all your data will be lost.

Delete a Kafka cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

cluster_id

string · required

UUID of the Kafka Cluster to delete.

Delete a Kafka cluster › Responses

200

id

string

UUID of the Kafka cluster. (UUID format)

name

string

Name of the Kafka cluster.

project_id

string

Project ID the Kafka cluster belongs to. (UUID format)

organization_id

string

Organisation ID the Kafka cluster belongs to. (UUID format)

status

string · enum

Status of the Kafka cluster.

Enum values:

unknown_status

ready

creating

configuring

deleting

error

locked

stopped

Default: unknown_status

version

string

Kafka version of the Kafka cluster.

tags

string[]

List of tags applied to the Kafka cluster.

Advanced settings of the Kafka cluster.

node_amount

integer · uint32

Number of nodes in Kafka cluster.

node_type

string

Node type of the Kafka cluster.

object

Volumes of the Kafka cluster.

List of Kafka cluster endpoints.

created_at

string · date-time

Creation date (must follow the ISO 8601 format). (RFC 3339 format)

updated_at

string · date-time

Last update date (must follow the ISO 8601 format). (RFC 3339 format)

region

string

Region the Kafka cluster is in.

multi_az

object

MultiAZ tell the cluster is deployed on multiple availability zones in the region.

object

MonoAZ details.

DELETE/kafka/v1alpha1/regions/{region}/clusters/{cluster_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/kafka/v1alpha1/regions/{region}/clusters/{cluster_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "version": "version",
  "tags": [
    "string"
  ],
  "settings": [
    {
      "name": "name",
      "bool_value": true,
      "string_value": "string_value",
      "int_value": 0,
      "float_value": 0
    }
  ],
  "node_amount": 0,
  "node_type": "node_type",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0
  },
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_records": [
        "string"
      ],
      "port": 0,
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public_network": {}
    }
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "region": "region",
  "multi_az": {},
  "mono_az": {
    "zone": "zone"
  }
}

json

application/json

Update a Kafka cluster

PATCH

https://api.scaleway.com

/kafka/v1alpha1/regions/{region}/clusters/{cluster_id}

Update the parameters of a Kafka cluster.

Update a Kafka cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

cluster_id

string · required

UUID of the Kafka Clusters to update.

Update a Kafka cluster › Request Body

name

string

Name of the Kafka Cluster.

tags

string[]

Tags of a Kafka Cluster.

version

string

Version of Kafka.

Update a Kafka cluster › Responses

200

id

string

UUID of the Kafka cluster. (UUID format)

name

string

Name of the Kafka cluster.

project_id

string

Project ID the Kafka cluster belongs to. (UUID format)

organization_id

string

Organisation ID the Kafka cluster belongs to. (UUID format)

status

string · enum

Status of the Kafka cluster.

Enum values:

unknown_status

ready

creating

configuring

deleting

error

locked

stopped

Default: unknown_status

version

string

Kafka version of the Kafka cluster.

tags

string[]

List of tags applied to the Kafka cluster.

Advanced settings of the Kafka cluster.

node_amount

integer · uint32

Number of nodes in Kafka cluster.

node_type

string

Node type of the Kafka cluster.

object

Volumes of the Kafka cluster.

Clusters for Apache Kafka®

List of Kafka cluster endpoints.

created_at

string · date-time

Creation date (must follow the ISO 8601 format). (RFC 3339 format)

updated_at

string · date-time

Last update date (must follow the ISO 8601 format). (RFC 3339 format)

region

string

Region the Kafka cluster is in.

multi_az

object

MultiAZ tell the cluster is deployed on multiple availability zones in the region.

object

MonoAZ details.

PATCH/kafka/v1alpha1/regions/{region}/clusters/{cluster_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/kafka/v1alpha1/regions/{region}/clusters/{cluster_id}"

Example Request Body

{
  "name": "name",
  "tags": [
    "string"
  ],
  "version": "version"
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "version": "version",
  "tags": [
    "string"
  ],
  "settings": [
    {
      "name": "name",
      "bool_value": true,
      "string_value": "string_value",
      "int_value": 0,
      "float_value": 0
    }
  ],
  "node_amount": 0,
  "node_type": "node_type",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0
  },
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_records": [
        "string"
      ],
      "port": 0,
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public_network": {}
    }
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "region": "region",
  "multi_az": {},
  "mono_az": {
    "zone": "zone"
  }
}

json

application/json

Get a Kafka cluster's certificate authority

GET

https://api.scaleway.com

/kafka/v1alpha1/regions/{region}/clusters/{cluster_id}/certificate-authority

Retrieve certificate authority for a given Kafka cluster, specified by the region and cluster_id parameters. The response object contains the certificate in PEM format. The certificate is required to validate the sever from the client side during TLS connection.

Get a Kafka cluster's certificate authority › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

cluster_id

string · required

UUID of the Kafka Cluster.

Get a Kafka cluster's certificate authority › Responses

200

scaleway.std.File

name

string

content_type

string

content

string

Renew the Kafka cluster's certificate authority

POST

https://api.scaleway.com

/kafka/v1alpha1/regions/{region}/clusters/{cluster_id}/renew-certificate-authority

Request to renew the certificate authority for a given Kafka cluster, specified by the region and cluster_id parameters. The certificate authority will be renewed within a few minutes.

Renew the Kafka cluster's certificate authority › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

cluster_id

string · required

UUID of the Kafka Cluster.

Renew the Kafka cluster's certificate authority › Request Body

Renew the Kafka cluster's certificate authority › Responses

No data returned

Node Types

Kafka Clusters

Download schema

A Kafka cluster is composed of one or multiple dedicated compute nodes running a single Kafka broker.

List Kafka clusters

GET

https://api.scaleway.com

/kafka/v1alpha1/regions/{region}/clusters

List Kafka clusters › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

List Kafka clusters › query Parameters

tags

string[]

List Kafka cluster with a given tag.

name

string

Lists Kafka clusters that match a name pattern.

order_by

string · enum

Criteria to use when ordering Kafka cluster listings.

Enum values:

created_at_asc

created_at_desc

name_asc

name_desc

status_asc

status_desc

Default: created_at_asc

organization_id

string

Organization ID of the Kafka cluster.

project_id

string

Project ID.

page

integer · int32

page_size

integer · uint32

List Kafka clusters › Responses

200

scaleway.kafka.v1alpha1.ListClustersResponse

scaleway.kafka.v1alpha1.Cluster[]

List of all Kafka cluster available in an Organization or Project.

total_count

integer · uint64

Total count of Kafka cluster available in an Organization or Project.

GET/kafka/v1alpha1/regions/{region}/clusters

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/kafka/v1alpha1/regions/{region}/clusters"

Example Responses

{
  "clusters": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "name": "name",
      "project_id": "6170692e-7363-616c-6577-61792e636f6d",
      "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
      "status": "unknown_status",
      "version": "version",
      "tags": [
        "string"
      ],
      "settings": [
        {
          "name": "name",
          "bool_value": true,
          "string_value": "string_value",
          "int_value": 0,
          "float_value": 0
        }
      ],
      "node_amount": 0,
      "node_type": "node_type",
      "volume": {
        "type": "unknown_type",
        "size_bytes": 0
      },
      "endpoints": [
        {
          "id": "6170692e-7363-616c-6577-61792e636f6d",
          "dns_records": [
            "string"
          ],
          "port": 0,
          "private_network": {
            "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
          },
          "public_network": {}
        }
      ],
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "region": "region",
      "multi_az": {},
      "mono_az": {
        "zone": "zone"
      }
    }
  ],
  "total_count": 0
}

json

application/json

Create a Kafka cluster

POST

https://api.scaleway.com

/kafka/v1alpha1/regions/{region}/clusters

Create a new Kafka cluster.

Create a Kafka cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

Create a Kafka cluster › Request Body

version

string · required

Version of Kafka.

node_amount

integer · uint32 · required

Number of nodes to use for the Kafka cluster.

node_type

string · required

Type of node to use for the Kafka cluster.

project_id

string

The ID of the Project in which the Kafka cluster will be created.

name

string

Name of the Kafka cluster.

tags

string[]

Tags to apply to the Kafka cluster.

object

Kafka volume information.

scaleway.kafka.v1alpha1.EndpointSpec[]

One or multiple EndpointSpec used to expose your Kafka cluster.

user_name

string

Username for the kafka user.

password

string

Password for the kafka user.

multi_az

object

MultiAZ tell the cluster is deployed on multiple availability zones in the region.

object

MonoAZ details.

Create a Kafka cluster › Responses

200

id

string

UUID of the Kafka cluster. (UUID format)

name

string

Name of the Kafka cluster.

project_id

string

Project ID the Kafka cluster belongs to. (UUID format)

organization_id

string

Organisation ID the Kafka cluster belongs to. (UUID format)

status

string · enum

Status of the Kafka cluster.

Enum values:

unknown_status

ready

creating

configuring

deleting

error

locked

stopped

Default: unknown_status

version

string

Kafka version of the Kafka cluster.

tags

string[]

List of tags applied to the Kafka cluster.

Advanced settings of the Kafka cluster.

node_amount

integer · uint32

Number of nodes in Kafka cluster.

node_type

string

Node type of the Kafka cluster.

object

Volumes of the Kafka cluster.

List of Kafka cluster endpoints.

created_at

string · date-time

Creation date (must follow the ISO 8601 format). (RFC 3339 format)

updated_at

string · date-time

Last update date (must follow the ISO 8601 format). (RFC 3339 format)

region

string

Region the Kafka cluster is in.

multi_az

object

MultiAZ tell the cluster is deployed on multiple availability zones in the region.

object

MonoAZ details.

POST/kafka/v1alpha1/regions/{region}/clusters

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "node_amount": 42,
    "node_type": "string",
    "project_id": "string",
    "version": "string"
  }' \
  "https://api.scaleway.com/kafka/v1alpha1/regions/{region}/clusters"

Example Request Body

{
  "project_id": "project_id",
  "name": "name",
  "version": "version",
  "tags": [
    "string"
  ],
  "node_amount": 0,
  "node_type": "node_type",
  "volume": {
    "size_bytes": 0,
    "type": "unknown_type"
  },
  "endpoints": [
    {
      "public_network": {},
      "private_network": {
        "private_network_id": "private_network_id"
      }
    }
  ],
  "user_name": "user_name",
  "password": "password",
  "multi_az": {},
  "mono_az": {
    "zone": "zone"
  }
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "version": "version",
  "tags": [
    "string"
  ],
  "settings": [
    {
      "name": "name",
      "bool_value": true,
      "string_value": "string_value",
      "int_value": 0,
      "float_value": 0
    }
  ],
  "node_amount": 0,
  "node_type": "node_type",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0
  },
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_records": [
        "string"
      ],
      "port": 0,
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public_network": {}
    }
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "region": "region",
  "multi_az": {},
  "mono_az": {
    "zone": "zone"
  }
}

json

application/json

Get a Kafka cluster

GET

https://api.scaleway.com

/kafka/v1alpha1/regions/{region}/clusters/{cluster_id}

Get a Kafka cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

cluster_id

string · required

UUID of the Kafka Cluster.

Get a Kafka cluster › Responses

200

id

string

UUID of the Kafka cluster. (UUID format)

name

string

Name of the Kafka cluster.

project_id

string

Project ID the Kafka cluster belongs to. (UUID format)

organization_id

string

Organisation ID the Kafka cluster belongs to. (UUID format)

status

string · enum

Status of the Kafka cluster.

Enum values:

unknown_status

ready

creating

configuring

deleting

error

locked

stopped

Default: unknown_status

version

string

Kafka version of the Kafka cluster.

tags

string[]

List of tags applied to the Kafka cluster.

Advanced settings of the Kafka cluster.

node_amount

integer · uint32

Number of nodes in Kafka cluster.

node_type

string

Node type of the Kafka cluster.

object

Volumes of the Kafka cluster.

List of Kafka cluster endpoints.

created_at

string · date-time

Creation date (must follow the ISO 8601 format). (RFC 3339 format)

updated_at

string · date-time

Last update date (must follow the ISO 8601 format). (RFC 3339 format)

region

string

Region the Kafka cluster is in.

multi_az

object

MultiAZ tell the cluster is deployed on multiple availability zones in the region.

object

MonoAZ details.

GET/kafka/v1alpha1/regions/{region}/clusters/{cluster_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/kafka/v1alpha1/regions/{region}/clusters/{cluster_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "version": "version",
  "tags": [
    "string"
  ],
  "settings": [
    {
      "name": "name",
      "bool_value": true,
      "string_value": "string_value",
      "int_value": 0,
      "float_value": 0
    }
  ],
  "node_amount": 0,
  "node_type": "node_type",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0
  },
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_records": [
        "string"
      ],
      "port": 0,
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public_network": {}
    }
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "region": "region",
  "multi_az": {},
  "mono_az": {
    "zone": "zone"
  }
}

json

application/json

Delete a Kafka cluster

DELETE

https://api.scaleway.com

/kafka/v1alpha1/regions/{region}/clusters/{cluster_id}

Delete a given Kafka cluster, specified by the region and cluster_id parameters. Deleting a Kafka cluster is permanent, and cannot be undone. Note that upon deletion all your data will be lost.

Delete a Kafka cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

cluster_id

string · required

UUID of the Kafka Cluster to delete.

Delete a Kafka cluster › Responses

200

id

string

UUID of the Kafka cluster. (UUID format)

name

string

Name of the Kafka cluster.

project_id

string

Project ID the Kafka cluster belongs to. (UUID format)

organization_id

string

Organisation ID the Kafka cluster belongs to. (UUID format)

status

string · enum

Status of the Kafka cluster.

Enum values:

unknown_status

ready

creating

configuring

deleting

error

locked

stopped

Default: unknown_status

version

string

Kafka version of the Kafka cluster.

tags

string[]

List of tags applied to the Kafka cluster.

Advanced settings of the Kafka cluster.

node_amount

integer · uint32

Number of nodes in Kafka cluster.

node_type

string

Node type of the Kafka cluster.

object

Volumes of the Kafka cluster.

List of Kafka cluster endpoints.

created_at

string · date-time

Creation date (must follow the ISO 8601 format). (RFC 3339 format)

updated_at

string · date-time

Last update date (must follow the ISO 8601 format). (RFC 3339 format)

region

string

Region the Kafka cluster is in.

multi_az

object

MultiAZ tell the cluster is deployed on multiple availability zones in the region.

object

MonoAZ details.

DELETE/kafka/v1alpha1/regions/{region}/clusters/{cluster_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/kafka/v1alpha1/regions/{region}/clusters/{cluster_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "version": "version",
  "tags": [
    "string"
  ],
  "settings": [
    {
      "name": "name",
      "bool_value": true,
      "string_value": "string_value",
      "int_value": 0,
      "float_value": 0
    }
  ],
  "node_amount": 0,
  "node_type": "node_type",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0
  },
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_records": [
        "string"
      ],
      "port": 0,
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public_network": {}
    }
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "region": "region",
  "multi_az": {},
  "mono_az": {
    "zone": "zone"
  }
}

json

application/json

Update a Kafka cluster

PATCH

https://api.scaleway.com

/kafka/v1alpha1/regions/{region}/clusters/{cluster_id}

Update the parameters of a Kafka cluster.

Update a Kafka cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

cluster_id

string · required

UUID of the Kafka Clusters to update.

Update a Kafka cluster › Request Body

name

string

Name of the Kafka Cluster.

tags

string[]

Tags of a Kafka Cluster.

version

string

Version of Kafka.

Update a Kafka cluster › Responses

200

id

string

UUID of the Kafka cluster. (UUID format)

name

string

Name of the Kafka cluster.

project_id

string

Project ID the Kafka cluster belongs to. (UUID format)

organization_id

string

Organisation ID the Kafka cluster belongs to. (UUID format)

status

string · enum

Status of the Kafka cluster.

Enum values:

unknown_status

ready

creating

configuring

deleting

error

locked

stopped

Default: unknown_status

version

string

Kafka version of the Kafka cluster.

tags

string[]

List of tags applied to the Kafka cluster.

Advanced settings of the Kafka cluster.

node_amount

integer · uint32

Number of nodes in Kafka cluster.

node_type

string

Node type of the Kafka cluster.

object

Volumes of the Kafka cluster.