Cloud Essentials for RabbitMQ

Download schema

Manage your RabbitMQ engine

Retrieve a list of MessageQ deployments

GET

https://api.scaleway.com

/messageq/v1alpha1/regions/{region}/deployments

Retrieve a list of MessageQ deployments › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

Retrieve a list of MessageQ deployments › query Parameters

organization_id

string

Organization ID to filter for, only deployments from this Organization will be returned.

project_id

string

Project ID to filter for, only deployments from this Project will be returned.

order_by

string · enum

Sort order for deployments in the response.

Enum values:

created_at_asc

created_at_desc

name_asc

name_desc

updated_at_asc

updated_at_desc

Default: created_at_asc

page

integer · int32

Page number to return, from the paginated results.

page_size

integer · uint32

Number of deployments to return per page.

tags

string[]

Tags to filter for, only deployments with one or more matching tags will be returned.

name

string

Deployment name to filter for, only deployments with this string within their name will be returned.

Retrieve a list of MessageQ deployments › Responses

200

scaleway.messageq.v1alpha1.ListDeploymentsResponse

scaleway.messageq.v1alpha1.Deployment[]

List of deployments.

total_count

integer · uint64

Number of deployments in result set.

GET/messageq/v1alpha1/regions/{region}/deployments

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/messageq/v1alpha1/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"
      ],
      "node_count": 0,
      "node_type": "node_type",
      "volume": {
        "type": "unknown_type",
        "size_bytes": 0
      },
      "endpoints": [
        {
          "id": "6170692e-7363-616c-6577-61792e636f6d",
          "dns_record": "dns_record",
          "services": [
            {
              "name": "name",
              "port": 0,
              "url": "url"
            }
          ],
          "public": {},
          "private_network": {
            "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
          }
        }
      ],
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "version": "version",
      "region": "region"
    }
  ],
  "total_count": 0
}

json

application/json

Create a new MessageQ deployment

POST

https://api.scaleway.com

/messageq/v1alpha1/regions/{region}/deployments

Create a new MessageQ deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

Create a new MessageQ deployment › Request Body

project_id

string

Project ID in which to create the deployment.

name

string

Name of the deployment.

tags

string[]

Tags.

node_count

integer · uint32

Number of nodes.

node_type

string

Node type to use.

user_name

string

Username for the deployment user.

password

string

Password for the deployment user.

object

Volume for storing data.

scaleway.messageq.v1alpha1.EndpointSpec[]

Endpoints to access the deployment.

version

string

The MessageQ version to use.

Create a new MessageQ deployment › Responses

200

scaleway.messageq.v1alpha1.Deployment

id

string

Unique identifier of the deployment. (UUID format)

name

string

Name of the deployment.

organization_id

string

ID of the Organization containing the deployment. (UUID format)

project_id

string

ID of the Project containing the deployment. (UUID format)

status

string · enum

Status of the deployment.

Enum values:

unknown_status

ready

creating

initializing

upgrading

deleting

error

locked

Default: unknown_status

tags

string[]

Tags of the deployment.

node_count

integer · uint32

Number of nodes.

node_type

string

Node type used.

object

Volume type and size.

scaleway.messageq.v1alpha1.Endpoint[]

Exposed endpoints.

created_at

string · date-time

Date the deployment was created. (RFC 3339 format)

updated_at

string · date-time

Date the deployment was last updated. (RFC 3339 format)

version

string

MessageQ version of the deployment.

region

string

Region of the deployment.

POST/messageq/v1alpha1/regions/{region}/deployments

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

Example Request Body

{
  "project_id": "project_id",
  "name": "name",
  "tags": [
    "string"
  ],
  "node_count": 0,
  "node_type": "node_type",
  "user_name": "user_name",
  "password": "password",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0
  },
  "endpoints": [
    {
      "public": {},
      "private_network": {
        "private_network_id": "private_network_id"
      }
    }
  ],
  "version": "version"
}

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"
  ],
  "node_count": 0,
  "node_type": "node_type",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0
  },
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "services": [
        {
          "name": "name",
          "port": 0,
          "url": "url"
        }
      ],
      "public": {},
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      }
    }
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "version": "version",
  "region": "region"
}

json

application/json

Retrieve a specific MessageQ deployment

GET

https://api.scaleway.com

/messageq/v1alpha1/regions/{region}/deployments/{deployment_id}

Retrieve a specific MessageQ deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

ID of the deployment.

Retrieve a specific MessageQ deployment › Responses

200

scaleway.messageq.v1alpha1.Deployment

id

string

Unique identifier of the deployment. (UUID format)

name

string

Name of the deployment.

organization_id

string

ID of the Organization containing the deployment. (UUID format)

project_id

string

ID of the Project containing the deployment. (UUID format)

status

string · enum

Status of the deployment.

Enum values:

unknown_status

ready

creating

initializing

upgrading

deleting

error

locked

Default: unknown_status

tags

string[]

Tags of the deployment.

