RuntimeDetails

The /RuntimeDetails resource collection represents runtime details of plan testing or execution. The collection includes details for various Orchestrator entities: a plan, group or step. Each Orchestrator entity has a specific system ID.

NOTE
When working with the /RuntimeDetails resource collection, keep in mind that:

Reboot of the Orchestrator server resets the /RuntimeDetails resource collection.
A range of data available to a client in the Orchestrator REST API depends on permissions of the account under which the client is currently logged in.

Get Details for Plan

The HTTP GET request to the /RuntimeDetails/Plans/{planId} endpoint retrieves runtime details for a plan with the specified ID.

SecurityuserAuth or clientAuth

Request

path Parameters

planId

required

string <uuid>

System ID assigned to a plan.

Responses

200

401

Unauthorized request. The authorization header has been expected but not found (or found but expired).

500

Internal server error.

get/api/v7.21/RuntimeDetails/Plans/{planId}

Request samples

curl
Python
JavaScript
C#
Go

Response samples

{"state": "RestoreComplete",
"stateName": "Restored",
"stateOrder": "300. Restored",
"resultName": "Complete, no errors, 1 warning",
"isEditingByCurrentUser": false,
"currentEditingUser": "",
"lastStableState": "RestoreComplete",
"lastStableStateName": "Restore",
"totalProgress": 100,
"isRunningState": false,
"isStableState": true,
"currentRunResult": "Warning",
"currentTestResult": "Undefined",
"currentCheckResult": "Undefined",
"planType": "Restore",
"recoveryLocationId": "66b41f69-36ae-4a3e-9f17-54ea4635c975",
"siteScopeId": "7514bfcc-dd93-418c-8ae3-8f43cc9bc9f7",
"siteScopeName": "Admin Scope",
"recoveryToNewLocation": false,
"roles": ["DRSiteAdmin",
"DRPlanAuthor",
"DRPlanOperator"
],
"isUndoPossible": false,
"isReversePossible": false,
"vendor": "Unknown",
"id": "35818d71-45c7-4094-858b-efcce1d73e2c",
"name": "vm1",
"progress": 100,
"executionState": "Completed",
"executionResult": {"result": "Warning",
"details": [{"friendlyInfo": "VM is powered off",
"level": "Normal",
"severity": "Error",
"timestamp": "2020-01-10T11:56:01Z"
}
],
"startTime": "2020-01-10T11:56:00Z",
"finishTime": "2020-01-10T11:56:10Z"
}
}

Get Details for Groups in Plan

The HTTP GET request to the /RuntimeDetails/Plans/{planId}/Groups endpoint retrieves runtime details for every group included in a plan with the specified ID.

SecurityuserAuth or clientAuth

Request

path Parameters

planId

required

string <uuid>

System ID assigned to a plan.

query Parameters

start	integer <int32> Excludes the first N items of a resource collection from the response.
limit	integer <int32> Specifies the maximum number of items of a resource collection to return in a response.
	Array of objects (Expression) Returns only specific items of a resource collection in the response. To learn how to use the `filter` parameter, see the Veeam Recovery Orchestrator REST API Reference, section Filter Parameter.
	Array of objects (SortQuery) Specifies the order of items of a resource collection in the response. To learn how to use the `sort` parameter, see the Veeam Recovery Orchestrator REST API Reference, section Sort Parameter.

Responses

200

401

Unauthorized request. The authorization header has been expected but not found (or found but expired).

500

Internal server error.

get/api/v7.21/RuntimeDetails/Plans/{planId}/Groups

Request samples

curl
Python
JavaScript
C#
Go

Response samples

