Manage API Tokens

date_range 29-Mar-24

arrow_backward

arrow_forward

API tokens use REST APIs to authenticate users when they try to retrieve information from Juniper Apstra Cloud Services. By using API tokens, users can avoid authentication for each request they make. An API token provides visibility into the resources accessed by a user, enabling you to have better control over access to resources.

Table 1 lists the parameters for configuring API tokens.

Table 1: Parameters to Configure API Tokens
Field	Description
Name	Name of the API token.
Role	Role to which the API token is applicable: Super User Network Admin Observer Helpdesk
Key	The key auto-generated to identify the application the user is using to access the resources.

Add an API Token

To add an API token for a role:

Click Organization > Settings in the navigation menu.
The Organization Settings page appears.
Click the Create Token icon.
The Create API Tokens page appears.
Enter values by following the guidelines in Table 1.
Click Generate.
The API token is populated in the Key field.
Click Close to return to the Organization Settings page.

Edit an API Token

To edit an API token:

Click Organization > Settings in the navigation menu.
The Organization Settings page appears.
Click the API token that you want to edit.
The Edit API Token page appears.
Edit the name, role, and site access by following the guidelines in Table 1.
Click Save.
You are returned to the Organization Settings page, where you can verify the changes in the API Tokens table.

Delete an API Token

To delete an API token:

Note:

Users using API tokens to access Juniper Apstra Cloud Services resources cannot access the resources after the API token is deleted.

Click Organization > Settings in the navigation menu.
The Organization Settings page appears.
Click the API token that you want to delete.
The Edit API token page appears.
Click Delete.
You are returned to the Organization Settings page, where you can verify that the API token is not listed in the API Tokens table.

arrow_backward PREVIOUS Manage Roles

NEXT arrow_forward Configure Webhooks to Receive Event Notifications in Third-Party Applications

Juniper Apstra Cloud Services User Guide

ON THIS PAGE

Manage API Tokens

Add an API Token

Edit an API Token

Delete an API Token

Stay in touch

Helped me install or use the product
Accelerated my deployment

Discuss the product with a co-worker
Make a purchase inquiry