Overview
The administrator can manage adapter resources such as connections, listeners and notifications using Integration Server Administrator. Alternatively, you can use the REST APIs provided by the Adapter Administrator API.
You can use any REST API client to invoke the Adapter Administrator APIs. Refer the REST API client documentation for more information on how to use the client. You must use your Integration Server Administrator credentials to authenticate the Adapter Administrator APIs to access adapter resources from the API client.
REST URL Structure
An Adapter Administrator API makes resources accessible through a URL path. All Adapter Administrator API requests must be issued using HTTP or HTTPS. The Adapter Administrator API supports the standard HTTP methods such as GET, POST, PUT, PATCH, and DELETE. Not all resources support all HTTP methods.
An absolute URL for an Adapter Administrator API resource has the following structure:
http://host:port/admin/adapters/resourceType/{resourceId}
Where:
http is the transport protocol. You can use HTTP or HTTPS.
host:port is the host and port of the
Integration Server on which you want to administer adapter resources.
admin/adapters is the directive for the adapter's Administrator API.
resourceType is the type of resource, such as adapter connection, adapter listener or adapter notification.
resourceId identifies a specific resource.
For example, the following API retrieves all the adapter connections for XXXAdapter:
HTTP GET http://host:port/admin/adapters/connection/XXXAdapter