Returns a list of all observables within the workspace that match the provided query.
List observables request Returns a list of observables by filters.
List observables request Returns a list of observables by filters.
The types of the observables to be retrieved.
- TYPE_ID_UNKNOWN: The observable type is unknown.
- TYPE_ID_HOSTNAME: The observable type is Hostname.
- TYPE_ID_IP_ADDRESS: The observable type is IP address.
- TYPE_ID_MAC_ADDRESS: The observable type is MAC address.
- TYPE_ID_USER_NAME: The observable type is User name.
- TYPE_ID_EMAIL_ADDRESS: The observable type is Email.
- TYPE_ID_URL: The observable type is URL.
- TYPE_ID_FILE_NAME: The observable type is File name.
- TYPE_ID_FILE_HASH: The observable type is File hash.
- TYPE_ID_PROCESS_NAME: The observable type is Process name.
- TYPE_ID_RESOURCE_UID: The observable type is Resource UID.
- TYPE_ID_OTHER: The observable type is Other.
The reputations of the observables to be retrieved.
- SCORE_UNKNOWN: The reputation score is unknown.
- SCORE_VERY_SAFE: The reputation score is Very safe.
- SCORE_SAFE: The reputation score is Safe.
- SCORE_PROBABLY_SAFE: The reputation score is Probably safe.
- SCORE_LEANS_SAFE: The reputation score is Leans safe.
- SCORE_MAY_NOT_BE_SAFE: The reputation score is May not be safe.
- SCORE_EXERCISE_CAUTION: The reputation score is Exercise caution.
- SCORE_SUSPICIOUS_OR_RISKY: The reputation score is Suspicious or risky.
- SCORE_POSSIBLY_MALICIOUS: The reputation score is Possibly malicious.
- SCORE_PROBABLY_MALICIOUS: The reputation score is Probably malicious.
- SCORE_MALICIOUS: The reputation score is Malicious.
- SCORE_OTHER: The reputation score is not mapped.
The start time for the filter.
The end time for the filter.
The start time for the filter.
The end time for the filter.
The sub types of the observables to be retrieved.
The sub type of the observable value.
- SUB_TYPE_ID_UNKNOWN: The observable sub type is unknown.
- SUB_TYPE_ID_HOSTNAME_FQDN: The observable type is Hostname and the sub type is FQDN.
- SUB_TYPE_ID_HOSTNAME_NETBIOS: The observable type is hostname and the sub type is NetBIOS.
- SUB_TYPE_ID_IP_ADDRESS_IPV4: The observable type is IP address and the sub type is IPv4.
- SUB_TYPE_ID_IP_ADDRESS_IPV6: The observable type is IP address and the sub type is IPv6.
- SUB_TYPE_ID_FILE_HASH_MD5: The observable type is File hash and the sub type is MD5.
- SUB_TYPE_ID_FILE_HASH_SHA1: The observable type is File hash and the sub type is SHA1.
- SUB_TYPE_ID_FILE_HASH_SHA256: The observable type is File hash and the sub type is SHA256.
- SUB_TYPE_ID_USERNAME_UPN: The observable type is User name and the sub type is UPN.
- SUB_TYPE_ID_USERNAME_DOMAIN: The observable type is User name and the sub type is Down-level Logon name.
- SUB_TYPE_ID_OTHER: The observable type is Other.
Search term to filter observables by value. This will search across all observable value fields.
The maximum number of observables to retrieve per page. Default is 100. Maximum is 500. If the number of results exceeds the defined page size, use pagination to retrieve the next page of results.
The token received from a previous List observables request. Provide this to retrieve the next page of results.
The order in which to sort the results. The possible values are: asc (ascending), desc (descending). Default is desc.
The criteria by which to sort the results. The possible values are: type, sub_type, reputation, first_seen, last_seen, case_count. Default is first_seen.
A successful response.
The list of observables.
The unique identifier of the observable. This field value is automatically generated and shouldn't be provided when creating or updating an observable.
The observable value type is unknown. Only applicable when the observable type is TYPE_ID_UNKNOWN.
The observable value is a hostname. Only applicable when the observable type is TYPE_ID_HOSTNAME. The hostname represents a unique name assigned to a device connected to a computer network, as defined by RFC 1034.
The observable value is an IP address. Only applicable when the observable type is TYPE_ID_IP_ADDRESS. An IP address is an Internet Protocol address, in either IPv4 or IPv6 format.
The observable value is a MAC (media access control) address. Only applicable when the observable type is TYPE_ID_MAC_ADDRESS.
The observable value is a user name. Only applicable when the observable type is TYPE_ID_USER_NAME.
The observable value is an email. Only applicable when the observable type is TYPE_ID_EMAIL_ADDRESS. The email address is validated with RFC 5322.
The observable value is a URL (Uniform Resource Locator). Only applicable when the observable type is TYPE_ID_URL.
The observable value is a file name. Only applicable when the observable type is TYPE_ID_FILE_NAME.
The observable value is a file hash. Only applicable when the observable type is TYPE_ID_FILE_HASH.
The observable value is a process name. Only applicable when the observable type is TYPE_ID_PROCESS_NAME.
The observable value is a resource UID. Only applicable when the observable type is TYPE_ID_RESOURCE_UID. Examples: S3 bucket name or an EC2 instance ID.
The observable value type is Other. Only applicable when the observable type is TYPE_ID_OTHER.
- TYPE_ID_UNKNOWN: The observable type is unknown.
- TYPE_ID_HOSTNAME: The observable type is Hostname.
- TYPE_ID_IP_ADDRESS: The observable type is IP address.
- TYPE_ID_MAC_ADDRESS: The observable type is MAC address.
- TYPE_ID_USER_NAME: The observable type is User name.
- TYPE_ID_EMAIL_ADDRESS: The observable type is Email.
- TYPE_ID_URL: The observable type is URL.
- TYPE_ID_FILE_NAME: The observable type is File name.
- TYPE_ID_FILE_HASH: The observable type is File hash.
- TYPE_ID_PROCESS_NAME: The observable type is Process name.
- TYPE_ID_RESOURCE_UID: The observable type is Resource UID.
- TYPE_ID_OTHER: The observable type is Other.
The name of the observable type. The name is automatically derived from the type ID.
- SCORE_UNKNOWN: The reputation score is unknown.
- SCORE_VERY_SAFE: The reputation score is Very safe.
- SCORE_SAFE: The reputation score is Safe.
- SCORE_PROBABLY_SAFE: The reputation score is Probably safe.
- SCORE_LEANS_SAFE: The reputation score is Leans safe.
- SCORE_MAY_NOT_BE_SAFE: The reputation score is May not be safe.
- SCORE_EXERCISE_CAUTION: The reputation score is Exercise caution.
- SCORE_SUSPICIOUS_OR_RISKY: The reputation score is Suspicious or risky.
- SCORE_POSSIBLY_MALICIOUS: The reputation score is Possibly malicious.
- SCORE_PROBABLY_MALICIOUS: The reputation score is Probably malicious.
- SCORE_MALICIOUS: The reputation score is Malicious.
- SCORE_OTHER: The reputation score is not mapped.
The reputation name. The name is automatically derived from the reputation ID.
The time when the observable was first observed. This field value is automatically generated and shouldn't be provided when creating or updating an observable.
The time when the observable was last observed. This field value is automatically generated and shouldn't be provided when creating or updating an observable.
The observable description.
The sub type of the observable value.
- SUB_TYPE_ID_UNKNOWN: The observable sub type is unknown.
- SUB_TYPE_ID_HOSTNAME_FQDN: The observable type is Hostname and the sub type is FQDN.
- SUB_TYPE_ID_HOSTNAME_NETBIOS: The observable type is hostname and the sub type is NetBIOS.
- SUB_TYPE_ID_IP_ADDRESS_IPV4: The observable type is IP address and the sub type is IPv4.
- SUB_TYPE_ID_IP_ADDRESS_IPV6: The observable type is IP address and the sub type is IPv6.
- SUB_TYPE_ID_FILE_HASH_MD5: The observable type is File hash and the sub type is MD5.
- SUB_TYPE_ID_FILE_HASH_SHA1: The observable type is File hash and the sub type is SHA1.
- SUB_TYPE_ID_FILE_HASH_SHA256: The observable type is File hash and the sub type is SHA256.
- SUB_TYPE_ID_USERNAME_UPN: The observable type is User name and the sub type is UPN.
- SUB_TYPE_ID_USERNAME_DOMAIN: The observable type is User name and the sub type is Down-level Logon name.
- SUB_TYPE_ID_OTHER: The observable type is Other.
The name of the observable sub type. The name is automatically derived from the sub type ID.
The observable enrichment data in JSON format.
The number of cases that this observable is associated with.
The timestamp of when the observable was last updated. This value is automatically generated.
The timestamp of when the observable enrichment field was last updated. This value is automatically generated.
The timestamp of when the observable was deleted.
ThreatIntel represents the complete threat intelligence data for an observable.
DetectionInfo represents aggregated detection information from multiple vendors.
Verdict represents a threat intel verdict with an ID and name.
VerdictID represents the verdict classification for a threat intel detection.
- VERDICT_ID_UNSPECIFIED: The verdict is unspecified.
- VERDICT_ID_UNKNOWN: The verdict is unknown.
- VERDICT_ID_KNOWN: The observable is known and not malicious.
- VERDICT_ID_SUSPICIOUS: The observable is suspicious.
- VERDICT_ID_MALICIOUS: The observable is malicious.
The name of the verdict, automatically derived from the verdict ID.
The number of vendors that flagged the observable as malicious.
The total number of vendors that scanned the observable.
The time when the observable was last scanned.
The list of vendor detections.
VendorDetection represents a detection result from a specific vendor.
The name of the vendor.
Verdict represents a threat intel verdict with an ID and name.
VerdictID represents the verdict classification for a threat intel detection.
- VERDICT_ID_UNSPECIFIED: The verdict is unspecified.
- VERDICT_ID_UNKNOWN: The verdict is unknown.
- VERDICT_ID_KNOWN: The observable is known and not malicious.
- VERDICT_ID_SUSPICIOUS: The observable is suspicious.
- VERDICT_ID_MALICIOUS: The observable is malicious.
The name of the verdict, automatically derived from the verdict ID.
Additional metadata from the vendor.
The time when the vendor last updated the detection.
IPThreatIntel represents IP-specific threat intelligence data.
The Autonomous System Number.
The owner of the ASN (e.g. "MICROSOFT-CORP-MSN-AS-BLOCK").
The country where the IP is located.
The last time the IP was seen by threat intel sources.
WHOISInfo represents WHOIS registration data as flexible key-value pairs.
Key-value pairs of WHOIS fields (e.g. NetRange, CIDR, Organization, RegDate).
The time when the WHOIS record was last updated.
DomainThreatIntel represents domain-specific threat intelligence data.
The categories assigned to the domain by threat intel sources.
DNSInfo represents DNS record information for a domain.
The A records (IPv4 addresses).
The NS records (name servers).
The MX records (mail exchange).
The time when DNS records were last updated.
The last time the domain was seen by threat intel sources.
WHOISInfo represents WHOIS registration data as flexible key-value pairs.
Key-value pairs of WHOIS fields (e.g. NetRange, CIDR, Organization, RegDate).
The time when the WHOIS record was last updated.
URLThreatIntel represents URL-specific threat intelligence data.
The categories assigned to the URL by threat intel sources.
The threat classification name.
The reason for the threat classification.
The last time the URL was seen by threat intel sources.
HashThreatIntel represents file hash-specific threat intelligence data.
The malware family name (e.g. "Trojan.Cobalt_Strike/Beacon").
FileInfo represents file metadata for a hash observable.
The file type (e.g. "PE32 executable (DLL)").
The size of the file in bytes.
The known file names associated with this hash.
SignatureInfo represents digital signature information for a file.
SignatureStatus represents a digital signature status with an ID and name.
SignatureStatusID represents the status of a digital signature.
- SIGNATURE_STATUS_ID_UNSPECIFIED: The signature status is unspecified.
- SIGNATURE_STATUS_ID_UNSIGNED: The file is unsigned.
- SIGNATURE_STATUS_ID_VALID: The signature is valid.
- SIGNATURE_STATUS_ID_INVALID: The signature is invalid.
- SIGNATURE_STATUS_ID_EXPIRED: The signature has expired.
The name of the signature status, automatically derived from the status ID.
The entity that signed the file.
The timestamp when the threat intelligence data was last updated.
When a token is returned it indicates there is another page of results to retrieve.
Pass this token in the page_token parameter in a subsequent List observables request to retrieve the next page of results.
If this field isn't returned it means there are no additional pages to retrieve.
Invalid bearer token. If you receive this message more than once try creating a new Client ID/Client Secret or generating a new bearer token.
You don't have permission to access this resource.