RESTful APIs overview

IBM® Control Center RESTful application programming interfaces (APIs) enable other applications to integrate with the IBM Control Center web console.

IBM Control Center contains RESTful APIs before the 6.0 release and the newly exposed REST APIs in the 6.0 release. The main difference in 6.0 is that more 10x RESTful APIs are exposed, which provide create, retrieve, update, and delete functions for APIs that include actions, calendars, email Lists, rules, schedules, and simple SLCs. With these newly exposed APIs, you can build your own APIs by using the new Interactive Console. RESTful APIs prior to 6.0 are comprised of methods to track your file transfers, file transfer success and failure, and health of your environment.

For all of the IBM Control Center RESTful APIs, the authorization header should be included in each REST API call for authentication. For more information about authenticating, see Authenticating RESTful APIs. After successfully authenticating, the server will return one cookie that is named jsessionid. This cookie should be included with subsequent RESTful API calls that are part of the same user session. If it is not included, a new user session is created on the server side for each new incoming RESTful API call, which consumes more server-side resources. For more secure RESTful API calls, enable a secure connection for the web container, so the RESTful API call can work through HTTPS.

The following request and response headers are common to all of the IBM Control Center REST APIs:
  • RESTful API HTTP return codes
  • RESTful API request headers
  • RESTful API response headers