Safe Browsing API (safebrowsing:v5)

2025-05-23

3 new methods

Additions

    Methods
  • safebrowsing.hashLists.list

      Description : List hash lists. In the V5 API, Google will never remove a hash list that has ever been returned by this method. This enables clients to skip using this method and simply hard-code all hash lists they need. This is a standard List method as defined by https://google.aip.dev/132 and the HTTP method is GET.

      Parameters :

        pageSize

          Format : int32

          Type : integer

          Location : query

          Description : The maximum number of hash lists to return. The service may return fewer than this value. If unspecified, the server will choose a page size, which may be larger than the number of hash lists so that pagination is not necessary.

        pageToken

          Description : A page token, received from a previous `ListHashLists` call. Provide this to retrieve the subsequent page.

          Location : query

          Type : string

      Path : v5/hashLists

      Flat Path : v5/hashLists

      HTTP Method : GET

  • safebrowsing.hashLists.batchGet

      Flat Path : v5/hashLists:batchGet

      Parameters :

        names

          Location : query

          Description : Required. The names of the particular hash lists. The list MAY be a threat list, or it may be the Global Cache. The names MUST NOT contain duplicates; if they did, the client will get an error.

          Repeated : Yes

          Type : string

        sizeConstraints.maxUpdateEntries

          Location : query

          Format : int32

          Type : integer

          Description : The maximum size in number of entries. The update will not contain more entries than this value, but it is possible that the update will contain fewer entries than this value. This MUST be at least 1024. If omitted or zero, no update size limit is set.

        sizeConstraints.maxDatabaseEntries

          Type : integer

          Description : Sets the maximum number of entries that the client is willing to have in the local database for the list. (The server MAY cause the client to store less than this number of entries.) If omitted or zero, no database size limit is set.

          Location : query

          Format : int32

        version

          Description : The versions of the hash list that the client already has. If this is the first time the client is fetching the hash lists, the field should be left empty. Otherwise, the client should supply the versions previously received from the server. The client MUST NOT manipulate those bytes. The client need not send the versions in the same order as the corresponding list names. The client may send fewer or more versions in a request than there are names. However the client MUST NOT send multiple versions that correspond to the same name; if it did, the client will get an error. Historical note: in V4 of the API, this was called `states`; it is now renamed to `version` for clarity.

          Location : query

          Type : string

          Repeated : Yes

          Format : byte

      Description : Get multiple hash lists at once. It is very common for a client to need to get multiple hash lists. Using this method is preferred over using the regular Get method multiple times. This is a standard batch Get method as defined by https://google.aip.dev/231 and the HTTP method is also GET.

      Path : v5/hashLists:batchGet

      HTTP Method : GET

  • safebrowsing.hashList.get

      Flat Path : v5/hashList/{name}

      Path : v5/hashList/{name}

      Description : Get the latest contents of a hash list. A hash list may either by a threat list or a non-threat list such as the Global Cache. This is a standard Get method as defined by https://google.aip.dev/131 and the HTTP method is also GET.

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The name of this particular hash list. It may be a threat list, or it may be the Global Cache.

          Location : path

          Type : string

          Required : Yes

        version

          Format : byte

          Location : query

          Description : The version of the hash list that the client already has. If this is the first time the client is fetching the hash list, this field MUST be left empty. Otherwise, the client SHOULD supply the version previously received from the server. The client MUST NOT manipulate those bytes. **What's new in V5**: in V4 of the API, this was called `states`; it is now renamed to `version` for clarity.

          Type : string

        sizeConstraints.maxUpdateEntries

          Format : int32

          Description : The maximum size in number of entries. The update will not contain more entries than this value, but it is possible that the update will contain fewer entries than this value. This MUST be at least 1024. If omitted or zero, no update size limit is set.

          Type : integer

          Location : query

        sizeConstraints.maxDatabaseEntries

          Type : integer

          Location : query

          Format : int32

          Description : Sets the maximum number of entries that the client is willing to have in the local database for the list. (The server MAY cause the client to store less than this number of entries.) If omitted or zero, no database size limit is set.

      Parameter Order : name