Versioning

In this article

    The current Veeam Backup & Replication REST API version and revision are specified in the version field of the root REST API object.

    For example:

    "version": "1.0-rev1"

    You must specify the Veeam Backup & Replication REST API version and revision in each request. The requirement lets you minimize changes in your client application with every REST API update. All requests that use an earlier version or revision are compatible with further updates of the REST API.

    Veeam Backup & Replication REST API implements a combined approach of versioning:

    • Major version is specified in the request path in the following format: v<major_version>.

    The current major version is v1.

    • Version and revision are specified in the request header in the following format: <version>-<revision>.

    The current version and revision is 1.0-rev1.

    VersioningExample

    To obtain current date and time on the backup server, send the HTTP GET request to the api/<major_version>/serverTime path. In the x-api-version header, specify a version and revision in the following format: <version>-<revision>.

    Request

    GET https://enterprise01.tech.local:9419/api/v1/serverTime

     

    Request Header

    x-api-version:1.0-rev1

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.