> 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/models.md).

# Models

## The reply object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"reply":{"title":"reply","type":"object","description":"The query result upon error.","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."}}}}}}
```

## The Error object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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"}}}}}}
```

## The PaginationMetadata object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"PaginationMetadata":{"type":"object","properties":{"total":{"type":"integer"},"total_pages":{"type":"integer"},"first_page":{"type":"integer"},"last_page":{"type":"integer"},"page":{"type":"integer"},"previous_page":{"type":"integer"},"next_page":{"type":"integer"}}}}}}
```

## The OrganizationRecord object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The Tag object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"Tag":{"type":"object","properties":{"tag_id":{"type":"string"},"tag_name":{"type":"string"}},"required":["tag_id","tag_name"],"additionalProperties":true}}}}
```

## The NetworkRecord object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The ServiceDetailIpRangeDetails object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The ServiceDetailIpRange object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The GetAsmAssetDetailsRequestData object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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."}}}}
```

## The GetAsmAssetDetailsRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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."}}}}
```

## The GenericReply object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The DefaultApiErrorResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"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}}}}
```

## The Geolocation object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"Geolocation":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"},"countryCode":{"type":"string"},"city":{"type":"string"},"regionCode":{"type":"string"},"timeZone":{"type":"string"}},"additionalProperties":true}}}}
```

## The Ips object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The ProviderDetails object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"ProviderDetails":{"type":"object","properties":{"name":{"type":"string"},"displayName":{"type":"string"},"firstObserved":{"type":"integer"},"lastObserved":{"type":"integer"}},"required":["displayName","name"],"additionalProperties":true}}}}
```

## The AsmDomainAdmin object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The AsmDomainRegistrar object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The AsmDomain object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The IpSource object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"IpSource":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":true}}}}
```

## The AsmProvider object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The AsmAssetIp object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The CertificateDetails object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The InferredCveMatchMetadata object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"InferredCveMatchMetadata":{"type":"object","properties":{"inferredCveMatchType":{"type":"string"},"product":{"type":"string"},"confidence":{"type":"string"},"vendor":{"type":"string"},"version":{"type":"string"}},"required":["confidence","inferredCveMatchType","product","vendor","version"],"additionalProperties":true}}}}
```

## The InferredCve object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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"}}}}}}
```

## The InferredCvesObserved object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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"}}}}}}
```

## The AsmAssetDetailsDetails object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The AsmAssetDetailExternalService object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"AsmAssetDetailExternalService":{"type":"object","properties":{"serviceType":{"type":"string"},"serviceKey":{"type":"string"},"activityStatus":{"type":"string"}},"additionalProperties":true}}}}
```

## The GetAsmAssetDetails object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The GetAsmAssetDetailsReply object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The GetAsmAssetDetailsResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"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}}}}
```

## The AsmAssetsFilter object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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"}}}}}}
```

## The GetAsmAssetsSort object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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."}}}}
```

## The GetAsmAssetsData object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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."}}}}
```

## The GetAsmAssetsRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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."}}}}
```

## The BusinessUnitHierarchy object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The NetworkInterface object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"NetworkInterface":{"type":"object","properties":{"id":{"type":"string"},"ip":{"type":"string"},"subnet_id":{"type":"string"},"vpc_id":{"type":"string"}},"additionalProperties":true}}}}
```

## The Volume object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"Volume":{"type":"object","properties":{"boot":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"additionalProperties":true}}}}
```

## The AssetsInternetExposureItemExtendedProperties object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The AssetsInternetExposureItem object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The GetAsmAssetsReply object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The GetAsmAssetsResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"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}}}}
```

## The EmptyRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The LastExternalAssessment object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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"}}}}}}
```

## The GetLastAssessmentResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"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"}}}}}}
```

## The ExternalIpAddressRangesFilter object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The ExternalIpAddressRangesSort object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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."}}}}
```

## The GetExternalIpAddressRangesRequestData object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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."}}}}
```

## The GetExternalIpAddressRangesRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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."}}}}
```

## The ExternalIpAddressRange object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The GetExternalIpAddressRangesReply object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The GetExternalIpAddressRangesResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"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}}}}
```

## The IpAddressRangeRequestData object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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."}}}}
```

## The GetExternalIpAddressRangeDetailsRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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."}}}}
```

## The ExternalIpAddressRangeNestedDetails object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The ExternalIpAddressRangeDetails object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The GetExternalIpAddressRangeDetailsReply object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The GetExternalIpAddressRangeDetailsResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"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}}}}
```

## The ServiceIdList object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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."}}}}
```

## The GetServiceDetailsRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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."}}}}
```

## The NestedServiceCertificate object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The NestedServiceDomain object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"NestedServiceDomain":{"type":"object","properties":{"domain":{"type":"string"},"activityStatus":{"type":"string"},"lastObserved":{"type":"integer"},"firstObserved":{"type":"integer"}},"additionalProperties":true}}}}
```

## The ServiceClassificationValues object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"ServiceClassificationValues":{"type":"object","properties":{"jsonValue":{"type":"string"},"firstObserved":{"type":"integer"},"lastObserved":{"type":"integer"}},"required":["firstObserved","jsonValue","lastObserved"],"additionalProperties":true}}}}
```

## The ServiceClassification object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The TlsVersion object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"TlsVersion":{"type":"object","properties":{"tlsVersion":{"type":"string"},"cipherSuite":{"type":"string"},"firstObserved":{"type":"integer"},"lastObserved":{"type":"integer"},"activityStatus":{"type":"string"}},"additionalProperties":true}}}}
```

## The NestedServiceDetails object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The Service object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The ServiceDetails object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The GetServiceDetailsResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"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}}}}
```

## The ExternalServicesFilter object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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"}}}}}}
```

## The ExternalServicesSort object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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."}}}}
```

## The GetServicesRequestData object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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."}}}}
```

## The GetServicesRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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."}}}}
```

## The ExternalService object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The GetServicesReply object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The GetServicesResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"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}}}}
```

## The GetWebsiteDetailsRequestData object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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."}}}}
```

## The GetWebsiteDetailsRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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."}}}}
```

## The PageElement object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"PageElement":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}},"additionalProperties":true}}}}
```

## The Page object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The SecurityAssessmentDetails object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The SecurityAssessment object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The WebsiteAsset object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"WebsiteAsset":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"assetType":{"type":"string"}},"required":["assetType","id","name"],"additionalProperties":true}}}}
```

## The WebsiteUrl object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"WebsiteUrl":{"type":"object","properties":{"url":{"type":"string"},"ip":{"type":"string"},"observed":{"type":"integer"}},"required":["ip","observed","url"],"additionalProperties":true}}}}
```

## The WebsiteEvidencePattern object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"WebsiteEvidencePattern":{"type":"object","properties":{"type":{"type":"string"},"regex":{"type":"string"},"value":{"type":"string"}},"required":["regex","type","value"],"additionalProperties":true}}}}
```

## The WebsiteEvidence object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The TechnologyDetails object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The WebsiteTechnologies object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The WebsiteThirdPartyResourceDetails object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"WebsiteThirdPartyResourceDetails":{"type":"object","properties":{"observed":{"type":"integer"}},"required":["observed"],"additionalProperties":true}}}}
```

## The WebsiteThirdPartyResource object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The FormField object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"FormField":{"type":"object","properties":{"name":{"type":"string"},"maxLength":{"type":"integer"},"required":{"type":"boolean"},"dataType":{"type":"string"}},"required":["dataType","maxLength","name","required"],"additionalProperties":true}}}}
```

## The FormDetails object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The WebsiteForm object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The WebsiteIp object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"WebsiteIp":{"type":"object","properties":{"ip":{"type":"string"},"lastObserved":{"type":"integer"},"firstObserved":{"type":"integer"}},"required":["firstObserved","ip","lastObserved"],"additionalProperties":true}}}}
```

## The WebsiteScreenshot object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"WebsiteScreenshot":{"type":"object","properties":{"url":{"type":"string"},"ip":{"type":"string"},"size":{"type":"integer"},"observed":{"type":"integer"}},"required":["ip","observed","size","url"],"additionalProperties":true}}}}
```

## The WebsiteNestedDetails object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The Website object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The WebsiteDetails object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The GetWebsiteDetailsResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"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}}}}
```

## The ExternalWebsitesFilter object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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"}}}}}}
```

## The ExternalWebsitesSort object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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`."}}}}
```

## The GetWebsitesRequestData object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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`."}}}}
```

## The GetWebsitesRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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`."}}}}
```

## The ExternalWebsite object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The GetWebsitesReply object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The GetWebsitesResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"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}}}}
```

## The OverrideBusForAsmAssetsFilter object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The OverrideBusForAsmAssetsRequestData object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The OverrideBusForAsmAssetsRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The AssignTagsToAsmEntitiesReply object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"AssignTagsToAsmEntitiesReply":{"type":"object","properties":{"assign_tags":{"type":"string","description":"succeeded if request was successful"}},"required":["assign_tags"],"additionalProperties":true}}}}
```

## The AssignTagsToAsmEntitiesResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"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}}}}
```

## The AsmAssetNotePatch object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The UpdateAsmAssetNoteRequestData object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The UpdateAsmAssetNoteRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"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}}}}
```

## The UpdateAsmAssetNoteResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"UpdateAsmAssetNoteResponse":{"type":"object","properties":{"reply":{"type":"string","description":"Reply indicates `succeeded` if the annotation was updated."}},"additionalProperties":true}}}}
```

## The AttackSurfaceRulesFilter object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"AttackSurfaceRulesFilter":{"type":"object","properties":{"field":{"type":"string","enum":["attack_surface_rule_id","category","priority","enabled_status","asm_alert_categories"],"description":"Identifies the alert field the filter is matching. Filters are based on the following keywords:\n  - enabled_status\n  - category\n  - priority\n  - attack_surface_rule_id\n  - asm_alert_categories\n"},"operator":{"type":"string","enum":["in"],"description":"String that identifies the comparison operator you want to use for this filter. \n  - in\n"},"value":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Value that this filter must match. The contents of this field will differ depending on the alert field that you specified for this filter"}}}}}}
```

## The GetAttackSurfaceRulesSort object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetAttackSurfaceRulesSort":{"type":"object","properties":{"field":{"type":"string","default":"created","enum":["enabled_status","priority","category","attack_surface_rule_id","attack_surface_rule_name","created"]},"keyword":{"type":"string","default":"desc","enum":["ASC","asc","DESC","desc"],"description":"Can either be ASC (ascending order) or DESC (descending order)."}},"additionalProperties":true,"description":"Identifies the sort order for the result set. By default, the sort is defined as created, DESC."}}}}
```

## The GetAttackSurfaceRulesRequestData object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetAttackSurfaceRulesRequestData":{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/AttackSurfaceRulesFilter"},"description":"Provides an array of filtered fields. Each JSON object can contain the following keywords:\n  - field\n  - operators\n  - value\n"},"search_from":{"type":"integer","default":0,"minimum":0,"description":"An integer representing the starting offset within the query result set from which you want attack surface rules returned"},"search_to":{"type":"integer","default":500,"minimum":0,"description":"An integer representing the end offset within the result set after which you do not want attack surface rules returned. <br />Attack surface rules in the alerts list that are indexed higher than this value are not returned in the final results set. \n"},"sort":{"$ref":"#/components/schemas/GetAttackSurfaceRulesSort"}},"additionalProperties":true,"description":"(Required) A dictionary containing the API request fields.<br />An empty dictionary returns all results."},"AttackSurfaceRulesFilter":{"type":"object","properties":{"field":{"type":"string","enum":["attack_surface_rule_id","category","priority","enabled_status","asm_alert_categories"],"description":"Identifies the alert field the filter is matching. Filters are based on the following keywords:\n  - enabled_status\n  - category\n  - priority\n  - attack_surface_rule_id\n  - asm_alert_categories\n"},"operator":{"type":"string","enum":["in"],"description":"String that identifies the comparison operator you want to use for this filter. \n  - in\n"},"value":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Value that this filter must match. The contents of this field will differ depending on the alert field that you specified for this filter"}}},"GetAttackSurfaceRulesSort":{"type":"object","properties":{"field":{"type":"string","default":"created","enum":["enabled_status","priority","category","attack_surface_rule_id","attack_surface_rule_name","created"]},"keyword":{"type":"string","default":"desc","enum":["ASC","asc","DESC","desc"],"description":"Can either be ASC (ascending order) or DESC (descending order)."}},"additionalProperties":true,"description":"Identifies the sort order for the result set. By default, the sort is defined as created, DESC."}}}}
```

## The GetAttackSurfaceRulesRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetAttackSurfaceRulesRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/GetAttackSurfaceRulesRequestData"}},"required":["request_data"],"additionalProperties":true},"GetAttackSurfaceRulesRequestData":{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/AttackSurfaceRulesFilter"},"description":"Provides an array of filtered fields. Each JSON object can contain the following keywords:\n  - field\n  - operators\n  - value\n"},"search_from":{"type":"integer","default":0,"minimum":0,"description":"An integer representing the starting offset within the query result set from which you want attack surface rules returned"},"search_to":{"type":"integer","default":500,"minimum":0,"description":"An integer representing the end offset within the result set after which you do not want attack surface rules returned. <br />Attack surface rules in the alerts list that are indexed higher than this value are not returned in the final results set. \n"},"sort":{"$ref":"#/components/schemas/GetAttackSurfaceRulesSort"}},"additionalProperties":true,"description":"(Required) A dictionary containing the API request fields.<br />An empty dictionary returns all results."},"AttackSurfaceRulesFilter":{"type":"object","properties":{"field":{"type":"string","enum":["attack_surface_rule_id","category","priority","enabled_status","asm_alert_categories"],"description":"Identifies the alert field the filter is matching. Filters are based on the following keywords:\n  - enabled_status\n  - category\n  - priority\n  - attack_surface_rule_id\n  - asm_alert_categories\n"},"operator":{"type":"string","enum":["in"],"description":"String that identifies the comparison operator you want to use for this filter. \n  - in\n"},"value":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Value that this filter must match. The contents of this field will differ depending on the alert field that you specified for this filter"}}},"GetAttackSurfaceRulesSort":{"type":"object","properties":{"field":{"type":"string","default":"created","enum":["enabled_status","priority","category","attack_surface_rule_id","attack_surface_rule_name","created"]},"keyword":{"type":"string","default":"desc","enum":["ASC","asc","DESC","desc"],"description":"Can either be ASC (ascending order) or DESC (descending order)."}},"additionalProperties":true,"description":"Identifies the sort order for the result set. By default, the sort is defined as created, DESC."}}}}
```

## The AttackSurfaceRule object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"AttackSurfaceRule":{"type":"object","properties":{"attack_surface_rule_name":{"type":"string"},"enabled_status":{"type":"string"},"priority":{"type":"string"},"description":{"type":"string"},"attack_surface_rule_id":{"type":"string"},"category":{"type":"string"},"knowledge_base_link":{"type":"string"},"created":{"type":"integer"},"modified":{"type":"integer"},"modified_by":{"type":"string"},"remediation_guidance":{"type":"string"},"asm_alert_categories":{"type":"array","items":{"type":"string"}}},"required":["asm_alert_categories","attack_surface_rule_id","attack_surface_rule_name","category","created","description","enabled_status","modified","priority","remediation_guidance"],"additionalProperties":true}}}}
```

## The AttackSurfaceRulesPage object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"AttackSurfaceRulesPage":{"type":"object","properties":{"total_count":{"type":"integer","minimum":0},"result_count":{"type":"integer","minimum":0},"attack_surface_rules":{"type":"array","items":{"$ref":"#/components/schemas/AttackSurfaceRule"}}},"required":["attack_surface_rules","result_count","total_count"],"additionalProperties":true},"AttackSurfaceRule":{"type":"object","properties":{"attack_surface_rule_name":{"type":"string"},"enabled_status":{"type":"string"},"priority":{"type":"string"},"description":{"type":"string"},"attack_surface_rule_id":{"type":"string"},"category":{"type":"string"},"knowledge_base_link":{"type":"string"},"created":{"type":"integer"},"modified":{"type":"integer"},"modified_by":{"type":"string"},"remediation_guidance":{"type":"string"},"asm_alert_categories":{"type":"array","items":{"type":"string"}}},"required":["asm_alert_categories","attack_surface_rule_id","attack_surface_rule_name","category","created","description","enabled_status","modified","priority","remediation_guidance"],"additionalProperties":true}}}}
```

## The GetAttackSurfaceRulesResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetAttackSurfaceRulesResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/AttackSurfaceRulesPage"}},"required":["reply"],"additionalProperties":true},"AttackSurfaceRulesPage":{"type":"object","properties":{"total_count":{"type":"integer","minimum":0},"result_count":{"type":"integer","minimum":0},"attack_surface_rules":{"type":"array","items":{"$ref":"#/components/schemas/AttackSurfaceRule"}}},"required":["attack_surface_rules","result_count","total_count"],"additionalProperties":true},"AttackSurfaceRule":{"type":"object","properties":{"attack_surface_rule_name":{"type":"string"},"enabled_status":{"type":"string"},"priority":{"type":"string"},"description":{"type":"string"},"attack_surface_rule_id":{"type":"string"},"category":{"type":"string"},"knowledge_base_link":{"type":"string"},"created":{"type":"integer"},"modified":{"type":"integer"},"modified_by":{"type":"string"},"remediation_guidance":{"type":"string"},"asm_alert_categories":{"type":"array","items":{"type":"string"}}},"required":["asm_alert_categories","attack_surface_rule_id","attack_surface_rule_name","category","created","description","enabled_status","modified","priority","remediation_guidance"],"additionalProperties":true}}}}
```

## The ManagementLogsFilterApi object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"ManagementLogsFilterApi":{"type":"object","properties":{"field":{"type":"string","enum":["email","type","sub_type","result","timestamp","audit_id"]},"operator":{"type":"string","enum":["in","neq","eq","lte","gte"]},"value":{"type":"integer"}},"additionalProperties":true}}}}
```

## The GetManagementLogsSortApi object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetManagementLogsSortApi":{"type":"object","properties":{"field":{"type":"string","default":"timestamp","enum":["sub_type","result","timestamp","audit_id","type"]},"keyword":{"type":"string","default":"desc","enum":["ASC","asc","DESC","desc"]}},"additionalProperties":true}}}}
```

## The GetManagementLogsRequestDataApi object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetManagementLogsRequestDataApi":{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/ManagementLogsFilterApi"}},"search_from":{"type":"integer","default":0,"minimum":0},"search_to":{"type":"integer","default":100,"minimum":0},"sort":{"$ref":"#/components/schemas/GetManagementLogsSortApi"}}},"ManagementLogsFilterApi":{"type":"object","properties":{"field":{"type":"string","enum":["email","type","sub_type","result","timestamp","audit_id"]},"operator":{"type":"string","enum":["in","neq","eq","lte","gte"]},"value":{"type":"integer"}},"additionalProperties":true},"GetManagementLogsSortApi":{"type":"object","properties":{"field":{"type":"string","default":"timestamp","enum":["sub_type","result","timestamp","audit_id","type"]},"keyword":{"type":"string","default":"desc","enum":["ASC","asc","DESC","desc"]}},"additionalProperties":true}}}}
```

