DELETE

Resource URL

https://host:port/ibmmq/rest/v1/admin/qmgr/{qmgrName}/queue/{queueName}

You can use HTTP instead of HTTPS if you enable HTTP connections. For more information about enabling HTTP, see Configuring HTTP and HTTPS ports.

Optional query parameters

keepAuthorityRecords

This parameter is only available on the IBM® MQ Appliance, UNIX, Linux®, and Windows.

Specifies that the associated authority records are not deleted.

commandScope=scope

This parameter is only available on z/OS®.

Specifies how the command is run when the queue manager is a member of a queue sharing group.

You cannot specify this parameter if the queue manager is not a member of a queue sharing group.

scope can be one of the following values:

The name of a queue manager

Specifies that the command is run on the queue manager that is named. The queue manager must be active within the same queue sharing group as the queue manager that is specified in the resource URL.

You cannot specify the queue manager name that is the queue manager that is specified in the resource URL.

If the queue manager name includes a percent sign, %, this character must be URL encoded as %25.

*

Specifies that the command is run on the local queue manager and also passed to every active queue manager in the queue sharing group.

If this option is used, an ibm-mq-qmgrs response header is returned with a comma-separated list of the queue managers that generated a response. For example, the header might look like the following header:

ibm-mq-qmgrs: MQ21, MQ22

purge

Specifies that all messages are purged from the queue.

If messages are on the queue, you must specify purge, or the queue cannot be deleted.

queueSharingGroupDisposition=disposition

This parameter is only available on z/OS.

Specifies where the queue is defined and how it behaves. That is, it specifies the disposition of the queue.

disposition can be one of the following values:

copy

Specifies that the queue definition exists on the page set of the queue manager that runs the command. The queue was defined by a command that used the MQQSGD_COPY PCF parameter, or the copy REST API parameter.

Any queue in the shared repository, or any queue that is defined by using the MQQSGD_Q_MGR PCF parameter, or qmgr REST API parameter, is not affected by this command.

group

Specifies that the queue definition exists in the shared repository. The queue was defined by a command that used the MQQSGD_GROUP PCF parameter, or the group REST API parameter.

Any queue that exists on the page set of the queue manager that runs the command, except for a local copy of the queue, is not affected by this command.

If the deletion is successful, the following MQSC command is generated and sent to all active queue managers in the queue sharing group to delete local copies on page set zero:

DELETE queue(q-name) QSGDISP(COPY)

or for a local queue only:

DELETE QLOCAL(q-name) NOPURGE QSGDISP(COPY)

The deletion of the group object takes effect even if the generated command with QSGDISP(COPY) fails.

Note: You always get the NOPURGE option even if you specify the purge flag. To delete messages on local copies of the queues you must explicitly run, for each copy, a command to delete the queue with the purge flag, and a queueSharingGroupDisposition value of copy.

qmgr

Specifies that the queue definition exists on the page set of the queue manager that runs the command. The object was defined by a command that used the MQQSGD_Q_MGR PCF parameter or the qmgr REST API parameter.

Any queue that exists in the shared repository, or any local copy of such a queue, is not affected by this command.

shared

This value is only valid for local queues.

Specifies that the queue exists in the shared repository. The object was defined by a command that used the MQQSGD_SHARED PCF parameter or the shared REST API parameter.

Any queue that exists on the page set of the queue manager that runs the command, or any queue that is defined by a command that uses the parameter MQQSGD_GROUP is not affected by this command.

The default value is qmgr.

Request headers

Request body format

None.

Security requirements

The caller must be authenticated to the mqweb server and must be a member of one or more of the MQWebAdmin, MQWebAdminRO, or MQWebUser roles. For more information about security for the administrative REST API, see IBM MQ Console and REST API security.

If token based security is used, the LTPA token that is used to authenticate the user must be provided with the request as a cookie. For more information about token-based authentication, see Using token-based authentication with the REST API.

On UNIX, Linux, and Windows, you can grant authority to security principals to use IBM MQ resources by using the setmqaut command. For more information, see setmqaut (grant or revoke authority).

On z/OS, see Setting up security on z/OS.

Response status codes

Response headers

Response body format

The response body is empty if the queue is deleted successfully. If an error occurs, the response body contains an error message. For more information, see REST API error handling.

Examples

The following example deletes the queue Q1 from the queue manager QM1, and purges all messages from the queue when used with the HTTP DELETE method:

https://localhost:9443/ibmmq/rest/v1/admin/qmgr/QM1/queue/Q1?purge