REST API endpoints for gitignore
Use the REST API to get .gitignore templates that can be used to ignore files and directories.
About gitignore
When you create a new repository on GitHub via the API, you can specify a .gitignore template to apply to the repository upon creation. You can use the REST API to get .gitignore templates from the GitHub .gitignore repository.
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_code | Description |
|---|---|
200 | OK |
304 | Not modified |
code_samples
request_example
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/templatesResponse
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
Parameters for "Get a gitignore template"
| Name, Type, Description |
|---|
accept string Setting to |
| Name, Type, Description |
|---|
name string Required |
http_status_code
| status_code | Description |
|---|---|
200 | OK |
304 | Not modified |
code_samples
request_example
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/NAMEResponse
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"
}