Content SubscribedLibrary forceDelete

Content SubscribedLibrary forceDelete

Force deletes the specified subscribed library by skipping the usage check.

Force deleting a subscribed library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal.

This operation was added in vSphere API 9.1.0.0.

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

  • The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.DeleteSubscribedLibrary.
Request
URI
POST
https://{host}/api/content/subscribed-library/{libraryId}?action=force-delete
COPY
Path Parameters
string
libraryId
Required

Identifier of the local library to delete.

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

Authentication
This operation uses the following authentication methods.
Responses
204

Success!

Operation doesn't return any data structure

400

If the library specified by libraryId is not a local library.

Returns Vapi Std Errors InvalidElementType of type(s) application/json
This response body class contains all of the following: Vapi Std Errors Error 
{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Vapi Std LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

404

If the library specified by libraryId does not exist.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: Vapi Std Errors Error 
{
    "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"
}

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' https://{api_host}/api/content/subscribed-library/{libraryId}?action=force-delete
On This Page
Content Operations
GET
Content SubscribedLibrary list
POST
Content SubscribedLibrary create
GET
Content SubscribedLibrary get
DELETE
Content SubscribedLibrary delete
PATCH
Content SubscribedLibrary update
POST
Content SubscribedLibrary forceDelete
POST
Content SubscribedLibrary evict
POST
Content SubscribedLibrary sync
POST
Content SubscribedLibrary probe