Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Tenant/ Obtaining the IP Address Whitelist of a Tenant
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Obtaining the IP Address Whitelist of a Tenant

Function

This API is used to obtain the IP address whitelist of a tenant.

Debugging

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

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsrepo::getTenantSetting

Read

-

-

-

-

URI

GET https://{hostURL}/v4/tenant/trusted-ip-addresses

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition

Offset, which starts from 0.

Value range:

0~2147483647

Default value:

0

limit

No

Integer

Definition

Number of returned records.

Value range:

1~100

Default value:

20

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token.

Constraints

N/A

Range

1–100,000 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response header parameters

Parameter

Type

Description

X-Total

String

Definition

Total number of results of the current request.
Table 4 Response body parameters

Parameter

Type

Description

[items]

Array of TenantTrustedIpAddressDto objects

Definition

IP address whitelist information.
Table 5 TenantTrustedIpAddressDto

Parameter

Type

Description

id

String

Definition

IP address whitelist ID.

user_id

Integer

Definition

User ID.

Value range:

0~2147483647

domain_id

String

Definition

Tenant ID.

ip_range

String

Definition

IP address range.

ip_type

Integer

Definition

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

Definition

Start IP address.

ip_end

String

Definition

End IP address.

view_flag

Integer

Definition

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

Definition

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

Definition

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

Definition

Remarks.

Range

Mandatory. Max. 200 characters.

created_at

String

Definition

Creation time.

Definition

MMM dd, yyyy hh:mm:ss a

updated_at

String

Definition

Update time.

Definition

MMM dd, yyyy hh:mm:ss a

order_flag

Integer

Definition

Sorting.

  • 0: indicates the default rule.

  • 1: indicates the custom rule.

Enumeration values:

  • 0

  • 1

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

GET https://{endpoint}/v4/tenant/setting/ip_addresses

Example Responses

Status code: 200

OK

[ {
  "id" : 1998,
  "user_id" : 9155,
  "ip_range" : "1.1.1.1",
  "ip_start" : "1.1.1.1",
  "ip_end" : "1.1.1.1",
  "created_at" : "Aug 21, 2023 10:27:09 PM",
  "updated_at" : "Jul 1, 2024 4:19:31 PM",
  "ip_type" : 3,
  "view_flag" : 1,
  "download_flag" : 1,
  "upload_flag" : 1,
  "order_flag" : 0,
  "domain_id" : "159b65b41ead484d8ddff250a4731781",
  "remark" : ""
}, {
  "id" : 1999,
  "user_id" : 9155,
  "ip_range" : "1.1.1.1",
  "ip_start" : "1.1.1.1",
  "ip_end" : "1.1.1.1",
  "created_at" : "Aug 21, 2023 10:27:09 PM",
  "updated_at" : "Jul 1, 2024 4:19:31 PM",
  "ip_type" : 3,
  "view_flag" : 1,
  "download_flag" : 1,
  "upload_flag" : 1,
  "order_flag" : 0,
  "domain_id" : "159b65b41ead484d8ddff250a4731781",
  "remark" : ""
} ]

Status code: 401

Unauthorized

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

Status code: 403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Bad Request

Error Codes

See Error Codes.

Parent topic: Tenant