Keep home page
Search or ask...
Platform
keephq/keep
keephq/keep
Search...
Navigation
workflows
Get Workflow By Id
Overview
Introduction
Playground
Use Cases
Key Concepts
Support
Alerts
Overview
Alert Table
Action Menu
Alert Sidebar
Customized Presets
Sound Notifications
Incidents
Overview
Facets
AIOps
Correlation
Deduplication
Extraction
Mapping
Maintenance Windows
Service Topology
Workflows
Workflow Automation
Overview
Syntax
Examples
Alert Evaluation Engine
Overview
Examples
Providers
Overview
Adding a New Provider
Provider methods
Supported Providers
Deployment
Configuration
Monitoring
Authentication
Provision
Secret Store
Deploy On
Local LLM
Specifications
Development
Getting started
Keep with an external URL
Keep API
providers
actions
healthcheck
topology
alerts
deduplications
maintenance
incidents
settings
workflows
GET
Get Workflows
POST
Create Workflow
GET
Export Workflows
POST
Run Workflow
POST
Run Workflow From Definition
POST
Create Workflow From Body
GET
Get Random Workflow Templates
GET
Get Workflow By Id
GET
Get Workflow By Id
PUT
Update Workflow By Id
DEL
Delete Workflow By Id
GET
Get Raw Workflow By Id
GET
Get Workflow Executions By Alert Fingerprint
GET
Get Workflow Execution Status
GET
Get workflow executions
whoami
pusher
status
rules
preset
enrichment
auth
metrics
users
groups
mappings
dashboard
tags
Keep CLI
Overview
Installation
Sync Keep Workflows With Github Action
Commands
workflows
Get Workflow By Id
Get workflow executions by ID
GET
/
workflows
/
{workflow_id}
/
runs
Try it
Authorizations
API Key
HTTPBasic
OAuth2PasswordBearer
​
X-API-KEY
string
header
required
Path Parameters
​
workflow_id
string
required
Query Parameters
​
tab
integer
default:
1
​
limit
integer
default:
25
​
offset
integer
default:
0
​
status
string[]
​
trigger
string[]
​
execution_id
string
Response
200 - application/json
​
count
integer
required
​
items
object[]
required
Show child attributes
​
items.
id
string
required
​
items.
started
string
required
​
items.
status
string
required
​
items.
triggered_by
string
required
​
items.
workflow_id
string
required
​
items.
error
string
​
items.
execution_time
number
​
items.
logs
object[]
Show child attributes
​
items.logs.
id
integer
required
​
items.logs.
message
string
required
​
items.logs.
timestamp
string
required
​
items.logs.
context
object
​
items.
results
object
​
items.
workflow_name
string
​
avgDuration
number
default:
0
​
failCount
integer
default:
0
​
limit
integer
default:
25
​
offset
integer
default:
0
​
passCount
integer
default:
0
​
workflow
object
Show child attributes
​
workflow.
created_by
string
required
​
workflow.
creation_time
string
required
​
workflow.
id
string
required
​
workflow.
providers
object[]
required
Show child attributes
​
workflow.providers.
installed
boolean
required
​
workflow.providers.
name
string
required
​
workflow.providers.
type
string
required
​
workflow.providers.
id
string
​
workflow.
workflow_raw
string
required
​
workflow.
description
string
default:
Workflow file doesn't contain description
​
workflow.
disabled
boolean
default:
false
​
workflow.
interval
integer
​
workflow.
invalid
boolean
default:
false
​
workflow.
last_execution_started
string
​
workflow.
last_execution_status
string
​
workflow.
last_execution_time
string
​
workflow.
last_executions
object[]
​
workflow.
last_updated
string
​
workflow.
name
string
default:
Workflow file doesn't contain name
​
workflow.
provisioned
boolean
default:
false
​
workflow.
provisioned_file
string
​
workflow.
revision
integer
default:
1
​
workflow.
triggers
object[]
Get Workflow By Id
Update Workflow By Id