VOOZH about

URL: https://docs.github.com/en/enterprise-server@2.21/rest/reference/gitignore

⇱ Gitignore - GitHub Docs

GitHub Docs

This version of GitHub Enterprise was discontinued on 2021-06-09. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.

Gitignore

The Gitignore API fetches .gitignore templates that can be used to ignore files and directories.

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/templates

Code samples

Shell
curl \
 -H "Accept: application/vnd.github.v3+json" \
 http(s)://{hostname}/api/v3/gitignore/templates
JavaScript (@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 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 application/vnd.github.v3+json is recommended.
name string path

Code samples

Shell
curl \
 -H "Accept: application/vnd.github.v3+json" \
 http(s)://{hostname}/api/v3/gitignore/templates/NAME
JavaScript (@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

Notes