Get Owned IP Range Details

post /public_api/v1/assets/get_external_ip_address_range/

Get external IP address range details according to the range IDs.
Required license: Cortex Xpanse Expander

Request headers

authorization

String

required

api-key

Example: {{api_key}}

x-xdr-auth-id

String

required

api-key-id

Example: {{api_key_id}}

Body parameters

required

request_dataObject

A dictionary containing the API request fields.

range_id_listArray[string]

A string representing the range ID for which you want to get the details.

REQUEST BODY

{
  "request_data": {
    "range_id_list": [
      "range_id_list",
      "range_id_list",
      "range_id_list",
      "range_id_list",
      "range_id_list"
    ]
  }
}

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_range/'
    
      -d
      '{
  "request_data" : {
    "range_id_list" : [ "range_id_list", "range_id_list", "range_id_list", "range_id_list", "range_id_list" ]
  }
}'

Responses

Body

replyObject

detailsArray

range_idString

first_ipString

last_ipString

ips_countInteger

active_responsive_ips_countInteger

date_addedInteger

organization_handlesArray[string]

detailsObject

networkRecordsArray

firstIpString

firstIpv6String

handleString

lastChangedInteger

lastIpString

lastIpv6String

nameString

organizationRecordsArray

addressString

dateAddedInteger

emailString

firstRegisteredInteger

formattedNameString

handleString

kindString

lastChangedInteger

orgString

phoneString

remarksString

rolesArray[string]

remarksString

whoIsServerString

explainersArray[string]

ipaddress_versionInteger

tagsArray[string]

first_ipv6String

last_ipv6String

annotationString

has_bu_overridesBoolean

RESPONSE

{
  "reply": {
    "details": [
      {
        "range_id": "range_id_example",
        "first_ip": "first_ip_example",
        "last_ip": "last_ip_example",
        "ips_count": 0,
        "active_responsive_ips_count": 0,
        "date_added": 0,
        "organization_handles": [
          "organization_handles_example"
        ],
        "details": {
          "networkRecords": [
            {
              "firstIp": "firstIp_example",
              "firstIpv6": "firstIpv6_example",
              "handle": "handle_example",
              "lastChanged": 0,
              "lastIp": "lastIp_example",
              "lastIpv6": "lastIpv6_example",
              "name": "name_example",
              "organizationRecords": [
                {
                  "address": "address_example",
                  "dateAdded": 0,
                  "email": "email_example",
                  "firstRegistered": 0,
                  "formattedName": "formattedName_example",
                  "handle": "handle_example",
                  "kind": "kind_example",
                  "lastChanged": 0,
                  "org": "org_example",
                  "phone": "phone_example",
                  "remarks": "remarks_example",
                  "roles": [
                    "roles_example"
                  ]
                }
              ],
              "remarks": "remarks_example",
              "whoIsServer": "whoIsServer_example"
            }
          ]
        },
        "explainers": [
          "explainers_example"
        ],
        "ipaddress_version": 0,
        "tags": [
          "tags_example"
        ],
        "first_ipv6": "first_ipv6_example",
        "last_ipv6": "last_ipv6_example",
        "annotation": "annotation_example",
        "has_bu_overrides": false
      }
    ]
  }
}

Bad Request. Got an invalid JSON.

Body

replyObject

The query results upon error.

RESPONSE

{
  "reply": {}
}

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

Body

replyObject

The query results upon error.

RESPONSE

{
  "reply": {}
}

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

Body

replyObject

The query results upon error.

RESPONSE

{
  "reply": {}
}

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

Body

replyObject

The query results upon error.

RESPONSE

{
  "reply": {}
}

Unprocessable Entity

Body

codeInteger

Error code

statusString

Error name

messageString

Error message

errorsObject

Errors

RESPONSE

{
  "code": 0,
  "status": "status_example",
  "message": "message_example",
  "errors": {}
}

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

Body

replyObject

The query results upon error.

RESPONSE

{
  "reply": {}
}