Start of change

Delete a Deployment

You can use this operation to remove a completed Deployment object from z/OSMF. The delete operation removes only the definition of the deployment from z/OSMF.

The following are not affected:
  • JCL data set containing the generated deployment jobs.
  • Submitted deployment jobs and their output in the target system spool.
  • Target software instance created by the deployment operation.
  • Workflow instances created for the target software instance.

HTTP method and URI path

DELETE /zosmf/swmgmt/dep/<dep-name>
where:
zosmf/swmgmt
Identifies the software management services.
dep

Informs the service the request is for a deployment.

<dep-name>

Name for the deployment to be deleted.

Standard headers

Use the following standard HTTP header with this request:
Accept-Language
Identifies the preferred language for any messages that are returned to the caller. The following values are acceptable:
  • Accept-Language: en (English)
  • Accept-Language: ja (Japanese)
If any other language value is specified or if the header is omitted, then English is used.

Custom headers

None.

Request content

None.

Required authorizations

Certain authorizations are required to submit a request through the software management services to delete a deployment. The user ID that initiates the request requires the same authorizations as those needed to delete the deployment with the z/OSMF Software Management task. The user ID needs the following:
  • READ access to the Software Management task
  • CONTROL access to the SAF resources that correspond to the deployment object to be deleted.
For more information about access controls for the Software Management task, see Creating access controls for the Software Management task in IBM z/OS Management Facility Configuration Guide.

Expected response

On completion, the service returns an HTTP response with a status code that indicates whether your request completed. Status code 200 indicates success. A status code of 4nn or 5nn indicates that an error occurred. For more information about errors, see Error handling.

Example

In the following example, the DELETE method is used to delete deployment Hooli from system PEV174.

DELETE /zosmf/swmgmt/dep/Hooli HTTP/1.1
Host: pev174.yourco.com
Here is the sample response that indicates that the delete operation was successful.
HTTP/1.1 200 OK
Date: Tues, 05 June 2021 18:53:27 +00004GMT
End of change