LinearB Deployment API
Updated
LinearB's delivery API enables enterprise customers to customize their deploy-time measurement to detect code deployments via an API call. This can also be customized to account for additional pre-deploy stages such as staging, pre-production, or QA. Additional stages added will be broken out in Metrics reports in LinearB.
Custom Stage Examples
qa- custom stage for QA stagepre_prod- custom stage for Pre-Prod stagerelease- built-in stage to identify actual deployment to production
Steps for Implementation
Single Stage Deployments
If you would like to listen for just your code deploys, API tokens can be generated following these instructions: How to Generate a Release API Token. Once generated, use the documentation linked below to build your API calls.
Multiple Stage Deployments (Available in paid plans)
Please contact your account manager or support@linearb.io in order to implement this feature. The process is listed below:
- Notify LinearB of the release stages you utilize and the order in which these stages progress. Please be sure to include the key you'll send via API (ex: preprod) as well as the name of the stage (ex: Pre-Prod) that you want to show in the Metrics reports.
- LinearB will configure your instance to listen for these stages.
- LinearB will then send you an API token.
- Use the documentation linked below to build your API calls.
What is marked as deployed when an API call is sent LinearB?
When a CD system sends a call to LinearB, all branches set as "merged" in the repo from which the call is sent are now set to "released".
