Grid Management API versioning

The Grid Management API uses versioning to support non-disruptive upgrades.

For example, this Request URL specifies version 3 of the API.

https://hostname_or_ip_address/api/v3/authorize

Changes in the Grid Management API that are backward incompatible bump the major version of the API. For example, an incompatible API change bumps the version from 2.1 to 3.0. Changes in the Grid Management API that are backward compatible bump the minor version instead. Backward-compatible changes include the addition of new endpoints or new properties. For example, a compatible API change bumps the version from 3.0 to 3.1.

When you install StorageGRID software for the first time, only the most recent version of the Grid Management API is enabled. However, when you upgrade to a new feature release of StorageGRID, you continue to have access to the older API version for at least one StorageGRID feature release.

Note: You can use the Grid Management API to configure the supported versions. See the “config” section of the Swagger API documentation for more information. You should deactivate support for the older version after updating all Grid Management API clients to use the newer version.

Outdated requests are marked as deprecated in the following ways:

The response header is "Deprecated: true"
The JSON response body includes "deprecated": true

A deprecated warning is added to nms.log. For example:

Received call to deprecated v1 API at POST "/api/v1/authorize"

Determining which API versions are supported in the current release

Use the following API request to return a list of the supported API major versions:

GET https://{{IP-Address}}/api/versions
{
  "responseTime": "2019-01-10T20:41:00.845Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": [
    2,
    3
  ]
}

Specifying an API version for a request

You can specify the API version using a path parameter (/api/v3) or a header (Api-Version: 3). If you provide both values, the header value overrides the path value.

curl https://[IP-Address]/api/v3/grid/accounts

curl -H "Api-Version: 3" https://[IP-Address]/api/grid/accounts