Keep actions API

The actions API from Keep — 2 operation(s) for actions.

OpenAPI Specification

keep-actions-api-openapi.yml Raw ↑
openapi: 3.0.2
info:
  title: Keep actions API
  description: Rest API powering https://platform.keephq.dev and friends 🏄‍♀️
  version: 0.24.5
tags:
- name: actions
paths:
  /actions:
    get:
      tags:
      - actions
      summary: Get Actions
      description: Get all actions
      operationId: get_actions_actions_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - API Key: []
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
    post:
      tags:
      - actions
      summary: Create Actions
      description: Create new actions by uploading a file
      operationId: create_actions_actions_post
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_create_actions_actions_post'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - API Key: []
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
  /actions/{action_id}:
    put:
      tags:
      - actions
      summary: Put Action
      description: Update an action
      operationId: put_action_actions__action_id__put
      parameters:
      - required: true
        schema:
          type: string
          title: Action Id
        name: action_id
        in: path
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_put_action_actions__action_id__put'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - API Key: []
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
    delete:
      tags:
      - actions
      summary: Delete Action
      description: Delete an action
      operationId: delete_action_actions__action_id__delete
      parameters:
      - required: true
        schema:
          type: string
          title: Action Id
        name: action_id
        in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - API Key: []
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Body_put_action_actions__action_id__put:
      properties:
        file:
          type: string
          format: binary
          title: File
      type: object
      required:
      - file
      title: Body_put_action_actions__action_id__put
    Body_create_actions_actions_post:
      properties:
        file:
          type: string
          format: binary
          title: File
      type: object
      title: Body_create_actions_actions_post
  securitySchemes:
    API Key:
      type: apiKey
      in: header
      name: X-API-KEY
    HTTPBasic:
      type: http
      scheme: basic
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: token