Authentication

REST API works on a token-based authentication system.

To begin:

  • Generate an API token from the Service > API Token page within the Diffusion® Cloud dashboard.

  • Give the token a name and select the scopes you need.

  • Copy the token value when it is displayed — it will only be shown once.

The token is prefixed with dcloud- and can be used directly to authenticate any subsequent requests. No additional login step is required.

All REST API requests must include the token in the Authorization header:

curl --request POST                                                     \
     --url https://api.diffusion.cloud/topics/fetch                     \
     --header 'content-type: application/json'                          \
     --header 'authorization: Apikey <TOKEN>'                           \
     -d '{"path":"my-topic", "type":"json"}'

Scopes

Tokens are assigned scopes that determine what operations can be performed:

  • rest-api/add — Create topics

  • rest-api/set — Update topic values

  • rest-api/sendRequestToPath — Send requests to a path

  • rest-api/fetch — Retrieve topic values

  • rest-api/remove — Remove topics

  • rest-api/gateway — Gateway operations

Token management

Tokens can be managed from the Service > API Token page:

  • Create — Generate a new token with a name and scopes.

  • List — View all tokens and their metadata.

  • Revoke — Revoke a token to permanently disable it.

A revoked token cannot be used to authenticate requests. Revocation is permanent and cannot be undone.