Overview of installation REST APIs

StorageGRID Webscale provides two REST APIs for performing installation tasks: the StorageGRID Webscale Installation API and the StorageGRID Appliance Installer API.

Both APIs use 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.

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

StorageGRID Webscale Installation API

The StorageGRID Webscale Installation API is only available when you are initially configuring your StorageGRID Webscale system, and in the event that you need to perform a primary Admin Node recovery. The Installation API can be accessed over HTTPS from the Grid Manager.

To access the API documentation, go to the installation web page on the primary Admin Node and select Help > API Docs from the menu bar.

The StorageGRID Webscale Installation API includes the following sections:

StorageGRID Appliance Installer API

The StorageGRID Appliance Installer API can be accessed over HTTP from Controller_IP:8080.

To access the API documentation, go to the StorageGRID Appliance Installer on the appliance and select Help > API Docs from the menu bar.

The StorageGRID Appliance Installer API includes the following sections: