Get started
Changes to the Grid Management API
Suggest changes
-
PDF of this doc site
-
Install and upgrade software
-
Install and maintain hardware
-
SG5700 storage appliances
-
SG5600 storage appliances
-
-
Configure and manage
-
Administer StorageGRID
-
-
Use StorageGRID
-
Monitor and troubleshoot
-
Monitor a StorageGRID system
-
-
Collection of separate PDF docs
Creating your file...
StorageGRID 11.5 uses version 3 of the Grid Management API. Version 3 deprecates version 2; however, version 1 and version 2 are still supported.
|
You can continue to use version 1 and version 2 of the management API with StorageGRID 11.5; however, support for these versions of the API will be removed in a future release of StorageGRID. After upgrading to StorageGRID 11.5, the deprecated v1 and v2 APIs can be deactivated using the PUT /grid/config/management API.
|
New client-certificates section
The new section, /grid/client-certificates, allows you to configure client certificates to provide secure, authenticated access to the StorageGRID Prometheus database. For example, you can monitor StorageGRID externally using Grafana.
Legacy compliance endpoints moved to new s3-object-lock section
With the introduction of StorageGRID S3 Object Lock, the APIs used to manage the legacy compliance settings for the grid were moved to a new section of the Swagger user interface. The s3-object-lock section includes the two /grid/compliance-global API endpoints, which now control the global S3 Object Lock setting. The endpoint URIs remain unchanged for compatibility with existing applications.
Swift-admin-password Accounts endpoint removed
The following Accounts API endpoint, which was deprecated in StorageGRID 10.4, has now been removed:
https://<IP-Address>/api/v1/grid/accounts/<AccountID>/swift-admin-password
New grid-passwords section
The grid-passwords section enables operations for grid password management. The section includes two /grid/change-provisioning-passphrase API endpoints. The endpoints allow users to change the StorageGRID provisioning passphrase and retrieve the status of the passphrase change.
storageAdmin permission added to Groups API
The /grid/groups API now includes the storageAdmin permission.
New parameter for Storage Usage API
The GET /grid/accounts/{id}/usage API now has a strictConsistency parameter. To enforce a strong-global consistency when retrieving storage usage information across Storage Nodes, set this parameter to true. When this parameter is set to false (default), StorageGRID attempts to retrieve usage information using strong-global consistency, but falls back to strong-site consistency if strong-global consistency cannot be met.
New Node Health API
A new /grid/node-health endpoint was added. This API returns the current status of each node by checking for active alerts on the nodes. The /grid/health/topology API, which checks for active alarms on nodes, is deprecated.
Change to "ApplianceStorageShelvesPowerSupplyDegraded" alert rule ID
The alert rule ID "ApplianceStorageShelvesPowerSupplyDegraded" has been renamed to "ApplianceStorageShelvesDegraded" to better reflect the alert's actual behavior.