Asset Management
APIs for managing assets
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
api-key
{{api_key}}api-key-id
{{api_key_id}}OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/assets/get_assets_internet_exposure/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 201
{
"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"
}
}{
"reply": {
"total_count": 1,
"result_count": 1,
"assets_internet_exposure": [
{
"agent_id": "text",
"annotation": "text",
"asm_ids": [
"text"
],
"asm_va_score": 1,
"asset_explainers": [
"text"
],
"asset_type": "text",
"aws_cloud_tags": [
"text"
],
"azure_cloud_tags": [
"text"
],
"business_units": [
[
{
"creation_time": 1,
"family": "text",
"family_alias": "text",
"id": "text",
"is_active": 1,
"name": "text",
"parent_id": "text",
"update_time": 1,
"ANY_ADDITIONAL_PROPERTY": "anything"
}
]
],
"certificate_algorithm": "text",
"certificate_classifications": [
"text"
],
"certificate_details": {
"issuer": "text",
"issuerAlternativeNames": "text",
"issuerCountry": "text",
"issuerEmail": "text",
"issuerLocality": "text",
"issuerName": "text",
"issuerOrg": "text",
"formattedIssuerOrg": "text",
"issuerOrgUnit": "text",
"issuerState": "text",
"publicKey": "text",
"publicKeyAlgorithm": "text",
"publicKeyRsaExponent": 1,
"signatureAlgorithm": "text",
"subject": "text",
"subjectAlternativeNames": "text",
"subjectCountry": "text",
"subjectEmail": "text",
"subjectLocality": "text",
"subjectName": "text",
"subjectOrg": "text",
"subjectOrgUnit": "text",
"subjectState": "text",
"serialNumber": "text",
"validNotBefore": 1,
"validNotAfter": 1,
"version": "text",
"publicKeyBits": 1,
"publicKeyModulus": "text",
"publicKeySpki": "text",
"sha1Fingerprint": "text",
"sha256Fingerprint": "text",
"md5Fingerprint": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"certificate_expiry_date": 1,
"certificate_issuer": "text",
"cloud_id": "text",
"cloud_provider": "text",
"cloud_resource_type": "text",
"creation_time": 1,
"date_added": 1,
"domain": "text",
"domain_details": {
"admin": {
"city": "text",
"country": "text",
"emailAddress": "text",
"faxExtension": "text",
"faxNumber": "text",
"name": "text",
"organization": "text",
"phoneExtension": "text",
"phoneNumber": "text",
"postalCode": "text",
"province": "text",
"registryId": "text",
"street": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"alignedRegistrar": "text",
"collectionTime": 1,
"creationDate": 1,
"dnssec": "text",
"domainName": "text",
"domainStatuses": [
"text"
],
"dropped": true,
"nameServers": [
"text"
],
"registrant": {
"city": "text",
"country": "text",
"emailAddress": "text",
"faxExtension": "text",
"faxNumber": "text",
"name": "text",
"organization": "text",
"phoneExtension": "text",
"phoneNumber": "text",
"postalCode": "text",
"province": "text",
"registryId": "text",
"street": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"registrar": {
"abuseContactEmail": "text",
"abuseContactPhone": "text",
"alignedName": "text",
"ianaId": 1,
"name": "text",
"registrationExpirationDate": 1,
"url": "text",
"whoisServer": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"registryDomainId": "text",
"registryExpiryDate": 1,
"reseller": "text",
"retrievedDate": 1,
"tech": {
"city": "text",
"country": "text",
"emailAddress": "text",
"faxExtension": "text",
"faxNumber": "text",
"name": "text",
"organization": "text",
"phoneExtension": "text",
"phoneNumber": "text",
"postalCode": "text",
"province": "text",
"registryId": "text",
"street": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"updatedDate": 1,
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"domain_resolves": true,
"extended_properties": {
"last_start_time": 1,
"machine_type": "text",
"network_interfaces": [
{
"id": "text",
"ip": "text",
"subnet_id": "text",
"vpc_id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"private_ips": [
"text"
],
"public_ips": [
"text"
],
"volume": [
{
"boot": true,
"id": "text",
"name": "text",
"type": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"external_ips": [
"text"
],
"externally_detected_providers": [
"text"
],
"externally_inferred_cves": [
"text"
],
"first_observed": 1,
"gcp_cloud_tags": [
"text"
],
"geo_region": "text",
"has_active_externally_services": true,
"has_alerts": true,
"has_bu_overrides": true,
"has_incidents": true,
"has_xdr_agent": "text",
"hierarchy": "text",
"internal_ips": [
"text"
],
"iot_category": "text",
"iot_model": "text",
"iot_profile": "text",
"ip_ranges": [
"text"
],
"ips": [
"text"
],
"ipv6s": [
"text"
],
"last_observed": 1,
"last_sampled_ip": 1,
"mac_addresses": [
"text"
],
"management_status": [
"text"
],
"name": "text",
"open_ports": [
1
],
"operation_system": "text",
"project_name": "text",
"provider_account": "text",
"recent_ips": [
{
"id": "text",
"ip": 1,
"ipv6": "text",
"source": {
"name": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"provider": {
"name": "text",
"additionalProviderInfo": "text",
"isCdn": true,
"legacyName": "text",
"displayName": "text",
"cdn": true,
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"lastObserved": 1,
"firstObserved": 1,
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"region": "text",
"sensor": [
"text"
],
"service_type": [
"text"
],
"sub_region": [
"text"
],
"tags": [
"text"
],
"vpc_name_id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"next_page_token": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}Get asset details according to the asset ID. You can send up to 20 IDs. Required license: Cortex Xpanse Expander
api-key
{{api_key}}api-key-id
{{api_key_id}}OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/assets/get_asset_internet_exposure/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 115
{
"request_data": {
"asm_id_list": [
"text"
],
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"reply": {
"details": [
{
"asm_ids": "text",
"name": "text",
"type": "text",
"last_observed": 1,
"first_observed": 1,
"externally_detected_providers": [
"text"
],
"created": 1,
"ips": [
{
"ip": 1,
"ipv6": "text",
"protocol": "text",
"provider": "text",
"geolocation": {
"latitude": 1,
"longitude": 1,
"countryCode": "text",
"city": "text",
"regionCode": "text",
"timeZone": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"activityStatus": "text",
"lastObserved": 1,
"firstObserved": 1,
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"active_service_ids": [
"text"
],
"all_service_ids": [
"text"
],
"active_external_services_types": [
"text"
],
"domain": "text",
"certificate_issuer": "text",
"certificate_algorithm": "text",
"certificate_classifications": [
"text"
],
"resolves": true,
"details": {
"providerDetails": [
{
"name": "text",
"displayName": "text",
"firstObserved": 1,
"lastObserved": 1,
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"domain": "text",
"topLevelAssetMapperDomain": "text",
"domainAssetType": "text",
"isPaidLevelDomain": true,
"domainDetails": {
"admin": {
"city": "text",
"country": "text",
"emailAddress": "text",
"faxExtension": "text",
"faxNumber": "text",
"name": "text",
"organization": "text",
"phoneExtension": "text",
"phoneNumber": "text",
"postalCode": "text",
"province": "text",
"registryId": "text",
"street": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"alignedRegistrar": "text",
"collectionTime": 1,
"creationDate": 1,
"dnssec": "text",
"domainName": "text",
"domainStatuses": [
"text"
],
"dropped": true,
"nameServers": [
"text"
],
"registrant": {
"city": "text",
"country": "text",
"emailAddress": "text",
"faxExtension": "text",
"faxNumber": "text",
"name": "text",
"organization": "text",
"phoneExtension": "text",
"phoneNumber": "text",
"postalCode": "text",
"province": "text",
"registryId": "text",
"street": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"registrar": {
"abuseContactEmail": "text",
"abuseContactPhone": "text",
"alignedName": "text",
"ianaId": 1,
"name": "text",
"registrationExpirationDate": 1,
"url": "text",
"whoisServer": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"registryDomainId": "text",
"registryExpiryDate": 1,
"reseller": "text",
"retrievedDate": 1,
"tech": {
"city": "text",
"country": "text",
"emailAddress": "text",
"faxExtension": "text",
"faxNumber": "text",
"name": "text",
"organization": "text",
"phoneExtension": "text",
"phoneNumber": "text",
"postalCode": "text",
"province": "text",
"registryId": "text",
"street": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"updatedDate": 1,
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"dnsZone": "text",
"latestSampledIp": 1,
"latestSampledIpv6": "text",
"subdomainMetadata": {},
"recentIps": [
{
"id": "text",
"ip": 1,
"ipv6": "text",
"source": {
"name": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"provider": {
"name": "text",
"additionalProviderInfo": "text",
"isCdn": true,
"legacyName": "text",
"displayName": "text",
"cdn": true,
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"lastObserved": 1,
"firstObserved": 1,
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"certificateDetails": {
"issuer": "text",
"issuerAlternativeNames": "text",
"issuerCountry": "text",
"issuerEmail": "text",
"issuerLocality": "text",
"issuerName": "text",
"issuerOrg": "text",
"formattedIssuerOrg": "text",
"issuerOrgUnit": "text",
"issuerState": "text",
"publicKey": "text",
"publicKeyAlgorithm": "text",
"publicKeyRsaExponent": 1,
"signatureAlgorithm": "text",
"subject": "text",
"subjectAlternativeNames": "text",
"subjectCountry": "text",
"subjectEmail": "text",
"subjectLocality": "text",
"subjectName": "text",
"subjectOrg": "text",
"subjectOrgUnit": "text",
"subjectState": "text",
"serialNumber": "text",
"validNotBefore": 1,
"validNotAfter": 1,
"version": "text",
"publicKeyBits": 1,
"publicKeyModulus": "text",
"publicKeySpki": "text",
"sha1Fingerprint": "text",
"sha256Fingerprint": "text",
"md5Fingerprint": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"inferredCvesObserved": [
{
"inferredCve": [
{
"cveId": "text",
"cvssScoreV2": null,
"cveSeverityV2": null,
"cvssScoreV3": 1,
"cveSeverityV3": "text",
"inferredCveMatchMetadata": {
"inferredCveMatchType": "text",
"product": "text",
"confidence": "text",
"vendor": "text",
"version": "text",
"matchingCpeInformation": [
{
"part": "text",
"vendor": "text",
"product": "text",
"version": "text",
"update": null,
"edition": null,
"language": null,
"softwareEdition": null,
"targetSoftware": null,
"targetHardware": null,
"other": null,
"sourceServiceClassificationId": "text"
}
]
},
"epssScore": null,
"cvssTemporalScoreV3": null,
"cvssTemporalScoreV2": null,
"publishedExploitsCount": null,
"reportedExploitedInTheWild": null,
"firstExploitPublished": null,
"firstReportedThreatActor": null,
"firstReportedRansomware": null,
"firstReportedBotnet": null,
"lastExploitPublished": null,
"lastReportedThreatActor": null,
"lastReportedRansomware": null,
"lastReportedBotnet": null,
"cisaKevDateAdded": null
}
],
"activityStatus": "text",
"lastObserved": 1,
"firstObserved": 1,
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"source": "text",
"ip_ranges": {
"ANY_ADDITIONAL_PROPERTY": {
"_IS_DELETED": "text",
"_LAST_MODIFIED_TIME": 1,
"ACTIVE_RESPONSIVE_IPS_COUNT": 1,
"ANNOTATION": "text",
"ASN_COUNTRIES": [
"text"
],
"ASN_HANDLES": [
"text"
],
"ASN_RECORD_NAMES": [
"text"
],
"ASN_REGISTRIES": [
"text"
],
"BUSINESS_UNIT": [
{
"tag_id": "text",
"tag_name": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"CITIES": [
"text"
],
"DATE_ADDED": 1,
"DETAILS": {
"networkRecords": {
"firstIp": "text",
"firstIpv6": "text",
"handle": "text",
"lastChanged": 1,
"lastIp": "text",
"lastIpv6": "text",
"name": "text",
"organizationRecords": [
{
"address": "text",
"dateAdded": 1,
"email": "text",
"firstRegistered": 1,
"formattedName": "text",
"handle": "text",
"kind": "text",
"lastChanged": 1,
"org": "text",
"phone": "text",
"remarks": "text",
"roles": [
"text"
],
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"remarks": "text",
"whoIsServer": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ENTITY_TYPES": [
"text"
],
"EXPLAINERS": [
"text"
],
"FIRST_IP": "text",
"FIRST_IPV6": "text",
"HAS_BU_OVERRIDES": true,
"IP_RANGE_ID": "text",
"IP_VERSION": 1,
"IS_SUBRANGE": true,
"LAST_IP": "text",
"LAST_IPV6": "text",
"ORGANIZATION_HANDLES": "text",
"REGIONS": [
"text"
],
"SBAC_TAGS": [
{
"tag_id": "text",
"tag_name": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"SECTORS": [
"text"
],
"SIZE": 1,
"STATES": [
"text"
],
"SUBRANGE_CREATED_EMAIL": "text",
"SUBRANGE_CREATED_TS": 1,
"SUBRANGE_CREATED_USER": "text",
"SYSTEM_RANGE_FIRST_IP": "text",
"SYSTEM_RANGE_ID": "text",
"SYSTEM_RANGE_LAST_IP": "text",
"TAGS": [
{
"tag_id": "text",
"tag_name": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"external_services": [
{
"serviceType": "text",
"serviceKey": "text",
"activityStatus": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"externally_inferred_vulnerability_score": 1,
"externally_inferred_cves": [
"text"
],
"explainers": [
"text"
],
"tags": [
"text"
],
"ipv6s": [
"text"
],
"has_bu_overrides": true,
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}Gets the time and status of the last update of assets data in Xpanse. A status of "true" indicates the assets data update was successful.
api-key
{{api_key}}api-key-id
{{api_key_id}}An empty dictionary returns the time and status of the last websites assessment.
OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/assets/get_assets_internet_exposure/last_external_assessment/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 56
{
"request_data": {},
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"last_external_assessment": {
"status": true,
"time": "text"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}Get a list of all your owned IP address ranges filtered by business units and organization handles. 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
api-key
{{api_key}}api-key-id
{{api_key_id}}OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/assets/get_external_ip_address_ranges/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 329
{
"request_data": {
"filters": [
{
"field": "organization_handles",
"operator": "in",
"value": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"search_from": 0,
"search_to": 500,
"sort": {
"field": "first_ip",
"keyword": "desc",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"use_page_token": true,
"next_page_token": "text"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"reply": {
"total_count": 1,
"result_count": 1,
"external_ip_address_ranges": [
{
"range_id": "text",
"first_ip": "text",
"last_ip": "text",
"ips_count": 1,
"active_responsive_ips_count": 1,
"date_added": 1,
"organization_handles": [
"text"
],
"ipaddress_version": 1,
"tags": [
"text"
],
"first_ipv6": "text",
"last_ipv6": "text",
"annotation": "text",
"has_bu_overrides": true,
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"next_page_token": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}Get external IP address range details according to the range IDs. Required license: Cortex Xpanse Expander
api-key
{{api_key}}api-key-id
{{api_key_id}}OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/assets/get_external_ip_address_range/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 117
{
"request_data": {
"range_id_list": [
"text"
],
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"reply": {
"details": [
{
"range_id": "text",
"first_ip": "text",
"last_ip": "text",
"ips_count": 1,
"active_responsive_ips_count": 1,
"date_added": 1,
"organization_handles": [
"text"
],
"details": {
"networkRecords": [
{
"firstIp": "text",
"firstIpv6": "text",
"handle": "text",
"lastChanged": 1,
"lastIp": "text",
"lastIpv6": "text",
"name": "text",
"organizationRecords": [
{
"address": "text",
"dateAdded": 1,
"email": "text",
"firstRegistered": 1,
"formattedName": "text",
"handle": "text",
"kind": "text",
"lastChanged": 1,
"org": "text",
"phone": "text",
"remarks": "text",
"roles": [
"text"
],
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"remarks": "text",
"whoIsServer": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"explainers": [
"text"
],
"ipaddress_version": 1,
"tags": [
"text"
],
"first_ipv6": "text",
"last_ipv6": "text",
"annotation": "text",
"has_bu_overrides": true,
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}Gets the time and status of the last update of ip address range data in Xpanse. A status of "true" indicates the ip address range data update was successful.
api-key
{{api_key}}api-key-id
{{api_key_id}}An empty dictionary returns the time and status of the last websites assessment.
OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/assets/get_external_ip_address_ranges/last_external_assessment/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 56
{
"request_data": {},
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"last_external_assessment": {
"status": true,
"time": "text"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}Get a complete or filtered list of all your external services. The maximum result limit is 500. Required License: Cortex Xpanse Expander
api-key
{{api_key}}api-key-id
{{api_key_id}}OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/assets/get_external_services/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"request_data": {
"filters": [
{
"field": "service_name",
"operator": "in",
"value": "string"
}
],
"search_from": 0,
"search_to": 500,
"sort": {
"field": "service_name",
"keyword": "asc"
},
"use_page_token": true,
"next_page_token": "string"
}
}{
"reply": {
"total_count": 1,
"result_count": 1,
"external_services": [
{
"service_id": "2b6da586-46ca-3804-bbba-e5b02d8e53bb",
"service_name": "Kerberos at x.x.x.x:88",
"service_type": "Kerberos",
"ip_address": [
"x.x.x.x"
],
"domain": [],
"externally_detected_providers": [
"On Prem"
],
"is_active": "Active",
"first_observed": 1710233760000,
"last_observed": 1711956600000,
"port": 88,
"protocol": "TCP",
"active_classifications": [
"Kerberos"
],
"inactive_classifications": [],
"discovery_type": "DirectlyDiscovered",
"externally_inferred_vulnerability_score": " ",
"externally_inferred_cves": [],
"tls_versions": [],
"inferred_cves_observed": [],
"cloud_management_status": "Not Applicable",
"tags": [
"AR:Registered to You",
"BU:Mustang UAT 8507355851529627158"
],
"vulnerability_test_status": "true",
"confirmed_vulnerable_cve_ids": [
"CVE-2019-3396",
"CVE-2022-26134",
"CVE-2021-26084"
],
"confirmed_not_vulnerable_cve_ids": [
"CVE-2021-26085"
],
"vulnerability_test_results": [],
"ipv6_address": [],
"asm_asset_ids": [
"0b3ea202-f3fc-3176-8b5d-791afe2c0bd0"
],
"geolocations": [
{
"latitude": 55.75,
"longitude": 37.58,
"countryCode": "RU",
"city": "MOSCOW",
"regionCode": "",
"timeZone": "null"
}
],
"business_units": [
[
{
"creation_time": 1712001753495,
"family": "business_units",
"family_alias": "BU",
"id": "BU:e9b79919-f6df-4723-af55-f080d5bf9e41",
"is_active": 1,
"name": "Mustang UAT 8507355851529627158",
"parent_id": null,
"update_time": 1712001753495
}
]
]
}
]
}
}Get service details according to the service ID. You can send up to 20 IDs. Required license: Cortex Xpanse Expander
api-key
{{api_key}}api-key-id
{{api_key_id}}OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/assets/get_external_service/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 119
{
"request_data": {
"service_id_list": [
"text"
],
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"reply": {
"details": [
{
"service_id": "123e4567-e89b-12d3-a456-426614174000",
"service_name": "text",
"service_type": "text",
"ip_address": [
"text"
],
"domain": [
"text"
],
"externally_detected_providers": [
"text"
],
"is_active": "text",
"first_observed": 1,
"last_observed": 1,
"port": 1,
"protocol": "text",
"active_classifications": [
"text"
],
"inactive_classifications": [
"text"
],
"discovery_type": "text",
"externally_inferred_vulnerability_score": 1,
"externally_inferred_cves": [
"text"
],
"details": {
"serviceKey": "text",
"serviceKeyType": "text",
"providerDetails": [
{
"name": "text",
"displayName": "text",
"firstObserved": 1,
"lastObserved": 1,
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"certificates": [
{
"certificate": {
"issuer": "text",
"issuerAlternativeNames": "text",
"issuerCountry": "text",
"issuerEmail": "text",
"issuerLocality": "text",
"issuerName": "text",
"issuerOrg": "text",
"formattedIssuerOrg": "text",
"issuerOrgUnit": "text",
"issuerState": "text",
"publicKey": "text",
"publicKeyAlgorithm": "text",
"publicKeyRsaExponent": 1,
"signatureAlgorithm": "text",
"subject": "text",
"subjectAlternativeNames": "text",
"subjectCountry": "text",
"subjectEmail": "text",
"subjectLocality": "text",
"subjectName": "text",
"subjectOrg": "text",
"subjectOrgUnit": "text",
"subjectState": "text",
"serialNumber": "text",
"validNotBefore": 1,
"validNotAfter": 1,
"version": "text",
"publicKeyBits": 1,
"publicKeyModulus": "text",
"publicKeySpki": "text",
"sha1Fingerprint": "text",
"sha256Fingerprint": "text",
"md5Fingerprint": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"activityStatus": "text",
"lastObserved": 1,
"firstObserved": 1,
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"domains": [
{
"domain": "text",
"activityStatus": "text",
"lastObserved": 1,
"firstObserved": 1,
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"ips": [
{
"ip": 1,
"ipv6": "text",
"protocol": "text",
"provider": "text",
"geolocation": {
"latitude": 1,
"longitude": 1,
"countryCode": "text",
"city": "text",
"regionCode": "text",
"timeZone": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"activityStatus": "text",
"lastObserved": 1,
"firstObserved": 1,
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"classifications": [
{
"name": "text",
"activityStatus": "text",
"values": [
{
"jsonValue": "text",
"firstObserved": 1,
"lastObserved": 1,
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"firstObserved": 1,
"lastObserved": 1,
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"tlsVersions": [
{
"tlsVersion": "text",
"cipherSuite": "text",
"firstObserved": 1,
"lastObserved": 1,
"activityStatus": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"inferred_cves_observed": [
{
"inferredCve": [
{
"cveId": "text",
"cvssScoreV2": null,
"cveSeverityV2": null,
"cvssScoreV3": 1,
"cveSeverityV3": "text",
"inferredCveMatchMetadata": {
"inferredCveMatchType": "text",
"product": "text",
"confidence": "text",
"vendor": "text",
"version": "text",
"matchingCpeInformation": [
{
"part": "text",
"vendor": "text",
"product": "text",
"version": "text",
"update": null,
"edition": null,
"language": null,
"softwareEdition": null,
"targetSoftware": null,
"targetHardware": null,
"other": null,
"sourceServiceClassificationId": "text"
}
]
},
"epssScore": null,
"cvssTemporalScoreV3": null,
"cvssTemporalScoreV2": null,
"publishedExploitsCount": null,
"reportedExploitedInTheWild": null,
"firstExploitPublished": null,
"firstReportedThreatActor": null,
"firstReportedRansomware": null,
"firstReportedBotnet": null,
"lastExploitPublished": null,
"lastReportedThreatActor": null,
"lastReportedRansomware": null,
"lastReportedBotnet": null,
"cisaKevDateAdded": null
}
],
"activityStatus": "text",
"lastObserved": 1,
"firstObserved": 1,
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"enrichedObservationSource": "text",
"ip_ranges": {
"ANY_ADDITIONAL_PROPERTY": {
"_IS_DELETED": "text",
"_LAST_MODIFIED_TIME": 1,
"ACTIVE_RESPONSIVE_IPS_COUNT": 1,
"ANNOTATION": "text",
"ASN_COUNTRIES": [
"text"
],
"ASN_HANDLES": [
"text"
],
"ASN_RECORD_NAMES": [
"text"
],
"ASN_REGISTRIES": [
"text"
],
"BUSINESS_UNIT": [
{
"tag_id": "text",
"tag_name": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"CITIES": [
"text"
],
"DATE_ADDED": 1,
"DETAILS": {
"networkRecords": {
"firstIp": "text",
"firstIpv6": "text",
"handle": "text",
"lastChanged": 1,
"lastIp": "text",
"lastIpv6": "text",
"name": "text",
"organizationRecords": [
{
"address": "text",
"dateAdded": 1,
"email": "text",
"firstRegistered": 1,
"formattedName": "text",
"handle": "text",
"kind": "text",
"lastChanged": 1,
"org": "text",
"phone": "text",
"remarks": "text",
"roles": [
"text"
],
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"remarks": "text",
"whoIsServer": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ENTITY_TYPES": [
"text"
],
"EXPLAINERS": [
"text"
],
"FIRST_IP": "text",
"FIRST_IPV6": "text",
"HAS_BU_OVERRIDES": true,
"IP_RANGE_ID": "text",
"IP_VERSION": 1,
"IS_SUBRANGE": true,
"LAST_IP": "text",
"LAST_IPV6": "text",
"ORGANIZATION_HANDLES": "text",
"REGIONS": [
"text"
],
"SBAC_TAGS": [
{
"tag_id": "text",
"tag_name": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"SECTORS": [
"text"
],
"SIZE": 1,
"STATES": [
"text"
],
"SUBRANGE_CREATED_EMAIL": "text",
"SUBRANGE_CREATED_TS": 1,
"SUBRANGE_CREATED_USER": "text",
"SYSTEM_RANGE_FIRST_IP": "text",
"SYSTEM_RANGE_ID": "text",
"SYSTEM_RANGE_LAST_IP": "text",
"TAGS": [
{
"tag_id": "text",
"tag_name": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"cloud_management_status": "text",
"tags": [
"text"
],
"ipv6_address": [
"text"
],
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"pretty_name": "text",
"groups": [
"text"
],
"users": [
"text"
],
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}Gets the time and status of the last update of services data in Xpanse. A status of "true" indicates the service data update was successful.
api-key
{{api_key}}api-key-id
{{api_key_id}}An empty dictionary returns the time and status of the last websites assessment.
OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/assets/get_external_services/last_external_assessment/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 56
{
"request_data": {},
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"last_external_assessment": {
"status": true,
"time": "text"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}Get a complete or filtered list of your public-facing websites. Required License: Cortex Xpanse Expander
api-key
{{api_key}}api-key-id
{{api_key_id}}OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/assets/get_external_websites/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 200
{
"request_data": {
"filters": [
{
"field": "ips",
"operator": "in",
"value": "string"
}
],
"search_from": 0,
"search_to": 500,
"sort": {
"field": "host",
"keyword": "asc"
},
"use_page_token": true,
"next_page_token": "string"
}
}{
"reply": {
"total_count": 1,
"result_count": 1,
"websites": [
{
"website_id": "text",
"host": "text",
"protocol": "text",
"is_active": "text",
"site_categories": [
"text"
],
"technology_ids": [
"text"
],
"first_observed": 1,
"last_observed": 1,
"provider_names": [
"text"
],
"ips": [
"text"
],
"port": 1,
"active_service_ids": [
"text"
],
"http_type": "text",
"third_party_script_domains": [
"text"
],
"security_assessments": [
{
"name": "text",
"priority": 1,
"score": 1,
"securityAssessmentDetails": {
"pages": [
{
"url": "text",
"message": "text",
"elements": [
{
"name": "text",
"value": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"description": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"authentication": [
"text"
],
"rootPageHttpStatusCode": "text",
"isNonConfiguredHost": true,
"externally_inferred_vulnerability_score": 1,
"externally_inferred_cves": [
"text"
],
"tags": [
"text"
],
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"next_page_token": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}Get details about specific websites based on website IDs. You can submit up to 20 website IDs. Required License: Cortex Xpanse Expander
api-key
{{api_key}}api-key-id
{{api_key_id}}OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/assets/get_external_website/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 119
{
"request_data": {
"website_id_list": [
"text"
],
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"reply": {
"details": [
{
"website_id": "text",
"host": "text",
"protocol": "text",
"is_active": "text",
"site_categories": [
"text"
],
"technology_ids": [
"text"
],
"first_observed": 1,
"last_observed": 1,
"provider_names": [
"text"
],
"ips": [
"text"
],
"port": 1,
"active_service_ids": [
"text"
],
"http_type": "text",
"security_assessments": [
{
"name": "text",
"priority": 1,
"score": 1,
"securityAssessmentDetails": {
"pages": [
{
"url": "text",
"message": "text",
"elements": [
{
"name": "text",
"value": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"description": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"rootPageHttpStatusCode": "text",
"isNonConfiguredHost": true,
"externally_inferred_vulnerability_score": 1,
"externally_inferred_cves": [
"text"
],
"tags": [
"text"
],
"assets": [
{
"id": "text",
"name": "text",
"assetType": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"technologies": [
{
"id": "text",
"version": "text",
"cpe": "text",
"categoryIds": [
1
],
"technologyDetails": {
"confidence": 1,
"urls": [
{
"url": "text",
"ip": "text",
"observed": 1,
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"evidence": {
"impliedBy": [
"text"
],
"patterns": [
{
"type": "text",
"regex": "text",
"value": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"name": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"third_party_resources": [
{
"url": "text",
"type": "text",
"thirdPartyResourceDetails": {
"observed": 1,
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"forms": [
{
"url": "text",
"action": "text",
"purpose": "text",
"formDetails": {
"fields": [
{
"name": "text",
"maxLength": 1,
"required": true,
"dataType": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"details": {
"ips": [
{
"ip": "text",
"lastObserved": 1,
"firstObserved": 1,
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"screenshots": [
{
"url": "text",
"ip": "text",
"size": 1,
"observed": 1,
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}Gets the time and status of the last update of websites data in Xpanse. A status of "true" indicates the websites data update was successful.
api-key
{{api_key}}api-key-id
{{api_key_id}}An empty dictionary returns the time and status of the last websites assessment.
OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/assets/get_external_websites/last_external_assessment/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 56
{
"request_data": {},
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"last_external_assessment": {
"status": true,
"time": "text"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}Fetches business unit information for all or a subset of the business units in your Cortex Xpanse tenant. The results are sorted by business_unit_name.
api-key
{{api_key}}api-key-id
{{api_key_id}}OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/assets/get_business_units HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 147
{
"request_data": {
"filters": [
{
"field": "business_unit_id",
"operator": "contains",
"value": "string"
}
],
"use_page_token": true,
"next_page_token": "string"
}
}{
"reply": {
"total_count": 0,
"result_count": 0,
"business_units": [
{
"business_unit_id": "string",
"business_unit_name": "string",
"parent_id": "string"
}
]
}
}api-key
{{api_key}}api-key-id
{{api_key_id}}OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/assets/override_bu_tags/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 204
{
"request_data": {
"filters": [
{
"field": "name",
"operator": "in",
"value": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"business_units": [
"text"
],
"include_subdomains": true
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"reply": {
"assign_tags": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}Adds an annotation (also called a note) to an asset or IP range. If an asset or IP range has an existing annotation, you can append a new annotation to the existing annotation or replace the existing annotation with a new one. Required License: Cortex Xpanse Expander
api-key
{{api_key}}api-key-id
{{api_key_id}}OK
Reply indicates succeeded if the annotation was updated.
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/assets/assets_internet_exposure/annotation/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api_key}}
x-xdr-auth-id: {{api_key_id}}
Content-Type: application/json
Accept: */*
Content-Length: 224
{
"request_data": {
"assets": [
{
"entity_id": "text",
"entity_type": "asset",
"annotation": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"should_append": true,
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"reply": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}Define an IP address range and assign a business unit (BU) or IP address tag (IPR) to that range. Note the following guidelines:
Use the shouldReplace field to indicate whether to replace all previously applied BUs on overlapping ranges.
Tags and notes on overlapping ranges will be deleted.
If only startIp is supplied, the endpoint will create a range for that single IP address.
If only endIP is supplied, the endpoint will create a range for that single IP address.
Define the range using either the startIp and endIp OR the cidrIp range, not both. Xpanse will run the request on only one range.
api-key
{{api-key}}api-key-id
{{api-key-id}}OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/assets/create_user_defined_ip_range/ HTTP/1.1
Host: api-{{fqdn}}
authorization: {{api-key}}
x-xdr-auth-id: {{api-key-id}}
Content-Type: application/json
Accept: */*
Content-Length: 204
{
"request_data": {
"startIp": "x.x.x.24",
"endIp": "x.x.x.25",
"cidrIp": "null",
"buTagIds": [
"BU:af500527-9f45-4bd8-8eb5-e161d18a47b3"
],
"iprTagIds": [
"IPR:cc1d6312306d48c79fb3023b93d69923"
],
"shouldReplace": false
}
}{
"reply": {
"user_defined_ip_range": "succeeded"
}
}Upload domains (paid-level domains (PLD) and subdomains) and IPv4 address ranges to your inventory. Upload up to 500 domains or IP ranges per request.
Check the status of your asset upload request on the Asset Uploads/Removals page in the Cortex Xpanse UI. Go to Settings → Configurations → Asset Management → Asset Uploads/Removals. Uploaded assets initially appear the Asset Uploads/Removals table with the status Pending. Within five days of submitting your request, each asset will be Accepted and added to the inventory or Rejected. Assets that are rejected include an explanation in the Decision Reason field.
You cannot upload an asset that was added or rejected in a previous upload request.
Required role: Instance Admin or Account Admin
Required license: Cortex Xpanse Expander
api-key
api-keyapi-key-id
api-key-idOK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/asm_management/upload_asm_data/ HTTP/1.1
Host: api-{{fqdn}}
authorization: api-key
x-xdr-auth-id: api-key-id
Content-Type: application/json
Accept: */*
Content-Length: 132
{
"request_data": {
"request_type": "addition",
"asset_type": "ip_range",
"asset_identifiers": [
"string"
],
"business_units": [
"BU:1",
"BU:2"
]
}
}{
"reply": {
"asset_names": [
"text"
],
"errors": [
{}
]
}
}Remove certificates, domains (paid-level domains and subdomains), and IPv4 address ranges from your inventory. Remove up to 500 certificates, domains, or IP ranges per request.
Removed assets appear the Asset Uploads/Removals table with the status Removed. Within 24 hours of submitting your request, assets are removed from the inventory. Within a few days, related incidents, alerts, and services are also removed. You cannot remove an asset that was uploaded in a previous upload request.
When you remove a paid-level domain, related subdomains are also removed. When you remove an IPv4 range, the individual IPv4 addresses in that range are also removed.
Required role: Instance Admin
Required license: Cortex Xpanse Expander
{api-key}
{api-key-id}
OK
Bad Request
Unauthorized. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Unprocessable Entity
Internal Server Error. A unified status for API communication type errors.
POST /public_api/v1/asm_management/remove_asm_data HTTP/1.1
Host: api-{{fqdn}}
authorization: text
x-xdr-auth-id: text
Content-Type: application/json
Accept: */*
Content-Length: 74
{
"request_data": {
"asset_type": "certificate",
"asset_identifiers": [
"text"
]
}
}{
"reply": "text"
}Last updated
Was this helpful?