keys_ip_override

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

Overview

Name	keys_ip_override
Type	Resource
Id	google.recaptchaenterprise.keys_ip_override

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
add_ip_override	insert	projectsId, keysId		Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 1000. * For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.
remove_ip_override	delete	projectsId, keysId		Removes an IP override from a key. The following restrictions hold: * If the IP isn't found in an existing IP override, a NOT_FOUND error is returned. * If the IP is found in an existing IP override, but the override type does not match, a NOT_FOUND error is returned.

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.

Name	Datatype	Description
keysId	string
projectsId	string

INSERT examples

add_ip_override

Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 1000. * For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.

INSERT INTO google.recaptchaenterprise.keys_ip_override (
data__ipOverrideData,
projectsId,
keysId
)
SELECT 
'{{ ipOverrideData }}',
'{{ projectsId }}',
'{{ keysId }}'
;

Manifest

# Description fields are for documentation purposes
- name: keys_ip_override
  props:
    - name: projectsId
      value: string
      description: Required parameter for the keys_ip_override resource.
    - name: keysId
      value: string
      description: Required parameter for the keys_ip_override resource.
    - name: ipOverrideData
      value: object
      description: >
        Required. IP override added to the key.
        

DELETE examples

remove_ip_override

Removes an IP override from a key. The following restrictions hold: * If the IP isn't found in an existing IP override, a NOT_FOUND error is returned. * If the IP is found in an existing IP override, but the override type does not match, a NOT_FOUND error is returned.

DELETE FROM google.recaptchaenterprise.keys_ip_override
WHERE projectsId = '{{ projectsId }}' --required
AND keysId = '{{ keysId }}' --required;