Overview Of Installation Rest Apis - NetApp StorageGRID 11.5 Hardware Installation And Maintenance Manual

Hardware Installation and Maintenance Guide for SG100 and SG1000 Appliances
Deploying a services appliance node
can be used to obtain data from the StorageGRID
system.
If you specified that random passwords should be generated, you need to extract the
Passwords.txt
######################################################################
##### The StorageGRID "recovery package" has been downloaded as: #####
#####
##### Safeguard this file as it will be needed in case of a
#####
######################################################################
Your StorageGRID system is installed and configured when a confirmation message is displayed.
StorageGRID has been configured and installed.

Overview of installation REST APIs

StorageGRID provides two REST APIs for performing installation tasks: the StorageGRID
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
API Docs webpage are live operations. Be careful not to
create, update, or delete configuration data 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 Installation API
The StorageGRID Installation API is only available when you are initially configuring your
StorageGRID 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 Documentation from the menu bar.
The StorageGRID Installation API includes the following sections:
• config – Operations related to the product release and versions of the API. You can list the
product release version and the major versions of the API supported by that release.
• grid – Grid-level configuration operations. You can get and update grid settings, including grid
details, Grid Network subnets, grid passwords, and NTP and DNS server IP addresses.
• nodes – Node-level configuration operations. You can retrieve a list of grid nodes, delete a grid
node, configure a grid node, view a grid node, and reset a grid node's configuration.
• provision – Provisioning operations. You can start the provisioning operation and view the
status of the provisioning operation.
• recovery – Primary Admin Node recovery operations. You can reset information, upload the
Recover Package, start the recovery, and view the status of the recovery operation.
• recovery-package – Operations to download the Recovery Package.
file and look for the passwords required to access your StorageGRID system.
./sgws-recovery-package-994078-rev1.zip
StorageGRID node recovery.
#####
#####
#####
71