This page describes the public REST API of the COT.
The public REST API URL can be accessed any time after COT installation by running the following command:
$ cot show --api_url
The following are REST requests to retrieve COT summary reports.
Request |
GET /api/v1/report/ |
Description |
API to get list of report IDs. |
Response Body |
List of strings, each string is an identifier of a COT run. |
Response Code |
200 OK |
Request |
GET /api/v1/report/{run_id} |
|||||||||||||||||||||||||||
Description |
API to get report by run_id. |
|||||||||||||||||||||||||||
Path Parameters |
|
|||||||||||||||||||||||||||
Query Parameters |
|
|||||||||||||||||||||||||||
Response Body |
If report is ready:
If report generation is in progress:
Otherwise:
|
|||||||||||||||||||||||||||
Response Code |
200 OK404 NOT FOUND – if report does not exist or is in progress |