The API allows you to list, view, create and edit os agent.
Returns list of OS Agent list records filtered by specified query parameters.
name | type | description | constraints |
---|---|---|---|
backupStatus | query | "IS_PROTECTED" or "NOT_PROTECTED" or "NO_SCHEDULE" | |
direction | query | ||
filter | query | ||
nameLike | query | ||
orderBy | query | ||
osType | query | "LINUX" or "MAC" or "WINDOWS" | |
page | query | ||
policy | query | ||
size | query |
media type | data type | description |
---|---|---|
application/json | array of OSAgentListRecord (JSON) | list of os-agents list records filtered by specified query parameters |
GET /os-agents
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"name" : "...",
"type" : "APP",
"backupUpToDate" : true,
"restorable" : true,
"description" : "...",
"lastSuccessfulBackupSize" : 12345,
"lastLoginDate" : 12345,
"status" : "DECOMMISSIONED",
"lastSuccessfulFullBackupSize" : 12345,
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"warningsPresent" : true,
"possibleActions" : [ "HVM_READ", "HVM_READ" ],
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"osType" : "MAC",
"averageProgress" : 12345.0,
"lastChainMarkedForDeletion" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"lastBackup" : 1451649601000
} ]
Assign os-agent to specified policy (or unassign if policy is null)
media type | data type | description |
---|---|---|
application/json | ProtectedEntityBackupPolicyAssignmentRequest (JSON) | containing policy and os-agent info |
POST /os-agents/assign-backup-policy
Content-Type: application/json
{
"backupPolicy" : "...",
"protectedEntities" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}
HTTP/1.1 201 Created
name | type | description | constraints |
---|---|---|---|
backupStatus | query | "IS_PROTECTED" or "NOT_PROTECTED" or "NO_SCHEDULE" | |
direction | query | ||
filter | query | ||
nameLike | query | ||
orderBy | query | ||
osType | query | "LINUX" or "MAC" or "WINDOWS" | |
page | query | ||
policy | query | ||
size | query |
media type | data type | description |
---|---|---|
application/json | array of RbacContextListRecord (JSON) |
GET /os-agents/rbac-contexts
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"nameAndGuid" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"uuid" : "...",
"type" : "STORAGE_POOL",
"checked" : true,
"lastLevel" : true,
"present" : true,
"entityType" : "...",
"childrenQueryType" : "..."
} ]
Remove OS Agent.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for OS Agent (use by vProtect) |
DELETE /os-agents/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single OS Agent.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for service provider (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | OSAgentDetails (JSON) | service provider details |
GET /os-agents/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"sshHost" : "...",
"sshPort" : 12345,
"credential" : {
"guid" : "...",
"name" : "...",
"user" : "...",
"secretKey" : "...",
"sshKey" : "...",
"sshKeyPath" : "...",
"powerShellTransportType" : "PLAINTEXT"
},
"sshKeyPath" : "...",
"backupCount" : 12345,
"rules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"name" : "...",
"type" : "CLOUD_USER",
"backupUpToDate" : true,
"restorable" : true,
"lastSuccessfulBackupSize" : 12345,
"lastSuccessfulFullBackupSize" : 12345,
"description" : "...",
"lastLoginDate" : 12345,
"warningsPresent" : true,
"status" : "DECOMMISSIONED",
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"possibleActions" : [ "READ", "HV_READ" ],
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"averageProgress" : 12345.0,
"policy" : {
"rules" : [ {
"guid" : "...",
"name" : "...",
"policy" : { },
"schedules" : [ { }, { } ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
}, {
"guid" : "...",
"name" : "...",
"policy" : { },
"schedules" : [ { }, { } ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
} ],
"name" : "...",
"autoAssignSettings" : {
"mode" : "DISABLED",
"includeRegExps" : [ "...", "..." ],
"osAgents" : [ { }, { } ]
},
"active" : true,
"autoRemoveNonPresent" : true,
"backupRetryCount" : 12345,
"averageBackupSize" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"priority" : 50,
"dailyReportEnabled" : true,
"mailingList" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
},
"lastChainMarkedForDeletion" : true,
"enabledScheduledBackups" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"osType" : "WINDOWS",
"lastBackup" : 1451649601000
}
Change OS Agent details.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for OS Agent (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | OSAgentRequest (JSON) | specify OS Agent details to update |
media type | data type | description |
---|---|---|
application/json | OSAgentDetails (JSON) | updated details of provider |
PUT /os-agents/{guid}
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"description" : "...",
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"enabledScheduledBackups" : true
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"sshHost" : "...",
"sshPort" : 12345,
"credential" : {
"guid" : "...",
"name" : "...",
"user" : "...",
"secretKey" : "...",
"sshKey" : "...",
"sshKeyPath" : "...",
"powerShellTransportType" : "SSL"
},
"sshKeyPath" : "...",
"backupCount" : 12345,
"rules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"name" : "...",
"type" : "CLOUD",
"backupUpToDate" : true,
"restorable" : true,
"lastSuccessfulBackupSize" : 12345,
"lastSuccessfulFullBackupSize" : 12345,
"description" : "...",
"lastLoginDate" : 12345,
"warningsPresent" : true,
"status" : "DISCONNECTED",
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"possibleActions" : [ "INVENTORY_SYNC", "HVM_READ" ],
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"averageProgress" : 12345.0,
"policy" : {
"rules" : [ {
"guid" : "...",
"name" : "...",
"policy" : { },
"schedules" : [ { }, { } ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
}, {
"guid" : "...",
"name" : "...",
"policy" : { },
"schedules" : [ { }, { } ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
} ],
"name" : "...",
"autoAssignSettings" : {
"mode" : "ASSIGN_ONLY",
"includeRegExps" : [ "...", "..." ],
"osAgents" : [ { }, { } ]
},
"active" : true,
"autoRemoveNonPresent" : true,
"backupRetryCount" : 12345,
"averageBackupSize" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"priority" : 50,
"dailyReportEnabled" : true,
"mailingList" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
},
"lastChainMarkedForDeletion" : true,
"enabledScheduledBackups" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"osType" : "MAC",
"lastBackup" : 1451649601000
}
Archive OS Agent.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for OS Agent (use by vProtect) |
POST /os-agents/{guid}/decommission
Content-Type: */*
...
HTTP/1.1 201 Created
Returns list of OSAgent backups.
name | type | description |
---|---|---|
guid | path |
media type | data type | description |
---|---|---|
application/json | array of number (JSON) | list of OSAgent backups |
GET /os-agents/{guid}/list-backups
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
...