Topics and Events credentials

Topics and Events credentials give access to the Topics and Events service

List Topics and Events credentials

GET

https://api.scaleway.com

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

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

List Topics and Events credentials › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

List Topics and Events credentials › query Parameters

project_id

string

Include only Topics and Events 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.ListSnsCredentialsRequest.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 Topics and Events credentials › Responses

200

scaleway.mnq.v1beta1.ListSnsCredentialsResponse

total_count

integer · uint64

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

scaleway.mnq.v1beta1.SnsCredentials[]

Topics and Events credentials on this page.

Create Topics and Events credentials

POST

https://api.scaleway.com

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

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

Create Topics and Events credentials › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

Create Topics and Events credentials › Request Body

project_id

string · required

Project containing the Topics and Events credentials.

name

string

Name of the credentials.

scaleway.mnq.v1beta1.SnsPermissions

Permissions associated with these credentials.

Create Topics and Events credentials › Responses

200

scaleway.mnq.v1beta1.SnsCredentials

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 Topics and Events Credentials call).

secret_checksum

string

Checksum of the Secret key.

scaleway.mnq.v1beta1.SnsPermissions

Permissions associated with these credentials.

POST/mnq/v1beta1/regions/{region}/sns-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}/sns-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 Topics and Events credentials

GET

https://api.scaleway.com

/mnq/v1beta1/regions/{region}/sns-credentials/{sns_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 Topics and Events credentials › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

sns_credentials_id

string · required

ID of the Topics and Events credentials to get.

Get Topics and Events credentials › Responses

200

scaleway.mnq.v1beta1.SnsCredentials

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 Topics and Events Credentials call).

secret_checksum

string

Checksum of the Secret key.

scaleway.mnq.v1beta1.SnsPermissions

Permissions associated with these credentials.

Delete Topics and Events credentials

DELETE

https://api.scaleway.com

/mnq/v1beta1/regions/{region}/sns-credentials/{sns_credentials_id}

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

Delete Topics and Events credentials › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

sns_credentials_id

string · required

ID of the credentials to delete.

Delete Topics and Events credentials › Responses

No data returned

Update Topics and Events credentials

PATCH

https://api.scaleway.com

/mnq/v1beta1/regions/{region}/sns-credentials/{sns_credentials_id}

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

Update Topics and Events credentials › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

sns_credentials_id

string · required

ID of the Topics and Events credentials to update.

Update Topics and Events credentials › Request Body

name

string | null

Name of the credentials.

scaleway.mnq.v1beta1.SnsPermissions

Permissions associated with these credentials.

Update Topics and Events credentials › Responses

200

scaleway.mnq.v1beta1.SnsCredentials

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 Topics and Events Credentials call).

secret_checksum

string

Checksum of the Secret key.

scaleway.mnq.v1beta1.SnsPermissions

Permissions associated with these credentials.

PATCH/mnq/v1beta1/regions/{region}/sns-credentials/{sns_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}/sns-credentials/{sns_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

Topics and Events