Parameter

Create parameter group

Create a new parameter group based on the default parameter group.

Request

Create parameter group Request Syntax
curl -X POST "https://redis.kr-central-2.kakaocloud.com/v1/parameter-groups" \
-H "X-Auth-Token: {token-id}" \
-d '{Body}'

Type	Parameter	Data Type	Description
Header	`{token-id}`*	String	Refer to API authentication token
Body	parameterGroupId*	String	ID of the base parameter group
	name*	String	Name of the new parameter group
	description	String	Description of the new parameter group

Create parameter group Request Body Example
{
  "parameterGroupId": "qwerqwer-7347-4d87-a49f-e705e91db2fb",
  "name": "test-parameter-group",
  "description": "test parameter group"
}

Response

Status Code	Description
`200`	Success response for retrieving or deleting the resource
`400`	The request is invalid and cannot be processed
`401`	Request made by an unauthenticated user
`403`	Request made by a user without permission
`404`	Requested resource does not exist
`500`	Internal server error preventing the operation

Field	Type	Description
objectId	String	ID of the created parameter group

Create parameter group Response Example
201 Created
content-length: 52
content-type: application/json; charset=UTF-8
 
{
  "objectId": "12341234-1234-1234-1234-e705e91db2fb"
}

Retrieve parameter group list

Retrieve the list of parameter groups.
You can use query parameters such as engineVersion={engine-version} to filter by engine version, or parameterGroupType={parameter-group-type} to filter by group type (default or custom).

Request

Retrieve parameter group list Request Syntax
curl -X GET "https://redis.kr-central-2.kakaocloud.com/v1/parameter-groups?engineVersion={engine-version}&parameterGroupType={parameter-group-type}&clusterMode={clusterMode}" \
-H "X-Auth-Token: {token-id}"

Type	Parameter	Data Type	Description
Header	`{token-id}`*	String	Refer to API authentication token
Query	`{engine-version}`	String	Specifies the Redis engine version
Query	`{parameter-group-type}`	String	Specifies the parameter group type - `default`, `custom`
Query	`{clusterMode}`	String	Allowed values - `enabled`, `disabled` - If omitted or empty, includes both

Response

Status Code	Description
`200`	Success response for retrieving or deleting the resource
`400`	The request is invalid and cannot be processed
`401`	Request made by an unauthenticated user
`403`	Request made by a user without permission
`404`	Requested resource does not exist
`500`	Internal server error preventing the operation

Field	Type	Description
parameterGroups[]	Object Array	List of parameter groups
parameterGroups[].id	String	Parameter group ID
parameterGroups[].engineVersion	String	Redis engine version of the parameter group
parameterGroups[].name	String	Name of the parameter group
parameterGroups[].description	String	Description of the parameter group
parameterGroups[].isDefault	Boolean	Indicates whether it is a default parameter group
parameterGroups[].defaultParameterGroupId	String	ID of the default parameter group that a custom group is based on - Empty for default groups
parameterGroups[].rollbackAvailable	Boolean	Whether rollback is available for the parameter group
parameterGroups[].clusterModeEnabled	Boolean	Whether the parameter group supports cluster mode
parameterGroups[].existErrorSync	Boolean	Whether any clusters using this group have sync errors
parameterGroups[].clusterSize	Integer	Number of clusters using this parameter group
parameterGroups[].createdAt	String	Creation date of the parameter group

Retrieve parameter group list Response Example
200 OK
content-length: ...
content-type: application/json; charset=UTF-8
 
{
  "parameterGroups": [
    {
      "id": "12341234-1234-1234-a49f-e705e91db2fb",
      "engineVersion": "5.0.6",
      "name": "test-parameter-group-1",
      "description": "test param group 1",
      "isDefault": false,
      "defaultParameterGroupId": "12341234-1234-1234-1234-e705e91db2fb",
      "rollbackAvailable": false,
      "clusterModeEnabled": true,
      "existErrorSync": false,
      "clusterSize": 5,
      "createdAt": "2024-03-06T02:35:13Z"
    },
    {
      "id": "56785678-5678-5678-a49f-e705e91db2fb",
      "engineVersion": "6.2.5",
      "name": "test-parameter-group-2",
      "description": "test param group 2",
      "isDefault": false,
      "defaultParameterGroupId": "56785678-5678-5678-5678-e705e91db2fb",
      "rollbackAvailable": true,
      "clusterModeEnabled": true,
      "existErrorSync": true,
      "clusterSize": 3,
      "createdAt": "2024-03-06T02:35:13Z"
    }
  ]
}

Retrieve parameter group details

Retrieve detailed information of a specified parameter group.

Request

Retrieve parameter group details Request Syntax
curl -X GET "https://redis.kr-central-2.kakaocloud.com/v1/parameter-groups/{parameter-group-id or parameter-group-name}" \
-H "X-Auth-Token: {token-id}"

Type	Parameter	Data Type	Description
URL	`{parameter-group-id or parameter-group-name}`*	String	Parameter group ID or name
Header	`{token-id}`*	String	Refer to API authentication token

