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.com 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 Enterprise Cloud .gitignore repository.
Get all gitignore templates
List all templates available to pass as an option when creating a repository.
Fine-grained access tokens for "Get all gitignore templates"
This endpoint works with the following token types:
- GitHub App user access tokens
- GitHub App installation access tokens
- Fine-grained personal access tokens
The token does not require any permissions.
HTTP response status codes for "Get all gitignore templates"
Status code | Description |
---|---|
200 | OK |
304 | Not modified |
Code samples for "Get all gitignore templates"
Request example
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/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 tokens for "Get a gitignore template"
This endpoint works with the following token types:
- GitHub App user access tokens
- GitHub App installation access tokens
- Fine-grained personal access tokens
The token does not require any permissions.
Parameters for "Get a gitignore template"
Name, Type, Description |
---|
accept string Setting to |
Name, Type, Description |
---|
name string Required |
HTTP response status codes for "Get a gitignore template"
Status code | Description |
---|---|
200 | OK |
304 | Not modified |
Code samples for "Get a gitignore template"
Request example
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/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"
}