Method: evaluateUri

This method is used to evaluate how malicious a URI is according to given threat types. Multiple threat types may be searched in a single query. The response will list a confidence level for all requested threat types (currently only for the SOCIAL_ENGINEERING threat type) representing how much the URI is predicted to be malicious.

HTTP request

POST https://webrisk.googleapis.com/v1eap1:evaluateUri

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "uri": string,
  "threatTypes": [
    enum (ThreatType)
  ],
  "allowScan": boolean
}
Fields
uri

string

Required. The URI to be evaluated.
threatTypes[]

enum (ThreatType)

Required. The threat types to evaluate against.
allowScan

boolean

Whether the caller would like to allow this method to scan the provided URI.

Response body

If successful, the response body contains data with the following structure:

Response type for requests to evaluate URIs.

JSON representation 
{
  "scores": [
    {
      object (Score)
    }
  ]
}
Fields
scores[]

object (Score)

Evaluation scores per threat type given.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ThreatType

The type of threat.

Enums
THREAT_TYPE_UNSPECIFIED Default type that indicates this enum hasn't been specified. This is not a valid ThreatType, one of the other types must be specified instead.
SOCIAL_ENGINEERING Social engineering targeting any platform.

Score

Score of a URI, represented as a ConfidenceLevel for every threat type given.

JSON representation 
{
  "threatType": enum (ThreatType),
  "confidenceLevel": enum (ConfidenceLevel)
}
Fields
threatType

enum (ThreatType)

Threat type associated with this score.
confidenceLevel

enum (ConfidenceLevel)

Confidence level according to the given threat type.

ConfidenceLevel

Confidence level in how risky a URI is predicted to be.

Enums
CONFIDENCE_LEVEL_UNSPECIFIED Default type that indicates this enum hasn't been specified. This is not a valid ConfidenceLevel, another type must be specified instead.
SAFE URIs that are considered as safe.
LOW Low confidence that the URI given is risky for this threat type.
MEDIUM Medium confidence that the URI given is risky for this threat type.
HIGH High confidence that the URI given is risky for this threat type.
VERY_HIGH Very high confidence that the URI given is risky for this threat type.
EXTREMELY_HIGH Extremely high confidence that the URI given is risky for this threat type.