## The GetManagementLogsRequestApi object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetManagementLogsRequestApi":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/GetManagementLogsRequestDataApi"}},"required":["request_data"],"additionalProperties":true},"GetManagementLogsRequestDataApi":{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/ManagementLogsFilterApi"}},"search_from":{"type":"integer","default":0,"minimum":0},"search_to":{"type":"integer","default":100,"minimum":0},"sort":{"$ref":"#/components/schemas/GetManagementLogsSortApi"}}},"ManagementLogsFilterApi":{"type":"object","properties":{"field":{"type":"string","enum":["email","type","sub_type","result","timestamp","audit_id"]},"operator":{"type":"string","enum":["in","neq","eq","lte","gte"]},"value":{"type":"integer"}},"additionalProperties":true},"GetManagementLogsSortApi":{"type":"object","properties":{"field":{"type":"string","default":"timestamp","enum":["sub_type","result","timestamp","audit_id","type"]},"keyword":{"type":"string","default":"desc","enum":["ASC","asc","DESC","desc"]}},"additionalProperties":true}}}}
```

## The ManagementLogApi object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"ManagementLogApi":{"type":"object","properties":{"AUDIT_ID":{"type":"integer"},"AUDIT_OWNER_NAME":{"type":"string"},"AUDIT_OWNER_EMAIL":{"type":"string"},"AUDIT_ASSET_JSON":{"type":"object","nullable":true},"AUDIT_ASSET_NAMES":{"type":"string","nullable":true},"AUDIT_HOSTNAME":{"type":"string","nullable":true},"AUDIT_RESULT":{"type":"string"},"AUDIT_REASON":{"type":"string","nullable":true},"AUDIT_DESCRIPTION":{"type":"string","nullable":true},"AUDIT_ENTITY":{"type":"string","enum":["LIVE_TERMINAL","RULES","RULES_EXCEPTIONS","AUTH","RESPONSE","INCIDENT_MANAGEMENT","ALERT_MANAGEMENT","INCIDENT_TIMELINE_EVENT","ENDPOINT_MANAGEMENT","ENDPOINT_GROUPS","ALERT_WHITELIST","PUBLIC_API","DISTRIBUTIONS","STARRED_INCIDENTS","POLICY_PROFILES","DEVICE_CONTROL_PROFILES","DEVICE_CONTROL_POLICY","PROTECTION_PROFILES","DEVICE_CONTROL_PROFILE","HOST_FIREWALL_PROFILE","HOST_DISK_ENCRYPTION_PROFILE","POLICY_RULES","PROTECTION_POLICY","DEVICE_CONTROL_TEMP_EXCEPTIONS","DEVICE_CONTROL_GLOBAL_EXCEPTIONS","DEVICE_CONTROL_CUSTOM_DEVICE","GLOBAL_EXCEPTIONS","MSSP","REPORTING","DASHBOARD","BROKER_API","BROKER_VM","MTH","MDR","ALERT_NOTIFICATIONS","INTEGRATIONS","QUERY","SCRIPT_EXECUTION","ALERT_RULES","COLLECTION","API_KEY","EDL","VA_RESCAN_ENDPOINT","HI_RESCAN_ENDPOINT","REMEDIATION","INGEST_DATA","LICENSING","AGENT_CONFIGURATION","PERMISSIONS","SCORING_RULES","LAYOUT_RULES","PLAYBOOK_TRIGGERS","FEATURED_ALERT_FIELDS","SYSTEM","TENANT_TAKEOVER","SCOUTER_POLICY","SCOUTER_PROFILE","SCOUTER_GROUPS","ALLOWED_DOMAINS","QUERY_LIBRARY","TENANT_CONFIGURATION","SCOUTER_CONFIGURATION","HOST_FIREWALL","XIF","XDM","ACTION_CENTER","XCLOUD_INTEGRATION","DATASETS","XSOAR","SECURITY_SETTINGS","ALERT_EXCLUSION","INDICATOR_RULES","EVENT_FORWARDING","ASSET_INVENTORY","SERVER_SETTINGS","ASSET_ROLES","CUSTOM_FIELDS","AUTOMATION_RULES","AGENT_EXCEPTION_RULES","REMEDIATION_PATH_RULES"]},"AUDIT_ENTITY_SUBTYPE":{"type":"string"},"AUDIT_SESSION_ID":{"type":"string","nullable":true},"AUDIT_CASE_ID":{"type":"string","nullable":true},"AUDIT_INSERT_TIME":{"type":"integer"},"AUDIT_SEVERITY":{"type":"string"},"AUDIT_LINK":{"type":"string","nullable":true},"AUDIT_SOURCE_IP":{"type":"string"},"AUDIT_USER_AGENT":{"type":"string"},"AUDIT_USER_ROLES":{"type":"array","items":{"type":"string"}}},"additionalProperties":true}}}}
```

## The ManagementLogsPageApi object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"ManagementLogsPageApi":{"type":"object","properties":{"total_count":{"type":"integer","minimum":0},"result_count":{"type":"integer","minimum":0},"data":{"type":"array","items":{"$ref":"#/components/schemas/ManagementLogApi"}}},"required":["data","result_count","total_count"],"additionalProperties":true},"ManagementLogApi":{"type":"object","properties":{"AUDIT_ID":{"type":"integer"},"AUDIT_OWNER_NAME":{"type":"string"},"AUDIT_OWNER_EMAIL":{"type":"string"},"AUDIT_ASSET_JSON":{"type":"object","nullable":true},"AUDIT_ASSET_NAMES":{"type":"string","nullable":true},"AUDIT_HOSTNAME":{"type":"string","nullable":true},"AUDIT_RESULT":{"type":"string"},"AUDIT_REASON":{"type":"string","nullable":true},"AUDIT_DESCRIPTION":{"type":"string","nullable":true},"AUDIT_ENTITY":{"type":"string","enum":["LIVE_TERMINAL","RULES","RULES_EXCEPTIONS","AUTH","RESPONSE","INCIDENT_MANAGEMENT","ALERT_MANAGEMENT","INCIDENT_TIMELINE_EVENT","ENDPOINT_MANAGEMENT","ENDPOINT_GROUPS","ALERT_WHITELIST","PUBLIC_API","DISTRIBUTIONS","STARRED_INCIDENTS","POLICY_PROFILES","DEVICE_CONTROL_PROFILES","DEVICE_CONTROL_POLICY","PROTECTION_PROFILES","DEVICE_CONTROL_PROFILE","HOST_FIREWALL_PROFILE","HOST_DISK_ENCRYPTION_PROFILE","POLICY_RULES","PROTECTION_POLICY","DEVICE_CONTROL_TEMP_EXCEPTIONS","DEVICE_CONTROL_GLOBAL_EXCEPTIONS","DEVICE_CONTROL_CUSTOM_DEVICE","GLOBAL_EXCEPTIONS","MSSP","REPORTING","DASHBOARD","BROKER_API","BROKER_VM","MTH","MDR","ALERT_NOTIFICATIONS","INTEGRATIONS","QUERY","SCRIPT_EXECUTION","ALERT_RULES","COLLECTION","API_KEY","EDL","VA_RESCAN_ENDPOINT","HI_RESCAN_ENDPOINT","REMEDIATION","INGEST_DATA","LICENSING","AGENT_CONFIGURATION","PERMISSIONS","SCORING_RULES","LAYOUT_RULES","PLAYBOOK_TRIGGERS","FEATURED_ALERT_FIELDS","SYSTEM","TENANT_TAKEOVER","SCOUTER_POLICY","SCOUTER_PROFILE","SCOUTER_GROUPS","ALLOWED_DOMAINS","QUERY_LIBRARY","TENANT_CONFIGURATION","SCOUTER_CONFIGURATION","HOST_FIREWALL","XIF","XDM","ACTION_CENTER","XCLOUD_INTEGRATION","DATASETS","XSOAR","SECURITY_SETTINGS","ALERT_EXCLUSION","INDICATOR_RULES","EVENT_FORWARDING","ASSET_INVENTORY","SERVER_SETTINGS","ASSET_ROLES","CUSTOM_FIELDS","AUTOMATION_RULES","AGENT_EXCEPTION_RULES","REMEDIATION_PATH_RULES"]},"AUDIT_ENTITY_SUBTYPE":{"type":"string"},"AUDIT_SESSION_ID":{"type":"string","nullable":true},"AUDIT_CASE_ID":{"type":"string","nullable":true},"AUDIT_INSERT_TIME":{"type":"integer"},"AUDIT_SEVERITY":{"type":"string"},"AUDIT_LINK":{"type":"string","nullable":true},"AUDIT_SOURCE_IP":{"type":"string"},"AUDIT_USER_AGENT":{"type":"string"},"AUDIT_USER_ROLES":{"type":"array","items":{"type":"string"}}},"additionalProperties":true}}}}
```

## The GetManagementLogsResponseApi object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetManagementLogsResponseApi":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/ManagementLogsPageApi"}},"required":["reply"],"additionalProperties":true},"ManagementLogsPageApi":{"type":"object","properties":{"total_count":{"type":"integer","minimum":0},"result_count":{"type":"integer","minimum":0},"data":{"type":"array","items":{"$ref":"#/components/schemas/ManagementLogApi"}}},"required":["data","result_count","total_count"],"additionalProperties":true},"ManagementLogApi":{"type":"object","properties":{"AUDIT_ID":{"type":"integer"},"AUDIT_OWNER_NAME":{"type":"string"},"AUDIT_OWNER_EMAIL":{"type":"string"},"AUDIT_ASSET_JSON":{"type":"object","nullable":true},"AUDIT_ASSET_NAMES":{"type":"string","nullable":true},"AUDIT_HOSTNAME":{"type":"string","nullable":true},"AUDIT_RESULT":{"type":"string"},"AUDIT_REASON":{"type":"string","nullable":true},"AUDIT_DESCRIPTION":{"type":"string","nullable":true},"AUDIT_ENTITY":{"type":"string","enum":["LIVE_TERMINAL","RULES","RULES_EXCEPTIONS","AUTH","RESPONSE","INCIDENT_MANAGEMENT","ALERT_MANAGEMENT","INCIDENT_TIMELINE_EVENT","ENDPOINT_MANAGEMENT","ENDPOINT_GROUPS","ALERT_WHITELIST","PUBLIC_API","DISTRIBUTIONS","STARRED_INCIDENTS","POLICY_PROFILES","DEVICE_CONTROL_PROFILES","DEVICE_CONTROL_POLICY","PROTECTION_PROFILES","DEVICE_CONTROL_PROFILE","HOST_FIREWALL_PROFILE","HOST_DISK_ENCRYPTION_PROFILE","POLICY_RULES","PROTECTION_POLICY","DEVICE_CONTROL_TEMP_EXCEPTIONS","DEVICE_CONTROL_GLOBAL_EXCEPTIONS","DEVICE_CONTROL_CUSTOM_DEVICE","GLOBAL_EXCEPTIONS","MSSP","REPORTING","DASHBOARD","BROKER_API","BROKER_VM","MTH","MDR","ALERT_NOTIFICATIONS","INTEGRATIONS","QUERY","SCRIPT_EXECUTION","ALERT_RULES","COLLECTION","API_KEY","EDL","VA_RESCAN_ENDPOINT","HI_RESCAN_ENDPOINT","REMEDIATION","INGEST_DATA","LICENSING","AGENT_CONFIGURATION","PERMISSIONS","SCORING_RULES","LAYOUT_RULES","PLAYBOOK_TRIGGERS","FEATURED_ALERT_FIELDS","SYSTEM","TENANT_TAKEOVER","SCOUTER_POLICY","SCOUTER_PROFILE","SCOUTER_GROUPS","ALLOWED_DOMAINS","QUERY_LIBRARY","TENANT_CONFIGURATION","SCOUTER_CONFIGURATION","HOST_FIREWALL","XIF","XDM","ACTION_CENTER","XCLOUD_INTEGRATION","DATASETS","XSOAR","SECURITY_SETTINGS","ALERT_EXCLUSION","INDICATOR_RULES","EVENT_FORWARDING","ASSET_INVENTORY","SERVER_SETTINGS","ASSET_ROLES","CUSTOM_FIELDS","AUTOMATION_RULES","AGENT_EXCEPTION_RULES","REMEDIATION_PATH_RULES"]},"AUDIT_ENTITY_SUBTYPE":{"type":"string"},"AUDIT_SESSION_ID":{"type":"string","nullable":true},"AUDIT_CASE_ID":{"type":"string","nullable":true},"AUDIT_INSERT_TIME":{"type":"integer"},"AUDIT_SEVERITY":{"type":"string"},"AUDIT_LINK":{"type":"string","nullable":true},"AUDIT_SOURCE_IP":{"type":"string"},"AUDIT_USER_AGENT":{"type":"string"},"AUDIT_USER_ROLES":{"type":"array","items":{"type":"string"}}},"additionalProperties":true}}}}
```

## The AlertFilter object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"AlertFilter":{"type":"object","properties":{"field":{"type":"string","enum":["business_units_list","tags","asm_alert_categories","attack_surface_rule_id","alert_id_list","external_id_list","alert_source","creation_time","last_modified_ts","server_creation_time","severity","status","attack_surface_rule_name","host_name","xpanse_policy_id","case_id_list","cloud_management_status","integration_source","aws_cloud_tags","gcp_cloud_tags","azure_cloud_tags","first_observed","last_observed"],"description":"Identifies the alert fields the filter is matching. \n "},"operator":{"type":"string","enum":["gte","lte","in","range","relative_timestamp"],"description":"String that identifies the comparison operator you want to use for this filter. Possible values:\n  - **in**— use with `alert_id_list`, `alert_source`, `asm_alert_categories`, `case_id_list`, `business_units_list`, `cloud_management_status`, `tags`, `xpanse_policy_id`, `severity`, `integration_source`\n  - **gte**—  Filters data from a specific timestamp onwards. Use with `creation_time`, `first_observed`, `last_observed`.\n  - **lte**— Filters data up to a specific timestamp. Use with `creation_time`, `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`."},"value":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"array","items":{"type":"string"}}],"description":"Value that this filter must match. The contents of this field will differ depending on the alert field that you specified for this filter:\n  - **alert_id_list** — List of integers. Each item in the list must be an alert ID.\n  - **alert_source** — List of strings.\n  - **asm_alert_categories** — List of strings. Example values: \"Development Infrastructure\", \"Unpatched, Misconfigured, and end-of-life (EOL) systems\".\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  - **case_id_list** — List of integers. Each item in the list must be a case ID.\n  - **cloud_management_status** — String. Values are `Managed Cloud`, `Unmanaged Cloud`, and `Not Applicable`.\n  - **creation_time** — Integer representing the number of seconds or milliseconds after the Unix epoch, UTC timezone. The value is returned in the response under the detection_timestamp field and represented in the console under the TIMESTAMP field.\n  - **external_id_list**— List of strings representing external IDs.\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  - **integration_source** — Valid values: `AWS`, `AZURE`, `GOOGLE`, `PRISMA_CLOUD`\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  - **severity** — Valid values: `low`, `medium`, `high`, `critical`, `informational`\n  - **status** — Valid values: `new`, `reopened`, `resolved_no_risk`, `resolved_risk_accepted`, `resolved_no_longer_observed`, `resolved_contested_asset`, `resolved_remediated_automatically`, `resolved`, `under_investigation`.\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  - **xpanse_policy_id** — List of strings representing the xpanse policy IDs."}}}}}}
```

## The AlertSort object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"AlertSort":{"type":"object","properties":{"field":{"type":"string","default":"creation_time","enum":["creation_time","severity","server_creation_time"],"description":"Can either be `severity` or `creation_time`."},"keyword":{"type":"string","default":"desc","enum":["ASC","asc","DESC","desc"],"description":"Can either be ASC (ascending order) or DESC (descending order). Case sensitive."}},"additionalProperties":true,"description":"Identifies the sort order for the result set. "}}}}
```

## The GetAlertsMultiEventsRequestData object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetAlertsMultiEventsRequestData":{"type":"object","description":"A dictionary containing the API request fields. An empty dictionary returns all results.\n","properties":{"filters":{"type":"array","description":"An array of filter fields.","items":{"$ref":"#/components/schemas/AlertFilter"}},"search_from":{"type":"integer","default":0,"minimum":0,"description":"An integer representing the starting offset within the query result set from which you want alerts returned. Alerts are returned as a zero-based list. Any alert indexed less than this value is not returned in the final result set and defaults to zero.\n"},"search_to":{"type":"integer","default":100,"minimum":0,"description":"An integer representing the end offset within the result set after which you do not want alerts returned. Alerts in the alerts list that are indexed higher than this value are not returned in the final results set.  Defaults to 100, which returns all alerts to the end of the list. Use this field to specify the number of results on a page when using page token pagination.\n<br />Max value - 100\n"},"sort":{"$ref":"#/components/schemas/AlertSort"},"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."}}},"AlertFilter":{"type":"object","properties":{"field":{"type":"string","enum":["business_units_list","tags","asm_alert_categories","attack_surface_rule_id","alert_id_list","external_id_list","alert_source","creation_time","last_modified_ts","server_creation_time","severity","status","attack_surface_rule_name","host_name","xpanse_policy_id","case_id_list","cloud_management_status","integration_source","aws_cloud_tags","gcp_cloud_tags","azure_cloud_tags","first_observed","last_observed"],"description":"Identifies the alert fields the filter is matching. \n "},"operator":{"type":"string","enum":["gte","lte","in","range","relative_timestamp"],"description":"String that identifies the comparison operator you want to use for this filter. Possible values:\n  - **in**— use with `alert_id_list`, `alert_source`, `asm_alert_categories`, `case_id_list`, `business_units_list`, `cloud_management_status`, `tags`, `xpanse_policy_id`, `severity`, `integration_source`\n  - **gte**—  Filters data from a specific timestamp onwards. Use with `creation_time`, `first_observed`, `last_observed`.\n  - **lte**— Filters data up to a specific timestamp. Use with `creation_time`, `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`."},"value":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"array","items":{"type":"string"}}],"description":"Value that this filter must match. The contents of this field will differ depending on the alert field that you specified for this filter:\n  - **alert_id_list** — List of integers. Each item in the list must be an alert ID.\n  - **alert_source** — List of strings.\n  - **asm_alert_categories** — List of strings. Example values: \"Development Infrastructure\", \"Unpatched, Misconfigured, and end-of-life (EOL) systems\".\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  - **case_id_list** — List of integers. Each item in the list must be a case ID.\n  - **cloud_management_status** — String. Values are `Managed Cloud`, `Unmanaged Cloud`, and `Not Applicable`.\n  - **creation_time** — Integer representing the number of seconds or milliseconds after the Unix epoch, UTC timezone. The value is returned in the response under the detection_timestamp field and represented in the console under the TIMESTAMP field.\n  - **external_id_list**— List of strings representing external IDs.\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  - **integration_source** — Valid values: `AWS`, `AZURE`, `GOOGLE`, `PRISMA_CLOUD`\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  - **severity** — Valid values: `low`, `medium`, `high`, `critical`, `informational`\n  - **status** — Valid values: `new`, `reopened`, `resolved_no_risk`, `resolved_risk_accepted`, `resolved_no_longer_observed`, `resolved_contested_asset`, `resolved_remediated_automatically`, `resolved`, `under_investigation`.\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  - **xpanse_policy_id** — List of strings representing the xpanse policy IDs."}}},"AlertSort":{"type":"object","properties":{"field":{"type":"string","default":"creation_time","enum":["creation_time","severity","server_creation_time"],"description":"Can either be `severity` or `creation_time`."},"keyword":{"type":"string","default":"desc","enum":["ASC","asc","DESC","desc"],"description":"Can either be ASC (ascending order) or DESC (descending order). Case sensitive."}},"additionalProperties":true,"description":"Identifies the sort order for the result set. "}}}}
```

## The GetAlertsMultiEventsRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetAlertsMultiEventsRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/GetAlertsMultiEventsRequestData"}},"required":["request_data"],"additionalProperties":true},"GetAlertsMultiEventsRequestData":{"type":"object","description":"A dictionary containing the API request fields. An empty dictionary returns all results.\n","properties":{"filters":{"type":"array","description":"An array of filter fields.","items":{"$ref":"#/components/schemas/AlertFilter"}},"search_from":{"type":"integer","default":0,"minimum":0,"description":"An integer representing the starting offset within the query result set from which you want alerts returned. Alerts are returned as a zero-based list. Any alert indexed less than this value is not returned in the final result set and defaults to zero.\n"},"search_to":{"type":"integer","default":100,"minimum":0,"description":"An integer representing the end offset within the result set after which you do not want alerts returned. Alerts in the alerts list that are indexed higher than this value are not returned in the final results set.  Defaults to 100, which returns all alerts to the end of the list. Use this field to specify the number of results on a page when using page token pagination.\n<br />Max value - 100\n"},"sort":{"$ref":"#/components/schemas/AlertSort"},"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."}}},"AlertFilter":{"type":"object","properties":{"field":{"type":"string","enum":["business_units_list","tags","asm_alert_categories","attack_surface_rule_id","alert_id_list","external_id_list","alert_source","creation_time","last_modified_ts","server_creation_time","severity","status","attack_surface_rule_name","host_name","xpanse_policy_id","case_id_list","cloud_management_status","integration_source","aws_cloud_tags","gcp_cloud_tags","azure_cloud_tags","first_observed","last_observed"],"description":"Identifies the alert fields the filter is matching. \n "},"operator":{"type":"string","enum":["gte","lte","in","range","relative_timestamp"],"description":"String that identifies the comparison operator you want to use for this filter. Possible values:\n  - **in**— use with `alert_id_list`, `alert_source`, `asm_alert_categories`, `case_id_list`, `business_units_list`, `cloud_management_status`, `tags`, `xpanse_policy_id`, `severity`, `integration_source`\n  - **gte**—  Filters data from a specific timestamp onwards. Use with `creation_time`, `first_observed`, `last_observed`.\n  - **lte**— Filters data up to a specific timestamp. Use with `creation_time`, `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`."},"value":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"array","items":{"type":"string"}}],"description":"Value that this filter must match. The contents of this field will differ depending on the alert field that you specified for this filter:\n  - **alert_id_list** — List of integers. Each item in the list must be an alert ID.\n  - **alert_source** — List of strings.\n  - **asm_alert_categories** — List of strings. Example values: \"Development Infrastructure\", \"Unpatched, Misconfigured, and end-of-life (EOL) systems\".\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  - **case_id_list** — List of integers. Each item in the list must be a case ID.\n  - **cloud_management_status** — String. Values are `Managed Cloud`, `Unmanaged Cloud`, and `Not Applicable`.\n  - **creation_time** — Integer representing the number of seconds or milliseconds after the Unix epoch, UTC timezone. The value is returned in the response under the detection_timestamp field and represented in the console under the TIMESTAMP field.\n  - **external_id_list**— List of strings representing external IDs.\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  - **integration_source** — Valid values: `AWS`, `AZURE`, `GOOGLE`, `PRISMA_CLOUD`\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  - **severity** — Valid values: `low`, `medium`, `high`, `critical`, `informational`\n  - **status** — Valid values: `new`, `reopened`, `resolved_no_risk`, `resolved_risk_accepted`, `resolved_no_longer_observed`, `resolved_contested_asset`, `resolved_remediated_automatically`, `resolved`, `under_investigation`.\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  - **xpanse_policy_id** — List of strings representing the xpanse policy IDs."}}},"AlertSort":{"type":"object","properties":{"field":{"type":"string","default":"creation_time","enum":["creation_time","severity","server_creation_time"],"description":"Can either be `severity` or `creation_time`."},"keyword":{"type":"string","default":"desc","enum":["ASC","asc","DESC","desc"],"description":"Can either be ASC (ascending order) or DESC (descending order). Case sensitive."}},"additionalProperties":true,"description":"Identifies the sort order for the result set. "}}}}
```