{"total": 1,
"data": [{"groupType": "VmGroup",
"successCount": 5,
"warningCount": 1,
"errorCount": 0,
"totalCount": 6,
"isProtected": false,
"isParallel": false,
"parallelProcessingVmsCount": 1,
"vmsCriticality": "AllNotCritical",
"vcenter": "vc1",
"datacenter": "dc1",
"virtualGroupType": "Normal",
"groupCategory": "Tag",
"executionType": "Replica",
"id": "04c0ffa2-b2aa-435d-8eaa-c79d14af16f6",
"name": "vm1",
"progress": 100,
"executionState": "Completed",
"executionResult": {"result": "Warning",
"details": [{"friendlyInfo": "VM is powered off",
"level": "Normal",
"severity": "Error",
"timestamp": "2020-01-27T04:58:01Z"
}
],
"startTime": "2020-01-27T04:58:00Z",
"finishTime": "2020-01-27T04:58:10Z"
}
}
]
}

Get Details for Inventory Group in Plan

The HTTP GET request to the /RuntimeDetails/Plans/{planId}/Groups/{groupId} endpoint retrieves runtime details for every VM included in an inventory group with the specified ID in a specific plan.

SecurityuserAuth or clientAuth

Request

path Parameters

planId required	string <uuid> System ID assigned to a plan.
groupId required	string <uuid> System ID assigned to an inventory group.

query Parameters

start	integer <int32> Excludes the first N items of a resource collection from the response.
limit	integer <int32> Specifies the maximum number of items of a resource collection to return in a response.
	Array of objects (Expression) Returns only specific items of a resource collection in the response. To learn how to use the `filter` parameter, see the Veeam Recovery Orchestrator REST API Reference, section Filter Parameter.
	Array of objects (SortQuery) Specifies the order of items of a resource collection in the response. To learn how to use the `sort` parameter, see the Veeam Recovery Orchestrator REST API Reference, section Sort Parameter.

Responses

200

401

Unauthorized request. The authorization header has been expected but not found (or found but expired).

500

Internal server error.

get/api/v7.21/RuntimeDetails/Plans/{planId}/Groups/{groupId}

Request samples

curl
Python
JavaScript
C#
Go

Response samples

{"total": 1,
"data": [{"voId": 500,
"isCritical": true,
"successCount": 5,
"warningCount": 1,
"errorCount": 0,
"totalCount": 6,
"number": 1,
"isWebConsoleAvailable": true,
"sourceMissing": false,
"id": "e331e72a-d006-434b-ac0a-a5d3ba6d831d",
"name": "vm1",
"progress": 100,
"executionState": "Completed",
"executionResult": {"result": "Warning",
"details": [{"friendlyInfo": "DataLab stopped with Warning",
"level": "Normal",
"severity": "Warning",
"timestamp": "2020-01-26T10:12:05Z"
}
],
"startTime": "2020-01-26T10:12:00Z",
"finishTime": "2020-01-26T10:12:10Z"
}
}
]
}

Get Details for Steps Added to Virtual Group in Plan

The HTTP GET request to the /RuntimeDetails/Plans/{planId}/Groups/{groupId}/Steps endpoint retrieves runtime details for every step added to a virtual group with the specified ID in a specific plan.

SecurityuserAuth or clientAuth

Request

path Parameters

planId required	string <uuid> System ID assigned to a plan.
groupId required	string <uuid> System ID assigned to an inventory group.

query Parameters

start	integer <int32> Excludes the first N items of a resource collection from the response.
limit	integer <int32> Specifies the maximum number of items of a resource collection to return in a response.
	Array of objects (Expression) Returns only specific items of a resource collection in the response. To learn how to use the `filter` parameter, see the Veeam Recovery Orchestrator REST API Reference, section Filter Parameter.
	Array of objects (SortQuery) Specifies the order of items of a resource collection in the response. To learn how to use the `sort` parameter, see the Veeam Recovery Orchestrator REST API Reference, section Sort Parameter.

Responses

200

401

Unauthorized request. The authorization header has been expected but not found (or found but expired).

500

Internal server error.

get/api/v7.21/RuntimeDetails/Plans/{planId}/Groups/{groupId}/Steps

Request samples

curl
Python
JavaScript
C#
Go

Response samples

