Keep

opencollection: 1.0.0
info:
  name: Keep API
  version: 0.24.5
items:
- info:
    name: Default
    type: folder
  items:
  - info:
      name: Root
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/'
    docs: App desctiption and version.
- info:
    name: providers
    type: folder
  items:
  - info:
      name: Get Providers
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/providers'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get Providers
  - info:
      name: Get Installed Providers
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/providers/export'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: export all installed providers
  - info:
      name: Get Alerts Configuration
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/providers/:provider_type/:provider_id/configured-alerts'
      params:
      - name: provider_type
        value: ''
        type: path
      - name: provider_id
        value: ''
        type: path
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get alerts configuration from a provider
  - info:
      name: Get Logs
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/providers/:provider_type/:provider_id/logs'
      params:
      - name: provider_type
        value: ''
        type: path
      - name: provider_id
        value: ''
        type: path
      - name: limit
        value: ''
        type: query
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get logs from a provider
  - info:
      name: Get Alerts Schema
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/providers/:provider_type/schema'
      params:
      - name: provider_type
        value: ''
        type: path
    docs: Get the provider's API schema used to push alerts configuration
  - info:
      name: Get Alert Count
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/providers/:provider_type/:provider_id/alerts/count'
      params:
      - name: provider_type
        value: ''
        type: path
      - name: provider_id
        value: ''
        type: path
      - name: ever
        value: ''
        type: query
      - name: start_time
        value: ''
        type: query
      - name: end_time
        value: ''
        type: query
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get number of alerts a specific provider has received (in a specific time time period or ever)
  - info:
      name: Add Alert
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/providers/:provider_type/:provider_id/alerts'
      params:
      - name: provider_type
        value: ''
        type: path
      - name: provider_id
        value: ''
        type: path
      - name: alert_id
        value: ''
        type: query
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Push new alerts to the provider
  - info:
      name: Test Provider
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/providers/test'
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Test a provider's alert retrieval
  - info:
      name: Delete Provider
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/providers/:provider_type/:provider_id'
      params:
      - name: provider_type
        value: ''
        type: path
      - name: provider_id
        value: ''
        type: path
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Delete Provider
  - info:
      name: Validate Provider Scopes
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/providers/:provider_id/scopes'
      params:
      - name: provider_id
        value: ''
        type: path
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Validate provider scopes
  - info:
      name: Update Provider
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/providers/:provider_id'
      params:
      - name: provider_id
        value: ''
        type: path
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Update provider
  - info:
      name: Install Provider
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/providers/install'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Install Provider
  - info:
      name: Install Provider Oauth2
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/providers/install/oauth2/:provider_type'
      params:
      - name: provider_type
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Install Provider Oauth2
  - info:
      name: Invoke Provider Method
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/providers/:provider_id/invoke/:method'
      params:
      - name: provider_id
        value: ''
        type: path
      - name: method
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Invoke provider special method
  - info:
      name: Install Provider Webhook
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/providers/install/webhook/:provider_type/:provider_id'
      params:
      - name: provider_type
        value: ''
        type: path
      - name: provider_id
        value: ''
        type: path
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Install Provider Webhook
  - info:
      name: Get Webhook Settings
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/providers/:provider_type/webhook'
      params:
      - name: provider_type
        value: ''
        type: path
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get Webhook Settings
- info:
    name: actions
    type: folder
  items:
  - info:
      name: Get Actions
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/actions'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get all actions
  - info:
      name: Create Actions
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/actions'
      body:
        type: multipart-form
        data: []
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Create new actions by uploading a file
  - info:
      name: Put Action
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/actions/:action_id'
      params:
      - name: action_id
        value: ''
        type: path
      body:
        type: multipart-form
        data: []
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Update an action
  - info:
      name: Delete Action
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/actions/:action_id'
      params:
      - name: action_id
        value: ''
        type: path
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Delete an action
- info:
    name: healthcheck
    type: folder
  items:
  - info:
      name: Healthcheck
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/healthcheck'
    docs: simple healthcheck endpoint
