Delete a service

Use the HTTP method DELETE to delete an IBM® z/OS® Connect service.

zosConnect-2.0 Applies to zosConnect-2.0.

HTTP method

DELETE

URI

/zosConnect/services/{serviceName}

If the service name contains forward slashes, they must be escaped by using %2F. For example, if the service name is MyService/v1, it must be provided as MyService%2Fv1.

Note: Added in V1.1.0 of the administration interface.

Description

Uninstalls the named service from IBM z/OS Connect, and deletes the service archive from the file system. A service must be in stopped state to be deleted.

Security

Users with Admin or Operations authority can delete a service, users with Invoke or Reader authority cannot. For more information about user authorization, see Overview of IBM z/OS Connect security.

Response body

{
  "name":"{service name}"
}

Example response body

{
  "name":"patient"
}

Errors

The following errors can occur.

409 Conflict
The z/OS Connect Service status is started. The z/OS Connect Service cannot be deleted unless it is stopped.
    
500 Internal Server Error
Server issue, might require administrator intervention.