Skip to main content
Ahora la API REST está versionada. Para obtener más información, consulta "Acerca del control de versiones de la API".

Puntos de conexión de la API de REST para gitignore

Usa la API de REST para obtener plantillas de .gitignore que se pueden usar para omitir archivos y directorios.

Acerca de gitignore

Al crear un repositorio en GitHub mediante la API, puede especificar una plantilla de .gitignore para aplicarla al repositorio cuando se cree. Puedes usar la API REST para obtener plantillas de .gitignore del repositorio .gitignore de GitHub.

Get all gitignore templates

List all templates available to pass as an option when creating a repository.

fine_grained_access

works_with_fine_grained_tokens:

no_permission_sets

allows_public_read_access_no_permissions

http_status_code

status_codeDescripción
200

OK

304

Not modified

code_samples

request_example

get/gitignore/templates
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/gitignore/templates

Response

Status: 200
[ "Actionscript", "Android", "AppceleratorTitanium", "Autotools", "Bancha", "C", "C++" ]

Get a gitignore template

Get the content of a gitignore template.

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd.github.raw+json: Returns the raw .gitignore contents.

fine_grained_access

works_with_fine_grained_tokens:

no_permission_sets

allows_public_read_access_no_permissions

Parámetros para "Get a gitignore template"

Encabezados
Nombre, Tipo, Descripción
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de ruta
Nombre, Tipo, Descripción
name string Obligatorio

http_status_code

status_codeDescripción
200

OK

304

Not modified

code_samples

request_example

get/gitignore/templates/{name}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/gitignore/templates/NAME

Response

Status: 200
{ "name": "C", "source": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" }