GitHub v3 REST API

Check Suite Preference

object

Check suite configuration preferences for a repository.

preferencesobjectrequired
Show Child Parameters
repositoryobjectrequired

Minimal Repository

Show Child Parameters
Example

code-scanning-analysis-tool-name

string

The name of the tool used to generate the code scanning analysis.

code-scanning-analysis-tool-guid

string

The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.

code-scanning-ref

string

The full Git reference, formatted as refs/heads/<branch name>,
refs/pull/<number>/merge, or refs/pull/<number>/head.

code-scanning-alert-state

string

State of a code scanning alert.

Allowed values:opencloseddismissedfixed