Operator API account management

If you want to use the Uptrends API, you need an API account (also called an API user in the Uptrends app). An API account is not the same as your Uptrends account. You must send the API account credentials using the Basic authentication scheme when you make API calls. For details, see Usage of your API account.

The API management tab lists the API credentials for an operator. Use this tab to review API user details, including when an API user was created and last used. You can edit an API user’s description, but not its credentials.

Add your own API account

To add a new API account:

1. Open the tab using any of these paths:
   • Go to profile > User settings > API management.
   • Go to profile > My settings > API management.
2. Click Add API user.
3. Specify the API user description.
4. Click Create new API user.
5. Save the username and password. You cannot retrieve these credentials after the account is created.

Your API account is now created and ready to use.

Delete your own API account

To delete an API account:

1. Open the tab using any of these paths:
   • Go to profile > User settings > API management.
   • Go to profile > My settings > API management.
2. In the row of the API account you want to remove, click Delete.

Your API account is now deleted.

Add an operator’s API account

To add a new API account to an operator:

1. Open the page using either of these paths:
   • Go to Account setup > Operators and groups > View all operators.
   • Go to Admin > Operator groups > View all operators.
2. Click the operator you want to add an API account to.
3. Open the API management tab.
4. Click Add API user.
5. Specify the API user description.
6. Click Create new API user.
7. Save the username and password. You cannot retrieve these credentials after the account is created.

Your operator’s API account is now created and ready to use.

Note

An older method for adding an API account is to use the /Register method of the Uptrends API. This method is not recommended because adding an API account through the API management tab is more convenient in most cases. However, the /Register method is still supported. For instructions, see Register an API account.

API accounts added using the /Register method also appear on the API management tab for the operator.

Delete an operator’s API account

To delete an API account from an operator:

1. Open the page using either of these paths:
   • Go to Account setup > Operators and groups > View all operators.
   • Go to Admin > Operator groups > View all operators.
2. Click the operator you want to remove an API account from.
3. Open the API management tab.
4. In the row of the API account you want to remove, click Delete.

Your operator’s API account is now deleted.