Scaleway logo
NATS API
NATS API

NATS credentials

Download schema

NATS credentials give services and platforms access to the NATS cluster using any standard NATS client

List NATS credentials

GET
https://api.scaleway.com
/mnq/v1beta1/regions/{region}/nats-credentials

List existing credentials in the specified NATS account. The response contains only the metadata for the credentials, not the credentials themselves, which are only returned after a Create Credentials call.

List NATS credentials › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams

List NATS credentials › query Parameters

project_id
​string

Include only NATS accounts in this Project.

nats_account_id
​string

Include only credentials for this NATS account.

page
​integer · int32

Page number to return.

page_size
​integer · uint32

Maximum number of credentials to return per page.

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 NATS credentials › Responses

200
scaleway.mnq.v1beta1.ListNatsCredentialsResponse
total_count
​integer · uint64

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

Credentials on this page.

Create NATS credentials

POST
https://api.scaleway.com
/mnq/v1beta1/regions/{region}/nats-credentials

Create a set of credentials for a NATS account, specified by its NATS account ID.

Create NATS credentials › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams

Create NATS credentials › Request Body

nats_account_id
​string · required

NATS account containing the credentials.

name
​string

Name of the credentials.

Create NATS credentials › Responses

200
scaleway.mnq.v1beta1.NatsCredentials
id
​string

ID of the credentials.

name
​string

Name of the credentials.

nats_account_id
​string

NATS account containing the credentials.

region
​string

Region where the NATS account is deployed.

created_at
​string | null · date-time

NATS credentials creation date. (RFC 3339 format)

updated_at
​string | null · date-time

NATS credentials last modification date. (RFC 3339 format)

Object containing the credentials file (Only returned by Create Nats Credentials call).

checksum
​string

Checksum of the credentials file.

Get NATS credentials

GET
https://api.scaleway.com
/mnq/v1beta1/regions/{region}/nats-credentials/{nats_credentials_id}

Retrieve an existing set of credentials, identified by the nats_credentials_id. The credentials themselves are NOT returned, only their metadata (NATS account ID, credentials name, etc), are returned in the response.

Get NATS credentials › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams
nats_credentials_id
​string · required

ID of the credentials to get.

Get NATS credentials › Responses

200
scaleway.mnq.v1beta1.NatsCredentials
id
​string

ID of the credentials.

name
​string

Name of the credentials.

nats_account_id
​string

NATS account containing the credentials.

region
​string

Region where the NATS account is deployed.

created_at
​string | null · date-time

NATS credentials creation date. (RFC 3339 format)

updated_at
​string | null · date-time

NATS credentials last modification date. (RFC 3339 format)

Object containing the credentials file (Only returned by Create Nats Credentials call).

checksum
​string

Checksum of the credentials file.

Delete NATS credentials

DELETE
https://api.scaleway.com
/mnq/v1beta1/regions/{region}/nats-credentials/{nats_credentials_id}

Delete a set of credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can no longer be used to access the NATS account, and active connections using this credentials will be closed.

Delete NATS credentials › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams
nats_credentials_id
​string · required

ID of the credentials to delete.

Delete NATS credentials › Responses

No data returned
NATS accounts