Chronosphere LogScaleAction API

openapi: 3.0.1
info:
  title: Config V1 Bucket LogScaleAction API
  description: '

    The Config API provides standard HTTP/JSON REST endpoints for creating, reading,

    updating, deleting, and listing configurable Chronosphere resources.


    Use this link to download the raw Swagger specification:

    <a href="/api/v1/config/swagger.json">/api/v1/config/swagger.json</a>

    '
  version: v1
servers:
- url: /
tags:
- name: LogScaleAction
paths:
  /api/v1/config/log-scale-actions:
    get:
      tags:
      - LogScaleAction
      operationId: ListLogScaleActions
      parameters:
      - name: page.max_size
        in: query
        description: 'Page size preference (i.e. how many items are returned in the next

          page). If zero, the server will use a default. Regardless of what size

          is given, clients must never assume how many items will be returned.'
        schema:
          type: integer
          format: int64
      - name: page.token
        in: query
        description: 'Opaque page token identifying which page to request. An empty token

          identifies the first page.'
        schema:
          type: string
      - name: slugs
        in: query
        description: Filters results by slug, where any LogScaleAction with a matching slug in the given list (and matches all other filters) is returned.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: names
        in: query
        description: Filters results by name, where any LogScaleAction with a matching name in the given list (and matches all other filters) is returned.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1ListLogScaleActionsResponse'
        '500':
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        default:
          description: An undefined error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/genericError'
    post:
      tags:
      - LogScaleAction
      operationId: CreateLogScaleAction
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/configv1CreateLogScaleActionRequest'
        required: true
      responses:
        '200':
          description: A successful response containing the created LogScaleAction.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1CreateLogScaleActionResponse'
        '400':
          description: Cannot create the LogScaleAction because the request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        '409':
          description: Cannot create the LogScaleAction because there is a conflict with an existing LogScaleAction.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        '500':
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        default:
          description: An undefined error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/genericError'
      x-codegen-request-body-name: body
  /api/v1/config/log-scale-actions/{slug}:
    get:
      tags:
      - LogScaleAction
      operationId: ReadLogScaleAction
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1ReadLogScaleActionResponse'
        '404':
          description: Cannot read the LogScaleAction because the slug does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        '500':
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        default:
          description: An undefined error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/genericError'
    put:
      tags:
      - LogScaleAction
      operationId: UpdateLogScaleAction
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigV1UpdateLogScaleActionBody'
        required: true
      responses:
        '200':
          description: A successful response containing the updated LogScaleAction.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1UpdateLogScaleActionResponse'
        '400':
          description: Cannot update the LogScaleAction because the request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        '404':
          description: Cannot update the LogScaleAction because the slug does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        '409':
          description: Cannot update the LogScaleAction because there is a conflict with an existing LogScaleAction.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        '500':
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        default:
          description: An undefined error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/genericError'
      x-codegen-request-body-name: body
    delete:
      tags:
      - LogScaleAction
      operationId: DeleteLogScaleAction
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1DeleteLogScaleActionResponse'
        '400':
          description: Cannot delete the LogScaleAction because it is in use.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        '404':
          description: Cannot delete the LogScaleAction because the slug does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        '500':
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        default:
          description: An undefined error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/genericError'
