API Token Generation

Need to Access REST API?

REST API is only available for subscribers of Team plan or higher.

In order to use the powerful automation side of RapidPipeline an API token is necessary to connect to our licensing system.

This token can be generated from the user interface for active subscribers of the Team plan or higher.

The generation of API tokens is not available with the free or Starter plan.

Log in on https://app.rapidpipeline.com and navigate to your account settings on the top right corner, then select -> API Tokens. Now give your new token a custom name and click Create API Token:

IMPORTANT

You then need to copy the token string once (it won’t be accessible through the Web interface later, for security reasons) and insert it into your rpd_account.json file (CLI) :

{
    "host" : "api.rapidcompact.com",
    "token" : "YOUR API TOKEN HERE"
}

or credentials.json file (rpdc.py tool):

{
    "token" : "YOUR API TOKEN HERE"
}

Token status & revoking

You can always check the status of your token and see if it is in recent use or not. In addition in the same overview you can always revoke a token. Keep in mind that process is terminal and you will not be able to recover the token. Simply create a new token instead.

Multi-User

As you can see, the API token generation process is pretty straight forward and there is currently no limitation on the number of available tokens. That means you can have one account in your organization and share multiple tokens with different teams, departments or individual users. The main administration tools will be managable only from the account which created the tokens in the first place.

Note that this approach works well using the CLI and API distributions of RapidPipeline, but will not work if multiple users want to access the same web portal account and interface (there is currently no multi-tenant system for the platform UI itself).