URL Design

API resource URL

All resources can be accessed over HTTPS from the https://{your_region}.manage.ovcirrus.com/api/ov domain:

https://{your_region}.manage.ovcirrus.com/api/ov

CODE

API Headers

The following header must be provided in all POSTand PUTrequests:

Header name	Value	Description
Content-Type	application/json	Used to indicate the media type of the resource.

If this header is missing or invalid, the API will return a 406 Not Acceptable with the following JSON response:

{
    "errorCode": 406,
    "errorMsg": "The 'Content-Type' header is missing or invalid. You should use 'Content-Type: application/json'.",
    "errorDetailsCode": "invalid_header"
}

CODE

API Endpoints

All URLs are built in the same way.

They are composed of a prefix (/api/ov), an API version number, and a suffix which refers to the collection of entities that are addressed by the API:

https://{your_region}.manage.ovcirrus.com/api/ov/{version}/{resourceName}

CODE

For example, a collection of entities of type sites will have the following URL:

https://{your_region}.manage.ovcirrus.com/api/ov/v1/sites

CODE

If we want to address a specific site entity, we will have to indicate the id of the site in the URL:

https://{your_region}.manage.ovcirrus.com/api/ov/v1/sites/{siteId}

CODE

Multiple entities could be added as a suffix. Here is an URL example used to fetch buildings of a given site:

https://{your_region}.manage.ovcirrus.com/api/ov/v1/sites/5d7f92389990373eb098909/buildings

CODE

Response

Most entities will return data in JSON format, and exceptions to this rule are indicated accordingly in our API Reference.