Changes to the Grid Management API

StorageGRID 11.2 introduces version 3 of the Grid Management API. Version 3 deprecates version 2; however, version 1 and version 2 are still supported.

Attention: You can continue to use version 1 and version 2 of the management API with StorageGRID 11.2; however, support for these versions of the API will be removed in a future release of StorageGRID. After upgrading to StorageGRID 11.2, the deprecated v1 and v2 APIs can be deactivated using the PUT /grid/config/management API.

503 error now returned for requests that can be retried

In previous StorageGRID releases, a 500 error code (Internal Server Error) was returned for some communication errors between nodes, including Connection Failed, Host Unreachable, and Connection Refused. In this release, a 503 error code (Service Unavailable) is returned when you can safely retry a request. As required, you should update client applications to reflect this change.

DELETE /authorize request can now return 200 response code

In previous StorageGRID releases, a 204 response code was returned for successful requests to delete an authorization token. In this release, a 200 response code and a response body can also be returned if single sign-on (SSO) is enabled.

New clientReads and clientWrites audit levels

Version 3 of the Grid Management API replaces the protocol audit message level with two new audit message levels: clientReads and clientWrites.

New networks section for install and expansion endpoints

The hardware section of the following endpoints now includes a networks section:

The response describes the original network configuration that was provided when the node registered with the primary Admin Node.

uniquename included in topology health data for grid and site

The data returned by the health/topology endpoint in the alarms section now includes the uniqueName property for the grid level and for each site. Previously, the uniquename property was only included for nodes.

responseTime marked optional

The responseTime parameter was incorrectly marked as required in the API Docs of the Grid Management API. This parameter has always been optional, and now it is correctly marked as optional.

Some metrics noted as _private_

Some metrics now include _private_ in their names, indicating that they are intended for internal use only. These metrics are subject to change between StorageGRID releases without notice.