repo_push_protection_bypasses

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

Overview

Name	repo_push_protection_bypasses
Type	Resource
Id	github.secret_scanning.repo_push_protection_bypasses

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
create_push_protection_bypass	insert	owner, repo, reason, placeholder_id		Creates a bypass for a previously push protected secret. The authenticated user must be the original author of the committed secret. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

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
owner	string	The account owner of the repository. The name is not case sensitive.
repo	string	The name of the repository without the .git extension. The name is not case sensitive.

INSERT examples

create_push_protection_bypass

Creates a bypass for a previously push protected secret.

The authenticated user must be the original author of the committed secret.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

INSERT INTO github.secret_scanning.repo_push_protection_bypasses (
reason,
placeholder_id,
owner,
repo
)
SELECT 
'{{ reason }}' /* required */,
'{{ placeholder_id }}' /* required */,
'{{ owner }}',
'{{ repo }}'
RETURNING
expire_at,
reason,
token_type
;

Manifest

# Description fields are for documentation purposes
- name: repo_push_protection_bypasses
props:
  - name: owner
    value: "{{ owner }}"
    description: Required parameter for the repo_push_protection_bypasses resource.
  - name: repo
    value: "{{ repo }}"
    description: Required parameter for the repo_push_protection_bypasses resource.
  - name: reason
    value: "{{ reason }}"
    description: |
      The reason for bypassing push protection.
    valid_values: ['false_positive', 'used_in_tests', 'will_fix_later']
  - name: placeholder_id
    value: "{{ placeholder_id }}"
    description: |
      The ID of the push protection bypass placeholder. This value is returned on any push protected routes.