Package types (1.11.0)

API documentation for webrisk_v1.types package.

Classes

CompressionType

The ways in which threat entry sets can be compressed.

Values: COMPRESSION_TYPE_UNSPECIFIED (0): Unknown. RAW (1): Raw, uncompressed data. RICE (2): Rice-Golomb encoded data.

ComputeThreatListDiffRequest

Describes an API diff request.

ComputeThreatListDiffResponse

CreateSubmissionRequest

Request to send a potentially phishy URI to WebRisk.

RawHashes

The uncompressed threat entries in hash format. Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4 bytes, but some hashes are lengthened if they collide with the hash of a popular URI.

Used for sending ThreatEntryAdditons to clients that do not support compression, or when sending non-4-byte hashes to clients that do support compression.

RawIndices

A set of raw indices to remove from a local list.

RiceDeltaEncoding

The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or compressed removal indices.

SearchHashesRequest

Request to return full hashes matched by the provided hash prefixes.

SearchHashesResponse

SearchUrisRequest

Request to check URI entries against threatLists.

SearchUrisResponse

Submission

Wraps a URI that might be displaying malicious content.

ThreatEntryAdditions

Contains the set of entries to add to a local database. May contain a combination of compressed and raw data in a single response.

ThreatEntryRemovals

Contains the set of entries to remove from a local database.

ThreatType

The type of threat. This maps directly to the threat list a threat may belong to.

Values: THREAT_TYPE_UNSPECIFIED (0): No entries should match this threat type. This threat type is unused. MALWARE (1): Malware targeting any platform. SOCIAL_ENGINEERING (2): Social engineering targeting any platform. UNWANTED_SOFTWARE (3): Unwanted software targeting any platform. SOCIAL_ENGINEERING_EXTENDED_COVERAGE (4): A list of extended coverage social engineering URIs targeting any platform.