IAP/REST API
IAP/REST is the IAP API based on REST (REpresentational State Transfer), or RESTful, web services. REST web services provide an interoperable web-standard interface for web clients such as web-page scripts running in web browsers to communicate with services hosted on web servers. IAP/REST is typically used to connect client applications running within web-page scripts to an IAP/REST server, and can be used to implement any application supporting REST requests and responses.
The REST URL format is SmartServer-version specific:
- With SmartServer release 2.8 or higher, you do not have to specify the port number.
https://<apollo_ip>/cms
- With SmartServer 2.7 and prior, you have to specify the port number (8443).
https://<apollo_ip>:8443/cms
This section consists of:
- IAP/REST API Reference – a detailed description of all APIs organized by resource.
- IAP/REST API Index – a list of all APIs in alphabetical order. Each API is linked to its reference page.
For information on using queries in the API call, see Queries and Parameters.