## The IncidentCertificate object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"IncidentCertificate":{"type":"object","properties":{"issuerName":{"type":"string"},"subjectName":{"type":"string"},"validNotBefore":{"type":"integer"},"validNotAfter":{"type":"integer"},"serialNumber":{"type":"string"}},"additionalProperties":true}}}}
```

## The AssetIdentifiers object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"AssetIdentifiers":{"type":"object","properties":{"domain":{"type":"string"},"certificate":{"$ref":"#/components/schemas/IncidentCertificate"},"ipv4Address":{"type":"string"},"ipv6Address":{"type":"string"},"httpPath":{"type":"string"},"portNumber":{"type":"integer"},"portProtocol":{"type":"string"},"firstObserved":{"type":"integer"},"lastObserved":{"type":"integer"}},"additionalProperties":true},"IncidentCertificate":{"type":"object","properties":{"issuerName":{"type":"string"},"subjectName":{"type":"string"},"validNotBefore":{"type":"integer"},"validNotAfter":{"type":"integer"},"serialNumber":{"type":"string"}},"additionalProperties":true}}}}
```

## The Alert object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"Alert":{"type":"object","properties":{"category":{"type":"string"},"project":{"type":"string"},"cloud_provider":{"type":"string"},"resource_sub_type":{"type":"string"},"resource_type":{"type":"string"},"action_country":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"events":{"type":"string"},"event_type":{"type":"string"},"is_whitelisted":{"type":"boolean"},"image_name":{"type":"string"},"action_local_ip":{"type":"string"},"action_local_port":{"type":"string"},"mitre_tactic_id_and_name":{"type":"array","items":{"type":"string"}},"mitre_technique_id_and_name":{"type":"array","items":{"type":"string"}},"action_external_hostname":{"type":"string"},"action_remote_ip":{"type":"array","items":{"type":"string"}},"action_remote_port":{"type":"array","items":{"type":"integer"}},"matching_service_rule_id":{"type":"string"},"starred":{"type":"boolean"},"external_id":{"type":"string"},"severity":{"type":"string"},"matching_status":{"type":"string"},"end_match_attempt_ts":{"type":"string"},"local_insert_ts":{"type":"integer","description":"The UNIX timestamp that this record was written to the database"},"last_modified_ts":{"type":"integer","description":"The UNIX timestamp that this record was last modified"},"case_id":{"type":"integer"},"deduplicate_tokens":{"type":"string"},"filter_rule_id":{"type":"string"},"event_id":{"type":"string"},"event_timestamp":{"type":"array","items":{"type":"integer"}},"action_local_ip_v6":{"type":"string"},"action_remote_ip_v6":{"type":"array","items":{"type":"string"}},"alert_type":{"type":"string"},"resolution_status":{"type":"string"},"resolution_comment":{"type":"string"},"dynamic_fields":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"malicious_urls":{"type":"string"},"asm_alert_categories":{"type":"array","items":{"type":"string"}},"aws_cloud_tags":{"type":"array","items":{"type":"string"}},"azure_cloud_tags":{"type":"array","items":{"type":"string"}},"gcp_cloud_tags":{"type":"array","items":{"type":"string"}},"last_observed":{"type":"integer"},"country_codes":{"type":"array","items":{"type":"string"}},"cloud_providers":{"type":"array","items":{"type":"string"}},"ipv4_addresses":{"type":"array","items":{"type":"string"}},"ipv6_addresses":{"type":"array","items":{"type":"string"}},"domain_names":{"type":"array","items":{"type":"string"}},"service_ids":{"type":"array","items":{"type":"string"}},"website_ids":{"type":"array","items":{"type":"string"}},"asset_ids":{"type":"array","items":{"type":"string"}},"certificate":{"$ref":"#/components/schemas/IncidentCertificate"},"port_protocol":{"type":"string"},"port_number":{"type":"integer"},"cloud_management_status":{"type":"string"},"business_unit_hierarchies":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/BusinessUnitHierarchy"}}},"attack_surface_rule_name":{"type":"string"},"remediation_guidance":{"type":"string"},"attack_surface_rule_id":{"type":"string"},"asset_identifiers":{"type":"array","items":{"$ref":"#/components/schemas/AssetIdentifiers"}},"integration_source":{"type":"string"},"alert_id":{"type":"string"},"detection_timestamp":{"type":"integer"},"name":{"type":"string"},"endpoint_id":{"type":"string"},"host_ip":{"type":"string"},"host_name":{"type":"string"},"action":{"type":"string"},"source":{"type":"string"},"user_name":{"type":"string"},"mac_addresses":{"type":"string"},"action_pretty":{"type":"string"}},"additionalProperties":true},"IncidentCertificate":{"type":"object","properties":{"issuerName":{"type":"string"},"subjectName":{"type":"string"},"validNotBefore":{"type":"integer"},"validNotAfter":{"type":"integer"},"serialNumber":{"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},"AssetIdentifiers":{"type":"object","properties":{"domain":{"type":"string"},"certificate":{"$ref":"#/components/schemas/IncidentCertificate"},"ipv4Address":{"type":"string"},"ipv6Address":{"type":"string"},"httpPath":{"type":"string"},"portNumber":{"type":"integer"},"portProtocol":{"type":"string"},"firstObserved":{"type":"integer"},"lastObserved":{"type":"integer"}},"additionalProperties":true}}}}
```

## The GetAlertsMultiEventsPage object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetAlertsMultiEventsPage":{"type":"object","properties":{"total_count":{"type":"integer","description":"The number of total results of this filter without paging. If the filter returned 10,000 results or more than 9,999 will be the value and you can use paging to view the entire set of data."},"result_count":{"type":"integer","description":"The number of alerts actually returned as result (integer)."},"alerts":{"type":"array","items":{"$ref":"#/components/schemas/Alert"},"description":"A list of alerts."},"next_page_token":{"type":"string","description":"This attribute is only returned if use_page_token is provided in the request with value true"}},"required":["result_count","total_count"],"additionalProperties":true},"Alert":{"type":"object","properties":{"category":{"type":"string"},"project":{"type":"string"},"cloud_provider":{"type":"string"},"resource_sub_type":{"type":"string"},"resource_type":{"type":"string"},"action_country":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"events":{"type":"string"},"event_type":{"type":"string"},"is_whitelisted":{"type":"boolean"},"image_name":{"type":"string"},"action_local_ip":{"type":"string"},"action_local_port":{"type":"string"},"mitre_tactic_id_and_name":{"type":"array","items":{"type":"string"}},"mitre_technique_id_and_name":{"type":"array","items":{"type":"string"}},"action_external_hostname":{"type":"string"},"action_remote_ip":{"type":"array","items":{"type":"string"}},"action_remote_port":{"type":"array","items":{"type":"integer"}},"matching_service_rule_id":{"type":"string"},"starred":{"type":"boolean"},"external_id":{"type":"string"},"severity":{"type":"string"},"matching_status":{"type":"string"},"end_match_attempt_ts":{"type":"string"},"local_insert_ts":{"type":"integer","description":"The UNIX timestamp that this record was written to the database"},"last_modified_ts":{"type":"integer","description":"The UNIX timestamp that this record was last modified"},"case_id":{"type":"integer"},"deduplicate_tokens":{"type":"string"},"filter_rule_id":{"type":"string"},"event_id":{"type":"string"},"event_timestamp":{"type":"array","items":{"type":"integer"}},"action_local_ip_v6":{"type":"string"},"action_remote_ip_v6":{"type":"array","items":{"type":"string"}},"alert_type":{"type":"string"},"resolution_status":{"type":"string"},"resolution_comment":{"type":"string"},"dynamic_fields":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"malicious_urls":{"type":"string"},"asm_alert_categories":{"type":"array","items":{"type":"string"}},"aws_cloud_tags":{"type":"array","items":{"type":"string"}},"azure_cloud_tags":{"type":"array","items":{"type":"string"}},"gcp_cloud_tags":{"type":"array","items":{"type":"string"}},"last_observed":{"type":"integer"},"country_codes":{"type":"array","items":{"type":"string"}},"cloud_providers":{"type":"array","items":{"type":"string"}},"ipv4_addresses":{"type":"array","items":{"type":"string"}},"ipv6_addresses":{"type":"array","items":{"type":"string"}},"domain_names":{"type":"array","items":{"type":"string"}},"service_ids":{"type":"array","items":{"type":"string"}},"website_ids":{"type":"array","items":{"type":"string"}},"asset_ids":{"type":"array","items":{"type":"string"}},"certificate":{"$ref":"#/components/schemas/IncidentCertificate"},"port_protocol":{"type":"string"},"port_number":{"type":"integer"},"cloud_management_status":{"type":"string"},"business_unit_hierarchies":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/BusinessUnitHierarchy"}}},"attack_surface_rule_name":{"type":"string"},"remediation_guidance":{"type":"string"},"attack_surface_rule_id":{"type":"string"},"asset_identifiers":{"type":"array","items":{"$ref":"#/components/schemas/AssetIdentifiers"}},"integration_source":{"type":"string"},"alert_id":{"type":"string"},"detection_timestamp":{"type":"integer"},"name":{"type":"string"},"endpoint_id":{"type":"string"},"host_ip":{"type":"string"},"host_name":{"type":"string"},"action":{"type":"string"},"source":{"type":"string"},"user_name":{"type":"string"},"mac_addresses":{"type":"string"},"action_pretty":{"type":"string"}},"additionalProperties":true},"IncidentCertificate":{"type":"object","properties":{"issuerName":{"type":"string"},"subjectName":{"type":"string"},"validNotBefore":{"type":"integer"},"validNotAfter":{"type":"integer"},"serialNumber":{"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},"AssetIdentifiers":{"type":"object","properties":{"domain":{"type":"string"},"certificate":{"$ref":"#/components/schemas/IncidentCertificate"},"ipv4Address":{"type":"string"},"ipv6Address":{"type":"string"},"httpPath":{"type":"string"},"portNumber":{"type":"integer"},"portProtocol":{"type":"string"},"firstObserved":{"type":"integer"},"lastObserved":{"type":"integer"}},"additionalProperties":true}}}}
```

## The GetAlertsMultiEventsResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetAlertsMultiEventsResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/GetAlertsMultiEventsPage"}},"required":["reply"],"additionalProperties":true},"GetAlertsMultiEventsPage":{"type":"object","properties":{"total_count":{"type":"integer","description":"The number of total results of this filter without paging. If the filter returned 10,000 results or more than 9,999 will be the value and you can use paging to view the entire set of data."},"result_count":{"type":"integer","description":"The number of alerts actually returned as result (integer)."},"alerts":{"type":"array","items":{"$ref":"#/components/schemas/Alert"},"description":"A list of alerts."},"next_page_token":{"type":"string","description":"This attribute is only returned if use_page_token is provided in the request with value true"}},"required":["result_count","total_count"],"additionalProperties":true},"Alert":{"type":"object","properties":{"category":{"type":"string"},"project":{"type":"string"},"cloud_provider":{"type":"string"},"resource_sub_type":{"type":"string"},"resource_type":{"type":"string"},"action_country":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"events":{"type":"string"},"event_type":{"type":"string"},"is_whitelisted":{"type":"boolean"},"image_name":{"type":"string"},"action_local_ip":{"type":"string"},"action_local_port":{"type":"string"},"mitre_tactic_id_and_name":{"type":"array","items":{"type":"string"}},"mitre_technique_id_and_name":{"type":"array","items":{"type":"string"}},"action_external_hostname":{"type":"string"},"action_remote_ip":{"type":"array","items":{"type":"string"}},"action_remote_port":{"type":"array","items":{"type":"integer"}},"matching_service_rule_id":{"type":"string"},"starred":{"type":"boolean"},"external_id":{"type":"string"},"severity":{"type":"string"},"matching_status":{"type":"string"},"end_match_attempt_ts":{"type":"string"},"local_insert_ts":{"type":"integer","description":"The UNIX timestamp that this record was written to the database"},"last_modified_ts":{"type":"integer","description":"The UNIX timestamp that this record was last modified"},"case_id":{"type":"integer"},"deduplicate_tokens":{"type":"string"},"filter_rule_id":{"type":"string"},"event_id":{"type":"string"},"event_timestamp":{"type":"array","items":{"type":"integer"}},"action_local_ip_v6":{"type":"string"},"action_remote_ip_v6":{"type":"array","items":{"type":"string"}},"alert_type":{"type":"string"},"resolution_status":{"type":"string"},"resolution_comment":{"type":"string"},"dynamic_fields":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"malicious_urls":{"type":"string"},"asm_alert_categories":{"type":"array","items":{"type":"string"}},"aws_cloud_tags":{"type":"array","items":{"type":"string"}},"azure_cloud_tags":{"type":"array","items":{"type":"string"}},"gcp_cloud_tags":{"type":"array","items":{"type":"string"}},"last_observed":{"type":"integer"},"country_codes":{"type":"array","items":{"type":"string"}},"cloud_providers":{"type":"array","items":{"type":"string"}},"ipv4_addresses":{"type":"array","items":{"type":"string"}},"ipv6_addresses":{"type":"array","items":{"type":"string"}},"domain_names":{"type":"array","items":{"type":"string"}},"service_ids":{"type":"array","items":{"type":"string"}},"website_ids":{"type":"array","items":{"type":"string"}},"asset_ids":{"type":"array","items":{"type":"string"}},"certificate":{"$ref":"#/components/schemas/IncidentCertificate"},"port_protocol":{"type":"string"},"port_number":{"type":"integer"},"cloud_management_status":{"type":"string"},"business_unit_hierarchies":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/BusinessUnitHierarchy"}}},"attack_surface_rule_name":{"type":"string"},"remediation_guidance":{"type":"string"},"attack_surface_rule_id":{"type":"string"},"asset_identifiers":{"type":"array","items":{"$ref":"#/components/schemas/AssetIdentifiers"}},"integration_source":{"type":"string"},"alert_id":{"type":"string"},"detection_timestamp":{"type":"integer"},"name":{"type":"string"},"endpoint_id":{"type":"string"},"host_ip":{"type":"string"},"host_name":{"type":"string"},"action":{"type":"string"},"source":{"type":"string"},"user_name":{"type":"string"},"mac_addresses":{"type":"string"},"action_pretty":{"type":"string"}},"additionalProperties":true},"IncidentCertificate":{"type":"object","properties":{"issuerName":{"type":"string"},"subjectName":{"type":"string"},"validNotBefore":{"type":"integer"},"validNotAfter":{"type":"integer"},"serialNumber":{"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},"AssetIdentifiers":{"type":"object","properties":{"domain":{"type":"string"},"certificate":{"$ref":"#/components/schemas/IncidentCertificate"},"ipv4Address":{"type":"string"},"ipv6Address":{"type":"string"},"httpPath":{"type":"string"},"portNumber":{"type":"integer"},"portProtocol":{"type":"string"},"firstObserved":{"type":"integer"},"lastObserved":{"type":"integer"}},"additionalProperties":true}}}}
```

## The GetIncidentExtraDataRequestData object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetIncidentExtraDataRequestData":{"type":"object","properties":{"incident_id":{"type":"string","description":"The ID of the incident for which you want to retrieve extra data."},"alerts_limit":{"type":"integer","description":"The maximum number of related alerts in the incident that you want to retrieve.<br /> Default: `1000`\n"}},"required":["incident_id"],"additionalProperties":true,"description":"A dictionary containing the API request fields."}}}}
```

## The GetIncidentExtraDataRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetIncidentExtraDataRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/GetIncidentExtraDataRequestData"}},"required":["request_data"],"additionalProperties":true},"GetIncidentExtraDataRequestData":{"type":"object","properties":{"incident_id":{"type":"string","description":"The ID of the incident for which you want to retrieve extra data."},"alerts_limit":{"type":"integer","description":"The maximum number of related alerts in the incident that you want to retrieve.<br /> Default: `1000`\n"}},"required":["incident_id"],"additionalProperties":true,"description":"A dictionary containing the API request fields."}}}}
```

## The Cve object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"Cve":{"type":"object","properties":{"cveId":{"type":"string"},"cvssScore":{"type":"integer"},"epssScore":{"type":"number"},"matchType":{"type":"string"},"exploitMaturity":{"type":"string"},"reportedExploitInTheWild":{"type":"boolean"},"mostRecentReportedExploitDate":{"type":"string"},"confidence":{"type":"string"}},"additionalProperties":true}}}}
```

