Using the RESTful administration interface

The administration interface for APIs is available in paths under /zosConnect/apis and provides meta-data for the APIs.

zosConnect-2.0 Applies to zosConnect-2.0.

A Swagger document describing the RESTful administration interface for IBM® z/OS® Connect is available on the URI /zosConnect/api-docs.

Notes for all calls

All successful calls return HTTP status code 200 unless otherwise specified.
URLs returned by any of the calls contain the protocol, server, and port from the request.
Any call using a HTTP method with a URI not mentioned in these topics will return an error 405 Method Not Allowed.
If an error occurs while processing a request, an appropriate HTTP status code and the following JSON will be returned:
```
{
       "errorMessage": "{message}",
       "errorDetails": "{details}"
}
```
Note: errorDetails is optional and will only be returned for some error scenarios.