Get All Owned IP Ranges

Cortex Xpanse REST API

post /public_api/v1/assets/get_external_ip_address_ranges/

The maximum result limit is 1000 ranges.
Note: You can send a request to retrieve either **all** or **filtered** results.
Required license: **Cortex Xpanse Expander**

Get a list of all your owned IP address ranges filtered by business units and organization handles.

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/get_external_ip_address_ranges/" \ -d ''
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
Array of filter fields.
field
optional
String (Enum)

Identifies the external IP ranges field the filter is matching. Filters are based on the following case-sensitive keywords:

  • business_units_list
  • organization_handles
  • Ipaddress_version
  • has_bu_overrides
  • tags
Allowed values:
organization_handles
tags
business_units_list
ipaddress_version
has_bu_overrides
operator
optional
String (Enum)

Identifies the comparison operator you want to use for this filter. Valid keywords and values are:

  • contains / not_contains
    • organization_handles
  • in
    • business_units_list
    • tags
  • eq / neq
    • ipaddress_version
    • has_bu_overrides
Allowed values:
in
contains
neq
eq
not_contains
value
optional

Values depend on the filter field used.

  • organization_handles — string
  • business_units_list — string or list of strings with syntax “Acme & Co, Inc.” or “BU:Acme & Co, Inc.”
  • tags — list of strings in format “{family alias}:{tag name}”
  • ipaddress_version — integer
  • has_bu_overrides - boolean (true/false)
search_from
optional
Integer
Represents the start offset index of results.
search_to
optional
Integer
An integer representing the start offset index of results. Use this field to specify the number of results on a page when using page token pagination.
Default value - 500
Max value - 1000
sort
optional
Object
Identifies the sort order for the result set.
field
optional
String (Enum)

Values are:

  • Id
  • first_ip
  • last_ip
    Case sensitive.
    Default is first_ip.
Allowed values:
last_ip
last_ipv6
first_ipv6
first_ip
ipaddress_version
range_id_list
keyword
optional
String (Enum)

Value are:

  • ASC (ascending order)
  • DESC (descending order). Case sensitive. Default is DESC.
Allowed values:
ASC
asc
DESC
desc
use_page_token
optional
Boolean
Use "use_page_token":true in the initial request to paginate the response data. Sort is not supported when using the use_page_token/next_page_token fields.
next_page_token
optional
String
If "use_page_token":true was included in the initial request, the response for that request will include a page token. Use "next_page_token":"string" to pass that page token into the next request to paginate the next set of data.
Responses

OK

Body
reply
optional
Object
total_count
optional
Integer
result_count
optional
Integer
external_ip_address_ranges
optional
Array of objects
range_id
optional
String
first_ip
optional
String
last_ip
optional
String
ips_count
optional
Integer
active_responsive_ips_count
optional
Integer
date_added
optional
Integer
organization_handles
optional
Array of strings
ipaddress_version
optional
Integer
tags
optional
Array of strings
first_ipv6
optional
String
last_ipv6
optional
String
annotation
optional
String
has_bu_overrides
optional
Boolean
next_page_token
optional
String
This attribute is only returned if use_page_token is provided in the request with value true

Bad Request. Got an invalid JSON.

Body
reply
required
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
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
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
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
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.