- info:
    name: alerts
    type: folder
  items:
  - info:
      name: Get All Alerts
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/alerts'
      params:
      - name: limit
        value: ''
        type: query
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get last alerts occurrence
  - info:
      name: Delete Alert
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/alerts'
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Delete alert by finerprint and last received time
  - info:
      name: Get Alert History
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/alerts/:fingerprint/history'
      params:
      - name: fingerprint
        value: ''
        type: path
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get alert history
  - info:
      name: Assign Alert
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/alerts/:fingerprint/assign/:last_received'
      params:
      - name: fingerprint
        value: ''
        type: path
      - name: last_received
        value: ''
        type: path
      - name: unassign
        value: ''
        type: query
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Assign alert to user
  - info:
      name: Receive Generic Event
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/alerts/event'
      params:
      - name: fingerprint
        value: ''
        type: query
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Receive a generic alert event
  - info:
      name: Webhook Challenge
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/alerts/event/netdata'
    docs: Helper function to complete Netdata webhook challenge
  - info:
      name: Receive Event
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/alerts/event/:provider_type'
      params:
      - name: provider_type
        value: ''
        type: path
      - name: provider_id
        value: ''
        type: query
      - name: fingerprint
        value: ''
        type: query
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Receive an alert event from a provider
  - info:
      name: Get Alert
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/alerts/:fingerprint'
      params:
      - name: fingerprint
        value: ''
        type: path
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get alert by fingerprint
  - info:
      name: Enrich Alert
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/alerts/enrich'
      params:
      - name: dispose_on_new_alert
        value: ''
        type: query
        description: Dispose on new alert
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Enrich an alert
  - info:
      name: Unenrich Alert
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/alerts/unenrich'
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Un-Enrich an alert
  - info:
      name: Search Alerts
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/alerts/search'
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Search alerts
  - info:
      name: Get Multiple Fingerprint Alert Audit
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/alerts/audit'
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get alert timeline audit trail for multiple fingerprints
  - info:
      name: Get Alert Audit
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/alerts/:fingerprint/audit'
      params:
      - name: fingerprint
        value: ''
        type: path
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get alert timeline audit trail
  - info:
      name: Get Alert Quality
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/alerts/quality/metrics'
      params:
      - name: fields
        value: ''
        type: query
      - name: time_stamp
        value: ''
        type: query
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get alert quality
- info:
    name: incidents
    type: folder
  items:
  - info:
      name: Get All Incidents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/incidents'
      params:
      - name: confirmed
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
      - name: offset
        value: ''
        type: query
      - name: sorting
        value: ''
        type: query
      - name: status
        value: ''
        type: query
      - name: severity
        value: ''
        type: query
      - name: assignees
        value: ''
        type: query
      - name: sources
        value: ''
        type: query
      - name: affected_services
        value: ''
        type: query
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get last incidents
  - info:
      name: Create Incident
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/incidents'
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Create new incident
  - info:
      name: Get Incidents Meta
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/incidents/meta'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get incidents' metadata for filtering
  - info:
      name: Get Incident
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/incidents/:incident_id'
      params:
      - name: incident_id
        value: ''
        type: path
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get incident by id
  - info:
      name: Update Incident
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/incidents/:incident_id'
      params:
      - name: incident_id
        value: ''
        type: path
      - name: generatedByAi
        value: ''
        type: query
        description: Whether the incident update request was generated by AI
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Update incident by id
  - info:
      name: Delete Incident
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/incidents/:incident_id'
      params:
      - name: incident_id
        value: ''
        type: path
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Delete incident by incident id
  - info:
      name: Merge Incidents
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/incidents/merge'
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Merge incidents
  - info:
      name: Get Incident Alerts
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/incidents/:incident_id/alerts'
      params:
      - name: incident_id
        value: ''
        type: path
      - name: limit
        value: ''
        type: query
      - name: offset
        value: ''
        type: query
      - name: include_unlinked
        value: ''
        type: query
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get incident alerts by incident incident id
  - info:
      name: Add Alerts To Incident
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/incidents/:incident_id/alerts'
      params:
      - name: incident_id
        value: ''
        type: path
      - name: is_created_by_ai
        value: ''
        type: query
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Add alerts to incident
  - info:
      name: Delete Alerts From Incident
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/incidents/:incident_id/alerts'
      params:
      - name: incident_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Delete alerts from incident
  - info:
      name: Get Future Incidents For An Incident
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/incidents/:incident_id/future_incidents'
      params:
      - name: incident_id
        value: ''
        type: path
      - name: limit
        value: ''
        type: query
      - name: offset
        value: ''
        type: query
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get same incidents linked to this one
  - info:
      name: Get Incident Workflows
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/incidents/:incident_id/workflows'
      params:
      - name: incident_id
        value: ''
        type: path
      - name: limit
        value: ''
        type: query
      - name: offset
        value: ''
        type: query
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get incident workflows by incident id
  - info:
      name: Receive Event
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/incidents/event/:provider_type'
      params:
      - name: provider_type
        value: ''
        type: path
      - name: provider_id
        value: ''
        type: query
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Receive an alert event from a provider
  - info:
      name: Change Incident Status
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/incidents/:incident_id/status'
      params:
      - name: incident_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Change incident status
  - info:
      name: Add Comment
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/incidents/:incident_id/comment'
      params:
      - name: incident_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Add incident audit activity
  - info:
      name: Create With Ai
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/incidents/ai/suggest'
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Create incident with AI
  - info:
      name: Commit With Ai
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/incidents/ai/:suggestion_id/commit'
      params:
      - name: suggestion_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Commit incidents with AI and user feedback
  - info:
      name: Confirm Incident
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/incidents/:incident_id/confirm'
      params:
      - name: incident_id
        value: ''
        type: path
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Confirm predicted incident by id
- info:
    name: settings
    type: folder
  items:
  - info:
      name: Webhook Settings
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/settings/webhook'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get details about the webhook endpoint (e.g. the API url and an API key)
  - info:
      name: Get Smtp Settings
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/settings/smtp'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get SMTP settings
  - info:
      name: Update Smtp Settings
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/settings/smtp'
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Install or update SMTP settings
  - info:
      name: Delete Smtp Settings
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/settings/smtp'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Delete SMTP settings
  - info:
      name: Test Smtp Settings
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/settings/smtp/test'
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Test SMTP settings
  - info:
      name: Create Key
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/settings/apikey'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Create API key
  - info:
      name: Update Api Key
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/settings/apikey'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Update API key secret
  - info:
      name: Get Keys
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/settings/apikeys'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get API keys
  - info:
      name: Delete Api Key
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/settings/apikey/:keyId'
      params:
      - name: keyId
        value: ''
        type: path
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Delete API key
  - info:
      name: Get Sso Settings
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/settings/sso'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get Sso Settings
- info:
    name: workflows
    type: folder
  items:
  - info:
      name: Get Workflows
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/workflows'
      params:
      - name: is_v2
        value: ''
        type: query
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get workflows
  - info:
      name: Create Workflow
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/workflows'
      body:
        type: multipart-form
        data: []
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Create or update a workflow
  - info:
      name: Export Workflows
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/workflows/export'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: export all workflow Yamls
  - info:
      name: Run Workflow
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/workflows/:workflow_id/run'
      params:
      - name: workflow_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Run a workflow
  - info:
      name: Run Workflow From Definition
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/workflows/test'
      body:
        type: multipart-form
        data: []
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Test run a workflow from a definition
  - info:
      name: Create Workflow From Body
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/workflows/json'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Create or update a workflow
  - info:
      name: Get Random Workflow Templates
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/workflows/random-templates'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get random workflow templates
  - info:
      name: Get Workflow By Id
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/workflows/:workflow_id'
      params:
      - name: workflow_id
        value: ''
        type: path
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get workflow by ID
  - info:
      name: Update Workflow By Id
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/workflows/:workflow_id'
      params:
      - name: workflow_id
        value: ''
        type: path
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Update a workflow
  - info:
      name: Delete Workflow By Id
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/workflows/:workflow_id'
      params:
      - name: workflow_id
        value: ''
        type: path
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Delete workflow
  - info:
      name: Get Raw Workflow By Id
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/workflows/:workflow_id/raw'
      params:
      - name: workflow_id
        value: ''
        type: path
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get workflow executions by ID
  - info:
      name: Get Workflow Executions By Alert Fingerprint
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/workflows/executions'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get workflow executions by alert fingerprint
  - info:
      name: Get Workflow By Id
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/workflows/:workflow_id/runs'
      params:
      - name: workflow_id
        value: ''
        type: path
      - name: tab
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
      - name: offset
        value: ''
        type: query
      - name: status
        value: ''
        type: query
      - name: trigger
        value: ''
        type: query
      - name: execution_id
        value: ''
        type: query
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get workflow executions by ID
  - info:
      name: Get Workflow Execution Status
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/workflows/:workflow_id/runs/:workflow_execution_id'
      params:
      - name: workflow_execution_id
        value: ''
        type: path
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get a workflow execution status
- info:
    name: whoami
    type: folder
  items:
  - info:
      name: Get Tenant Id
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/whoami'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get tenant id
- info:
    name: pusher
    type: folder
  items:
  - info:
      name: Pusher Authentication
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/pusher/auth'
      body:
        type: form-urlencoded
        data: []
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: "Authenticate a user to a private channel\n\nArgs:\n    request (Request): The request object\n    tenant_id (str,\
      \ optional): The tenant ID. Defaults to Depends(verify_bearer_token).\n    pusher_client (Pusher, optional): Pusher\
      \ client. Defaults to Depends(get_pusher_client).\n\nRaises:\n    HTTPException: 403 if the user is not allowed to access\
      \ the channel.\n\nReturns:\n    dict: The authentication response."
- info:
    name: status
    type: folder
  items:
  - info:
      name: Status
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/status'
    docs: simple status endpoint
- info:
    name: rules
    type: folder
  items:
  - info:
      name: Get Rules
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/rules'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Get Rules
  - info:
      name: Create Rule
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/rules'
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Create Rule
  - info:
      name: Update Rule
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/rules/:rule_id'
      params:
      - name: rule_id
        value: ''
        type: path
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Update Rule
  - info:
      name: Delete Rule
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/rules/:rule_id'
      params:
      - name: rule_id
        value: ''
        type: path
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs: Delete Rule
- info:
    name: preset
    type: folder
  items:
  - info:
      name: Get Presets
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/preset'
      params:
      - name: time_stamp
        value: ''
        type: query
      auth:
        type: apikey
        key: X-API-KEY
        value: '{{X-API-KEY}}'
        placement: header
    docs

# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/keep/refs/heads/main/apis.yml