Delete an API

You can use the HTTP method DELETE to delete an IBM® z/OS® Connect API.

zosConnect-2.0 Applies to zosConnect-2.0.

HTTP method

DELETE

URI

/zosConnect/apis/{apiName}

Description

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

Security

Users with Admin or Operations authority can delete an API, users with Invoke or Reader authority cannot.

Return body

{
  "name":"{API name}"
}

Example body

{
  "name":"HospitalAPI"
}

Errors

The following errors can occur:

409 Conflict
A z/OS Connect API must be stopped before it can be deleted.
    
500 Internal Server Error
Server issue, might require administrator intervention.

503 Service Unavailable
A z/OS Connect API must complete all outstanding requests before it can 
     be deleted.