Help Center/ Workspace/ API Reference/ Workspace APIs/ Policy Group/ Importing an IP Address List

Updated on 2026-02-10 GMT+08:00

View PDF

Importing an IP Address List

Function

Imports an IP address list in Excel format.

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 has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:accessPolicies:importIp	Write	-	-	-	-

URI

POST /v2/{project_id}/ip/import

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** FormData parameters
Parameter	Mandatory	Type	Description
file	No	File	The imported user file.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
ip_list	Array of ImportIpInfo objects	List of successful imported IP addresses.
failed_ip_list	Array of ImportIpInfo objects	List of IP addresses that failed to be imported.
failed_code	String	Error code.
failed_message	String	Error code.
total_count	Integer	Number of IP address lists.

**Table 4** ImportIpInfo
Parameter	Type	Description
number	String	No.
ip_address	String	IP address.
subnet_mask	String	Subnet mask.
error_code	String	Error code.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 405

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

POST /v2/0bec5db98280d2d02fd6c00c2de791ce/ip/import

{
  "file" : "Importing an xlsx file for IP addresses"
}

Example Responses

Status code: 200

Response to the request for importing the IP address list.

{
  "ip_list" : [ {
    "number" : "1",
    "ip_address" : "192.0.0.1",
    "subnet_mask" : "255.255.255.255"
  }, {
    "number" : "2",
    "ip_address" : "192.0.0.2",
    "subnet_mask" : "255.255.255.255"
  } ],
  "total_count" : 2
}

Status Codes

Status Code	Description
200	Response to the request for importing the IP address list.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
405	The method specified in the request is not allowed.
500	An internal service error occurred. For details about the error code, see the error code description.