Gorelo API overview - Gorelo Documentation

Gorelo allows you to integrate with any external product through the Gorelo API. The Gorelo API uses API keys. Include your key in every request via the X-API-Key header. The Gorelo base URL depends on the region you opted to host your data on in Gorelo:

US
Australia

Base URL: https://api.usw.gorelo.io/
API Reference: https://api.usw.gorelo.io/swagger

Example requests

The following JavaScript fetch snippets show how to authenticate with the X-API-Key header. Replace YOUR_API_KEY with your key and swap the base URL for the region hosting your data.

GET

const response = await fetch('https://api.usw.gorelo.io/your-endpoint', {
  method: 'GET',
  headers: {
    'X-API-Key': 'YOUR_API_KEY',
  },
});

const data = await response.json();

POST

const response = await fetch('https://api.usw.gorelo.io/your-endpoint', {
  method: 'POST',
  headers: {
    'X-API-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ key: 'value' }),
});

const data = await response.json();

Scopes and permissions

You can scope API keys. If a key lacks access to an endpoint, the API returns 403 Forbidden.

Error handling

Error	Meaning
401 Unauthorized	Missing/invalid API key
403 Forbidden	Valid key, insufficient scope
429 Too Many Requests	Rate limit exceeded

Status IDs

Agent assets

ID	Status
1	Installing
2	Online
3	Offline
4	Pending Delete
5	Deleted
6	Pending Client Delete
7	Client Deleted

​Example requests

​Scopes and permissions

​Error handling

​Status IDs

​Agent assets

Example requests

Scopes and permissions

Error handling

Status IDs

Agent assets