Queues credentials

Queues credentials give access to the Queues service

List Queues credentials

GET

https://api.scaleway.com

/mnq/v1beta1/regions/{region}/sqs-credentials

List existing Queues credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.

List Queues credentials › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

List Queues credentials › query Parameters

project_id

string

Include only Queues credentials in this Project.

page

integer · int32

Page number to return.

page_size

integer · uint32

Maximum number of credentials to return per page.

order_by

scaleway.mnq.v1beta1.ListSqsCredentialsRequest.OrderBy · enum

Order in which to return results.

Enum values:

created_at_asc

created_at_desc

updated_at_asc

updated_at_desc

name_asc

name_desc

Default: created_at_asc

List Queues credentials › Responses

200

scaleway.mnq.v1beta1.ListSqsCredentialsResponse

total_count

integer · uint64

Total count of existing credentials (matching any filters specified).

scaleway.mnq.v1beta1.SqsCredentials[]

Queues credentials on this page.

Create Queues credentials

POST

https://api.scaleway.com

/mnq/v1beta1/regions/{region}/sqs-credentials

Create a set of credentials for Queues, specified by a Project ID. Credentials give the bearer access to queues, and the level of permissions can be defined granularly.

Create Queues credentials › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

Create Queues credentials › Request Body

project_id

string · required

Project containing the Queues credentials.

name

string

Name of the credentials.

scaleway.mnq.v1beta1.SqsPermissions

Permissions associated with these credentials.

Create Queues credentials › Responses

200

scaleway.mnq.v1beta1.SqsCredentials

id

string

ID of the credentials.

name

string

Name of the credentials.

project_id

string

Project ID of the Project containing the credentials.

region

string

Region where the credentials exists.

created_at

string | null · date-time

Credentials creation date. (RFC 3339 format)

updated_at

string | null · date-time

Credentials last modification date. (RFC 3339 format)

access_key

string

Access key ID.

secret_key

string

Secret key ID (Only returned by Create Queues Credentials call).

secret_checksum

string

Checksum of the Secret key.

scaleway.mnq.v1beta1.SqsPermissions

Permissions associated with these credentials.

POST/mnq/v1beta1/regions/{region}/sqs-credentials

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","project_id":"string"}' \
  "https://api.scaleway.com/mnq/v1beta1/regions/{region}/sqs-credentials"

Example Request Body

{
  "project_id": "project_id",
  "name": "name",
  "permissions": {
    "can_publish": true,
    "can_receive": true,
    "can_manage": true
  }
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "project_id": "project_id",
  "region": "region",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "access_key": "access_key",
  "secret_key": "secret_key",
  "secret_checksum": "secret_checksum",
  "permissions": {
    "can_publish": true,
    "can_receive": true,
    "can_manage": true
  }
}

json

application/json

Get Queues credentials

GET

https://api.scaleway.com

/mnq/v1beta1/regions/{region}/sqs-credentials/{sqs_credentials_id}

Retrieve an existing set of credentials, identified by the credentials_id. The credentials themselves, as well as their metadata (name, project ID etc), are returned in the response.

Get Queues credentials › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

sqs_credentials_id

string · required

ID of the Queues credentials to get.

Get Queues credentials › Responses

200

scaleway.mnq.v1beta1.SqsCredentials

id

string

ID of the credentials.

name

string

Name of the credentials.

project_id

string

Project ID of the Project containing the credentials.

region

string

Region where the credentials exists.

created_at

string | null · date-time

Credentials creation date. (RFC 3339 format)

updated_at

string | null · date-time

Credentials last modification date. (RFC 3339 format)

access_key

string

Access key ID.

secret_key

string

Secret key ID (Only returned by Create Queues Credentials call).

secret_checksum

string

Checksum of the Secret key.

scaleway.mnq.v1beta1.SqsPermissions

Permissions associated with these credentials.

Delete Queues credentials

DELETE

https://api.scaleway.com

/mnq/v1beta1/regions/{region}/sqs-credentials/{sqs_credentials_id}

Delete a set of Queues credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access Queues.

Delete Queues credentials › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

sqs_credentials_id

string · required

ID of the credentials to delete.

Delete Queues credentials › Responses

No data returned

Update Queues credentials

PATCH

https://api.scaleway.com

/mnq/v1beta1/regions/{region}/sqs-credentials/{sqs_credentials_id}

Update a set of Queues credentials. You can update the credentials' name, or their permissions.

Update Queues credentials › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

sqs_credentials_id

string · required

ID of the Queues credentials to update.

Update Queues credentials › Request Body

name

string | null

Name of the credentials.

scaleway.mnq.v1beta1.SqsPermissions

Permissions associated with these credentials.

Update Queues credentials › Responses

200

scaleway.mnq.v1beta1.SqsCredentials

id

string

ID of the credentials.

name

string

Name of the credentials.

project_id

string

Project ID of the Project containing the credentials.

region

string

Region where the credentials exists.

created_at

string | null · date-time

Credentials creation date. (RFC 3339 format)

updated_at

string | null · date-time

Credentials last modification date. (RFC 3339 format)

access_key

string

Access key ID.

secret_key

string

Secret key ID (Only returned by Create Queues Credentials call).

secret_checksum

string

Checksum of the Secret key.

scaleway.mnq.v1beta1.SqsPermissions

Permissions associated with these credentials.

PATCH/mnq/v1beta1/regions/{region}/sqs-credentials/{sqs_credentials_id}

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

Example Request Body

{
  "name": "name",
  "permissions": {
    "can_publish": true,
    "can_receive": true,
    "can_manage": true
  }
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "project_id": "project_id",
  "region": "region",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "access_key": "access_key",
  "secret_key": "secret_key",
  "secret_checksum": "secret_checksum",
  "permissions": {
    "can_publish": true,
    "can_receive": true,
    "can_manage": true
  }
}

json

application/json

Queues