How to get details of an API requester

You can use the HTTP method GET to obtain information about a specific IBM® z/OS® Connect API requester.

HTTP method

GET

URI

/zosConnect/apiRequesters/{apiRequesterName}

Description

Gets the details of the requested IBM z/OS Connect API requester.

Security

Users with Admin, Operations or Reader authority can get details of an API requester; users with Invoke authority cannot.

Response body

{
  "name":"{apiRequesterName}",
  "version":"{version}",
  "description":"{API requester description}",
  "status": "Started|Stopped",
  "apiRequesterUrl":"http(s)://{host}:{port}/zosConnect/apiRequesters/{name}"
  "connection":"{Endpoint Connection id}"
}

Example response body

{
  "name":"Book_Inventory",
  "version":"1.0.0",
  "description":"API requester for Book_Inventory app",
  "status":"Started"
  "apiRequesterUrl":"http://localhost:9080/zosConnect/apiRequesters/Book_Inventory"
  "connection":"BookConnref"
}

Errors

The following error can occur:

404 Not found
The API requester is not registered.