Gitignore
The Gitignore API fetches .gitignore templates that can be used to ignore files and directories.
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. The .gitignore templates API lists and fetches templates from the GitHub Enterprise Cloud .gitignore repository.
Custom media types for gitignore
You can use this custom media type when getting a gitignore template.
application/vnd.github.VERSION.raw
For more information, see "Media types."
Get all gitignore templates
List all templates available to pass as an option when creating a repository.
get /gitignore/templatesCode samples
Example
curl \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/gitignore/templatesawait octokit.request('GET /gitignore/templates', {})gh api \
-H "Accept: application/vnd.github.v3+json" \
/gitignore/templatesResponse
Status: 200[
"Actionscript",
"Android",
"AppceleratorTitanium",
"Autotools",
"Bancha",
"C",
"C++"
]Status codes
| HTTP Status Code | Description |
|---|---|
200 | OK |
304 | Not modified |
Notes
Get a gitignore template
The API also allows fetching the source of a single template. Use the raw media type to get the raw contents.
get /gitignore/templates/{name}Parameters
| Name | Type | In | Description |
|---|---|---|---|
accept | string | header | Setting to |
name | string | path |
Code samples
Example
curl \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/gitignore/templates/NAMEawait octokit.request('GET /gitignore/templates/{name}', {
name: 'NAME'
})gh api \
-H "Accept: application/vnd.github.v3+json" \
/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"
}Status codes
| HTTP Status Code | Description |
|---|---|
200 | OK |
304 | Not modified |