{"total": 1,
"data": [{"actionType": "CheckVmLicense",
"hidden": false,
"stepDefinitionUid": "838bd461-d101-4314-b32f-2e9079d7e24b",
"id": "6eecdb22-6901-41c6-be98-577f4f01b6b4",
"name": "Check license and availability",
"progress": 100,
"executionState": "Completed",
"executionResult": {"result": "Success",
"details": [{"friendlyInfo": "[VM license status] The VM is licensed",
"level": "Critical",
"severity": "Success",
"timestamp": "2020-01-28T16:35:01Z"
}
],
"startTime": "2020-01-28T16:35:00Z",
"finishTime": "2020-01-28T16:35:02Z"
}
}
]
}

Get Details for Steps Added for VM in Plan

The HTTP GET request to the /RuntimeDetails/Plans/{planId}/Vms/{vmId}/Steps endpoint retrieves runtime details for every step added for a VM with the specified ID included in a specific plan.

SecurityuserAuth or clientAuth

Request

path Parameters

planId required	string <uuid> System ID assigned to a plan.
vmId required	string <uuid> System ID assigned to a VM.

query Parameters

start	integer <int32> Excludes the first N items of a resource collection from the response.
limit	integer <int32> Specifies the maximum number of items of a resource collection to return in a response.
	Array of objects (Expression) Returns only specific items of a resource collection in the response. To learn how to use the `filter` parameter, see the Veeam Recovery Orchestrator REST API Reference, section Filter Parameter.
	Array of objects (SortQuery) Specifies the order of items of a resource collection in the response. To learn how to use the `sort` parameter, see the Veeam Recovery Orchestrator REST API Reference, section Sort Parameter.

Responses

200

401

Unauthorized request. The authorization header has been expected but not found (or found but expired).

500

Internal server error.

get/api/v7.21/RuntimeDetails/Plans/{planId}/Vms/{vmId}/Steps

Request samples

curl
Python
JavaScript
C#
Go

Response samples

{"total": 1,
"data": [{"actionType": "CheckVmLicense",
"hidden": false,
"stepDefinitionUid": "838bd461-d101-4314-b32f-2e9079d7e24b",
"id": "6eecdb22-6901-41c6-be98-577f4f01b6b4",
"name": "Check license and availability",
"progress": 100,
"executionState": "Completed",
"executionResult": {"result": "Success",
"details": [{"friendlyInfo": "[VM license status] The VM is licensed",
"level": "Critical",
"severity": "Success",
"timestamp": "2020-01-28T16:35:01Z"
}
],
"startTime": "2020-01-28T16:35:00Z",
"finishTime": "2020-01-28T16:35:02Z"
}
}
]
}

Get Details for Step in Plan

The HTTP GET request to the /RuntimeDetails/Plans/{planId}/Steps/{stepId} endpoint retrieves runtime details for a step with the specified ID included in a specific plan.

SecurityuserAuth or clientAuth

Request

path Parameters

planId required	string <uuid> System ID assigned to a plan.
stepId required	string <uuid> System ID assigned to a step.

query Parameters

start	integer <int32> Excludes the first N items of a resource collection from the response.
limit	integer <int32> Specifies the maximum number of items of a resource collection to return in a response.
	Array of objects (Expression) Returns only specific items of a resource collection in the response. To learn how to use the `filter` parameter, see the Veeam Recovery Orchestrator REST API Reference, section Filter Parameter.
	Array of objects (SortQuery) Specifies the order of items of a resource collection in the response. To learn how to use the `sort` parameter, see the Veeam Recovery Orchestrator REST API Reference, section Sort Parameter.

Responses

200

401

Unauthorized request. The authorization header has been expected but not found (or found but expired).

500

Internal server error.

get/api/v7.21/RuntimeDetails/Plans/{planId}/Steps/{stepId}

Request samples

curl
Python
JavaScript
C#
Go

Response samples

{"total": 1,
"data": [{"friendlyInfo": "[Step Sequence] Step is in correct sequence",
"level": "Normal",
"severity": "Success",
"timestamp": "2020-01-20T00:06:00Z"
}
]
}