# Authentication

{% hint style="info" %}
The REST API is available as BETA.
{% endhint %}

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.&#x20;

Jira issue data (including [custom fields](/advanced/ativo-programs-custom-fields.md) ) 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.

<figure><img src="/files/YrdeE096vSkaEOtHUIy2" alt=""><figcaption></figcaption></figure>

Choose a name for the token, and click submit.&#x20;

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

<figure><img src="/files/DvXZcYQJkROxSSlVvQf3" alt=""><figcaption></figcaption></figure>

### Revoke a token

Jira admins can revoke tokens. They can do so for all tokens, including tokens from other Jira admins.&#x20;

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

<figure><img src="/files/iG986fZbiY7n2bLtrAOg" alt=""><figcaption></figcaption></figure>

### Authentication and authorization

Most REST API clients provide a mechanism to supply an authorization token.&#x20;

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

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

### Versioning

The Jira API endpoints and returned models are [versioned](/rest-api/version.md).

### Learn more

Browser the REST API:

{% content-ref url="/pages/oGjtoJPXoaBERu8TxaN9" %}
[Cloud REST API](/rest-api/cloud-rest-api.md)
{% endcontent-ref %}

{% content-ref url="/pages/KH8KzKAMs0mtwbzVwRS4" %}
[Data Center REST API](/rest-api/data-center-rest-api.md)
{% endcontent-ref %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ativo.io/rest-api/authentication.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
