REST API - export

vcenter guest customization specs: export

Returns the content of the customization specification in the specified format. Note that any passwords in the customization specification will be set to blank values during the export operation. This operation was added in vSphere API 7.0.0.0.

Request:

HTTP request

POST https://{server}/rest/vcenter/guest/customization-specs/{name}?action=export

Path Parameters

Name Type Description
Required
name string The name of the customization specification that has to be returned.

Request Body Structure:

{
    "format""JSON"
}

Request Body Parameters:

Name Type Description
bold = required
format string Specifies the formats the customization specification can be exported to. This enumeration was added in vSphere API 7.0.0.0. Value is one of:
JSON: JSON format. This constant was added in vSphere API 7.0.0.0.
XML: XML format. This constant was added in vSphere API 7.0.0.0.The format in which the customization specification has to be returned.

Response:

HTTP Status Code: 200

Representation:

{
    "value""string"
}

Response Type:

Name Type Description
bold = required
value string The string representation of the customization specification in the specified format.

Errors:

HTTP Status Code Type Description
400 invalid_argument If value of format is not valid.
404 not_found if the customization specification is not found.
503 service_unavailable if the system is unable to communicate with a service to complete the request.
401 unauthenticated if the user can not be authenticated.
403 unauthorized if the user doesn't have the required privileges.