Operator API account management

If you want to use Uptrends' API you need an API account (which is not the same as your Uptrends account). The credentials of the API account have to be entered using the Basic authentication scheme for execution of an API call. Check the information in Usage of your API account on how to enter the credentials when making API calls.

The API management tab of an operator lets you manage all API accounts that are related to a specific operator.

Adding an API account

To add a new API account to an operator:

1. Go to Account setup > Operators, groups (and sub accounts).

2. Click the View all operators button.

3. In the list of operators click the one that you want to add an API account to.

4. Switch to the API management tab.

5. Click the Add API user button.

6. Follow the wizard and make sure to note down the password. The API account is added to the list of API users:

   

7. Click the Save button at the bottom to save the changes to the operator.

On the API management tab of an operator you can see all API user accounts that are linked to this operator. You can also see the creation date and when the account was last used. These options may appear in the Last used column:

• Unknown — is shown when the API account was created before the functionality of “Last used” became available.
• Not yet used — means that the API account was created after introduction of the “Last used” feature, but the account hasn’t been used.
• Date/time — the timestamp of the latest use of the API account will be shown if the account was created and used after introduction of the “Last used” feature.

Note that there is another (older) way of adding a API account by using the /Register method of Uptrends' API. This method is not recommended, as it is less handy in most situations. However, this will still work and the instructions can be found in Register an API account . An account that is added through the API will also appear on the API management tab of an operator.

Deleting an API account

To delete an API account from an operator:

1. Go to Account setup > Operators, groups (and sub accounts).
2. Click the View all operators button.
3. In the list of operators click the one that you want to remove an API account from.
4. Switch to the API management tab.
5. In the row of the account that you want to remove, click the Delete API user button.
6. Click the Save button at the bottom.