API: Events
Events are the history of every "action" that has occured on the website or via the API.
- Partners have access to all Events associated with any Company account that signed up for CleverFox Backup using a special Partner Plan link.
Attributes
All of the attribute fields are returned from GET (read) operations. Only those attributes not marked as read only may be set via POST (create) or PUT (update) operations.
| Name | Type | Notes |
|---|---|---|
| EventId | Integer | Read Only |
| EventTypeId | Integer | Read Only |
| EventType | String | Read Only |
| BackupTypeId | Integer | Read Only |
| CompanyId | Integer | Read Only |
| CompanyUserId | Integer | Read Only |
| DeviceId | Integer | Read Only |
| JobId | Integer | Read Only |
| JobItemId | Integer | Read Only |
| LogId | Integer | Read Only |
| LogItemId | Integer | Read Only |
| PartnerId | Integer | Read Only |
| PartnerUserId | Integer | Read Only |
| PlanId | Integer | Read Only |
| PlanTypeId | Integer | Read Only |
| SubscriptionId | Integer | Read Only |
| AddedOn | DateTime UTC | Read Only |
List (GET)
Returns an array of Events in descending order.
URL
https://cleverfoxbackup.com/api/events
Optional Parameters
- PageNo: the page number to return, defaults to 1.
- PageSize: the maximum number of records per page, defaults to 25.
Response Codes
- 200 OK
{
"data": [
{
"EventId": 1,
"EventTypeId": 32,
"EventType": "Device Modified",
"BackupTypeId": null,
"CompanyId": 1,
"CompanyUserId": null,
"DeviceId": 1,
"JobId": null,
"JobItemId": null,
"LogId": null,
"LogItemId": null,
"PartnerId": null,
"PartnerPlanId": null,
"PartnerUserId": null,
"PlanId": null,
"PlanTypeId": null,
"SubscriptionId": null,
"AddedOn": "2015-01-01T00:00:00.000"
}
],
"page_no": 1,
"page_size": 25
}
Read (GET)
Returns a single Event.
URL
https://cleverfoxbackup.com/api/events/{EventId}
Required Parameters
- EventId
Response Codes
- 200 OK
- 404 Not Found
{
"data": {
"EventId": 1,
"EventTypeId": 32,
"EventType": "Device Modified",
"BackupTypeId": null,
"CompanyId": 1,
"CompanyUserId": null,
"DeviceId": 1,
"JobId": null,
"JobItemId": null,
"LogId": null,
"LogItemId": null,
"PartnerId": null,
"PartnerPlanId": null,
"PartnerUserId": null,
"PlanId": null,
"PlanTypeId": null,
"SubscriptionId": null,
"AddedOn": "2015-01-01T00:00:00.000"
}
}
Create (POST)
This action is not supported. If called it will return a 405 Method Not Allowed.
Update (PUT)
This action is not supported. If called it will return a 405 Method Not Allowed.
Delete (DELETE)
This action is not supported. If called it will return a 405 Method Not Allowed.