The Airplane API is currently available to customers as a beta and is subject to change. Please reach out to us as email@example.com with any feedback!
The Airplane API uses API keys to authenticate your requests. API keys are prefixed with
Authentication to the API is performed by supplying the
X-Airplane-API-Key header. Runs and
sessions created through the API are recorded as being run by
You can view and manage your API keys with the Airplane CLI. To generate a new token:
bashCopied1airplane apikeys create <token name>
API keys can be created by
Team admins and
Team developers. See
Team Roles for details.
Your API keys carry the privileges to execute every task and runbook your team owns so be sure to keep them secure! Do not share your API keys in publicly accessible areas such as GitHub, client-side code, etc.
All API requests must be made over HTTPS. Any requests made over plain HTTP will fail. Requests
without a valid API key will fail and return a
bashCopied1# Authenticated request example2curl https://api.airplane.dev/v0/runs/get \3-H 'X-Airplane-API-Key: tkn_examplekey123456789EXAMPLEKEY1234567' \4-d id=run20220222example \5-G