Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Keep alerts API

The alerts API from Keep — 24 operation(s) for alerts.

Keep alerts API is one of 27 APIs that Keep publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include alerts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 28 operations across 24 paths, and defines 21 schemas. It is described by OpenAPI 3.0.2, at version 0.24.5.

Requests are made against the base URL https://api.keephq.dev.

28 operations 24 paths 21 schemas 2 DELETE14 GET11 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
0.24.5
Base URL
https://api.keephq.dev
Authentication
API Key, HTTP Basic, OAuth 2.0
Resource Areas
1

Authentication & Security 3

Keep alerts API declares 3 security schemes for authenticating requests. An API key is passed in the header as X-API-KEY (API Key). It accepts HTTP basic authentication (HTTPBasic). It supports OAuth 2.0 (OAuth2PasswordBearer) using the password flow.

Paths & Operations 28

Across 24 paths, the API surfaces 28 operations — 2 DELETE, 14 GET, 11 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

alerts 28
GET
/alerts
Get All Alerts
get_all_alerts_alerts_get 1 param → 200422
DELETE
/alerts
Delete Alert
delete_alert_alerts_delete body → 200422
GET
/alerts/{fingerprint}/history
Get Alert History
get_alert_history_alerts__fingerprint__history_get 1 param → 200422
POST
/alerts/{fingerprint}/assign/{last_received}
Assign Alert
assign_alert_alerts__fingerprint__assign__last_received__post 3 params → 200422
POST
/alerts/event
Receive Generic Event
receive_generic_event_alerts_event_post 1 param body → 202422
GET
/alerts/event/netdata
Webhook Challenge
webhook_challenge_alerts_event_netdata_get → 200
POST
/alerts/event/{provider_type}
Receive Event
receive_event_alerts_event__provider_type__post 3 params → 202422
GET
/alerts/{fingerprint}
Get Alert
get_alert_alerts__fingerprint__get 1 param → 200422
POST
/alerts/enrich
Enrich Alert
enrich_alert_alerts_enrich_post 1 param body → 200422
POST
/alerts/unenrich
Unenrich Alert
unenrich_alert_alerts_unenrich_post body → 200422
POST
/alerts/search
Search Alerts
search_alerts_alerts_search_post body → 200422
POST
/alerts/audit
Get Multiple Fingerprint Alert Audit
get_multiple_fingerprint_alert_audit_alerts_audit_post body → 200422
GET
/alerts/{fingerprint}/audit
Get Alert Audit
get_alert_audit_alerts__fingerprint__audit_get 1 param → 200422
GET
/alerts/quality/metrics
Get Alert Quality
get_alert_quality_alerts_quality_metrics_get 2 params → 200422
GET
/workflows
Get Workflows
get_workflows_workflows_get 1 param → 200422
POST
/workflows
Create Workflow
create_workflow_workflows_post body → 201422
GET
/workflows/export
Export Workflows
export_workflows_workflows_export_get → 200
POST
/workflows/{workflow_id}/run
Run Workflow
run_workflow_workflows__workflow_id__run_post 1 param body → 200422
POST
/workflows/test
Run Workflow From Definition
run_workflow_from_definition_workflows_test_post body → 200422
POST
/workflows/json
Create Workflow From Body
create_workflow_from_body_workflows_json_post → 201
GET
/workflows/random-templates
Get Random Workflow Templates
get_random_workflow_templates_workflows_random_templates_get → 200
GET
/workflows/{workflow_id}
Get Workflow By Id
get_workflow_by_id_workflows__workflow_id__get 1 param → 200422
PUT
/workflows/{workflow_id}
Update Workflow By Id
update_workflow_by_id_workflows__workflow_id__put 1 param → 201422
DELETE
/workflows/{workflow_id}
Delete Workflow By Id
delete_workflow_by_id_workflows__workflow_id__delete 1 param → 200422
GET
/workflows/{workflow_id}/raw
Get Raw Workflow By Id
get_raw_workflow_by_id_workflows__workflow_id__raw_get 1 param → 200422
GET
/workflows/executions
Get Workflow Executions By Alert Fingerprint
get_workflow_executions_by_alert_fingerprint_workflows_executions_get → 200
GET
/workflows/{workflow_id}/runs
Get Workflow By Id
get_workflow_by_id_workflows__workflow_id__runs_get 7 params → 200422
GET
/workflows/{workflow_id}/runs/{workflow_execution_id}
Get Workflow Execution Status
get_workflow_execution_status_workflows__workflow_id__runs__workflow_execution_id__get 1 param → 200422

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are AlertDto (31 properties), WorkflowDTO (19 properties), WorkflowExecutionDTO (10 properties), WorkflowExecutionsPaginatedResultsDto (8 properties). Each schema is shown below with its type and property counts.

DeleteRequestBody
object
3 properties 2 required
ValidationError
object
3 properties 3 required
WorkflowToAlertExecutionDTO
object
5 properties 5 required
WorkflowExecutionsPaginatedResultsDto
object
8 properties 2 required
ProviderDTO
object
4 properties 3 required
UnEnrichAlertRequestBody
object
2 properties 2 required
AlertStatus
An enumeration.
AlertActionType
An enumeration.
Body_create_workflow_workflows_post
object
1 property 1 required
WorkflowExecutionDTO
object
10 properties 5 required
PresetSearchQuery
object
4 properties 2 required
AlertAuditDto
object
6 properties 6 required
AlertSeverity
An enumeration.
Body_run_workflow_from_definition_workflows_test_post
object
1 property
HTTPValidationError
object
1 property
WorkflowDTO
object
19 properties 5 required
EnrichAlertRequestBody
object
2 properties 2 required
AlertDto
object
31 properties 4 required
SearchAlertsRequest
object
2 properties 2 required
WorkflowExecutionLogsDTO
object
4 properties 3 required
WorkflowCreateOrUpdateDTO
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keep-alerts-api-openapi.yml Raw ↑

Other APIs Keep publishes across the network.

Keep actions API
Keep auth API
Keep dashboard API
Keep deduplications API
Keep enrichment API
Keep extraction API
Keep groups API
Keep healthcheck API
Keep incidents API
Keep Keep API API
Keep maintenance API
Keep mapping API