openapi: 3.1.0
info:
  title: SolarWinds Loggly Account Events API
  description: RESTful API for cloud-based log management including event submission, event retrieval, search, and account management. Supports sending events over HTTP/S and retrieving log data via paginating event retrieval endpoints.
  version: '2'
  contact:
    name: SolarWinds Support
    url: https://support.solarwinds.com
  termsOfService: https://www.solarwinds.com/legal/terms
servers:
- url: https://{subdomain}.loggly.com/apiv2
  description: Loggly API Server
  variables:
    subdomain:
      default: logs-01
      description: Your Loggly subdomain
security:
- bearerAuth: []
tags:
- name: Events
  description: Search and retrieve log events
paths:
  /events/search.json:
    get:
      operationId: searchEvents
      summary: Solarwinds Search Log Events
      description: Searches log events matching the specified criteria. Returns matching events sorted by timestamp.
      tags:
      - Events
      parameters:
      - name: q
        in: query
        description: Search query string
        schema:
          type: string
        example: example_value
      - name: system_id
        in: query
        description: Limit results to a specific system
        schema:
          type: integer
        example: '500123'
      - name: group_id
        in: query
        description: Limit results to a specific group
        schema:
          type: integer
        example: '500123'
      - name: min_id
        in: query
        description: Return events after this event ID
        schema:
          type: string
        example: '500123'
      - name: max_id
        in: query
        description: Return events before this event ID
        schema:
          type: string
        example: '500123'
      - name: min_time
        in: query
        description: Start time (Unix timestamp)
        schema:
          type: integer
        example: 10
      - name: max_time
        in: query
        description: End time (Unix timestamp)
        schema:
          type: integer
        example: 10
      - name: limit
        in: query
        description: Maximum number of events to return
        schema:
          type: integer
          default: 50
        example: 10
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventSearchResult'
              examples:
                Searchevents200Example:
                  summary: Default searchEvents 200 response
                  x-microcks-default: true
                  value:
                    events:
                    - id: abc123
                      received_at: '2026-01-15T10:30:00Z'
                      generated_at: '2026-01-15T10:30:00Z'
                      display_received_at: '2026-01-15T10:30:00Z'
                      source_ip: example_value
                      source_name: example_value
                      source_id: '500123'
                      hostname: example_value
                      program: example_value
                      severity: example_value
                      facility: example_value
                      message: example_value
                    min_id: '500123'
                    max_id: '500123'
                    reached_beginning: true
                    min_time_at: '2026-01-15T10:30:00Z'
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    EventSearchResult:
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/Event'
          example: []
        min_id:
          type: string
          description: Minimum event ID in results
          example: '500123'
        max_id:
          type: string
          description: Maximum event ID in results
          example: '500123'
        reached_beginning:
          type: boolean
          description: Whether results include the earliest matching event
          example: true
        min_time_at:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
    Event:
      type: object
      properties:
        id:
          type: string
          description: Unique event identifier
          example: abc123
        received_at:
          type: string
          format: date-time
          description: When the event was received
          example: '2026-01-15T10:30:00Z'
        generated_at:
          type: string
          format: date-time
          description: When the event was generated
          example: '2026-01-15T10:30:00Z'
        display_received_at:
          type: string
          description: Human-readable received timestamp
          example: '2026-01-15T10:30:00Z'
        source_ip:
          type: string
          description: Source IP address
          example: example_value
        source_name:
          type: string
          description: Source system name
          example: example_value
        source_id:
          type: integer
          description: Source system ID
          example: '500123'
        hostname:
          type: string
          description: Hostname
          example: example_value
        program:
          type: string
          description: Program name
          example: example_value
        severity:
          type: string
          description: Syslog severity
          example: example_value
        facility:
          type: string
          description: Syslog facility
          example: example_value
        message:
          type: string
          description: Log message content
          example: example_value
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API token for authentication via Authorization Bearer header
    customerToken:
      type: apiKey
      in: path
      name: token
      description: Customer token for event submission endpoints
externalDocs:
  description: Loggly API Documentation
  url: https://documentation.solarwinds.com/en/success_center/loggly/content/admin/api-overview.htm