Components

The /Components resource collection represents all infrastructure components added to Orchestrator.

Get Credentials

The HTTP GET request to the /Components/Credentials endpoint retrieves a list of all credentials added to Orchestrator.

SecurityuserAuth

Request

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) Deprecated Obsolete parameter. Use the actionFilters parameter instead.
	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.
	Array of objects (Expression) Returns only specific items of a resource collection in the response. To learn how to use the `actionFilters` parameter, see the Veeam Recovery Orchestrator REST API Reference, section ActionFilters 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/v13.1/Components/Credentials

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"total": 0,
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"userName": "string",
"description": "string"
}
]
}

Get Collection of Standalone Hyper-V Hosts

The HTTP GET request to the /Components/HyperV/DirectHosts endpoint retrieves a list of all standalone Hyper-V hosts added to the Orchestrator infrastructure.

SecurityuserAuth

Request

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) Deprecated Obsolete parameter. Use the actionFilters parameter instead.
	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.
	Array of objects (Expression) Returns only specific items of a resource collection in the response. To learn how to use the `actionFilters` parameter, see the Veeam Recovery Orchestrator REST API Reference, section ActionFilters 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/v13.1/Components/HyperV/DirectHosts

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"total": 0,
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"address": "string",
"credentialsId": "08e8bcd2-3d30-4d03-8e1a-ab6ac0cbf1ed"
}
]
}

Add Standalone Hyper-V Host

The HTTP POST request to the /Components/HyperV/DirectHosts endpoint adds a new standalone Hyper-V host to the Orchestrator infrastructure.

SecurityuserAuth

Request

Request Body schema: application/json

address required	string or null IP address of the standalone Hyper-V host.
credentialsId required	string <uuid> System ID assigned to the credentials used to authenticate to the standalone Hyper-V host.

Responses

204

No Content

401

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

500

Internal server error.

post/api/v13.1/Components/HyperV/DirectHosts

Request samples

application/json

{"address": "string",
"credentialsId": "08e8bcd2-3d30-4d03-8e1a-ab6ac0cbf1ed"
}

Get Networks of Standalone Hyper-V Host

The HTTP GET request to the /Components/HyperV/DirectHosts/{hvServerId}/Networks endpoint retrieves a list of networks available on a standalone Hyper-V direct host with the specified ID.

SecurityuserAuth

Request

path Parameters

directHostId

required

string <uuid>

System ID assigned to a standalone Hyper-V host.

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) Deprecated Obsolete parameter. Use the actionFilters parameter instead.
	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.
	Array of objects (Expression) Returns only specific items of a resource collection in the response. To learn how to use the `actionFilters` parameter, see the Veeam Recovery Orchestrator REST API Reference, section ActionFilters 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/v13.1/Components/HyperV/DirectHosts/{directHostId}/Networks

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"total": 0,
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
]
}

Remove Standalone Hyper-V Host

The HTTP DELETE request to the /Components/HyperV/DirectHosts/{id} endpoint removes a standalone Hyper-V host with the specified ID from the Orchestrator infrastructure.

SecurityuserAuth

Request

path Parameters

directHostId

required

string <uuid>

System ID assigned to a standalone Hyper-V host.

Responses

204

No Content

401

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

500

Internal server error.

delete/api/v13.1/Components/HyperV/DirectHosts/{directHostId}

Request samples

curl
Python
JavaScript
C#
Go

Get CSV disks by Hyper-V Host

The HTTP GET request to the /Components/HyperV/DirectHosts/{directHostId}/CsvDisks endpoint retrieves a list of CSV disks available on a Microsoft Hyper-V standalone host with the specified ID.

SecurityuserAuth

Request

path Parameters

directHostId

required

string <uuid>

System ID assigned to a Hyper-V standalone host.

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) Deprecated Obsolete parameter. Use the actionFilters parameter instead.
	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.
	Array of objects (Expression) Returns only specific items of a resource collection in the response. To learn how to use the `actionFilters` parameter, see the Veeam Recovery Orchestrator REST API Reference, section ActionFilters 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/v13.1/Components/HyperV/DirectHosts/{directHostId}/CsvDisks

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"total": 0,
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"isRemoved": true
}
]
}