The resource model
The Coro REST API consists of a hierarchy of resources that are manipulated using standard HTTP requests. HTTP URIs are used to address the resources within the Coro platform:
| Resource | URI | Description |
|---|---|---|
| audit-logs | /audit-logs/search | Gets a list of all audit logs for the specified workspace. |
| authentication | /oauth/token | Manages requests for authentication tokens that enable access to the API. |
| devices | /devices | Provides access to the list of protected devices managed by a workspace. Also provides a list of the latest stable Coro Agent packages for the workspace. |
| portal-users | /portal-users | Manages the admin users for a specified workspace. |
| subscriptions | /subscriptions | Manages the subscription for a specified workspace. |
| tickets | /tickets | Manages simple access to the ticket list in a specified workspace. |
| tickets-summary | /tickets/summary | Provides summarized lists of tickets by protection component. |
| usage | /usage | Provides details of which modules and add-ons are activated in a workspace, and an overview of the protected users and devices in that workspace. |
| users | /users | Provides access to the list of protected users in a workspace. |
| webhook-configuration | /webhook-configuration | Manages details of existing webhooks configurations, and creates new webhook configurations. |
| workspaces | /workspaces | View details of provisioned workspaces, create new workspaces, and search for child workspaces. |
All resources are represented as JSON structures (MIME type "application/json"), and objects of each resource type are captured in this format.
For example, a single object of a particular resource type might be represented as a series of key:value pairs such as:
{ "key1": "stringvalue1", "key2": numericvalue2, "key3": booleanvalue3 }
In some cases, objects (such as tickets of a particular type) are stored and presented as an array:
{ "items": [ { "key1": "stringvalue1", "key2": numericvalue2, "key3": booleanvalue3 } ], "totalElements": 100 }
As you make a requests to the Coro API for objects of a specific resource type (such as tickets raised for email anomalies), the response contains a JSON structure representing these objects. To understand the specific response object, refer to the Resources section of this portal.