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 incidents API

The incidents API from Keep — 13 operation(s) for incidents.

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

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

This API exposes 18 operations across 13 paths, and defines 25 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.

18 operations 13 paths 25 schemas 2 DELETE6 GET9 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 incidents 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 18

Across 13 paths, the API surfaces 18 operations — 2 DELETE, 6 GET, 9 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

incidents 18
GET
/incidents
Get All Incidents
get_all_incidents_incidents_get 9 params → 200422
POST
/incidents
Create Incident
create_incident_incidents_post body → 202422
GET
/incidents/meta
Get Incidents Meta
get_incidents_meta_incidents_meta_get → 200
GET
/incidents/{incident_id}
Get Incident
get_incident_incidents__incident_id__get 1 param → 200422
PUT
/incidents/{incident_id}
Update Incident
update_incident_incidents__incident_id__put 2 params body → 200422
DELETE
/incidents/{incident_id}
Delete Incident
delete_incident_incidents__incident_id__delete 1 param → 200422
POST
/incidents/merge
Merge Incidents
merge_incidents_incidents_merge_post body → 200422
GET
/incidents/{incident_id}/alerts
Get Incident Alerts
get_incident_alerts_incidents__incident_id__alerts_get 4 params → 200422
POST
/incidents/{incident_id}/alerts
Add Alerts To Incident
add_alerts_to_incident_incidents__incident_id__alerts_post 2 params body → 202422
DELETE
/incidents/{incident_id}/alerts
Delete Alerts From Incident
delete_alerts_from_incident_incidents__incident_id__alerts_delete 1 param body → 202422
GET
/incidents/{incident_id}/future_incidents
Get Future Incidents For An Incident
get_future_incidents_for_an_incident_incidents__incident_id__future_incidents_get 3 params → 200422
GET
/incidents/{incident_id}/workflows
Get Incident Workflows
get_incident_workflows_incidents__incident_id__workflows_get 3 params → 200422
POST
/incidents/event/{provider_type}
Receive Event
receive_event_incidents_event__provider_type__post 2 params → 202422
POST
/incidents/{incident_id}/status
Change Incident Status
change_incident_status_incidents__incident_id__status_post 1 param body → 200422
POST
/incidents/{incident_id}/comment
Add Comment
add_comment_incidents__incident_id__comment_post 1 param body → 200422
POST
/incidents/ai/suggest
Create With Ai
create_with_ai_incidents_ai_suggest_post body → 202422
POST
/incidents/ai/{suggestion_id}/commit
Commit With Ai
commit_with_ai_incidents_ai__suggestion_id__commit_post 1 param body → 202422
POST
/incidents/{incident_id}/confirm
Confirm Incident
confirm_incident_incidents__incident_id__confirm_post 1 param → 200422

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are AlertWithIncidentLinkMetadataDto (32 properties), AlertDto (31 properties), IncidentDto (23 properties), WorkflowDTO (19 properties). Each schema is shown below with its type and property counts.

AlertAudit
object
7 properties 5 required
IncidentDto
object
23 properties 7 required
ValidationError
object
3 properties 3 required
MergeIncidentsResponseDto
object
5 properties 5 required
WorkflowExecutionsPaginatedResultsDto
object
8 properties 2 required
ProviderDTO
object
4 properties 3 required
AlertStatus
An enumeration.
IncidentsPaginatedResultsDto
object
4 properties 2 required
WorkflowExecutionDTO
object
10 properties 5 required
IncidentCommit
object
4 properties 3 required
AlertSeverity
An enumeration.
IncidentStatus
An enumeration.
IncidentListFilterParamsDto
object
5 properties 3 required
HTTPValidationError
object
1 property
WorkflowDTO
object
19 properties 5 required
IncidentDtoIn
object
4 properties
IncidentSorting
An enumeration.
AlertWithIncidentLinkMetadataPaginatedResultsDto
object
4 properties 2 required
AlertDto
object
31 properties 4 required
IncidentSeverity
An enumeration.
MergeIncidentsRequestDto
object
2 properties 2 required
IncidentStatusChangeDto
object
2 properties 1 required
WorkflowExecutionLogsDTO
object
4 properties 3 required
AlertWithIncidentLinkMetadataDto
object
32 properties 4 required
IncidentsClusteringSuggestion
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keep-incidents-api-openapi.yml Raw ↑

Other APIs Keep publishes across the network.

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