> For the complete documentation index, see [llms.txt](https://cortex-docs.paloaltonetworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cortex-docs.paloaltonetworks.com/xpanse-api/xpanse-public-api/asset-management.md).

# Asset Management

APIs for managing assets

## Get All Assets

> Get a list of all your assets or a filtered list of your assets. \<br />The maximum result limit is 5000 assets. \<br />Required license: \*\*Cortex Xpanse Expander\*\*<br>

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"tags":[{"name":"Asset Management","description":"APIs for managing assets"}],"servers":[{"url":"https://api-{{fqdn}}"}],"paths":{"/public_api/v1/assets/get_assets_internet_exposure/":{"post":{"parameters":[{"in":"header","name":"authorization","description":"api-key","schema":{"type":"string"},"required":true},{"in":"header","name":"x-xdr-auth-id","description":"api-key-id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAsmAssetsResponse"}}}},"400":{"description":"Bad Request. Got an invalid JSON.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"401":{"description":"Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"402":{"description":"Unauthorized access. User does not have the required license type to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"403":{"description":"Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"422":{"$ref":"#/components/responses/UNPROCESSABLE_ENTITY"},"500":{"description":"Internal server error. A unified status for API communication type errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAsmAssetsRequest"}}},"description":""},"summary":"Get All Assets","description":"Get a list of all your assets or a filtered list of your assets. <br />The maximum result limit is 5000 assets. <br />Required license: **Cortex Xpanse Expander**\n","tags":["Asset Management"]}}},"components":{"schemas":{"GetAsmAssetsResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/GetAsmAssetsReply"}},"additionalProperties":true},"GetAsmAssetsReply":{"type":"object","properties":{"total_count":{"type":"integer"},"result_count":{"type":"integer"},"assets_internet_exposure":{"type":"array","items":{"$ref":"#/components/schemas/AssetsInternetExposureItem"}},"next_page_token":{"type":"string","description":"This attribute is only returned if use_page_token is provided in the request with value true"}},"additionalProperties":true},"AssetsInternetExposureItem":{"type":"object","properties":{"agent_id":{"type":"string"},"annotation":{"type":"string"},"asm_ids":{"type":"array","items":{"type":"string"}},"asm_va_score":{"type":"number"},"asset_explainers":{"type":"array","items":{"type":"string"}},"asset_type":{"type":"string"},"aws_cloud_tags":{"type":"array","items":{"type":"string"}},"azure_cloud_tags":{"type":"array","items":{"type":"string"}},"business_units":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/BusinessUnitHierarchy"}}},"certificate_algorithm":{"type":"string"},"certificate_classifications":{"type":"array","items":{"type":"string"}},"certificate_details":{"$ref":"#/components/schemas/CertificateDetails"},"certificate_expiry_date":{"type":"integer"},"certificate_issuer":{"type":"string"},"cloud_id":{"type":"string"},"cloud_provider":{"type":"string"},"cloud_resource_type":{"type":"string"},"creation_time":{"type":"integer"},"date_added":{"type":"integer"},"domain":{"type":"string"},"domain_details":{"$ref":"#/components/schemas/AsmDomain"},"domain_resolves":{"type":"boolean"},"extended_properties":{"$ref":"#/components/schemas/AssetsInternetExposureItemExtendedProperties"},"external_ips":{"type":"array","items":{"type":"string"}},"externally_detected_providers":{"type":"array","items":{"type":"string"}},"externally_inferred_cves":{"type":"array","items":{"type":"string"}},"first_observed":{"type":"integer"},"gcp_cloud_tags":{"type":"array","items":{"type":"string"}},"geo_region":{"type":"string"},"has_active_externally_services":{"type":"boolean"},"has_alerts":{"type":"boolean"},"has_bu_overrides":{"type":"boolean"},"has_incidents":{"type":"boolean"},"has_xdr_agent":{"type":"string"},"hierarchy":{"type":"string"},"internal_ips":{"type":"array","items":{"type":"string"}},"iot_category":{"type":"string"},"iot_model":{"type":"string"},"iot_profile":{"type":"string"},"ip_ranges":{"type":"array","items":{"type":"string"}},"ips":{"type":"array","items":{"type":"string"}},"ipv6s":{"type":"array","items":{"type":"string"}},"last_observed":{"type":"integer"},"last_sampled_ip":{"type":"integer"},"mac_addresses":{"type":"array","items":{"type":"string"}},"management_status":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"open_ports":{"type":"array","items":{"type":"integer"}},"operation_system":{"type":"string"},"project_name":{"type":"string"},"provider_account":{"type":"string"},"recent_ips":{"type":"array","items":{"$ref":"#/components/schemas/AsmAssetIp"}},"region":{"type":"string"},"sensor":{"type":"array","items":{"type":"string"}},"service_type":{"type":"array","items":{"type":"string"}},"sub_region":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"vpc_name_id":{"type":"string"}},"required":["asm_ids","asset_type","date_added","domain_resolves","first_observed","has_xdr_agent","last_observed","name"],"additionalProperties":true},"BusinessUnitHierarchy":{"type":"object","properties":{"creation_time":{"type":"integer"},"family":{"type":"string"},"family_alias":{"type":"string"},"id":{"type":"string"},"is_active":{"type":"integer"},"name":{"type":"string"},"parent_id":{"type":"string"},"update_time":{"type":"integer"}},"additionalProperties":true},"CertificateDetails":{"type":"object","properties":{"issuer":{"type":"string"},"issuerAlternativeNames":{"type":"string"},"issuerCountry":{"type":"string"},"issuerEmail":{"type":"string"},"issuerLocality":{"type":"string"},"issuerName":{"type":"string"},"issuerOrg":{"type":"string"},"formattedIssuerOrg":{"type":"string"},"issuerOrgUnit":{"type":"string"},"issuerState":{"type":"string"},"publicKey":{"type":"string"},"publicKeyAlgorithm":{"type":"string"},"publicKeyRsaExponent":{"type":"integer"},"signatureAlgorithm":{"type":"string"},"subject":{"type":"string"},"subjectAlternativeNames":{"type":"string"},"subjectCountry":{"type":"string"},"subjectEmail":{"type":"string"},"subjectLocality":{"type":"string"},"subjectName":{"type":"string"},"subjectOrg":{"type":"string"},"subjectOrgUnit":{"type":"string"},"subjectState":{"type":"string"},"serialNumber":{"type":"string"},"validNotBefore":{"type":"integer"},"validNotAfter":{"type":"integer"},"version":{"type":"string"},"publicKeyBits":{"type":"integer"},"publicKeyModulus":{"type":"string"},"publicKeySpki":{"type":"string"},"sha1Fingerprint":{"type":"string"},"sha256Fingerprint":{"type":"string"},"md5Fingerprint":{"type":"string"}},"additionalProperties":true},"AsmDomain":{"type":"object","properties":{"admin":{"$ref":"#/components/schemas/AsmDomainAdmin"},"alignedRegistrar":{"type":"string"},"collectionTime":{"type":"integer"},"creationDate":{"type":"integer"},"dnssec":{"type":"string"},"domainName":{"type":"string"},"domainStatuses":{"type":"array","items":{"type":"string"}},"dropped":{"type":"boolean"},"nameServers":{"type":"array","items":{"type":"string"}},"registrant":{"$ref":"#/components/schemas/AsmDomainAdmin"},"registrar":{"$ref":"#/components/schemas/AsmDomainRegistrar"},"registryDomainId":{"type":"string"},"registryExpiryDate":{"type":"integer"},"reseller":{"type":"string"},"retrievedDate":{"type":"integer"},"tech":{"$ref":"#/components/schemas/AsmDomainAdmin"},"updatedDate":{"type":"integer"}},"required":["collectionTime","domainName","dropped","registrar","retrievedDate"],"additionalProperties":true},"AsmDomainAdmin":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"emailAddress":{"type":"string"},"faxExtension":{"type":"string"},"faxNumber":{"type":"string"},"name":{"type":"string"},"organization":{"type":"string"},"phoneExtension":{"type":"string"},"phoneNumber":{"type":"string"},"postalCode":{"type":"string"},"province":{"type":"string"},"registryId":{"type":"string"},"street":{"type":"string"}},"additionalProperties":true},"AsmDomainRegistrar":{"type":"object","properties":{"abuseContactEmail":{"type":"string"},"abuseContactPhone":{"type":"string"},"alignedName":{"type":"string"},"ianaId":{"type":"number"},"name":{"type":"string"},"registrationExpirationDate":{"type":"number"},"url":{"type":"string"},"whoisServer":{"type":"string"}},"additionalProperties":true},"AssetsInternetExposureItemExtendedProperties":{"type":"object","properties":{"last_start_time":{"type":"integer"},"machine_type":{"type":"string"},"network_interfaces":{"type":"array","items":{"$ref":"#/components/schemas/NetworkInterface"}},"private_ips":{"type":"array","items":{"type":"string"}},"public_ips":{"type":"array","items":{"type":"string"}},"volume":{"type":"array","items":{"$ref":"#/components/schemas/Volume"}}},"additionalProperties":true},"NetworkInterface":{"type":"object","properties":{"id":{"type":"string"},"ip":{"type":"string"},"subnet_id":{"type":"string"},"vpc_id":{"type":"string"}},"additionalProperties":true},"Volume":{"type":"object","properties":{"boot":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"additionalProperties":true},"AsmAssetIp":{"type":"object","properties":{"id":{"type":"string"},"ip":{"type":"integer"},"ipv6":{"type":"string"},"source":{"$ref":"#/components/schemas/IpSource"},"provider":{"$ref":"#/components/schemas/AsmProvider"},"lastObserved":{"type":"integer"},"firstObserved":{"type":"integer"}},"required":["firstObserved","lastObserved"],"additionalProperties":true},"IpSource":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":true},"AsmProvider":{"type":"object","properties":{"name":{"type":"string"},"additionalProviderInfo":{"type":"string"},"isCdn":{"type":"boolean"},"legacyName":{"type":"string"},"displayName":{"type":"string"},"cdn":{"type":"boolean"}},"required":["cdn","displayName","isCdn","legacyName","name"],"additionalProperties":true},"DefaultApiErrorResponse":{"type":"object","properties":{"reply":{"description":"The query results upon error.","allOf":[{"$ref":"#/components/schemas/GenericReply"}]}},"required":["reply"],"additionalProperties":true},"GenericReply":{"type":"object","properties":{"err_code":{"type":"string","description":"HTTP response code."},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","description":"Additional information describing the error."}},"additionalProperties":true},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors"}}},"GetAsmAssetsRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/GetAsmAssetsData"}},"required":["request_data"],"additionalProperties":true},"GetAsmAssetsData":{"type":"object","description":"A dictionary containing the API request fields.\nAn empty dictionary returns all results.","properties":{"filters":{"type":"array","description":"An array of filter fields.","items":{"$ref":"#/components/schemas/AsmAssetsFilter"}},"search_from":{"type":"integer","default":0,"minimum":0,"description":"Represents the start offset index of results."},"search_to":{"type":"integer","default":500,"minimum":0,"description":"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. <br />Max value - 5000\n"},"sort":{"$ref":"#/components/schemas/GetAsmAssetsSort"},"use_page_token":{"type":"boolean","description":"Use `\"use_page_token\":true` in the initial request to paginate the response data.  \n"},"next_page_token":{"type":"string","description":"If `\"use_page_token\":true` was included in the initial request, the response for that request will include a page token.<br />  Use `\"next_page_token\":\"string\"` to pass that page token into the next request to paginate the next set of data.'\n"}}},"AsmAssetsFilter":{"type":"object","properties":{"field":{"type":"string","enum":["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"],"description":"Identifies the assets field the filter is matching. Case-sensitive."},"operator":{"type":"string","enum":["in","contains","neq","eq","not_contains","gte","lte","range","relative_timestamp"],"description":"Identifies the comparison operator you want to use for this filter. Valid keywords and values are:\n  - **contains** / **not_contains**: use with `externally_detected_providers`, `externally_inferred_cves`, `name`\n  - **eq** / **neq**: use with `name`, `ip_address`, `has_bu_overrides`.\n  - **gte**:  Filters data from a specific timestamp onwards. Use with `first_observed`, `last_observed`.\n  - **in**:  use with `has_active_external_services`, `type`, `business_units_list`, `ip_address`.\n  - **lte**:  Filters data up to a specific timestamp. Use with `first_observed`, `last_observed`.\n  - **range**: Filters data between two specific timestamps.Use with `first_observed`, `last_observed`.\n  - **relative_timestamp**: Filters data relative to the current time (e.g., last 30 days). Use with `first_observed` or `last_observed`."},"value":{"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"integer"}],"description":"Value depends on the filter field used.\n  - 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.”\n  - **externally_detected_providers**: string\n  - **externally_inferred_cves**: string \n   - **first_observed** — values in milliseconds format\n       - with **gte** or **lte** operator, specify a specific date or time as a timestamp in milliseconds format\n       - with **range** operator, specify \"to\" and \"from\" values as timestamps in milliseconds format\n         \"value\": { \"from\": \"{{previous30Days}}\",\"to\": \"{{previous7Days}}\"\n       - with **relative_timestamp** operator, specify time interval to look back on (24H, 7D, 30D, etc.) as a value in milliseconds format\n  - **has_active_external_services**: list of strings (enum values: \"yes\", \"no\", \"unknown\")\n  - **has_bu_overrides**: boolean (\"true\" or \"false\")\n  - **ip_address**: list of strings\n  - **ipv6_address**: string\n   - **last_observed** — values in milliseconds format\n       - with **gte** or **lte** operator, specify a specific date or time as a timestamp in milliseconds format\n       - with **range** operator, specify \"to\" and \"from\" values as timestamps in milliseconds format, as follows\n         \"value\": { \"from\": \"{{previous30Days}}\",\"to\": \"{{previous7Days}}\"\n       - with **relative_timestamp** operator, specify time interval to look back on (24H, 7D, 30D, etc.) as a value in milliseconds format\n  - **name**: string\n  - **type**: List of strings (enum values: \"certificate\", \"cloud_integration\", \"cloud_compute_instance\", \"domain\", \"unassociated_responsive_ip\")\n  - **tags**: List of strings indicating the tags to filter on in the format `\"tag-family:tag-name\"`, for example `\"AR:registered to you\"`.\n  - **type**: string\n"}}},"GetAsmAssetsSort":{"type":"object","properties":{"field":{"type":"string","default":"name","enum":["first_observed","name","last_observed"],"description":"Case sensitive."},"keyword":{"type":"string","default":"asc","enum":["ASC","asc","DESC","desc"],"description":"Case sensitive."}},"additionalProperties":true,"description":"Identifies the sort order for the result set."}},"responses":{"UNPROCESSABLE_ENTITY":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
```

## Get Asset Details

> Get asset details according to the asset ID. You can send up to 20 IDs. \<br />Required license: \*\*Cortex Xpanse Expander\*\*<br>

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"tags":[{"name":"Asset Management","description":"APIs for managing assets"}],"servers":[{"url":"https://api-{{fqdn}}"}],"paths":{"/public_api/v1/assets/get_asset_internet_exposure/":{"post":{"parameters":[{"in":"header","name":"authorization","description":"api-key","schema":{"type":"string"},"required":true},{"in":"header","name":"x-xdr-auth-id","description":"api-key-id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAsmAssetDetailsResponse"}}}},"400":{"description":"Bad Request. Got an invalid JSON.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"401":{"description":"Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"402":{"description":"Unauthorized access. User does not have the required license type to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"403":{"description":"Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"422":{"$ref":"#/components/responses/UNPROCESSABLE_ENTITY"},"500":{"description":"Internal server error. A unified status for API communication type errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAsmAssetDetailsRequest"}}},"description":""},"summary":"Get Asset Details","description":"Get asset details according to the asset ID. You can send up to 20 IDs. <br />Required license: **Cortex Xpanse Expander**\n","tags":["Asset Management"]}}},"components":{"schemas":{"GetAsmAssetDetailsResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/GetAsmAssetDetailsReply"}},"required":["reply"],"additionalProperties":true},"GetAsmAssetDetailsReply":{"type":"object","properties":{"details":{"type":"array","items":{"$ref":"#/components/schemas/GetAsmAssetDetails"}}},"additionalProperties":true},"GetAsmAssetDetails":{"type":"object","properties":{"asm_ids":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"last_observed":{"type":"integer"},"first_observed":{"type":"integer"},"externally_detected_providers":{"type":"array","items":{"type":"string"}},"created":{"type":"integer"},"ips":{"type":"array","items":{"$ref":"#/components/schemas/Ips"}},"active_service_ids":{"type":"array","items":{"type":"string"}},"all_service_ids":{"type":"array","items":{"type":"string"}},"active_external_services_types":{"type":"array","items":{"type":"string"}},"domain":{"type":"string"},"certificate_issuer":{"type":"string"},"certificate_algorithm":{"type":"string"},"certificate_classifications":{"type":"array","items":{"type":"string"}},"resolves":{"type":"boolean"},"details":{"$ref":"#/components/schemas/AsmAssetDetailsDetails"},"external_services":{"type":"array","items":{"$ref":"#/components/schemas/AsmAssetDetailExternalService"}},"externally_inferred_vulnerability_score":{"type":"number"},"externally_inferred_cves":{"type":"array","items":{"type":"string"}},"explainers":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"ipv6s":{"type":"array","items":{"type":"string"}},"has_bu_overrides":{"type":"boolean"}},"additionalProperties":true},"Ips":{"type":"object","properties":{"ip":{"type":"integer"},"ipv6":{"type":"string"},"protocol":{"type":"string"},"provider":{"type":"string"},"geolocation":{"$ref":"#/components/schemas/Geolocation"},"activityStatus":{"type":"string"},"lastObserved":{"type":"integer"},"firstObserved":{"type":"integer"}},"additionalProperties":true},"Geolocation":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"},"countryCode":{"type":"string"},"city":{"type":"string"},"regionCode":{"type":"string"},"timeZone":{"type":"string"}},"additionalProperties":true},"AsmAssetDetailsDetails":{"type":"object","properties":{"providerDetails":{"type":"array","items":{"$ref":"#/components/schemas/ProviderDetails"}},"domain":{"type":"string"},"topLevelAssetMapperDomain":{"type":"string"},"domainAssetType":{"type":"string"},"isPaidLevelDomain":{"type":"boolean"},"domainDetails":{"$ref":"#/components/schemas/AsmDomain"},"dnsZone":{"type":"string"},"latestSampledIp":{"type":"number"},"latestSampledIpv6":{"type":"string"},"subdomainMetadata":{"type":"object"},"recentIps":{"type":"array","items":{"$ref":"#/components/schemas/AsmAssetIp"}},"certificateDetails":{"$ref":"#/components/schemas/CertificateDetails"},"inferredCvesObserved":{"type":"array","items":{"$ref":"#/components/schemas/InferredCvesObserved"}},"source":{"type":"string"},"ip_ranges":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ServiceDetailIpRange"},"description":"Keys should be valid IPv4 address"}},"additionalProperties":true},"ProviderDetails":{"type":"object","properties":{"name":{"type":"string"},"displayName":{"type":"string"},"firstObserved":{"type":"integer"},"lastObserved":{"type":"integer"}},"required":["displayName","name"],"additionalProperties":true},"AsmDomain":{"type":"object","properties":{"admin":{"$ref":"#/components/schemas/AsmDomainAdmin"},"alignedRegistrar":{"type":"string"},"collectionTime":{"type":"integer"},"creationDate":{"type":"integer"},"dnssec":{"type":"string"},"domainName":{"type":"string"},"domainStatuses":{"type":"array","items":{"type":"string"}},"dropped":{"type":"boolean"},"nameServers":{"type":"array","items":{"type":"string"}},"registrant":{"$ref":"#/components/schemas/AsmDomainAdmin"},"registrar":{"$ref":"#/components/schemas/AsmDomainRegistrar"},"registryDomainId":{"type":"string"},"registryExpiryDate":{"type":"integer"},"reseller":{"type":"string"},"retrievedDate":{"type":"integer"},"tech":{"$ref":"#/components/schemas/AsmDomainAdmin"},"updatedDate":{"type":"integer"}},"required":["collectionTime","domainName","dropped","registrar","retrievedDate"],"additionalProperties":true},"AsmDomainAdmin":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"emailAddress":{"type":"string"},"faxExtension":{"type":"string"},"faxNumber":{"type":"string"},"name":{"type":"string"},"organization":{"type":"string"},"phoneExtension":{"type":"string"},"phoneNumber":{"type":"string"},"postalCode":{"type":"string"},"province":{"type":"string"},"registryId":{"type":"string"},"street":{"type":"string"}},"additionalProperties":true},"AsmDomainRegistrar":{"type":"object","properties":{"abuseContactEmail":{"type":"string"},"abuseContactPhone":{"type":"string"},"alignedName":{"type":"string"},"ianaId":{"type":"number"},"name":{"type":"string"},"registrationExpirationDate":{"type":"number"},"url":{"type":"string"},"whoisServer":{"type":"string"}},"additionalProperties":true},"AsmAssetIp":{"type":"object","properties":{"id":{"type":"string"},"ip":{"type":"integer"},"ipv6":{"type":"string"},"source":{"$ref":"#/components/schemas/IpSource"},"provider":{"$ref":"#/components/schemas/AsmProvider"},"lastObserved":{"type":"integer"},"firstObserved":{"type":"integer"}},"required":["firstObserved","lastObserved"],"additionalProperties":true},"IpSource":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":true},"AsmProvider":{"type":"object","properties":{"name":{"type":"string"},"additionalProviderInfo":{"type":"string"},"isCdn":{"type":"boolean"},"legacyName":{"type":"string"},"displayName":{"type":"string"},"cdn":{"type":"boolean"}},"required":["cdn","displayName","isCdn","legacyName","name"],"additionalProperties":true},"CertificateDetails":{"type":"object","properties":{"issuer":{"type":"string"},"issuerAlternativeNames":{"type":"string"},"issuerCountry":{"type":"string"},"issuerEmail":{"type":"string"},"issuerLocality":{"type":"string"},"issuerName":{"type":"string"},"issuerOrg":{"type":"string"},"formattedIssuerOrg":{"type":"string"},"issuerOrgUnit":{"type":"string"},"issuerState":{"type":"string"},"publicKey":{"type":"string"},"publicKeyAlgorithm":{"type":"string"},"publicKeyRsaExponent":{"type":"integer"},"signatureAlgorithm":{"type":"string"},"subject":{"type":"string"},"subjectAlternativeNames":{"type":"string"},"subjectCountry":{"type":"string"},"subjectEmail":{"type":"string"},"subjectLocality":{"type":"string"},"subjectName":{"type":"string"},"subjectOrg":{"type":"string"},"subjectOrgUnit":{"type":"string"},"subjectState":{"type":"string"},"serialNumber":{"type":"string"},"validNotBefore":{"type":"integer"},"validNotAfter":{"type":"integer"},"version":{"type":"string"},"publicKeyBits":{"type":"integer"},"publicKeyModulus":{"type":"string"},"publicKeySpki":{"type":"string"},"sha1Fingerprint":{"type":"string"},"sha256Fingerprint":{"type":"string"},"md5Fingerprint":{"type":"string"}},"additionalProperties":true},"InferredCvesObserved":{"type":"object","properties":{"inferredCve":{"type":"array","items":{"$ref":"#/components/schemas/InferredCve"}},"activityStatus":{"type":"string"},"lastObserved":{"type":"integer"},"firstObserved":{"type":"integer"}},"additionalProperties":true},"InferredCve":{"type":"object","properties":{"cveId":{"type":"string"},"cvssScoreV2":{"type":"null"},"cveSeverityV2":{"type":"null"},"cvssScoreV3":{"type":"number"},"cveSeverityV3":{"type":"string"},"inferredCveMatchMetadata":{"type":"object","properties":{"inferredCveMatchType":{"type":"string"},"product":{"type":"string"},"confidence":{"type":"string"},"vendor":{"type":"string"},"version":{"type":"string"},"matchingCpeInformation":{"type":"array","items":{"type":"object","properties":{"part":{"type":"string"},"vendor":{"type":"string"},"product":{"type":"string"},"version":{"type":"string"},"update":{"type":"null"},"edition":{"type":"null"},"language":{"type":"null"},"softwareEdition":{"type":"null"},"targetSoftware":{"type":"null"},"targetHardware":{"type":"null"},"other":{"type":"null"},"sourceServiceClassificationId":{"type":"string"}}}}}},"epssScore":{"type":"null"},"cvssTemporalScoreV3":{"type":"null"},"cvssTemporalScoreV2":{"type":"null"},"publishedExploitsCount":{"type":"null"},"reportedExploitedInTheWild":{"type":"null"},"firstExploitPublished":{"type":"null"},"firstReportedThreatActor":{"type":"null"},"firstReportedRansomware":{"type":"null"},"firstReportedBotnet":{"type":"null"},"lastExploitPublished":{"type":"null"},"lastReportedThreatActor":{"type":"null"},"lastReportedRansomware":{"type":"null"},"lastReportedBotnet":{"type":"null"},"cisaKevDateAdded":{"type":"null"}}},"ServiceDetailIpRange":{"type":"object","properties":{"_IS_DELETED":{"type":"string"},"_LAST_MODIFIED_TIME":{"type":"integer"},"ACTIVE_RESPONSIVE_IPS_COUNT":{"type":"integer"},"ANNOTATION":{"type":"string"},"ASN_COUNTRIES":{"type":"array","items":{"type":"string"}},"ASN_HANDLES":{"type":"array","items":{"type":"string"}},"ASN_RECORD_NAMES":{"type":"array","items":{"type":"string"}},"ASN_REGISTRIES":{"type":"array","items":{"type":"string"}},"BUSINESS_UNIT":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"CITIES":{"type":"array","items":{"type":"string"}},"DATE_ADDED":{"type":"integer"},"DETAILS":{"$ref":"#/components/schemas/ServiceDetailIpRangeDetails"},"ENTITY_TYPES":{"type":"array","items":{"type":"string"}},"EXPLAINERS":{"type":"array","items":{"type":"string"}},"FIRST_IP":{"type":"string"},"FIRST_IPV6":{"type":"string"},"HAS_BU_OVERRIDES":{"type":"boolean"},"IP_RANGE_ID":{"type":"string"},"IP_VERSION":{"type":"integer"},"IS_SUBRANGE":{"type":"boolean"},"LAST_IP":{"type":"string"},"LAST_IPV6":{"type":"string"},"ORGANIZATION_HANDLES":{"type":"string"},"REGIONS":{"type":"array","items":{"type":"string"}},"SBAC_TAGS":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"SECTORS":{"type":"array","items":{"type":"string"}},"SIZE":{"type":"integer"},"STATES":{"type":"array","items":{"type":"string"}},"SUBRANGE_CREATED_EMAIL":{"type":"string"},"SUBRANGE_CREATED_TS":{"type":"integer"},"SUBRANGE_CREATED_USER":{"type":"string"},"SYSTEM_RANGE_FIRST_IP":{"type":"string"},"SYSTEM_RANGE_ID":{"type":"string"},"SYSTEM_RANGE_LAST_IP":{"type":"string"},"TAGS":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}},"required":["IP_RANGE_ID"],"additionalProperties":true},"Tag":{"type":"object","properties":{"tag_id":{"type":"string"},"tag_name":{"type":"string"}},"required":["tag_id","tag_name"],"additionalProperties":true},"ServiceDetailIpRangeDetails":{"type":"object","properties":{"networkRecords":{"$ref":"#/components/schemas/NetworkRecord"}},"additionalProperties":true},"NetworkRecord":{"type":"object","properties":{"firstIp":{"type":"string"},"firstIpv6":{"type":"string"},"handle":{"type":"string"},"lastChanged":{"type":"integer"},"lastIp":{"type":"string"},"lastIpv6":{"type":"string"},"name":{"type":"string"},"organizationRecords":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationRecord"}},"remarks":{"type":"string"},"whoIsServer":{"type":"string"}},"required":["handle","name","whoIsServer"],"additionalProperties":true},"OrganizationRecord":{"type":"object","properties":{"address":{"type":"string"},"dateAdded":{"type":"integer"},"email":{"type":"string"},"firstRegistered":{"type":"integer"},"formattedName":{"type":"string"},"handle":{"type":"string"},"kind":{"type":"string"},"lastChanged":{"type":"integer"},"org":{"type":"string"},"phone":{"type":"string"},"remarks":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}},"required":["address","email","formattedName","handle","kind","org","phone","remarks"],"additionalProperties":true},"AsmAssetDetailExternalService":{"type":"object","properties":{"serviceType":{"type":"string"},"serviceKey":{"type":"string"},"activityStatus":{"type":"string"}},"additionalProperties":true},"DefaultApiErrorResponse":{"type":"object","properties":{"reply":{"description":"The query results upon error.","allOf":[{"$ref":"#/components/schemas/GenericReply"}]}},"required":["reply"],"additionalProperties":true},"GenericReply":{"type":"object","properties":{"err_code":{"type":"string","description":"HTTP response code."},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","description":"Additional information describing the error."}},"additionalProperties":true},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors"}}},"GetAsmAssetDetailsRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/GetAsmAssetDetailsRequestData"}},"required":["request_data"],"additionalProperties":true},"GetAsmAssetDetailsRequestData":{"type":"object","properties":{"asm_id_list":{"type":"array","items":{"type":"string"},"description":"A list of string(s) representing the asset IDs."}},"required":["asm_id_list"],"additionalProperties":true,"description":"(Required) A dictionary containing the API request fields. An empty dictionary returns all results."}},"responses":{"UNPROCESSABLE_ENTITY":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
```

## Get Assets Last Assessment

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

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"tags":[{"name":"Asset Management","description":"APIs for managing assets"}],"servers":[{"url":"https://api-{{fqdn}}"}],"paths":{"/public_api/v1/assets/get_assets_internet_exposure/last_external_assessment/":{"post":{"parameters":[{"in":"header","name":"authorization","description":"api-key","schema":{"type":"string"},"required":true},{"in":"header","name":"x-xdr-auth-id","description":"api-key-id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLastAssessmentResponse"}}}},"400":{"description":"Bad Request. Got an invalid JSON.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"401":{"description":"Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"402":{"description":"Unauthorized access. User does not have the required license type to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"403":{"description":"Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"422":{"$ref":"#/components/responses/UNPROCESSABLE_ENTITY"},"500":{"description":"Internal server error. A unified status for API communication type errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyRequest"}}}},"summary":"Get Assets Last Assessment","description":"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.","tags":["Asset Management"]}}},"components":{"schemas":{"GetLastAssessmentResponse":{"type":"object","properties":{"last_external_assessment":{"$ref":"#/components/schemas/LastExternalAssessment"}},"additionalProperties":true},"LastExternalAssessment":{"type":"object","properties":{"status":{"type":"boolean","description":"`True`: the update of services data was successful.<br /> `False`: the update of services data failed.\n"},"time":{"type":"string"}}},"DefaultApiErrorResponse":{"type":"object","properties":{"reply":{"description":"The query results upon error.","allOf":[{"$ref":"#/components/schemas/GenericReply"}]}},"required":["reply"],"additionalProperties":true},"GenericReply":{"type":"object","properties":{"err_code":{"type":"string","description":"HTTP response code."},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","description":"Additional information describing the error."}},"additionalProperties":true},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors"}}},"EmptyRequest":{"type":"object","properties":{"request_data":{"type":"object","description":"An empty dictionary returns the time and status of the last websites assessment."}},"required":["request_data"],"additionalProperties":true}},"responses":{"UNPROCESSABLE_ENTITY":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
```

## Get All Owned IP Ranges

> Get a list of all your owned IP address ranges filtered by business units and organization handles. \<br />The maximum result limit is 1000 ranges. \<br />Note: You can send a request to retrieve either \*\*all\*\* or \*\*filtered\*\* results. \<br />Required license: \*\*Cortex Xpanse Expander\*\*<br>

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"tags":[{"name":"Asset Management","description":"APIs for managing assets"}],"servers":[{"url":"https://api-{{fqdn}}"}],"paths":{"/public_api/v1/assets/get_external_ip_address_ranges/":{"post":{"parameters":[{"in":"header","name":"authorization","description":"api-key","schema":{"type":"string"},"required":true},{"in":"header","name":"x-xdr-auth-id","description":"api-key-id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetExternalIpAddressRangesResponse"}}}},"400":{"description":"Bad Request. Got an invalid JSON.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"401":{"description":"Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"402":{"description":"Unauthorized access. User does not have the required license type to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"403":{"description":"Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"422":{"$ref":"#/components/responses/UNPROCESSABLE_ENTITY"},"500":{"description":"Internal server error. A unified status for API communication type errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetExternalIpAddressRangesRequest"}}},"description":""},"summary":"Get All Owned IP Ranges","description":"Get a list of all your owned IP address ranges filtered by business units and organization handles. <br />The maximum result limit is 1000 ranges. <br />Note: You can send a request to retrieve either **all** or **filtered** results. <br />Required license: **Cortex Xpanse Expander**\n","tags":["Asset Management"]}}},"components":{"schemas":{"GetExternalIpAddressRangesResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/GetExternalIpAddressRangesReply"}},"additionalProperties":true},"GetExternalIpAddressRangesReply":{"type":"object","properties":{"total_count":{"type":"integer"},"result_count":{"type":"integer"},"external_ip_address_ranges":{"type":"array","items":{"$ref":"#/components/schemas/ExternalIpAddressRange"}},"next_page_token":{"type":"string","description":"This attribute is only returned if use_page_token is provided in the request with value true"}},"additionalProperties":true},"ExternalIpAddressRange":{"type":"object","properties":{"range_id":{"type":"string"},"first_ip":{"type":"string"},"last_ip":{"type":"string"},"ips_count":{"type":"integer"},"active_responsive_ips_count":{"type":"integer"},"date_added":{"type":"integer"},"organization_handles":{"type":"array","items":{"type":"string"}},"ipaddress_version":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"}},"first_ipv6":{"type":"string"},"last_ipv6":{"type":"string"},"annotation":{"type":"string"},"has_bu_overrides":{"type":"boolean"}},"additionalProperties":true},"DefaultApiErrorResponse":{"type":"object","properties":{"reply":{"description":"The query results upon error.","allOf":[{"$ref":"#/components/schemas/GenericReply"}]}},"required":["reply"],"additionalProperties":true},"GenericReply":{"type":"object","properties":{"err_code":{"type":"string","description":"HTTP response code."},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","description":"Additional information describing the error."}},"additionalProperties":true},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors"}}},"GetExternalIpAddressRangesRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/GetExternalIpAddressRangesRequestData"}},"required":["request_data"],"additionalProperties":true},"GetExternalIpAddressRangesRequestData":{"type":"object","description":"A dictionary containing the API request fields. An empty dictionary returns all results.","properties":{"filters":{"type":"array","description":"Array of filter fields.","items":{"$ref":"#/components/schemas/ExternalIpAddressRangesFilter"}},"search_from":{"type":"integer","default":0,"minimum":0,"description":"Represents the start offset index of results."},"search_to":{"type":"integer","default":500,"minimum":0,"description":"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. <br />Default value - 500 <br />Max value - 1000\n"},"sort":{"$ref":"#/components/schemas/ExternalIpAddressRangesSort"},"use_page_token":{"type":"boolean","description":"Use `\"use_page_token\":true` in the initial request to paginate the response data.\n"},"next_page_token":{"type":"string","description":"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.\n"}}},"ExternalIpAddressRangesFilter":{"type":"object","properties":{"field":{"type":"string","enum":["organization_handles","tags","business_units_list","ipaddress_version","has_bu_overrides"],"description":"Identifies the external IP ranges field the filter is matching. Filters are based on the following case-sensitive keywords:\n  - business_units_list\n  - organization_handles\n  - Ipaddress_version\n  - has_bu_overrides\n  - tags\n"},"operator":{"type":"string","enum":["in","contains","neq","eq","not_contains"],"description":"Identifies the comparison operator you want to use for this filter. Valid keywords and values are:\n  - **contains** / **not_contains**\n    -  organization_handles\n  - **in**\n    - business_units_list \n    - tags \n  - **eq** / **neq**\n    - ipaddress_version \n    - has_bu_overrides\n"},"value":{"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"integer"},{"type":"array","items":{"type":"string"}}],"description":"Values depend on the filter field used.\n  - organization_handles — string\n  - business_units_list — string or list of strings with syntax `“Acme & Co, Inc.”` or `“BU:Acme & Co, Inc.”`\n  - tags — list of strings in format “{family alias}:{tag name}”\n  - ipaddress_version — integer\n  - has_bu_overrides - boolean (true/false)\n"}},"additionalProperties":true},"ExternalIpAddressRangesSort":{"type":"object","properties":{"field":{"type":"string","default":"first_ip","enum":["last_ip","last_ipv6","first_ipv6","first_ip","ipaddress_version","range_id_list"],"description":"Values are:\n  - `Id` \n  - `first_ip`\n  - `last_ip` \n<br />Case sensitive.  <br />Default is `first_ip`.\n"},"keyword":{"type":"string","default":"desc","enum":["ASC","asc","DESC","desc"],"description":"Value are: \n  - `ASC` (ascending order)  \n  - `DESC` (descending order). \n  Case sensitive. Default is `DESC`.\n"}},"additionalProperties":true,"description":"Identifies the sort order for the result set."}},"responses":{"UNPROCESSABLE_ENTITY":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
```

## Get Owned IP Range Details

> Get external IP address range details according to the range IDs. \<br />Required license: \*\*Cortex Xpanse Expander\*\*<br>

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"tags":[{"name":"Asset Management","description":"APIs for managing assets"}],"servers":[{"url":"https://api-{{fqdn}}"}],"paths":{"/public_api/v1/assets/get_external_ip_address_range/":{"post":{"parameters":[{"in":"header","name":"authorization","description":"api-key","schema":{"type":"string"},"required":true},{"in":"header","name":"x-xdr-auth-id","description":"api-key-id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetExternalIpAddressRangeDetailsResponse"}}}},"400":{"description":"Bad Request. Got an invalid JSON.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"401":{"description":"Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"402":{"description":"Unauthorized access. User does not have the required license type to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"403":{"description":"Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"422":{"$ref":"#/components/responses/UNPROCESSABLE_ENTITY"},"500":{"description":"Internal server error. A unified status for API communication type errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetExternalIpAddressRangeDetailsRequest"}}},"description":""},"summary":"Get Owned IP Range Details","description":"Get external IP address range details according to the range IDs. <br />Required license: **Cortex Xpanse Expander**\n","tags":["Asset Management"]}}},"components":{"schemas":{"GetExternalIpAddressRangeDetailsResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/GetExternalIpAddressRangeDetailsReply"}},"additionalProperties":true},"GetExternalIpAddressRangeDetailsReply":{"type":"object","properties":{"details":{"type":"array","items":{"$ref":"#/components/schemas/ExternalIpAddressRangeDetails"}}},"additionalProperties":true},"ExternalIpAddressRangeDetails":{"type":"object","properties":{"range_id":{"type":"string"},"first_ip":{"type":"string"},"last_ip":{"type":"string"},"ips_count":{"type":"integer"},"active_responsive_ips_count":{"type":"integer"},"date_added":{"type":"integer"},"organization_handles":{"type":"array","items":{"type":"string"}},"details":{"$ref":"#/components/schemas/ExternalIpAddressRangeNestedDetails"},"explainers":{"type":"array","items":{"type":"string"}},"ipaddress_version":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"}},"first_ipv6":{"type":"string"},"last_ipv6":{"type":"string"},"annotation":{"type":"string"},"has_bu_overrides":{"type":"boolean"}},"required":["has_bu_overrides","range_id"],"additionalProperties":true},"ExternalIpAddressRangeNestedDetails":{"type":"object","properties":{"networkRecords":{"type":"array","items":{"$ref":"#/components/schemas/NetworkRecord"}}},"additionalProperties":true},"NetworkRecord":{"type":"object","properties":{"firstIp":{"type":"string"},"firstIpv6":{"type":"string"},"handle":{"type":"string"},"lastChanged":{"type":"integer"},"lastIp":{"type":"string"},"lastIpv6":{"type":"string"},"name":{"type":"string"},"organizationRecords":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationRecord"}},"remarks":{"type":"string"},"whoIsServer":{"type":"string"}},"required":["handle","name","whoIsServer"],"additionalProperties":true},"OrganizationRecord":{"type":"object","properties":{"address":{"type":"string"},"dateAdded":{"type":"integer"},"email":{"type":"string"},"firstRegistered":{"type":"integer"},"formattedName":{"type":"string"},"handle":{"type":"string"},"kind":{"type":"string"},"lastChanged":{"type":"integer"},"org":{"type":"string"},"phone":{"type":"string"},"remarks":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}},"required":["address","email","formattedName","handle","kind","org","phone","remarks"],"additionalProperties":true},"DefaultApiErrorResponse":{"type":"object","properties":{"reply":{"description":"The query results upon error.","allOf":[{"$ref":"#/components/schemas/GenericReply"}]}},"required":["reply"],"additionalProperties":true},"GenericReply":{"type":"object","properties":{"err_code":{"type":"string","description":"HTTP response code."},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","description":"Additional information describing the error."}},"additionalProperties":true},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors"}}},"GetExternalIpAddressRangeDetailsRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/IpAddressRangeRequestData"}},"required":["request_data"],"additionalProperties":true},"IpAddressRangeRequestData":{"type":"object","properties":{"range_id_list":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string"},"description":"A string representing the range ID for which you want to get the details."}},"additionalProperties":true,"description":"A dictionary containing the API request fields."}},"responses":{"UNPROCESSABLE_ENTITY":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
```

## Get IP Address Ranges Last Assessment

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

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"tags":[{"name":"Asset Management","description":"APIs for managing assets"}],"servers":[{"url":"https://api-{{fqdn}}"}],"paths":{"/public_api/v1/assets/get_external_ip_address_ranges/last_external_assessment/":{"post":{"parameters":[{"in":"header","name":"authorization","description":"api-key","schema":{"type":"string"},"required":true},{"in":"header","name":"x-xdr-auth-id","description":"api-key-id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLastAssessmentResponse"}}}},"400":{"description":"Bad Request. Got an invalid JSON.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"401":{"description":"Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"402":{"description":"Unauthorized access. User does not have the required license type to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"403":{"description":"Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"422":{"$ref":"#/components/responses/UNPROCESSABLE_ENTITY"},"500":{"description":"Internal server error. A unified status for API communication type errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyRequest"}}}},"summary":"Get IP Address Ranges Last Assessment","description":"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.","tags":["Asset Management"]}}},"components":{"schemas":{"GetLastAssessmentResponse":{"type":"object","properties":{"last_external_assessment":{"$ref":"#/components/schemas/LastExternalAssessment"}},"additionalProperties":true},"LastExternalAssessment":{"type":"object","properties":{"status":{"type":"boolean","description":"`True`: the update of services data was successful.<br /> `False`: the update of services data failed.\n"},"time":{"type":"string"}}},"DefaultApiErrorResponse":{"type":"object","properties":{"reply":{"description":"The query results upon error.","allOf":[{"$ref":"#/components/schemas/GenericReply"}]}},"required":["reply"],"additionalProperties":true},"GenericReply":{"type":"object","properties":{"err_code":{"type":"string","description":"HTTP response code."},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","description":"Additional information describing the error."}},"additionalProperties":true},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors"}}},"EmptyRequest":{"type":"object","properties":{"request_data":{"type":"object","description":"An empty dictionary returns the time and status of the last websites assessment."}},"required":["request_data"],"additionalProperties":true}},"responses":{"UNPROCESSABLE_ENTITY":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
```

## Get All Services

> Get a complete or filtered list of all your external services. \<br />The maximum result limit is 500. \<br />Required License: \*\*Cortex Xpanse Expander\*\*<br>

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"tags":[{"name":"Asset Management","description":"APIs for managing assets"}],"servers":[{"url":"https://api-{{fqdn}}"}],"paths":{"/public_api/v1/assets/get_external_services/":{"post":{"parameters":[{"in":"header","name":"authorization","description":"api-key","schema":{"type":"string"},"required":true},{"in":"header","name":"x-xdr-auth-id","description":"api-key-id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetServicesResponse"}}}},"400":{"description":"Bad Request. Got an invalid JSON.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"401":{"description":"Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"402":{"description":"Unauthorized access. User does not have the required license type to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"403":{"description":"Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"422":{"$ref":"#/components/responses/UNPROCESSABLE_ENTITY"},"500":{"description":"Internal server error. A unified status for API communication type errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetServicesRequest"}}},"description":""},"summary":"Get All Services","description":"Get a complete or filtered list of all your external services. <br />The maximum result limit is 500. <br />Required License: **Cortex Xpanse Expander**\n","tags":["Asset Management"]}}},"components":{"schemas":{"GetServicesResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/GetServicesReply"}},"additionalProperties":true},"GetServicesReply":{"type":"object","properties":{"total_count":{"type":"integer"},"result_count":{"type":"integer"},"external_services":{"type":"array","items":{"$ref":"#/components/schemas/ExternalService"}},"next_page_token":{"type":"string","description":"This attribute is only returned if use_page_token is provided in the request with value true"}},"additionalProperties":true},"ExternalService":{"type":"object","properties":{"service_id":{"type":"string"},"service_name":{"type":"string"},"service_type":{"type":"string"},"ip_address":{"type":"array","items":{"type":"string"}},"domain":{"type":"array","items":{"type":"string"}},"externally_detected_providers":{"type":"array","items":{"type":"string"}},"is_active":{"type":"string"},"first_observed":{"type":"integer"},"last_observed":{"type":"integer"},"port":{"type":"integer"},"protocol":{"type":"string"},"active_classifications":{"type":"array","items":{"type":"string"}},"inactive_classifications":{"type":"array","items":{"type":"string"}},"discovery_type":{"type":"string"},"externally_inferred_vulnerability_score":{"type":"string"},"externally_inferred_cves":{"type":"array","items":{"type":"string"}},"tls_versions":{"type":"array","items":{"$ref":"#/components/schemas/TlsVersion"}},"inferred_cves_observed":{"type":"array","items":{"$ref":"#/components/schemas/InferredCvesObserved"}},"cloud_management_status":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"vulnerability_test_status":{"type":"string"},"confirmed_vulnerable_cve_ids":{"type":"array","items":{"type":"string"}},"confirmed_not_vulnerable_cve_ids":{"type":"array","items":{"type":"string"}},"ipv6_address":{"type":"array","items":{"type":"string"}},"asm_asset_ids":{"type":"array","items":{"type":"string"}},"geolocations":{"type":"array","items":{"$ref":"#/components/schemas/Geolocation"}},"business_units":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/BusinessUnitHierarchy"}}},"service_versions":{"type":"array","items":{"type":"string"}}}},"TlsVersion":{"type":"object","properties":{"tlsVersion":{"type":"string"},"cipherSuite":{"type":"string"},"firstObserved":{"type":"integer"},"lastObserved":{"type":"integer"},"activityStatus":{"type":"string"}},"additionalProperties":true},"InferredCvesObserved":{"type":"object","properties":{"inferredCve":{"type":"array","items":{"$ref":"#/components/schemas/InferredCve"}},"activityStatus":{"type":"string"},"lastObserved":{"type":"integer"},"firstObserved":{"type":"integer"}},"additionalProperties":true},"InferredCve":{"type":"object","properties":{"cveId":{"type":"string"},"cvssScoreV2":{"type":"null"},"cveSeverityV2":{"type":"null"},"cvssScoreV3":{"type":"number"},"cveSeverityV3":{"type":"string"},"inferredCveMatchMetadata":{"type":"object","properties":{"inferredCveMatchType":{"type":"string"},"product":{"type":"string"},"confidence":{"type":"string"},"vendor":{"type":"string"},"version":{"type":"string"},"matchingCpeInformation":{"type":"array","items":{"type":"object","properties":{"part":{"type":"string"},"vendor":{"type":"string"},"product":{"type":"string"},"version":{"type":"string"},"update":{"type":"null"},"edition":{"type":"null"},"language":{"type":"null"},"softwareEdition":{"type":"null"},"targetSoftware":{"type":"null"},"targetHardware":{"type":"null"},"other":{"type":"null"},"sourceServiceClassificationId":{"type":"string"}}}}}},"epssScore":{"type":"null"},"cvssTemporalScoreV3":{"type":"null"},"cvssTemporalScoreV2":{"type":"null"},"publishedExploitsCount":{"type":"null"},"reportedExploitedInTheWild":{"type":"null"},"firstExploitPublished":{"type":"null"},"firstReportedThreatActor":{"type":"null"},"firstReportedRansomware":{"type":"null"},"firstReportedBotnet":{"type":"null"},"lastExploitPublished":{"type":"null"},"lastReportedThreatActor":{"type":"null"},"lastReportedRansomware":{"type":"null"},"lastReportedBotnet":{"type":"null"},"cisaKevDateAdded":{"type":"null"}}},"Geolocation":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"},"countryCode":{"type":"string"},"city":{"type":"string"},"regionCode":{"type":"string"},"timeZone":{"type":"string"}},"additionalProperties":true},"BusinessUnitHierarchy":{"type":"object","properties":{"creation_time":{"type":"integer"},"family":{"type":"string"},"family_alias":{"type":"string"},"id":{"type":"string"},"is_active":{"type":"integer"},"name":{"type":"string"},"parent_id":{"type":"string"},"update_time":{"type":"integer"}},"additionalProperties":true},"DefaultApiErrorResponse":{"type":"object","properties":{"reply":{"description":"The query results upon error.","allOf":[{"$ref":"#/components/schemas/GenericReply"}]}},"required":["reply"],"additionalProperties":true},"GenericReply":{"type":"object","properties":{"err_code":{"type":"string","description":"HTTP response code."},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","description":"Additional information describing the error."}},"additionalProperties":true},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors"}}},"GetServicesRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/GetServicesRequestData"}},"required":["request_data"],"additionalProperties":true},"GetServicesRequestData":{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/ExternalServicesFilter"}},"search_from":{"type":"integer","default":0,"minimum":0,"description":"An integer representing the start offset index of results."},"search_to":{"type":"integer","default":500,"minimum":0,"description":"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."},"sort":{"$ref":"#/components/schemas/ExternalServicesSort"},"use_page_token":{"type":"boolean","description":"Use `\"use_page_token\":true` in the initial request to paginate the response data.\n"},"next_page_token":{"type":"string","description":"If `\"use_page_token\":true` was included in the initial request, the response for that request will include a page token.<br /> Use `\"next_page_token\":\"string\"` to pass that page token into the next request to paginate the next set of data.\n"},"vulnerability_test_results":{"enum":[true],"description":"Includes vulnerability test results from the last 14 days for each service in the response."}}},"ExternalServicesFilter":{"type":"object","description":"Provides an array of filtered fields. ","properties":{"field":{"type":"string","enum":["service_name","protocol","service_type","ip_address","domain","externally_detected_providers","externally_inferred_cves","discovery_type","active_classifications","inactive_classifications","is_active","confirmed_vulnerable_cve_ids","confirmed_not_vulnerable_cve_ids","vulnerability_test_status","tags","service_type_list","business_units_list","ipv6_address","last_observed","first_observed"],"description":"String that identifies the service field the filter is matching. Filters are based on the following case-sensitive keywords:\n  - active_classifications\n  - business_units_list\n  - discovery_type\n  - domain\n  - externally_detected_providers\n  - externally_inferred_cves\n  - first_observed\n  - inactive_classifications\n  - ip_address\n  - ipv6_address\n  - is_active\n  - last_observed\n  - protocol\n  - service_name\n  - service_type\n  - service_type_list\n  - tags\n"},"operator":{"type":"string","enum":["in","contains","neq","eq","not_contains","gte","lte","range","relative_timestamp"],"description":"String that identifies the comparison operator you want to use for this filter. Valid keywords and values are:\n  - **contains** / **not_contains**— use with `externally_detected_providers`, `domain`, `externally_inferred_cves`, `active_classifications`, `inactive_classifications`, service_name, `service_type`, `protocol`\n  - **eq** / **neq**—  use with `service_name`, `service_type`, `protocol`, `ip_address`\n  - **gte**— Filters data from a specific timestamp onwards. Use with `first_observed`, `last_observed`\n  - **in**— use with `is_active`, `discovery_type`, `business_units_list`, `tags`, `ip_address`\n  - **lte**— Filters data up to a specific timestamp. Use with `first_observed`, `last_observed`\n  - **range**— Filters data between two specific timestamps. Use with `first_observed`, `last_observed`\n  - **relative_timestamp**— Filters data relative to the current time (e.g., last 30 days). Use with `first_observed`, `last_observed`\n"},"value":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"integer"}],"description":"Value that this filter must match. The contents of this field will differ depending on the services field that you specified for this filter:\n  - **active_classifications** — String\n  - **business_units_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.”\n  - **discovery_type** — List of strings. Values are: `ColocatedOnIp`, `DirectlyDiscovered`, `Unknown`.\n  - **domain** —  String\n  - **externally_detected_providers** — String \n  - **externally_inferred_cves** — String\n  - **first_observed** — values in milliseconds format\n       - with **gte** or **lte** operator, specify a specific date or time as a timestamp in milliseconds format\n       - with **range** operator, specify \"to\" and \"from\" values as timestamps in milliseconds format\n         \"value\": { \"from\": \"{{previous30Days}}\",\"to\": \"{{previous7Days}}\"\n       - with **relative_timestamp** operator, specify time interval to look back on (24H, 7D, 30D, etc.) as a value in milliseconds format\n  - **inactive_classifications** — String\n  - **ip_address** — List of strings\n  - **ipv6_address** — String\n  - **is_active** — String. Values are:`yes`, `no`\n  - **last_observed** — values in milliseconds format\n       - with **gte** or **lte** operator, specify a specific date or time as a timestamp in milliseconds format\n       - with **range** operator, specify \"to\" and \"from\" values as timestamps in milliseconds format, as follows\n         \"value\": { \"from\": \"{{previous30Days}}\",\"to\": \"{{previous7Days}}\"\n       - with **relative_timestamp** operator, specify time interval to look back on (24H, 7D, 30D, etc.) as a value in milliseconds format\n  - **protocol** — String \n  - **service_name** —  String\n  - **service_type** —  String\n  - **service_type_list** —  String\n  - **tags** — List of strings indicating the tags to filter on in the format `\"tag-family:tag-name\"`, for example `\"AR:registered to you\"`.\n"}}},"ExternalServicesSort":{"type":"object","properties":{"field":{"type":"string","default":"service_name","enum":["first_observed","service_name","last_observed"],"description":"Values are: \n  - service_name \n  - first_observed \n  - last_observed \n  By default, case-sensitive, sort is defined as service_name.\n"},"keyword":{"type":"string","default":"asc","enum":["ASC","asc","DESC","desc"],"description":"Can be either ASC (ascending order) or DESC (descending order). Default is ASC. Values are case sensitive."}},"additionalProperties":true,"description":"Identifies the sort order for the result set."}},"responses":{"UNPROCESSABLE_ENTITY":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
```

## Get Service Details

> Get service details according to the service ID. You can send up to 20 IDs. \<br />Required license: \*\*Cortex Xpanse Expander\*\*<br>

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"tags":[{"name":"Asset Management","description":"APIs for managing assets"}],"servers":[{"url":"https://api-{{fqdn}}"}],"paths":{"/public_api/v1/assets/get_external_service/":{"post":{"parameters":[{"in":"header","name":"authorization","description":"api-key","schema":{"type":"string"},"required":true},{"in":"header","name":"x-xdr-auth-id","description":"api-key-id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetServiceDetailsResponse"}}}},"400":{"description":"Bad Request. Got an invalid JSON.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"401":{"description":"Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"402":{"description":"Unauthorized access. User does not have the required license type to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"403":{"description":"Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"422":{"$ref":"#/components/responses/UNPROCESSABLE_ENTITY"},"500":{"description":"Internal server error. A unified status for API communication type errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetServiceDetailsRequest"}}},"description":""},"summary":"Get Service Details","description":"Get service details according to the service ID. You can send up to 20 IDs. <br />Required license: **Cortex Xpanse Expander**\n","tags":["Asset Management"]}}},"components":{"schemas":{"GetServiceDetailsResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/ServiceDetails"}},"required":["reply"],"additionalProperties":true},"ServiceDetails":{"type":"object","properties":{"details":{"type":"array","items":{"$ref":"#/components/schemas/Service"},"description":"Service details according to the service ID."},"pretty_name":{"type":"string"},"groups":{"type":"array","items":{"type":"string"}},"users":{"type":"array","items":{"type":"string"}}},"additionalProperties":true,"description":"JSON object containing the query result."},"Service":{"type":"object","properties":{"service_id":{"type":"string","format":"uuid"},"service_name":{"type":"string"},"service_type":{"type":"string"},"ip_address":{"type":"array","items":{"type":"string"}},"domain":{"type":"array","items":{"type":"string"}},"externally_detected_providers":{"type":"array","items":{"type":"string"}},"is_active":{"type":"string"},"first_observed":{"type":"integer"},"last_observed":{"type":"integer"},"port":{"type":"integer"},"protocol":{"type":"string"},"active_classifications":{"type":"array","items":{"type":"string"}},"inactive_classifications":{"type":"array","items":{"type":"string"}},"discovery_type":{"type":"string"},"externally_inferred_vulnerability_score":{"type":"number"},"externally_inferred_cves":{"type":"array","items":{"type":"string"}},"details":{"$ref":"#/components/schemas/NestedServiceDetails"},"cloud_management_status":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"ipv6_address":{"type":"array","items":{"type":"string"}}},"required":["service_id","service_name","service_type"],"additionalProperties":true},"NestedServiceDetails":{"type":"object","properties":{"serviceKey":{"type":"string"},"serviceKeyType":{"type":"string"},"providerDetails":{"type":"array","items":{"$ref":"#/components/schemas/ProviderDetails"}},"certificates":{"type":"array","items":{"$ref":"#/components/schemas/NestedServiceCertificate"}},"domains":{"type":"array","items":{"$ref":"#/components/schemas/NestedServiceDomain"}},"ips":{"type":"array","items":{"$ref":"#/components/schemas/Ips"}},"classifications":{"type":"array","items":{"$ref":"#/components/schemas/ServiceClassification"}},"tlsVersions":{"type":"array","items":{"$ref":"#/components/schemas/TlsVersion"}},"inferred_cves_observed":{"type":"array","items":{"$ref":"#/components/schemas/InferredCvesObserved"}},"enrichedObservationSource":{"type":"string"},"ip_ranges":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ServiceDetailIpRange"},"description":"Keys should be valid IPv4 address"}},"additionalProperties":true},"ProviderDetails":{"type":"object","properties":{"name":{"type":"string"},"displayName":{"type":"string"},"firstObserved":{"type":"integer"},"lastObserved":{"type":"integer"}},"required":["displayName","name"],"additionalProperties":true},"NestedServiceCertificate":{"type":"object","properties":{"certificate":{"$ref":"#/components/schemas/CertificateDetails"},"activityStatus":{"type":"string"},"lastObserved":{"type":"integer"},"firstObserved":{"type":"integer"}},"additionalProperties":true},"CertificateDetails":{"type":"object","properties":{"issuer":{"type":"string"},"issuerAlternativeNames":{"type":"string"},"issuerCountry":{"type":"string"},"issuerEmail":{"type":"string"},"issuerLocality":{"type":"string"},"issuerName":{"type":"string"},"issuerOrg":{"type":"string"},"formattedIssuerOrg":{"type":"string"},"issuerOrgUnit":{"type":"string"},"issuerState":{"type":"string"},"publicKey":{"type":"string"},"publicKeyAlgorithm":{"type":"string"},"publicKeyRsaExponent":{"type":"integer"},"signatureAlgorithm":{"type":"string"},"subject":{"type":"string"},"subjectAlternativeNames":{"type":"string"},"subjectCountry":{"type":"string"},"subjectEmail":{"type":"string"},"subjectLocality":{"type":"string"},"subjectName":{"type":"string"},"subjectOrg":{"type":"string"},"subjectOrgUnit":{"type":"string"},"subjectState":{"type":"string"},"serialNumber":{"type":"string"},"validNotBefore":{"type":"integer"},"validNotAfter":{"type":"integer"},"version":{"type":"string"},"publicKeyBits":{"type":"integer"},"publicKeyModulus":{"type":"string"},"publicKeySpki":{"type":"string"},"sha1Fingerprint":{"type":"string"},"sha256Fingerprint":{"type":"string"},"md5Fingerprint":{"type":"string"}},"additionalProperties":true},"NestedServiceDomain":{"type":"object","properties":{"domain":{"type":"string"},"activityStatus":{"type":"string"},"lastObserved":{"type":"integer"},"firstObserved":{"type":"integer"}},"additionalProperties":true},"Ips":{"type":"object","properties":{"ip":{"type":"integer"},"ipv6":{"type":"string"},"protocol":{"type":"string"},"provider":{"type":"string"},"geolocation":{"$ref":"#/components/schemas/Geolocation"},"activityStatus":{"type":"string"},"lastObserved":{"type":"integer"},"firstObserved":{"type":"integer"}},"additionalProperties":true},"Geolocation":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"},"countryCode":{"type":"string"},"city":{"type":"string"},"regionCode":{"type":"string"},"timeZone":{"type":"string"}},"additionalProperties":true},"ServiceClassification":{"type":"object","properties":{"name":{"type":"string"},"activityStatus":{"type":"string"},"values":{"type":"array","items":{"$ref":"#/components/schemas/ServiceClassificationValues"}},"firstObserved":{"type":"integer"},"lastObserved":{"type":"integer"}},"required":["name"],"additionalProperties":true},"ServiceClassificationValues":{"type":"object","properties":{"jsonValue":{"type":"string"},"firstObserved":{"type":"integer"},"lastObserved":{"type":"integer"}},"required":["firstObserved","jsonValue","lastObserved"],"additionalProperties":true},"TlsVersion":{"type":"object","properties":{"tlsVersion":{"type":"string"},"cipherSuite":{"type":"string"},"firstObserved":{"type":"integer"},"lastObserved":{"type":"integer"},"activityStatus":{"type":"string"}},"additionalProperties":true},"InferredCvesObserved":{"type":"object","properties":{"inferredCve":{"type":"array","items":{"$ref":"#/components/schemas/InferredCve"}},"activityStatus":{"type":"string"},"lastObserved":{"type":"integer"},"firstObserved":{"type":"integer"}},"additionalProperties":true},"InferredCve":{"type":"object","properties":{"cveId":{"type":"string"},"cvssScoreV2":{"type":"null"},"cveSeverityV2":{"type":"null"},"cvssScoreV3":{"type":"number"},"cveSeverityV3":{"type":"string"},"inferredCveMatchMetadata":{"type":"object","properties":{"inferredCveMatchType":{"type":"string"},"product":{"type":"string"},"confidence":{"type":"string"},"vendor":{"type":"string"},"version":{"type":"string"},"matchingCpeInformation":{"type":"array","items":{"type":"object","properties":{"part":{"type":"string"},"vendor":{"type":"string"},"product":{"type":"string"},"version":{"type":"string"},"update":{"type":"null"},"edition":{"type":"null"},"language":{"type":"null"},"softwareEdition":{"type":"null"},"targetSoftware":{"type":"null"},"targetHardware":{"type":"null"},"other":{"type":"null"},"sourceServiceClassificationId":{"type":"string"}}}}}},"epssScore":{"type":"null"},"cvssTemporalScoreV3":{"type":"null"},"cvssTemporalScoreV2":{"type":"null"},"publishedExploitsCount":{"type":"null"},"reportedExploitedInTheWild":{"type":"null"},"firstExploitPublished":{"type":"null"},"firstReportedThreatActor":{"type":"null"},"firstReportedRansomware":{"type":"null"},"firstReportedBotnet":{"type":"null"},"lastExploitPublished":{"type":"null"},"lastReportedThreatActor":{"type":"null"},"lastReportedRansomware":{"type":"null"},"lastReportedBotnet":{"type":"null"},"cisaKevDateAdded":{"type":"null"}}},"ServiceDetailIpRange":{"type":"object","properties":{"_IS_DELETED":{"type":"string"},"_LAST_MODIFIED_TIME":{"type":"integer"},"ACTIVE_RESPONSIVE_IPS_COUNT":{"type":"integer"},"ANNOTATION":{"type":"string"},"ASN_COUNTRIES":{"type":"array","items":{"type":"string"}},"ASN_HANDLES":{"type":"array","items":{"type":"string"}},"ASN_RECORD_NAMES":{"type":"array","items":{"type":"string"}},"ASN_REGISTRIES":{"type":"array","items":{"type":"string"}},"BUSINESS_UNIT":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"CITIES":{"type":"array","items":{"type":"string"}},"DATE_ADDED":{"type":"integer"},"DETAILS":{"$ref":"#/components/schemas/ServiceDetailIpRangeDetails"},"ENTITY_TYPES":{"type":"array","items":{"type":"string"}},"EXPLAINERS":{"type":"array","items":{"type":"string"}},"FIRST_IP":{"type":"string"},"FIRST_IPV6":{"type":"string"},"HAS_BU_OVERRIDES":{"type":"boolean"},"IP_RANGE_ID":{"type":"string"},"IP_VERSION":{"type":"integer"},"IS_SUBRANGE":{"type":"boolean"},"LAST_IP":{"type":"string"},"LAST_IPV6":{"type":"string"},"ORGANIZATION_HANDLES":{"type":"string"},"REGIONS":{"type":"array","items":{"type":"string"}},"SBAC_TAGS":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"SECTORS":{"type":"array","items":{"type":"string"}},"SIZE":{"type":"integer"},"STATES":{"type":"array","items":{"type":"string"}},"SUBRANGE_CREATED_EMAIL":{"type":"string"},"SUBRANGE_CREATED_TS":{"type":"integer"},"SUBRANGE_CREATED_USER":{"type":"string"},"SYSTEM_RANGE_FIRST_IP":{"type":"string"},"SYSTEM_RANGE_ID":{"type":"string"},"SYSTEM_RANGE_LAST_IP":{"type":"string"},"TAGS":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}},"required":["IP_RANGE_ID"],"additionalProperties":true},"Tag":{"type":"object","properties":{"tag_id":{"type":"string"},"tag_name":{"type":"string"}},"required":["tag_id","tag_name"],"additionalProperties":true},"ServiceDetailIpRangeDetails":{"type":"object","properties":{"networkRecords":{"$ref":"#/components/schemas/NetworkRecord"}},"additionalProperties":true},"NetworkRecord":{"type":"object","properties":{"firstIp":{"type":"string"},"firstIpv6":{"type":"string"},"handle":{"type":"string"},"lastChanged":{"type":"integer"},"lastIp":{"type":"string"},"lastIpv6":{"type":"string"},"name":{"type":"string"},"organizationRecords":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationRecord"}},"remarks":{"type":"string"},"whoIsServer":{"type":"string"}},"required":["handle","name","whoIsServer"],"additionalProperties":true},"OrganizationRecord":{"type":"object","properties":{"address":{"type":"string"},"dateAdded":{"type":"integer"},"email":{"type":"string"},"firstRegistered":{"type":"integer"},"formattedName":{"type":"string"},"handle":{"type":"string"},"kind":{"type":"string"},"lastChanged":{"type":"integer"},"org":{"type":"string"},"phone":{"type":"string"},"remarks":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}},"required":["address","email","formattedName","handle","kind","org","phone","remarks"],"additionalProperties":true},"DefaultApiErrorResponse":{"type":"object","properties":{"reply":{"description":"The query results upon error.","allOf":[{"$ref":"#/components/schemas/GenericReply"}]}},"required":["reply"],"additionalProperties":true},"GenericReply":{"type":"object","properties":{"err_code":{"type":"string","description":"HTTP response code."},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","description":"Additional information describing the error."}},"additionalProperties":true},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors"}}},"GetServiceDetailsRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/ServiceIdList"}},"required":["request_data"],"additionalProperties":true},"ServiceIdList":{"type":"object","properties":{"service_id_list":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string"}}},"additionalProperties":true,"description":"(Required) A dictionary containing the API request fields."}},"responses":{"UNPROCESSABLE_ENTITY":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
```

## Get Services Last Assessment

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

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"tags":[{"name":"Asset Management","description":"APIs for managing assets"}],"servers":[{"url":"https://api-{{fqdn}}"}],"paths":{"/public_api/v1/assets/get_external_services/last_external_assessment/":{"post":{"parameters":[{"in":"header","name":"authorization","description":"api-key","schema":{"type":"string"},"required":true},{"in":"header","name":"x-xdr-auth-id","description":"api-key-id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLastAssessmentResponse"}}}},"400":{"description":"Bad Request. Got an invalid JSON.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"401":{"description":"Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"402":{"description":"Unauthorized access. User does not have the required license type to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"403":{"description":"Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"422":{"$ref":"#/components/responses/UNPROCESSABLE_ENTITY"},"500":{"description":"Internal server error. A unified status for API communication type errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyRequest"}}}},"summary":"Get Services Last Assessment","description":"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.","tags":["Asset Management"]}}},"components":{"schemas":{"GetLastAssessmentResponse":{"type":"object","properties":{"last_external_assessment":{"$ref":"#/components/schemas/LastExternalAssessment"}},"additionalProperties":true},"LastExternalAssessment":{"type":"object","properties":{"status":{"type":"boolean","description":"`True`: the update of services data was successful.<br /> `False`: the update of services data failed.\n"},"time":{"type":"string"}}},"DefaultApiErrorResponse":{"type":"object","properties":{"reply":{"description":"The query results upon error.","allOf":[{"$ref":"#/components/schemas/GenericReply"}]}},"required":["reply"],"additionalProperties":true},"GenericReply":{"type":"object","properties":{"err_code":{"type":"string","description":"HTTP response code."},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","description":"Additional information describing the error."}},"additionalProperties":true},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors"}}},"EmptyRequest":{"type":"object","properties":{"request_data":{"type":"object","description":"An empty dictionary returns the time and status of the last websites assessment."}},"required":["request_data"],"additionalProperties":true}},"responses":{"UNPROCESSABLE_ENTITY":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
```

## Get All Websites

> Get a complete or filtered list of your public-facing websites. \<br />Required License: \*\*Cortex Xpanse Expander\*\*<br>

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"tags":[{"name":"Asset Management","description":"APIs for managing assets"}],"servers":[{"url":"https://api-{{fqdn}}"}],"paths":{"/public_api/v1/assets/get_external_websites/":{"post":{"parameters":[{"in":"header","name":"authorization","description":"api-key","schema":{"type":"string"},"required":true},{"in":"header","name":"x-xdr-auth-id","description":"api-key-id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebsitesResponse"}}}},"400":{"description":"Bad Request. Got an invalid JSON.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"401":{"description":"Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"402":{"description":"Unauthorized access. User does not have the required license type to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"403":{"description":"Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"422":{"$ref":"#/components/responses/UNPROCESSABLE_ENTITY"},"500":{"description":"Internal server error. A unified status for API communication type errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebsitesRequest"}}},"description":""},"summary":"Get All Websites","description":"Get a complete or filtered list of your public-facing websites. <br />Required License: **Cortex Xpanse Expander**\n","tags":["Asset Management"]}}},"components":{"schemas":{"GetWebsitesResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/GetWebsitesReply"}},"additionalProperties":true},"GetWebsitesReply":{"type":"object","properties":{"total_count":{"type":"integer"},"result_count":{"type":"integer"},"websites":{"type":"array","items":{"$ref":"#/components/schemas/ExternalWebsite"}},"next_page_token":{"type":"string","description":"This attribute is only returned if use_page_token is provided in the request with value true"}},"additionalProperties":true},"ExternalWebsite":{"type":"object","properties":{"website_id":{"type":"string"},"host":{"type":"string"},"protocol":{"type":"string"},"is_active":{"type":"string"},"site_categories":{"type":"array","items":{"type":"string"}},"technology_ids":{"type":"array","items":{"type":"string"}},"first_observed":{"type":"integer"},"last_observed":{"type":"integer"},"provider_names":{"type":"array","items":{"type":"string"}},"ips":{"type":"array","items":{"type":"string"}},"port":{"type":"integer"},"active_service_ids":{"type":"array","items":{"type":"string"}},"http_type":{"type":"string"},"third_party_script_domains":{"type":"array","items":{"type":"string"}},"security_assessments":{"type":"array","items":{"$ref":"#/components/schemas/SecurityAssessment"}},"authentication":{"type":"array","items":{"type":"string"}},"rootPageHttpStatusCode":{"type":"string"},"isNonConfiguredHost":{"type":"boolean"},"externally_inferred_vulnerability_score":{"type":"number"},"externally_inferred_cves":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}}},"additionalProperties":true},"SecurityAssessment":{"type":"object","properties":{"name":{"type":"string"},"priority":{"type":"integer"},"score":{"type":"integer"},"securityAssessmentDetails":{"$ref":"#/components/schemas/SecurityAssessmentDetails"}},"additionalProperties":true},"SecurityAssessmentDetails":{"type":"object","properties":{"pages":{"type":"array","items":{"$ref":"#/components/schemas/Page"}},"description":{"type":"string"}},"additionalProperties":true},"Page":{"type":"object","properties":{"url":{"type":"string"},"message":{"type":"string"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/PageElement"}}},"additionalProperties":true},"PageElement":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}},"additionalProperties":true},"DefaultApiErrorResponse":{"type":"object","properties":{"reply":{"description":"The query results upon error.","allOf":[{"$ref":"#/components/schemas/GenericReply"}]}},"required":["reply"],"additionalProperties":true},"GenericReply":{"type":"object","properties":{"err_code":{"type":"string","description":"HTTP response code."},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","description":"Additional information describing the error."}},"additionalProperties":true},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors"}}},"GetWebsitesRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/GetWebsitesRequestData"}},"required":["request_data"],"additionalProperties":true},"GetWebsitesRequestData":{"type":"object","description":"A dictionary containing the API request fields. An empty dictionary returns all results.","properties":{"filters":{"type":"array","description":"Array of filter fields. Each JSON object must contain a field, operator, and value.","items":{"$ref":"#/components/schemas/ExternalWebsitesFilter"}},"search_from":{"type":"integer","default":0,"minimum":0,"description":"An integer representing the start offset index of results <br />Default value - 0\n"},"search_to":{"type":"integer","default":500,"minimum":0,"description":"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. <br />Default value - 500\n"},"sort":{"$ref":"#/components/schemas/ExternalWebsitesSort"},"use_page_token":{"type":"boolean","description":"Use `\"use_page_token\":true` in the initial request to paginate the response data.\n"},"next_page_token":{"type":"string","description":"If `\"use_page_token\":true` was included in the initial request, the response for that request will include a page token.  <br />Use `\"next_page_token\":\"string\"` to pass that page token into the next request to paginate the next set of data.\n"}}},"ExternalWebsitesFilter":{"type":"object","properties":{"field":{"type":"string","enum":["ips","technology_ids","http_type","is_active","provider_names","tags","active_service_ids","third_party_script_domains","host","authentication","site_categories","business_units_list"],"description":"String that identifies the external service field the filter is matching. Filters are based on the following case-sensitive keywords:\n "},"operator":{"type":"string","enum":["in","contains","eq","neq","not_contains"],"description":"String that identifies the comparison operator you want to use for this filter. Valid operator keywords and corresponding filter fields are:\n  - **contains**/**not_contains**- used with `active_service_ids`, `authentication`, `host`, `provider_names`, `site_categories`, `technology_ids`, `third_party_script_domains` \n  - **eq**/**ne** - used with `ips`, `host`\n  - **in** - used with `is_active`, `http_type`, `tags`, `ips`\n"},"value":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"boolean"}],"description":"Value that the filter must match. The contents of this field will differ depending on the website field that you specified for this filter:\n  - **host** - string\n  - **is_active** - values are `yes` or `no`\n  - **technology_ids** - list of strings\n  - **provider_names** - string\n  - **site_categories** - string\n  - **active_service_ids** - list of strings\n  - **ips** - list of strings\n  - **tags** - list of strings\n  - **http_type** - values are `http_only`, `http_redirects_to_https`, `https_only`\n  - **third_party_script_domains** - list of strings\n  - **authentication** - string\n -  **business_units_list** - list of business unit names\n"}}},"ExternalWebsitesSort":{"type":"object","properties":{"field":{"type":"string","default":"host","enum":["first_observed","host","last_observed"],"description":"Valid values are:\n  - `host`\n  - `first_observed`\n  - `last_observed`\n"},"keyword":{"type":"string","default":"asc","enum":["ASC","asc","DESC","desc"],"description":"Valid values are:\n  - ASC - ascending order\n  - DESC - descending order\n  ASC is the default.\n"}},"additionalProperties":true,"description":"Identifies the sort order for the result set. Values are case sensitive. The default sort is defined as `is_active` and `ASC`."}},"responses":{"UNPROCESSABLE_ENTITY":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
```

## Get Website Details

> Get details about specific websites based on website IDs. You can submit up to 20 website IDs. \<br/>Required License: \*\*Cortex Xpanse Expander\*\*

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"tags":[{"name":"Asset Management","description":"APIs for managing assets"}],"servers":[{"url":"https://api-{{fqdn}}"}],"paths":{"/public_api/v1/assets/get_external_website/":{"post":{"parameters":[{"in":"header","name":"authorization","description":"api-key","schema":{"type":"string"},"required":true},{"in":"header","name":"x-xdr-auth-id","description":"api-key-id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebsiteDetailsResponse"}}}},"400":{"description":"Bad Request. Got an invalid JSON.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"401":{"description":"Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"402":{"description":"Unauthorized access. User does not have the required license type to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"403":{"description":"Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"422":{"$ref":"#/components/responses/UNPROCESSABLE_ENTITY"},"500":{"description":"Internal server error. A unified status for API communication type errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebsiteDetailsRequest"}}}},"summary":"Get Website Details","description":"Get details about specific websites based on website IDs. You can submit up to 20 website IDs. <br/>Required License: **Cortex Xpanse Expander**","tags":["Asset Management"]}}},"components":{"schemas":{"GetWebsiteDetailsResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/WebsiteDetails"}},"required":["reply"],"additionalProperties":true},"WebsiteDetails":{"type":"object","properties":{"details":{"type":"array","items":{"$ref":"#/components/schemas/Website"}}},"additionalProperties":true},"Website":{"type":"object","properties":{"website_id":{"type":"string"},"host":{"type":"string"},"protocol":{"type":"string"},"is_active":{"type":"string"},"site_categories":{"type":"array","items":{"type":"string"}},"technology_ids":{"type":"array","items":{"type":"string"}},"first_observed":{"type":"integer"},"last_observed":{"type":"integer"},"provider_names":{"type":"array","items":{"type":"string"}},"ips":{"type":"array","items":{"type":"string"}},"port":{"type":"integer"},"active_service_ids":{"type":"array","items":{"type":"string"}},"http_type":{"type":"string"},"security_assessments":{"type":"array","items":{"$ref":"#/components/schemas/SecurityAssessment"}},"rootPageHttpStatusCode":{"type":"string"},"isNonConfiguredHost":{"type":"boolean"},"externally_inferred_vulnerability_score":{"type":"number"},"externally_inferred_cves":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"assets":{"type":"array","items":{"$ref":"#/components/schemas/WebsiteAsset"}},"technologies":{"type":"array","items":{"$ref":"#/components/schemas/WebsiteTechnologies"}},"third_party_resources":{"type":"array","items":{"$ref":"#/components/schemas/WebsiteThirdPartyResource"}},"forms":{"type":"array","items":{"$ref":"#/components/schemas/WebsiteForm"}},"details":{"$ref":"#/components/schemas/WebsiteNestedDetails"}},"additionalProperties":true},"SecurityAssessment":{"type":"object","properties":{"name":{"type":"string"},"priority":{"type":"integer"},"score":{"type":"integer"},"securityAssessmentDetails":{"$ref":"#/components/schemas/SecurityAssessmentDetails"}},"additionalProperties":true},"SecurityAssessmentDetails":{"type":"object","properties":{"pages":{"type":"array","items":{"$ref":"#/components/schemas/Page"}},"description":{"type":"string"}},"additionalProperties":true},"Page":{"type":"object","properties":{"url":{"type":"string"},"message":{"type":"string"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/PageElement"}}},"additionalProperties":true},"PageElement":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}},"additionalProperties":true},"WebsiteAsset":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"assetType":{"type":"string"}},"required":["assetType","id","name"],"additionalProperties":true},"WebsiteTechnologies":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"cpe":{"type":"string"},"categoryIds":{"type":"array","items":{"type":"integer"}},"technologyDetails":{"$ref":"#/components/schemas/TechnologyDetails"},"name":{"type":"string"}},"additionalProperties":true},"TechnologyDetails":{"type":"object","properties":{"confidence":{"type":"number"},"urls":{"type":"array","items":{"$ref":"#/components/schemas/WebsiteUrl"}},"evidence":{"$ref":"#/components/schemas/WebsiteEvidence"}},"additionalProperties":true},"WebsiteUrl":{"type":"object","properties":{"url":{"type":"string"},"ip":{"type":"string"},"observed":{"type":"integer"}},"required":["ip","observed","url"],"additionalProperties":true},"WebsiteEvidence":{"type":"object","properties":{"impliedBy":{"type":"array","items":{"type":"string"}},"patterns":{"type":"array","items":{"$ref":"#/components/schemas/WebsiteEvidencePattern"}}},"required":["impliedBy","patterns"],"additionalProperties":true},"WebsiteEvidencePattern":{"type":"object","properties":{"type":{"type":"string"},"regex":{"type":"string"},"value":{"type":"string"}},"required":["regex","type","value"],"additionalProperties":true},"WebsiteThirdPartyResource":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"thirdPartyResourceDetails":{"$ref":"#/components/schemas/WebsiteThirdPartyResourceDetails"}},"additionalProperties":true},"WebsiteThirdPartyResourceDetails":{"type":"object","properties":{"observed":{"type":"integer"}},"required":["observed"],"additionalProperties":true},"WebsiteForm":{"type":"object","properties":{"url":{"type":"string"},"action":{"type":"string"},"purpose":{"type":"string"},"formDetails":{"$ref":"#/components/schemas/FormDetails"}},"required":["action","formDetails","purpose","url"],"additionalProperties":true},"FormDetails":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/FormField"}}},"required":["fields"],"additionalProperties":true},"FormField":{"type":"object","properties":{"name":{"type":"string"},"maxLength":{"type":"integer"},"required":{"type":"boolean"},"dataType":{"type":"string"}},"required":["dataType","maxLength","name","required"],"additionalProperties":true},"WebsiteNestedDetails":{"type":"object","properties":{"ips":{"type":"array","items":{"$ref":"#/components/schemas/WebsiteIp"}},"screenshots":{"type":"array","items":{"$ref":"#/components/schemas/WebsiteScreenshot"}}},"additionalProperties":true},"WebsiteIp":{"type":"object","properties":{"ip":{"type":"string"},"lastObserved":{"type":"integer"},"firstObserved":{"type":"integer"}},"required":["firstObserved","ip","lastObserved"],"additionalProperties":true},"WebsiteScreenshot":{"type":"object","properties":{"url":{"type":"string"},"ip":{"type":"string"},"size":{"type":"integer"},"observed":{"type":"integer"}},"required":["ip","observed","size","url"],"additionalProperties":true},"DefaultApiErrorResponse":{"type":"object","properties":{"reply":{"description":"The query results upon error.","allOf":[{"$ref":"#/components/schemas/GenericReply"}]}},"required":["reply"],"additionalProperties":true},"GenericReply":{"type":"object","properties":{"err_code":{"type":"string","description":"HTTP response code."},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","description":"Additional information describing the error."}},"additionalProperties":true},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors"}}},"GetWebsiteDetailsRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/GetWebsiteDetailsRequestData"}},"required":["request_data"],"additionalProperties":true},"GetWebsiteDetailsRequestData":{"type":"object","properties":{"website_id_list":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string"},"description":"A string representing the website ID you want to get details for. Limit is 20 website ids"}},"additionalProperties":true,"description":"A dictionary containing the API request fields."}},"responses":{"UNPROCESSABLE_ENTITY":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
```

## Get Websites Last Assessment

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

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"tags":[{"name":"Asset Management","description":"APIs for managing assets"}],"servers":[{"url":"https://api-{{fqdn}}"}],"paths":{"/public_api/v1/assets/get_external_websites/last_external_assessment/":{"post":{"parameters":[{"in":"header","name":"authorization","description":"api-key","schema":{"type":"string"},"required":true},{"in":"header","name":"x-xdr-auth-id","description":"api-key-id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLastAssessmentResponse"}}}},"400":{"description":"Bad Request. Got an invalid JSON.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"401":{"description":"Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"402":{"description":"Unauthorized access. User does not have the required license type to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"403":{"description":"Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"422":{"$ref":"#/components/responses/UNPROCESSABLE_ENTITY"},"500":{"description":"Internal server error. A unified status for API communication type errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyRequest"}}}},"summary":"Get Websites Last Assessment","description":"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.","tags":["Asset Management"]}}},"components":{"schemas":{"GetLastAssessmentResponse":{"type":"object","properties":{"last_external_assessment":{"$ref":"#/components/schemas/LastExternalAssessment"}},"additionalProperties":true},"LastExternalAssessment":{"type":"object","properties":{"status":{"type":"boolean","description":"`True`: the update of services data was successful.<br /> `False`: the update of services data failed.\n"},"time":{"type":"string"}}},"DefaultApiErrorResponse":{"type":"object","properties":{"reply":{"description":"The query results upon error.","allOf":[{"$ref":"#/components/schemas/GenericReply"}]}},"required":["reply"],"additionalProperties":true},"GenericReply":{"type":"object","properties":{"err_code":{"type":"string","description":"HTTP response code."},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","description":"Additional information describing the error."}},"additionalProperties":true},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors"}}},"EmptyRequest":{"type":"object","properties":{"request_data":{"type":"object","description":"An empty dictionary returns the time and status of the last websites assessment."}},"required":["request_data"],"additionalProperties":true}},"responses":{"UNPROCESSABLE_ENTITY":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
```

## Get Business Units

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

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"tags":[{"name":"Asset Management","description":"APIs for managing assets"}],"servers":[{"url":"https://api-{{fqdn}}"}],"paths":{"/public_api/v1/assets/get_business_units":{"post":{"summary":"Get Business Units","tags":["Asset Management"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"reply":{"type":"object","properties":{"total_count":{"type":"integer"},"result_count":{"type":"integer"},"business_units":{"type":"array","items":{"type":"object","properties":{"business_unit_id":{"type":"string"},"business_unit_name":{"type":"string"},"parent_id":{"type":"string","nullable":true}}}}}}}}}}},"400":{"description":"Bad Request. Got an invalid JSON."},"401":{"description":"Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"402":{"description":"Unauthorized access. User does not have the required license type to run this API.","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"403":{"description":"Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"422":{"description":"Unprocessable Entity ","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal server error. A unified status for API communication type errors.","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/DefaultApiErrorResponse"}}}}},"operationId":"post-public_api-v1-assets-get_business_units","description":"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.","parameters":[{"schema":{"type":"string"},"in":"header","name":"authorization","description":"api-key","required":true},{"schema":{"type":"string"},"in":"header","name":"x-xdr-auth-id","description":"api-key-id","required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["request_data"],"properties":{"request_data":{"type":"object","description":"A dictionary containing the API request fields. An empty dictionary returns all results.","properties":{"filters":{"type":"array","description":"An array of filter fields.","items":{"type":"object","properties":{"field":{"enum":["business_unit_id","business_unit_name","parent_id"],"description":"Identifies the business unit field the filter is matching. "},"operator":{"enum":["contains","eq","in","neq","not_contains"],"description":"Identifies the comparison operator you want to use for this filter. All operators listed can be used with all filter fields."},"value":{"type":"string","description":"Value depends on the filter field used.\r\n- **business_unit_id**: string\r\n- **business_unit_name**: string\r\n- **parent_id**: string"}}}},"use_page_token":{"type":"boolean","description":"Use `\"use_page_token\":true` in the initial request to paginate the response data.\r\n"},"next_page_token":{"type":"string","description":"If `\"use_page_token\":true` was included in the initial request, the response for that request will include a page token.<br />  Use `\"next_page_token\":\"string\"` to pass that page token into the next request to paginate the next set of data.'\r\n"}}}}}}}}}}},"components":{"schemas":{"DefaultApiErrorResponse":{"type":"object","properties":{"reply":{"description":"The query results upon error.","allOf":[{"$ref":"#/components/schemas/GenericReply"}]}},"required":["reply"],"additionalProperties":true},"GenericReply":{"type":"object","properties":{"err_code":{"type":"string","description":"HTTP response code."},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","description":"Additional information describing the error."}},"additionalProperties":true},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors"}}}}}}
```

## POST /public\_api/v1/assets/override\_bu\_tags/

> Override Business Units for Assets

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"tags":[{"name":"Asset Management","description":"APIs for managing assets"}],"servers":[{"url":"https://api-{{fqdn}}"}],"paths":{"/public_api/v1/assets/override_bu_tags/":{"post":{"parameters":[{"in":"header","name":"authorization","description":"api-key","schema":{"type":"string"},"required":true},{"in":"header","name":"x-xdr-auth-id","description":"api-key-id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignTagsToAsmEntitiesResponse"}}}},"400":{"description":"Bad Request. Got an invalid JSON.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"401":{"description":"Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"402":{"description":"Unauthorized access. User does not have the required license type to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"403":{"description":"Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"422":{"$ref":"#/components/responses/UNPROCESSABLE_ENTITY"},"500":{"description":"Internal server error. A unified status for API communication type errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverrideBusForAsmAssetsRequest"}}}},"summary":"Override Business Units for Assets","tags":["Asset Management"]}}},"components":{"schemas":{"AssignTagsToAsmEntitiesResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/AssignTagsToAsmEntitiesReply"}},"required":["reply"],"additionalProperties":true},"AssignTagsToAsmEntitiesReply":{"type":"object","properties":{"assign_tags":{"type":"string","description":"succeeded if request was successful"}},"required":["assign_tags"],"additionalProperties":true},"DefaultApiErrorResponse":{"type":"object","properties":{"reply":{"description":"The query results upon error.","allOf":[{"$ref":"#/components/schemas/GenericReply"}]}},"required":["reply"],"additionalProperties":true},"GenericReply":{"type":"object","properties":{"err_code":{"type":"string","description":"HTTP response code."},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","description":"Additional information describing the error."}},"additionalProperties":true},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors"}}},"OverrideBusForAsmAssetsRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/OverrideBusForAsmAssetsRequestData"}},"required":["request_data"],"additionalProperties":true},"OverrideBusForAsmAssetsRequestData":{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/OverrideBusForAsmAssetsFilter"}},"business_units":{"type":"array","description":"List of strings in format BU: uuid.","items":{"type":"string"}},"include_subdomains":{"type":"boolean","description":"Indicates whether these tags should propagate to subdomains."}}},"OverrideBusForAsmAssetsFilter":{"type":"object","properties":{"field":{"type":"string","enum":["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"]},"operator":{"type":"string","enum":["in","contains","neq","eq","not_contains"]},"value":{"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}],"description":"Value that the filter must match. The contents of this field will differ depending on the asset field that you specified for this filter:\n  - name: eq, neq - string\n  - type: in - list of strings\n  - has_xdr_agent: eq, neq - boolean\n  - ip_address: eq, neq - string\n  - ipv6_address: eq, neq - string\n  - externally_detected_providers: contains - string\n  - has_active_external_services: eq, neq - boolean\n  - mac_addresses: eq, neq - string\n  - externally_inferred_cves: contains, not_contains - string\n  - tags: contains, not_contains - list of strings\n  - business_units_list: contains, not_contains - list of strings in format BU: uuid\n  - has_bu_overrides: eq, neq - boolean\n  - asm_id_list: in - list of strings\n"}},"additionalProperties":true}},"responses":{"UNPROCESSABLE_ENTITY":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
```

