List 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.
path Parameters
regionThe region you want to target
query Parameters
project_idInclude only NATS accounts in this Project.
pagePage number to return.
page_sizeMaximum number of NATS accounts to return per page.
order_byOrder in which to return results.
List NATS accounts › Responses
total_countTotal count of existing NATS accounts (matching any filters specified).
NATS accounts on this page.
Create a NATS account
Create a NATS account associated with a Project.
path Parameters
regionThe region you want to target
Create a NATS account › Request Body
nameNATS account name.
project_idProject containing the NATS account.
Create a NATS account › Responses
idNATS account ID.
nameNATS account name.
endpointEndpoint of the NATS service for this account.
project_idProject ID of the Project containing the NATS account.
regionRegion where the NATS account is deployed.
created_atNATS account creation date. (RFC 3339 format)
updated_atNATS account last modification date. (RFC 3339 format)
Get a NATS account
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.
path Parameters
regionThe region you want to target
nats_account_idID of the NATS account to get.
Get a NATS account › Responses
idNATS account ID.
nameNATS account name.
endpointEndpoint of the NATS service for this account.
project_idProject ID of the Project containing the NATS account.
regionRegion where the NATS account is deployed.
created_atNATS account creation date. (RFC 3339 format)
updated_atNATS account last modification date. (RFC 3339 format)
Delete a NATS account
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.
path Parameters
regionThe region you want to target
nats_account_idID of the NATS account to delete.
Delete a NATS account › Responses
Update the name of a NATS account
Update the name of a NATS account, specified by its NATS account ID.
path Parameters
regionThe region you want to target
nats_account_idID of the NATS account to update.
Update the name of a NATS account › Responses
idNATS account ID.
nameNATS account name.
endpointEndpoint of the NATS service for this account.
project_idProject ID of the Project containing the NATS account.
regionRegion where the NATS account is deployed.
created_atNATS account creation date. (RFC 3339 format)
updated_atNATS account last modification date. (RFC 3339 format)