Help Center/ CodeArts Repo/ API Reference/ APIs/ Tenant/ Modifying a Tenant IP Address Whitelist
Updated on 2025-03-28 GMT+08:00
View PDF
Share

Modifying a Tenant IP Address Whitelist

Function

This API is used to modify a tenant IP address whitelist.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

PUT /v4/tenant/trusted-ip-addresses/{ip_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

ip_id

Yes

Integer

Details:

IP address whitelist ID.

Value range:

1-2147483647

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Details:

User token. You can obtain a token by calling the IAM API used to obtain a user token. In the returned response header, X-Subject-Token is the desired user token.

Constraints:

Mandatory.

Value range:

1–100,000 characters.

Default value:

N/A.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

ip_type

No

Integer

Details:

Format type.

  • 0: Indicates a specified IP address.

  • 1: Indicates the IP address range.

  • 2: Indicates CIDR (Classless Inter-Domain Routing).

Default value:

0

Enumeration values:

  • 0

  • 1

  • 2

ip_start

No

String

Details:

Start IP address.

ip_end

No

String

Details:

End IP address.

view_flag

No

Integer

Details:

Whether to allow access to the repository.

  • 0: Indicates that the access is forbidden.

  • 1: Indicates that the access is allowed.

Default value:

0

Enumeration values:

  • 0

  • 1

download_flag

No

Integer

Details:

Whether to allow code download.

  • 0: Indicates that the download is forbidden.

  • 1: Indicates that the download is allowed.

Default value:

0

Enumeration values:

  • 0

  • 1

upload_flag

No

Integer

Details:

Whether to allow code commit.

  • 0: Indicates that the commit is forbidden.

  • 1: Indicates that the commit is allowed.

Default value:

0

Enumeration values:

  • 0

  • 1

remark

No

String

Details:

Remarks.

Value range:

Mandatory. Max. 200 characters.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

Details:

IP address whitelist ID.

user_id

Integer

Details:

User ID.

Value range:

0-2147483647

domain_id

String

Details:

Tenant ID.

ip_range

String

Details:

IP address range.

ip_type

Integer

Details:

Format type.

  • 0: Indicates a specified IP address.

  • 1: Indicates the IP address range.

  • 2: Indicates CIDR.

Default value:

0

Enumeration values:

  • 0

  • 1

  • 2

ip_start

String

Details:

Start IP address.

ip_end

String

Details:

End IP address.

view_flag

Integer

Details:

Whether to allow access to the repository.

  • 0: Indicates that the access is forbidden.

  • 1: Indicates that the access is allowed.

Default value:

0

Enumeration values:

  • 0

  • 1

download_flag

Integer

Details:

Whether to allow code download.

  • 0: Indicates that the download is forbidden.

  • 1: Indicates that the download is allowed.

Default value:

0

Enumeration values:

  • 0

  • 1

upload_flag

Integer

Details:

Whether to allow code commit.

  • 0: Indicates that the commit is forbidden.

  • 1: Indicates that the commit is allowed.

Default value:

0

Enumeration values:

  • 0

  • 1

remark

String

Details:

Remarks.

Value range:

Mandatory. Max. 200 characters.

created_at

String

Details:

Creation time.

Details:

MMM dd, yyyy hh:mm:ss a

updated_at

String

Details:

Update time.

Details:

MMM dd, yyyy hh:mm:ss a

order_flag

Integer

Details:

Sorting.

  • 0: Indicates the default rule.

  • 1: Indicates the custom rule.

Enumeration values:

  • 0

  • 1

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Details:

Error code.

error_msg

String

Details:

Error message.

Example Requests

PUT https://{endpoint}/v4/tenant/trusted-ip-addresses/1

{
  "ip_type" : 0,
  "ip_start" : "1.1.1.1",
  "ip_end" : "1.1.1.1",
  "view_flag" : 1,
  "download_flag" : 1,
  "upload_flag" : 1,
  "remark" : "xxx office network"
}

Example Responses

Status code: 200

OK

{
  "id" : 19326,
  "user_id" : 7574,
  "ip_range" : "1.1.1.1",
  "ip_start" : "1.1.1.1",
  "ip_end" : "1.1.1.1",
  "ip_type" : 0,
  "view_flag" : 1,
  "download_flag" : 1,
  "upload_flag" : 1,
  "order_flag" : 1,
  "domain_id" : "159b65b41ead484d8ddff250a4731781",
  "remark" : ""
}

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

Error Codes

See Error Codes.

Parent topic: Tenant
OSZAR »