Create and use API tokens

Create a token

You need a Developer or Admin role on at least one project.

1. Open Settings.

2. Select API Tokens.

3. Enter a recognizable Token name, such as Production deploy hook.

4. Choose the Project.

5. Select Create token.

6. Copy the token immediately.

The plain token is displayed only when it is created. DeployMonitor cannot show it again later.

Store the token in a password manager or deployment secret store. Never commit it to source control, place it in client-side code, or print it in logs.

Understand token scope

Every token is assigned to one project and receives these abilities:

• project:read to retrieve the assigned project.

• project_logs:read to list and view the assigned project's logs.

• project_logs:create to create logs for the assigned project.

The project scope cannot be changed after creation. Create a separate token for another project.

The token owner's current role still applies. The token loses access if its owner loses access to the project. Log creation also stops if the owner no longer has a Developer or Admin role.

Authenticate requests

Send the token as a Bearer token and request JSON responses:

Authorization: Bearer <token>
Accept: application/json
Content-Type: application/json

Use Content-Type: application/json for requests with a JSON body.

Review and revoke tokens

The API Tokens page lists each token's project, creation time, and last-used time. A token that has not authenticated a request displays Never used.

Select Revoke, review the token name, and confirm Revoke token to disable it immediately.

Update the connected integration before or immediately after revocation to avoid failed requests.

Next, see Get the project assigned to a token.