Console
    Contact Us Start free

    Method: projects.keys.listIpOverrides

    Lists all IP overrides for a key.

    HTTP request

    GET https://recaptchaenterprise.googleapis.com/v1/{parent=projects/*/keys/*}:listIpOverrides

    The URL uses gRPC Transcoding syntax.

    Path parameters

    Parameters
    parent

    string

    Required. The parent key for which the IP overrides are listed, in the format projects/{project}/keys/{key} .

    Query parameters

    Parameters
    pageSize

    integer

    Optional. The maximum number of overrides to return. Default is 10. Max limit is 100. If the number of overrides is less than the pageSize, all overrides are returned. If the page size is more than 100, it is coerced to 100.
    pageToken

    string

    Optional. The nextPageToken value returned from a previous ListIpOverridesRequest, if any.

    Request body

    The request body must be empty.

    Response body

    Response for keys.listIpOverrides.

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

    JSON representation 
     { 
 "ipOverrides" 
 : 
 [ 
 { 
 object (  IpOverrideData 
 
) 
 } 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 }
    Fields
    ipOverrides[]

    object ( IpOverrideData )

    IP Overrides details.
    nextPageToken

    string

    Token to retrieve the next page of results. If this field is empty, no keys remain in the results.

    Authorization scopes

    Requires the following OAuth scope:

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

    For more information, see the Authentication Overview .

    IAM Permissions

    Requires the following IAM permission on the parent resource:

    • recaptchaenterprise.keys.get

    For more information, see the IAM documentation .
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: