Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

Manage API Tokens

API tokens authenticate users when they try to retrieve information from Routing Director by using REST APIs. By using API tokens, users can avoid authentication for each request that 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

    You must assign at least one access control profile to a Network Admin role to grant access to resources. See Access Control Profile Overview.

  • Observer

  • Installer
Key

The key auto-generated to identify the application the user is using to access the resources.

Tags

Tags assigned to the API token.

If there is more than one tag assigned to the API token, an integer is present next to the displayed tag. For example, +2 in the Tags column indicates that there are two more tags in addition to what is currently listed. You can hover over the integer to view the additional tags assigned to the API token.

To assign a tag, edit the API token. See Edit an API Token.
Access Control Profile

Assign one or more access control profiles to grant access to resources (devices, service instances, and perform tagging operations).

If an access profile does not exist, click the +Add Access Control Profile link to create a new profile and assign it to the Network Admin user. See Add Access Control Profiles.

Add an API Token

To add an API token for a role:
  1. Click Settings Menu > System Settings on the banner.
    The Organization Settings page appears.
  2. Click the Create Token (+) icon.
    The Create API Tokens page appears.
  3. Enter values by following the guidelines in Table 1.

    Fields marked * are mandatory.

  4. Click Generate.
    The API token is populated in the Key field.
  5. Click Close to return to the Organization Settings page.

Edit an API Token

To edit an API token:
  1. Click Settings Menu > System Settings on the banner.
    The Organization Settings page appears.
  2. Click the API token that you want to edit.
    The Edit API Token page appears.
  3. Add a pre-defined tag and edit the name, role, and assigned tags. If a tag does not exist, click the Create New Tag link to create a new tag and then assign the tag to the API token.
  4. 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 Routing Director resources cannot access the resources after the API token is deleted.

  1. Click Settings Menu > System Settings on the banner.
    The Organization Settings page appears.
  2. Click the API token that you want to delete.
    The Edit API token page appears.
  3. 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.

See Also