node_count

integer · uint32

Number of nodes.

node_type

string

Node type used.

object

Volume type and size.

scaleway.messageq.v1alpha1.Endpoint[]

Exposed endpoints.

created_at

string · date-time

Date the deployment was created. (RFC 3339 format)

updated_at

string · date-time

Date the deployment was last updated. (RFC 3339 format)

version

string

MessageQ version of the deployment.

region

string

Region of the deployment.

GET/messageq/v1alpha1/regions/{region}/deployments/{deployment_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/messageq/v1alpha1/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"
  ],
  "node_count": 0,
  "node_type": "node_type",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0
  },
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "services": [
        {
          "name": "name",
          "port": 0,
          "url": "url"
        }
      ],
      "public": {},
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      }
    }
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "version": "version",
  "region": "region"
}

json

application/json

Delete a MessageQ deployment

DELETE

https://api.scaleway.com

/messageq/v1alpha1/regions/{region}/deployments/{deployment_id}

Delete a MessageQ deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

ID of the deployment.

Delete a MessageQ deployment › Responses

200

scaleway.messageq.v1alpha1.Deployment

id

string

Unique identifier of the deployment. (UUID format)

name

string

Name of the deployment.

organization_id

string

ID of the Organization containing the deployment. (UUID format)

project_id

string

ID of the Project containing the deployment. (UUID format)

status

string · enum

Status of the deployment.

Enum values:

unknown_status

ready

creating

initializing

upgrading

deleting

error

locked

Default: unknown_status

tags

string[]

Tags of the deployment.

node_count

integer · uint32

Number of nodes.

node_type

string

Node type used.

object

Volume type and size.

scaleway.messageq.v1alpha1.Endpoint[]

Exposed endpoints.

created_at

string · date-time

Date the deployment was created. (RFC 3339 format)

updated_at

string · date-time

Date the deployment was last updated. (RFC 3339 format)

version

string

MessageQ version of the deployment.

region

string

Region of the deployment.

DELETE/messageq/v1alpha1/regions/{region}/deployments/{deployment_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/messageq/v1alpha1/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"
  ],
  "node_count": 0,
  "node_type": "node_type",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0
  },
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "services": [
        {
          "name": "name",
          "port": 0,
          "url": "url"
        }
      ],
      "public": {},
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      }
    }
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "version": "version",
  "region": "region"
}

json

application/json

Update a MessageQ deployment

PATCH

https://api.scaleway.com

/messageq/v1alpha1/regions/{region}/deployments/{deployment_id}

Update a MessageQ deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

ID of the deployment. (UUID format)

Update a MessageQ deployment › Request Body

name

string

New name for the deployment.

tags

string[]

Tags to update.

Update a MessageQ deployment › Responses

200

scaleway.messageq.v1alpha1.Deployment

id

string

Unique identifier of the deployment. (UUID format)

name

string

Name of the deployment.

organization_id

string

ID of the Organization containing the deployment. (UUID format)

project_id

string

ID of the Project containing the deployment. (UUID format)

status

string · enum

Status of the deployment.

Enum values:

unknown_status

ready

creating

initializing

upgrading

deleting

error

locked

Default: unknown_status

tags

string[]

Tags of the deployment.

node_count

integer · uint32

Number of nodes.

node_type

string

Node type used.

object

Volume type and size.

scaleway.messageq.v1alpha1.Endpoint[]

Exposed endpoints.

created_at

string · date-time

Date the deployment was created. (RFC 3339 format)

updated_at

string · date-time

Date the deployment was last updated. (RFC 3339 format)

version

string

MessageQ version of the deployment.

region

string

Region of the deployment.

PATCH/messageq/v1alpha1/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/messageq/v1alpha1/regions/{region}/deployments/{deployment_id}"

Example Request Body

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

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"
  ],
  "node_count": 0,
  "node_type": "node_type",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0
  },
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "services": [
        {
          "name": "name",
          "port": 0,
          "url": "url"
        }
      ],
      "public": {},
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      }
    }
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "version": "version",
  "region": "region"
}

json

application/json

Upgrade a MessageQ deployment

POST

https://api.scaleway.com

/messageq/v1alpha1/regions/{region}/deployments/{deployment_id}/upgrade

Upgrade a MessageQ deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

ID of the deployment. (UUID format)

Upgrade a MessageQ deployment › Request Body

node_count

integer · uint32

Target number of nodes.

volume_size_bytes

integer · uint64

Target volume size. (in bytes)

Upgrade a MessageQ deployment › Responses

200

scaleway.messageq.v1alpha1.Deployment

id

string

Unique identifier of the deployment. (UUID format)

name

string

Name of the deployment.

organization_id

string

ID of the Organization containing the deployment. (UUID format)

project_id

string

ID of the Project containing the deployment. (UUID format)

status

string · enum

Status of the deployment.

Enum values:

unknown_status

ready

creating

initializing

upgrading

deleting

error

locked

Default: unknown_status

