About the APIs
This section provides information about the authentication method, available API methods, the base URL, content types, and available endpoints for IOS-XE SLP REST APIs.
Authentication
HTTP authentication is performed with a username and password and is performed for every request.
A username and password is configured on the product instance. For details, see Enabling an HTTP Server with an Authentication Method. The same is then used with each API request.
For example, if you use the Postman application, provide authentication information as follows:
- Click + New, to create create a new API request.
- Click the Authorization tab of the API request
- From the Type dropdown list, select Basic Auth.
- Enter the username and password you configured on the product instance.
You can also use other authentication methods such as TACACS, an encrypted password, etc.
Available Methods
The available request methods are GET and POST.
Each request produces an HTTPS response from CSSM. The response has the standard headers, response content, and status code.
Base URL
The base URL for all IOS-XE SLP REST APIs is: https://<PI-mgmt-ip>
Content Types
All IOS-XE SLP REST APIs use Content-type: Application/json
API Endpoint and Description
| API Endpoint | Description |
|---|---|
| /smartlic-service/close-reports | Closes all currently open RUM reports on the product instance. |
| /smartlic-service/list | Gets the list of available RUM reports with the report ID and timestamps. Acts as a table of contents for what is available on the product instance. |
| /smartlic-service/all-reports | Gets the list of all signed RUM reports with the device-led conversion payload - where available. |
| /smartlic-service/days | Gets the list of signed RUM reports for the last 90 days. |
| /smartlic-service/days/n | Gets the list of all signed RUM reports for the last 'n' number of days. |
| /smartlic-service/days/rum-report-id | Gets the RUM report for a specified ID. |
| /smartlic-service/import | Applies a SLAC, or RUM ACK, or custom policy on the product instance. A single file may include one or more items (SLAC, RUM ACK, custom policy). |
Note:
RUM reports, once closed, are immutable. Hence an API to DELETE a RUM report is not supported. To erase all data from a product instance, see Decommissioning a Product Instance.
An API to return a SLAC (for export-controlled or enforced licenses or throughput greater than 205 Mbps) is currently not supported.