Backup Types are used to classify Job Items. The two most commonly used are "File" and "SQL Server".

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
BackupTypeId	Integer	Read Only
EngineId	String 25	Read Only
Name	String 100	Read Only
EngineType	String 10	Read Only
Port	Integer	Read Only
IsInactive	Boolean	Read Only

List (GET)

Returns an array of Backup Types in descending order.

URL

https://cleverfoxbackup.com/api/backuptypes

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

Sample JSON

{
  "data": [
    {
      "BackupTypeId": 2,
      "EngineId": "MSSQL",
      "Name": "SQL Server",
      "EngineType": "SQLServer",
      "Port": null,
      "IsInactive": false
    },
    {
      "BackupTypeId": 1,
      "EngineId": "FILE",
      "Name": "File",
      "EngineType": "File",
      "Port": null,
      "IsInactive": false
    }
  ],
  "page_no": 1,
  "page_size": 25
}

Read (GET)

Returns a single Backup Type.

URL

https://cleverfoxbackup.com/api/backuptypes/{BackupTypeId}

Required Parameters

• BackupTypeId

Response Codes

• 200 OK
• 404 Not Found

Sample JSON

{
  "data": {
    "BackupTypeId": 1,
    "EngineId": "FILE",
    "Name": "File",
    "EngineType": "File",
    "Port": null,
    "IsInactive": false
  }
}

Create (POST)

Update (PUT)

Delete (DELETE)