Get All Assets

post /public_api/v1/assets/get_assets_internet_exposure/

Get a list of all your assets or a filtered list of your assets.
The maximum result limit is 5000 assets.
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}}

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_assets_internet_exposure/'
    

      -d
      '{
  "request_data" : {
    "search_from" : 0,
    "next_page_token" : "next_page_token",
    "filters" : [ {
      "field" : "name",
      "value" : "AsmAssetsFilter_value",
      "operator" : "in"
    }, {
      "field" : "name",
      "value" : "AsmAssetsFilter_value",
      "operator" : "in"
    } ],
    "sort" : {
      "field" : "name",
      "keyword" : "asc"
    },
    "search_to" : 0,
    "use_page_token" : true
  }
}'
    


      

import http.client

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

payload = "{\"request_data\":{\"filters\":[{\"field\":\"name\",\"operator\":\"in\",\"value\":\"string\"}],\"search_from\":0,\"search_to\":500,\"sort\":{\"field\":\"first_observed\",\"keyword\":\"ASC\"},\"use_page_token\":true,\"next_page_token\":\"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_assets_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_assets_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\":{\"filters\":[{\"field\":\"name\",\"operator\":\"in\",\"value\":\"string\"}],\"search_from\":0,\"search_to\":500,\"sort\":{\"field\":\"first_observed\",\"keyword\":\"ASC\"},\"use_page_token\":true,\"next_page_token\":\"string\"}}"

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