## The RiskFactorIssueType object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"RiskFactorIssueType":{"type":"object","properties":{"displayName":{"type":"string"},"issueTypeId":{"type":"string"}},"required":["displayName","issueTypeId"],"additionalProperties":true}}}}
```

## The RiskFactor object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"RiskFactor":{"type":"object","properties":{"attributeId":{"type":"string"},"attributeName":{"type":"string"},"issueTypes":{"type":"array","items":{"$ref":"#/components/schemas/RiskFactorIssueType"}}},"required":["attributeId","attributeName","issueTypes"],"additionalProperties":true},"RiskFactorIssueType":{"type":"object","properties":{"displayName":{"type":"string"},"issueTypeId":{"type":"string"}},"required":["displayName","issueTypeId"],"additionalProperties":true}}}}
```

## The XpanseRiskExplainer object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"XpanseRiskExplainer":{"type":"object","properties":{"cves":{"type":"array","items":{"$ref":"#/components/schemas/Cve"}},"riskFactors":{"type":"array","items":{"$ref":"#/components/schemas/RiskFactor"}},"versionMatched":{"type":"boolean"}},"additionalProperties":true},"Cve":{"type":"object","properties":{"cveId":{"type":"string"},"cvssScore":{"type":"integer"},"epssScore":{"type":"number"},"matchType":{"type":"string"},"exploitMaturity":{"type":"string"},"reportedExploitInTheWild":{"type":"boolean"},"mostRecentReportedExploitDate":{"type":"string"},"confidence":{"type":"string"}},"additionalProperties":true},"RiskFactor":{"type":"object","properties":{"attributeId":{"type":"string"},"attributeName":{"type":"string"},"issueTypes":{"type":"array","items":{"$ref":"#/components/schemas/RiskFactorIssueType"}}},"required":["attributeId","attributeName","issueTypes"],"additionalProperties":true},"RiskFactorIssueType":{"type":"object","properties":{"displayName":{"type":"string"},"issueTypeId":{"type":"string"}},"required":["displayName","issueTypeId"],"additionalProperties":true}}}}
```

## The Incident object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"Incident":{"type":"object","properties":{"incident_id":{"type":"string"},"is_blocked":{"type":"boolean"},"incident_name":{"type":"string"},"creation_time":{"type":"integer"},"modification_time":{"type":"integer"},"detection_time":{"type":"integer"},"status":{"type":"string"},"severity":{"type":"string"},"description":{"type":"string"},"assigned_user_mail":{"type":"string"},"assigned_user_pretty_name":{"type":"string"},"alert_count":{"type":"integer"},"low_severity_alert_count":{"type":"integer"},"med_severity_alert_count":{"type":"integer"},"high_severity_alert_count":{"type":"integer"},"critical_severity_alert_count":{"type":"integer"},"user_count":{"type":"integer"},"host_count":{"type":"integer"},"notes":{"type":"string"},"resolve_comment":{"type":"string"},"resolved_timestamp":{"type":"integer"},"manual_severity":{"type":"string"},"manual_description":{"type":"string"},"xdr_url":{"type":"string"},"starred":{"type":"boolean"},"starred_manually":{"type":"boolean"},"hosts":{"type":"array","items":{"type":"string"}},"incident_sources":{"type":"array","items":{"type":"string"}},"rule_based_score":{"type":"integer"},"manual_score":{"type":"number"},"aggregated_score":{"type":"integer"},"alerts_grouping_status":{"type":"string"},"alert_categories":{"type":"array","items":{"type":"string"}},"original_tags":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"xpanse_risk_score":{"type":"integer"},"xpanse_risk_explainer":{"$ref":"#/components/schemas/XpanseRiskExplainer"},"cloud_management_status":{"type":"string"},"integration_source":{"type":"string"},"ipv4_addresses":{"type":"array","items":{"type":"string"}},"ipv6_addresses":{"type":"array","items":{"type":"string"}},"domain_names":{"type":"array","items":{"type":"string"}},"port_number":{"type":"integer"},"asset_ids":{"type":"array","items":{"type":"string","format":"uuid"}},"ip_range_ids":{"type":"array","items":{"type":"string"}},"website_ids":{"type":"array","items":{"type":"string"}},"service_ids":{"type":"array","items":{"type":"string"}},"last_observed":{"type":"integer"},"cloud_providers":{"type":"array","items":{"type":"string"}},"country_codes":{"type":"array","items":{"type":"string"}},"certificate_common_names":{"type":"array","items":{"type":"string"}},"certificate_issuers":{"type":"array","items":{"type":"string"}}},"additionalProperties":true},"XpanseRiskExplainer":{"type":"object","properties":{"cves":{"type":"array","items":{"$ref":"#/components/schemas/Cve"}},"riskFactors":{"type":"array","items":{"$ref":"#/components/schemas/RiskFactor"}},"versionMatched":{"type":"boolean"}},"additionalProperties":true},"Cve":{"type":"object","properties":{"cveId":{"type":"string"},"cvssScore":{"type":"integer"},"epssScore":{"type":"number"},"matchType":{"type":"string"},"exploitMaturity":{"type":"string"},"reportedExploitInTheWild":{"type":"boolean"},"mostRecentReportedExploitDate":{"type":"string"},"confidence":{"type":"string"}},"additionalProperties":true},"RiskFactor":{"type":"object","properties":{"attributeId":{"type":"string"},"attributeName":{"type":"string"},"issueTypes":{"type":"array","items":{"$ref":"#/components/schemas/RiskFactorIssueType"}}},"required":["attributeId","attributeName","issueTypes"],"additionalProperties":true},"RiskFactorIssueType":{"type":"object","properties":{"displayName":{"type":"string"},"issueTypeId":{"type":"string"}},"required":["displayName","issueTypeId"],"additionalProperties":true}}}}
```

## The IncidentExtraData object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"IncidentExtraData":{"type":"object","properties":{"category":{"type":"string"},"project":{"type":"string"},"cloud_provider":{"type":"string"},"resource_sub_type":{"type":"string"},"resource_type":{"type":"string"},"action_country":{"type":"string"},"event_type":{"type":"string"},"is_whitelisted":{"type":"boolean"},"mac":{"type":"string"},"image_name":{"type":"string"},"action_local_ip":{"type":"string"},"action_local_port":{"type":"string"},"action_external_hostname":{"type":"string"},"action_remote_ip":{"type":"array","items":{"type":"string"}},"action_remote_port":{"type":"integer"},"matching_service_rule_id":{"type":"string"},"starred":{"type":"boolean"},"external_id":{"type":"string"},"severity":{"type":"string"},"matching_status":{"type":"string"},"end_match_attempt_ts":{"type":"string"},"local_insert_ts":{"type":"integer","description":"The UNIX timestamp that this record was written to the database"},"last_modified_ts":{"type":"integer","description":"The UNIX timestamp that this record was last modified"},"case_id":{"type":"integer"},"deduplicate_tokens":{"type":"string"},"filter_rule_id":{"type":"string"},"event_id":{"type":"string"},"event_timestamp":{"type":"integer"},"action_local_ip_v6":{"type":"string"},"action_remote_ip_v6":{"type":"string"},"alert_type":{"type":"string"},"resolution_status":{"type":"string"},"resolution_comment":{"type":"string"},"dynamic_fields":{"type":"string"},"tags":{"type":"string"},"malicious_urls":{"type":"string"},"asm_alert_categories":{"type":"string"},"last_observed":{"type":"integer"},"country_codes":{"type":"string"},"cloud_providers":{"type":"string"},"ipv4_addresses":{"type":"string"},"ipv6_addresses":{"type":"string"},"domain_names":{"type":"string"},"service_ids":{"type":"string"},"website_ids":{"type":"string"},"asset_ids":{"type":"string"},"certificate":{"$ref":"#/components/schemas/IncidentCertificate"},"port_protocol":{"type":"string"},"port_number":{"type":"integer"},"business_unit_hierarchies":{"type":"array","items":{"$ref":"#/components/schemas/BusinessUnitHierarchy"}},"attack_surface_rule_name":{"type":"string"},"remediation_guidance":{"type":"string"},"attack_surface_rule_id":{"type":"string"},"asset_identifiers":{"$ref":"#/components/schemas/AssetIdentifiers"},"alert_id":{"type":"string"},"detection_timestamp":{"type":"integer"},"name":{"type":"string"},"endpoint_id":{"type":"string"},"description":{"type":"string"},"host_ip":{"type":"string"},"host_name":{"type":"string"},"source":{"type":"string"},"action":{"type":"string"},"action_pretty":{"type":"string"},"user_name":{"type":"string"},"events_length":{"type":"integer"},"mitre_tactic_id_and_name":{"type":"string"},"mitre_technique_id_and_name":{"type":"string"},"cloud_management_status":{"type":"string"}},"additionalProperties":true},"IncidentCertificate":{"type":"object","properties":{"issuerName":{"type":"string"},"subjectName":{"type":"string"},"validNotBefore":{"type":"integer"},"validNotAfter":{"type":"integer"},"serialNumber":{"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},"AssetIdentifiers":{"type":"object","properties":{"domain":{"type":"string"},"certificate":{"$ref":"#/components/schemas/IncidentCertificate"},"ipv4Address":{"type":"string"},"ipv6Address":{"type":"string"},"httpPath":{"type":"string"},"portNumber":{"type":"integer"},"portProtocol":{"type":"string"},"firstObserved":{"type":"integer"},"lastObserved":{"type":"integer"}},"additionalProperties":true}}}}
```

## The IncidentExtraDataAlerts object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"IncidentExtraDataAlerts":{"type":"object","properties":{"total_count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/IncidentExtraData"}}},"required":["total_count"],"additionalProperties":true},"IncidentExtraData":{"type":"object","properties":{"category":{"type":"string"},"project":{"type":"string"},"cloud_provider":{"type":"string"},"resource_sub_type":{"type":"string"},"resource_type":{"type":"string"},"action_country":{"type":"string"},"event_type":{"type":"string"},"is_whitelisted":{"type":"boolean"},"mac":{"type":"string"},"image_name":{"type":"string"},"action_local_ip":{"type":"string"},"action_local_port":{"type":"string"},"action_external_hostname":{"type":"string"},"action_remote_ip":{"type":"array","items":{"type":"string"}},"action_remote_port":{"type":"integer"},"matching_service_rule_id":{"type":"string"},"starred":{"type":"boolean"},"external_id":{"type":"string"},"severity":{"type":"string"},"matching_status":{"type":"string"},"end_match_attempt_ts":{"type":"string"},"local_insert_ts":{"type":"integer","description":"The UNIX timestamp that this record was written to the database"},"last_modified_ts":{"type":"integer","description":"The UNIX timestamp that this record was last modified"},"case_id":{"type":"integer"},"deduplicate_tokens":{"type":"string"},"filter_rule_id":{"type":"string"},"event_id":{"type":"string"},"event_timestamp":{"type":"integer"},"action_local_ip_v6":{"type":"string"},"action_remote_ip_v6":{"type":"string"},"alert_type":{"type":"string"},"resolution_status":{"type":"string"},"resolution_comment":{"type":"string"},"dynamic_fields":{"type":"string"},"tags":{"type":"string"},"malicious_urls":{"type":"string"},"asm_alert_categories":{"type":"string"},"last_observed":{"type":"integer"},"country_codes":{"type":"string"},"cloud_providers":{"type":"string"},"ipv4_addresses":{"type":"string"},"ipv6_addresses":{"type":"string"},"domain_names":{"type":"string"},"service_ids":{"type":"string"},"website_ids":{"type":"string"},"asset_ids":{"type":"string"},"certificate":{"$ref":"#/components/schemas/IncidentCertificate"},"port_protocol":{"type":"string"},"port_number":{"type":"integer"},"business_unit_hierarchies":{"type":"array","items":{"$ref":"#/components/schemas/BusinessUnitHierarchy"}},"attack_surface_rule_name":{"type":"string"},"remediation_guidance":{"type":"string"},"attack_surface_rule_id":{"type":"string"},"asset_identifiers":{"$ref":"#/components/schemas/AssetIdentifiers"},"alert_id":{"type":"string"},"detection_timestamp":{"type":"integer"},"name":{"type":"string"},"endpoint_id":{"type":"string"},"description":{"type":"string"},"host_ip":{"type":"string"},"host_name":{"type":"string"},"source":{"type":"string"},"action":{"type":"string"},"action_pretty":{"type":"string"},"user_name":{"type":"string"},"events_length":{"type":"integer"},"mitre_tactic_id_and_name":{"type":"string"},"mitre_technique_id_and_name":{"type":"string"},"cloud_management_status":{"type":"string"}},"additionalProperties":true},"IncidentCertificate":{"type":"object","properties":{"issuerName":{"type":"string"},"subjectName":{"type":"string"},"validNotBefore":{"type":"integer"},"validNotAfter":{"type":"integer"},"serialNumber":{"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},"AssetIdentifiers":{"type":"object","properties":{"domain":{"type":"string"},"certificate":{"$ref":"#/components/schemas/IncidentCertificate"},"ipv4Address":{"type":"string"},"ipv6Address":{"type":"string"},"httpPath":{"type":"string"},"portNumber":{"type":"integer"},"portProtocol":{"type":"string"},"firstObserved":{"type":"integer"},"lastObserved":{"type":"integer"}},"additionalProperties":true}}}}
```

## The NetworkArtifacts object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"NetworkArtifacts":{"type":"object","properties":{"total_count":{"type":"integer"},"data":{"type":"array","items":{"type":"string"}}},"required":["total_count"],"additionalProperties":true}}}}
```

## The FileArtifacts object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"FileArtifacts":{"type":"object","properties":{"total_count":{"type":"integer"},"data":{"type":"array","items":{"type":"string"}}},"required":["total_count"],"additionalProperties":true}}}}
```

