How to Generate a LinearB API Token

LinearB can track deploy time based on API calls from your CI/CD system, report incidents to more accurately measure MTTR and CFR, import custom metrics, or export export LinearB data using our LinaerB API.

API Documentation can be found here: https://docs.linearb.io/api-overview/

Use the instructions below to generate a release API token. Additionally, if you plan to use the token to track releases, you will need to complete the prep work below:

Prep work for tracking releases (optional, only for release tracking):

  • Make sure to first update your release detection in LinearB to use the API integration. Go to Company Settings -> Advanced and select "API Integration" under Release Detection.
    • Don't see an "API Integration" option? Contact support@linearb.io to upgrade or enable this feature!
  • The UI is built to generate a token for the final release stage of deployment. If you would like to monitor multiple deployment stages, such as a QA or staging phase prior to release, please contact our support team at support@linearb.io to implement a multi-stage detection strategy.

Generating a API Token (all use cases)

  1. Navigate to company settings and open the API Tokens tab
  2. Click the "Create API Token" button, a popup window will appear with your new key.
  3. Copy the API token.
You must copy this key before closing the generated window. The one and only time this key is visible is upon generation. 

The generated token can be installed in your CI/CD system to notify LinearB when code is deployed. For more detail on implementing this API in your system, please review our documentation here: Multi-Stage Delivery API

Update or Revoke API Token

API Tokens are only visible the first time they are generated. If you need to update or change your API Token, first revoke the existing token and generate a new token. Tokens can be revoked at any time. Simply click the "revoke" button next to your current token to revoke access.


How did we do?


Powered by HelpDocs (opens in a new tab)