Skip to main content

API Keys

API keys can be used to interact with the WarpBuild API programmatically.

Creating an API Key​

Navigate to the API Keys page and click the Generate API Key button.

Scopes​

API Keys can be scoped to combinations of WarpBuild products. Currently, the following scopes are available:

  • CI
  • Cache
  • Helios

Create an API key

The API key will be displayed only once, so make sure to save it in a secure location.

API key created

Editing an API Key​

You can edit the name and scope of an API key from the API Keys page.

Edit an API key

Using an API Key​

You can use the generated API key to connect to WarpBuild endpoints. Just include the API key in the Authorization header of your request.

curl -X GET "https://api.warpbuild.com/api/v1/builder-profiles?page=1&per_page=20&name=test" \
     -H "Authorization: Bearer <your-api-key>"