## The GetIncidentExtraDataReply object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetIncidentExtraDataReply":{"type":"object","properties":{"incident":{"$ref":"#/components/schemas/Incident"},"alerts":{"$ref":"#/components/schemas/IncidentExtraDataAlerts"},"network_artifacts":{"$ref":"#/components/schemas/NetworkArtifacts"},"file_artifacts":{"$ref":"#/components/schemas/FileArtifacts"}},"additionalProperties":true},"Incident":{"type":"object","properties":{"incident_id":{"type":"string"},"is_blocked":{"type":"boolean"},"incident_name":{"type":"string"},"creation_time":{"type":"integer"},"modification_time":{"type":"integer"},"detection_time":{"type":"integer"},"status":{"type":"string"},"severity":{"type":"string"},"description":{"type":"string"},"assigned_user_mail":{"type":"string"},"assigned_user_pretty_name":{"type":"string"},"alert_count":{"type":"integer"},"low_severity_alert_count":{"type":"integer"},"med_severity_alert_count":{"type":"integer"},"high_severity_alert_count":{"type":"integer"},"critical_severity_alert_count":{"type":"integer"},"user_count":{"type":"integer"},"host_count":{"type":"integer"},"notes":{"type":"string"},"resolve_comment":{"type":"string"},"resolved_timestamp":{"type":"integer"},"manual_severity":{"type":"string"},"manual_description":{"type":"string"},"xdr_url":{"type":"string"},"starred":{"type":"boolean"},"starred_manually":{"type":"boolean"},"hosts":{"type":"array","items":{"type":"string"}},"incident_sources":{"type":"array","items":{"type":"string"}},"rule_based_score":{"type":"integer"},"manual_score":{"type":"number"},"aggregated_score":{"type":"integer"},"alerts_grouping_status":{"type":"string"},"alert_categories":{"type":"array","items":{"type":"string"}},"original_tags":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"xpanse_risk_score":{"type":"integer"},"xpanse_risk_explainer":{"$ref":"#/components/schemas/XpanseRiskExplainer"},"cloud_management_status":{"type":"string"},"integration_source":{"type":"string"},"ipv4_addresses":{"type":"array","items":{"type":"string"}},"ipv6_addresses":{"type":"array","items":{"type":"string"}},"domain_names":{"type":"array","items":{"type":"string"}},"port_number":{"type":"integer"},"asset_ids":{"type":"array","items":{"type":"string","format":"uuid"}},"ip_range_ids":{"type":"array","items":{"type":"string"}},"website_ids":{"type":"array","items":{"type":"string"}},"service_ids":{"type":"array","items":{"type":"string"}},"last_observed":{"type":"integer"},"cloud_providers":{"type":"array","items":{"type":"string"}},"country_codes":{"type":"array","items":{"type":"string"}},"certificate_common_names":{"type":"array","items":{"type":"string"}},"certificate_issuers":{"type":"array","items":{"type":"string"}}},"additionalProperties":true},"XpanseRiskExplainer":{"type":"object","properties":{"cves":{"type":"array","items":{"$ref":"#/components/schemas/Cve"}},"riskFactors":{"type":"array","items":{"$ref":"#/components/schemas/RiskFactor"}},"versionMatched":{"type":"boolean"}},"additionalProperties":true},"Cve":{"type":"object","properties":{"cveId":{"type":"string"},"cvssScore":{"type":"integer"},"epssScore":{"type":"number"},"matchType":{"type":"string"},"exploitMaturity":{"type":"string"},"reportedExploitInTheWild":{"type":"boolean"},"mostRecentReportedExploitDate":{"type":"string"},"confidence":{"type":"string"}},"additionalProperties":true},"RiskFactor":{"type":"object","properties":{"attributeId":{"type":"string"},"attributeName":{"type":"string"},"issueTypes":{"type":"array","items":{"$ref":"#/components/schemas/RiskFactorIssueType"}}},"required":["attributeId","attributeName","issueTypes"],"additionalProperties":true},"RiskFactorIssueType":{"type":"object","properties":{"displayName":{"type":"string"},"issueTypeId":{"type":"string"}},"required":["displayName","issueTypeId"],"additionalProperties":true},"IncidentExtraDataAlerts":{"type":"object","properties":{"total_count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/IncidentExtraData"}}},"required":["total_count"],"additionalProperties":true},"IncidentExtraData":{"type":"object","properties":{"category":{"type":"string"},"project":{"type":"string"},"cloud_provider":{"type":"string"},"resource_sub_type":{"type":"string"},"resource_type":{"type":"string"},"action_country":{"type":"string"},"event_type":{"type":"string"},"is_whitelisted":{"type":"boolean"},"mac":{"type":"string"},"image_name":{"type":"string"},"action_local_ip":{"type":"string"},"action_local_port":{"type":"string"},"action_external_hostname":{"type":"string"},"action_remote_ip":{"type":"array","items":{"type":"string"}},"action_remote_port":{"type":"integer"},"matching_service_rule_id":{"type":"string"},"starred":{"type":"boolean"},"external_id":{"type":"string"},"severity":{"type":"string"},"matching_status":{"type":"string"},"end_match_attempt_ts":{"type":"string"},"local_insert_ts":{"type":"integer","description":"The UNIX timestamp that this record was written to the database"},"last_modified_ts":{"type":"integer","description":"The UNIX timestamp that this record was last modified"},"case_id":{"type":"integer"},"deduplicate_tokens":{"type":"string"},"filter_rule_id":{"type":"string"},"event_id":{"type":"string"},"event_timestamp":{"type":"integer"},"action_local_ip_v6":{"type":"string"},"action_remote_ip_v6":{"type":"string"},"alert_type":{"type":"string"},"resolution_status":{"type":"string"},"resolution_comment":{"type":"string"},"dynamic_fields":{"type":"string"},"tags":{"type":"string"},"malicious_urls":{"type":"string"},"asm_alert_categories":{"type":"string"},"last_observed":{"type":"integer"},"country_codes":{"type":"string"},"cloud_providers":{"type":"string"},"ipv4_addresses":{"type":"string"},"ipv6_addresses":{"type":"string"},"domain_names":{"type":"string"},"service_ids":{"type":"string"},"website_ids":{"type":"string"},"asset_ids":{"type":"string"},"certificate":{"$ref":"#/components/schemas/IncidentCertificate"},"port_protocol":{"type":"string"},"port_number":{"type":"integer"},"business_unit_hierarchies":{"type":"array","items":{"$ref":"#/components/schemas/BusinessUnitHierarchy"}},"attack_surface_rule_name":{"type":"string"},"remediation_guidance":{"type":"string"},"attack_surface_rule_id":{"type":"string"},"asset_identifiers":{"$ref":"#/components/schemas/AssetIdentifiers"},"alert_id":{"type":"string"},"detection_timestamp":{"type":"integer"},"name":{"type":"string"},"endpoint_id":{"type":"string"},"description":{"type":"string"},"host_ip":{"type":"string"},"host_name":{"type":"string"},"source":{"type":"string"},"action":{"type":"string"},"action_pretty":{"type":"string"},"user_name":{"type":"string"},"events_length":{"type":"integer"},"mitre_tactic_id_and_name":{"type":"string"},"mitre_technique_id_and_name":{"type":"string"},"cloud_management_status":{"type":"string"}},"additionalProperties":true},"IncidentCertificate":{"type":"object","properties":{"issuerName":{"type":"string"},"subjectName":{"type":"string"},"validNotBefore":{"type":"integer"},"validNotAfter":{"type":"integer"},"serialNumber":{"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},"AssetIdentifiers":{"type":"object","properties":{"domain":{"type":"string"},"certificate":{"$ref":"#/components/schemas/IncidentCertificate"},"ipv4Address":{"type":"string"},"ipv6Address":{"type":"string"},"httpPath":{"type":"string"},"portNumber":{"type":"integer"},"portProtocol":{"type":"string"},"firstObserved":{"type":"integer"},"lastObserved":{"type":"integer"}},"additionalProperties":true},"NetworkArtifacts":{"type":"object","properties":{"total_count":{"type":"integer"},"data":{"type":"array","items":{"type":"string"}}},"required":["total_count"],"additionalProperties":true},"FileArtifacts":{"type":"object","properties":{"total_count":{"type":"integer"},"data":{"type":"array","items":{"type":"string"}}},"required":["total_count"],"additionalProperties":true}}}}
```

## The GetIncidentExtraDataResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetIncidentExtraDataResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/GetIncidentExtraDataReply"}},"required":["reply"],"additionalProperties":true},"GetIncidentExtraDataReply":{"type":"object","properties":{"incident":{"$ref":"#/components/schemas/Incident"},"alerts":{"$ref":"#/components/schemas/IncidentExtraDataAlerts"},"network_artifacts":{"$ref":"#/components/schemas/NetworkArtifacts"},"file_artifacts":{"$ref":"#/components/schemas/FileArtifacts"}},"additionalProperties":true},"Incident":{"type":"object","properties":{"incident_id":{"type":"string"},"is_blocked":{"type":"boolean"},"incident_name":{"type":"string"},"creation_time":{"type":"integer"},"modification_time":{"type":"integer"},"detection_time":{"type":"integer"},"status":{"type":"string"},"severity":{"type":"string"},"description":{"type":"string"},"assigned_user_mail":{"type":"string"},"assigned_user_pretty_name":{"type":"string"},"alert_count":{"type":"integer"},"low_severity_alert_count":{"type":"integer"},"med_severity_alert_count":{"type":"integer"},"high_severity_alert_count":{"type":"integer"},"critical_severity_alert_count":{"type":"integer"},"user_count":{"type":"integer"},"host_count":{"type":"integer"},"notes":{"type":"string"},"resolve_comment":{"type":"string"},"resolved_timestamp":{"type":"integer"},"manual_severity":{"type":"string"},"manual_description":{"type":"string"},"xdr_url":{"type":"string"},"starred":{"type":"boolean"},"starred_manually":{"type":"boolean"},"hosts":{"type":"array","items":{"type":"string"}},"incident_sources":{"type":"array","items":{"type":"string"}},"rule_based_score":{"type":"integer"},"manual_score":{"type":"number"},"aggregated_score":{"type":"integer"},"alerts_grouping_status":{"type":"string"},"alert_categories":{"type":"array","items":{"type":"string"}},"original_tags":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"xpanse_risk_score":{"type":"integer"},"xpanse_risk_explainer":{"$ref":"#/components/schemas/XpanseRiskExplainer"},"cloud_management_status":{"type":"string"},"integration_source":{"type":"string"},"ipv4_addresses":{"type":"array","items":{"type":"string"}},"ipv6_addresses":{"type":"array","items":{"type":"string"}},"domain_names":{"type":"array","items":{"type":"string"}},"port_number":{"type":"integer"},"asset_ids":{"type":"array","items":{"type":"string","format":"uuid"}},"ip_range_ids":{"type":"array","items":{"type":"string"}},"website_ids":{"type":"array","items":{"type":"string"}},"service_ids":{"type":"array","items":{"type":"string"}},"last_observed":{"type":"integer"},"cloud_providers":{"type":"array","items":{"type":"string"}},"country_codes":{"type":"array","items":{"type":"string"}},"certificate_common_names":{"type":"array","items":{"type":"string"}},"certificate_issuers":{"type":"array","items":{"type":"string"}}},"additionalProperties":true},"XpanseRiskExplainer":{"type":"object","properties":{"cves":{"type":"array","items":{"$ref":"#/components/schemas/Cve"}},"riskFactors":{"type":"array","items":{"$ref":"#/components/schemas/RiskFactor"}},"versionMatched":{"type":"boolean"}},"additionalProperties":true},"Cve":{"type":"object","properties":{"cveId":{"type":"string"},"cvssScore":{"type":"integer"},"epssScore":{"type":"number"},"matchType":{"type":"string"},"exploitMaturity":{"type":"string"},"reportedExploitInTheWild":{"type":"boolean"},"mostRecentReportedExploitDate":{"type":"string"},"confidence":{"type":"string"}},"additionalProperties":true},"RiskFactor":{"type":"object","properties":{"attributeId":{"type":"string"},"attributeName":{"type":"string"},"issueTypes":{"type":"array","items":{"$ref":"#/components/schemas/RiskFactorIssueType"}}},"required":["attributeId","attributeName","issueTypes"],"additionalProperties":true},"RiskFactorIssueType":{"type":"object","properties":{"displayName":{"type":"string"},"issueTypeId":{"type":"string"}},"required":["displayName","issueTypeId"],"additionalProperties":true},"IncidentExtraDataAlerts":{"type":"object","properties":{"total_count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/IncidentExtraData"}}},"required":["total_count"],"additionalProperties":true},"IncidentExtraData":{"type":"object","properties":{"category":{"type":"string"},"project":{"type":"string"},"cloud_provider":{"type":"string"},"resource_sub_type":{"type":"string"},"resource_type":{"type":"string"},"action_country":{"type":"string"},"event_type":{"type":"string"},"is_whitelisted":{"type":"boolean"},"mac":{"type":"string"},"image_name":{"type":"string"},"action_local_ip":{"type":"string"},"action_local_port":{"type":"string"},"action_external_hostname":{"type":"string"},"action_remote_ip":{"type":"array","items":{"type":"string"}},"action_remote_port":{"type":"integer"},"matching_service_rule_id":{"type":"string"},"starred":{"type":"boolean"},"external_id":{"type":"string"},"severity":{"type":"string"},"matching_status":{"type":"string"},"end_match_attempt_ts":{"type":"string"},"local_insert_ts":{"type":"integer","description":"The UNIX timestamp that this record was written to the database"},"last_modified_ts":{"type":"integer","description":"The UNIX timestamp that this record was last modified"},"case_id":{"type":"integer"},"deduplicate_tokens":{"type":"string"},"filter_rule_id":{"type":"string"},"event_id":{"type":"string"},"event_timestamp":{"type":"integer"},"action_local_ip_v6":{"type":"string"},"action_remote_ip_v6":{"type":"string"},"alert_type":{"type":"string"},"resolution_status":{"type":"string"},"resolution_comment":{"type":"string"},"dynamic_fields":{"type":"string"},"tags":{"type":"string"},"malicious_urls":{"type":"string"},"asm_alert_categories":{"type":"string"},"last_observed":{"type":"integer"},"country_codes":{"type":"string"},"cloud_providers":{"type":"string"},"ipv4_addresses":{"type":"string"},"ipv6_addresses":{"type":"string"},"domain_names":{"type":"string"},"service_ids":{"type":"string"},"website_ids":{"type":"string"},"asset_ids":{"type":"string"},"certificate":{"$ref":"#/components/schemas/IncidentCertificate"},"port_protocol":{"type":"string"},"port_number":{"type":"integer"},"business_unit_hierarchies":{"type":"array","items":{"$ref":"#/components/schemas/BusinessUnitHierarchy"}},"attack_surface_rule_name":{"type":"string"},"remediation_guidance":{"type":"string"},"attack_surface_rule_id":{"type":"string"},"asset_identifiers":{"$ref":"#/components/schemas/AssetIdentifiers"},"alert_id":{"type":"string"},"detection_timestamp":{"type":"integer"},"name":{"type":"string"},"endpoint_id":{"type":"string"},"description":{"type":"string"},"host_ip":{"type":"string"},"host_name":{"type":"string"},"source":{"type":"string"},"action":{"type":"string"},"action_pretty":{"type":"string"},"user_name":{"type":"string"},"events_length":{"type":"integer"},"mitre_tactic_id_and_name":{"type":"string"},"mitre_technique_id_and_name":{"type":"string"},"cloud_management_status":{"type":"string"}},"additionalProperties":true},"IncidentCertificate":{"type":"object","properties":{"issuerName":{"type":"string"},"subjectName":{"type":"string"},"validNotBefore":{"type":"integer"},"validNotAfter":{"type":"integer"},"serialNumber":{"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},"AssetIdentifiers":{"type":"object","properties":{"domain":{"type":"string"},"certificate":{"$ref":"#/components/schemas/IncidentCertificate"},"ipv4Address":{"type":"string"},"ipv6Address":{"type":"string"},"httpPath":{"type":"string"},"portNumber":{"type":"integer"},"portProtocol":{"type":"string"},"firstObserved":{"type":"integer"},"lastObserved":{"type":"integer"}},"additionalProperties":true},"NetworkArtifacts":{"type":"object","properties":{"total_count":{"type":"integer"},"data":{"type":"array","items":{"type":"string"}}},"required":["total_count"],"additionalProperties":true},"FileArtifacts":{"type":"object","properties":{"total_count":{"type":"integer"},"data":{"type":"array","items":{"type":"string"}}},"required":["total_count"],"additionalProperties":true}}}}
```

## The IncidentFilter object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"IncidentFilter":{"type":"object","properties":{"field":{"type":"string","enum":["modification_time","description","creation_time","alert_sources","incident_id_list","status","cloud_management_status","starred","incident_id","integration_source"],"description":"Identifies the incident field the filter is matching. \n "},"operator":{"type":"string","enum":["in","contains","neq","eq","lte","gte"],"description":"Identifies the comparison operator you want to use for this filter. Valid keywords are:\n- **in**: `incident_id_list`, `alert_sources`, `cloud_management_status`, `description`, `integration_source`\n- **contains**: `description` \n- **gte** / **lte**: `modification_time`, `creation_time`: Integer in timestamp epoch milliseconds \n- **eq** / **nqe**: `status`\n"},"value":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"integer"}}],"description":"Value that this filter must match. The contents of this field will differ depending on the incident field that you specified for this filter:\n  - alert_sources: String\n  - cloud_management_status: String. Values are `Managed Cloud`, `Unmanaged Cloud`, and `Not Applicable`.\n  - creation_time:`Integer in timestamp epoch milliseconds\n  - description: String\n  - incident_id_list: List of strings. Each item in the list must be an incident ID.\n  - integration_source: List of strings. Valid values: `AWS`, `AZURE`, `GOOGLE`, `PRISMA_CLOUD`\n  - modification_time: `Integer` in timestamp epoch milliseconds\n  - status: Valid values: `new`, `under_investigation`, `resolved`\n"}}}}}}
```

## The IncidentSort object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"IncidentSort":{"type":"object","properties":{"field":{"type":"string","default":"modification_time","enum":["creation_time","modification_time","incident_id"],"description":"Can be `creation_time` or `severity`."},"keyword":{"type":"string","default":"desc","enum":["ASC","asc","DESC","desc"],"description":"Can either be `ASC` (ascending order) or `DESC` (descending order)."}},"additionalProperties":true,"description":"Identifies the sort order for the result set. Default sort is defined as `creation_time`, `DESC`."}}}}
```

## The GetIncidentsRequestData object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetIncidentsRequestData":{"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/IncidentFilter"}},"search_from":{"type":"integer","default":0,"minimum":0,"description":"Integer representing the starting offset within the query result set from which you want incidents returned. Incidents are returned as a zero-based list. Any incident indexed less than this value is not returned in the final result set and defaults to zero.\n"},"search_to":{"type":"integer","default":100,"minimum":0,"description":"Integer representing the end offset within the result set after which you do not want incidents returned. Incidents in the incident list that are indexed higher than this value are not returned in the final results set. Defaults to >100, which returns all incidents to the end of the list.\n"},"sort":{"$ref":"#/components/schemas/IncidentSort"}}},"IncidentFilter":{"type":"object","properties":{"field":{"type":"string","enum":["modification_time","description","creation_time","alert_sources","incident_id_list","status","cloud_management_status","starred","incident_id","integration_source"],"description":"Identifies the incident field the filter is matching. \n "},"operator":{"type":"string","enum":["in","contains","neq","eq","lte","gte"],"description":"Identifies the comparison operator you want to use for this filter. Valid keywords are:\n- **in**: `incident_id_list`, `alert_sources`, `cloud_management_status`, `description`, `integration_source`\n- **contains**: `description` \n- **gte** / **lte**: `modification_time`, `creation_time`: Integer in timestamp epoch milliseconds \n- **eq** / **nqe**: `status`\n"},"value":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"integer"}}],"description":"Value that this filter must match. The contents of this field will differ depending on the incident field that you specified for this filter:\n  - alert_sources: String\n  - cloud_management_status: String. Values are `Managed Cloud`, `Unmanaged Cloud`, and `Not Applicable`.\n  - creation_time:`Integer in timestamp epoch milliseconds\n  - description: String\n  - incident_id_list: List of strings. Each item in the list must be an incident ID.\n  - integration_source: List of strings. Valid values: `AWS`, `AZURE`, `GOOGLE`, `PRISMA_CLOUD`\n  - modification_time: `Integer` in timestamp epoch milliseconds\n  - status: Valid values: `new`, `under_investigation`, `resolved`\n"}}},"IncidentSort":{"type":"object","properties":{"field":{"type":"string","default":"modification_time","enum":["creation_time","modification_time","incident_id"],"description":"Can be `creation_time` or `severity`."},"keyword":{"type":"string","default":"desc","enum":["ASC","asc","DESC","desc"],"description":"Can either be `ASC` (ascending order) or `DESC` (descending order)."}},"additionalProperties":true,"description":"Identifies the sort order for the result set. Default sort is defined as `creation_time`, `DESC`."}}}}
```

## The GetIncidentsRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetIncidentsRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/GetIncidentsRequestData"}},"required":["request_data"],"additionalProperties":true},"GetIncidentsRequestData":{"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/IncidentFilter"}},"search_from":{"type":"integer","default":0,"minimum":0,"description":"Integer representing the starting offset within the query result set from which you want incidents returned. Incidents are returned as a zero-based list. Any incident indexed less than this value is not returned in the final result set and defaults to zero.\n"},"search_to":{"type":"integer","default":100,"minimum":0,"description":"Integer representing the end offset within the result set after which you do not want incidents returned. Incidents in the incident list that are indexed higher than this value are not returned in the final results set. Defaults to >100, which returns all incidents to the end of the list.\n"},"sort":{"$ref":"#/components/schemas/IncidentSort"}}},"IncidentFilter":{"type":"object","properties":{"field":{"type":"string","enum":["modification_time","description","creation_time","alert_sources","incident_id_list","status","cloud_management_status","starred","incident_id","integration_source"],"description":"Identifies the incident field the filter is matching. \n "},"operator":{"type":"string","enum":["in","contains","neq","eq","lte","gte"],"description":"Identifies the comparison operator you want to use for this filter. Valid keywords are:\n- **in**: `incident_id_list`, `alert_sources`, `cloud_management_status`, `description`, `integration_source`\n- **contains**: `description` \n- **gte** / **lte**: `modification_time`, `creation_time`: Integer in timestamp epoch milliseconds \n- **eq** / **nqe**: `status`\n"},"value":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"integer"}}],"description":"Value that this filter must match. The contents of this field will differ depending on the incident field that you specified for this filter:\n  - alert_sources: String\n  - cloud_management_status: String. Values are `Managed Cloud`, `Unmanaged Cloud`, and `Not Applicable`.\n  - creation_time:`Integer in timestamp epoch milliseconds\n  - description: String\n  - incident_id_list: List of strings. Each item in the list must be an incident ID.\n  - integration_source: List of strings. Valid values: `AWS`, `AZURE`, `GOOGLE`, `PRISMA_CLOUD`\n  - modification_time: `Integer` in timestamp epoch milliseconds\n  - status: Valid values: `new`, `under_investigation`, `resolved`\n"}}},"IncidentSort":{"type":"object","properties":{"field":{"type":"string","default":"modification_time","enum":["creation_time","modification_time","incident_id"],"description":"Can be `creation_time` or `severity`."},"keyword":{"type":"string","default":"desc","enum":["ASC","asc","DESC","desc"],"description":"Can either be `ASC` (ascending order) or `DESC` (descending order)."}},"additionalProperties":true,"description":"Identifies the sort order for the result set. Default sort is defined as `creation_time`, `DESC`."}}}}
```

## The GetIncidentsPage object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetIncidentsPage":{"type":"object","properties":{"total_count":{"type":"integer"},"result_count":{"type":"integer"},"incidents":{"type":"array","items":{"$ref":"#/components/schemas/Incident"}},"restricted_incident_ids":{"type":"array","items":{"type":"string"}}},"required":["result_count","total_count"],"additionalProperties":true},"Incident":{"type":"object","properties":{"incident_id":{"type":"string"},"is_blocked":{"type":"boolean"},"incident_name":{"type":"string"},"creation_time":{"type":"integer"},"modification_time":{"type":"integer"},"detection_time":{"type":"integer"},"status":{"type":"string"},"severity":{"type":"string"},"description":{"type":"string"},"assigned_user_mail":{"type":"string"},"assigned_user_pretty_name":{"type":"string"},"alert_count":{"type":"integer"},"low_severity_alert_count":{"type":"integer"},"med_severity_alert_count":{"type":"integer"},"high_severity_alert_count":{"type":"integer"},"critical_severity_alert_count":{"type":"integer"},"user_count":{"type":"integer"},"host_count":{"type":"integer"},"notes":{"type":"string"},"resolve_comment":{"type":"string"},"resolved_timestamp":{"type":"integer"},"manual_severity":{"type":"string"},"manual_description":{"type":"string"},"xdr_url":{"type":"string"},"starred":{"type":"boolean"},"starred_manually":{"type":"boolean"},"hosts":{"type":"array","items":{"type":"string"}},"incident_sources":{"type":"array","items":{"type":"string"}},"rule_based_score":{"type":"integer"},"manual_score":{"type":"number"},"aggregated_score":{"type":"integer"},"alerts_grouping_status":{"type":"string"},"alert_categories":{"type":"array","items":{"type":"string"}},"original_tags":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"xpanse_risk_score":{"type":"integer"},"xpanse_risk_explainer":{"$ref":"#/components/schemas/XpanseRiskExplainer"},"cloud_management_status":{"type":"string"},"integration_source":{"type":"string"},"ipv4_addresses":{"type":"array","items":{"type":"string"}},"ipv6_addresses":{"type":"array","items":{"type":"string"}},"domain_names":{"type":"array","items":{"type":"string"}},"port_number":{"type":"integer"},"asset_ids":{"type":"array","items":{"type":"string","format":"uuid"}},"ip_range_ids":{"type":"array","items":{"type":"string"}},"website_ids":{"type":"array","items":{"type":"string"}},"service_ids":{"type":"array","items":{"type":"string"}},"last_observed":{"type":"integer"},"cloud_providers":{"type":"array","items":{"type":"string"}},"country_codes":{"type":"array","items":{"type":"string"}},"certificate_common_names":{"type":"array","items":{"type":"string"}},"certificate_issuers":{"type":"array","items":{"type":"string"}}},"additionalProperties":true},"XpanseRiskExplainer":{"type":"object","properties":{"cves":{"type":"array","items":{"$ref":"#/components/schemas/Cve"}},"riskFactors":{"type":"array","items":{"$ref":"#/components/schemas/RiskFactor"}},"versionMatched":{"type":"boolean"}},"additionalProperties":true},"Cve":{"type":"object","properties":{"cveId":{"type":"string"},"cvssScore":{"type":"integer"},"epssScore":{"type":"number"},"matchType":{"type":"string"},"exploitMaturity":{"type":"string"},"reportedExploitInTheWild":{"type":"boolean"},"mostRecentReportedExploitDate":{"type":"string"},"confidence":{"type":"string"}},"additionalProperties":true},"RiskFactor":{"type":"object","properties":{"attributeId":{"type":"string"},"attributeName":{"type":"string"},"issueTypes":{"type":"array","items":{"$ref":"#/components/schemas/RiskFactorIssueType"}}},"required":["attributeId","attributeName","issueTypes"],"additionalProperties":true},"RiskFactorIssueType":{"type":"object","properties":{"displayName":{"type":"string"},"issueTypeId":{"type":"string"}},"required":["displayName","issueTypeId"],"additionalProperties":true}}}}
```

