@@ -24,13 +24,13 @@ You need to pass your [Management Console password](https://help.github.com/ente
24
24
Use the` api_key ` parameter to send this token with each request. For example:
25
25
26
26
<pre class =" terminal " >
27
- $ curl -L 'http://<em >hostname</em >/setup/api?api_key=<em >your-amazing-password</em >'
27
+ $ curl -L 'http://<em >hostname</em >:< em >admin_port</ em > /setup/api?api_key=<em >your-amazing-password</em >'
28
28
</pre >
29
29
30
30
You can also use standard HTTP authentication to send this token. For example:
31
31
32
32
<pre class =" terminal " >
33
- $ curl -L 'http://api_key:<em >your-amazing-password</em >@<em >hostname</em >/setup/api'
33
+ $ curl -L 'http://api_key:<em >your-amazing-password</em >@<em >hostname</em >:< em >admin_port</ em > /setup/api'
34
34
</pre >
35
35
36
36
##Upload a license for the first time
@@ -64,13 +64,13 @@ For a list of the available settings, see [the `/setup/api/settings` endpoint](#
64
64
65
65
<pre class =" terminal " >
66
66
HTTP/1.1 202 Created
67
- Location: http://<em >hostname</em >/setup/api/configcheck
67
+ Location: http://<em >hostname</em >:< em >admin_port</ em > /setup/api/configcheck
68
68
</pre >
69
69
70
70
###Example
71
71
72
72
<pre class =" terminal " >
73
- curl -L -X POST 'http://<em >hostname</em >/setup/api/start' -F license=@<em >/path/to/github-enterprise.ghl</em > -F "password=<em >your-amazing-password</em >" -F settings=< ; <em >/path/to/settings.json</em >
73
+ curl -L -X POST 'http://<em >hostname</em >:< em >admin_port</ em > /setup/api/start' -F license=@<em >/path/to/github-enterprise.ghl</em > -F "password=<em >your-amazing-password</em >" -F settings=< ; <em >/path/to/settings.json</em >
74
74
</pre >
75
75
76
76
##Upgrade a license
@@ -89,13 +89,13 @@ Name | Type | Description
89
89
90
90
<pre class =" terminal " >
91
91
HTTP/1.1 202 Accepted
92
- Location: http://hostname/setup/api/configcheck
92
+ Location: http://< em > hostname</ em >:< em >admin_port</ em > /setup/api/configcheck
93
93
</pre >
94
94
95
95
###Example
96
96
97
97
<pre class =" terminal " >
98
- curl -L -X POST 'http://api_key:<em >your-amazing-password</em >@<em >hostname</em >/setup/api/upgrade'
98
+ curl -L -X POST 'http://api_key:<em >your-amazing-password</em >@<em >hostname</em >:< em >admin_port</ em > /setup/api/upgrade'
99
99
</pre >
100
100
101
101
##Check configuration status
@@ -124,7 +124,7 @@ Status | Description
124
124
###Example
125
125
126
126
<pre class =" terminal " >
127
- curl -L 'http://api_key:<em >your-amazing-password</em >@<em >hostname</em >/setup/api/configcheck'
127
+ curl -L 'http://api_key:<em >your-amazing-password</em >@<em >hostname</em >:< em >admin_port</ em > /setup/api/configcheck'
128
128
</pre >
129
129
130
130
##Start a configuration process
@@ -137,13 +137,13 @@ This endpoint allows you to start a configuration process at any time for your u
137
137
138
138
<pre class =" terminal " >
139
139
HTTP/1.1 202 Accepted
140
- Location: http://hostname/setup/api/configcheck
140
+ Location: http://< em > hostname</ em >:< em >admin_port</ em > /setup/api/configcheck
141
141
</pre >
142
142
143
143
###Example
144
144
145
145
<pre class =" terminal " >
146
- curl -L -X POST 'http://api_key:<em >your-amazing-password</em >@<em >hostname</em >/setup/api/configure'
146
+ curl -L -X POST 'http://api_key:<em >your-amazing-password</em >@<em >hostname</em >:< em >admin_port</ em > /setup/api/configure'
147
147
</pre >
148
148
149
149
##Retrieve settings
@@ -158,7 +158,7 @@ curl -L -X POST 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>
158
158
###Example
159
159
160
160
<pre class =" terminal " >
161
- curl -L 'http://api_key:<em >your-amazing-password</em >@<em >hostname</em >/setup/api/settings'
161
+ curl -L 'http://api_key:<em >your-amazing-password</em >@<em >hostname</em >:< em >admin_port</ em > /setup/api/settings'
162
162
</pre >
163
163
164
164
##Modify settings
@@ -180,7 +180,7 @@ HTTP/1.1 204 No Content
180
180
###Example
181
181
182
182
<pre class =" terminal " >
183
- curl -L -X PUT 'http://api_key:<em >your-amazing-password</em >@<em >hostname</em >/setup/api/settings' --data-urlencode "settings=`cat /path/to/settings.json`"
183
+ curl -L -X PUT 'http://api_key:<em >your-amazing-password</em >@<em >hostname</em >:< em >admin_port</ em > /setup/api/settings' --data-urlencode "settings=`cat /path/to/settings.json`"
184
184
</pre >
185
185
186
186
##Check maintenance status
@@ -197,7 +197,7 @@ Check your installation's maintenance status:
197
197
###Example
198
198
199
199
<pre class =" terminal " >
200
- curl -L 'http://api_key:<em >your-amazing-password</em >@<em >hostname</em >/setup/api/maintenance'
200
+ curl -L 'http://api_key:<em >your-amazing-password</em >@<em >hostname</em >:< em >admin_port</ em > /setup/api/maintenance'
201
201
</pre >
202
202
203
203
##Enable or disable maintenance mode
@@ -224,7 +224,7 @@ The possible values for `when` are `now` or any date parseable by
224
224
###Example
225
225
226
226
<pre class =" terminal " >
227
- curl -L -X POST 'http://api_key:<em >your-amazing-password</em >@<em >hostname</em >/setup/api/maintenance' -d 'maintenance=<em >{"enabled":true, "when":"now"}</em >'
227
+ curl -L -X POST 'http://api_key:<em >your-amazing-password</em >@<em >hostname</em >:< em >admin_port</ em > /setup/api/maintenance' -d 'maintenance=<em >{"enabled":true, "when":"now"}</em >'
228
228
</pre >
229
229
230
230
##Retrieve authorized SSH keys
@@ -239,7 +239,7 @@ curl -L -X POST 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>
239
239
###Example
240
240
241
241
<pre class =" terminal " >
242
- curl -L 'http://api_key:<em >your-amazing-password</em >@<em >hostname</em >/setup/api/settings/authorized-keys'
242
+ curl -L 'http://api_key:<em >your-amazing-password</em >@<em >hostname</em >:< em >admin_port</ em > /setup/api/settings/authorized-keys'
243
243
</pre >
244
244
245
245
##Add a new authorized SSH key
@@ -260,7 +260,7 @@ Name | Type | Description
260
260
###Example
261
261
262
262
<pre class =" terminal " >
263
- curl -L -X POST 'http://api_key:<em >your-amazing-password</em >@<em >hostname</em >/setup/api/settings/authorized-keys' -F authorized_key=@<em >/path/to/key.pub</em >
263
+ curl -L -X POST 'http://api_key:<em >your-amazing-password</em >@<em >hostname</em >:< em >admin_port</ em > /setup/api/settings/authorized-keys' -F authorized_key=@<em >/path/to/key.pub</em >
264
264
</pre >
265
265
266
266
##Remove an authorized SSH key
@@ -281,5 +281,5 @@ Name | Type | Description
281
281
###Example
282
282
283
283
<pre class =" terminal " >
284
- curl -L -X DELETE 'http://api_key:<em >your-amazing-password</em >@<em >hostname</em >/setup/api/settings/authorized-keys' -F authorized_key=@<em >/path/to/key.pub</em >
284
+ curl -L -X DELETE 'http://api_key:<em >your-amazing-password</em >@<em >hostname</em >:< em >admin_port</ em > /setup/api/settings/authorized-keys' -F authorized_key=@<em >/path/to/key.pub</em >
285
285
</pre >