OwlProxy OpenAPI 3.1 Specification

This document provides access to the OwlProxy OpenAPI 3.1 specification file, for consumption by AI assistants, large models, code generation tools, and automation scripts. The specification content is exactly the same as the site's "API Documentation" OpenAPI.md, just in machine-readable OpenAPI format.

📥 Download OpenAPI Specification File - Suitable for Direct Import to Postman, Swagger Editor, AI Tools, etc.

How to get:

  • Browser Download: Click to download openapi.yaml, or visit: https://api.owlproxy.com/owlproxy/doc/en/server/openapi.yaml If the browser opens directly instead of downloading, right-click the link and select "Save As".
  • Command Line: curl https://api.owlproxy.com/owlproxy/doc/en/server/openapi.yaml -o owlproxy-openapi.yaml
  • Direct Reference: Use the above URL directly in Postman, Swagger Editor, AI and other tools to import

Full Specification

The following is the full OpenAPI 3.1 specification. You can copy directly from this page or download the file via the link above.

openapi: 3.1.0
info:
  title: OwlProxy OpenAPI
  description: |
    OwlProxy Proxy Service OpenAPI Specification, for consumption by AI/Large Models/Code Assistants and automation tools.
    Interface descriptions, request/response parameters and business semantics are subject to the site's "API Documentation" OpenAPI.md;
    For authentication and signature, see OpenAPI.md.
  version: "1.0.0"

servers:
  - url: https://api.owlproxy.com
    description: OwlProxy API Server

security:
  - OwlProxyHMAC: []

tags:
  - name: Static IP Service
  - name: Dynamic Proxy Service
  - name: Callback Management