## The GetIncidentsResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetIncidentsResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/GetIncidentsPage"}},"required":["reply"],"additionalProperties":true},"GetIncidentsPage":{"type":"object","properties":{"total_count":{"type":"integer"},"result_count":{"type":"integer"},"incidents":{"type":"array","items":{"$ref":"#/components/schemas/Incident"}},"restricted_incident_ids":{"type":"array","items":{"type":"string"}}},"required":["result_count","total_count"],"additionalProperties":true},"Incident":{"type":"object","properties":{"incident_id":{"type":"string"},"is_blocked":{"type":"boolean"},"incident_name":{"type":"string"},"creation_time":{"type":"integer"},"modification_time":{"type":"integer"},"detection_time":{"type":"integer"},"status":{"type":"string"},"severity":{"type":"string"},"description":{"type":"string"},"assigned_user_mail":{"type":"string"},"assigned_user_pretty_name":{"type":"string"},"alert_count":{"type":"integer"},"low_severity_alert_count":{"type":"integer"},"med_severity_alert_count":{"type":"integer"},"high_severity_alert_count":{"type":"integer"},"critical_severity_alert_count":{"type":"integer"},"user_count":{"type":"integer"},"host_count":{"type":"integer"},"notes":{"type":"string"},"resolve_comment":{"type":"string"},"resolved_timestamp":{"type":"integer"},"manual_severity":{"type":"string"},"manual_description":{"type":"string"},"xdr_url":{"type":"string"},"starred":{"type":"boolean"},"starred_manually":{"type":"boolean"},"hosts":{"type":"array","items":{"type":"string"}},"incident_sources":{"type":"array","items":{"type":"string"}},"rule_based_score":{"type":"integer"},"manual_score":{"type":"number"},"aggregated_score":{"type":"integer"},"alerts_grouping_status":{"type":"string"},"alert_categories":{"type":"array","items":{"type":"string"}},"original_tags":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"xpanse_risk_score":{"type":"integer"},"xpanse_risk_explainer":{"$ref":"#/components/schemas/XpanseRiskExplainer"},"cloud_management_status":{"type":"string"},"integration_source":{"type":"string"},"ipv4_addresses":{"type":"array","items":{"type":"string"}},"ipv6_addresses":{"type":"array","items":{"type":"string"}},"domain_names":{"type":"array","items":{"type":"string"}},"port_number":{"type":"integer"},"asset_ids":{"type":"array","items":{"type":"string","format":"uuid"}},"ip_range_ids":{"type":"array","items":{"type":"string"}},"website_ids":{"type":"array","items":{"type":"string"}},"service_ids":{"type":"array","items":{"type":"string"}},"last_observed":{"type":"integer"},"cloud_providers":{"type":"array","items":{"type":"string"}},"country_codes":{"type":"array","items":{"type":"string"}},"certificate_common_names":{"type":"array","items":{"type":"string"}},"certificate_issuers":{"type":"array","items":{"type":"string"}}},"additionalProperties":true},"XpanseRiskExplainer":{"type":"object","properties":{"cves":{"type":"array","items":{"$ref":"#/components/schemas/Cve"}},"riskFactors":{"type":"array","items":{"$ref":"#/components/schemas/RiskFactor"}},"versionMatched":{"type":"boolean"}},"additionalProperties":true},"Cve":{"type":"object","properties":{"cveId":{"type":"string"},"cvssScore":{"type":"integer"},"epssScore":{"type":"number"},"matchType":{"type":"string"},"exploitMaturity":{"type":"string"},"reportedExploitInTheWild":{"type":"boolean"},"mostRecentReportedExploitDate":{"type":"string"},"confidence":{"type":"string"}},"additionalProperties":true},"RiskFactor":{"type":"object","properties":{"attributeId":{"type":"string"},"attributeName":{"type":"string"},"issueTypes":{"type":"array","items":{"$ref":"#/components/schemas/RiskFactorIssueType"}}},"required":["attributeId","attributeName","issueTypes"],"additionalProperties":true},"RiskFactorIssueType":{"type":"object","properties":{"displayName":{"type":"string"},"issueTypeId":{"type":"string"}},"required":["displayName","issueTypeId"],"additionalProperties":true}}}}
```

## The Alerts object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"Alerts":{"type":"object","properties":{"severity":{"type":"string","description":"Administrator-defined severity, one of the following:\n  - critical\n  - high\n  - medium\n  - low\n  - unknown\n"},"status":{"type":"string","description":"Updated alert status, one of the following:\n  - resolved_-_no_longer_observed\n  - new\n  - resolved_-_no_risk\n  - resolved_-_risk_accepted\n  - under_investigation\n  - resolved_-_contested_asset\n  - resolved_-_remediated_automatically\n  - resolved\n"},"comment":{"type":"string","description":"Updated text that appears in the Resolution Comment field of the Alerts table."}}}}}}
```

## The UpdateAlertsData object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"UpdateAlertsData":{"type":"object","properties":{"alert_id_list":{"type":"array","items":{"type":"string"}},"update_data":{"$ref":"#/components/schemas/Alerts"}},"required":["update_data"],"additionalProperties":true,"description":"(Required) A dictionary containing the API request fields. An empty dictionary returns all results.\n"},"Alerts":{"type":"object","properties":{"severity":{"type":"string","description":"Administrator-defined severity, one of the following:\n  - critical\n  - high\n  - medium\n  - low\n  - unknown\n"},"status":{"type":"string","description":"Updated alert status, one of the following:\n  - resolved_-_no_longer_observed\n  - new\n  - resolved_-_no_risk\n  - resolved_-_risk_accepted\n  - under_investigation\n  - resolved_-_contested_asset\n  - resolved_-_remediated_automatically\n  - resolved\n"},"comment":{"type":"string","description":"Updated text that appears in the Resolution Comment field of the Alerts table."}}}}}}
```

## The UpdateAlertsRequestData object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"UpdateAlertsRequestData":{"type":"object","properties":{"request_data":{"description":"(Required) A dictionary containing the API request fields.\r\n\r\nAn empty dictionary returns all results.\r\n","allOf":[{"$ref":"#/components/schemas/UpdateAlertsData"}]}},"required":["request_data"],"additionalProperties":true},"UpdateAlertsData":{"type":"object","properties":{"alert_id_list":{"type":"array","items":{"type":"string"}},"update_data":{"$ref":"#/components/schemas/Alerts"}},"required":["update_data"],"additionalProperties":true,"description":"(Required) A dictionary containing the API request fields. An empty dictionary returns all results.\n"},"Alerts":{"type":"object","properties":{"severity":{"type":"string","description":"Administrator-defined severity, one of the following:\n  - critical\n  - high\n  - medium\n  - low\n  - unknown\n"},"status":{"type":"string","description":"Updated alert status, one of the following:\n  - resolved_-_no_longer_observed\n  - new\n  - resolved_-_no_risk\n  - resolved_-_risk_accepted\n  - under_investigation\n  - resolved_-_contested_asset\n  - resolved_-_remediated_automatically\n  - resolved\n"},"comment":{"type":"string","description":"Updated text that appears in the Resolution Comment field of the Alerts table."}}}}}}
```

## The AlertIdsList object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"AlertIdsList":{"type":"object","properties":{"alerts_ids":{"type":"array","items":{"type":"integer"}}},"additionalProperties":true}}}}
```

## The UpdateAlertsResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"UpdateAlertsResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/AlertIdsList"}},"required":["reply"],"additionalProperties":true},"AlertIdsList":{"type":"object","properties":{"alerts_ids":{"type":"array","items":{"type":"integer"}}},"additionalProperties":true}}}}
```

## The IncidentComment object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"IncidentComment":{"type":"object","properties":{"comment_action":{"type":"string","default":"add","enum":["add"]},"value":{"type":"string"}},"additionalProperties":true,"description":"Add a comment to the incident."}}}}
```

## The UpdateIncident object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"UpdateIncident":{"type":"object","properties":{"assigned_user_mail":{"type":"string","description":"Updated email address of the incident assignee."},"assigned_user_pretty_name":{"type":"string","description":"Updated full name of the incident assignee. To supply a new value in this field, you must also supply a value for `assigned_user_mail` in the same request."},"manual_severity":{"type":"string","enum":["low","high","critical","medium"],"description":"Administrator-defined severity."},"status":{"type":"string","enum":["resolved","new","under_investigation"],"description":"Updated incident status."},"resolve_comment":{"type":"string","description":"Descriptive comment explaining the incident change."},"comment":{"$ref":"#/components/schemas/IncidentComment"}},"required":["assigned_user_mail","assigned_user_pretty_name","resolve_comment","status"],"additionalProperties":true},"IncidentComment":{"type":"object","properties":{"comment_action":{"type":"string","default":"add","enum":["add"]},"value":{"type":"string"}},"additionalProperties":true,"description":"Add a comment to the incident."}}}}
```

## The UpdateIncidentRequestData object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"UpdateIncidentRequestData":{"type":"object","properties":{"incident_id":{"type":"string"},"update_data":{"$ref":"#/components/schemas/UpdateIncident"}},"required":["incident_id","update_data"],"additionalProperties":true},"UpdateIncident":{"type":"object","properties":{"assigned_user_mail":{"type":"string","description":"Updated email address of the incident assignee."},"assigned_user_pretty_name":{"type":"string","description":"Updated full name of the incident assignee. To supply a new value in this field, you must also supply a value for `assigned_user_mail` in the same request."},"manual_severity":{"type":"string","enum":["low","high","critical","medium"],"description":"Administrator-defined severity."},"status":{"type":"string","enum":["resolved","new","under_investigation"],"description":"Updated incident status."},"resolve_comment":{"type":"string","description":"Descriptive comment explaining the incident change."},"comment":{"$ref":"#/components/schemas/IncidentComment"}},"required":["assigned_user_mail","assigned_user_pretty_name","resolve_comment","status"],"additionalProperties":true},"IncidentComment":{"type":"object","properties":{"comment_action":{"type":"string","default":"add","enum":["add"]},"value":{"type":"string"}},"additionalProperties":true,"description":"Add a comment to the incident."}}}}
```

## The UpdateIncidentRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"UpdateIncidentRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/UpdateIncidentRequestData"}},"required":["request_data"],"additionalProperties":true},"UpdateIncidentRequestData":{"type":"object","properties":{"incident_id":{"type":"string"},"update_data":{"$ref":"#/components/schemas/UpdateIncident"}},"required":["incident_id","update_data"],"additionalProperties":true},"UpdateIncident":{"type":"object","properties":{"assigned_user_mail":{"type":"string","description":"Updated email address of the incident assignee."},"assigned_user_pretty_name":{"type":"string","description":"Updated full name of the incident assignee. To supply a new value in this field, you must also supply a value for `assigned_user_mail` in the same request."},"manual_severity":{"type":"string","enum":["low","high","critical","medium"],"description":"Administrator-defined severity."},"status":{"type":"string","enum":["resolved","new","under_investigation"],"description":"Updated incident status."},"resolve_comment":{"type":"string","description":"Descriptive comment explaining the incident change."},"comment":{"$ref":"#/components/schemas/IncidentComment"}},"required":["assigned_user_mail","assigned_user_pretty_name","resolve_comment","status"],"additionalProperties":true},"IncidentComment":{"type":"object","properties":{"comment_action":{"type":"string","default":"add","enum":["add"]},"value":{"type":"string"}},"additionalProperties":true,"description":"Add a comment to the incident."}}}}
```

## The UpdateIncidentResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"UpdateIncidentResponse":{"type":"object","properties":{"reply":{"type":"boolean"},"warnings":{"type":"array","items":{"type":"string"}}},"required":["reply"],"additionalProperties":true}}}}
```

## The RemediationRulesFilterCondition object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"RemediationRulesFilterCondition":{"type":"object","properties":{"field":{"type":"string","enum":["attack_surface_rule_id"],"description":"String that identifies the attack surface rule field for filtering.\n"},"operator":{"type":"string","enum":["neq","eq"],"description":"Identifies the comparison operator to use for this filter. Valid keywords are\n  - `eq`\n  - `neq`\n"},"value":{"type":"string","description":"Value that the filter must match. Value must be the following:\n  - `{attack_surface_rule_id}`: String of the attack surface rule to filter on\n"}},"required":["field","operator","value"],"additionalProperties":true}}}}
```

## The RemediationRulesSort object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"RemediationRulesSort":{"type":"object","properties":{"field":{"type":"string","default":"created_at","enum":["created_at"],"description":"Sorting based on the `created_at` field is supported."},"keyword":{"type":"string","default":"desc","enum":["ASC","asc","DESC","desc"],"description":"Sort order can be one of the following values:\n  - `ASC`: ascending order\n  - `DESC`: descending order\n"}},"additionalProperties":true}}}}
```

## The GetRemediationRulesFilters object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetRemediationRulesFilters":{"type":"object","properties":{"filters":{"type":"array","description":"Array of filter fields. Each JSON object must contain the following:\n  - field\n  - operator\n  - value\n","items":{"$ref":"#/components/schemas/RemediationRulesFilterCondition"}},"sort":{"description":"Identifies the sort order for the result set. By default, the sort is defined as `created_at`, `DESC`.","allOf":[{"$ref":"#/components/schemas/RemediationRulesSort"}]},"search_from":{"type":"integer","default":0,"minimum":0},"search_to":{"type":"integer","default":500,"minimum":0}},"additionalProperties":true,"description":"A dictionary containing the API request fields."},"RemediationRulesFilterCondition":{"type":"object","properties":{"field":{"type":"string","enum":["attack_surface_rule_id"],"description":"String that identifies the attack surface rule field for filtering.\n"},"operator":{"type":"string","enum":["neq","eq"],"description":"Identifies the comparison operator to use for this filter. Valid keywords are\n  - `eq`\n  - `neq`\n"},"value":{"type":"string","description":"Value that the filter must match. Value must be the following:\n  - `{attack_surface_rule_id}`: String of the attack surface rule to filter on\n"}},"required":["field","operator","value"],"additionalProperties":true},"RemediationRulesSort":{"type":"object","properties":{"field":{"type":"string","default":"created_at","enum":["created_at"],"description":"Sorting based on the `created_at` field is supported."},"keyword":{"type":"string","default":"desc","enum":["ASC","asc","DESC","desc"],"description":"Sort order can be one of the following values:\n  - `ASC`: ascending order\n  - `DESC`: descending order\n"}},"additionalProperties":true}}}}
```

## The GetRemediationRulesRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetRemediationRulesRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/GetRemediationRulesFilters"}},"required":["request_data"],"additionalProperties":true},"GetRemediationRulesFilters":{"type":"object","properties":{"filters":{"type":"array","description":"Array of filter fields. Each JSON object must contain the following:\n  - field\n  - operator\n  - value\n","items":{"$ref":"#/components/schemas/RemediationRulesFilterCondition"}},"sort":{"description":"Identifies the sort order for the result set. By default, the sort is defined as `created_at`, `DESC`.","allOf":[{"$ref":"#/components/schemas/RemediationRulesSort"}]},"search_from":{"type":"integer","default":0,"minimum":0},"search_to":{"type":"integer","default":500,"minimum":0}},"additionalProperties":true,"description":"A dictionary containing the API request fields."},"RemediationRulesFilterCondition":{"type":"object","properties":{"field":{"type":"string","enum":["attack_surface_rule_id"],"description":"String that identifies the attack surface rule field for filtering.\n"},"operator":{"type":"string","enum":["neq","eq"],"description":"Identifies the comparison operator to use for this filter. Valid keywords are\n  - `eq`\n  - `neq`\n"},"value":{"type":"string","description":"Value that the filter must match. Value must be the following:\n  - `{attack_surface_rule_id}`: String of the attack surface rule to filter on\n"}},"required":["field","operator","value"],"additionalProperties":true},"RemediationRulesSort":{"type":"object","properties":{"field":{"type":"string","default":"created_at","enum":["created_at"],"description":"Sorting based on the `created_at` field is supported."},"keyword":{"type":"string","default":"desc","enum":["ASC","asc","DESC","desc"],"description":"Sort order can be one of the following values:\n  - `ASC`: ascending order\n  - `DESC`: descending order\n"}},"additionalProperties":true}}}}
```

## The RemediationRuleCriteria object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"RemediationRuleCriteria":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"},"operator":{"type":"string"}},"required":["field","operator","value"],"additionalProperties":true}}}}
```

## The RemediationRule object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"RemediationRule":{"type":"object","properties":{"rule_id":{"type":"string"},"description":{"type":"string"},"attack_surface_rule_id":{"type":"string"},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/RemediationRuleCriteria"}},"criteria_conjunction":{"type":"string"},"action":{"type":"string"},"created_by":{"type":"string"},"created_by_pretty":{"type":"string"},"created_at":{"type":"integer"},"details":{"type":"string"}},"required":["action","attack_surface_rule_id","created_at","created_by","created_by_pretty","criteria","criteria_conjunction","description","details","rule_id"],"additionalProperties":true},"RemediationRuleCriteria":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"},"operator":{"type":"string"}},"required":["field","operator","value"],"additionalProperties":true}}}}
```

## The RemediationRulesPageResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"RemediationRulesPageResponse":{"type":"object","properties":{"result_count":{"type":"integer"},"remediation_rules":{"type":"array","items":{"$ref":"#/components/schemas/RemediationRule"}}},"required":["remediation_rules","result_count"],"additionalProperties":true},"RemediationRule":{"type":"object","properties":{"rule_id":{"type":"string"},"description":{"type":"string"},"attack_surface_rule_id":{"type":"string"},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/RemediationRuleCriteria"}},"criteria_conjunction":{"type":"string"},"action":{"type":"string"},"created_by":{"type":"string"},"created_by_pretty":{"type":"string"},"created_at":{"type":"integer"},"details":{"type":"string"}},"required":["action","attack_surface_rule_id","created_at","created_by","created_by_pretty","criteria","criteria_conjunction","description","details","rule_id"],"additionalProperties":true},"RemediationRuleCriteria":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"},"operator":{"type":"string"}},"required":["field","operator","value"],"additionalProperties":true}}}}
```

