/clusters/{clusterName}/services/{serviceName}/config
Mount Point: /api/v1/clusters/{clusterName}/services/{serviceName}/config
GET
Retrieves the configuration of a specific service.
The "summary" view contains only the configured parameters, and configuration for role types that contain configured parameters.
The "full" view contains all available configuration parameters for the service and its role types. This mode performs validation on the configuration, which could take a few seconds on a large cluster (around 500 nodes or more).
Parameters
| name | description | type | default |
|---|---|---|---|
| clusterName | The name of the cluster. | path | |
| serviceName | The service to query. | path | |
| view | The view of the data to materialize, either "summary" or "full". | query | summary |
Response Body
| element: | serviceConfig |
List of service and role types configuration parameters.
PUT
Updates the service configuration with the given values.
If a value is set in the given configuration, it will be added to the service's configuration, replacing any existing entries. If a value is unset (its value is null), the existing configuration for the attribute will be erased, if any.
Attributes that are not listed in the input will maintain their current values in the configuration.
Parameters
| name | description | type | default |
|---|---|---|---|
| clusterName | The name of the cluster. | path | |
| serviceName | The service to modify. | path | |
| message | Optional message describing the changes. | query |
Request Body
| element: | serviceConfig |
Configuration changes.
Response Body
| element: | serviceConfig |
The new service configuration.