REST API Documentation

 

Automate implements a RESTful (REpresentational State Transfer) web service on your Management Server. To access the web service, you need to use a REST client/library that can construct the URI, header, method (GET, PUT, POST, DELETE), and body of the requests. The base URI for the web service varies for each version:

• Version 11: "http://myserver:9708/BPAManagement/"
• Version 10: "http://myserver:9608/BPAManagement/"

By default the web service is turned off. It can be enabled in the Options > Server Settings > API Security page of the SMC. Automate does not need to be restarted to enable/disable this feature.

The web service uses HTTP Basic authentication and therefore does not require cookies, a session identifier, or login pages. For HTTP Basic authentication, the URI is often specified to the client like "http://myuser:mypassword@myserver:9708/BPAManagement/". The client then takes that user:password combination out of the URI, encodes it in Base64, and adds a header line similar to: "Authorization: Basic bXl1c2VyOm15cGFzc3dvcmQ=". Note: Some clients will not parse the user:password out of the URI and add the header for you. For those clients, you may have to specify the user and password as separate parameters or provide the header line yourself.

This API is only available for Automate Plus/Ultimate and the Enterprise version of Automate BPA Server.

REST API documentation

Applies To: 

• Automate Plus/Ultimate v11.0 and higher
• Automate BPA Server v10.5.0.56 and higher