API documentation for webrisk_v1.types module.
Classes
ComputeThreatListDiffRequest
Describes an API diff request.
The current version token of the client for the requested list (the client version that was received from the last successful diff). If the client does not have a version token (this is the first time calling ComputeThreatListDiff), this may be left empty and a full database snapshot will be returned.
ComputeThreatListDiffResponse
A set of entries to add to a local threat type’s list.
The new opaque client version token. This should be retained by the client and passed into the next call of ComputeThreatListDiff as ‘version_token’. A separate version token should be stored and used for each threatList.
The soonest the client should wait before issuing any diff request. Querying sooner is unlikely to produce a meaningful diff. Waiting longer is acceptable considering the use case. If this field is not set clients may update as soon as they want.
CreateSubmissionRequest
Request to send a potentially phishy URI to WebRisk.
Required. The submission that contains the content of the phishing report.
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.
The hashes, in binary format, concatenated into one long string. Hashes are sorted in lexicographic order. For JSON API users, hashes are base64-encoded.
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.
The Golomb-Rice parameter, which is a number between 2 and 28.
This field is missing (that is, zero) if num_entries is
zero.
The encoded deltas that are encoded using the Golomb-Rice coder.
SearchHashesRequest
Request to return full hashes matched by the provided hash prefixes.
Required. The ThreatLists to search in. Multiple ThreatLists may be specified.
SearchHashesResponse
For requested entities that did not match the threat list, how long to cache the response until.
SearchUrisRequest
Request to check URI entries against threatLists.
Required. The ThreatLists to search in. Multiple ThreatLists may be specified.
SearchUrisResponse
Submission
Wraps a URI that might be displaying phishing 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.
The encoded 4-byte prefixes of SHA256-formatted entries, using a Golomb-Rice encoding. The hashes are converted to uint32, sorted in ascending order, then delta encoded and stored as encoded_data.
ThreatEntryRemovals
Contains the set of entries to remove from a local database.
The encoded local, lexicographically-sorted list indices, using a Golomb-Rice encoding. Used for sending compressed removal indices. The removal indices (uint32) are sorted in ascending order, then delta encoded and stored as encoded_data.
Timestamp
API documentation for webrisk_v1.types.Timestamp class.