SolarWinds Checks API

openapi: 3.1.0
info:
  title: SolarWinds Loggly Account Checks 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: Checks
  description: Manage uptime and transaction checks
paths:
  /checks:
    get:
      operationId: listChecks
      summary: Solarwinds List All Checks
      description: Returns a list of all checks configured in the Pingdom account.
      tags:
      - Checks
      parameters:
      - name: limit
        in: query
        description: Maximum number of checks to return
        schema:
          type: integer
          default: 25000
        example: 10
      - name: offset
        in: query
        description: Offset for pagination
        schema:
          type: integer
          default: 0
        example: 10
      - name: tags
        in: query
        description: Filter by comma-separated tag names
        schema:
          type: string
        example: example_value
      - name: type
        in: query
        description: Filter by check type
        schema:
          type: string
          enum:
          - http
          - httpcustom
          - tcp
          - ping
          - dns
          - udp
          - smtp
          - pop3
          - imap
        example: http
      responses:
        '200':
          description: List of checks
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckList'
              examples:
                Listchecks200Example:
                  summary: Default listChecks 200 response
                  x-microcks-default: true
                  value:
                    checks:
                    - id: abc123
                      name: Example Title
                      type: http
                      hostname: example_value
                      status: up
                      resolution: 10
                      lastresponsetime: 10
                      lasttesttime: 10
                      created: 10
                      tags: {}
                    counts:
                      total: 10
                      limited: 10
                      filtered: 10
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createCheck
      summary: Solarwinds Create a New Check
      description: Creates a new uptime check with the specified configuration.
      tags:
      - Checks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckCreate'
            examples:
              CreatecheckRequestExample:
                summary: Default createCheck request
                x-microcks-default: true
                value:
                  name: Example Title
                  host: example_value
                  type: http
                  resolution: 1
                  paused: true
                  encryption: true
      responses:
        '200':
          description: Check created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Check'
              examples:
                Createcheck200Example:
                  summary: Default createCheck 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    type: http
                    hostname: example_value
                    status: up
                    resolution: 10
                    lastresponsetime: 10
                    lasttesttime: 10
                    created: 10
                    tags:
                    - name: Example Title
                      type: example_value
                      count: 10
        '400':
          description: Invalid check configuration
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /checks/{checkid}:
    get:
      operationId: getCheck
      summary: Solarwinds Get Detailed Check Information
      description: Returns detailed information about a specific check including its configuration and current status.
      tags:
      - Checks
      parameters:
      - $ref: '#/components/parameters/CheckId'
      responses:
        '200':
          description: Check details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckDetail'
              examples:
                Getcheck200Example:
                  summary: Default getCheck 200 response
                  x-microcks-default: true
                  value:
                    check: example_value
        '401':
          description: Unauthorized
        '404':
          description: Check not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateCheck
      summary: Solarwinds Update a Check
      description: Updates the configuration of an existing check.
      tags:
      - Checks
      parameters:
      - $ref: '#/components/parameters/CheckId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckUpdate'
            examples:
              UpdatecheckRequestExample:
                summary: Default updateCheck request
                x-microcks-default: true
                value:
                  name: Example Title
                  host: example_value
                  resolution: 10
                  paused: true
      responses:
        '200':
          description: Check updated successfully
        '400':
          description: Invalid check configuration
        '401':
          description: Unauthorized
        '404':
          description: Check not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteCheck
      summary: Solarwinds Delete a Check
      description: Permanently deletes a check and all associated data.
      tags:
      - Checks
      parameters:
      - $ref: '#/components/parameters/CheckId'
      responses:
        '200':
          description: Check deleted successfully
        '401':
          description: Unauthorized
        '404':
          description: Check not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CheckDetail:
      type: object
      properties:
        check:
          allOf:
          - $ref: '#/components/schemas/Check'
          - type: object
            properties:
              encryption:
                type: boolean
                description: Use SSL/TLS
              port:
                type: integer
                description: Target port
              sendnotificationwhendown:
                type: integer
                description: Number of failed tests before notification
              notifyagainevery:
                type: integer
                description: Notification repeat interval
              notifywhenbackup:
                type: boolean
                description: Notify when check recovers
          example: example_value
    CheckUpdate:
      type: object
      properties:
        name:
          type: string
          example: Example Title
        host:
          type: string
          example: example_value
        resolution:
          type: integer
          example: 10
        paused:
          type: boolean
          example: true
    Check:
      type: object
      properties:
        id:
          type: integer
          description: Unique check identifier
          example: abc123
        name:
          type: string
          description: Check name
          example: Example Title
        type:
          type: string
          description: Check type
          enum:
          - http
          - httpcustom
          - tcp
          - ping
          - dns
          - udp
          - smtp
          - pop3
          - imap
          example: http
        hostname:
          type: string
          description: Target hostname
          example: example_value
        status:
          type: string
          description: Current check status
          enum:
          - up
          - down
          - unconfirmed_down
          - unknown
          - paused
          example: up
        resolution:
          type: integer
          description: Check interval in minutes
          example: 10
        lastresponsetime:
          type: integer
          description: Last response time in milliseconds
          example: 10
        lasttesttime:
          type: integer
          description: Last test timestamp (Unix)
          example: 10
        created:
          type: integer
          description: Creation timestamp (Unix)
          example: 10
        tags:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              type:
                type: string
              count:
                type: integer
          example: []
    CheckList:
      type: object
      properties:
        checks:
          type: array
          items:
            $ref: '#/components/schemas/Check'
          example: []
        counts:
          type: object
          properties:
            total:
              type: integer
            limited:
              type: integer
            filtered:
              type: integer
          example: example_value
    CheckCreate:
      type: object
      required:
      - name
      - host
      - type
      properties:
        name:
          type: string
          description: Check name
          example: Example Title
        host:
          type: string
          description: Target hostname or IP
          example: example_value
        type:
          type: string
          description: Check type
          enum:
          - http
          - httpcustom
          - tcp
          - ping
          - dns
          - udp
          - smtp
          - pop3
          - imap
          example: http
        resolution:
          type: integer
          description: Check interval in minutes
          enum:
          - 1
          - 5
          - 15
          - 30
          - 60
          example: 1
        paused:
          type: boolean
          description: Whether the check is paused
          example: true
        encryption:
          type: boolean
          description: Use SSL/TLS
          example: true
  parameters:
    CheckId:
      name: checkid
      in: path
      required: true
      description: Unique identifier for the check
      schema:
        type: integer
  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