• Release notes
  • Setting up Pipelines for Applications
  • Applications and application groups
  • Application tutorials
  • Builds
  • Environments
  • Deployments
  • Deployment tutorials
  • Manifest
  • Releases
  • Jobs
  • Docker
  • Servers
  • Agent and CLI
  • Application pipelines
  • Dashboards
  • Users and groups
  • Integrations
  • Notifications
  • API

Pipelines API tokens

Sections


Before beginning these steps, ensure you are in the appropriate account. If you need to change accounts, see Switching accounts.

Create an API Token

  1. In the Pipelines web UI click the gear icon on the top right.
  2. Click the API link on the left.
  3. Click the Create API Token button.
  4. Give the token a meaningful Description.
  5. Click the Create Token button.

You have created an API token. You can now test the token with the following ListApps call.

curl -i "https://api.distelli.com/USERNAME/apps?apiToken=TOKEN"

Replace USERNAME with your Pipelines user name or team user name. Replace TOKEN with the Pipelines API token.

You should be returned a list of applications. If you do not get a 200 OK, ensure you are using the correct user name with the correct token.

If necessary, see Finding your Pipelines username.


Before beginning these steps, ensure you are in the appropriate account. If you need to change accounts, see Switching accounts.

Deactivate an API Token

  • In the Pipelines web UI click the gear icon on the top right.
  • Click the API link on the left.
  • For the API token you wish to deactivate, click the gear on the right.
  • This will open a dialog.

  • Check the Deactivate API Token.
  • Click Update Token button.

You have deactivated your API token.


Before beginning these steps, ensure you are in the appropriate account. If you need to change accounts, see Switching accounts.

Delete an API Token

A token must be deactivated before it can be deleted.

  1. In the Pipelines web UI click the gear icon on the top right.
  2. Click the API link on the left.
  3. For the API token you wish to delete, click the gear on the right.
  4. Note:The token must be deactivated before deleting.

  5. Check the I understand this is permanent box.
  6. Click Delete Token button.

You have permanently deleted your API token.


Before beginning these steps, ensure you are in the appropriate account. If you need to change accounts, see Switching accounts.

Find your API Token

Important: You must have created an API token before you can find it.

  1. In the Pipelines web UI click the gear icon on the top right.
  2. Click the API link on the left.

Here you can see any created API tokens.

If there are no tokens, you can create one. See creating an API token.


Before beginning these steps, ensure you are in the appropriate account. If you need to change accounts, see Switching accounts.

Reactivate an API token

These instructions assume the token you wish to reactivate has been deactivated.

  1. In the Pipelines web UI, click the gear icon on the top right.
  2. Click the API link on the left.
  3. For the API token you wish to reactivate, click the gear on the right.
  4. This will open a dialog.

  5. Check the Reactivate API Token.
  6. Click Update Token button.

You have reactivated your API token.

How helpful was this page?
Puppet sites use proprietary and third-party cookies. By using our sites, you agree to our cookie policy.