ex2-com Ex2 Catalogue API

openapi: 3.2.0
info:
  title: Ex2 Catalogue API
  version: '1'
  summary: Plans, prices and domain names of Ex2, web hosting from Québec.
  description: Read-only, public, no authentication. Prices come from the Ex2 billing system (cached for up to 10 minutes), in the currency asked for, excluding taxes. Fields are added, never renamed or removed. A breaking change comes as a new version (/api/v2); the old one then keeps answering for at least 12 months, with Deprecation and Sunset headers (RFC 9745, RFC 8594) and a notice on the developers page. Errors are RFC 9457 problem details. The same data is available to AI assistants through the MCP server at https://www.ex2.com/mcp.
  termsOfService: https://www.ex2.com/en/terms-and-conditions
  contact:
    name: Ex2 support
    url: https://www.ex2.com/en/support
servers:
- url: https://www.ex2.com
tags:
- name: Ex2 Catalogue API
paths:
  /api/v1:
    get:
      operationId: getApiIndex
      summary: What the API offers
      description: The API's parameters and endpoints, and the product lines with their plan ids.
      parameters:
      - $ref: '#/components/parameters/lang'
      responses:
        '200':
          description: The index.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Index'
        '400':
          description: A parameter is not valid.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: WHMCS (or, for availability, the registry) is unreachable and nothing is cached. Try again in a few minutes.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Ex2 Catalogue API
components:
  schemas:
    Index:
      type: object
      required:
      - name
      - version
      - description
      - documentation
      - mcp_server
      - openapi
      - parameters
      - endpoints
      - product_lines
      properties:
        name:
          type: string
        version:
          type: integer
        description:
          type: string
        documentation:
          type: string
          format: uri
          description: The developers page, in the language asked for.
        mcp_server:
          type: string
          format: uri
        openapi:
          type: string
          format: uri
          description: This document.
        parameters:
          type: object
          additionalProperties:
            type: object
        endpoints:
          type: array
          items:
            type: object
            required:
            - path
            - query
            - description
            properties:
              path:
                type: string
              query:
                type: array
                items:
                  type: string
              description:
                type: string
        product_lines:
          type: array
          items:
            $ref: '#/components/schemas/ProductLine'
    ProductLine:
      type: object
      required:
      - id
      - name
      - url
      - plans
      properties:
        id:
          type: string
          enum:
          - green
          - wordpress
          - divi
          - woocommerce
          - ecommerce
          - cms
          - site-builder
          - n8n
          - email
          - reseller
          - vps
          - dedicated
          - server-management
        name:
          type: string
        url:
          type: string
          format: uri
          description: The product line's page.
        plans:
          type: array
          items:
            type: string
          description: Its plan ids.
    Error:
      type: object
      required:
      - type
      - title
      - status
      - detail
      - code
      - error
      description: RFC 9457 problem details, sent as application/problem+json; error repeats code and detail as the API first gave them.
      properties:
        type:
          type: string
          description: urn:ex2:problem:<code>
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
          description: What to change, in English.
        code:
          type: string
          description: The same code as error.code.
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
              description: Stable, e.g. invalid_currency, unknown_plan, invalid_domain, unsupported_tld, rate_limited, unavailable, whois_unavailable.
            message:
              type: string
              description: What to change, in English.
  parameters:
    lang:
      name: lang
      in: query
      required: false
      description: Language of names, features, specifications and links.
      schema:
        type: string
        enum:
        - en
        - fr
        default: en
externalDocs:
  description: Developers page
  url: https://www.ex2.com/en/developers