components:
  schemas:
    genericError:
      type: object
      additionalProperties: true
    configv1ReadLogScaleActionResponse:
      type: object
      properties:
        log_scale_action:
          $ref: '#/components/schemas/configv1LogScaleAction'
    LogScaleActionSlackPostMessageAction:
      type: object
      properties:
        api_token:
          type: string
          description: API token to authenticate with Slack.
        channels:
          type: array
          description: List of Slack channels to message.
          items:
            type: string
        fields:
          type: object
          additionalProperties:
            type: string
          description: Fields to include within the Slack message. Can be templated with values from the query result.
        use_proxy:
          type: boolean
          description: Defines whether the action should use the configured proxy to make web requests.
    LogScaleActionWebhookAction:
      type: object
      properties:
        method:
          $ref: '#/components/schemas/WebhookActionHTTPMethod'
        url:
          type: string
          description: URL to send the HTTP or HTTPS request to.
        headers:
          type: object
          additionalProperties:
            type: string
          description: Headers of the HTTP or HTTPS request.
        body_template:
          type: string
          description: Body of the HTTP or HTTPS request. Can be templated with values from the query result.
        ignore_ssl:
          type: boolean
          description: Flag indicating whether SSL should be ignored for the request.
        use_proxy:
          type: boolean
          description: Defines whether the action should use the configured proxy to make web requests.
    configv1LogScaleAction:
      type: object
      properties:
        slug:
          type: string
          description: Unique identifier of the LogScaleAction. If a `slug` isn't provided, one will be generated based of the `name` field. You can't modify this field after the LogScaleAction is created.
        repository:
          type: string
          description: Name of the LogScale repository the alerts belongs to. Required.
        name:
          type: string
          description: Name of an action.
        created_at:
          type: string
          description: Timestamp of when the LogScaleAction was created. Cannot be set by clients.
          format: date-time
          readOnly: true
        updated_at:
          type: string
          description: Timestamp of when the LogScaleAction was last updated. Cannot be set by clients.
          format: date-time
          readOnly: true
        action_type:
          $ref: '#/components/schemas/LogScaleActionActionType'
        email_action:
          $ref: '#/components/schemas/LogScaleActionEmailAction'
        humio_action:
          $ref: '#/components/schemas/LogScaleActionHumioRepoAction'
        ops_genie_action:
          $ref: '#/components/schemas/LogScaleActionOpsGenieAction'
        pager_duty_action:
          $ref: '#/components/schemas/LogScaleActionPagerDutyAction'
        slack_action:
          $ref: '#/components/schemas/LogScaleActionSlackAction'
        slack_post_message_action:
          $ref: '#/components/schemas/LogScaleActionSlackPostMessageAction'
        victor_ops_action:
          $ref: '#/components/schemas/LogScaleActionVictorOpsAction'
        webhook_action:
          $ref: '#/components/schemas/LogScaleActionWebhookAction'
        upload_file_action:
          $ref: '#/components/schemas/LogScaleActionUploadFileAction'
    ConfigV1UpdateLogScaleActionBody:
      type: object
      properties:
        log_scale_action:
          $ref: '#/components/schemas/configv1LogScaleAction'
        create_if_missing:
          type: boolean
          description: If true, the LogScaleAction will be created if it does not already exist, identified by slug. If false, an error will be returned if the LogScaleAction does not already exist.
        dry_run:
          type: boolean
          description: If true, the LogScaleAction isn't created or updated, and no response LogScaleAction will be returned. The response will return an error if the given LogScaleAction is invalid.
    LogScaleActionEmailAction:
      type: object
      properties:
        recipients:
          type: array
          description: List of email addresses to send an email to.
          items:
            type: string
        subject_template:
          type: string
          description: Subject of the email. Can be templated with values from the query result.
        body_template:
          type: string
          description: Body of the email. Can be templated with values from the query result.
        attach_csv:
          type: boolean
          description: Whether the result set should be attached as a CSV file.
        use_proxy:
          type: boolean
          description: Defines whether the action should use the configured proxy to make web requests.
    LogScaleActionOpsGenieAction:
      type: object
      properties:
        api_url:
          type: string
          description: OpsGenie webhook URL to send the request to.
        ops_genie_key:
          type: string
          description: Key to authenticate with OpsGenie.
        use_proxy:
          type: boolean
          description: Defines whether the action should use the configured proxy to make web requests.
    WebhookActionHTTPMethod:
      type: string
      enum:
      - GET
      - POST
      - PUT
      - PATCH
      - DELETE
      - HEAD
      - OPTIONS
    configv1DeleteLogScaleActionResponse:
      type: object
    configv1ListLogScaleActionsResponse:
      type: object
      properties:
        page:
          $ref: '#/components/schemas/configv1PageResult'
        log_scale_actions:
          type: array
          items:
            $ref: '#/components/schemas/configv1LogScaleAction'
    apiError:
      type: object
      properties:
        code:
          type: integer
          description: An optional private error code whose values are undefined.
          format: int32
        message:
          type: string
          description: An error message describing what went wrong.
    LogScaleActionPagerDutyAction:
      type: object
      properties:
        severity:
          $ref: '#/components/schemas/PagerDutyActionSeverity'
        routing_key:
          type: string
          description: Routing key to authenticate with PagerDuty.
        use_proxy:
          type: boolean
          description: Defines whether the action should use the configured proxy to make web requests.
    LogScaleActionUploadFileAction:
      type: object
      properties:
        file_name:
          type: string
          description: File name for the uploaded file.
    configv1CreateLogScaleActionRequest:
      type: object
      properties:
        log_scale_action:
          $ref: '#/components/schemas/configv1LogScaleAction'
        dry_run:
          type: boolean
          description: If true, the LogScaleAction isn't created, and no response LogScaleAction will be returned. The response will return an error if the given LogScaleAction is invalid.
    LogScaleActionActionType:
      type: string
      enum:
      - EMAIL
      - HUMIO_REPO
      - OPS_GENIE
      - PAGER_DUTY
      - SLACK
      - SLACK_POST_MESSAGE
      - VICTOR_OPS
      - WEBHOOK
      - UPLOAD_FILE
    configv1PageResult:
      type: object
      properties:
        next_token:
          type: string
          description: 'Opaque page token which identifies the next page of items which the

            client should request. An empty next_token indicates that there are no

            more items to return.'
    LogScaleActionSlackAction:
      type: object
      properties:
        url:
          type: string
          description: Slack webhook URL to send the request to.
        fields:
          type: object
          additionalProperties:
            type: string
          description: Fields to include within the Slack message. Can be templated with values from the query result.
        use_proxy:
          type: boolean
          description: Defines whether the action should use the configured proxy to make web requests.
    configv1UpdateLogScaleActionResponse:
      type: object
      properties:
        log_scale_action:
          $ref: '#/components/schemas/configv1LogScaleAction'
    LogScaleActionHumioRepoAction:
      type: object
      properties:
        ingest_token:
          type: string
          description: Ingest token for the repository that the action should ingest into.
    configv1CreateLogScaleActionResponse:
      type: object
      properties:
        log_scale_action:
          $ref: '#/components/schemas/configv1LogScaleAction'
    LogScaleActionVictorOpsAction:
      type: object
      properties:
        message_type:
          type: string
          description: Type of the VictorOps message to make.
        notify_url:
          type: string
          description: VictorOps webhook URL to send the request to.
        use_proxy:
          type: boolean
          description: Defines whether the action should use the configured proxy to make web requests.
    PagerDutyActionSeverity:
      type: string
      enum:
      - CRITICAL
      - ERROR
      - WARNING
      - INFO
x-original-swagger-version: '2.0'