get_capabilities

(GET)/capabilities

Description

Get the platform capability information for one or more systems.

Request

Syntax

GET /api/capabilities/?sid={sid}
GET /api/capabilities/{capability}/?sid={sid}
Host: <server host name>
Accept: application/json
AuthToken: <authentication token returned from authenticate>

Parameters

Response

200 success

Parameters

Parameters returned or a string key for each capability and its value.

Index	Value	Type	Returned
{platform name model}	true indicating platform model	boolean	if present

• | "Recovery-714S" (example appliance) |
• | "UEB" (UEB) |
• | "UEB CE" (UEB Community Edition) virtual_machine | this platform is a virtual machine | boolean | if present open_license | this platform supports the open licensing | boolean | if present archiving | this platform supports archiving | boolean | if present deduplication | this platform supports deduplication | boolean | if present vmware_ir | this platform supports VMware Instant Recovery | boolean | always hyperv_ir | this platform supports Hyper-V Instant Recovery | boolean | always replication | this platform supports replication | boolean | always failover_virtualization | failover virtualization modes supported | array of string targets | always, may be empty
• | targets may be "Unitrends appliance", VMware" and "Hyper-V" |
• | if empty, failover_virtualization is not supported | backup_strategies | backup strategies supported | array of string strategies | always
• | "incremental forever", "full with incrementals", "all" (no restrictions) backup_min_recurrence | minimum recurrence of backups in minutes | int | always
• | if 0, no limits | max_backup | maximum protected capacity, in GB | int | always
• | returned by hardware appliances if set, if virtual appliances, returns 0 if not set

Other capability tokens may be returned, depending on platform.

Examples

Sample Request

GET /api/capabilities
Host: <server host name>
Accept: application/json
AuthToken: 8a00sjerhterqerjlqkjlk443l4j56869h4f_)(fjdkasHHHHHkdal324

Sample Response

{
    "data": [
        {
              "system_name": "myUEB",
              "system_id": 1,
              "capabilities": {
                          "UEB CE": true,
                          "virtual_machine": true,
                          "backup_strategies": [
                                   "incremental forever"
                           ],
                          "backup_min_recurrence": 1440,
                          "max_backup": 0
              }
        },
        {
              "system_name": "your-rs",
              "system_id": 2,
              "capabilities": {
                          "Recovery-312": true,
                          "replication": true,
                          "deduplication": true,
                          "backup_strategies": [
                                   "all"
                           ],
                          "backup_min_recurrence": 0,
                          "max_backup": 1000
              }
        }
    ]
}