GridGain Nebula REST API

Overview

Clusters in GridGain Nebula provide an OpenAPI specification that can be used to work with standard REST methods. The openapi.yaml specification file each version is included with that version’s release.

You can generate a client using the above spec from the release repository. Alternatively, you can use CURL, Postman, or any other method of your choice.

CURL Examples

Authenticate

curl -X POST -H "Content-Type: application/json" \
--data '{"username": string, "password": password}' \  https://api.<portal_domain>/v1/authenticate

If authentication succeeds, it returns an access token as part of the JSON response document:

{
  "access_token": "<access_token>",
  "refresh_token": "<refresh_token>"
}

Refresh Access Token

curl -X POST -H "Content-Type: application/json" \
--data '{"refresh_token": "<refresh_token>"}' \  https://api.<portal_domain>/v1/token

If refresh token succeeds, it returns an access token as part of the JSON response document:

{
  "access_token": "<access_token>",
  "refresh_token": "<refresh_token>"
}

Provision Cluster

curl -X POST \
-H "Authorization: Bearer $AUTH_TOKEN" \
-H "Content-Type: application/json" \
--data '{"cloudProviderRegion": "us-east-1", "clusterSize": "S", "igniteDataRegions": [{"name": "default","sizeInBytes": 2147483648,"persistence": true}],"nodeCount": 1,"rules": [],"userLogin": "cluster-user","userPassword": "12345678","azEnabled": false}' \
https://api.<portal_domain>/v1/nebula/deployments

Destroy Cluster

curl -X DELETE \
-H "Authorization: Bearer $AUTH_TOKEN" \
https://api.<portal_domain>/v1/nebula/deployments/<cluster-id>

© 2024 GridGain Systems, Inc. All Rights Reserved. Privacy Policy | Legal Notices. GridGain® is a registered trademark of GridGain Systems, Inc.
Apache, Apache Ignite, the Apache feather and the Apache Ignite logo are either registered trademarks or trademarks of The Apache Software Foundation.

Last updated on Mar 26, 2024