Puntos de conexión de API REST para Dependabot solicitudes de descarte de alertas

List dismissal requests for Dependabot alerts for an organization

Lists dismissal requests for Dependabot alerts in an organization.

Delegated alert dismissal must be enabled on repositories in the org and the user must be an org admin, security manager, or have the appropriate permission to access this endpoint. Personal access tokens (classic) need the security_events scope to use this endpoint.

Tokens de acceso específicos para "List dismissal requests for Dependabot alerts for an organization"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Organization dismissal requests for Dependabot" organization permissions (read)

Parámetros para "List dismissal requests for Dependabot alerts for an organization"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Obligatorio The organization name. The name is not case sensitive.

Parámetros de consulta
Nombre, Tipo, Descripción
`repository_name` string The name of the repository to filter on.
`reviewer` string Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.
`requester` string Filter bypass requests by the handle of the GitHub user who requested the bypass.
`time_period` string The time period to filter by. For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). Valor predeterminado: `day` Puede ser uno de los siguientes: `hour`, `day`, `week`, `month`
`request_status` string The status of the dismissal request to filter on. When specified, only requests with this status will be returned. Valor predeterminado: `all` Puede ser uno de los siguientes: `completed`, `cancelled`, `approved`, `expired`, `denied`, `open`, `all`
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Valor predeterminado: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Valor predeterminado: `1`

Códigos de estado de respuesta HTTP para "List dismissal requests for Dependabot alerts for an organization"

status code	Descripción
`200`	A list of alert dismissal requests.
`403`	Forbidden
`404`	Resource not found
`500`	Internal Error

Ejemplos de código para "List dismissal requests for Dependabot alerts for an organization"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

get/orgs/{org}/dismissal-requests/dependabot

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/dismissal-requests/dependabot

A list of alert dismissal requests.

Status: 200

[
  {
    "id": 21,
    "number": 42,
    "repository": {
      "id": 1,
      "name": "smile",
      "full_name": "octo-org/smile"
    },
    "organization": {
      "id": 1,
      "name": "octo-org"
    },
    "requester": {
      "actor_id": 12,
      "actor_name": "monalisa"
    },
    "request_type": "dependabot_alert_dismissal",
    "data": [
      {
        "reason": "no_bandwidth",
        "alert_number": "1",
        "alert_title": "lodash - GHSA-1234-abcd-5678"
      }
    ],
    "resource_identifier": "1",
    "status": "denied",
    "requester_comment": "No bandwidth to fix this right now",
    "expires_at": "2024-07-08T08:43:03Z",
    "created_at": "2024-07-01T08:43:03Z",
    "responses": [
      {
        "id": 42,
        "reviewer": {
          "actor_id": 4,
          "actor_name": "octocat"
        },
        "status": "denied",
        "created_at": "2024-07-02T08:43:04Z"
      }
    ],
    "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/dependabot/1",
    "html_url": "https://github.com/octo-org/smile/security/dependabot/1"
  },
  {
    "id": 12,
    "number": 24,
    "repository": {
      "id": 1,
      "name": "smile",
      "full_name": "octo-org/smile"
    },
    "organization": {
      "id": 1,
      "name": "octo-org"
    },
    "requester": {
      "actor_id": 12,
      "actor_name": "monalisa"
    },
    "request_type": "dependabot_alert_dismissal",
    "data": [
      {
        "reason": "tolerable_risk",
        "alert_number": "2",
        "alert_title": "axios - GHSA-5678-efgh-9012"
      }
    ],
    "resource_identifier": "2",
    "status": "approved",
    "requester_comment": "Risk is acceptable for this internal tool",
    "expires_at": "2024-07-08T07:43:03Z",
    "created_at": "2024-07-01T07:43:03Z",
    "responses": [
      {
        "id": 43,
        "reviewer": {
          "actor_id": 4,
          "actor_name": "octocat"
        },
        "status": "approved",
        "created_at": "2024-07-02T08:43:04Z"
      }
    ],
    "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/dependabot/2",
    "html_url": "https://github.com/octo-org/smile/security/dependabot/2"
  }
]

List dismissal requests for Dependabot alerts for a repository

Lists dismissal requests for Dependabot alerts for a repository.

Delegated alert dismissal must be enabled on the repository. Personal access tokens (classic) need the security_events scope to use this endpoint.

Tokens de acceso específicos para "List dismissal requests for Dependabot alerts for a repository"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Dependabot alerts" repository permissions (read)

Parámetros para "List dismissal requests for Dependabot alerts for a repository"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`owner` string Obligatorio The account owner of the repository. The name is not case sensitive.
`repo` string Obligatorio The name of the repository without the `.git` extension. The name is not case sensitive.

Parámetros de consulta
Nombre, Tipo, Descripción
`reviewer` string Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request.
`requester` string Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal.
`time_period` string The time period to filter by. For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). Valor predeterminado: `month` Puede ser uno de los siguientes: `hour`, `day`, `week`, `month`
`request_status` string Filter alert dismissal requests by status. When specified, only requests with this status will be returned. Valor predeterminado: `all` Puede ser uno de los siguientes: `open`, `approved`, `expired`, `denied`, `all`
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Valor predeterminado: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Valor predeterminado: `1`

Códigos de estado de respuesta HTTP para "List dismissal requests for Dependabot alerts for a repository"

status code	Descripción
`200`	A list of alert dismissal requests.
`403`	Forbidden
`404`	Resource not found
`500`	Internal Error

Ejemplos de código para "List dismissal requests for Dependabot alerts for a repository"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

get/repos/{owner}/{repo}/dismissal-requests/dependabot

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/dismissal-requests/dependabot

A list of alert dismissal requests.

Status: 200

