Introduction to the Administrator API

Integration Server 10.11 | Integration Server Administrator's Guide | Integration Server Administrator API | Introduction to the Administrator API

Integration Server provides an administrative API that can be used to perform administrative actions such as restarting Integration Server as well as creating, retrieving, updating and deleting assets on Integration Server. The Administrator API uses the REST architectural style. The unit of work for all REST operations is a resource. In the Integration Server Administrator API, resources are administrative assets such as packages, license keys, and the server itself.

The Integration Server Administrator API uses JSON as the media type. However, The API supports other media types requested by the client as long as Integration Server has a content handler for the media type.

All Administrator API requests and responses are described by an OpenAPI 3.0 document. This document can be obtained in the following ways:

Requested from the API with GET /admin/swagger/integrationServer

From the file system: Integration Server_directory \instances\instanceName\packages\WmAdmin\resources\wmadmin_swagger.json

Note:
The OpenAPI Specification was originally called the Swagger specification. An OpenAPI document may also be referred to as a Swagger document or file or simply Swagger.

The Administrator API is available when the WmAdmin package is enabled. This package is enabled by default. Disabling the WmAdmin package disables the API.

Using the Integration Server Administrator API requires familiarity with REST, OpenAPI 3.0, and Integration Server.