## The GetRemediationRulesResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetRemediationRulesResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/RemediationRulesPageResponse"}},"required":["reply"],"additionalProperties":true},"RemediationRulesPageResponse":{"type":"object","properties":{"result_count":{"type":"integer"},"remediation_rules":{"type":"array","items":{"$ref":"#/components/schemas/RemediationRule"}}},"required":["remediation_rules","result_count"],"additionalProperties":true},"RemediationRule":{"type":"object","properties":{"rule_id":{"type":"string"},"description":{"type":"string"},"attack_surface_rule_id":{"type":"string"},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/RemediationRuleCriteria"}},"criteria_conjunction":{"type":"string"},"action":{"type":"string"},"created_by":{"type":"string"},"created_by_pretty":{"type":"string"},"created_at":{"type":"integer"},"details":{"type":"string"}},"required":["action","attack_surface_rule_id","created_at","created_by","created_by_pretty","criteria","criteria_conjunction","description","details","rule_id"],"additionalProperties":true},"RemediationRuleCriteria":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"},"operator":{"type":"string"}},"required":["field","operator","value"],"additionalProperties":true}}}}
```

## The RemediationScanFilterCondition object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"RemediationScanFilterCondition":{"type":"object","required":["field","operator","value"],"properties":{"field":{"enum":["attack_surface_rule_id","alert_internal_id","service_id"],"description":"All three of these filters must be used."},"operator":{"enum":["eq","EQ"]},"value":{"anyOf":[{"type":"string"},{"type":"integer"}]}}}}}}
```

## The RemediationScanFilterRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"RemediationScanFilterRequest":{"type":"object","description":"A dictionary containing the API request fields. An empty dictionary returns all results.","required":["filters"],"properties":{"filters":{"type":"array","minItems":0,"maxItems":3,"description":"An array of filter fields.","items":{"$ref":"#/components/schemas/RemediationScanFilterCondition"}}}},"RemediationScanFilterCondition":{"type":"object","required":["field","operator","value"],"properties":{"field":{"enum":["attack_surface_rule_id","alert_internal_id","service_id"],"description":"All three of these filters must be used."},"operator":{"enum":["eq","EQ"]},"value":{"anyOf":[{"type":"string"},{"type":"integer"}]}}}}}}
```

## The GetOrCreateRemediationScanRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetOrCreateRemediationScanRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/RemediationScanFilterRequest"}},"required":["request_data"],"additionalProperties":true},"RemediationScanFilterRequest":{"type":"object","description":"A dictionary containing the API request fields. An empty dictionary returns all results.","required":["filters"],"properties":{"filters":{"type":"array","minItems":0,"maxItems":3,"description":"An array of filter fields.","items":{"$ref":"#/components/schemas/RemediationScanFilterCondition"}}}},"RemediationScanFilterCondition":{"type":"object","required":["field","operator","value"],"properties":{"field":{"enum":["attack_surface_rule_id","alert_internal_id","service_id"],"description":"All three of these filters must be used."},"operator":{"enum":["eq","EQ"]},"value":{"anyOf":[{"type":"string"},{"type":"integer"}]}}}}}}
```

## The RemediationScanId object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"RemediationScanId":{"type":"object","properties":{"scanId":{"type":"string"}},"additionalProperties":true}}}}
```

## The GetOrCreateRemediationScanResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetOrCreateRemediationScanResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/RemediationScanId"}},"required":["reply"],"additionalProperties":true},"RemediationScanId":{"type":"object","properties":{"scanId":{"type":"string"}},"additionalProperties":true}}}}
```

## The PollRemediationScanResultsFilterCondition object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"PollRemediationScanResultsFilterCondition":{"type":"object","properties":{"field":{"type":"string","enum":["id"],"description":"\"id\": Indicates that you want to filter on a specific scan ID."},"operator":{"type":"string","default":"eq","enum":["eq"],"description":"EQ"},"value":{"type":"string","description":"The scan ID (string)."}},"required":["value"],"additionalProperties":true}}}}
```

## The RemediationScanResultsFilterRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"RemediationScanResultsFilterRequest":{"type":"object","properties":{"filters":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/PollRemediationScanResultsFilterCondition"}}},"required":["filters"],"additionalProperties":true},"PollRemediationScanResultsFilterCondition":{"type":"object","properties":{"field":{"type":"string","enum":["id"],"description":"\"id\": Indicates that you want to filter on a specific scan ID."},"operator":{"type":"string","default":"eq","enum":["eq"],"description":"EQ"},"value":{"type":"string","description":"The scan ID (string)."}},"required":["value"],"additionalProperties":true}}}}
```

## The PollRemediationScanResultsRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"PollRemediationScanResultsRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/RemediationScanResultsFilterRequest"}},"required":["request_data"],"additionalProperties":true},"RemediationScanResultsFilterRequest":{"type":"object","properties":{"filters":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/PollRemediationScanResultsFilterCondition"}}},"required":["filters"],"additionalProperties":true},"PollRemediationScanResultsFilterCondition":{"type":"object","properties":{"field":{"type":"string","enum":["id"],"description":"\"id\": Indicates that you want to filter on a specific scan ID."},"operator":{"type":"string","default":"eq","enum":["eq"],"description":"EQ"},"value":{"type":"string","description":"The scan ID (string)."}},"required":["value"],"additionalProperties":true}}}}
```

## The RemediationScanStatus object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"RemediationScanStatus":{"type":"object","properties":{"status":{"type":"string","description":"Possible values are:\n  - IN_PROGRESS\n  - FAILED_TIMEOUT\n  - FAILED_ERROR\n  - SUCCESS\n"},"result":{"type":"string","description":"If the status equals \"SUCCESS\", then possible result values are:\n  - REMEDIATED\n  - UNREMEDIATED\n"}},"required":["status"],"additionalProperties":true}}}}
```

## The PollRemediationScanResultsResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"PollRemediationScanResultsResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/RemediationScanStatus"}},"required":["reply"],"additionalProperties":true},"RemediationScanStatus":{"type":"object","properties":{"status":{"type":"string","description":"Possible values are:\n  - IN_PROGRESS\n  - FAILED_TIMEOUT\n  - FAILED_ERROR\n  - SUCCESS\n"},"result":{"type":"string","description":"If the status equals \"SUCCESS\", then possible result values are:\n  - REMEDIATED\n  - UNREMEDIATED\n"}},"required":["status"],"additionalProperties":true}}}}
```

## The GetRolesFilter object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetRolesFilter":{"type":"object","properties":{"role_names":{"type":"array","items":{"type":"string"},"description":"List of one or more role names in your environment for which you want detailed information."}},"additionalProperties":true,"description":"A dictionary containing the API request fields."}}}}
```

## The GetRolesRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetRolesRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/GetRolesFilter"}},"required":["request_data"],"additionalProperties":true},"GetRolesFilter":{"type":"object","properties":{"role_names":{"type":"array","items":{"type":"string"},"description":"List of one or more role names in your environment for which you want detailed information."}},"additionalProperties":true,"description":"A dictionary containing the API request fields."}}}}
```

## The Role object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"Role":{"type":"object","properties":{"pretty_name":{"type":"string","description":"Name of the role as it appears in the Management Console."},"permissions":{"type":"array","items":{"type":"string"},"description":"List of permissions associated with this role."},"insert_time":{"type":"integer","description":"Timestamp of when the Role was created."},"update_time":{"type":"integer","description":"Timestamp of when the Role was last updated."},"created_by":{"type":"string","description":"Email of the user who created the Role."},"description":{"type":"string","description":"Description of the Role, if available."},"groups":{"type":"array","items":{"type":"string"},"description":"Group names associated with the Role."},"users":{"type":"array","items":{"type":"string"},"description":"Email addresses of users associated with the Role."}},"required":["created_by","description","permissions","pretty_name"],"additionalProperties":true}}}}
```

## The GetRolesResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetRolesResponse":{"type":"object","properties":{"reply":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/Role"}},"description":"JSON object containing the query result."}},"required":["reply"],"additionalProperties":true},"Role":{"type":"object","properties":{"pretty_name":{"type":"string","description":"Name of the role as it appears in the Management Console."},"permissions":{"type":"array","items":{"type":"string"},"description":"List of permissions associated with this role."},"insert_time":{"type":"integer","description":"Timestamp of when the Role was created."},"update_time":{"type":"integer","description":"Timestamp of when the Role was last updated."},"created_by":{"type":"string","description":"Email of the user who created the Role."},"description":{"type":"string","description":"Description of the Role, if available."},"groups":{"type":"array","items":{"type":"string"},"description":"Group names associated with the Role."},"users":{"type":"array","items":{"type":"string"},"description":"Email addresses of users associated with the Role."}},"required":["created_by","description","permissions","pretty_name"],"additionalProperties":true}}}}
```

## The TenantLicenseInfo object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"TenantLicenseInfo":{"type":"object","properties":{"aum":{"type":"integer"},"expiration_date":{"type":"string"},"activation_date":{"type":"string"},"status":{"type":"string"}},"required":["activation_date","aum","expiration_date","status"],"additionalProperties":true,"description":"List of available licenses, number of devices, and purchased add-ons on your tenant."}}}}
```

## The GetTenantLicenseInfoResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetTenantLicenseInfoResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/TenantLicenseInfo"}},"required":["reply"],"additionalProperties":true},"TenantLicenseInfo":{"type":"object","properties":{"aum":{"type":"integer"},"expiration_date":{"type":"string"},"activation_date":{"type":"string"},"status":{"type":"string"}},"required":["activation_date","aum","expiration_date","status"],"additionalProperties":true,"description":"List of available licenses, number of devices, and purchased add-ons on your tenant."}}}}
```

## The GetUserGroupsFilter object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetUserGroupsFilter":{"type":"object","properties":{"group_names":{"type":"array","items":{"type":"string"},"description":"List of one or more user group names for which you want the associated users."}},"additionalProperties":true,"description":"A dictionary containing the API request fields."}}}}
```

## The GetUserGroupsRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetUserGroupsRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/GetUserGroupsFilter"}},"required":["request_data"],"additionalProperties":true},"GetUserGroupsFilter":{"type":"object","properties":{"group_names":{"type":"array","items":{"type":"string"},"description":"List of one or more user group names for which you want the associated users."}},"additionalProperties":true,"description":"A dictionary containing the API request fields."}}}}
```

## The UserGroup object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"UserGroup":{"type":"object","properties":{"group_name":{"type":"string","description":"Name of the User Group."},"description":{"type":"string","description":"Description of the User Group, if available."},"created_by":{"type":"string"},"pretty_name":{"type":"string","description":"Name of the User Group as it appears in the Management Console."},"insert_time":{"type":"integer","description":"Timestamp of when the User Group was created."},"update_time":{"type":"integer","description":"Timestamp of when the User Group was last updated."},"user_email":{"type":"array","items":{"type":"string"},"description":"List of email addresses belonging to the users associated with the User Group."},"source":{"type":"string","description":"Type of User Group."}},"required":["group_name","insert_time","source"],"additionalProperties":true}}}}
```

## The GetUserGroupsResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetUserGroupsResponse":{"type":"object","properties":{"reply":{"type":"array","items":{"$ref":"#/components/schemas/UserGroup"},"description":"JSON object containing the query result."}},"required":["reply"],"additionalProperties":true},"UserGroup":{"type":"object","properties":{"group_name":{"type":"string","description":"Name of the User Group."},"description":{"type":"string","description":"Description of the User Group, if available."},"created_by":{"type":"string"},"pretty_name":{"type":"string","description":"Name of the User Group as it appears in the Management Console."},"insert_time":{"type":"integer","description":"Timestamp of when the User Group was created."},"update_time":{"type":"integer","description":"Timestamp of when the User Group was last updated."},"user_email":{"type":"array","items":{"type":"string"},"description":"List of email addresses belonging to the users associated with the User Group."},"source":{"type":"string","description":"Type of User Group."}},"required":["group_name","insert_time","source"],"additionalProperties":true}}}}
```

## The Scope object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"Scope":{"type":"object","properties":{"tag_id":{"type":"string"},"tag_name_with_alias":{"type":"string"}},"required":["tag_id","tag_name_with_alias"],"additionalProperties":true}}}}
```

## The User object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"User":{"type":"object","properties":{"user_email":{"type":"string","description":"Email address of the user."},"user_first_name":{"type":"string","description":"First name of the user."},"user_last_name":{"type":"string","description":"Last name of the user."},"role_name":{"type":"string","description":"Role name associated with the user."},"last_logged_in":{"type":"integer","description":"Timestamp of when the user last logged in."},"user_type":{"type":"string","description":"Type of user."},"groups":{"type":"array","items":{"type":"string"},"description":"Name of user groups associated with the user, if applicable."},"scope":{"type":"array","items":{"$ref":"#/components/schemas/Scope"},"description":"Name of scope associated with the user, if applicable."}},"required":["groups","user_email","user_first_name","user_last_name","user_type"],"additionalProperties":true},"Scope":{"type":"object","properties":{"tag_id":{"type":"string"},"tag_name_with_alias":{"type":"string"}},"required":["tag_id","tag_name_with_alias"],"additionalProperties":true}}}}
```

## The GetUsersResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetUsersResponse":{"type":"object","properties":{"reply":{"type":"array","items":{"$ref":"#/components/schemas/User"},"description":"JSON object containing the query result."}},"required":["reply"],"additionalProperties":true},"User":{"type":"object","properties":{"user_email":{"type":"string","description":"Email address of the user."},"user_first_name":{"type":"string","description":"First name of the user."},"user_last_name":{"type":"string","description":"Last name of the user."},"role_name":{"type":"string","description":"Role name associated with the user."},"last_logged_in":{"type":"integer","description":"Timestamp of when the user last logged in."},"user_type":{"type":"string","description":"Type of user."},"groups":{"type":"array","items":{"type":"string"},"description":"Name of user groups associated with the user, if applicable."},"scope":{"type":"array","items":{"$ref":"#/components/schemas/Scope"},"description":"Name of scope associated with the user, if applicable."}},"required":["groups","user_email","user_first_name","user_last_name","user_type"],"additionalProperties":true},"Scope":{"type":"object","properties":{"tag_id":{"type":"string"},"tag_name_with_alias":{"type":"string"}},"required":["tag_id","tag_name_with_alias"],"additionalProperties":true}}}}
```

## The SetUserRoleFilter object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"SetUserRoleFilter":{"type":"object","properties":{"user_emails":{"type":"array","items":{"type":"string"},"description":"List of one or more user emails of users you want to add to or remove from a role."},"role_name":{"type":"string","description":"Name of the role you want to add a user to. Send an empty field to remove the user."}},"required":["role_name"],"additionalProperties":true,"description":"A dictionary containing the API request fields."}}}}
```

## The SetUserRoleRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"SetUserRoleRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/SetUserRoleFilter"}},"required":["request_data"],"additionalProperties":true},"SetUserRoleFilter":{"type":"object","properties":{"user_emails":{"type":"array","items":{"type":"string"},"description":"List of one or more user emails of users you want to add to or remove from a role."},"role_name":{"type":"string","description":"Name of the role you want to add a user to. Send an empty field to remove the user."}},"required":["role_name"],"additionalProperties":true,"description":"A dictionary containing the API request fields."}}}}
```

## The UpdateCountResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"UpdateCountResponse":{"type":"object","properties":{"update_count":{"type":"integer","description":"Number of updated users."}},"required":["update_count"],"additionalProperties":true,"description":"JSON object containing the query result."}}}}
```

## The SetUserRoleResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"SetUserRoleResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/UpdateCountResponse"}},"required":["reply"],"additionalProperties":true},"UpdateCountResponse":{"type":"object","properties":{"update_count":{"type":"integer","description":"Number of updated users."}},"required":["update_count"],"additionalProperties":true,"description":"JSON object containing the query result."}}}}
```

## The AssignOrRemoveTagsFromAsmAssetsRequestFilter object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"AssignOrRemoveTagsFromAsmAssetsRequestFilter":{"type":"object","required":["field","operator","value"],"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"],"description":"Identifies the asset field the filter matches. Case-sensitive."},"operator":{"type":"string","enum":["in","contains","neq","eq","not_contains"],"description":"Comparison operator for the filter. Valid operators depend on the field:\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  - **in**: use with asm_id_list, has_active_external_services, type, business_units_list, ip_address\n"},"value":{"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}],"description":"Value depends on the filter field used.\n  - **asm_id_list**: list of asset ID strings\n  - **business_units_list**: string or list of strings in the format \"BU name\" or \"BU:BU name\"\n  - **externally_detected_providers**: string\n  - **externally_inferred_cves**: string\n  - **has_active_external_services**: list of strings (enum values: \"yes\", \"no\", \"unknown\")\n  - **has_bu_overrides**: boolean (\"true\" or \"false\")\n  - **has_xdr_agent**: string (enum values: \"yes\", \"no\")\n  - **ip_address**: list of strings\n  - **ipv6_address**: string\n  - **mac_addresses**: string\n  - **name**: string\n  - **tags**: list of strings in the format \"tag-family:tag-name\"\n  - **type**: list of strings (enum values: \"certificate\", \"cloud_compute_instance\", \"domain\", \"unassociated_responsive_ip\")\n"}}}}}}
```

## The AssignOrRemoveTagsFromAsmAssetsRequestData object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"AssignOrRemoveTagsFromAsmAssetsRequestData":{"type":"object","description":"A dictionary containing the API request fields. An empty dictionary returns all results.","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/AssignOrRemoveTagsFromAsmAssetsRequestFilter"}},"tags":{"type":"array","description":"List of tag names to add or remove. These do not need to include the tag family.","items":{"type":"string"}}}},"AssignOrRemoveTagsFromAsmAssetsRequestFilter":{"type":"object","required":["field","operator","value"],"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"],"description":"Identifies the asset field the filter matches. Case-sensitive."},"operator":{"type":"string","enum":["in","contains","neq","eq","not_contains"],"description":"Comparison operator for the filter. Valid operators depend on the field:\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  - **in**: use with asm_id_list, has_active_external_services, type, business_units_list, ip_address\n"},"value":{"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}],"description":"Value depends on the filter field used.\n  - **asm_id_list**: list of asset ID strings\n  - **business_units_list**: string or list of strings in the format \"BU name\" or \"BU:BU name\"\n  - **externally_detected_providers**: string\n  - **externally_inferred_cves**: string\n  - **has_active_external_services**: list of strings (enum values: \"yes\", \"no\", \"unknown\")\n  - **has_bu_overrides**: boolean (\"true\" or \"false\")\n  - **has_xdr_agent**: string (enum values: \"yes\", \"no\")\n  - **ip_address**: list of strings\n  - **ipv6_address**: string\n  - **mac_addresses**: string\n  - **name**: string\n  - **tags**: list of strings in the format \"tag-family:tag-name\"\n  - **type**: list of strings (enum values: \"certificate\", \"cloud_compute_instance\", \"domain\", \"unassociated_responsive_ip\")\n"}}}}}}
```