const data = JSON.stringify({
  "request_data": {
    "filters": [
      {
        "field": "name",
        "operator": "in",
        "value": "string"
      }
    ],
    "search_from": 0,
    "search_to": 500,
    "sort": {
      "field": "first_observed",
      "keyword": "ASC"
    },
    "use_page_token": true,
    "next_page_token": "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_assets_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_assets_internet_exposure/")
  .header("authorization", "{{api_key}}")
  .header("x-xdr-auth-id", "{{api_key_id}}")
  .header("content-type", "application/json")
  .body("{\"request_data\":{\"filters\":[{\"field\":\"name\",\"operator\":\"in\",\"value\":\"string\"}],\"search_from\":0,\"search_to\":500,\"sort\":{\"field\":\"first_observed\",\"keyword\":\"ASC\"},\"use_page_token\":true,\"next_page_token\":\"string\"}}")
  .asString();

import Foundation

let headers = [
  "authorization": "{{api_key}}",
  "x-xdr-auth-id": "{{api_key_id}}",
  "content-type": "application/json"
]
let parameters = ["request_data": [
    "filters": [
      [
        "field": "name",
        "operator": "in",
        "value": "string"
      ]
    ],
    "search_from": 0,
    "search_to": 500,
    "sort": [
      "field": "first_observed",
      "keyword": "ASC"
    ],
    "use_page_token": true,
    "next_page_token": "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_assets_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_assets_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\":{\"filters\":[{\"field\":\"name\",\"operator\":\"in\",\"value\":\"string\"}],\"search_from\":0,\"search_to\":500,\"sort\":{\"field\":\"first_observed\",\"keyword\":\"ASC\"},\"use_page_token\":true,\"next_page_token\":\"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_assets_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\":{\"filters\":[{\"field\":\"name\",\"operator\":\"in\",\"value\":\"string\"}],\"search_from\":0,\"search_to\":500,\"sort\":{\"field\":\"first_observed\",\"keyword\":\"ASC\"},\"use_page_token\":true,\"next_page_token\":\"string\"}}");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://api-/%7B%7Bfqdn%7D%7D/public_api/v1/assets/get_assets_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\":{\"filters\":[{\"field\":\"name\",\"operator\":\"in\",\"value\":\"string\"}],\"search_from\":0,\"search_to\":500,\"sort\":{\"field\":\"first_observed\",\"keyword\":\"ASC\"},\"use_page_token\":true,\"next_page_token\":\"string\"}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Body parameters

required

application/json

request_dataobject

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

filtersarray

An array of filter fields.

[

fieldstring (Enum)

Identifies the assets field the filter is matching. Case-sensitive.

Allowed values:"name""has_xdr_agent""ip_address""externally_detected_providers""type""has_active_external_services""mac_addresses""externally_inferred_cves""aws_cloud_tags""gcp_cloud_tags""azure_cloud_tags""tags""business_units_list""ipv6_address""has_bu_overrides""asm_id_list""first_observed""last_observed"

operatorstring (Enum)

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

contains / not_contains: use with externally_detected_providers, externally_inferred_cves, name
eq / neq: use with name, ip_address, has_bu_overrides.
gte: Filters data from a specific timestamp onwards. Use with first_observed, last_observed.
in: use with has_active_external_services, type, business_units_list, ip_address.
lte: Filters data up to a specific timestamp. Use with first_observed, last_observed.
range: Filters data between two specific timestamps.Use with first_observed, last_observed.
relative_timestamp: Filters data relative to the current time (e.g., last 30 days). Use with first_observed or last_observed.

Allowed values:"in""contains""neq""eq""not_contains""gte""lte""range""relative_timestamp"

valueobject

Value depends on the filter field used.

business_un****its_list: string or list of strings in the format "BU name" or "BU:BU name", for example “Acme & Co, Inc.” or “BU:Acme & Co, Inc.”
externally_detected_providers: string
externally_inferred_cves: string
first_observed — values in milliseconds format
- with gte or lte operator, specify a specific date or time as a timestamp in milliseconds format
- with range operator, specify "to" and "from" values as timestamps in milliseconds format "value": { "from": "{{previous30Days}}","to": "{{previous7Days}}"
- with relative_timestamp operator, specify time interval to look back on (24H, 7D, 30D, etc.) as a value in milliseconds format
has_active_external_services: list of strings (enum values: "yes", "no", "unknown")
has_bu_overrides: boolean ("true" or "false")
ip_address: list of strings
ipv6_address: string
last_observed — values in milliseconds format
- with gte or lte operator, specify a specific date or time as a timestamp in milliseconds format
- with range operator, specify "to" and "from" values as timestamps in milliseconds format, as follows "value": { "from": "{{previous30Days}}","to": "{{previous7Days}}"
- with relative_timestamp operator, specify time interval to look back on (24H, 7D, 30D, etc.) as a value in milliseconds format
name: string
type: List of strings (enum values: "certificate", "cloud_integration", "cloud_compute_instance", "domain", "unassociated_responsive_ip")
tags: List of strings indicating the tags to filter on in the format "tag-family:tag-name", for example "AR:registered to you".
type: string

One of

string

Value depends on the filter field used.

business_un****its_list: string or list of strings in the format "BU name" or "BU:BU name", for example “Acme & Co, Inc.” or “BU:Acme & Co, Inc.”
externally_detected_providers: string
externally_inferred_cves: string
first_observed — values in milliseconds format
- with gte or lte operator, specify a specific date or time as a timestamp in milliseconds format
- with range operator, specify "to" and "from" values as timestamps in milliseconds format "value": { "from": "{{previous30Days}}","to": "{{previous7Days}}"
- with relative_timestamp operator, specify time interval to look back on (24H, 7D, 30D, etc.) as a value in milliseconds format
has_active_external_services: list of strings (enum values: "yes", "no", "unknown")
has_bu_overrides: boolean ("true" or "false")
ip_address: list of strings
ipv6_address: string
last_observed — values in milliseconds format
- with gte or lte operator, specify a specific date or time as a timestamp in milliseconds format
- with range operator, specify "to" and "from" values as timestamps in milliseconds format, as follows "value": { "from": "{{previous30Days}}","to": "{{previous7Days}}"
- with relative_timestamp operator, specify time interval to look back on (24H, 7D, 30D, etc.) as a value in milliseconds format
name: string
type: List of strings (enum values: "certificate", "cloud_integration", "cloud_compute_instance", "domain", "unassociated_responsive_ip")
tags: List of strings indicating the tags to filter on in the format "tag-family:tag-name", for example "AR:registered to you".
type: string

boolean

Value depends on the filter field used.

business_un****its_list: string or list of strings in the format "BU name" or "BU:BU name", for example “Acme & Co, Inc.” or “BU:Acme & Co, Inc.”
externally_detected_providers: string
externally_inferred_cves: string
first_observed — values in milliseconds format
- with gte or lte operator, specify a specific date or time as a timestamp in milliseconds format
- with range operator, specify "to" and "from" values as timestamps in milliseconds format "value": { "from": "{{previous30Days}}","to": "{{previous7Days}}"
- with relative_timestamp operator, specify time interval to look back on (24H, 7D, 30D, etc.) as a value in milliseconds format
has_active_external_services: list of strings (enum values: "yes", "no", "unknown")
has_bu_overrides: boolean ("true" or "false")
ip_address: list of strings
ipv6_address: string
last_observed — values in milliseconds format
- with gte or lte operator, specify a specific date or time as a timestamp in milliseconds format
- with range operator, specify "to" and "from" values as timestamps in milliseconds format, as follows "value": { "from": "{{previous30Days}}","to": "{{previous7Days}}"
- with relative_timestamp operator, specify time interval to look back on (24H, 7D, 30D, etc.) as a value in milliseconds format
name: string
type: List of strings (enum values: "certificate", "cloud_integration", "cloud_compute_instance", "domain", "unassociated_responsive_ip")
tags: List of strings indicating the tags to filter on in the format "tag-family:tag-name", for example "AR:registered to you".
type: string

Array

integer

Value depends on the filter field used.

business_un****its_list: string or list of strings in the format "BU name" or "BU:BU name", for example “Acme & Co, Inc.” or “BU:Acme & Co, Inc.”
externally_detected_providers: string
externally_inferred_cves: string
first_observed — values in milliseconds format
- with gte or lte operator, specify a specific date or time as a timestamp in milliseconds format
- with range operator, specify "to" and "from" values as timestamps in milliseconds format "value": { "from": "{{previous30Days}}","to": "{{previous7Days}}"
- with relative_timestamp operator, specify time interval to look back on (24H, 7D, 30D, etc.) as a value in milliseconds format
has_active_external_services: list of strings (enum values: "yes", "no", "unknown")
has_bu_overrides: boolean ("true" or "false")
ip_address: list of strings
ipv6_address: string
last_observed — values in milliseconds format
- with gte or lte operator, specify a specific date or time as a timestamp in milliseconds format
- with range operator, specify "to" and "from" values as timestamps in milliseconds format, as follows "value": { "from": "{{previous30Days}}","to": "{{previous7Days}}"
- with relative_timestamp operator, specify time interval to look back on (24H, 7D, 30D, etc.) as a value in milliseconds format
name: string
type: List of strings (enum values: "certificate", "cloud_integration", "cloud_compute_instance", "domain", "unassociated_responsive_ip")
tags: List of strings indicating the tags to filter on in the format "tag-family:tag-name", for example "AR:registered to you".
type: string

]

search_frominteger

Represents the start offset index of results.

search_tointeger

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.
Max value - 5000

Default:500

sortobject

Identifies the sort order for the result set.

fieldstring (Enum)

Case sensitive.

Default:"name"

Allowed values:"first_observed""name""last_observed"

keywordstring (Enum)

Case sensitive.

Default:"asc"

Allowed values:"ASC""asc""DESC""desc"

Free-Form object

use_page_tokenboolean

Use "use_page_token":true in the initial request to paginate the response data.

next_page_tokenstring

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.'

Free-Form object

REQUEST

{
  "request_data": {
    "filters": [
      {
        "field": "name",
        "operator": "in",
        "value": "string"
      }
    ],
    "search_from": 0,
    "search_to": 500,
    "sort": {
      "field": "name",
      "keyword": "asc"
    },
    "use_page_token": true,
    "next_page_token": "string"
  }
}

{
  "request_data": {
    "filters": [
      {
        "field": "last_observed",
        "value": {
          "from": "{{previous30Days}}",
          "to": "{{previous7Days}}"
        },
        "operator": "range"
      }
    ]
  }
}

Responses

Body

application/json

replyobject

total_countinteger

result_countinteger

assets_internet_exposurearray

[

agent_idstring

annotationstring

asm_idsarray[string]

asm_va_scorenumber

asset_explainersarray[string]

asset_typestring

aws_cloud_tagsarray[string]

azure_cloud_tagsarray[string]

business_unitsarray

[

creation_timeinteger

familystring

family_aliasstring

idstring

is_activeinteger

namestring

parent_idstring

update_timeinteger

Free-Form object

]

certificate_algorithmstring

certificate_classificationsarray[string]

certificate_detailsobject

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

certificate_expiry_dateinteger

certificate_issuerstring

cloud_idstring

cloud_providerstring

cloud_resource_typestring

creation_timeinteger

date_addedinteger

domainstring

domain_detailsobjectrequired

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

domain_resolvesboolean

extended_propertiesobject

last_start_timeinteger

machine_typestring

network_interfacesarray

[

idstring

ipstring

subnet_idstring

vpc_idstring

Free-Form object

]

private_ipsarray[string]

public_ipsarray[string]

volumearray

[

bootboolean

idstring

namestring

typestring

Free-Form object

]

Free-Form object

external_ipsarray[string]

externally_detected_providersarray[string]

externally_inferred_cvesarray[string]

first_observedinteger

gcp_cloud_tagsarray[string]

geo_regionstring

has_active_externally_servicesboolean

has_alertsboolean

has_bu_overridesboolean

has_incidentsboolean

has_xdr_agentstring

hierarchystring

internal_ipsarray[string]

iot_categorystring

iot_modelstring

iot_profilestring

ip_rangesarray[string]

ipsarray[string]

ipv6sarray[string]

last_observedinteger

last_sampled_ipinteger

mac_addressesarray[string]

management_statusarray[string]

namestring

open_portsarray[integer]

operation_systemstring

project_namestring

provider_accountstring

recent_ipsarray

[

idstring

ipinteger

ipv6string

sourceobjectrequired

namestring

Free-Form object

providerobjectrequired

namestring

additionalProviderInfostring

isCdnboolean

legacyNamestring

displayNamestring

cdnboolean

Free-Form object

lastObservedinteger

firstObservedinteger

Free-Form object

]

regionstring

sensorarray[string]

service_typearray[string]

sub_regionarray[string]

tagsarray[string]

vpc_name_idstring

Free-Form object

]

next_page_tokenstring

This attribute is only returned if use_page_token is provided in the request with value true

Free-Form object

RESPONSE
{
  "reply": {
    "total_count": 0,
    "result_count": 0,
    "assets_internet_exposure": [
      {
        "agent_id": "example",
        "annotation": "example",
        "asm_ids": [
          "example"
        ],
        "asm_va_score": 0.1,
        "asset_explainers": [
          "example"
        ],
        "asset_type": "example",
        "aws_cloud_tags": [
          "example"
        ],
        "azure_cloud_tags": [
          "example"
        ],
        "business_units": [
          [
            {
              "creation_time": 0,
              "family": "example",
              "family_alias": "example",
              "id": "example",
              "is_active": 0,
              "name": "example",
              "parent_id": "example",
              "update_time": 0
            }
          ]
        ],
        "certificate_algorithm": "example",
        "certificate_classifications": [
          "example"
        ],
        "certificate_details": {
          "issuer": "example",
          "issuerAlternativeNames": "example",
          "issuerCountry": "example",
          "issuerEmail": "example",
          "issuerLocality": "example",
          "issuerName": "example",
          "issuerOrg": "example",
          "formattedIssuerOrg": "example",
          "issuerOrgUnit": "example",
          "issuerState": "example",
          "publicKey": "example",
          "publicKeyAlgorithm": "example",
          "publicKeyRsaExponent": 0,
          "signatureAlgorithm": "example",
          "subject": "example",
          "subjectAlternativeNames": "example",
          "subjectCountry": "example",
          "subjectEmail": "example",
          "subjectLocality": "example",
          "subjectName": "example",
          "subjectOrg": "example",
          "subjectOrgUnit": "example",
          "subjectState": "example",
          "serialNumber": "example",
          "validNotBefore": 0,
          "validNotAfter": 0,
          "version": "example",
          "publicKeyBits": 0,
          "publicKeyModulus": "example",
          "publicKeySpki": "example",
          "sha1Fingerprint": "example",
          "sha256Fingerprint": "example",
          "md5Fingerprint": "example"
        },
        "certificate_expiry_date": 0,
        "certificate_issuer": "example",
        "cloud_id": "example",
        "cloud_provider": "example",
        "cloud_resource_type": "example",
        "creation_time": 0,
        "date_added": 0,
        "domain": "example",
        "domain_details": {
          "admin": {
            "city": "example",
            "country": "example",
            "emailAddress": "example",
            "faxExtension": "example",
            "faxNumber": "example",
            "name": "example",
            "organization": "example",
            "phoneExtension": "example",
            "phoneNumber": "example",
            "postalCode": "example",
            "province": "example",
            "registryId": "example",
            "street": "example"
          },
          "alignedRegistrar": "example",
          "collectionTime": 0,
          "creationDate": 0,
          "dnssec": "example",
          "domainName": "example",
          "domainStatuses": [
            "example"
          ],
          "dropped": false,
          "nameServers": [
            "example"
          ],
          "registrant": {
            "city": "example",
            "country": "example",
            "emailAddress": "example",
            "faxExtension": "example",
            "faxNumber": "example",
            "name": "example",
            "organization": "example",
            "phoneExtension": "example",
            "phoneNumber": "example",
            "postalCode": "example",
            "province": "example",
            "registryId": "example",
            "street": "example"
          },
          "registrar": {
            "abuseContactEmail": "example",
            "abuseContactPhone": "example",
            "alignedName": "example",
            "ianaId": 0.1,
            "name": "example",
            "registrationExpirationDate": 0.1,
            "url": "example",
            "whoisServer": "example"
          },
          "registryDomainId": "example",
          "registryExpiryDate": 0,
          "reseller": "example",
          "retrievedDate": 0,
          "tech": {
            "city": "example",
            "country": "example",
            "emailAddress": "example",
            "faxExtension": "example",
            "faxNumber": "example",
            "name": "example",
            "organization": "example",
            "phoneExtension": "example",
            "phoneNumber": "example",
            "postalCode": "example",
            "province": "example",
            "registryId": "example",
            "street": "example"
          },
          "updatedDate": 0
        },
        "domain_resolves": false,
        "extended_properties": {
          "last_start_time": 0,
          "machine_type": "example",
          "network_interfaces": [
            {
              "id": "example",
              "ip": "example",
              "subnet_id": "example",
              "vpc_id": "example"
            }
          ],
          "private_ips": [
            "example"
          ],
          "public_ips": [
            "example"
          ],
          "volume": [
            {
              "boot": false,
              "id": "example",
              "name": "example",
              "type": "example"
            }
          ]
        },
        "external_ips": [
          "example"
        ],
        "externally_detected_providers": [
          "example"
        ],
        "externally_inferred_cves": [
          "example"
        ],
        "first_observed": 0,
        "gcp_cloud_tags": [
          "example"
        ],
        "geo_region": "example",
        "has_active_externally_services": false,
        "has_alerts": false,
        "has_bu_overrides": false,
        "has_incidents": false,
        "has_xdr_agent": "example",
        "hierarchy": "example",
        "internal_ips": [
          "example"
        ],
        "iot_category": "example",
        "iot_model": "example",
        "iot_profile": "example",
        "ip_ranges": [
          "example"
        ],
        "ips": [
          "example"
        ],
        "ipv6s": [
          "example"
        ],
        "last_observed": 0,
        "last_sampled_ip": 0,
        "mac_addresses": [
          "example"
        ],
        "management_status": [
          "example"
        ],
        "name": "example",
        "open_ports": [
          0
        ],
        "operation_system": "example",
        "project_name": "example",
        "provider_account": "example",
        "recent_ips": [
          {
            "id": "example",
            "ip": 0,
            "ipv6": "example",
            "source": {
              "name": "example"
            },
            "provider": {
              "name": "example",
              "additionalProviderInfo": "example",
              "isCdn": false,
              "legacyName": "example",
              "displayName": "example",
              "cdn": false
            },
            "lastObserved": 0,
            "firstObserved": 0
          }
        ],
        "region": "example",
        "sensor": [
          "example"
        ],
        "service_type": [
          "example"
        ],
        "sub_region": [
          "example"
        ],
        "tags": [
          "example"
        ],
        "vpc_name_id": "example"
      }
    ],
    "next_page_token": "example"
  }
}

Bad Request. Got an invalid JSON.

Body

application/json

replyobject

The query results upon error.

err_codestring

HTTP response code.

err_msgstring

Error message.

err_extrastring

Additional information describing the error.

Free-Form object

RESPONSE
{
  "reply": {
    "err_code": "example",
    "err_msg": "example",
    "err_extra": "example"
  }
}

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

Body

application/json

replyobject

The query results upon error.

err_codestring

HTTP response code.

err_msgstring

Error message.

err_extrastring

Additional information describing the error.

Free-Form object

RESPONSE
{
  "reply": {
    "err_code": "example",
    "err_msg": "example",
    "err_extra": "example"
  }
}

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

Body

application/json

replyobject

The query results upon error.

err_codestring

HTTP response code.

err_msgstring

Error message.

err_extrastring

Additional information describing the error.

Free-Form object

RESPONSE
{
  "reply": {
    "err_code": "example",
    "err_msg": "example",
    "err_extra": "example"
  }
}

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

Body

application/json

replyobject

The query results upon error.

err_codestring

HTTP response code.

err_msgstring

Error message.

err_extrastring

Additional information describing the error.

Free-Form object

RESPONSE
{
  "reply": {
    "err_code": "example",
    "err_msg": "example",
    "err_extra": "example"
  }
}

Unprocessable Entity

Body

application/json

codeinteger

Error code

statusstring

Error name

messagestring

Error message

errorsobject

Errors

RESPONSE
{
  "code": 0,
  "status": "example",
  "message": "example",
  "errors": {}
}

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

Body

application/json

replyobject

The query results upon error.

err_codestring

HTTP response code.

err_msgstring

Error message.

err_extrastring

Additional information describing the error.

Free-Form object

RESPONSE
{
  "reply": {
    "err_code": "example",
    "err_msg": "example",
    "err_extra": "example"
  }
}