Overview

Cirrus utilizes the REST APIs principles, allowing developers to perform queries to the Cirrus platform. We support GET, POST, and DELETE requests. Use a Get request to retrieve information, a POST to create or update an entity, and a DELETE to remove an entity.
After receiving the request, the API sends back an HTTP code as a response in JSON format.

Structure and Examples

Access Token

All API requests require an Access Token to validate authenticity to indicate to the system what modules, operations, and resources the user can access. See more detailed information in the Security and Authentication section of this documentation.

Base URI

All URLs referenced in the documentation have the following base: https://api.commbox.io

Request

• The request must include the module and operation in the URI.
  For example, to access an operation called SystemStatus in the Core module, make an HTTP request to –
  /Core/SystemStatus
• To receive specific information regarding a resource, use the provided parameters in the URI.
  For example, to access a specific user data in the Core module, make an HTTP GET request to –
  /Users/{USER_ID}/Details
• To change a resource, use an HTTP POST request to the resource URI.
  For example, to change a specific user name in the Core module, make an HTTP POST request to –
  POST /Users/{USER_ID}/Details
  And include the post parameter
  data={"FirstName":"FIRSTNAME", "LastName":"LASTNAME"}
• To delete a resource, use an HTTP DELETE request to the resource URI.
  For example, to change a specific user name in the Core module, make an HTTP DELETE request to –
  DELETE /Users/{USER_ID}/

Response

Possible Response Status Codes