Scaleway logo
NATS API
NATS API

NATS accounts

Download schema

A NATS account allows you to interact with a NATS cluster

List NATS accounts

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

List all NATS accounts in the specified region, for a Scaleway Organization or Project. By default, the NATS accounts returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

List NATS accounts › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams

List NATS accounts › query Parameters

project_id
​string

Include only NATS accounts in this Project.

page
​integer · int32

Page number to return.

page_size
​integer · uint32

Maximum number of NATS accounts 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 accounts › Responses

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

Total count of existing NATS accounts (matching any filters specified).

NATS accounts on this page.

Create a NATS account

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

Create a NATS account associated with a Project.

Create a NATS account › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams

Create a NATS account › Request Body

name
​string

NATS account name.

project_id
​string

Project containing the NATS account.

Create a NATS account › Responses

200
scaleway.mnq.v1beta1.NatsAccount
id
​string

NATS account ID.

name
​string

NATS account name.

endpoint
​string

Endpoint of the NATS service for this account.

project_id
​string

Project ID of the Project containing the NATS account.

region
​string

Region where the NATS account is deployed.

created_at
​string | null · date-time

NATS account creation date. (RFC 3339 format)

updated_at
​string | null · date-time

NATS account last modification date. (RFC 3339 format)

Get a NATS account

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

Retrieve information about an existing NATS account identified by its NATS account ID. Its full details, including name and endpoint, are returned in the response.

Get a NATS account › path Parameters

region
​string · enum · required

The region you want to target

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

ID of the NATS account to get.

Get a NATS account › Responses

200
scaleway.mnq.v1beta1.NatsAccount
id
​string

NATS account ID.

name
​string

NATS account name.

endpoint
​string

Endpoint of the NATS service for this account.

project_id
​string

Project ID of the Project containing the NATS account.

region
​string

Region where the NATS account is deployed.

created_at
​string | null · date-time

NATS account creation date. (RFC 3339 format)

updated_at
​string | null · date-time

NATS account last modification date. (RFC 3339 format)

Delete a NATS account

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

Delete a NATS account, specified by its NATS account ID. Note that deleting a NATS account is irreversible, and any credentials, streams, consumer and stored messages belonging to this NATS account will also be deleted.

Delete a NATS account › path Parameters

region
​string · enum · required

The region you want to target

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

ID of the NATS account to delete.

Delete a NATS account › Responses

No data returned

Update the name of a NATS account

PATCH
https://api.scaleway.com
/mnq/v1beta1/regions/{region}/nats-accounts/{nats_account_id}

Update the name of a NATS account, specified by its NATS account ID.

Update the name of a NATS account › path Parameters

region
​string · enum · required

The region you want to target

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

ID of the NATS account to update.

Update the name of a NATS account › Request Body

name
​string | null

NATS account name.

Update the name of a NATS account › Responses

200
scaleway.mnq.v1beta1.NatsAccount
id
​string

NATS account ID.

name
​string

NATS account name.

endpoint
​string

Endpoint of the NATS service for this account.

project_id
​string

Project ID of the Project containing the NATS account.

region
​string

Region where the NATS account is deployed.

created_at
​string | null · date-time

NATS account creation date. (RFC 3339 format)

updated_at
​string | null · date-time

NATS account last modification date. (RFC 3339 format)

NATS credentials