API for Private Tokens

This page describes management of Private tokens via API.

Once you have the short-lived token from logging in, the next step is to create a long-living token (it's called a Private Token). This token is meant for backend server use, allowing you to make API requests without needing to constantly re-authenticate.

What can you do?

Create new private token

Create private token

post
Authorizations
AuthorizationstringRequired

Authenticate using SaaS Private token

Body
namestring · min: 1Required
expiration_timestring · date-timeRequired
Responses
post
/api/v1/auth/private_tokens/

List your private tokens

Get private tokens list

get
Authorizations
AuthorizationstringRequired

Authenticate using SaaS Private token

Query parameters
orderingstringOptional

Which field to use when ordering the results.

qstringOptional

A search term.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

Responses
200Success
application/json
get
/api/v1/auth/private_tokens/
200Success

Revoke your private token

Revoke private token

delete
Authorizations
AuthorizationstringRequired

Authenticate using SaaS Private token

Path parameters
idintegerRequired

A unique integer value identifying this private token.

Responses
delete
/api/v1/auth/private_tokens/{id}/
204

No response body

No content

Last updated

Was this helpful?