The API allows you to list, view, create and edit application command executions.
Returns list of application command executions.
name | type | description |
---|---|---|
direction | query | |
filter | query | |
nameLike | query | |
orderBy | query | |
page | query | |
size | query |
media type | data type | description |
---|---|---|
application/json | array of AppCmdExecConfigListRecord (JSON) | list of application command executions |
GET /applications/configs
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"name" : "...",
"cmdArg" : [ "...", "..." ],
"cmdExecMethod" : "NODE",
"exportData" : true,
"removeFilesAfterExport" : true,
"sourceType" : "STREAM",
"sourcePath" : "...",
"appCmdExecConfigParams" : [ {
"name" : "...",
"showInUi" : true,
"obligatory" : true,
"defaultValue" : "...",
"userFriendlyHint" : "...",
"envVariables" : [ {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}, {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "..."
} ],
"appCmdExecConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}, {
"name" : "...",
"showInUi" : true,
"obligatory" : true,
"defaultValue" : "...",
"userFriendlyHint" : "...",
"envVariables" : [ {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "..."
}, {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "..."
} ],
"appCmdExecConfig" : {
"guid" : "...",
"name" : "..."
},
"guid" : "..."
} ],
"userModifiable" : true,
"useNetcat" : true,
"possibleActions" : [ "READ", "WRITE" ],
"instanceCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
} ]
Create a application command execution.
media type | data type | description |
---|---|---|
application/json | AppCmdExecConfigRequest (JSON) | specify details for new application command execution |
media type | data type | description |
---|---|---|
application/json | AppCmdExecConfigDetails (JSON) | details of newly created application command execution |
POST /applications/configs
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"cmdArg" : [ "...", "..." ],
"applications" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"cmdExecMethod" : "NODE",
"exportData" : true,
"removeFilesAfterExport" : true,
"sourceType" : "STREAM",
"appCmdExecConfigParams" : [ {
"guid" : "...",
"name" : "...",
"showInUi" : true,
"obligatory" : true,
"defaultValue" : "...",
"userFriendlyHint" : "..."
}, {
"guid" : "...",
"name" : "...",
"showInUi" : true,
"obligatory" : true,
"defaultValue" : "...",
"userFriendlyHint" : "..."
} ],
"ignoredExitCodes" : "...",
"stdErrorHandling" : "DONT_IGNORE",
"sourcePath" : "...",
"timeout" : 12345,
"useNetcat" : true
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"applications" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"name" : "...",
"cmdArg" : [ "...", "..." ],
"timeout" : 12345,
"ignoredExitCodes" : "...",
"cmdExecMethod" : "REMOTE_POWERSHELL",
"stdErrorHandling" : "DONT_IGNORE",
"exportData" : true,
"buildInType" : "DB2_BACKUP",
"removeFilesAfterExport" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"sourceType" : "STREAM",
"sourcePath" : "...",
"appCmdExecConfigParams" : [ {
"name" : "...",
"showInUi" : true,
"obligatory" : true,
"defaultValue" : "...",
"userFriendlyHint" : "...",
"envVariables" : [ {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}, {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "..."
} ],
"appCmdExecConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}, {
"name" : "...",
"showInUi" : true,
"obligatory" : true,
"defaultValue" : "...",
"userFriendlyHint" : "...",
"envVariables" : [ {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "..."
}, {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "..."
} ],
"appCmdExecConfig" : {
"guid" : "...",
"name" : "..."
},
"guid" : "..."
} ],
"userModifiable" : true,
"useNetcat" : true,
"possibleActions" : [ "WRITE", "READ" ],
"instanceCount" : 12345
}
Returns detailed list of application command executions.
media type | data type | description |
---|---|---|
application/json | array of AppCmdExecConfigDetails (JSON) | detailed list of application command executions |
GET /applications/configs/detailed
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"applications" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"name" : "...",
"cmdArg" : [ "...", "..." ],
"timeout" : 12345,
"ignoredExitCodes" : "...",
"cmdExecMethod" : "NODE",
"stdErrorHandling" : "IGNORE_WITH_WARNING",
"exportData" : true,
"buildInType" : "MSSQL_DB_BACKUP",
"removeFilesAfterExport" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"sourceType" : "STREAM",
"sourcePath" : "...",
"appCmdExecConfigParams" : [ {
"name" : "...",
"showInUi" : true,
"obligatory" : true,
"defaultValue" : "...",
"userFriendlyHint" : "...",
"envVariables" : [ {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}, {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "..."
} ],
"appCmdExecConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}, {
"name" : "...",
"showInUi" : true,
"obligatory" : true,
"defaultValue" : "...",
"userFriendlyHint" : "...",
"envVariables" : [ {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "..."
}, {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "..."
} ],
"appCmdExecConfig" : {
"guid" : "...",
"name" : "..."
},
"guid" : "..."
} ],
"userModifiable" : true,
"useNetcat" : true,
"possibleActions" : [ "HV_READ", "INVENTORY_SYNC" ],
"instanceCount" : 12345
} ]
media type | data type | description |
---|---|---|
application/json | array of NameAndGuid (JSON) |
GET /applications/configs/preview
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
} ]
Returns list of application command executions.
media type | data type | description |
---|---|---|
application/json | array of RbacContextListRecord (JSON) | list of application command executions |
GET /applications/configs/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" : "DATA_CENTER",
"checked" : true,
"lastLevel" : true,
"present" : true,
"entityType" : "...",
"childrenQueryType" : "..."
} ]
Remove application command execution.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for application command execution (use by vProtect) |
DELETE /applications/configs/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single application command execution.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for application command execution (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | AppCmdExecConfigDetails (JSON) | a single application command execution details |
GET /applications/configs/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"applications" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"name" : "...",
"cmdArg" : [ "...", "..." ],
"timeout" : 12345,
"ignoredExitCodes" : "...",
"cmdExecMethod" : "NODE",
"stdErrorHandling" : "IGNORE_WITHOUT_WARNING",
"exportData" : true,
"buildInType" : "OVIRT_RHV_DB_BACKUP",
"removeFilesAfterExport" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"sourceType" : "FILE",
"sourcePath" : "...",
"appCmdExecConfigParams" : [ {
"name" : "...",
"showInUi" : true,
"obligatory" : true,
"defaultValue" : "...",
"userFriendlyHint" : "...",
"envVariables" : [ {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}, {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "..."
} ],
"appCmdExecConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}, {
"name" : "...",
"showInUi" : true,
"obligatory" : true,
"defaultValue" : "...",
"userFriendlyHint" : "...",
"envVariables" : [ {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "..."
}, {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "..."
} ],
"appCmdExecConfig" : {
"guid" : "...",
"name" : "..."
},
"guid" : "..."
} ],
"userModifiable" : true,
"useNetcat" : true,
"possibleActions" : [ "READ", "READ" ],
"instanceCount" : 12345
}
Change application command execution details.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for application command execution (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | AppCmdExecConfigRequest (JSON) | specify application command execution details to update |
media type | data type | description |
---|---|---|
application/json | AppCmdExecConfigDetails (JSON) | updated details of application command execution |
PUT /applications/configs/{guid}
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"cmdArg" : [ "...", "..." ],
"applications" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"cmdExecMethod" : "NODE",
"exportData" : true,
"removeFilesAfterExport" : true,
"sourceType" : "STREAM",
"appCmdExecConfigParams" : [ {
"guid" : "...",
"name" : "...",
"showInUi" : true,
"obligatory" : true,
"defaultValue" : "...",
"userFriendlyHint" : "..."
}, {
"guid" : "...",
"name" : "...",
"showInUi" : true,
"obligatory" : true,
"defaultValue" : "...",
"userFriendlyHint" : "..."
} ],
"ignoredExitCodes" : "...",
"stdErrorHandling" : "DONT_IGNORE",
"sourcePath" : "...",
"timeout" : 12345,
"useNetcat" : true
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"applications" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"name" : "...",
"cmdArg" : [ "...", "..." ],
"timeout" : 12345,
"ignoredExitCodes" : "...",
"cmdExecMethod" : "REMOTE_POWERSHELL",
"stdErrorHandling" : "DONT_IGNORE",
"exportData" : true,
"buildInType" : "INTERNAL_DB_BACKUP",
"removeFilesAfterExport" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"sourceType" : "FILE",
"sourcePath" : "...",
"appCmdExecConfigParams" : [ {
"name" : "...",
"showInUi" : true,
"obligatory" : true,
"defaultValue" : "...",
"userFriendlyHint" : "...",
"envVariables" : [ {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}, {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "..."
} ],
"appCmdExecConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}, {
"name" : "...",
"showInUi" : true,
"obligatory" : true,
"defaultValue" : "...",
"userFriendlyHint" : "...",
"envVariables" : [ {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "..."
}, {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "..."
} ],
"appCmdExecConfig" : {
"guid" : "...",
"name" : "..."
},
"guid" : "..."
} ],
"userModifiable" : true,
"useNetcat" : true,
"possibleActions" : [ "READ", "HV_READ" ],
"instanceCount" : 12345
}
Clone application command execution.
name | type | description |
---|---|---|
guid | path | local unique identifier of application command execution that will be cloned |
media type | data type | description |
---|---|---|
application/json | CloneDTO (JSON) | specify details for new application command execution |
media type | data type | description |
---|---|---|
application/json | AppCmdExecConfigDetails (JSON) | details of newly created application command execution |
POST /applications/configs/{guid}/clone
Content-Type: application/json
Accept: application/json
{
"name" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"applications" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"name" : "...",
"cmdArg" : [ "...", "..." ],
"timeout" : 12345,
"ignoredExitCodes" : "...",
"cmdExecMethod" : "REMOTE_POWERSHELL",
"stdErrorHandling" : "IGNORE_WITHOUT_WARNING",
"exportData" : true,
"buildInType" : "REAR_BACKUP",
"removeFilesAfterExport" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"sourceType" : "FILE",
"sourcePath" : "...",
"appCmdExecConfigParams" : [ {
"name" : "...",
"showInUi" : true,
"obligatory" : true,
"defaultValue" : "...",
"userFriendlyHint" : "...",
"envVariables" : [ {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}, {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "..."
} ],
"appCmdExecConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}, {
"name" : "...",
"showInUi" : true,
"obligatory" : true,
"defaultValue" : "...",
"userFriendlyHint" : "...",
"envVariables" : [ {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "..."
}, {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : { },
"appCmdExecConfigParam" : { },
"guid" : "..."
} ],
"appCmdExecConfig" : {
"guid" : "...",
"name" : "..."
},
"guid" : "..."
} ],
"userModifiable" : true,
"useNetcat" : true,
"possibleActions" : [ "WRITE", "WRITE" ],
"instanceCount" : 12345
}