Response

Status Code	Description
`200`	Success response for retrieving or deleting the resource
`400`	The request is invalid and cannot be processed
`401`	Request made by an unauthenticated user
`403`	Request made by a user without permission
`404`	Requested resource does not exist
`500`	Internal server error preventing the operation

Field	Type	Description
id	String	Parameter group ID
name	String	Parameter group name
description	String	Description of the parameter group
engineVersion	String	Redis engine version of the parameter group
isDefault	Boolean	Indicates whether it is a default parameter group
defaultParameterGroupId	String	ID of the default group this group is based on
clusterModeEnabled	Boolean	Whether the group supports cluster mode
existErrorSync	Boolean	Indicates whether any cluster using this group has sync errors
clusterSize	Integer	Number of clusters using this group
rollbackAvailable	Boolean	Whether rollback is available for this group
parameters[]	Object Array	List of parameters
parameters[].parameterType	String	Parameter type (e.g., STATIC, DYNAMIC)
parameters[].parameterKey	String	Parameter key
parameters[].parameterValue	String	Parameter value
parameters[].defaultParameterValue	String	Default parameter value
parameters[].dataType	String	Data type of the parameter value (ENUM, STRING, INTEGER)
parameters[].editable	Boolean	Indicates whether the value can be edited - STRING: regex-based - NUMBER: numeric range or values separated by `
parameters[].validationValueFormat	String	Validation format of the parameter value
createdAt	String	Creation timestamp of the parameter group

Retrieve parameter group details Response Example
200 Created
content-length: ...
content-type: application/json; charset=UTF-8
 
{
  "id": "12341234-1234-1234-a49f-e705e91db2fb",
  "name": "test-parameter-group",
  "description": "test description",
  "engineVersion": "6.2.5",
  "isDefault": false,
  "defaultParameterGroupId": "qwerqwer-7347-4d87-a49f-e705e91db2fb",
  "clusterModeEnabled": false,
  "existErrorSync": false,
  "clusterSize": 5,
  "parameters": [
    {
      "parameterType": "DYNAMIC",
      "parameterKey": "param-key1",
      "parameterValue": "param-val1",
      "defaultParameterValue": "init-param-val1",
      "dataType": "STRING",
      "editable": true,
      "validationValueFormat": "param-val1|param-val2|param-val3"
    },
    {
      "parameterType": "DYNAMIC",
      "parameterKey": "param-key2",
      "parameterValue": "1",
      "defaultParameterValue": "0",
      "dataType": "NUMBER",
      "editable": true,
      "validationValueFormat": "0~10"
    }
  ],
  "rollbackAvailable": false,
  "createdAt": "2024-03-06T02:35:13Z"
}

Delete parameter group

Delete a parameter group. There must be no clusters currently using the specified parameter group.

Request

Delete parameter group Request Syntax
curl -X DELETE "https://redis.kr-central-2.kakaocloud.com/v1/parameter-groups/{parameter-group-id or parameter-group-name}" \
-H "X-Auth-Token: {token-id}"

Type	Parameter	Data Type	Description
URL	`{parameter-group-id or parameter-group-name}`*	String	Parameter group ID or name
Header	`{token-id}`*	String	Refer to API authentication token

Response

Status Code	Description
`200`	Success response for retrieving or deleting the resource
`400`	The request is invalid and cannot be processed
`401`	Request made by an unauthenticated user
`403`	Request made by a user without permission
`404`	Requested resource does not exist
`500`	Internal server error preventing the operation

Field	Type	Description
objectId	String	Parameter group ID

Delete parameter group Response Example
200 OK
content-length: ...
content-type: application/json; charset=UTF-8

{
  "objectId": "qwerqwer-7347-4d87-a49f-e705e91db2fb"
}

Modify parameters

Update parameter values in a parameter group.

Request

Modify parameter group Request Syntax
curl -X PATCH "https://redis.kr-central-2.kakaocloud.com/v1/parameter-groups/{parameter-group-id or parameter-group-name}" \
-H "X-Auth-Token: {token-id}" \
-d '{Body}'

Type	Parameter	Data Type	Description
URL	`{parameter-group-id or parameter-group-name}`*	String	Parameter group ID or name
Header	`{token-id}`*	String	Refer to API authentication token
Body	description	String	Description of the parameter group
	parameters[]	Object Array	List of parameters to update
	parameters[].parameterKey	String	Key of the parameter to update
	parameters[].parameterValue	String	New value of the parameter
	applyMode	String	Apply mode for connected clusters - Required only when modifying parameters - `sequential`: Apply sequentially - `parallel`: Apply in parallel

Modify parameter group Request Body Example
{
  "description": "test description",
  "parameters": [
    {
      "parameterKey": "param-key1",
      "parameterValue": "param-val1"
    },
    {
      "parameterKey": "param-key2",
      "parameterValue": "param-val2"
    },
    {
      "parameterKey": "param-key3",
      "parameterValue": "param-val3"
    }
  ],
  "applyMode": "sequential"
}

Response

Status Code	Description
`200`	Success response for retrieving or deleting the resource
`400`	The request is invalid and cannot be processed
`401`	Request made by an unauthenticated user
`403`	Request made by a user without permission
`404`	Requested resource does not exist
`500`	Internal server error preventing the operation

Field	Type	Description
objectId	String	Parameter group ID

Modify parameter group Response Example
200 OK
content-length: ...
content-type: application/json; charset=UTF-8

{
  "objectId": "qwerqwer-7347-4d87-a49f-e705e91db2fb"
}

Roll back parameter group

Roll back the parameter values of a parameter group to the previously used values.

Request

Roll back parameter group Request Syntax
curl -X POST "https://redis.kr-central-2.kakaocloud.com/v1/parameter-groups/{parameter-group-id or parameter-group-name}/rollback" \
-H "X-Auth-Token: {token-id}"

Type	Parameter	Data Type	Description
URL	`{parameter-group-id or parameter-group-name}`*	String	Parameter group ID or name
Header	`{token-id}`*	String	Refer to API authentication token

Roll back parameter group Request Body Example
{
  "applyMode": "sequential"
}

Response

Status Code	Description
`200`	Success response for retrieving or deleting the resource
`400`	The request is invalid and cannot be processed
`401`	Request made by an unauthenticated user
`403`	Request made by a user without permission
`404`	Requested resource does not exist
`500`	Internal server error preventing the operation

Field	Type	Description
objectId	String	Parameter group ID

Roll back parameter group Response Example
200 OK
content-length: ...
content-type: application/json; charset=UTF-8

{
  "objectId": "qwerqwer-7347-4d87-a49f-e705e91db2fb"
}

Reset parameter group

Reset the parameters of a parameter group to match the default parameter group's values.

Request

Reset parameter group Request Syntax
curl -X POST "https://redis.kr-central-2.kakaocloud.com/v1/parameter-groups/{parameter-group-id or parameter-group-name}/reset" \
-H "X-Auth-Token: {token-id}" \
-d '{Body}'

Type	Parameter	Data Type	Description
URL	`{parameter-group-id or parameter-group-name}`*	String	Parameter group ID or name
Header	`{token-id}`*	String	Refer to API authentication token
Body	applyMode*	String	Apply mode for connected clusters - `sequential`: Apply sequentially - `parallel`: Apply in parallel

Reset parameter group Request Body Example
{
  "applyMode": "sequential"
}

Response

Status Code	Description
`200`	Success response for retrieving or deleting the resource
`400`	The request is invalid and cannot be processed
`401`	Request made by an unauthenticated user
`403`	Request made by a user without permission
`404`	Requested resource does not exist
`500`	Internal server error preventing the operation

Field	Type	Description
objectId	String	Parameter group ID

Reset parameter group Response Example
200 OK
content-length: ...
content-type: application/json; charset=UTF-8

{
  "objectId": "qwerqwer-7347-4d87-a49f-e705e91db2fb"
}

Retrieve recent parameter group events

Retrieve events related to a parameter group from the past 7 days.

Request

Retrieve recent parameter group events Request Syntax
curl -X GET "https://redis.kr-central-2.kakaocloud.com/v1/parameter-groups/{parameter-group-id or parameter-group-name}/events" \
-H "X-Auth-Token: {token-id}"

Type	Parameter	Data Type	Description
URL	`{parameter-group-id or parameter-group-name}`*	String	Parameter group ID or name
Header	`{token-id}`*	String	Refer to API authentication token

Response

Status Code	Description
`200`	Success response for retrieving or deleting the resource
`400`	The request is invalid and cannot be processed
`401`	Request made by an unauthenticated user
`403`	Request made by a user without permission
`404`	Requested resource does not exist
`500`	Internal server error preventing the operation

Field	Type	Description
events[]	Object Array	List of events
events[].eventName	String	Name of the event
events[].message	String	Event message
events[].createdAt	String	Event creation timestamp (RFC3339)

Retrieve recent parameter group events Response Example
200 OK
content-length: ...
content-type: application/json; charset=UTF-8

{
  "events": [
    {
      "eventName": "Apply Parameter",
      "message": "",
      "createdAt": "2024-05-07T12:00:01.123456Z"
    },
    {
      "eventName": "Update Parameter",
      "message": "",
      "createdAt": "2024-05-07T12:00:00.000000Z"
    }
  ]
}

Create parameter group​

Request​

Response​

Retrieve parameter group list​

Request​

Response​

Retrieve parameter group details​

Request​

Response​

Delete parameter group​

Request​

Response​

Modify parameters​

Request​

Response​

Roll back parameter group​

Request​

Response​

Reset parameter group​

Request​

Response​

Retrieve recent parameter group events​

Request​

Response​

Create parameter group

Request

Response

Retrieve parameter group list

Request

Response

Retrieve parameter group details

Request

Response

Delete parameter group

Request

Response

Modify parameters

Request

Response

Roll back parameter group

Request

Response

Reset parameter group

Request

Response

Retrieve recent parameter group events

Request

Response