Logs
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
GET | |
POST | |
GET | |
POST | |
POST | |
GET | |
POST | |
GET |
List all environments logs alerts
Required API key scopes
logs:readPath parameters
- environment_idstring
Query parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /environments /:environment_id /logs /alertsExample response
Status 200
RESPONSE
List all environments logs alerts
Required API key scopes
logs:readPath parameters
- environment_idstring
Query parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /environments /:environment_id /logs /alertsExample response
Status 200
RESPONSE
Create environments logs alerts
Required API key scopes
logs:writePath parameters
- environment_idstring
Request parameters
- namestring
- enabledboolean
- filters
- threshold_countinteger
- threshold_operatorDefault:
above - window_minutesinteger
- evaluation_periodsintegerDefault:
1 - datapoints_to_alarmintegerDefault:
1 - cooldown_minutesinteger
- snooze_untilstring
Response
Example request
POST /api /environments /:environment_id /logs /alertsExample response
Status 201
RESPONSE
Create environments logs alerts
Required API key scopes
logs:writePath parameters
- environment_idstring
Request parameters
- namestring
- enabledboolean
- filters
- threshold_countinteger
- threshold_operatorDefault:
above - window_minutesinteger
- evaluation_periodsintegerDefault:
1 - datapoints_to_alarmintegerDefault:
1 - cooldown_minutesinteger
- snooze_untilstring
Response
Example request
POST /api /environments /:environment_id /logs /alertsExample response
Status 201
RESPONSE
Retrieve environments logs alerts
Required API key scopes
logs:readPath parameters
- environment_idstring
- idstring
Response
Example request
GET /api /environments /:environment_id /logs /alerts /:idExample response
Status 200
RESPONSE
Retrieve environments logs alerts
Required API key scopes
logs:readPath parameters
- environment_idstring
- idstring
Response
Example request
GET /api /environments /:environment_id /logs /alerts /:idExample response
Status 200
RESPONSE
Update environments logs alerts
Required API key scopes
logs:writePath parameters
- environment_idstring
- idstring
Request parameters
- namestring
- enabledboolean
- filters
- threshold_countinteger
- threshold_operatorDefault:
above - window_minutesinteger
- evaluation_periodsintegerDefault:
1 - datapoints_to_alarmintegerDefault:
1 - cooldown_minutesinteger
- snooze_untilstring
Response
Example request
PATCH /api /environments /:environment_id /logs /alerts /:idExample response
Status 200
RESPONSE
Update environments logs alerts
Required API key scopes
logs:writePath parameters
- environment_idstring
- idstring
Request parameters
- namestring
- enabledboolean
- filters
- threshold_countinteger
- threshold_operatorDefault:
above - window_minutesinteger
- evaluation_periodsintegerDefault:
1 - datapoints_to_alarmintegerDefault:
1 - cooldown_minutesinteger
- snooze_untilstring
Response
Example request
PATCH /api /environments /:environment_id /logs /alerts /:idExample response
Status 200
RESPONSE
Delete environments logs alerts
Required API key scopes
logs:writePath parameters
- environment_idstring
- idstring
Example request
DELETE /api /environments /:environment_id /logs /alerts /:idExample response
Status 204 No response body
Delete environments logs alerts
Required API key scopes
logs:writePath parameters
- environment_idstring
- idstring
Example request
DELETE /api /environments /:environment_id /logs /alerts /:idExample response
Status 204 No response body
Retrieve environments logs attributes
Required API key scopes
logs:readPath parameters
- environment_idstring
Example request
GET /api /environments /:environment_id /logs /attributesExample response
Status 200 No response body
Create environments logs export
Required API key scopes
logs:readPath parameters
- environment_idstring
Example request
POST /api /environments /:environment_id /logs /exportExample response
Status 200 No response body
Retrieve environments logs has logs
Required API key scopes
logs:readPath parameters
- environment_idstring
Example request
GET /api /environments /:environment_id /logs /has_logsExample response
Status 200 No response body
Create environments logs query
Required API key scopes
logs:readPath parameters
- environment_idstring
Example request
POST /api /environments /:environment_id /logs /queryExample response
Status 200 No response body
Create environments logs sparkline
Required API key scopes
logs:readPath parameters
- environment_idstring
Example request
POST /api /environments /:environment_id /logs /sparklineExample response
Status 200 No response body
Retrieve environments logs values
Required API key scopes
logs:readPath parameters
- environment_idstring
Example request
GET /api /environments /:environment_id /logs /valuesExample response
Status 200 No response body
Create logs explainlogwithai
Explain a log entry using AI.
POST /api/environments/:id/logs/explainLogWithAI/
Required API key scopes
logs:writePath parameters
- project_idstring
Request parameters
- uuidstring
- timestampstring
- force_refreshbooleanDefault:
false
Response
Example request
POST /api /environments /:project_id /logs /explainLogWithAIExample response
Status 201
RESPONSE
List all logs views
Required API key scopes
logs:readPath parameters
- project_idstring
Query parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /environments /:project_id /logs /viewsExample response
Status 200
RESPONSE