vulnerability_alerts

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

Overview

Name	vulnerability_alerts
Type	Resource
Id	github.repos.vulnerability_alerts

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
check_vulnerability_alerts	exec	owner, repo		Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "About security alerts for vulnerable dependencies".
enable_vulnerability_alerts	exec	owner, repo		Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "About security alerts for vulnerable dependencies".
disable_vulnerability_alerts	exec	owner, repo		Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "About security alerts for vulnerable dependencies".

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.

Lifecycle Methods

check_vulnerability_alerts

Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "About security alerts for vulnerable dependencies".

EXEC github.repos.vulnerability_alerts.check_vulnerability_alerts 
@owner='{{ owner }}' --required, 
@repo='{{ repo }}' --required
;

enable_vulnerability_alerts

Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "About security alerts for vulnerable dependencies".

EXEC github.repos.vulnerability_alerts.enable_vulnerability_alerts 
@owner='{{ owner }}' --required, 
@repo='{{ repo }}' --required
;

disable_vulnerability_alerts

Disables dependency alerts and the dependency graph for a repository.
The authenticated user must have admin access to the repository. For more information,
see "About security alerts for vulnerable dependencies".

EXEC github.repos.vulnerability_alerts.disable_vulnerability_alerts 
@owner='{{ owner }}' --required, 
@repo='{{ repo }}' --required
;