Get Vcenter Vm Folder

Get information about the vCenter Server's VM folder object.

Request

URI

GET

https://{api_host}/pairings/{pairing_id}/vcenters/{vcenter_id}/inventory/vm-folder/{vm_folder_id}

COPY

Path Parameters

string

pairing_id

Required

The ID of the pairing between this vSphere Replication server and the remote one.

string

vcenter_id

Required

The ID of the vCenter server

string

vm_folder_id

Required

The ID of a vCenter Server's VM folder object.

Authentication

This operation uses the following authentication methods.

SessionHeader

Responses

200

Information about the vCenter Server's VM folder object.

Returns VcenterServerInventoryItemDrResponseEntity of type(s) application/json

This response body class contains all of the following: InlineVcenterServerInventoryItemDrResponseEntity0 , InlineVcenterServerInventoryItemDrResponseEntity1

{
    "id": "string",
    "name": "string",
    "path": "string",
    "parent": "string",
    "_meta": {
        "errors": [
            {
                "code": "string",
                "message": "string",
                "field": "string"
            }
        ]
    }
}

400

Bad request - the server cannot understand the request due to invalid syntax or invalid request body content

Returns ResponseError of type(s) application/json

"ResponseError Object"

string

error_code

Optional

The code of the error.

string

message

Optional

The message of the error.

string As uuid As uuid

op_id

Optional

The ID of the operation.

401

Unauthorized - the client must authenticate itself to get the requested response

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json

"ResponseError Object"

string

error_code

Optional

The code of the error.

string

message

Optional

The message of the error.

string As uuid As uuid

op_id

Optional

The ID of the operation.

404

Not Found - server cannot find the requested in URL resource

Operation doesn't return any data structure

500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json

"ResponseError Object"

string

error_code

Optional

The code of the error.

string

message

Optional

The message of the error.

string As uuid As uuid

op_id

Optional

The ID of the operation.

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/pairings/{pairing_id}/vcenters/{vcenter_id}/inventory/vm-folder/{vm_folder_id}

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Vcenters Operations

GET

Get Vcenter Compute Inventory

GET