## The AssignOrRemoveTagsFromAsmAssetsRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"AssignOrRemoveTagsFromAsmAssetsRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/AssignOrRemoveTagsFromAsmAssetsRequestData"}},"required":["request_data"],"additionalProperties":true},"AssignOrRemoveTagsFromAsmAssetsRequestData":{"type":"object","description":"A dictionary containing the API request fields. An empty dictionary returns all results.","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/AssignOrRemoveTagsFromAsmAssetsRequestFilter"}},"tags":{"type":"array","description":"List of tag names to add or remove. These do not need to include the tag family.","items":{"type":"string"}}}},"AssignOrRemoveTagsFromAsmAssetsRequestFilter":{"type":"object","required":["field","operator","value"],"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"],"description":"Identifies the asset field the filter matches. Case-sensitive."},"operator":{"type":"string","enum":["in","contains","neq","eq","not_contains"],"description":"Comparison operator for the filter. Valid operators depend on the field:\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  - **in**: use with asm_id_list, has_active_external_services, type, business_units_list, ip_address\n"},"value":{"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}],"description":"Value depends on the filter field used.\n  - **asm_id_list**: list of asset ID strings\n  - **business_units_list**: string or list of strings in the format \"BU name\" or \"BU:BU name\"\n  - **externally_detected_providers**: string\n  - **externally_inferred_cves**: string\n  - **has_active_external_services**: list of strings (enum values: \"yes\", \"no\", \"unknown\")\n  - **has_bu_overrides**: boolean (\"true\" or \"false\")\n  - **has_xdr_agent**: string (enum values: \"yes\", \"no\")\n  - **ip_address**: list of strings\n  - **ipv6_address**: string\n  - **mac_addresses**: string\n  - **name**: string\n  - **tags**: list of strings in the format \"tag-family:tag-name\"\n  - **type**: list of strings (enum values: \"certificate\", \"cloud_compute_instance\", \"domain\", \"unassociated_responsive_ip\")\n"}}}}}}
```

## The AssignOrRemoveTagsFromIpRangesRequestFilter object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"AssignOrRemoveTagsFromIpRangesRequestFilter":{"type":"object","properties":{"field":{"type":"string","enum":["organization_handles","tags","business_units_list","ipaddress_version","has_bu_overrides","range_id_list"],"description":"range_id_list: indicates that the set of IP ranges will be a list of IDs."},"operator":{"type":"string","enum":["in","contains","neq","eq","not_contains"],"description":"in"},"value":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"integer"}}],"description":"List of strings, the ip range IDs that should be removed from the tag."}},"required":["field","operator","value"],"additionalProperties":true}}}}
```

## The AssignOrRemoveTagsFromIpRangesRequestData object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"AssignOrRemoveTagsFromIpRangesRequestData":{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/AssignOrRemoveTagsFromIpRangesRequestFilter"},"description":"An array of filter fields."},"tags":{"type":"array","items":{"type":"string"},"description":"Name of the tag to add to the ranges. The tag name does not need to include the tag family."}},"additionalProperties":true,"description":"A dictionary containing the API request fields. An empty dictionary returns all results."},"AssignOrRemoveTagsFromIpRangesRequestFilter":{"type":"object","properties":{"field":{"type":"string","enum":["organization_handles","tags","business_units_list","ipaddress_version","has_bu_overrides","range_id_list"],"description":"range_id_list: indicates that the set of IP ranges will be a list of IDs."},"operator":{"type":"string","enum":["in","contains","neq","eq","not_contains"],"description":"in"},"value":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"integer"}}],"description":"List of strings, the ip range IDs that should be removed from the tag."}},"required":["field","operator","value"],"additionalProperties":true}}}}
```

## The AssignOrRemoveTagsFromIpRangesRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"AssignOrRemoveTagsFromIpRangesRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/AssignOrRemoveTagsFromIpRangesRequestData"}},"required":["request_data"],"additionalProperties":true},"AssignOrRemoveTagsFromIpRangesRequestData":{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/AssignOrRemoveTagsFromIpRangesRequestFilter"},"description":"An array of filter fields."},"tags":{"type":"array","items":{"type":"string"},"description":"Name of the tag to add to the ranges. The tag name does not need to include the tag family."}},"additionalProperties":true,"description":"A dictionary containing the API request fields. An empty dictionary returns all results."},"AssignOrRemoveTagsFromIpRangesRequestFilter":{"type":"object","properties":{"field":{"type":"string","enum":["organization_handles","tags","business_units_list","ipaddress_version","has_bu_overrides","range_id_list"],"description":"range_id_list: indicates that the set of IP ranges will be a list of IDs."},"operator":{"type":"string","enum":["in","contains","neq","eq","not_contains"],"description":"in"},"value":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"integer"}}],"description":"List of strings, the ip range IDs that should be removed from the tag."}},"required":["field","operator","value"],"additionalProperties":true}}}}
```

## The IpRange object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"IpRange":{"type":"object","properties":{"from_ip":{"type":"string"},"to_ip":{"type":"string"}},"additionalProperties":true}}}}
```

## The CreateTagRulesForIpRangesRequestData object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"CreateTagRulesForIpRangesRequestData":{"type":"object","properties":{"ip_ranges":{"type":"array","items":{"$ref":"#/components/schemas/IpRange"},"description":"List of dictionaries containing \"from_ip\" and \"to_ip\" to define an IP range. These fields can be the same to denote a single IP address.<br /> For example,<br />`\"from_ip\": \"1.1.1.1\", \"to_ip\": \"1.1.1.3\"`.'\n"},"rule_name":{"type":"string","description":"Name of the tag rule. Will use `tag_name` if left empty."},"description":{"type":"string","description":"(Optional) Description of the tag rule."},"tag_name":{"type":"string","description":"Name of the tag to be used to tag assets. If a rules-based tag with the same name already exists, it will use that tag. If not, a new rules-based tag will be created."}},"required":["ip_ranges"],"additionalProperties":true,"description":"A dictionary containing the API request fields."},"IpRange":{"type":"object","properties":{"from_ip":{"type":"string"},"to_ip":{"type":"string"}},"additionalProperties":true}}}}
```

## The CreateTagRulesForIpRangesRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"CreateTagRulesForIpRangesRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/CreateTagRulesForIpRangesRequestData"}},"required":["request_data"],"additionalProperties":true},"CreateTagRulesForIpRangesRequestData":{"type":"object","properties":{"ip_ranges":{"type":"array","items":{"$ref":"#/components/schemas/IpRange"},"description":"List of dictionaries containing \"from_ip\" and \"to_ip\" to define an IP range. These fields can be the same to denote a single IP address.<br /> For example,<br />`\"from_ip\": \"1.1.1.1\", \"to_ip\": \"1.1.1.3\"`.'\n"},"rule_name":{"type":"string","description":"Name of the tag rule. Will use `tag_name` if left empty."},"description":{"type":"string","description":"(Optional) Description of the tag rule."},"tag_name":{"type":"string","description":"Name of the tag to be used to tag assets. If a rules-based tag with the same name already exists, it will use that tag. If not, a new rules-based tag will be created."}},"required":["ip_ranges"],"additionalProperties":true,"description":"A dictionary containing the API request fields."},"IpRange":{"type":"object","properties":{"from_ip":{"type":"string"},"to_ip":{"type":"string"}},"additionalProperties":true}}}}
```

## The CreateTagRulesForIpRangesResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"CreateTagRulesForIpRangesResponse":{"type":"object","properties":{"reply":{"type":"string"}},"required":["reply"],"additionalProperties":true}}}}
```

## The RemoveTagsFromAsmEntitiesReply object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"RemoveTagsFromAsmEntitiesReply":{"type":"object","properties":{"remove_tags":{"type":"string","description":"succeeded if request was successful"}},"required":["remove_tags"],"additionalProperties":true}}}}
```

## The RemoveTagsFromAsmEntitiesResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"RemoveTagsFromAsmEntitiesResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/RemoveTagsFromAsmEntitiesReply"}},"required":["reply"],"additionalProperties":true},"RemoveTagsFromAsmEntitiesReply":{"type":"object","properties":{"remove_tags":{"type":"string","description":"succeeded if request was successful"}},"required":["remove_tags"],"additionalProperties":true}}}}
```

## The UpdateVulnerabilityTestsRequestData object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"UpdateVulnerabilityTestsRequestData":{"type":"object","properties":{"test_names":{"type":"array","description":"Names of tests, for example [\"test1\", \"test2\", \"test3\"]","items":{"type":"string"}},"status":{"type":"string","enum":["enabled","disabled"]}},"additionalProperties":true}}}}
```

## The UpdateVulnerabilityTestsRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"UpdateVulnerabilityTestsRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/UpdateVulnerabilityTestsRequestData"}},"required":["request_data"],"additionalProperties":true},"UpdateVulnerabilityTestsRequestData":{"type":"object","properties":{"test_names":{"type":"array","description":"Names of tests, for example [\"test1\", \"test2\", \"test3\"]","items":{"type":"string"}},"status":{"type":"string","enum":["enabled","disabled"]}},"additionalProperties":true}}}}
```

## The UpdateVulnerabilityTestsReply object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"UpdateVulnerabilityTestsReply":{"type":"object","properties":{"bulk_update_result":{"type":"string","enum":["Success"]}},"additionalProperties":true}}}}
```

## The UpdateVulnerabilityTestsResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"UpdateVulnerabilityTestsResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/UpdateVulnerabilityTestsReply"}},"required":["reply"],"additionalProperties":true},"UpdateVulnerabilityTestsReply":{"type":"object","properties":{"bulk_update_result":{"type":"string","enum":["Success"]}},"additionalProperties":true}}}}
```

## The VulnerabilityTestFilter object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"VulnerabilityTestFilter":{"type":"object","properties":{"field":{"type":"string","enum":["name","test_names","vulnerability_ids","description","vendor_names","status","affected_software","severity_score","cwe_ids","epss_score","count_vulnerable_services"]},"operator":{"type":"string","enum":["in","contains","neq","eq","lte","gte","not_contains"],"description":"Identifies the comparison operator to use for this filter. The following list shows which operator can be used for each filter field:\n  - `name`: contains, eq, neq\n  - `status`: eq\n  - `vulnerability_ids`: contains, not_contains\n  - `description`: contains\n  - `affected_software`: contains, not_contains\n  - `cwe_ids`: contains, not_contains\n  - `vendor_names`: contains, not_contains\n  - `severity_score`: eq, neq, gte, lte\n  - `epss_score`: eq, neq, gte, lte\n  - `count_vulnerable_services`: eq, neq, gte, lte\n"},"value":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"number","format":"float"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"integer"}}],"description":"Value depends on the filter field used.\n  - `name`: string e.g. apache\n  - `status`: Enabled, Disabled\n  - `vulnerability_ids`: strings in the form of CVE IDs, such as CVE-1, CVE-2\n  - `description`: string e.g. apache\n  - `affected_software`: strings\n  - `cwe_ids`: strings in the form of CWE IDs such as CWE-20\n  - `vendor_names`: strings such as Cisco, Siemens\n  - `severity_score`: numbers, such as 2, 3.5\n  - `epss_score`: numbers, such as 2, 3.5\n  - `count_vulnerable_services`: integers, such as 1,2,5\n"}},"additionalProperties":true}}}}
```

## The VulnerabilityTestSort object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"VulnerabilityTestSort":{"type":"object","properties":{"field":{"type":"string","default":"severity_score","enum":["severity_score","created","first_published","status"]},"keyword":{"type":"string","default":"desc","enum":["ASC","asc","DESC","desc"]}},"additionalProperties":true}}}}
```

## The GetVulnerabilityTestsRequestData object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetVulnerabilityTestsRequestData":{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/VulnerabilityTestFilter"}},"search_from":{"type":"integer","default":0,"minimum":0},"search_to":{"type":"integer","default":500,"minimum":0},"sort":{"$ref":"#/components/schemas/VulnerabilityTestSort"}},"additionalProperties":true},"VulnerabilityTestFilter":{"type":"object","properties":{"field":{"type":"string","enum":["name","test_names","vulnerability_ids","description","vendor_names","status","affected_software","severity_score","cwe_ids","epss_score","count_vulnerable_services"]},"operator":{"type":"string","enum":["in","contains","neq","eq","lte","gte","not_contains"],"description":"Identifies the comparison operator to use for this filter. The following list shows which operator can be used for each filter field:\n  - `name`: contains, eq, neq\n  - `status`: eq\n  - `vulnerability_ids`: contains, not_contains\n  - `description`: contains\n  - `affected_software`: contains, not_contains\n  - `cwe_ids`: contains, not_contains\n  - `vendor_names`: contains, not_contains\n  - `severity_score`: eq, neq, gte, lte\n  - `epss_score`: eq, neq, gte, lte\n  - `count_vulnerable_services`: eq, neq, gte, lte\n"},"value":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"number","format":"float"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"integer"}}],"description":"Value depends on the filter field used.\n  - `name`: string e.g. apache\n  - `status`: Enabled, Disabled\n  - `vulnerability_ids`: strings in the form of CVE IDs, such as CVE-1, CVE-2\n  - `description`: string e.g. apache\n  - `affected_software`: strings\n  - `cwe_ids`: strings in the form of CWE IDs such as CWE-20\n  - `vendor_names`: strings such as Cisco, Siemens\n  - `severity_score`: numbers, such as 2, 3.5\n  - `epss_score`: numbers, such as 2, 3.5\n  - `count_vulnerable_services`: integers, such as 1,2,5\n"}},"additionalProperties":true},"VulnerabilityTestSort":{"type":"object","properties":{"field":{"type":"string","default":"severity_score","enum":["severity_score","created","first_published","status"]},"keyword":{"type":"string","default":"desc","enum":["ASC","asc","DESC","desc"]}},"additionalProperties":true}}}}
```

## The GetVulnerabilityTestsRequest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetVulnerabilityTestsRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/GetVulnerabilityTestsRequestData"}},"required":["request_data"],"additionalProperties":true},"GetVulnerabilityTestsRequestData":{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/VulnerabilityTestFilter"}},"search_from":{"type":"integer","default":0,"minimum":0},"search_to":{"type":"integer","default":500,"minimum":0},"sort":{"$ref":"#/components/schemas/VulnerabilityTestSort"}},"additionalProperties":true},"VulnerabilityTestFilter":{"type":"object","properties":{"field":{"type":"string","enum":["name","test_names","vulnerability_ids","description","vendor_names","status","affected_software","severity_score","cwe_ids","epss_score","count_vulnerable_services"]},"operator":{"type":"string","enum":["in","contains","neq","eq","lte","gte","not_contains"],"description":"Identifies the comparison operator to use for this filter. The following list shows which operator can be used for each filter field:\n  - `name`: contains, eq, neq\n  - `status`: eq\n  - `vulnerability_ids`: contains, not_contains\n  - `description`: contains\n  - `affected_software`: contains, not_contains\n  - `cwe_ids`: contains, not_contains\n  - `vendor_names`: contains, not_contains\n  - `severity_score`: eq, neq, gte, lte\n  - `epss_score`: eq, neq, gte, lte\n  - `count_vulnerable_services`: eq, neq, gte, lte\n"},"value":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"number","format":"float"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"integer"}}],"description":"Value depends on the filter field used.\n  - `name`: string e.g. apache\n  - `status`: Enabled, Disabled\n  - `vulnerability_ids`: strings in the form of CVE IDs, such as CVE-1, CVE-2\n  - `description`: string e.g. apache\n  - `affected_software`: strings\n  - `cwe_ids`: strings in the form of CWE IDs such as CWE-20\n  - `vendor_names`: strings such as Cisco, Siemens\n  - `severity_score`: numbers, such as 2, 3.5\n  - `epss_score`: numbers, such as 2, 3.5\n  - `count_vulnerable_services`: integers, such as 1,2,5\n"}},"additionalProperties":true},"VulnerabilityTestSort":{"type":"object","properties":{"field":{"type":"string","default":"severity_score","enum":["severity_score","created","first_published","status"]},"keyword":{"type":"string","default":"desc","enum":["ASC","asc","DESC","desc"]}},"additionalProperties":true}}}}
```

## The AffectedSoftware object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"AffectedSoftware":{"type":"object","properties":{"NAME":{"type":"string"},"VERSION_START_INCLUDING":{"type":"string"},"VERSION_START_EXCLUDING":{"type":"string"},"VERSION_END_INCLUDING":{"type":"string"},"VERSION_END_EXCLUDING":{"type":"string"},"VENDOR":{"type":"string"},"PRODUCT":{"type":"string"},"VERSION":{"type":"string"}},"additionalProperties":true}}}}
```

## The VulnerabilityTest object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"VulnerabilityTest":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"vulnerability_ids":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"status":{"type":"string"},"vendor_names":{"type":"array","items":{"type":"string"}},"affected_software":{"type":"array","items":{"$ref":"#/components/schemas/AffectedSoftware"}},"severity_score":{"type":"number"},"cwe_ids":{"type":"array","items":{"type":"string"}},"epss_score":{"type":"number"},"references":{"type":"array","items":{"type":"string"}},"remediation_guidance":{"type":"string"},"first_published":{"type":"integer"},"created":{"type":"integer"},"count_vulnerable_services":{"type":"integer"}},"additionalProperties":true},"AffectedSoftware":{"type":"object","properties":{"NAME":{"type":"string"},"VERSION_START_INCLUDING":{"type":"string"},"VERSION_START_EXCLUDING":{"type":"string"},"VERSION_END_INCLUDING":{"type":"string"},"VERSION_END_EXCLUDING":{"type":"string"},"VENDOR":{"type":"string"},"PRODUCT":{"type":"string"},"VERSION":{"type":"string"}},"additionalProperties":true}}}}
```

## The GetVulnerabilityTestsPage object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetVulnerabilityTestsPage":{"type":"object","properties":{"total_count":{"type":"integer"},"result_count":{"type":"integer"},"vulnerability_tests":{"type":"array","items":{"$ref":"#/components/schemas/VulnerabilityTest"}}},"required":["result_count","total_count"],"additionalProperties":true},"VulnerabilityTest":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"vulnerability_ids":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"status":{"type":"string"},"vendor_names":{"type":"array","items":{"type":"string"}},"affected_software":{"type":"array","items":{"$ref":"#/components/schemas/AffectedSoftware"}},"severity_score":{"type":"number"},"cwe_ids":{"type":"array","items":{"type":"string"}},"epss_score":{"type":"number"},"references":{"type":"array","items":{"type":"string"}},"remediation_guidance":{"type":"string"},"first_published":{"type":"integer"},"created":{"type":"integer"},"count_vulnerable_services":{"type":"integer"}},"additionalProperties":true},"AffectedSoftware":{"type":"object","properties":{"NAME":{"type":"string"},"VERSION_START_INCLUDING":{"type":"string"},"VERSION_START_EXCLUDING":{"type":"string"},"VERSION_END_INCLUDING":{"type":"string"},"VERSION_END_EXCLUDING":{"type":"string"},"VENDOR":{"type":"string"},"PRODUCT":{"type":"string"},"VERSION":{"type":"string"}},"additionalProperties":true}}}}
```

## The GetVulnerabilityTestsResponse object

```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"components":{"schemas":{"GetVulnerabilityTestsResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/GetVulnerabilityTestsPage"}},"required":["reply"],"additionalProperties":true},"GetVulnerabilityTestsPage":{"type":"object","properties":{"total_count":{"type":"integer"},"result_count":{"type":"integer"},"vulnerability_tests":{"type":"array","items":{"$ref":"#/components/schemas/VulnerabilityTest"}}},"required":["result_count","total_count"],"additionalProperties":true},"VulnerabilityTest":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"vulnerability_ids":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"status":{"type":"string"},"vendor_names":{"type":"array","items":{"type":"string"}},"affected_software":{"type":"array","items":{"$ref":"#/components/schemas/AffectedSoftware"}},"severity_score":{"type":"number"},"cwe_ids":{"type":"array","items":{"type":"string"}},"epss_score":{"type":"number"},"references":{"type":"array","items":{"type":"string"}},"remediation_guidance":{"type":"string"},"first_published":{"type":"integer"},"created":{"type":"integer"},"count_vulnerable_services":{"type":"integer"}},"additionalProperties":true},"AffectedSoftware":{"type":"object","properties":{"NAME":{"type":"string"},"VERSION_START_INCLUDING":{"type":"string"},"VERSION_START_EXCLUDING":{"type":"string"},"VERSION_END_INCLUDING":{"type":"string"},"VERSION_END_EXCLUDING":{"type":"string"},"VENDOR":{"type":"string"},"PRODUCT":{"type":"string"},"VERSION":{"type":"string"}},"additionalProperties":true}}}}
```


---

# 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/models.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.