Documentation Center

delete_package

Deletes a package or distribution profile from the server.

Description

Deleting a packaging or distribution profile permanently removes it from the system. You cannot restore it. In case the case of packaging profiles, you can no longer export the package. In the case of distribution profiles, it will no longer synchronize its group of delivery servers.

Parameters

action
delete_package
name
Identifying name of the package or the delivery group.
type
Either "packages" to administer normal packages, or "masters" to administer Master Server delivery groups. Defaults to "packages".

Example URL

http://<host>:<port>/<context>/web/package.xql?action=delete_package&name=<value>&type=<value>

Successful Result

This function returns a standard API result element (<result status='SUCCESS' statusCode='0' message='Localized Message' messageKey='message.key'/>). A statusCode of 0 indicates a successful execution. Any other statusCode indicates a failure.

Failed Result

Accessing this API feature requires the "Manage application" permission, and the function will throw a permission exception if the permission is not available.