Remote API Access

You can send programmatic requests to the API for Loome Assist.

First you will need to create an API key, please follow the steps below.

API Keys created before the 26th of September 2023 will have the permissions of an administrator. Previously created API Keys that did not have an application role will remain with administrator permissions, but can be modified by you as needed.

How to Create an API Key

You can find the Remote Access page from the dropdown menu, here you can manage Remote API Keys for Loome Assist.

Remote access page

To create an API Key, click on the Add API Key button in the top-right corner.

Create an API key

Provide a description that will identify where and how this key will be used.

Then choose an expiry date. After this date, this API Key will no longer work.

API key description and expiry date

You can view and copy your Client ID and Client Secret.

Client ID and Client secret

Next, you can click on the Networking tab to apply firewall rules.

You can optionally add your client IPv4 address or firewall rules to this API Key.

API key rules

If you add your client IPv4 address, it will add your Start IPv4 Address and End IPv4 Address.

client IPv4 address

If you add a firewall rule, you can then choose the Rule Name, Start IPv4 Address and End IPv4 Address, and click Save.

Firewall rule

Click on Save at the bottom right to save the API Key.

Save API Key

Your key will display in the API Key table.

Edit an API Key

You can edit the details of this key using Edit on the right of the key.

Edit API key

Copy an API Key

You can either copy the key by right-clicking on the key and clicking Copy, or by editing the key, and using the Copy button on the right of the key.

Copy your API key

Delete an API Key

If you would like to delete an API key, please click on Delete on the right of the key.

Delete an API key

You will be asked to confirm that you would like to delete it.

Confirm that you want to delete an API key

Add an API Key to a Role

You can add an API Key either to an overall application role in the tenant or to a project role in a specific project.

Select a role from the tabs at the top of the page, click Add User, and then choose API Keys as the member type.

Choose user type

Choose an API Key from the dropdown and click Submit.

Choose role

This API Key will have the permissions of this role.

After it has been added, you can use the Client ID of this API Key to access Loome Monitor programmatically. The level of access will be the application role or project role of the API Key.

Working with the Loome Assist API

Like Loome Integrate, Loome Assist exposes a REST API that can be used to interact with Loome Assist programmatically.

We recommend using Loome’s Postman collection. You can easily generate scripts using the Postman collection in your preferred code language.

Set up Prerequisites

You will need to set up prerequisites to use Loome programmatically.

You can first set up script prerequisites according to our guide here.

Set up a Script using Loome’s Postman Collection

  1. Choose a task on the left panel under Assist.

    (The endpoints your API Key can use will depend on the role you have added it to above.)

Please note that these endpoints are subject to change.

  1. Provide any required details in fields such as the URL, Params or Body.

  2. Choose the code button in the right-hand panel.

  3. Choose the code format for your preferred language.

  4. Copy the code for your script using the button on the right.

API steps

If you get a Forbidden 403 error, it means your Client ID does not have the required minimum privilege to run the job. Other errors can inform you that the job has failed.

If you receive errors that contain Bad Request and/or Unauthorised 401, this most likely means your Client ID has been removed from the corresponding tenant.

You can view our guide on using more endpoints in Postman here.