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

The workflows API from Keep — 11 operation(s) for workflows.

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

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

This API exposes 14 operations across 11 paths, and defines 11 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.

14 operations 11 paths 11 schemas 1 DELETE8 GET4 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 workflows 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 14

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

workflows 14
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 11

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

Body_run_workflow_from_definition_workflows_test_post
object
1 property
HTTPValidationError
object
1 property
WorkflowDTO
object
19 properties 5 required
Body_create_workflow_workflows_post
object
1 property 1 required
WorkflowExecutionDTO
object
10 properties 5 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
WorkflowExecutionLogsDTO
object
4 properties 3 required
WorkflowCreateOrUpdateDTO
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keep-workflows-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 incidents API
Keep Keep API API
Keep maintenance API