Skip to main content
Skip table of contents

Get and delete API token

Gets API token existing for a current account and deletes it.

Step 1 - Sign in

Sign user in.

Endpoint

CODE
POST /login

Request

JSON
POST /login

Content-Type: application/json

{
  "name": "mary.griffin@circularo.com",
  "password": "#32Password1!",
  "tenant": "default"
}

Response

Note following properties in response object:

  • token - In response object at position token.

    • It may have value of dzS8LArPqzYzirvc3FGuZmufwguKxBHIGfUOQQivzZARDahwnFEE7mVpVM70gF99.

Step 2 - Get API tokens

Get all API tokens existing for a current account.

Endpoint

CODE
GET /api/key

Request

JSON
GET /api/key?token=dzS8LArPqzYzirvc3FGuZmufwguKxBHIGfUOQQivzZARDahwnFEE7mVpVM70gF99

Response

Note following properties in response object:

  • apiToken - In response object at position results[0].id.

    • It may have value of uHWf13GOMoTJ43d2dcaTYWclSCAMMlbTOLnIJtRkayJ7WsYmdEAdkOuWQCXL3mpo.

Returned array contains all existing API tokens for current account.

Step 3 - Delete API token

Deletes given API token.

Endpoint

CODE
DELETE /api/key/:token

Request

JSON
DELETE /api/key/uHWf13GOMoTJ43d2dcaTYWclSCAMMlbTOLnIJtRkayJ7WsYmdEAdkOuWQCXL3mpo

Step 4 - Sign out (Optional)

Sign user out.

Endpoint

CODE
GET /logout

Request

JSON
GET /logout?token=dzS8LArPqzYzirvc3FGuZmufwguKxBHIGfUOQQivzZARDahwnFEE7mVpVM70gF99

The API token is now deleted and can't be used anymore.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.