Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Modifying the Password-Free Configuration of a GeminiDB Redis Instance
Updated on 2025-10-17 GMT+08:00

Modifying the Password-Free Configuration of a GeminiDB Redis Instance

Function

This API is used to modify the password-free configuration of a GeminiDB Redis instance.

Constraints

This API supports the following instance type:

  • GeminiDB Redis

URI

PUT /v3/{project_id}/instances/{instance_id}/passwordless-config

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

instance_id

Yes

String

Explanation:

Instance ID, which can be obtained by following Querying Instances and Details. If no instance is available, call the API by flowing Creating an Instance to create one.

Constraints:

N/A

Values:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token

You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication.

Constraints:

N/A

Values:

N/A

Default value:

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

config_ips

Yes

Array of strings

Explanation:

List of IP addresses and CIDR blocks for which password-free configurations need to be set. If the list is empty, the password-free configurations are cleared.

Constraints:

N/A

Values:

N/A

Default value:

N/A

Response Parameters

Status code: 200

None

Example Request

PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/b31f6915c8be45e38958eac14e96a5d2in12/passwordless-config 
 
{ 
  "config_ips" : [ "10.23.26.0/24" ] 
}

Example Response

None

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.