AbuseIPDB Check OpenAPI Spec

openapi.yml

openapi: 3.0.3
info:
  title: AbuseIPDB API
  version: "v2"
servers:
  - url: https://api.abuseipdb.com/api/v2
paths:
  /check:
    get:
      operationId: checkIp
      summary: Check an IP address against the AbuseIPDB database
      description: Retrieves abuse reports for a given IP address.
      parameters:
        - name: ipAddress
          in: query
          description: The IP address to check
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response with abuse report details
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: object
                    $ref: '#/components/schemas/AbuseReport'
        '401':
          description: Authentication failed
components:
  securitySchemes:
      ApiKeyAuth:
        type: apiKey
        in: header
        name: Key
  schemas:
    AbuseReport:
      type: object
      properties:
        data:
          type: object
          properties:
            ipAddress:
              type: string
              example: "118.25.6.39"
            isPublic:
              type: string
              example: true
            ipVersion:
              type: string
              example: 4
            isWhitelisted:
              type: string
              example: false
            abuseConfidenceScore:
              type: string
              example: 100
            countryCode:
              type: string
              example: "CN"
            countryName:
              type: string
              example: "China"
            usageType:
              type: string
              example: "Data Center/Web Hosting/Transit"
            isp:
              type: string
              example: "Tencent Cloud Computing (Beijing) Co. Ltd"
            domain:
              type: string
              example: "tencent.com"
            hostnames:
              type: string
              example: []
            isTor:
              type: string
              example: false
            totalReports:
              type: string
              example: 1
            numDistinctUsers:
              type: string
              example: 1
            lastReportedAt:
              type: string
              example: "2018-12-20T20:55:14+00:00"