Apidog API
    Apidog API
    • Introduction
    • API Versions
    • Authentication
    • Import & Export
      • Import OpenAPI/Swagger Data
        POST
      • Import Postman Collection Data
        POST
      • Export Data in OpenAPI/Swagger Format
        POST

    API Versions

    Learn how to specify the API version when requesting the REST API.

    About API Versioning#

    The Apidog REST API is versioned. The API version name is based on the release date of each version. For example, the API version 2024-03-28 was released on 28 Mar 2024.
    Any breaking changes will be released in a new API version. Breaking changes are changes that can potentially break an integration. Breaking changes include:
    Removing an entire operation
    Removing or renaming parameters
    Removing or renaming response fields
    Adding new required parameters
    Making a Previously Optional Parameter Required
    Removing Enum Values
    Adding a New Validation Rule to an Existing Parameter
    Changing Authentication or Authorization Requirements
    Any additive (non-breaking) changes will be available in all supported API versions. Additive changes are changes that should not break an integration. Additive changes include:
    Adding an Operation
    Adding an Optional Parameter
    Adding an Optional Request Header
    Adding a Response Field
    Adding a Response Header
    Adding Enum Values
    When a new API version is released, the previous API version will be supported for at least 3 more months following the release of the new API version.

    Specifying an API version#

    Please use the X-Apidog-Api-Version header to specify an API version. For example:
    CAUTION
    If the specified API version is no longer supported or not included in the request, a 422 error will be returned.

    Supported API Versions#

    The following API versions are currently supported:
    2024-03-28
    Modified at 2024-05-15 10:19:03
    Previous
    Introduction
    Next
    Authentication
    Built with