[
  {
    "id": 21,
    "number": 42,
    "repository": {
      "id": 1,
      "name": "smile",
      "full_name": "octo-org/smile"
    },
    "organization": {
      "id": 1,
      "name": "octo-org"
    },
    "requester": {
      "actor_id": 12,
      "actor_name": "monalisa"
    },
    "request_type": "dependabot_alert_dismissal",
    "data": [
      {
        "reason": "no_bandwidth",
        "alert_number": "1",
        "alert_title": "lodash - GHSA-1234-abcd-5678"
      }
    ],
    "resource_identifier": "1",
    "status": "denied",
    "requester_comment": "No bandwidth to fix this right now",
    "expires_at": "2024-07-08T08:43:03Z",
    "created_at": "2024-07-01T08:43:03Z",
    "responses": [
      {
        "id": 42,
        "reviewer": {
          "actor_id": 4,
          "actor_name": "octocat"
        },
        "status": "denied",
        "created_at": "2024-07-02T08:43:04Z"
      }
    ],
    "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/dependabot/1",
    "html_url": "https://github.com/octo-org/smile/security/dependabot/1"
  },
  {
    "id": 12,
    "number": 24,
    "repository": {
      "id": 1,
      "name": "smile",
      "full_name": "octo-org/smile"
    },
    "organization": {
      "id": 1,
      "name": "octo-org"
    },
    "requester": {
      "actor_id": 12,
      "actor_name": "monalisa"
    },
    "request_type": "dependabot_alert_dismissal",
    "data": [
      {
        "reason": "tolerable_risk",
        "alert_number": "2",
        "alert_title": "axios - GHSA-5678-efgh-9012"
      }
    ],
    "resource_identifier": "2",
    "status": "approved",
    "requester_comment": "Risk is acceptable for this internal tool",
    "expires_at": "2024-07-08T07:43:03Z",
    "created_at": "2024-07-01T07:43:03Z",
    "responses": [
      {
        "id": 43,
        "reviewer": {
          "actor_id": 4,
          "actor_name": "octocat"
        },
        "status": "approved",
        "created_at": "2024-07-02T08:43:04Z"
      }
    ],
    "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/dependabot/2",
    "html_url": "https://github.com/octo-org/smile/security/dependabot/2"
  }
]

Get a dismissal request for a Dependabot alert for a repository

Gets a dismissal request to dismiss a Dependabot alert in a repository.

Delegated alert dismissal must be enabled on the repository. Personal access tokens (classic) need the security_events scope to use this endpoint.

Tokens de acceso específicos para "Get a dismissal request for a Dependabot alert for a repository"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Dependabot alerts" repository permissions (read)

Parámetros para "Get a dismissal request for a Dependabot alert for a repository"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`owner` string Obligatorio The account owner of the repository. The name is not case sensitive.
`repo` string Obligatorio The name of the repository without the `.git` extension. The name is not case sensitive.
`alert_number` integer Obligatorio The number that identifies the Dependabot alert.

Códigos de estado de respuesta HTTP para "Get a dismissal request for a Dependabot alert for a repository"

status code	Descripción
`200`	A single dismissal request.
`403`	Forbidden
`404`	Resource not found
`500`	Internal Error

Ejemplos de código para "Get a dismissal request for a Dependabot alert for a repository"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

get/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/dismissal-requests/dependabot/ALERT_NUMBER

A single dismissal request.

Status: 200

{
  "id": 21,
  "number": 42,
  "repository": {
    "id": 1,
    "name": "smile",
    "full_name": "octo-org/smile"
  },
  "organization": {
    "id": 1,
    "name": "octo-org"
  },
  "requester": {
    "actor_id": 12,
    "actor_name": "monalisa"
  },
  "request_type": "dependabot_alert_dismissal",
  "data": [
    {
      "reason": "no_bandwidth",
      "alert_number": "1",
      "alert_title": "lodash - GHSA-1234-abcd-5678"
    }
  ],
  "resource_identifier": "1",
  "status": "pending",
  "requester_comment": "No bandwidth to fix this right now",
  "expires_at": "2024-07-08T08:43:03Z",
  "created_at": "2024-07-01T08:43:03Z",
  "responses": [],
  "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/dependabot/1",
  "html_url": "https://github.com/octo-org/smile/security/dependabot/1"
}

Review a dismissal request for a Dependabot alert for a repository

Approve or deny a dismissal request to dismiss a Dependabot alert in a repository.

Delegated alert dismissal must be enabled on the repository and the user must be a dismissal reviewer to access this endpoint. OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint.

Tokens de acceso específicos para "Review a dismissal request for a Dependabot alert for a repository"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Organization dismissal requests for Dependabot" organization permissions (write) and "Dependabot alerts" repository permissions (read)

Parámetros para "Review a dismissal request for a Dependabot alert for a repository"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`owner` string Obligatorio The account owner of the repository. The name is not case sensitive.
`repo` string Obligatorio The name of the repository without the `.git` extension. The name is not case sensitive.
`alert_number` integer Obligatorio The number that identifies the Dependabot alert.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`status` string Obligatorio The review action to perform on the dismissal request. Puede ser uno de los siguientes: `approve`, `deny`
`message` string Obligatorio A message to include with the review. Has a maximum character length of 2048.

Códigos de estado de respuesta HTTP para "Review a dismissal request for a Dependabot alert for a repository"

status code	Descripción
`200`	The review of the dismissal request.
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal Error

Ejemplos de código para "Review a dismissal request for a Dependabot alert for a repository"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

patch/repos/{owner}/{repo}/dismissal-requests/dependabot/{alert_number}

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/dismissal-requests/dependabot/ALERT_NUMBER \
  -d '{"status":"approve","message":"Used in tests."}'

The review of the dismissal request.

Status: 200

{
  "dismissal_review_id": 1
}