Skip to main content

keys_ip_overrides

Creates, updates, deletes, gets or lists a keys_ip_overrides resource.

Overview

Namekeys_ip_overrides
TypeResource
Idgoogle.recaptchaenterprise.keys_ip_overrides

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
ipstringRequired. The IP address to override (can be IPv4, IPv6 or CIDR). The IP override must be a valid IPv4 or IPv6 address, or a CIDR range. The IP override must be a public IP address. Example of IPv4: 168.192.5.6 Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B Example of IPv4 with CIDR: 168.192.5.0/24 Example of IPv6 with CIDR: 2001:0DB8🔢:/48
overrideTypestringRequired. Describes the type of IP override.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_ip_overridesselectprojectsId, keysIdpageSize, pageTokenLists all IP overrides for a key.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
keysIdstring
projectsIdstring
pageSizeinteger (int32)
pageTokenstring

SELECT examples

Lists all IP overrides for a key.

SELECT
ip,
overrideType
FROM google.recaptchaenterprise.keys_ip_overrides
WHERE projectsId = '{{ projectsId }}' -- required
AND keysId = '{{ keysId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';