API: Plans
Plans contain details about various backup services.
- All storage limits are based on compressed data. For example, your database is 300 MB, but compresses down to 30 MB. Thirty MB is what is counted when determining the total storage used.
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 |
|---|---|---|
| PlanId | Integer | Read Only |
| PlanTypeId | Integer | Read Only |
| PlanType | Object | Read Only, See API Plan Types |
| Name | String 100 | Read Only |
| Details | String | Read Only |
| IsInactive | Boolean | Read Only |
| DeviceLimit | Integer | Read Only, the total number of Devices allowed on this Plan. |
| StorageLimit | Integer | Read Only, the total storage, in GB, allowed on this Plan. |
| DownloadLimit | Boolean | Read Only, if true, this Plan has a restriction on downloading backups. |
List (GET)
Returns an array of Plans in descending order.
URL
https://cleverfoxbackup.com/api/plans
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": [
{
"PlanId": 1,
"PlanTypeId": 1,
"PlanType": {
"PlanTypeId": 1,
"Name": "CleverFox Backup",
"IsInactive": false
},
"Name": "Small Plan",
"Details": "1 Device\r\n25 GB Storage\r\nEmail Support\r\nFree Updates",
"IsInactive": false,
"DeviceLimit": 1,
"StorageLimit": 25,
"DownloadLimit": false
}
],
"page_no": 1,
"page_size": 25
}
Read (GET)
Returns a single Plan.
URL
https://cleverfoxbackup.com/api/plans/{PlanId}
Required Parameters
- PlanId
Response Codes
- 200 OK
- 404 Not Found
{
"data": {
"Name": "Small Plan",
"Details": "1 Device\r\n25 GB Storage\r\nEmail Support\r\nFree Updates",
"IsInactive": false,
"DeviceLimit": 1,
"StorageLimit": 25,
"DownloadLimit": false
}
}
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.