The API allows you to list, view, create and edit recovery plan policies.
Returns list of recovery plan policies.
name | type | description |
---|---|---|
direction | query | |
filter | query | |
nameLike | query | |
orderBy | query | |
page | query | |
size | query |
media type | data type | description |
---|---|---|
application/json | array of RecoveryPlanPolicyListRecord (JSON) | list of recovery plan policies |
GET /policies/recovery-plan
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"ruleCount" : 12345,
"rules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"rulesVmCount" : {
"property1" : 12345,
"property2" : 12345
},
"name" : "...",
"active" : true,
"backupRetryCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"priority" : 50
} ]
Create recovery plan policy.
media type | data type | description |
---|---|---|
application/json | RecoveryPlanPolicyRequest (JSON) | specify details for new recovery plan policy |
media type | data type | description |
---|---|---|
application/json | RecoveryPlanPolicyDetails (JSON) | details of newly created recovery plan policy |
POST /policies/recovery-plan
Content-Type: application/json
Accept: application/json
{
"rules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"name" : "...",
"backupRetryCount" : 12345,
"priority" : 50,
"active" : true
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"rules" : [ {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
}, {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "...",
"name" : "..."
},
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
} ],
"name" : "...",
"active" : true,
"vms" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"backupRetryCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"priority" : 50
}
Returns detailed list of recovery plan policies.
media type | data type | description |
---|---|---|
application/json | array of RecoveryPlanPolicyDetails (JSON) | detailed list of recovery plan policies |
GET /policies/recovery-plan/detailed
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"rules" : [ {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
}, {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "...",
"name" : "..."
},
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
} ],
"name" : "...",
"active" : true,
"vms" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"backupRetryCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"priority" : 50
} ]
Remove recovery plan policy.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for recovery plan policy (use by vProtect) |
DELETE /policies/recovery-plan/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single recovery plan policy.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for recovery plan policy (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | RecoveryPlanPolicyDetails (JSON) | a single recovery plan policy details |
GET /policies/recovery-plan/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"rules" : [ {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
}, {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "...",
"name" : "..."
},
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
} ],
"name" : "...",
"active" : true,
"vms" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"backupRetryCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"priority" : 50
}
Change recovery plan policy details.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for recovery plan policy (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | RecoveryPlanPolicyRequest (JSON) | specify recovery plan policy details to update |
media type | data type | description |
---|---|---|
application/json | RecoveryPlanPolicyDetails (JSON) | updated details of recovery plan policy |
PUT /policies/recovery-plan/{guid}
Content-Type: application/json
Accept: application/json
{
"rules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"name" : "...",
"backupRetryCount" : 12345,
"priority" : 50,
"active" : true
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"rules" : [ {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
}, {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "...",
"name" : "..."
},
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
} ],
"name" : "...",
"active" : true,
"vms" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"backupRetryCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"priority" : 50
}
name | type | description |
---|---|---|
guid | path |
media type | data type |
---|---|
application/json | CloneDTO (JSON) |
media type | data type | description |
---|---|---|
application/json | RecoveryPlanPolicyDetails (JSON) |
POST /policies/recovery-plan/{guid}/clone
Content-Type: application/json
Accept: application/json
{
"name" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"rules" : [ {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
}, {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "...",
"name" : "..."
},
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
} ],
"name" : "...",
"active" : true,
"vms" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"backupRetryCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"priority" : 50
}