The API allows you to list, view, create and edit snapshot management policies for storages.
Returns list of snapshot management 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 StorageSnapshotMgmtPolicyListRecord (JSON) | list of snapshot management policies |
GET /policies/storage-snapshot
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"ruleCount" : 12345,
"storageCount" : 12345,
"rules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"name" : "...",
"autoAssignMode" : "ASSIGN_AND_REMOVE",
"active" : true,
"backupRetryCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"priority" : 50
} ]
Create snapshot management policy.
media type | data type | description |
---|---|---|
application/json | StorageSnapshotMgmtPolicyRequest (JSON) | specify details for new snapshot management policy |
media type | data type | description |
---|---|---|
application/json | StorageSnapshotMgmtPolicyDetails (JSON) | details of newly created snapshot management policy |
POST /policies/storage-snapshot
Content-Type: application/json
Accept: application/json
{
"autoRemoveNonPresent" : true,
"rules" : [ {
"retentionVersions" : 12345,
"guid" : "...",
"name" : "...",
"retentionDays" : 12345,
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"position" : 12345
}, {
"retentionVersions" : 12345,
"guid" : "...",
"name" : "...",
"retentionDays" : 12345,
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"policy" : {
"guid" : "...",
"name" : "..."
},
"position" : 12345
} ],
"name" : "...",
"storages" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"autoAssignSettings" : {
"mode" : "DISABLED",
"includeRegExps" : [ "...", "..." ],
"excludeRegExps" : [ "...", "..." ],
"storagePools" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
},
"backupRetryCount" : 12345,
"priority" : 50,
"executeAutoAssignmentAfterSavingPolicy" : true,
"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
} ],
"autoRemoveNonPresent" : true,
"name" : "...",
"active" : true,
"backupRetryCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"storages" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"autoAssignSettings" : {
"mode" : "DISABLED",
"includeRegExps" : [ "...", "..." ],
"excludeRegExps" : [ "...", "..." ],
"storagePools" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
},
"priority" : 50
}
Get auto-assignment preview for all storages and given snapshot management policy.
media type | data type | description |
---|---|---|
application/json | StorageSnapshotMgmtPolicyRequest (JSON) | specify storage snapshot management policy details to create preview |
media type | data type | description |
---|---|---|
application/json | array of AutoAssignResultPreviewListRecord (JSON) | list of auto-assignment result preview records |
POST /policies/storage-snapshot/auto-assignment-preview
Content-Type: application/json
Accept: application/json
{
"autoRemoveNonPresent" : true,
"rules" : [ {
"retentionVersions" : 12345,
"guid" : "...",
"name" : "...",
"retentionDays" : 12345,
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"position" : 12345
}, {
"retentionVersions" : 12345,
"guid" : "...",
"name" : "...",
"retentionDays" : 12345,
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"policy" : {
"guid" : "...",
"name" : "..."
},
"position" : 12345
} ],
"name" : "...",
"storages" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"autoAssignSettings" : {
"mode" : "DISABLED",
"includeRegExps" : [ "...", "..." ],
"excludeRegExps" : [ "...", "..." ],
"storagePools" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
},
"backupRetryCount" : 12345,
"priority" : 50,
"executeAutoAssignmentAfterSavingPolicy" : true,
"active" : true
}
HTTP/1.1 201 Created
Content-Type: application/json
[ {
"protectedEntity" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"changeType" : "REMOVAL",
"changeReason" : "PE_IS_NOT_PRESENT"
} ]
Returns detailed list of snapshot management policies.
media type | data type | description |
---|---|---|
application/json | array of StorageSnapshotMgmtPolicyDetails (JSON) | detailed list of snapshot management policies |
GET /policies/storage-snapshot/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
} ],
"autoRemoveNonPresent" : true,
"name" : "...",
"active" : true,
"backupRetryCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"storages" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"autoAssignSettings" : {
"mode" : "ASSIGN_ONLY",
"includeRegExps" : [ "...", "..." ],
"excludeRegExps" : [ "...", "..." ],
"storagePools" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
},
"priority" : 50
} ]
Remove snapshot management policy.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for snapshot management policy (use by vProtect) |
DELETE /policies/storage-snapshot/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single snapshot management policy.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for snapshot management policy (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | StorageSnapshotMgmtPolicyDetails (JSON) | a single snapshot management policy details |
GET /policies/storage-snapshot/{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
} ],
"autoRemoveNonPresent" : true,
"name" : "...",
"active" : true,
"backupRetryCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"storages" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"autoAssignSettings" : {
"mode" : "DISABLED",
"includeRegExps" : [ "...", "..." ],
"excludeRegExps" : [ "...", "..." ],
"storagePools" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
},
"priority" : 50
}
Change snapshot management policy details.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for snapshot management policy (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | StorageSnapshotMgmtPolicyRequest (JSON) | specify snapshot management policy details to update |
media type | data type | description |
---|---|---|
application/json | StorageSnapshotMgmtPolicyDetails (JSON) | updated details of snapshot management policy |
PUT /policies/storage-snapshot/{guid}
Content-Type: application/json
Accept: application/json
{
"autoRemoveNonPresent" : true,
"rules" : [ {
"retentionVersions" : 12345,
"guid" : "...",
"name" : "...",
"retentionDays" : 12345,
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"position" : 12345
}, {
"retentionVersions" : 12345,
"guid" : "...",
"name" : "...",
"retentionDays" : 12345,
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"policy" : {
"guid" : "...",
"name" : "..."
},
"position" : 12345
} ],
"name" : "...",
"storages" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"autoAssignSettings" : {
"mode" : "ASSIGN_ONLY",
"includeRegExps" : [ "...", "..." ],
"excludeRegExps" : [ "...", "..." ],
"storagePools" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
},
"backupRetryCount" : 12345,
"priority" : 50,
"executeAutoAssignmentAfterSavingPolicy" : true,
"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
} ],
"autoRemoveNonPresent" : true,
"name" : "...",
"active" : true,
"backupRetryCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"storages" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"autoAssignSettings" : {
"mode" : "DISABLED",
"includeRegExps" : [ "...", "..." ],
"excludeRegExps" : [ "...", "..." ],
"storagePools" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
},
"priority" : 50
}
Get auto-assignment preview for all storages and given snapshot management policy.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for snapshot management policy (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | StorageSnapshotMgmtPolicyRequest (JSON) | specify storage snapshot management policy details to create preview |
media type | data type | description |
---|---|---|
application/json | array of AutoAssignResultPreviewListRecord (JSON) | list of auto-assignment result preview records |
POST /policies/storage-snapshot/{guid}/auto-assignment-preview
Content-Type: application/json
Accept: application/json
{
"autoRemoveNonPresent" : true,
"rules" : [ {
"retentionVersions" : 12345,
"guid" : "...",
"name" : "...",
"retentionDays" : 12345,
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"position" : 12345
}, {
"retentionVersions" : 12345,
"guid" : "...",
"name" : "...",
"retentionDays" : 12345,
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"policy" : {
"guid" : "...",
"name" : "..."
},
"position" : 12345
} ],
"name" : "...",
"storages" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"autoAssignSettings" : {
"mode" : "ASSIGN_AND_REMOVE",
"includeRegExps" : [ "...", "..." ],
"excludeRegExps" : [ "...", "..." ],
"storagePools" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
},
"backupRetryCount" : 12345,
"priority" : 50,
"executeAutoAssignmentAfterSavingPolicy" : true,
"active" : true
}
HTTP/1.1 201 Created
Content-Type: application/json
[ {
"protectedEntity" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"changeType" : "REMOVAL",
"changeReason" : "PE_IS_NOT_PRESENT"
} ]
name | type | description |
---|---|---|
guid | path |
media type | data type |
---|---|
application/json | CloneDTO (JSON) |
media type | data type | description |
---|---|---|
application/json | StorageSnapshotMgmtPolicyDetails (JSON) |
POST /policies/storage-snapshot/{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
} ],
"autoRemoveNonPresent" : true,
"name" : "...",
"active" : true,
"backupRetryCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"storages" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"autoAssignSettings" : {
"mode" : "DISABLED",
"includeRegExps" : [ "...", "..." ],
"excludeRegExps" : [ "...", "..." ],
"storagePools" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
},
"priority" : 50
}