firewall_bypass

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

Overview

Name	firewall_bypass
Type	Resource
Id	vercel.security.firewall_bypass

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
id	string	(wire: Id)
actor_id	string	(wire: ActorId)
owner_id	string	(wire: OwnerId)
project_id	string	(wire: ProjectId)
action	string	(block, bypass) (wire: Action)
created_at	string	(wire: CreatedAt)
deleted_at	string	(wire: DeletedAt)
domain	string	(wire: Domain)
expires_at	number	(wire: ExpiresAt)
ip	string	(wire: Ip)
is_project_rule	boolean	(false, true) (wire: IsProjectRule)
note	string	(wire: Note)
updated_at	string	(wire: UpdatedAt)
updated_at_hour	string	(wire: UpdatedAtHour)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	project_id	limit, source_ip, domain, project_scope, offset, team_id, slug	Retrieve the system bypass rules configured for the specified project
create	insert	project_id, domain, project_scope	team_id, slug	Create new system bypass rules
delete	delete	project_id	team_id, slug	Remove system bypass rules

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
project_id	string	(wire: projectId)
domain	string	Filter by domain
limit	number
offset	string	Used for pagination. Retrieves results after the provided id
project_scope	boolean	Filter by project scoped rules (wire: projectScope)
slug	string	The Team slug to perform the request on behalf of.
source_ip	string	Filter by source IP (wire: sourceIp)
team_id	string	The Team identifier to perform the request on behalf of. (wire: teamId)

SELECT examples

list

Retrieve the system bypass rules configured for the specified project

SELECT
id,
actor_id,
owner_id,
project_id,
action,
created_at,
deleted_at,
domain,
expires_at,
ip,
is_project_rule,
note,
updated_at,
updated_at_hour
FROM vercel.security.firewall_bypass
WHERE project_id = '{{ project_id }}' -- required
AND limit = '{{ limit }}'
AND source_ip = '{{ source_ip }}'
AND domain = '{{ domain }}'
AND project_scope = '{{ project_scope }}'
AND offset = '{{ offset }}'
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;

INSERT examples

create

Create new system bypass rules

INSERT INTO vercel.security.firewall_bypass (
domain,
project_scope,
source_ip,
all_sources,
ttl,
note,
project_id,
team_id,
slug
)
SELECT 
'{{ domain }}' /* required */,
{{ project_scope }} /* required */,
'{{ source_ip }}',
{{ all_sources }},
{{ ttl }},
'{{ note }}',
'{{ project_id }}',
'{{ team_id }}',
'{{ slug }}'
RETURNING
ok,
pagination,
result
;

Manifest

# Description fields are for documentation purposes
- name: firewall_bypass
props:
  - name: project_id
    value: "{{ project_id }}"
    description: Required parameter for the firewall_bypass resource.
  - name: domain
    value: "{{ domain }}"
  - name: project_scope
    value: {{ project_scope }}
    description: |
      If the specified bypass will apply to all domains for a project.
  - name: source_ip
    value: "{{ source_ip }}"
  - name: all_sources
    value: {{ all_sources }}
  - name: ttl
    value: {{ ttl }}
    description: |
      Time to live in milliseconds
  - name: note
    value: "{{ note }}"
  - name: team_id
    value: "{{ team_id }}"
    description: The Team identifier to perform the request on behalf of.
    description: The Team identifier to perform the request on behalf of.
  - name: slug
    value: "{{ slug }}"
    description: The Team slug to perform the request on behalf of.
    description: The Team slug to perform the request on behalf of.

DELETE examples

delete

Remove system bypass rules

DELETE FROM vercel.security.firewall_bypass
WHERE project_id = '{{ project_id }}' --required
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;