Get Asset Details

post /public_api/v1/assets/get_asset_internet_exposure/

Get asset details according to the asset ID. You can send up to 20 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_dataObjectrequired

(Required) A dictionary containing the API request fields. An empty dictionary returns all results.

asm_id_listArray[string]

A list of string(s) representing the asset IDs.

Free-Form object

REQUEST BODY

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

CLIENT REQUEST

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

import http.client

conn = http.client.HTTPSConnection("api-")

payload = "{\"request_data\":{\"asm_id_list\":[\"string\"]}}"

headers = {
    'authorization': "{{api_key}}",
    'x-xdr-auth-id': "{{api_key_id}}",
    'content-type': "application/json"
    }

conn.request("POST", "%7B%7Bfqdn%7D%7D/public_api/v1/assets/get_asset_internet_exposure/", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api-/%7B%7Bfqdn%7D%7D/public_api/v1/assets/get_asset_internet_exposure/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["authorization"] = '{{api_key}}'
request["x-xdr-auth-id"] = '{{api_key_id}}'
request["content-type"] = 'application/json'
request.body = "{\"request_data\":{\"asm_id_list\":[\"string\"]}}"

response = http.request(request)
puts response.read_body

const data = JSON.stringify({
  "request_data": {
    "asm_id_list": [
      "string"
    ]
  }
});

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api-/%7B%7Bfqdn%7D%7D/public_api/v1/assets/get_asset_internet_exposure/");
xhr.setRequestHeader("authorization", "{{api_key}}");
xhr.setRequestHeader("x-xdr-auth-id", "{{api_key_id}}");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

HttpResponse<String> response = Unirest.post("https://api-/%7B%7Bfqdn%7D%7D/public_api/v1/assets/get_asset_internet_exposure/")
  .header("authorization", "{{api_key}}")
  .header("x-xdr-auth-id", "{{api_key_id}}")
  .header("content-type", "application/json")
  .body("{\"request_data\":{\"asm_id_list\":[\"string\"]}}")
  .asString();

import Foundation

let headers = [
  "authorization": "{{api_key}}",
  "x-xdr-auth-id": "{{api_key_id}}",
  "content-type": "application/json"
]
let parameters = ["request_data": ["asm_id_list": ["string"]]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api-/%7B%7Bfqdn%7D%7D/public_api/v1/assets/get_asset_internet_exposure/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-/%7B%7Bfqdn%7D%7D/public_api/v1/assets/get_asset_internet_exposure/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"request_data\":{\"asm_id_list\":[\"string\"]}}",
  CURLOPT_HTTPHEADER => [
    "authorization: {{api_key}}",
    "content-type: application/json",
    "x-xdr-auth-id: {{api_key_id}}"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api-/%7B%7Bfqdn%7D%7D/public_api/v1/assets/get_asset_internet_exposure/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "authorization: {{api_key}}");
headers = curl_slist_append(headers, "x-xdr-auth-id: {{api_key_id}}");
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"request_data\":{\"asm_id_list\":[\"string\"]}}");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://api-/%7B%7Bfqdn%7D%7D/public_api/v1/assets/get_asset_internet_exposure/");
var request = new RestRequest(Method.POST);
request.AddHeader("authorization", "{{api_key}}");
request.AddHeader("x-xdr-auth-id", "{{api_key_id}}");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\"request_data\":{\"asm_id_list\":[\"string\"]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Responses

Body

replyObject

detailsArray

[

asm_idsString

nameString

typeString

last_observedInteger

first_observedInteger

externally_detected_providersArray[string]

createdInteger

ipsArray

[

ipInteger

ipv6String

protocolString

providerString

geolocationObject

latitudeNumber

longitudeNumber

countryCodeString

cityString

regionCodeString

timeZoneString

Free-Form object

activityStatusString

lastObservedInteger

firstObservedInteger

Free-Form object

]

active_service_idsArray[string]

all_service_idsArray[string]

active_external_services_typesArray[string]

domainString

certificate_issuerString

certificate_algorithmString

certificate_classificationsArray[string]

resolvesBoolean

detailsObject

providerDetailsArray

[

nameString

displayNameString

firstObservedInteger

lastObservedInteger

Free-Form object

]

domainString

topLevelAssetMapperDomainString

domainAssetTypeString

isPaidLevelDomainBoolean

domainDetailsObjectrequired

adminObject

cityString

countryString

emailAddressString

faxExtensionString

faxNumberString

nameString

organizationString

phoneExtensionString

phoneNumberString

postalCodeString

provinceString

registryIdString

streetString

Free-Form object

alignedRegistrarString

collectionTimeInteger

creationDateInteger

dnssecString

domainNameString

domainStatusesArray[string]

droppedBoolean

nameServersArray[string]

registrantObject

cityString

countryString

emailAddressString

faxExtensionString

faxNumberString

nameString

organizationString

phoneExtensionString

phoneNumberString

postalCodeString

provinceString

registryIdString

streetString

Free-Form object

registrarObject

abuseContactEmailString

abuseContactPhoneString

alignedNameString

ianaIdNumber

nameString

registrationExpirationDateNumber

urlString

whoisServerString

Free-Form object

registryDomainIdString

registryExpiryDateInteger

resellerString

retrievedDateInteger

techObject

cityString

countryString

emailAddressString

faxExtensionString

faxNumberString

nameString

organizationString

phoneExtensionString

phoneNumberString

postalCodeString

provinceString

registryIdString

streetString

Free-Form object

updatedDateInteger

Free-Form object

dnsZoneString

latestSampledIpNumber

latestSampledIpv6String

subdomainMetadataObject

recentIpsArray

[

idString

ipInteger

ipv6String

sourceObjectrequired

nameString

Free-Form object

providerObjectrequired

nameString

additionalProviderInfoString

isCdnBoolean

legacyNameString

displayNameString

cdnBoolean

Free-Form object

lastObservedInteger

firstObservedInteger

Free-Form object

]

certificateDetailsObject

issuerString

issuerAlternativeNamesString

issuerCountryString

issuerEmailString

issuerLocalityString

issuerNameString

issuerOrgString

formattedIssuerOrgString

issuerOrgUnitString

issuerStateString

publicKeyString

publicKeyAlgorithmString

publicKeyRsaExponentInteger

signatureAlgorithmString

subjectString

subjectAlternativeNamesString

subjectCountryString

subjectEmailString

subjectLocalityString

subjectNameString

subjectOrgString

subjectOrgUnitString

subjectStateString

serialNumberString

validNotBeforeInteger

validNotAfterInteger

versionString

publicKeyBitsInteger

publicKeyModulusString

publicKeySpkiString

sha1FingerprintString

sha256FingerprintString

md5FingerprintString

Free-Form object

inferredCvesObservedArray

[

inferredCveArray

[

cveIdString

cvssScoreV2String

cveSeverityV2String

cvssScoreV3Number

cveSeverityV3String

inferredCveMatchMetadataArray

[

inferredCveMatchTypeString

productString

confidenceString

vendorString

versionString

Free-Form object

]

epssScoreString

cvssTemporalScoreV3String

cvssTemporalScoreV2String

publishedExploitsCountString

reportedExploitedInTheWildString

firstExploitPublishedString

firstReportedThreatActorString

firstReportedRansomwareString

firstReportedBotnetString

lastExploitPublishedString

lastReportedThreatActorString

lastReportedRansomwareString

lastReportedBotnetString

cisaKevDateAddedString

Free-Form object

]

activityStatusString

lastObservedInteger

firstObservedInteger

Free-Form object

]

sourceString

ip_rangesObject

Keys should be valid IPv4 address

Additional propertiesObjectrequired

_IS_DELETEDString

_LAST_MODIFIED_TIMEInteger

ACTIVE_RESPONSIVE_IPS_COUNTInteger

ANNOTATIONString

ASN_COUNTRIESArray[string]

ASN_HANDLESArray[string]

ASN_RECORD_NAMESArray[string]

ASN_REGISTRIESArray[string]

BUSINESS_UNITArray

[

tag_idString

tag_nameString

Free-Form object

]

CITIESArray[string]

DATE_ADDEDInteger

DETAILSObject

networkRecordsObjectrequired

firstIpString

firstIpv6String

handleString

lastChangedInteger

lastIpString

lastIpv6String

nameString

organizationRecordsArray

[

addressString

dateAddedInteger

emailString

firstRegisteredInteger

formattedNameString

handleString

kindString

lastChangedInteger

orgString

phoneString

remarksString

rolesArray[string]

Free-Form object

]

remarksString

whoIsServerString

Free-Form object

ENTITY_TYPESArray[string]

EXPLAINERSArray[string]

FIRST_IPString

FIRST_IPV6String

HAS_BU_OVERRIDESBoolean

IP_RANGE_IDString

IP_VERSIONInteger

IS_SUBRANGEBoolean

LAST_IPString

LAST_IPV6String

ORGANIZATION_HANDLESString

REGIONSArray[string]

SBAC_TAGSArray

[

tag_idString

tag_nameString

Free-Form object

]

SECTORSArray[string]

SIZEInteger

STATESArray[string]

SUBRANGE_CREATED_EMAILString

SUBRANGE_CREATED_TSInteger

SUBRANGE_CREATED_USERString

SYSTEM_RANGE_FIRST_IPString

SYSTEM_RANGE_IDString

SYSTEM_RANGE_LAST_IPString

TAGSArray

[

tag_idString

tag_nameString

Free-Form object

]

Free-Form object

external_servicesArray

[

serviceTypeString

serviceKeyString

activityStatusString

Free-Form object

]

externally_inferred_vulnerability_scoreNumber

externally_inferred_cvesArray[string]

explainersArray[string]

tagsArray[string]

ipv6sArray[string]

has_bu_overridesBoolean

Free-Form object

]

Free-Form object

RESPONSE

{
  "reply": {
    "details": [
      {
        "asm_ids": "asm_ids_example",
        "name": "name_example",
        "type": "type_example",
        "last_observed": 0,
        "first_observed": 0,
        "externally_detected_providers": [
          "externally_detected_providers_example"
        ],
        "created": 0,
        "ips": [
          {
            "ip": 0,
            "ipv6": "ipv6_example",
            "protocol": "protocol_example",
            "provider": "provider_example",
            "geolocation": {
              "latitude": 0.0,
              "longitude": 0.0,
              "countryCode": "countryCode_example",
              "city": "city_example",
              "regionCode": "regionCode_example",
              "timeZone": "timeZone_example"
            },
            "activityStatus": "activityStatus_example",
            "lastObserved": 0,
            "firstObserved": 0
          }
        ],
        "active_service_ids": [
          "active_service_ids_example"
        ],
        "all_service_ids": [
          "all_service_ids_example"
        ],
        "active_external_services_types": [
          "active_external_services_types_example"
        ],
        "domain": "domain_example",
        "certificate_issuer": "certificate_issuer_example",
        "certificate_algorithm": "certificate_algorithm_example",
        "certificate_classifications": [
          "certificate_classifications_example"
        ],
        "resolves": false,
        "details": {
          "providerDetails": [
            {
              "name": "name_example",
              "displayName": "displayName_example",
              "firstObserved": 0,
              "lastObserved": 0
            }
          ],
          "domain": "domain_example",
          "topLevelAssetMapperDomain": "topLevelAssetMapperDomain_example",
          "domainAssetType": "domainAssetType_example",
          "isPaidLevelDomain": false,
          "domainDetails": {
            "admin": {
              "city": "city_example",
              "country": "country_example",
              "emailAddress": "emailAddress_example",
              "faxExtension": "faxExtension_example",
              "faxNumber": "faxNumber_example",
              "name": "name_example",
              "organization": "organization_example",
              "phoneExtension": "phoneExtension_example",
              "phoneNumber": "phoneNumber_example",
              "postalCode": "postalCode_example",
              "province": "province_example",
              "registryId": "registryId_example",
              "street": "street_example"
            },
            "alignedRegistrar": "alignedRegistrar_example",
            "collectionTime": 0,
            "creationDate": 0,
            "dnssec": "dnssec_example",
            "domainName": "domainName_example",
            "domainStatuses": [
              "domainStatuses_example"
            ],
            "dropped": false,
            "nameServers": [
              "nameServers_example"
            ],
            "registrant": {
              "city": "city_example",
              "country": "country_example",
              "emailAddress": "emailAddress_example",
              "faxExtension": "faxExtension_example",
              "faxNumber": "faxNumber_example",
              "name": "name_example",
              "organization": "organization_example",
              "phoneExtension": "phoneExtension_example",
              "phoneNumber": "phoneNumber_example",
              "postalCode": "postalCode_example",
              "province": "province_example",
              "registryId": "registryId_example",
              "street": "street_example"
            },
            "registrar": {
              "abuseContactEmail": "abuseContactEmail_example",
              "abuseContactPhone": "abuseContactPhone_example",
              "alignedName": "alignedName_example",
              "ianaId": 0.0,
              "name": "name_example",
              "registrationExpirationDate": 0.0,
              "url": "url_example",
              "whoisServer": "whoisServer_example"
            },
            "registryDomainId": "registryDomainId_example",
            "registryExpiryDate": 0,
            "reseller": "reseller_example",
            "retrievedDate": 0,
            "tech": {
              "city": "city_example",
              "country": "country_example",
              "emailAddress": "emailAddress_example",
              "faxExtension": "faxExtension_example",
              "faxNumber": "faxNumber_example",
              "name": "name_example",
              "organization": "organization_example",
              "phoneExtension": "phoneExtension_example",
              "phoneNumber": "phoneNumber_example",
              "postalCode": "postalCode_example",
              "province": "province_example",
              "registryId": "registryId_example",
              "street": "street_example"
            },
            "updatedDate": 0
          },
          "dnsZone": "dnsZone_example",
          "latestSampledIp": 0.0,
          "latestSampledIpv6": "latestSampledIpv6_example",
          "subdomainMetadata": {},
          "recentIps": [
            {
              "id": "id_example",
              "ip": 0,
              "ipv6": "ipv6_example",
              "source": {
                "name": "name_example"
              },
              "provider": {
                "name": "name_example",
                "additionalProviderInfo": "additionalProviderInfo_example",
                "isCdn": false,
                "legacyName": "legacyName_example",
                "displayName": "displayName_example",
                "cdn": false
              },
              "lastObserved": 0,
              "firstObserved": 0
            }
          ],
          "certificateDetails": {
            "issuer": "issuer_example",
            "issuerAlternativeNames": "issuerAlternativeNames_example",
            "issuerCountry": "issuerCountry_example",
            "issuerEmail": "issuerEmail_example",
            "issuerLocality": "issuerLocality_example",
            "issuerName": "issuerName_example",
            "issuerOrg": "issuerOrg_example",
            "formattedIssuerOrg": "formattedIssuerOrg_example",
            "issuerOrgUnit": "issuerOrgUnit_example",
            "issuerState": "issuerState_example",
            "publicKey": "publicKey_example",
            "publicKeyAlgorithm": "publicKeyAlgorithm_example",
            "publicKeyRsaExponent": 0,
            "signatureAlgorithm": "signatureAlgorithm_example",
            "subject": "subject_example",
            "subjectAlternativeNames": "subjectAlternativeNames_example",
            "subjectCountry": "subjectCountry_example",
            "subjectEmail": "subjectEmail_example",
            "subjectLocality": "subjectLocality_example",
            "subjectName": "subjectName_example",
            "subjectOrg": "subjectOrg_example",
            "subjectOrgUnit": "subjectOrgUnit_example",
            "subjectState": "subjectState_example",
            "serialNumber": "serialNumber_example",
            "validNotBefore": 0,
            "validNotAfter": 0,
            "version": "version_example",
            "publicKeyBits": 0,
            "publicKeyModulus": "publicKeyModulus_example",
            "publicKeySpki": "publicKeySpki_example",
            "sha1Fingerprint": "sha1Fingerprint_example",
            "sha256Fingerprint": "sha256Fingerprint_example",
            "md5Fingerprint": "md5Fingerprint_example"
          },
          "inferredCvesObserved": [
            {
              "inferredCve": [
                {
                  "cveId": "cveId_example",
                  "cvssScoreV2": "cvssScoreV2_example",
                  "cveSeverityV2": "cveSeverityV2_example",
                  "cvssScoreV3": 0.0,
                  "cveSeverityV3": "cveSeverityV3_example",
                  "inferredCveMatchMetadata": [
                    {
                      "inferredCveMatchType": "inferredCveMatchType_example",
                      "product": "product_example",
                      "confidence": "confidence_example",
                      "vendor": "vendor_example",
                      "version": "version_example"
                    }
                  ],
                  "epssScore": "epssScore_example",
                  "cvssTemporalScoreV3": "cvssTemporalScoreV3_example",
                  "cvssTemporalScoreV2": "cvssTemporalScoreV2_example",
                  "publishedExploitsCount": "publishedExploitsCount_example",
                  "reportedExploitedInTheWild": "reportedExploitedInTheWild_example",
                  "firstExploitPublished": "firstExploitPublished_example",
                  "firstReportedThreatActor": "firstReportedThreatActor_example",
                  "firstReportedRansomware": "firstReportedRansomware_example",
                  "firstReportedBotnet": "firstReportedBotnet_example",
                  "lastExploitPublished": "lastExploitPublished_example",
                  "lastReportedThreatActor": "lastReportedThreatActor_example",
                  "lastReportedRansomware": "lastReportedRansomware_example",
                  "lastReportedBotnet": "lastReportedBotnet_example",
                  "cisaKevDateAdded": "cisaKevDateAdded_example"
                }
              ],
              "activityStatus": "activityStatus_example",
              "lastObserved": 0,
              "firstObserved": 0
            }
          ],
          "source": "source_example",
          "ip_ranges": {
            "additionalProperties": {
              "_IS_DELETED": "_IS_DELETED_example",
              "_LAST_MODIFIED_TIME": 0,
              "ACTIVE_RESPONSIVE_IPS_COUNT": 0,
              "ANNOTATION": "ANNOTATION_example",
              "ASN_COUNTRIES": [
                "ASN_COUNTRIES_example"
              ],
              "ASN_HANDLES": [
                "ASN_HANDLES_example"
              ],
              "ASN_RECORD_NAMES": [
                "ASN_RECORD_NAMES_example"
              ],
              "ASN_REGISTRIES": [
                "ASN_REGISTRIES_example"
              ],
              "BUSINESS_UNIT": [
                {
                  "tag_id": "tag_id_example",
                  "tag_name": "tag_name_example"
                }
              ],
              "CITIES": [
                "CITIES_example"
              ],
              "DATE_ADDED": 0,
              "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"
                }
              },
              "ENTITY_TYPES": [
                "ENTITY_TYPES_example"
              ],
              "EXPLAINERS": [
                "EXPLAINERS_example"
              ],
              "FIRST_IP": "FIRST_IP_example",
              "FIRST_IPV6": "FIRST_IPV6_example",
              "HAS_BU_OVERRIDES": false,
              "IP_RANGE_ID": "IP_RANGE_ID_example",
              "IP_VERSION": 0,
              "IS_SUBRANGE": false,
              "LAST_IP": "LAST_IP_example",
              "LAST_IPV6": "LAST_IPV6_example",
              "ORGANIZATION_HANDLES": "ORGANIZATION_HANDLES_example",
              "REGIONS": [
                "REGIONS_example"
              ],
              "SBAC_TAGS": [
                {
                  "tag_id": "tag_id_example",
                  "tag_name": "tag_name_example"
                }
              ],
              "SECTORS": [
                "SECTORS_example"
              ],
              "SIZE": 0,
              "STATES": [
                "STATES_example"
              ],
              "SUBRANGE_CREATED_EMAIL": "SUBRANGE_CREATED_EMAIL_example",
              "SUBRANGE_CREATED_TS": 0,
              "SUBRANGE_CREATED_USER": "SUBRANGE_CREATED_USER_example",
              "SYSTEM_RANGE_FIRST_IP": "SYSTEM_RANGE_FIRST_IP_example",
              "SYSTEM_RANGE_ID": "SYSTEM_RANGE_ID_example",
              "SYSTEM_RANGE_LAST_IP": "SYSTEM_RANGE_LAST_IP_example",
              "TAGS": [
                {
                  "tag_id": "tag_id_example",
                  "tag_name": "tag_name_example"
                }
              ]
            }
          }
        },
        "external_services": [
          {
            "serviceType": "serviceType_example",
            "serviceKey": "serviceKey_example",
            "activityStatus": "activityStatus_example"
          }
        ],
        "externally_inferred_vulnerability_score": 0.0,
        "externally_inferred_cves": [
          "externally_inferred_cves_example"
        ],
        "explainers": [
          "explainers_example"
        ],
        "tags": [
          "tags_example"
        ],
        "ipv6s": [
          "ipv6s_example"
        ],
        "has_bu_overrides": false
      }
    ]
  }
}

Bad Request. Got an invalid JSON.

Body

replyObject

The query results upon error.

Free-Form object

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.

Free-Form object

RESPONSE

{
  "reply": {}
}

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

Body

replyObject

The query results upon error.

Free-Form object

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.

Free-Form object

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.

Free-Form object

RESPONSE

{
  "reply": {}
}