API Tokens

List API Tokens

get

Returns a paginated list of API tokens with obfuscated token IDs.

Authorizations

jwtapiToken

Query parameters

pageintegerOptional

The page number of results

Example: 1

limitintegerOptional

The number of results to return per page

Example: 10

Responses

200

OK

application/json

totalinteger · int32OptionalExample: 25

nextPagenumber · int32 · nullableOptionalExample: 2

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get/v2/api-tokens

HTTPcURLJavaScriptPython

GET /v2/api-tokens HTTP/1.1
Host: api.appetize.io
Accept: */*

{
  "total": 25,
  "nextPage": 2,
  "tokens": [
    {
      "id": "6592008029c8c3e4dc76256c",
      "obfuscatedToken": "tok_abcd****",
      "label": "CI/CD Token",
      "role": "developer",
      "lastUsed": "2021-01-01T00:00:00.000Z",
      "created": "2021-01-01T00:00:00.000Z",
      "createdBy": "[e-mail]"
    }
  ]
}

Create a new API token

post

Creates a new API token. Returns the full token only once. Token must be saved securely by the user.

Authorizations

jwtapiToken

Body

application/json

labelstringRequired

The label of the API token.

Example: CI/CD Token

rolestring · enumRequired

The role of the API token.

Example: developerPossible values:

Responses

201

API Token created

application/json

idstringRequired

The ID of the API token.

Example: 6592008029c8c3e4dc76256c

obfuscatedTokenstringRequired

The string representing the token obfuscated

Example: tok_abcd****

tokenstringRequired

The full token string

Example: tok_abcdefghijklmnopqrstuvwxyz

accountIdstringOptional

The ID of the account.

Example: 6592008029c8c3e4dc76256c

labelstringRequired

The label of the API token.

Example: CI/CD Token

createdBystringRequired

The email of the user who created the API token.

Example: [e-mail]

createdstringRequired

The date and time the API token was created.

Example: 2021-01-01T00:00:00.000Z

lastUsedstring · nullableOptional

The date and time the API token was last used.

Example: 2021-01-01T00:00:00.000Z

rolestring · enumRequired

The role of the API token.

Example: developerPossible values:

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post/v2/api-tokens

HTTPcURLJavaScriptPython

POST /v2/api-tokens HTTP/1.1
Host: api.appetize.io
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "label": "CI/CD Token",
  "role": "developer"
}

{
  "id": "6592008029c8c3e4dc76256c",
  "obfuscatedToken": "tok_abcd****",
  "token": "tok_abcdefghijklmnopqrstuvwxyz",
  "accountId": "6592008029c8c3e4dc76256c",
  "label": "CI/CD Token",
  "createdBy": "[e-mail]",
  "created": "2021-01-01T00:00:00.000Z",
  "lastUsed": "2021-01-01T00:00:00.000Z",
  "role": "developer"
}

Get an API token by id

get

Retrieve a specific API token’s info.

Authorizations

jwtapiToken

Path parameters

idstringRequired

The id for the API token

Example: 6592008029c8c3e4dc76256c

Responses

200

The API token

application/json

idstringRequired

The ID of the API token.

Example: 6592008029c8c3e4dc76256c

obfuscatedTokenstringRequired

The string representing the token obfuscated

Example: tok_abcd****

labelstringRequired

The label of the API token.

Example: CI/CD Token

rolestring · enumRequired

The role of the API token.

Example: developerPossible values:

lastUsedstring · nullableOptional

The date and time the API token was last used.

Example: 2021-01-01T00:00:00.000Z

createdstringRequired

The date and time the API token was last used.

Example: 2021-01-01T00:00:00.000Z

createdBystringRequired

The email of the user who created the API token.

Example: [e-mail]

401

Unauthorized

application/json

403

Forbidden

application/json

404

API Token not found

application/json

get/v2/api-tokens/{id}

HTTPcURLJavaScriptPython

GET /v2/api-tokens/{id} HTTP/1.1
Host: api.appetize.io
Accept: */*

{
  "id": "6592008029c8c3e4dc76256c",
  "obfuscatedToken": "tok_abcd****",
  "label": "CI/CD Token",
  "role": "developer",
  "lastUsed": "2021-01-01T00:00:00.000Z",
  "created": "2021-01-01T00:00:00.000Z",
  "createdBy": "[e-mail]"
}

Rekove an API token

delete

Revoke an API token.

Authorizations

jwtapiToken

Path parameters

idstringRequired

The id for the API token to revoke

Example: 6592008029c8c3e4dc76256c

Responses

204

API Token rekoved

No content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

API Token not found

application/json

delete/v2/api-tokens/{id}

HTTPcURLJavaScriptPython

DELETE /v2/api-tokens/{id} HTTP/1.1
Host: api.appetize.io
Accept: */*

No content