Developer Documentation
Export Customization Specs
Released in v7.0.0Returns 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. |
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | action=export |
Request Body
Request Body
Contains
ExportRequestBody
of type application/json
(required)
{
"format": "enum"
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | format | CustomizationSpecsFormat Enum |
The format in which the customization specification has to be returned. |
Response
Response
Response BodyResponse Body
200 OK returns
ExportResponseBody
of type application/json
This structure was autogenerated to hold a response body. It contains: 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. |
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Error | 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. |
| 404 | Error | com.vmware.vapi.std.errors.not_found : if the customization specification is not found. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request. |
| default | Error | Not available |
| 400 | Error | com.vmware.vapi.std.errors.invalid_argument : If value of format is not valid. |
