When you create a new GitHub Enterprise Server repository 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 Server .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
Shell
curl \
-H "Accept: application/vnd.github.v3+json" \
http(s)://{hostname}/api/v3/gitignore/templatesJavaScript (@octokit/core.js)
await octokit.request('GET /gitignore/templates')
Response
Status: 200 OK[
"Actionscript",
"Android",
"AppceleratorTitanium",
"Autotools",
"Bancha",
"C",
"C++"
]
Not modified
Status: 304 Not ModifiedNotes
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
Shell
curl \
-H "Accept: application/vnd.github.v3+json" \
http(s)://{hostname}/api/v3/gitignore/templates/NAMEJavaScript (@octokit/core.js)
await octokit.request('GET /gitignore/templates/{name}', {
name: 'name'
})
Response
Status: 200 OK{
"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"
}
Not modified
Status: 304 Not Modified