## Update Asset Annotation

> 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. \<br />Required License: \*\*Cortex Xpanse Expander\*\*<br>

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"tags":[{"name":"Asset Management","description":"APIs for managing assets"}],"servers":[{"url":"https://api-{{fqdn}}"}],"paths":{"/public_api/v1/assets/assets_internet_exposure/annotation/":{"post":{"parameters":[{"in":"header","name":"authorization","description":"api-key","schema":{"type":"string"},"required":true},{"in":"header","name":"x-xdr-auth-id","description":"api-key-id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAsmAssetNoteResponse"}}}},"400":{"description":"Bad Request. Got an invalid JSON.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"401":{"description":"Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"402":{"description":"Unauthorized access. User does not have the required license type to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"403":{"description":"Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"422":{"$ref":"#/components/responses/UNPROCESSABLE_ENTITY"},"500":{"description":"Internal server error. A unified status for API communication type errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAsmAssetNoteRequest"}}}},"summary":"Update Asset Annotation","description":"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. <br />Required License: **Cortex Xpanse Expander**\n","tags":["Asset Management"]}}},"components":{"schemas":{"UpdateAsmAssetNoteResponse":{"type":"object","properties":{"reply":{"type":"string","description":"Reply indicates `succeeded` if the annotation was updated."}},"additionalProperties":true},"DefaultApiErrorResponse":{"type":"object","properties":{"reply":{"description":"The query results upon error.","allOf":[{"$ref":"#/components/schemas/GenericReply"}]}},"required":["reply"],"additionalProperties":true},"GenericReply":{"type":"object","properties":{"err_code":{"type":"string","description":"HTTP response code."},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","description":"Additional information describing the error."}},"additionalProperties":true},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors"}}},"UpdateAsmAssetNoteRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/UpdateAsmAssetNoteRequestData"}},"required":["request_data"],"additionalProperties":true},"UpdateAsmAssetNoteRequestData":{"type":"object","properties":{"assets":{"type":"array","items":{"$ref":"#/components/schemas/AsmAssetNotePatch"},"description":"List of dictionaries that refer to assets."},"should_append":{"type":"boolean","default":true,"description":"`True` append the annotation to the existing annotation.<br /> `False` replaces the existing annotation.<br/> The default is `true`.\n"}},"additionalProperties":true,"description":"A dictionary containing the API request fields."},"AsmAssetNotePatch":{"type":"object","properties":{"entity_id":{"type":"string","description":"<asm_asset_id>"},"entity_type":{"type":"string","enum":["asset","ip_range"],"description":"Values are `asset` or `ip_range`."},"annotation":{"type":"string","description":"Annotation text."}},"additionalProperties":true}},"responses":{"UNPROCESSABLE_ENTITY":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
```

## Create User-Defined IP Range

> 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.&#x20;
> \
> \- 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.
> \\
>
> <br>

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"tags":[{"name":"Asset Management","description":"APIs for managing assets"}],"servers":[{"url":"https://api-{{fqdn}}"}],"paths":{"/public_api/v1/assets/create_user_defined_ip_range/":{"post":{"summary":"Create User-Defined IP Range","tags":["Asset Management"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"reply":{"type":"object","properties":{"user_defined_ip_range":{"type":"string"}}}}}}}},"400":{"description":"Bad Request. Got an invalid JSON.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"401":{"description":"Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"402":{"description":"Unauthorized access. User does not have the required license type to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"403":{"description":"Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"422":{"description":"Unprocessable Entity ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal server error. A unified status for API communication type errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}}},"operationId":"post-public_api-v1-assets-create_user_defined_ip_range","description":"Define an IP address range and assign a business unit (BU) or IP address tag (IPR) to that range. Note the following guidelines:\r\n- Use the shouldReplace field to indicate whether to replace all previously applied BUs on overlapping ranges. \r\n- Tags and notes on overlapping ranges will be deleted.\r\n- If only startIp is supplied, the endpoint will create a range for that single IP address.\r\n- If only endIP is supplied, the endpoint will create a range for that single IP address.\r\n- Define the range using either the startIp and endIp OR the cidrIp range, not both. Xpanse will run the request on only one range.\r\n\r\n","parameters":[{"schema":{"type":"string"},"in":"header","name":"authorization","required":true,"description":"api-key"},{"schema":{"type":"string"},"in":"header","name":"x-xdr-auth-id","description":"api-key-id","required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["request_data"],"properties":{"request_data":{"type":"object","properties":{"startIp":{"type":"string","description":"First IP address of the range.","nullable":true},"endIp":{"type":"string","description":"Ending IP address of the range.","nullable":true},"cidrIp":{"type":"string","description":"IP range in CIDR notation. ","nullable":true},"buTagIds":{"type":"array","description":"List of business unit tag IDs that will be applied to the IP range.","nullable":true,"items":{"type":"string"}},"iprTagIds":{"type":"array","description":"List of IP range tag IDs (IPR) that will be applied to the IP range.","nullable":true,"items":{"type":"string"}},"shouldReplace":{"type":"boolean","description":"Boolean denoting whether to replace all previously applied business units on overlapping ranges. "}}}}}}}}}}},"components":{"schemas":{"DefaultApiErrorResponse":{"type":"object","properties":{"reply":{"description":"The query results upon error.","allOf":[{"$ref":"#/components/schemas/GenericReply"}]}},"required":["reply"],"additionalProperties":true},"GenericReply":{"type":"object","properties":{"err_code":{"type":"string","description":"HTTP response code."},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","description":"Additional information describing the error."}},"additionalProperties":true},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors"}}}}}}
```

## Upload Assets

> 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.&#x20;
> \\
>
> \
> 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

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"tags":[{"name":"Asset Management","description":"APIs for managing assets"}],"servers":[{"url":"https://api-{{fqdn}}"}],"paths":{"/public_api/v1/asm_management/upload_asm_data/":{"post":{"summary":"Upload Assets","tags":["Asset Management"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"reply":{"type":"object","properties":{"asset_names":{"type":"array","items":{"type":"string"}},"errors":{"type":"array","items":{"type":"object","properties":{}}}}}}}}}},"400":{"description":"Bad Request. Got an invalid JSON.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"401":{"description":"Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"402":{"description":"Unauthorized access. User does not have the required license type to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"403":{"description":"Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"422":{"description":"Unprocessable Entity ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal server error. A unified status for API communication type errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}}},"operationId":"post-public_api-v1-asm_management-upload_asm_data","description":"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. \r\n\r\nCheck 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.\r\n\r\nYou cannot upload an asset that was added or rejected in a previous upload request.\r\n\r\nRequired role: Instance Admin or Account Admin\r\n\r\nRequired license: Cortex Xpanse Expander","parameters":[{"schema":{"type":"string"},"in":"header","name":"authorization","description":"api-key","required":true},{"schema":{"type":"string"},"in":"header","name":"x-xdr-auth-id","description":"api-key-id","required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["request_data"],"properties":{"request_data":{"type":"object","description":"(Required) A dictionary containing the API request fields.","required":["request_type","asset_type","asset_identifiers","business_units"],"properties":{"request_type":{"description":"Indicates that you want to add new assets to your inventory.\r\n\"Addition\" is the only supported value.\r\n","enum":["addition"]},"asset_type":{"description":"Type of asset. Supported values are `ip_range` and `domain`.","enum":["ip_range","domain"]},"asset_identifiers":{"type":"array","description":"List of assets to be uploaded. \r\n- All assets in a request must be the same asset type, either domain or ip_range. \r\n- Value can be one or more domains or one or more ipv4 ranges.\r\n- Accepted formats for IPv4 address ranges are `<first ip>-<last ip>` and CIDR format.\r\n- Individual IPs are supported using either CIDR Notation (e.g. 8.8.8.8/32) or  `<first ip>-<last ip>` format (e.g. 8.8.8.8-8.8.8.8).\r\n","items":{"type":"string"}},"business_units":{"type":"array","description":"One or more business unit IDs or business unit names to which the uploaded assets will be assigned.","items":{"type":"string"}}}}}}}}}}}},"components":{"schemas":{"DefaultApiErrorResponse":{"type":"object","properties":{"reply":{"description":"The query results upon error.","allOf":[{"$ref":"#/components/schemas/GenericReply"}]}},"required":["reply"],"additionalProperties":true},"GenericReply":{"type":"object","properties":{"err_code":{"type":"string","description":"HTTP response code."},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","description":"Additional information describing the error."}},"additionalProperties":true},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors"}}}}}}
```

## Remove Assets

> 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

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"tags":[{"name":"Asset Management","description":"APIs for managing assets"}],"servers":[{"url":"https://api-{{fqdn}}"}],"paths":{"/public_api/v1/asm_management/remove_asm_data":{"post":{"summary":"Remove Assets","tags":["Asset Management"],"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"reply":{"type":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"401":{"description":"Unauthorized. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"402":{"description":"Unauthorized access. User does not have the required license type to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"403":{"description":"Forbidden access.  The provided API Key does not have the required RBAC permissions to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"422":{"description":"Unprocessable Entity ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error. A unified status for API communication type errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}}},"operationId":"post-public_api-v1-asm_management-remove_asm_data","description":"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.\n\nRemoved 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.\nYou cannot remove an asset that was uploaded in a previous upload request. \n\nWhen 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.\n\nRequired role: Instance Admin \n\nRequired license: Cortex Xpanse Expander","parameters":[{"schema":{"type":"string"},"in":"header","name":"authorization","description":"{api-key}","required":true},{"schema":{"type":"string"},"in":"header","name":"x-xdr-auth-id","description":"{api-key-id}","required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["request_data"],"properties":{"request_data":{"type":"object","description":"A dictionary containing the API request fields.","required":["asset_type","asset_identifiers"],"properties":{"asset_type":{"enum":["certificate","domain","ip_range"],"description":"The type of asset being removed."},"asset_identifiers":{"type":"array","description":"A list of one or more assets you want to add to the inventory. Note the following:\n- All assets in a request must be of the same asset type.\n- For IP ranges, the accepted format is first-last or CIDR format. \n- Individual IP addresses can be listed using either CIDR notation (for example, 8.8.8.8/32) or first-last format (for example, 8.8.8.8-8.8.8.8).","items":{"type":"string"}}}}}}}}}}}},"components":{"schemas":{"DefaultApiErrorResponse":{"type":"object","properties":{"reply":{"description":"The query results upon error.","allOf":[{"$ref":"#/components/schemas/GenericReply"}]}},"required":["reply"],"additionalProperties":true},"GenericReply":{"type":"object","properties":{"err_code":{"type":"string","description":"HTTP response code."},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","description":"Additional information describing the error."}},"additionalProperties":true},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://cortex-docs.paloaltonetworks.com/xpanse-api/xpanse-public-api/asset-management.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.