JSON Envelope Format
Format
All data returned by the API will be in the following format:
| Name | Description |
|---|---|
| Data | The data returned. |
| Meta | Metadata associated with the request. |
| Errors | Request errors, if any. |
Data
The API will return a list of results in the data section based on the API endpoint used. Below is an example of the policies data section.
"data": [
{
"name": "Audit",
"guid": "c404a4ba-e953-4468-98d0-123456789123",
"description": "This policy puts the Secure Endpoint Connector in audit mode.",
"createdAt": "2020-01-18T23:58:21.000Z",
"updatedAt": "2020-01-18T23:58:21.000Z",
"serialNumber": 169,
"orbital": {
"enabled": false
},
"operatingSystem": "linux",
"policyType": "workstation"
}
]
Meta
In most cases, the "meta" object provides information on how many results were returned.
Pagination
"meta": {
"start": 0,
"size": 1,
"total": 149,
"create": "/services/organizations/OrgIdentifierHere/policies"
}
The size of the result set is a required parameter for paginated lists. A sample result set will look like this:
"meta": {
"start": 0,
"size": 50,
"total": 149,
"create": "/services/organizations/OrgIdentifierHere/policies"
}
To retrieve the next set of 50 results or any other offset in a paginated list, specify an optional zero-based start parameter. Example:
"meta": {
"start": 50,
"size": 50,
"total": 149
}
Links
A series of links are returned in the meta section for convenience purposes that help create other useful API queries.
"meta": {
"proxy": "/services/organizations/OrgIdentifierHere/policies/c404a4ba-e953-4468-98d0-123456789123/proxy",
"networkControlLists": "/services/organizations/OrgIdentifierHere/policies/c404a4ba-e953-4468-98d0-123456789123/network_control_lists",
"exclusionSets": "/services/organizations/OrgIdentifierHere/policies/c404a4ba-e953-4468-98d0-123456789123/exclusion_sets"
}
Errors
A list of errors are returned in the meta section if any exist.
{
"data":{},
"meta":{
"errors": [
{
"attribute": "size",
"message": "size is a required parameter"
}
]
}
}