paths:
  /owlproxy/proxy/type:
    get:
      tags:
        - Static IP Service
      summary: Get Proxy Type
      operationId: owlproxy_proxy_type_get
      description: |
        Get list of supported proxy types
      responses:
        "200":
          description: Returns JSON on success, structure is { code, msg, ts, data }, code=200 indicates success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/static/region:
    get:
      tags:
        - Static IP Service
      summary: Get Static IP Regions
      operationId: owlproxy_static_region_get
      description: |
        Get list of regions supported by static IP
      responses:
        "200":
          description: Returns JSON on success, structure is { code, msg, ts, data }, code=200 indicates success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/static/quality:
    get:
      tags:
        - Static IP Service
      summary: Get Static IP Quality Options
      operationId: owlproxy_static_quality_get
      description: |
        Get static IP quality options
      responses:
        "200":
          description: Returns JSON on success, structure is { code, msg, ts, data }, code=200 indicates success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/static/provider:
    get:
      tags:
        - Static IP Service
      summary: Get Static IP Service Provider
      operationId: owlproxy_static_provider_get
      description: |
        Get list of static IP service providers
      responses:
        "200":
          description: Returns JSON on success, structure is { code, msg, ts, data }, code=200 indicates success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/static/package:
    get:
      tags:
        - Static IP Service
      summary: Get Static IP Package
      operationId: owlproxy_static_package_get
      description: |
        Get list of static IP packages
      parameters:
        - name: region
          in: query
          description: Region code
          schema:
            type: string
        - name: provider
          in: query
          description: Service provider code
          schema:
            type: string
        - name: quality
          in: query
          description: Quality level
          schema:
            type: string
      responses:
        "200":
          description: Returns JSON on success, structure is { code, msg, ts, data }, code=200 indicates success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/static/order:
    post:
      tags:
        - Static IP Service
      summary: Purchase Static IP Package
      operationId: owlproxy_static_order_post
      description: |
        Purchase static IP package
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: See OpenAPI.md for this interface request Body/parameter table
      responses:
        "200":
          description: Returns JSON on success, structure is { code, msg, ts, data }, code=200 indicates success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/static/ipinfo:
    post:
      tags:
        - Static IP Service
      summary: Get IP Information by Order ID
      operationId: owlproxy_static_ipinfo_post
      description: |
        Get IP information by order ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: See OpenAPI.md for this interface request Body/parameter table
      responses:
        "200":
          description: Returns JSON on success, structure is { code, msg, ts, data }, code=200 indicates success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/static/list:
    post:
      tags:
        - Static IP Service
      summary: Get Static IP List
      operationId: owlproxy_static_list_post
      description: |
        Get user's static IP list
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: See OpenAPI.md for this interface request Body/parameter table
      responses:
        "200":
          description: Returns JSON on success, structure is { code, msg, ts, data }, code=200 indicates success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/static/remark:
    post:
      tags:
        - Static IP Service
      summary: Modify Static IP Remarks
      operationId: owlproxy_static_remark_post
      description: |
        Modify static IP remarks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: See OpenAPI.md for this interface request Body/parameter table
      responses:
        "200":
          description: Returns JSON on success, structure is { code, msg, ts, data }, code=200 indicates success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/static/renew:
    post:
      tags:
        - Static IP Service
      summary: Renew Static IP
      operationId: owlproxy_static_renew_post
      description: |
        Renew static IP
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: See OpenAPI.md for this interface request Body/parameter table
      responses:
        "200":
          description: Returns JSON on success, structure is { code, msg, ts, data }, code=200 indicates success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /openApi/vcProxy/batchCalculateRenewPrice:
    post:
      tags:
        - Static IP Service
      summary: Batch Calculate Renewal Price
      operationId: owlproxy_batchCalculateRenewPrice_post
      description: |
        Batch calculate renewal price for multiple IPs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: See OpenAPI.md for request Body parameters
      responses:
        "200":
          description: Successful response returns JSON, structure is { code, msg, ts, data }, code=200 indicates success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/static/autoRenew:
    post:
      tags:
        - Static IP Service
      summary: Set Static IP Auto-Renewal
      operationId: owlproxy_static_autoRenew_post
      description: |
        Set static IP auto-renewal
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: See OpenAPI.md for this interface request Body/parameter table
      responses:
        "200":
          description: Returns JSON on success, structure is { code, msg, ts, data }, code=200 indicates success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/static/orderList:
    post:
      tags:
        - Static IP Service
      summary: Static IP Order List
      operationId: owlproxy_static_orderList_post
      description: |
        Get static IP order list
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: See OpenAPI.md for this interface request Body/parameter table
      responses:
        "200":
          description: Returns JSON on success, structure is { code, msg, ts, data }, code=200 indicates success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/dynamic/balance:
    get:
      tags:
        - Dynamic Proxy Service
      summary: Query Dynamic Traffic Balance
      operationId: owlproxy_dynamic_balance_get
      description: |
        Query current traffic balance for dynamic proxy
      responses:
        "200":
          description: Returns JSON on success, structure is { code, msg, ts, data }, code=200 indicates success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/dynamic/package:
    get:
      tags:
        - Dynamic Proxy Service
      summary: Get Dynamic IP Package
      operationId: owlproxy_dynamic_package_get
      description: |
        Get list of dynamic IP packages
      parameters:
        - name: region
          in: query
          description: Region code
          schema:
            type: string
      responses:
        "200":
          description: Returns JSON on success, structure is { code, msg, ts, data }, code=200 indicates success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/dynamic/order:
    post:
      tags:
        - Dynamic Proxy Service
      summary: Purchase Dynamic IP Package
      operationId: owlproxy_dynamic_order_post
      description: |
        Purchase dynamic IP package
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: See OpenAPI.md for this interface request Body/parameter table
      responses:
        "200":
          description: Returns JSON on success, structure is { code, msg, ts, data }, code=200 indicates success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/dynamic/region:
    get:
      tags:
        - Dynamic Proxy Service
      summary: Get Dynamic IP Extraction Region
      operationId: owlproxy_dynamic_region_get
      description: |
        Get list of dynamic IP extraction regions
      responses:
        "200":
          description: Returns JSON on success, structure is { code, msg, ts, data }, code=200 indicates success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/dynamic/line:
    get:
      tags:
        - Dynamic Proxy Service
      summary: Get Dynamic IP Extraction Line
      operationId: owlproxy_dynamic_line_get
      description: |
        Get dynamic IP extraction line
      parameters:
        - name: region
          in: query
          description: Region code
          schema:
            type: string
      responses:
        "200":
          description: Returns JSON on success, structure is { code, msg, ts, data }, code=200 indicates success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/dynamic/extract:
    post:
      tags:
        - Dynamic Proxy Service
      summary: Extract Dynamic IP
      operationId: owlproxy_dynamic_extract_post
      description: |
        Extract dynamic IP
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: See OpenAPI.md for this interface request Body/parameter table
      responses:
        "200":
          description: Returns JSON on success, structure is { code, msg, ts, data }, code=200 indicates success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/dynamic/autoRenewOrder:
    post:
      tags:
        - Dynamic Proxy Service
      summary: Dynamic IP Auto-Renewal Orders
      operationId: owlproxy_dynamic_autoRenewOrder_post
      description: |
        Get dynamic IP auto-renewal orders
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: See OpenAPI.md for this interface request Body/parameter table
      responses:
        "200":
          description: Returns JSON on success, structure is { code, msg, ts, data }, code=200 indicates success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/dynamic/setAutoRenew:
    post:
      tags:
        - Dynamic Proxy Service
      summary: Set Dynamic IP Auto-Renewal
      operationId: owlproxy_dynamic_setAutoRenew_post
      description: |
        Set dynamic IP auto-renewal
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: See OpenAPI.md for this interface request Body/parameter table
      responses:
        "200":
          description: Returns JSON on success, structure is { code, msg, ts, data }, code=200 indicates success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/dynamic/orderList:
    post:
      tags:
        - Dynamic Proxy Service
      summary: Dynamic IP Order List
      operationId: owlproxy_dynamic_orderList_post
      description: |
        Get dynamic IP order list
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: See OpenAPI.md for this interface request Body/parameter table
      responses:
        "200":
          description: Returns JSON on success, structure is { code, msg, ts, data }, code=200 indicates success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"

