NATS credentials give services and platforms access to the NATS cluster using any standard NATS client
List 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.
path Parameters
regionThe region you want to target
query Parameters
project_idInclude only NATS accounts in this Project.
nats_account_idInclude only credentials for this NATS account.
pagePage number to return.
page_sizeMaximum number of credentials to return per page.
order_byOrder in which to return results.
List NATS credentials › Responses
total_countTotal count of existing credentials (matching any filters specified).
Credentials on this page.
Create NATS credentials
Create a set of credentials for a NATS account, specified by its NATS account ID.
path Parameters
regionThe region you want to target
Create NATS credentials › Request Body
nats_account_idNATS account containing the credentials.
nameName of the credentials.
Create NATS credentials › Responses
idID of the credentials.
nameName of the credentials.
nats_account_idNATS account containing the credentials.
regionRegion where the NATS account is deployed.
created_atNATS credentials creation date. (RFC 3339 format)
updated_atNATS credentials last modification date. (RFC 3339 format)
Object containing the credentials file (Only returned by Create Nats Credentials call).
checksumChecksum of the credentials file.
Get NATS credentials
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.
path Parameters
regionThe region you want to target
nats_credentials_idID of the credentials to get.
Get NATS credentials › Responses
idID of the credentials.
nameName of the credentials.
nats_account_idNATS account containing the credentials.
regionRegion where the NATS account is deployed.
created_atNATS credentials creation date. (RFC 3339 format)
updated_atNATS credentials last modification date. (RFC 3339 format)
Object containing the credentials file (Only returned by Create Nats Credentials call).
checksumChecksum of the credentials file.
Delete NATS credentials
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.
path Parameters
regionThe region you want to target
nats_credentials_idID of the credentials to delete.