Ativo Programs for Jira 📖 Documentation
  • Getting started
    • Quickstart guide
    • Prerequisites
    • Installation
      • Updates
    • Cheat sheet
  • Configuration
    • Permissions
    • Team
    • Program (release train)
    • Period (program increment)
    • Project and Jira (JQL) filters
  • Preparing a Program Increment (PI)
    • Program cycle
    • Feature backlog
  • Program Increment (PI) planning
    • Plan issues
    • Plan epics (features)
    • Plan dependencies
    • Raise risks and impediments
    • PI Objectives
    • Capacity
    • Team breakout
  • Scrum of scrums / Art Sync
    • Scrum of scrums and art-sync preparation
    • Progress per team
    • Progress per program
  • Cross-pi
    • Cross-PI dependencies
  • Advanced
    • Export issues, PI objectives, milestones and capacity to Excel
    • Ativo Programs custom fields
      • Field sharing
      • Ativo Program fields use PI keys since April 2023
    • Fields added to screens
    • Issue types
    • Limit permissions of suppliers
    • Jira Service Management tickets on the program board
    • Server to cloud migration
  • REST API
    • Authentication
    • Version
    • Cloud REST API Rate Limiting
    • Cloud REST API
    • Data Center REST API
  • Training
    • User training
Powered by GitBook
On this page
  • Create an API token
  • Revoke a token
  • Authentication and authorization
  • Versioning
  • Learn more
  1. REST API

Authentication

Connect to the REST API

PreviousServer to cloud migrationNextVersion

Last updated 11 months ago

The REST API is available as BETA.

The REST API allows you to interact with Ativo Programs interactively. Use this API to extract configuration data that has been saved in Ativo itself.

Jira issue data (including ) is never processed in the Ativo backend, and hence not available via the API. Use the Jira API instead to access Jira issue data.

Create an API token

Jira admins can create an API authentication token. Go to Jira settings > Manage apps > Ativo Programs > REST API and click on "Create" button.

Choose a name for the token, and click submit.

The generated token will be shown. Make sure to copy the token, as you will not be able to see it again afterwards.

Revoke a token

Jira admins can revoke tokens. They can do so for all tokens, including tokens from other Jira admins.

Click on the revoke button next to the token. The token is revoked immediately.

Authentication and authorization

Most REST API clients provide a mechanism to supply an authorization token.

For example, you can supply the -H option to curl. The example (for Jira cloud) below will provide the index list of Ativo teams.

curl https://cloud-api.ativo.io/rest/api/1/team
 -H "Authorization: Bearer <token>"

Versioning

Learn more

Browser the REST API:

The Jira API endpoints and returned models are .

versioned
Cloud REST API
Data Center REST API
custom fields