Help Center/ Web Application Firewall/ API Reference/ APIs/ Address Group Management/ Modifying an IP Address Group
Updated on 2024-04-25 GMT+08:00
View PDF

Modifying an IP Address Group

Function

This API is used to modify an IP address group.

URI

PUT /v1/{project_id}/waf/ip-group/{id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. To obtain it, go to Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials.Then, in the Projects area, view Project ID of the corresponding project.

id

Yes

String

ID of the IP address group.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

You can obtain the ID by calling the ListEnterpriseProject API of EPS.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Content-Type

Yes

String

Content type.

Default: application/json;charset=utf8
Table 4 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Group Name

ips

Yes

String

IP addresses or IP address ranges are separated by commas (,).

description

No

String

Address group description

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

id

String

ID of the IP address group

name

String

IP address group name

ips

String

Address group IP addresses (IP addresses or IP address ranges are separated by commas (,).

size

Integer

Length of the IP address group

rules

Array of RuleInfo objects

List of rules that use the IP address group

description

String

Address group description
Table 6 RuleInfo

Parameter

Type

Description

rule_id

String

Rule ID

rule_name

String

Rule name

policy_id

String

Policy ID

policy_name

String

Policy Name

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Requests

The following example shows how to update an address group in a project. The project ID is specified by project_id. The address group ID is ip. IP address group name: demo. IP address: xx.xx.xx.xx. The address group description is empty.

PUT https://{Endpoint}/v1/{project_id}/waf/ip-group/{id}?enterprise_project_id=0

{
  "ips" : "xx.xx.xx.xx",
  "name" : "demo",
  "description" : ""
}

Example Responses

Status code: 200

Request succeeded.

{
  "description" : "",
  "id" : "c36e896b18ee486a81026fce8e69fb1a",
  "ips" : "xx.xx.xx.xx",
  "name" : "demo",
  "size" : 1,
  "rules" : [ ]
}

Status Codes

Status Code

Description

200

Request succeeded.

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.

Parent topic: Address Group Management