🟢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

• List your private tokens

• Revoke your private token

Create new private token

Create private token

POST/api/v1/auth/private_tokens/

Authorization

PrivateTokenAuthPasswordAuthcookieAuth

Body

application/json

name*string

expiration_time*string (date-time)

Response

201400

Body

application/json

id*integer

name*string

expiration_time*string (date-time)

data*string

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/auth/private_tokens/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "expiration_time": "2024-10-22T10:45:34.192Z",
      "name": "text"
    }),
});
const data = await response.json();

Response

201400

{
  "name": "text",
  "expiration_time": "2024-10-22T10:45:34.192Z",
  "data": "text"
}

---

List your private tokens

Get private tokens list

GET/api/v1/auth/private_tokens/

Authorization

PrivateTokenAuthPasswordAuthcookieAuth

Query parameters

Response

200

Body

application/json

count*integer

Example: 123

nextnullable string (uri)

Example: "http://api.example.org/accounts/?page=4"

previousnullable string (uri)

Example: "http://api.example.org/accounts/?page=2"

results*array of PrivateToken (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/auth/private_tokens/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "name": "text",
      "expiration_time": "2024-10-22T10:45:34.192Z"
    }
  ]
}

---

Revoke your private token

Revoke private token

DELETE/api/v1/auth/private_tokens/{id}/

Authorization

PrivateTokenAuthPasswordAuthcookieAuth

Path parameters

id*integer

A unique integer value identifying this private token.

Response

204

No response body

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/auth/private_tokens/{id}/', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();