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
Type of change to API | Old version | New version |
---|---|---|
Compatible with older versions | 2.1 | 2.2 |
Not compatible with older versions | 2.1 | 3.0 |
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.
Received call to deprecated v1 API at POST "/api/v1/authorize"
GET https://{{IP-Address}}/api/versions { "responseTime": "2019-01-10T20:41:00.845Z", "status": "success", "apiVersion": "3.0", "data": [ 2, 3 ] }
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