Configuration
- GET /configuration/groups
List configuration groups
Retrieves all configuration groups with pagination and optional keyword filtering
- Query Parameters:
keyword (string) – Filter groups by keyword
page (integer) – Page number (default: 1)
page_size (integer) – Page size (default: 50, max: 100)
- Status Codes:
200 OK – Successfully retrieved configuration groups
400 Bad Request – Invalid request parameters
401 Unauthorized – Unauthorized - missing or invalid token
403 Forbidden – Forbidden - CONFIGURATION_VIEW permission required
500 Internal Server Error – Internal server error
- GET /configuration/list
List configurations
Retrieves configurations with advanced filtering and pagination. Search terms are matched against transformed configuration names and descriptions.
- Query Parameters:
name (string) – Exact configuration name
category (string) – Filter by category
group (string) – Filter by group
subgroup (string) – Filter by subgroup
keyword (string) – Search keyword (searches in name, description, and display text)
clusterid (string) – Filter by cluster ID
page (integer) – Page number (default: 1)
page_size (integer) – Page size (default: 50, max: 100)
listall (boolean) – List all configurations (default: true)
- Status Codes:
200 OK – Successfully retrieved configurations
400 Bad Request – Invalid request parameters
401 Unauthorized – Unauthorized - missing or invalid token
403 Forbidden – Forbidden - CONFIGURATION_VIEW permission required
500 Internal Server Error – Internal server error
- GET /configuration/status
Health check
Returns the health status of the Configuration Manager API service
- Status Codes:
200 OK – Service is healthy and operational
- PUT /configuration/update
Update configuration value
Updates a configuration value and logs the change to audit history
- Request JSON Object:
accountid (string)
clusterid (string)
domainid (string)
imagestoreuuid (string)
name (string) – (required)
storageid (string)
value (string) – (required)
zoneid (string)
- Status Codes:
200 OK – Configuration updated successfully
400 Bad Request – Invalid request body
401 Unauthorized – Unauthorized - missing or invalid token
403 Forbidden – Forbidden - CONFIGURATION_MANAGE permission required
500 Internal Server Error – Internal server error