# RoleConfigGroupsResource Resource

### GET /clusters/{clusterName}/services/{serviceName}/roleConfigGroups

Returns the information for all role config groups for a given cluster and service.

Available since API v3.

Request Parameters
name | type | description | default
--- | --- | --- | ---
clusterName | path |  | n/a
serviceName | path |  | n/a

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiRoleConfigGroupList (JSON) | The list of role config groups for the given service.

### POST /clusters/{clusterName}/services/{serviceName}/roleConfigGroups

Creates new role config groups. It is not allowed to create base groups (base must be set to false.)

Available since API v3.

Request Parameters
name | type | description | default
--- | --- | --- | ---
clusterName | path |  | n/a
serviceName | path |  | n/a

Request Body
media type | data type | description
--- | --- | ---
application/json | ApiRoleConfigGroupList (JSON) | The list of groups to be created.

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiRoleConfigGroupList (JSON) | The list of new role config groups.

### PUT /clusters/{clusterName}/services/{serviceName}/roleConfigGroups/roles

Moves roles to the base role config group. The roles can be moved from any role config group belonging to the same service. The role type of the roles may vary. Each role will be moved to its corresponding base group depending on its role type.

Available since API v3.

Request Parameters
name | type | description | default
--- | --- | --- | ---
clusterName | path |  | n/a
serviceName | path |  | n/a

Request Body
media type | data type | description
--- | --- | ---
application/json | ApiRoleNameList (JSON) | The names of the roles to move.

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiRoleList (JSON) | The roles which have been moved successfully.

### DELETE /clusters/{clusterName}/services/{serviceName}/roleConfigGroups/{roleConfigGroupName}

Deletes a role config group.

Available since API v3.

Request Parameters
name | type | description | default
--- | --- | --- | ---
clusterName | path |  | n/a
roleConfigGroupName | path | The name of the group to delete. | n/a
serviceName | path |  | n/a

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiRoleConfigGroup (JSON) | The deleted role config group.

### GET /clusters/{clusterName}/services/{serviceName}/roleConfigGroups/{roleConfigGroupName}

Returns the information for a role config group.

Available since API v3.

Request Parameters
name | type | description | default
--- | --- | --- | ---
clusterName | path |  | n/a
roleConfigGroupName | path | The name of the requested group. | n/a
serviceName | path |  | n/a

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiRoleConfigGroup (JSON) | The requested role config group.

### PUT /clusters/{clusterName}/services/{serviceName}/roleConfigGroups/{roleConfigGroupName}

Updates an existing role config group

Available since API v3.

Request Parameters
name | type | description | default
--- | --- | --- | ---
clusterName | path |  | n/a
roleConfigGroupName | path | The name of the group to update. | n/a
serviceName | path |  | n/a
message | query | The optional message describing the changes. | n/a

Request Body
media type | data type | description
--- | --- | ---
application/json | ApiRoleConfigGroup (JSON) | The updated role config group.

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiRoleConfigGroup (JSON) | Role updated role config group.

### GET /clusters/{clusterName}/services/{serviceName}/roleConfigGroups/{roleConfigGroupName}/config

Returns the current revision of the config for the specified role config group.

Available since API v3.

Request Parameters
name | type | description | default
--- | --- | --- | ---
clusterName | path |  | n/a
roleConfigGroupName | path | The name of the role config group. | n/a
serviceName | path |  | n/a
view | query | The view of the data to materialize, either "summary" or "full". | summary

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiConfigList (JSON) | The current configuration of the role config group.

### PUT /clusters/{clusterName}/services/{serviceName}/roleConfigGroups/{roleConfigGroupName}/config

Updates the config for the given role config group.

Request Parameters
name | type | description | default
--- | --- | --- | ---
clusterName | path |  | n/a
roleConfigGroupName | path | The name of the role config group. | n/a
serviceName | path |  | n/a
message | query | Optional message describing the changes. | n/a

Request Body
media type | data type | description
--- | --- | ---
application/json | ApiConfigList (JSON) | The new config information for the group.

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiConfigList (JSON) | The updated config of the role config group.

### GET /clusters/{clusterName}/services/{serviceName}/roleConfigGroups/{roleConfigGroupName}/roles

Returns all roles in the given role config group.

Available since API v3.

Request Parameters
name | type | description | default
--- | --- | --- | ---
clusterName | path |  | n/a
roleConfigGroupName | path | The name of the role config group. | n/a
serviceName | path |  | n/a

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiRoleList (JSON) | The roles in the role config group.

### PUT /clusters/{clusterName}/services/{serviceName}/roleConfigGroups/{roleConfigGroupName}/roles

Moves roles to the specified role config group. The roles can be moved from any role config group belonging to the same service. The role type of the destination group must match the role type of the roles.

Available since API v3.

Request Parameters
name | type | description | default
--- | --- | --- | ---
clusterName | path |  | n/a
roleConfigGroupName | path | The name of the group the roles will be moved to. | n/a
serviceName | path |  | n/a

Request Body
media type | data type | description
--- | --- | ---
application/json | ApiRoleNameList (JSON) | The names of the roles to move.

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiRoleList (JSON) | The roles which have been moved successfully.