REST URL Structure
The Administrator API makes resources accessible through a URL path. All requests to the Administrator API must be issued using HTTPS or HTTP. The Administrator API supports the standard H TTP methods GET, POST, PUT, PATCH, and DELETE. Not all resources will support all HTTP methods. However, all resources support the HEAD and OPTIONS methods.
An absolute URL for an Administrator API resource has the following structure:
https://host:port/admin/resourceType
or
https://host:port/admin/resourceType/{resourceId}
Where:
https is the transport protocol. You can use HTTP or HTTPS.
Software AG recommends using the more secure HTTPS protocol to administer your Integration Server.
host:port is the host and port of the
Integration Server you want to administer.
admin is the directive for the Administrator API.
resourceType is the type of resource, such as a package or cache manager.
{resourceId} identifies a specific resource, such as a package name or a cache manager name.
{resourceId} is only used with some requests.
Examples:
The absolute URL for
GET /admin/package resource which retrieves all packages looks like:
HTTPS GET http://localhost:port/admin/package
The absolute URL for the
GET /admin/package/{packageName} resource which retrieves information for a specific package looks like the following when retrieving details about the WmPublic package.
HTTP GET http://localhost:port/admin/package/WmPublic
Note:
In EBNF syntax, the absolute URL has the following structure: https://host:port/admin/resourceType[/resourceId]
The relative URL for an Administrator API resource must start with /admin and then identify the type of resource. The relative URI has the following structure:
/admin/resourceType
or
/admin/resourceType/{resourceId}
Examples:
GET /admin/license Returns license information for Integration Server.
POST /admin/remoteserver Retrieves information about all of the remote server aliases configured on Integration Server
PATCH /admin/remoteserver/example Updates a remote server alias named "example".
Note:
In EBNF syntax, the relative URL has the following structure: /admin/resourceType[/resourceId]