Broox Topology API

Broox Topology API is a REST API allowing access to all the Broox Studio objects.

With it you can automate all available operations (installation creation, device provisioning, etc.) available in the Studio.

Usage

HTTP Requests should be directed to the /api endpoint of your Broox Studio instance.

All requests shall be authorized via your API Key in an Authorization: Bearer header.

For example, using typescript:

const options = {
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer ' + apiKey,

  }
};
fetch(host + '/api/account', options).then(accounts => ...

Obtaining your API Key

Every function in the Broox Topology API requires an API key. In order to get it, follow next steps:

1. Go to Broox Studio

2. In your user profile menu, go to Settings

   

3. Copy the API Key

The API key is only available to Administrators, and is usable instance-wide.

API reference

Access de API Reference to get more details

Broox Topology API Reference