REST API
The GridGain Control Center REST API for user management, cluster attachment, alerting configuration, and health monitoring.
Control Center provides a REST API for programmatic access to its functionality. The API enables automation of common tasks including user management, cluster attachment, alerting configuration, and health monitoring.
API Overview
The REST API includes endpoints for:
Authentication - Login and JWT token management
Users - Create, update, and manage user accounts
Teams - Create teams and manage team membership
Clusters - Attach clusters and configure sharing
Notifications - Configure email, SMS, and webhook notification channels
Alerts - Set up metric-based alert configurations
Health - Retrieve cluster health reports
License - Upload and manage licenses
Connector - Get the list of connectors for the current user
For the complete API specification, see the OpenAPI documentation.
To learn how to use the REST API for fully automated Control Center deployment, see Automated Deployment.
Authentication
These examples use plain-text credentials on the command line for simplicity. In production, manage credentials using secure mechanisms such as secrets managers, environment variables, or encrypted vaults. Do not store credentials in plain text or embed them directly in commands.
Authenticate requests using HTTP Basic Authentication with your Control Center credentials (email and password):
Alternatively, obtain a JWT token by calling the login endpoint:
Then use the token in subsequent requests:
Get Cluster Health Reports
Authenticate with your Control Center credentials (email and password) and specify the connectionId in the request.
The endpoint returns the cluster health report in JSON format.
Example request:
Example response:
You can also view a specific report by passing reportName property to the endpoint:
Example response:
Last updated
Was this helpful?