1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
---
# .gitignore API
DETAILS:
**Tier:** Free, Premium, Ultimate
**Offering:** GitLab.com, Self-managed, GitLab Dedicated
In GitLab, the `/gitignores` endpoint returns a list of Git `.gitignore` templates. For more information,
see the [Git documentation for `.gitignore`](https://git-scm.com/docs/gitignore).
Users with the Guest role can't access the .gitignore templates. For more information, see [Project and group visibility](../../user/public_access.md).
## Get all `.gitignore` templates
Get a list of all `.gitignore` templates:
```plaintext
GET /templates/gitignores
```
Example request:
```shell
curl "https://gitlab.example.com/api/v4/templates/gitignores"
```
Example response:
```json
[
{
"key": "Actionscript",
"name": "Actionscript"
},
{
"key": "Ada",
"name": "Ada"
},
{
"key": "Agda",
"name": "Agda"
},
{
"key": "Android",
"name": "Android"
},
{
"key": "AppEngine",
"name": "AppEngine"
},
{
"key": "AppceleratorTitanium",
"name": "AppceleratorTitanium"
},
{
"key": "ArchLinuxPackages",
"name": "ArchLinuxPackages"
},
{
"key": "Autotools",
"name": "Autotools"
},
{
"key": "C",
"name": "C"
},
{
"key": "C++",
"name": "C++"
},
{
"key": "CFWheels",
"name": "CFWheels"
},
{
"key": "CMake",
"name": "CMake"
},
{
"key": "CUDA",
"name": "CUDA"
},
{
"key": "CakePHP",
"name": "CakePHP"
},
{
"key": "ChefCookbook",
"name": "ChefCookbook"
},
{
"key": "Clojure",
"name": "Clojure"
},
{
"key": "CodeIgniter",
"name": "CodeIgniter"
},
{
"key": "CommonLisp",
"name": "CommonLisp"
},
{
"key": "Composer",
"name": "Composer"
},
{
"key": "Concrete5",
"name": "Concrete5"
}
]
```
## Get a single `.gitignore` template
Get a single `.gitignore` template:
```plaintext
GET /templates/gitignores/:key
```
| Attribute | Type | Required | Description |
|-----------|--------|----------|-------------|
| `key` | string | yes | The key of the `.gitignore` template |
Example request:
```shell
curl "https://gitlab.example.com/api/v4/templates/gitignores/Ruby"
```
Example response:
```json
{
"name": "Ruby",
"content": "*.gem\n*.rbc\n/.config\n/coverage/\n/InstalledFiles\n/pkg/\n/spec/reports/\n/spec/examples.txt\n/test/tmp/\n/test/version_tmp/\n/tmp/\n\n# Used by dotenv library to load environment variables.\n# .env\n\n## Specific to RubyMotion:\n.dat*\n.repl_history\nbuild/\n*.bridgesupport\nbuild-iPhoneOS/\nbuild-iPhoneSimulator/\n\n## Specific to RubyMotion (use of CocoaPods):\n#\n# We recommend against adding the Pods directory to your .gitignore. However\n# you should judge for yourself, the pros and cons are mentioned at:\n# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control\n#\n# vendor/Pods/\n\n## Documentation cache and generated files:\n/.yardoc/\n/_yardoc/\n/doc/\n/rdoc/\n\n## Environment normalization:\n/.bundle/\n/vendor/bundle\n/lib/bundler/man/\n\n# for a library or gem, you might want to ignore these files since the code is\n# intended to run in multiple environments; otherwise, check them in:\n# Gemfile.lock\n# .ruby-version\n# .ruby-gemset\n\n# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:\n.rvmrc\n"
}
```
<!-- ## Troubleshooting
Include any troubleshooting steps that you can foresee. If you know beforehand what issues
one might have when setting this up, or when something is changed, or on upgrading, it's
important to describe those, too. Think of things that may go wrong and include them here.
This is important to minimize requests for support, and to avoid doc comments with
questions that you know someone might ask.
Each scenario can be a third-level heading, for example `### Getting error message X`.
If you have none to add when creating a doc, leave this section in place
but commented out to help encourage others to add to it in the future. -->
|
