G
GithubApi
Arcade Native

GetGithubSecretScanningAlert

GithubApi.GetGithubSecretScanningAlert

Arcade Native Built and maintained by Arcade with full support
Supported by Arcade

Description

Retrieve a specific secret scanning alert from a GitHub repository.

Use this tool to obtain details of a secret scanning alert detected in a GitHub repository. This requires administrative access to the repository or organization, and an appropriate personal access token. It also supports GitHub Apps with specific read permissions.

Input Parameters

{
  "parameters": [
    {
      "name": "alert_identifier",
      "required": true,
      "inferrable": true,
      "description": "The unique integer number identifying a GitHub secret scanning alert. This is found at the URL's end for the alert or in the `number` field of the alert response.",
      "value_schema": {
        "val_type": "integer"
      }
    },
    {
      "name": "repository_name",
      "required": true,
      "inferrable": true,
      "description": "The case-insensitive name of the repository from which to retrieve the secret scanning alert.",
      "value_schema": {
        "val_type": "string"
      }
    },
    {
      "name": "repository_owner",
      "required": true,
      "inferrable": true,
      "description": "The username of the account owner for the repository. Case insensitive.",
      "value_schema": {
        "val_type": "string"
      }
    }
  ]
}

Output

{
  "description": "Response from the API endpoint 'secret-scanning/get-alert'.",
  "value_schema": {
    "val_type": "json"
  },
  "available_modes": [
    "value",
    "error"
  ]
}