Vcenter VmTemplate LibraryItems Versions delete

Deletes the virtual machine template contained in the library item at the specified version.

This operation was added in vSphere API 6.9.1.

Returns an authorization error if you do not have all of the privileges described as follows:

Operation execution requires System.Read.
The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.DeleteLibraryItem.
The resource com.vmware.content.library.item.Version referenced by the parameter version requires System.Read.

Request

URI

DELETE

https://{api_host}/api/vcenter/vm-template/library-items/{templateLibraryItem}/versions/{version}

COPY

Path Parameters

string

templateLibraryItem

Required

Identifier of the VM template library item.

The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

string

version

Required

Version of the library item to delete.

The parameter must be an identifier for the resource type: com.vmware.content.library.item.Version.

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

204

Success!

Operation doesn't return any data structure

400

if the specified version is the latest version of the library item.

if the library item does not contain a virtual machine template.

Returns Vapi Std Errors InvalidArgument of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors InvalidArgument0

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": "Vapi Std NestedLocalizableMessage Object",
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

401

if the user that requested the operation cannot be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0

"Vapi Std Errors Unauthenticated Object"

string

challenge

Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.

403

if the user that requested the operation is not authorized to perform the operation.

Returns Vapi Std Errors Unauthorized of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthorized0

"Vapi Std Errors Unauthorized Object"

404

if the library item or version is not found.

Returns Vapi Std Errors NotFound of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors NotFound0

"Vapi Std Errors NotFound Object"

500

Vapi Std Errors ResourceInaccessible if the virtual machine template's configuration state cannot be accessed.

Vapi Std Errors Error if the system reports an error while responding to the request.

Returns Vapi Std Errors Error of type(s) application/json

"Vapi Std Errors Error Object"

array of object

messages

Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string

error_type

Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.

Code Samples

COPY

                    curl -X DELETE -H 'Authorization: <value>' https://{api_host}/api/vcenter/vm-template/library-items/{templateLibraryItem}/versions/{version}

On This Page

Description

Request

Path Parameters

Authentication

Response

204 Response Body

Errors

Vcenter Vm Template Operations

GET

Vcenter VmTemplate LibraryItems Versions list

GET