Skip to main content
FlashGrid.io

REST API for generating FlashGrid Cluster templates

  • Updated
  • Products: FlashGrid Cluster on Azure
  • Products: FlashGrid Cluster on GCP
  • Products: FlashGrid Cluster on AWS

For fully automated deployments of FlashGrid Cluster it may be preferable to use REST API instead of FlashGrid Launcher GUI.

Note: Access to the REST API is restricted to approved customers only and requires providing a key. Please contact technical support if you need access to the REST API.

Endpoints

The REST API endpoints have the following address format: https://<version>.cloudprov.flashgrid.io/api/gen_cf

<version> corresponds to a FlashGrid Cluster release version. For example, 2304 is for version 23.04. The following REST API endpoints are currently valid:

  • https://2304.cloudprov.flashgrid.io/api/gen_cf
  • https://2302.cloudprov.flashgrid.io/api/gen_cf
  • https://2212.cloudprov.flashgrid.io/api/gen_cf
  • https://2209.cloudprov.flashgrid.io/api/gen_cf
  • https://2206.cloudprov.flashgrid.io/api/gen_cf

Retired Endpoints

The endpoints are normally planned for retirement after 1 year. This is done to ensure that the systems are deployed with the latest security patches that are included in newer versions. For example, the endpoint of version 21.08 was released in August 2021 and is planned for retirement in August 2022.

Please contact FlashGrid support if you need to use an endpoint after its planned retirement date.

The following endpoints are now retired and no longer accessible:

  • https://2203.cloudprov.flashgrid.io/api/gen_cf
  • https://2111.cloudprov.flashgrid.io/api/gen_cf
  • https://2108-cluster.cloudprov.flashgrid.io/api/gen_cf
  • https://2106-cluster.cloudprov.flashgrid.io/api/gen_cf
  • https://2103-cluster.cloudprov.flashgrid.io/api/gen_cf
  • https://2102-cluster.cloudprov.flashgrid.io/api/gen_cf
  • https://2010-cluster.cloudprov.flashgrid.io/api/gen_cf

Input

The REST API accepts the following inputs:

  • api-key:<accesskey> - the API access key provided in the request header
  • Cluster configuration file provided as POST binary data.

Example of using the API

curl -o generated_template.json -H api-key:mycompany-4717983475934759 --data-binary @my-cluster-config-file.cfg https://2302.cloudprov.flashgrid.io/api/gen_cf

This example will generate a FlashGrid Cluster template from my-cluster-config-file.cfg configuration file and will save it as a file named generated_template.json.

SSL certificate validation

When using curl you may get the following error if your OS does not have the corresponding Certification Authority certificate installed:

curl: (60) Peer's Certificate issuer is not recognized.

To prevent this error you may choose to install the certificate used by the endpoint or to skip certificate validation by adding --insecure option to the curl command.

Creating and managing cluster configuration files for use with the REST API

The following scenarios provide recommendations for creating and managing cluster configuration files depending on a specific scenario.

  • Deploying new cluster(s) for new database/application(s)

    Use FlashGrid Cluster Launcher GUI for creating and saving the initial version of a cluster configuration file. You can start with a blank configuration or upload a cluster configuration file that you created previously. Subsequently, the configuration file can be stored in a version control system, cloned, and customized as needed.

  • Deploying cluster(s) in Dev/Test/QA/Pre-prod environment that need to match configuration of a cluster in Prod environment

    Start with the cluster configuration file used for deploying the production cluster and customize it as needed for the new environment. Use the same API version for consistency.

  • Deploying a secondary cluster (with configuration matching the primary cluster) in a different region for DR purposes.

    Start with the cluster configuration file used for deploying the production cluster and customize it as needed for the new environment. Use the same API version for consistency.

  • Re-deploying a cluster in case it is damaged or destroyed by mistake

    Use the same cluster configuration file that was used for creating the cluster initially. In some cases using newer API version for the deployment may be preferred or required, for example, if the initial cluster had been deployed long time ago and was since updated to newer OS and/or software versions. Using newer API version might require modifications to some of the parameters stored in the cluster configuration file.

Submit request to technical support if you need help with modifying the cluster configuration file.