tags

string[]

Tags of the deployment.

node_count

integer · uint32

Number of nodes.

node_type

string

Node type used.

object

Volume type and size.

scaleway.messageq.v1alpha1.Endpoint[]

Exposed endpoints.

created_at

string · date-time

Date the deployment was created. (RFC 3339 format)

updated_at

string · date-time

Date the deployment was last updated. (RFC 3339 format)

version

string

MessageQ version of the deployment.

region

string

Region of the deployment.

POST/messageq/v1alpha1/regions/{region}/deployments/{deployment_id}/upgrade

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

Example Request Body

{
  "node_count": 0,
  "volume_size_bytes": 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"
  ],
  "node_count": 0,
  "node_type": "node_type",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0
  },
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "services": [
        {
          "name": "name",
          "port": 0,
          "url": "url"
        }
      ],
      "public": {},
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      }
    }
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "version": "version",
  "region": "region"
}

json

application/json

Retrieve a list of deployment users

GET

https://api.scaleway.com

/messageq/v1alpha1/regions/{region}/deployments/{deployment_id}/users

Retrieve a list of deployment users › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

Retrieve a list of deployment users › query Parameters

page

integer · int32

page_size

integer · uint32

order_by

scaleway.messageq.v1alpha1.ListUsersRequest.OrderBy · enum

Enum values:

name_asc

name_desc

Default: name_asc

name

string

Retrieve a list of deployment users › Responses

200

scaleway.messageq.v1alpha1.ListUsersResponse

scaleway.messageq.v1alpha1.User[]

total_count

integer · uint64

Create a new user

POST

https://api.scaleway.com

/messageq/v1alpha1/regions/{region}/deployments/{deployment_id}/users

Create a new user › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

ID of the deployment.

Create a new user › Request Body

username

string

Username of the deployment user.

password

string

Password of the deployment user.

Create a new user › Responses

200

scaleway.messageq.v1alpha1.User

username

string

Delete an existing user

DELETE

https://api.scaleway.com

/messageq/v1alpha1/regions/{region}/deployments/{deployment_id}/users/{username}

Delete an existing user › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

ID of the deployment.

username

string · required

Username of the deployment user.

Delete an existing user › Responses

No data returned

Update an existing user

PATCH

https://api.scaleway.com

/messageq/v1alpha1/regions/{region}/deployments/{deployment_id}/users/{username}

Update an existing user › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

ID of the deployment.

username

string · required

Username of the deployment user.

Update an existing user › Request Body

password

string

Password of the deployment user.

Update an existing user › Responses

200

scaleway.messageq.v1alpha1.User

username

string

Create a new endpoint for a deployment

POST

https://api.scaleway.com

/messageq/v1alpha1/regions/{region}/endpoints

Create a new endpoint for a deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

Create a new endpoint for a deployment › Request Body

deployment_id

string

ID of the deployment.

object

Specification of the endpoint you want to create.

Create a new endpoint for a deployment › Responses

200

scaleway.messageq.v1alpha1.Endpoint

id

string

Unique identifier of the endpoint. (UUID format)

scaleway.messageq.v1alpha1.Endpoint.Service[]

List of available services, their ports and URLs.

public

object

Delete an existing endpoint

DELETE

https://api.scaleway.com

/messageq/v1alpha1/regions/{region}/endpoints/{endpoint_id}

Delete an existing endpoint › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

endpoint_id

string · required

ID of the endpoint.

Delete an existing endpoint › Responses

No data returned

Retrieve a list of available node types

GET

https://api.scaleway.com

/messageq/v1alpha1/regions/{region}/node-types

Retrieve a list of available node types › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

Retrieve a list of available node types › query Parameters

order_by

string · enum

Sort order for versions in the response.

Enum values:

name_asc

name_desc

vcpus_asc

vcpus_desc

memory_asc

memory_desc

Default: name_asc

page

integer · int32

Page number to return, from the paginated results.

page_size

integer · uint32

Number of node types to return per page.

Retrieve a list of available node types › Responses

200

scaleway.messageq.v1alpha1.ListNodeTypesResponse

scaleway.messageq.v1alpha1.NodeType[]

List of node types compatible.

total_count

integer · uint64

Number of node types in result set.

List available MessageQ versions

GET

https://api.scaleway.com

/messageq/v1alpha1/regions/{region}/versions

List available MessageQ versions › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

List available MessageQ versions › query Parameters

order_by

string · enum

Sort order for versions in the response.

Enum values:

version_asc

version_desc

Default: version_asc

page

integer · int32

Page number to return, from the paginated results.

page_size

integer · uint32

Number of versions to return per page.

version

string

Engine version to filter for, only versions with this version will be returned.

List available MessageQ versions › Responses

200

scaleway.messageq.v1alpha1.ListVersionsResponse

scaleway.messageq.v1alpha1.Version[]

List of versions.

total_count

integer · uint64

Number of versions in result set.

Other endpoints