components:
  securitySchemes:
    OwlProxyHMAC:
      type: http
      scheme: custom
      description: |
        HMAC-SHA256 signature verification. Request headers must include:
        x-date (UTC time ISO 8601), x-host (api.owlproxy.com),
        Content-Type (application/json), authorization (HMAC-SHA256 signature).
        Signature format: HMAC-SHA256 Credential={AccessKey}, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature={Signature}
        For calculation steps, see OpenAPI.md.
  schemas:
    ApiResponse:
      type: object
      properties:
        code:
          type: integer
          description: Business code, 200 indicates success
        msg:
          type: string
          description: Message
        ts:
          type: integer
          description: Timestamp
        data:
          description: Business data, structure see OpenAPI.md for each interface response parameters

Specification Content Description

  • Interface Scope: Consistent with the interface overview in OpenAPI.md, including all interfaces for Static IP Service, Dynamic Proxy Service, and Callback Management.
  • Request/Response Semantics: Paths, methods, summaries, and parameter names are consistent with corresponding interfaces in OpenAPI.md; for detailed parameter types, whether required, examples, etc., refer to OpenAPI.md.
  • Authentication Method: Globally uses HMAC-SHA256 signature (request headers x-date, x-host, Content-Type, authorization), for calculation method see the site's OpenAPI.md.

Usage Suggestions

  1. AI / Large Models: Provide the above openapi.yaml URL or content to AI, facilitating generation of call examples, parameter descriptions, or SDK code.
  2. Code Generation: When using OpenAPI code generators (such as OpenAPI Generator), use this YAML as input, and combine with site documentation to understand business semantics and error codes.
  3. Debugging and Testing: Can be imported into tools like Postman, Insomnia; authentication needs to be implemented by yourself for HMAC-SHA256, refer to OpenAPI.md.

Prev LLMs.txt (AI Quick Reference)  |  Next Error Codes