Puntos de conexión de la API de REST para acceso al repositorio de Dependabot

Acerca del acceso al repositorio de Dependabot

Puedes enumerar los repositorios a los que Dependabot ya tiene acceso y establecer un nivel de acceso de repositorio predeterminado para Dependabot.

Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.

Note

This operation supports both server-to-server and user-to-server access. Unauthorized users will not see the existence of this endpoint.

Tokens de acceso específicos para "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies."

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

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Administration" organization permissions (read)

Parámetros para "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies."

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 Requerido The organization name. The name is not case sensitive.

Parámetros de consulta
Nombre, Tipo, Descripción
`page` integer The page number of results to fetch. Valor predeterminado: `1`
`per_page` integer Number of results per page. Valor predeterminado: `30`

Códigos de estado de respuesta HTTP para "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies."

status code	Descripción
`200`	OK
`403`	Forbidden
`404`	Resource not found

Ejemplos de código para "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies."

Ejemplo de solicitud

get/organizations/{org}/dependabot/repository-access

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/organizations/ORG/dependabot/repository-access

Response

Status: 200

{
  "default_level": "public",
  "accessible_repositories": [
    {
      "id": 123456,
      "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=",
      "name": "example-repo",
      "full_name": "octocat/example-repo",
      "owner": {
        "name": "octocat",
        "email": "octo@github.com",
        "login": "octocat",
        "id": 1,
        "node_id": "MDQ6VXNlcjE=",
        "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4",
        "gravatar_id": 1,
        "url": "https://api.github.com/users/octocat",
        "html_url": "https://github.com/octocat/example-repo",
        "followers_url": "https://api.github.com/users/octocat/followers",
        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
        "organizations_url": "https://api.github.com/users/octocat/orgs",
        "repos_url": "https://api.github.com/users/octocat/repos",
        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
        "received_events_url": "https://api.github.com/users/octocat/received_events",
        "type": "User",
        "site_admin": false,
        "starred_at": "\"2020-07-09T00:17:55Z\"",
        "user_view_type": "default"
      },
      "private": false,
      "html_url": "https://github.com/octocat/example-repo",
      "description": "This is an example repository.",
      "fork": false,
      "url": "https://api.github.com/repos/octocat/example-repo",
      "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}",
      "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}",
      "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}",
      "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}",
      "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}",
      "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}",
      "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}",
      "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}",
      "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}",
      "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors",
      "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments",
      "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads",
      "events_url": "https://api.github.com/repos/octocat/example-repo/events",
      "forks_url": "https://api.github.com/repos/octocat/example-repo/forks",
      "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}",
      "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}",
      "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}",
      "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}",
      "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}",
      "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}",
      "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}",
      "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}",
      "languages_url": "https://api.github.com/repos/octocat/example-repo/languages",
      "merges_url": "https://api.github.com/repos/octocat/example-repo/merges",
      "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}",
      "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}",
      "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}",
      "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}",
      "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers",
      "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}",
      "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers",
      "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription",
      "tags_url": "https://api.github.com/repos/octocat/example-repo/tags",
      "teams_url": "https://api.github.com/repos/octocat/example-repo/teams",
      "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}",
      "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks"
    }
  ]
}

Updates repositories to the list of repositories that organization admins have allowed Dependabot to access when updating dependencies.

Note

This operation supports both server-to-server and user-to-server access. Unauthorized users will not see the existence of this endpoint.

Example request body:

{
  "repository_ids_to_add": [123, 456],
  "repository_ids_to_remove": [789]
}

Tokens de acceso específicos para "Updates repositories to the list of repositories that organization admins have allowed Dependabot to access when updating dependencies."

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

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Administration" organization permissions (write)

Parámetros para "Updates repositories to the list of repositories that organization admins have allowed Dependabot to access when updating dependencies."

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 Requerido The organization name. The name is not case sensitive.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`repository_ids_to_add` array of integers List of repository IDs to add.
`repository_ids_to_remove` array of integers List of repository IDs to remove.

Códigos de estado de respuesta HTTP para "Updates repositories to the list of repositories that organization admins have allowed Dependabot to access when updating dependencies."

status code	Descripción
`204`	No Content
`403`	Forbidden
`404`	Resource not found

Ejemplos de código para "Updates repositories to the list of repositories that organization admins have allowed Dependabot to access when updating dependencies."

Ejemplo de solicitud

patch/organizations/{org}/dependabot/repository-access

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/organizations/ORG/dependabot/repository-access

Response

Status: 204

Set the default repository access level for Dependabot

Note

This operation supports both server-to-server and user-to-server access. Sets the default level of repository access Dependabot will have while performing an update. Available values are:

'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.
'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.

Unauthorized users will not see the existence of this endpoint.

Tokens de acceso específicos para "Set the default repository access level for Dependabot"

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

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Administration" organization permissions (write)

Parámetros para "Set the default repository access level for Dependabot"

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 Requerido The organization name. The name is not case sensitive.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`default_level` string Requerido The default repository access level for Dependabot updates. Puede ser uno de los siguientes: `public`, `internal`

Códigos de estado de respuesta HTTP para "Set the default repository access level for Dependabot"

status code	Descripción
`204`	No Content
`403`	Forbidden
`404`	Resource not found

Ejemplos de código para "Set the default repository access level for Dependabot"

Ejemplo de solicitud

put/organizations/{org}/dependabot/repository-access/default-level

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/organizations/ORG/dependabot/repository-access/default-level \
  -d '{"default_level":"public"}'

Response

Status: 204