Add Tags to IP Ranges

Cortex Xpanse REST API

post /public_api/v1/assets/tags/external_ip_address_ranges/assign

Add tags in bulk to owned IP ranges.

CURL
curl -X POST \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ "https://api-yourfqdn/public_api/v1/assets/tags/external_ip_address_ranges/assign" \ -d '{ "request_data" : { "filters" : [ { "field" : "field", "value" : "value", "operator" : "operator" }, { "field" : "field", "value" : "value", "operator" : "operator" } ], "tags" : [ "", "" ] } }'
Request
Body
optional
Example: {"request_data":{"filters":[{"field":"range_id_list","operator":"in","value":["range_id_list"]}],"tags":["tag_name"]}}
request_data
required

A dictionary containing the API request fields.

An empty dictionary returns all results.

filters
optional
Array
An array of filter fields.
field
optional
String

Identifies the field the filter is matching. The following field is supported. Values are case-sensitive.

  • range_id_list
operator
optional
String

dentifies the comparison operator you want to use for this filter. Valid keywords are the following:

  • in
value
optional
String
The IP range IDs to which the tag should be added.
tags
optional
Array of objects
Name of the tag to add to the ranges. The tag name does not need to include the tag family.
Responses

OK

Body
reply
optional
assign_tags
optional
Boolean

Bad Request. Got an invalid JSON.

Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
err_extra
optional
String
Additional information describing the error.

Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.

Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
err_extra
optional
String
Additional information describing the error.

Unauthorized access. User does not have the required license type to run this API.

Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
err_extra
optional
String
Additional information describing the error.

Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.

Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
err_extra
optional
String
Additional information describing the error.

Internal server error. A unified status for API communication type errors.

Body
The query result upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
err_extra
optional
String
Additional information describing the error.