openapi: 3.2.0
info:
  title: Hostfully Version API
  license:
    name: Apache 2.0
    url: https://www.hostfully.com/
  version: v3.0.1
servers:
- url: https://sandbox-api.hostfully.com
security:
- JWT-Authentication: []
- Agency-API-key: []
tags:
- name: Version
paths:
  /api/version/{newApiVersion}:
    put:
      tags:
      - Version
      summary: Update API version
      description: Use this endpoint to upgrade your API version. Upgrades are incremental. If for example you’re on V3, you must migrate to V3.1 before moving to V3.2.
      operationId: updateApiVersion
      parameters:
      - name: newApiVersion
        in: path
        required: true
        schema:
          type: string
          enum:
          - V2
          - V2_OR_V3
          - V3
          - V3_1
          - V3_2
          - V3_3
          - ALL
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/MigrationResponseDto'
  /api/version:
    get:
      tags:
      - Version
      summary: Get API version
      description: Endpoint to retrieve your current API version.
      operationId: currentApiVersion
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiVersionDto'
components:
  schemas:
    ApiVersionDto:
      type: object
      properties:
        apiVersion:
          type: string
          enum:
          - V2
          - V2_OR_V3
          - V3
          - V3_1
          - V3_2
          - V3_3
          - ALL
    MigrationResponseDto:
      type: object
      properties:
        message:
          type: string
  securitySchemes:
    JWT-Authentication:
      type: apiKey
      description: OAuth Access Token
      name: Authorization
      in: header
    Agency-API-key:
      type: apiKey
      description: API Key
      name: X-HOSTFULLY-APIKEY
      in: header
externalDocs:
  description: Hostfully Documentation
  url: https://dev.hostfully.com/v3.0/reference
x-readme:
  explorer-enabled: true
  proxy-enabled: true