Skip to main content
Every request to the Clumio REST API, and every SDK call, authenticates with a signed JSON Web Token sent as a bearer token.

​
Send an authenticated request

​
Generate a token

1

Open the token screen

In the Clumio console, go to Administration → Access management → API tokens.
2

Create the token

Generate a personal token for development or a service token for automation. Super Administrators and OU Administrators can generate service tokens.
3

Download and store it

Download the CSV when Clumio generates it. The full token can be downloaded only once. Store it in a secrets manager, never in a repository.
Tokens persist until you refresh or delete them. Deleting a token immediately invalidates every script using it.

​
Token types

Use service tokens for unattended automation. Clumio deletes a personal token when its user account is suspended or deleted. Use the API base URL for the control plane that issued the token. See Supported regions. API endpoints require TLS 1.3, or TLS 1.2 with ECDHE-AES-GCM cipher suites. See Deprecations.

​
Rotation

API tokens remain valid until they are refreshed or deleted. Clumio recommends refreshing them every three months. Refreshing a token immediately invalidates the previous value.
Refresh the token in Clumio, download the new CSV, and update every script or integration that uses it. Plan the deployment because the previous token stops working immediately.
Service token activity is recorded in the audit log and can be reported on separately from human user activity. See Clumio’s service token audit report.

​
Next

REST API overview

Send a request and review the API conventions.

Supported regions

Find the API base URL for your control plane.