Github API - Test Config

secret-scanning-alert [object]

Attributes
created_at alert-created-at

alert-created-at [scalar]

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

API:
Github Open API
(version: 1.1.4)

html_url alert-html-url

alert-html-url [scalar]

The GitHub URL of the alert resource.

API:
Github Open API
(version: 1.1.4)

locations_url string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

The REST API URL of the code locations for this alert.

number alert-number

alert-number [scalar]

The security alert number.

API:
Github Open API
(version: 1.1.4)

push_protection_bypassed boolean

boolean [scalar]

The OpenAPI boolean type

API:
Github Open API
(version: 1.1.4)

Whether push protection was bypassed for the detected secret.

push_protection_bypassed_at string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

push_protection_bypassed_by nullable-simple-user

nullable-simple-user [object]

A GitHub user.

Attributes
avatar_url string

email string

events_url string

followers_url string

following_url string

gists_url string

gravatar_id string

html_url string

id integer

login string

name string

node_id string

organizations_url string

received_events_url string

repos_url string

site_admin boolean

starred_at string

starred_url string

subscriptions_url string

type string

url string

API:
Github Open API
(version: 1.1.4)

resolution secret-scanning-alert-resolution

secret-scanning-alert-resolution [scalar]

Required when the state is resolved. The reason for resolving the alert.

API:
Github Open API
(version: 1.1.4)

resolution_comment string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

An optional comment to resolve an alert.

resolved_at string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

resolved_by nullable-simple-user

nullable-simple-user [object]

A GitHub user.

Attributes
avatar_url string

email string

events_url string

followers_url string

following_url string

gists_url string

gravatar_id string

html_url string

id integer

login string

name string

node_id string

organizations_url string

received_events_url string

repos_url string

site_admin boolean

starred_at string

starred_url string

subscriptions_url string

type string

url string

API:
Github Open API
(version: 1.1.4)

secret string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

The secret that was detected.

secret_type string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

The type of secret that secret scanning detected.

secret_type_display_name string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

User-friendly name for the detected secret, matching the secret_type.
For a list of built-in patterns, see "Secret scanning patterns."

state secret-scanning-alert-state

secret-scanning-alert-state [scalar]

Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.

API:
Github Open API
(version: 1.1.4)

updated_at nullable-alert-updated-at

nullable-alert-updated-at [scalar]

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

API:
Github Open API
(version: 1.1.4)

url alert-url

alert-url [scalar]

The REST API URL of the alert resource.

API:
Github Open API
(version: 1.1.4)

API:
Github Open API
(version: 1.1.4)