secret-scanning-alert

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
number	object
created_at	object
updated_at	object
url	object
html_url	object
locations_url	string	The REST API URL of the code locations for this alert.
state	object
resolution	object
resolved_at	string	The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
resolved_by	object
resolution_comment	string	An optional comment to resolve an alert.
secret_type	string	The type of secret that secret scanning detected.
secret_type_display_name	string	User-friendly name for the detected secret, matching the `secret_type`. For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/[email protected]/code-security/sec
secret	string	The secret that was detected.
push_protection_bypassed	boolean	Whether push protection was bypassed for the detected secret.
push_protection_bypassed_by	object
push_protection_bypassed_at	string	The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/secret-scanning-alert",
  "title": "secret-scanning-alert",
  "type": "object",
  "properties": {
    "number": {
      "$ref": "#/components/schemas/alert-number"
    },
    "created_at": {
      "$ref": "#/components/schemas/alert-created-at"
    },
    "updated_at": {
      "$ref": "#/components/schemas/nullable-alert-updated-at"
    },
    "url": {
      "$ref": "#/components/schemas/alert-url"
    },
    "html_url": {
      "$ref": "#/components/schemas/alert-html-url"
    },
    "locations_url": {
      "type": "string",
      "format": "uri",
      "description": "The REST API URL of the code locations for this alert."
    },
    "state": {
      "$ref": "#/components/schemas/secret-scanning-alert-state"
    },
    "resolution": {
      "$ref": "#/components/schemas/secret-scanning-alert-resolution"
    },
    "resolved_at": {
      "type": "string",
      "format": "date-time",
      "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
      "nullable": true
    },
    "resolved_by": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "resolution_comment": {
      "type": "string",
      "description": "An optional comment to resolve an alert.",
      "nullable": true
    },
    "secret_type": {
      "type": "string",
      "description": "The type of secret that secret scanning detected."
    },
    "secret_type_display_name": {
      "type": "string",
      "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/[email protected]/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\""
    },
    "secret": {
      "type": "string",
      "description": "The secret that was detected."
    },
    "push_protection_bypassed": {
      "type": "boolean",
      "description": "Whether push protection was bypassed for the detected secret.",
      "nullable": true
    },
    "push_protection_bypassed_by": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "push_protection_bypassed_at": {
      "type": "string",
      "format": "date-time",
      "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
      "nullable": true
    }
  }
}