Export Customization Specs
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
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.
Request
URLURL
https://{api_host}/rest/vcenter/guest/customization-specs/{name}?action=export
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | The name of the customization specification that has to be returned. The parameter must be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains GuestCustomizationSpecsExportRequestBody
of type application/json
(required)
{
"format": "enum"
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | format | GuestCustomizationSpecsFormat Enum |
The format in which the customization specification has to be returned. |
Response
Response
Response BodyResponse Body
200 OK returns
GuestCustomizationSpecsExportResponseBody
of type application/json
The string representation of the customization specification in the specified format.
{
"value": "string"
}| Property Name | Type | Description |
|---|---|---|
| value | string |
The string representation of the customization specification in the specified format. |
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"format":"enum"}' https://{api_host}/rest/vcenter/guest/customization-specs/{name}?action=export
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | ErrorRest | com.vmware.vapi.std.errors.not_found : if the customization specification is not found. |
| 503 | ErrorRest | com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request. |
| default | ErrorRest | Not available |
| 400 | ErrorRest | com.vmware.vapi.std.errors.invalid_argument : If value of format is not valid. |
| 401 | ErrorRest | com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges. |
