Versioning

In this article

    Veeam Backup & Replication REST API is backward-compatible. This means that in general client requests that use an earlier version or revision of the REST API are compatible with further REST API updates. You can find the current Veeam Backup & Replication REST API version and revision in the REST API specification. It is specified in the version field of the info object. For example:

    "version": "1.0-rev2"

    The table below lists versions and revisions of the REST API and the Veeam Backup & Replication build numbers when the version and revision were released.

    REST API Version and Revision

    Veeam Backup & Replication Build

    1.0-rev1

    11.0.0.837

    1.0-rev2

    11.0.1.1261

    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.

    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-rev2.

    For example, 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-rev2