Understanding the Grid Management API

StorageGRID Webscale provides a REST API for performing system management tasks.

You access the Grid Management API over HTTPS. You can access the Grid Management API from the Grid Management Interface.

Grid Management API documentation

The Grid Management API uses the Swagger open source API platform to provide the API documentation. Swagger allows both developers and non-developers to interact with the API in a user interface that illustrates how the API responds to parameters and options. This documentation assumes that you are familiar with standard web technologies and the JSON (JavaScript Object Notation) data format.

Attention: Any API operations you perform using the Swagger user interface are live operations. Be careful not to create, update, or delete configuration or other data by mistake.

You can access the Grid Management API documentation by signing in to the Grid Management Interface and selecting Help > API Docs in the web application header.

API

Each REST API command includes the API's URL, an HTTP action, any required or optional URL parameters, and an expected API response.

The Swagger UI provides details and documentation for each API operation, as in the following example. To get information about a local grid administrator group, you would enter that group's unique name as the value for the shortName parameter and click Try it out.


Example from Swagger UI

The Grid Management API includes the following sections:

Top-level resources

The Grid Management API provides the following top level resources: