Questions? We have answers.

MindBridge API: Overview

  • Updated

Summary

The MindBridge application programming interface (API) enables secure access to enterprise assets and processes, saving time by extracting and importing data directly into the MindBridge platform.


Configuration details

You must be an App Admin to access the API tab.


Go to the API tab

  1. Open the MindBridge sidebar ( Sidebar open-close icon.svg ) from anywhere in the application.
  2. Select Admin ( Admin icon.svg ).
    You will go to the User management tab on the Admin page.
  3. Select the API tab.


Overview

The API tab provides:

  1. Search capabilities.
  2. A way to filter for API tokens.
  3. A link to the API's reference documentation.
  4. A way to create a new API token.
  5. A sortable list of existing tokens.
  6. A hint at the API token IDs — this may be helpful for Admins managing multiple API tokens.
  7. The date of token creation.
  8. The date of token expiration.
  9. The token's current status in MindBridge.
  10. More actions, including means to rename, renew, and delete existing API tokens.

API_tab_overview.png


Search

  1. Enter the API token name in full or in part into the Search field.
  2. Press enter/return on your keyboard, or select the magnifying glass icon ( Search icon.svg ).
    The dashboard displays tokens that match your search criteria.


Filter tokens

Filtering allows you to find relevant API tokens quickly.

  1. Open the Status menu.
  2. Select between:
    • Active: Displays all tokens that are currently active.
    • Expired: Displays all tokens that have expired.


Create API tokens

  1. Select Create token near the top of the page.
    You will go to the token creation page.
  2. Enter a Name for the new token.
  3. Open the Expiration menu and select when the token should expire.
    If you select Custom, use the calendar to select a specific expiration date.
  4. Check the boxes next to the permissions to define the scope of access users should have to specific areas (or "endpoints") in MindBridge.
    • Read access grants users the ability to view the designated component.
    • Write access grants users the ability to edit and make changes within the designated component.
    • Delete access grants users the ability to delete or make deletions within the designated component.
  5. Add individuals or groups to the Allow list:
    • Add an IP address to grant access to any single device on a network.
    • Add a CIDR to grant access to a network or multiple devices on a network.
  6. When you are satisfied, select Create token to create a new token.
  7. Once the token has been created successfully, copy and save it to a secure location.

Create_an_API_token_example.gif

Note: The API token can only be viewed and copied once and cannot be reproduced. If the token number is lost or the token settings need updating, you must create a new token.

Organize columns

Sort a column

Sort columns in ascending or descending order by selecting the column header. The darker triangle indicates the sort order.

Reorder columns

Click and drag the desired column header left or right into its new location.

Add and remove columns

Open the Columns menu on the right side of the table and check the box next to each column you want to display.

Pin a column

Pinning columns ensures they will stay in view when scrolling horizontally.

Open the menu on the column header you want to pin and select Pin Column, then choose the pin location on the tableLeftRight or No Pin (default). 


Rename tokens

Renaming is the only modification you can make to an existing API token.

  1. Open the Actions menu in line with the token you want to rename.
  2. Select Rename.
  3. Enter a new name for the token.
  4. When you are satisfied, Save your changes.


Renew tokens

Renewing a token does not re-use the existing token, but rather copies the existing settings into a new token.

  1. Open the Actions menu in line with the token you want to rename.
  2. Select Renew.
    You will go to a token creation page with a pre-populated name, permissions, and allow list.
  3. Open the Expiration menu and select when the token should expire.
    If you select Custom, use the calendar to select a specific expiration date.
  4. When you are satisfied, select Renew token.
  5. Once the token has been created successfully, copy and save it to a secure location.
Note: The API token can only be viewed and copied once and cannot be reproduced. If the token number is lost or the token settings need updating, you must create a new token.

Delete tokens

Tokens can be deleted whether they are active or not.

  1. Open the Actions menu in line with the token you want to rename.
  2. Select Delete.
    A confirmation window appears.
  3. To permanently delete the token, select Delete.


Anything else on your mind? Chat with us or submit a request for further assistance.


Related articles

Was this article helpful?