Wallarm Integrations API

Third-party integrations (SIEM, notifications, etc.)

OpenAPI Specification

wallarm-integrations-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Wallarm Applications Integrations API
  description: The Wallarm API provides programmatic access to the Wallarm API Security Platform. It enables management of attacks, incidents, vulnerabilities, security rules, IP lists, filter nodes, users, integrations, and triggers. The API is available on both US Cloud and EU Cloud endpoints and uses API token authentication.
  version: 4.0.0
  termsOfService: https://www.wallarm.com/terms-of-service
  contact:
    name: Wallarm Support
    url: https://docs.wallarm.com/
    email: support@wallarm.com
  license:
    name: Proprietary
    url: https://www.wallarm.com/terms-of-service
servers:
- url: https://us1.api.wallarm.com
  description: Wallarm US Cloud API
- url: https://api.wallarm.com
  description: Wallarm EU Cloud API
security:
- ApiTokenAuth: []
tags:
- name: Integrations
  description: Third-party integrations (SIEM, notifications, etc.)
paths:
  /v1/objects/integration:
    post:
      operationId: listIntegrations
      summary: List Integrations
      description: Retrieve all configured third-party integrations (Slack, PagerDuty, Splunk, Jira, etc.).
      tags:
      - Integrations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ObjectQueryRequest'
      responses:
        '200':
          description: List of integrations returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationListResponse'
        '401':
          description: Unauthorized
components:
  schemas:
    Integration:
      type: object
      properties:
        id:
          type: integer
          description: Integration identifier
        name:
          type: string
          description: Integration name
        type:
          type: string
          description: Integration type (slack, pagerduty, splunk, etc.)
        enabled:
          type: boolean
          description: Whether integration is active
        created:
          type: integer
          description: Unix timestamp of creation
    ObjectQueryRequest:
      type: object
      properties:
        clientid:
          type: integer
          description: Client ID
        filter:
          type: object
          description: Filter criteria
        limit:
          type: integer
          default: 50
          description: Maximum number of results to return
        offset:
          type: integer
          default: 0
          description: Pagination offset
        order_by:
          type: string
          description: Field to sort results by
        order_desc:
          type: boolean
          default: true
          description: Sort in descending order
    IntegrationListResponse:
      type: object
      properties:
        status:
          type: integer
        body:
          type: array
          items:
            $ref: '#/components/schemas/Integration'
  securitySchemes:
    ApiTokenAuth:
      type: apiKey
      in: header
      name: X-WallarmApi-Token
      description: API token obtained from Wallarm Console under Settings → API Tokens.