Get Service Details

Cortex Xpanse REST API

post /public_api/v1/assets/get_external_service/

Get service details according to the service 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_dataObject

(Required) A dictionary containing the API request fields.

service_id_listArray[string]
Free-Form object
Free-Form object
REQUEST BODY
{ "request_data": { "service_id_list": [ "service_id_list", "service_id_list", "service_id_list", "service_id_list", "service_id_list" ] } }
CURL
curl -X 'POST'
-H 'Accept: application/json'
-H 'Content-Type: application/json'
-H 'authorization: {{api_key}}' -H 'x-xdr-auth-id: {{api_key_id}}'
'https://api-}/public_api/v1/assets/get_external_service/'
-d '{ "request_data" : { "service_id_list" : [ "service_id_list", "service_id_list", "service_id_list", "service_id_list", "service_id_list" ] } }'
Responses

OK

Body
replyObject

JSON object containing the query result.

detailsArray

Service details according to the service ID.

[
service_idStringuuid
service_nameString
service_typeString
ip_addressArray[string]
domainArray[string]
externally_detected_providersArray[string]
is_activeString
first_observedInteger
last_observedInteger
portInteger
protocolString
active_classificationsArray[string]
inactive_classificationsArray[string]
discovery_typeString
externally_inferred_vulnerability_scoreNumber
externally_inferred_cvesArray[string]
detailsObject
serviceKeyString
serviceKeyTypeString
providerDetailsArray
[
nameString
displayNameString
firstObservedInteger
lastObservedInteger
Free-Form object
]
certificatesArray
[
certificateObject
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
activityStatusString
lastObservedInteger
firstObservedInteger
Free-Form object
]
domainsArray
[
domainString
activityStatusString
lastObservedInteger
firstObservedInteger
Free-Form object
]
ipsArray
[
ipInteger
ipv6String
protocolString
providerString
geolocationObject
latitudeNumber
longitudeNumber
countryCodeString
cityString
regionCodeString
timeZoneString
Free-Form object
activityStatusString
lastObservedInteger
firstObservedInteger
Free-Form object
]
classificationsArray
[
nameString
activityStatusString
valuesArray
[
jsonValueString
firstObservedInteger
lastObservedInteger
Free-Form object
]
firstObservedInteger
lastObservedInteger
Free-Form object
]
tlsVersionsArray
[
tlsVersionString
cipherSuiteString
firstObservedInteger
lastObservedInteger
activityStatusString
Free-Form object
]
inferred_cves_observedArray
[
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
]
enrichedObservationSourceString
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
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
Free-Form object
cloud_management_statusString
tagsArray[string]
ipv6_addressArray[string]
Free-Form object
]
pretty_nameString
groupsArray[string]
usersArray[string]
Free-Form object
Free-Form object
RESPONSE
{ "reply": { "details": [ { "service_id": "service_id_example", "service_name": "service_name_example", "service_type": "service_type_example", "ip_address": [ "ip_address_example" ], "domain": [ "domain_example" ], "externally_detected_providers": [ "externally_detected_providers_example" ], "is_active": "is_active_example", "first_observed": 0, "last_observed": 0, "port": 0, "protocol": "protocol_example", "active_classifications": [ "active_classifications_example" ], "inactive_classifications": [ "inactive_classifications_example" ], "discovery_type": "discovery_type_example", "externally_inferred_vulnerability_score": 0.0, "externally_inferred_cves": [ "externally_inferred_cves_example" ], "details": { "serviceKey": "serviceKey_example", "serviceKeyType": "serviceKeyType_example", "providerDetails": [ { "name": "name_example", "displayName": "displayName_example", "firstObserved": 0, "lastObserved": 0 } ], "certificates": [ { "certificate": { "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" }, "activityStatus": "activityStatus_example", "lastObserved": 0, "firstObserved": 0 } ], "domains": [ { "domain": "domain_example", "activityStatus": "activityStatus_example", "lastObserved": 0, "firstObserved": 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 } ], "classifications": [ { "name": "name_example", "activityStatus": "activityStatus_example", "values": [ { "jsonValue": "jsonValue_example", "firstObserved": 0, "lastObserved": 0 } ], "firstObserved": 0, "lastObserved": 0 } ], "tlsVersions": [ { "tlsVersion": "tlsVersion_example", "cipherSuite": "cipherSuite_example", "firstObserved": 0, "lastObserved": 0, "activityStatus": "activityStatus_example" } ], "inferred_cves_observed": [ { "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 } ], "enrichedObservationSource": "enrichedObservationSource_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" } ] } } }, "cloud_management_status": "cloud_management_status_example", "tags": [ "tags_example" ], "ipv6_address": [ "ipv6_address_example" ] } ], "pretty_name": "pretty_name_example", "groups": [ "groups_example" ], "users": [ "users_example" ] } }

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": {} }