This tutorial demonstrates how to use our TCO Optimizer HTTP API to define, query, and manage your TCO policy overrides, used exclusively for logs.
Visit this page to learn how to use our TCO Tracing gPRC API to define, query, and manage your TCO policy criteria, used both for spans and logs.
Select the base API endpoint associated with your Coralogix domain.
Domain | Base API endpoint |
---|---|
coralogix.us (Ohio) | https://api.app.coralogix.us/api/v1/external/tco/ |
cx498.coralogix.com (Oregon) | https://api.app.cx498.coralogix.com/api/v1/external/tco/ |
coralogix.com (Ireland) | https://api.coralogix.com/api/v1/external/tco/ |
eu2.coralogix.com (Stockholm) | https://api.app.eu2.coralogix.com/api/v1/external/tco/ |
coralogix.in (Mumbai) | https://api.app.coralogix.in/api/v1/external/tco/ |
coralogixsg.com (Singapore) | https://api.app.coralogixsg.com/api/v1/external/tco/ |
Key | Value |
---|---|
Content-Type | application/json |
Authorization | Bearer <API_KEY> |
The TCO Optimizer API uses your Alerts, Rules, and Tags API Key to authenticate requests. To access this API key in your Coralogix navigation pane, click Data Flow > API Keys > Alerts, Rules, and Tags API Key.
Name | Value |
---|---|
debug | 1 |
verbose | 2 |
info | 3 |
warning | 4 |
error | 5 |
critical | 6 |
Name | Value |
---|---|
block | block |
low | low |
medium | medium |
high | high |
GET /overrides
Route example: https://api.coralogix.com/api/v1/external/tco/overrides
Response example:
[ { "id": "dd361b69-89c7-11ec-a5ad-0616c20b31c7", "name": "default|recommendationservice|INFO", "priority": "high", "severity": 3, "applicationName": "default", "subsystemName": "recommendationservice" }, { "id": "61d551af-8f96-11ec-8bfb-02dd69f0920d", "name": "default|checkoutservice|DEBUG", "priority": "high", "severity": 1, "applicationName": "default", "subsystemName": "checkoutservice" } ]
GET /overrides/{id}
Route example: https://api.coralogix.com/api/v1/external/tco/overrides/*972f6b98-343c-11ee-ac29-061115d0c307*
Response example:
{ "id": "dd361b69-89c7-11ec-a5ad-0616c20b31c7", "name": "default|recommendationservice|INFO", "priority": "high", "severity": 3, "applicationName": "default", "subsystemName": "recommendationservice" }
POST /overrides
Route example: https://api.coralogix.com/api/v1/external/tco/overrides
Request example:
{ "priority": "high", "severity": 3, "applicationName": "default", "subsystemName": "blablabla123" }
Response example:
{ "priority": "high", "severity": 3, "applicationName": "default", "subsystemName": "blablabla123", "id": "972f6b98-343c-11ee-ac29-061115d0c307" }
POST /overrides/bulk
Route example: https://api.coralogix.com/api/v1/external/tco/overrides/bulk
Request example:
[ { "priority": "high", "severity": 3, "applicationName": "default", "subsystemName": "blablabla1234" }, { "priority": "high", "severity": 3, "applicationName": "default", "subsystemName": "blablabla12345" } ]
Response example:
[ { "status": 200, "override": { "priority": "high", "severity": 3, "applicationName": "default", "subsystemName": "blablabla1234", "id": "2c42a7aa-343d-11ee-ac29-061115d0c307" } }, { "status": 200, "override": { "priority": "high", "severity": 3, "applicationName": "default", "subsystemName": "blablabla12345", "id": "2c53d05f-343d-11ee-ac29-061115d0c307" } } ]
PUT /overrides/bulk
Route example: https://api.coralogix.com/api/v1/external/tco/overrides/bulk
Request example:
[ { "id": "2c42a7aa-343d-11ee-ac29-061115d0c307", "name": "default|blablabla1234|INFO", "priority": "high", "severity": 3, "applicationName": "default", "subsystemName": "blablabla1234" }, { "id": "2c53d05f-343d-11ee-ac29-061115d0c307", "name": "default|blablabla12345|INFO", "priority": "high", "severity": 3, "applicationName": "default", "subsystemName": "blablabla12345" } ]
Response example:
[ { "status": 200, "override": { "name": "default|blablabla1234|INFO", "priority": "high", "severity": 3, "applicationName": "default", "subsystemName": "blablabla1234", "id": "2c42a7aa-343d-11ee-ac29-061115d0c307" } }, { "status": 200, "override": { "name": "default|blablabla12345|INFO", "priority": "high", "severity": 3, "applicationName": "default", "subsystemName": "blablabla12345", "id": "2c53d05f-343d-11ee-ac29-061115d0c307" } } ]
DELETE /overrides/{id}
Route example: https://api.coralogix.com/api/v1/external/tco/overrides/2c53d05f-343d-11ee-ac29-061115d0c307
Response example:
{ "id": "2c53d05f-343d-11ee-ac29-061115d0c307" }
DELETE /overrides/bulk
Route example: https://api.coralogix.com/api/v1/external/tco/overrides/bulk
Request example:
[ { "id": "2c42a7aa-343d-11ee-ac29-061115d0c307" } ]
Response example:
[ { "status": 200, "override": { "id": "2c42a7aa-343d-11ee-ac29-061115d0c307" } } ]
Documentation | TCO Optimizer TCO Tracing gPRC API |
Need help?
Our world-class customer success team is available 24/7 to walk you through your setup and answer any questions that may come up.
Feel free to reach out to us via our in-app chat or by sending us an email at [email protected].