User Authentication
Overview
Authentication to the Release API is done using headers. Users must generate a user authentication token using the Release CLI, then include it in API requests.
Installing the Release CLI
Follow the installation instructions at: Release CLI Installation Guide
Generating a User Authentication Token
To generate a user authentication token, run the following command interactively from your local machine:
After authentication, the Release CLI stores credentials in ~/.release.yaml
.
Using Authentication in a Non-Interactive Environment
For non-interactive environments, such as CI/CD systems or programmatic use:
Install and authenticate the Release CLI on your local machine using
release auth login
.Copy the
login
andtoken
values from the Release config file at~/.release.yaml
.Or you can visit https://web.release.com/profile to copy your user auth token from the Release user inteface
API Authentication Headers
Once you have generated a user authentication token, use the following headers in API requests:
X-User-Token
: The authentication token retrieved from the Release CLI.X-User-Email
: The user email associated with the authenticated Release account.
Include these headers in all API requests to authenticate with the Release API.
Last updated
Was this helpful?