👋 We've unified all of GitHub's product documentation in one place! Check out the content for REST API, GraphQL API, and Developers. Learn more on the GitHub blog.
Article version: GitHub.com

Gitignore

In this article

Were you able to find what you were looking for?

When you create a new GitHub 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 .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

Parameters

Name Type In Description
accept string header

Setting to application/vnd.github.v3+json is recommended

Code samples

Shell
curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/gitignore/templates
JavaScript (@octokit/core.js)
await octokit.request('GET /gitignore/templates')

Response

Status: 200 OK
[
  "Actionscript",
  "Android",
  "AppceleratorTitanium",
  "Autotools",
  "Bancha",
  "C",
  "C++"
]

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" \
  https://api.github.com/gitignore/templates/NAME
JavaScript (@octokit/core.js)
await octokit.request('GET /gitignore/templates/{name}', {
  name: 'name'
})

Default 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"
}

Notes


Were you able to find what you were looking for?

Ask a human

Can't find what you're looking for?

Contact us