Add Tags to IP Address 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" -H "authorization: {{api_key}}" -H "x-xdr-auth-id: {{api_key_id}}" \ "https://api-}/public_api/v1/assets/tags/external_ip_address_ranges/assign/" \ -d '{ "request_data" : { "filters" : [ { "field" : "organization_handles", "value" : "AssignOrRemoveTagsFromIpRangesRequestFilter_value", "operator" : "in" }, { "field" : "organization_handles", "value" : "AssignOrRemoveTagsFromIpRangesRequestFilter_value", "operator" : "in" } ], "tags" : [ "tags", "tags" ] } }'
Request headers
authorization
required
String
api-key
Example: {{api_key}}
x-xdr-auth-id
required
String
api-key-id
Example: {{api_key_id}}
Request
Body
required
request_data
required
Object
A dictionary containing the API request fields. An empty dictionary returns all results.
filters
optional
Array of objects
An array of filter fields.
field
required
String (Enum)
range_id_list: indicates that the set of IP ranges will be a list of IDs.
Allowed values:
organization_handles
tags
business_units_list
ipaddress_version
has_bu_overrides
range_id_list
operator
required
String (Enum)
in
Allowed values:
in
contains
neq
eq
not_contains
value
required
List of strings, the ip range IDs that should be removed from the tag.
tags
optional
Array of strings
Name of the tag to add to the ranges. The tag name does not need to include the tag family.
Responses

OK

Body
reply
required
Object
assign_tags
required
String
succeeded if request was successful

Bad Request. Got an invalid JSON.

Body
reply
required
Object
The query results 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
reply
required
Object
The query results 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
reply
required
Object
The query results 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
reply
required
Object
The query results upon error.
err_code
optional
String
HTTP response code.
err_msg
optional
String
Error message.
err_extra
optional
String
Additional information describing the error.

Unprocessable Entity

Body
code
optional
Integer
Error code
status
optional
String
Error name
message
optional
String
Error message
errors
optional
Object
Errors

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

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