@@ -14,22 +14,24 @@ You must explicitly set the port number when making API calls to the Management
1414
1515If you don't want to provide a port number, you'll need to configure your tool to automatically follow redirects.
1616
17+ You may also need to add the[ ` -k ` flag] ( http://curl.haxx.se/docs/manpage.html#-k ) when using` curl ` , since GitHub Enterprise uses a self-signed certificate before you[ add your own SSL certificate] ( https://help.github.com/enterprise/admin/guides/installation/dns-hostname-subdomain-isolation-and-ssl/#ssl ) .
18+
1719{{/tip}}
1820
1921##Authentication
2022
21- You need to pass your[ Management Console password] ( https://help.github.com/enterprise/2.0/ admin/articles/accessing-the-management-console/ ) as an authentication token to every Management Console API endpoint except[ ` /setup/api/start ` ] ( #upload-a-license-for-the-first-time ) .
23+ You need to pass your[ Management Console password] ( https://help.github.com/enterprise/admin/articles/accessing-the-management-console/ ) as an authentication token to every Management Console API endpoint except[ ` /setup/api/start ` ] ( #upload-a-license-for-the-first-time ) .
2224
2325Use the` api_key ` parameter to send this token with each request. For example:
2426
2527``` command-line
26- $ curl -L 'http ://<em>hostname</em>:<em>admin_port</em>/setup/api?api_key=<em>your-amazing-password</em>'
28+ $ curl -L 'https ://<em>hostname</em>:<em>admin_port</em>/setup/api?api_key=<em>your-amazing-password</em>'
2729```
2830
2931You can also use standard HTTP authentication to send this token. For example:
3032
3133``` command-line
32- $ curl -L 'http ://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api'
34+ $ curl -L 'https ://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api'
3335```
3436
3537##Upload a license for the first time
@@ -69,7 +71,7 @@ For a list of the available settings, see [the `/setup/api/settings` endpoint](#
6971###Example
7072
7173``` command-line
72- $ 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+ $ curl -L -X POST 'https ://<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>
7375```
7476
7577##Upgrade a license
@@ -94,7 +96,7 @@ Name | Type | Description
9496###Example
9597
9698``` command-line
97- $ curl -L -X POST 'http ://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/upgrade'
99+ $ curl -L -X POST 'https ://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/upgrade'
98100```
99101
100102##Check configuration status
@@ -123,7 +125,7 @@ Status | Description
123125###Example
124126
125127``` command-line
126- $ curl -L 'http ://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/configcheck'
128+ $ curl -L 'https ://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/configcheck'
127129```
128130
129131##Start a configuration process
@@ -142,7 +144,7 @@ This endpoint allows you to start a configuration process at any time for your u
142144###Example
143145
144146``` command-line
145- $ curl -L -X POST 'http ://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/configure'
147+ $ curl -L -X POST 'https ://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/configure'
146148```
147149
148150##Retrieve settings
@@ -157,7 +159,7 @@ $ curl -L -X POST 'http://api_key:<em>your-amazing-password</em>@<em>hostname</e
157159###Example
158160
159161``` command-line
160- $ curl -L 'http ://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/settings'
162+ $ curl -L 'https ://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/settings'
161163```
162164
163165##Modify settings
@@ -179,7 +181,7 @@ Name | Type | Description
179181###Example
180182
181183``` command-line
182- $ 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+ $ curl -L -X PUT 'https ://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`"
183185```
184186
185187##Check maintenance status
@@ -196,7 +198,7 @@ Check your installation's maintenance status:
196198###Example
197199
198200``` command-line
199- $ curl -L 'http ://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/maintenance'
201+ $ curl -L 'https ://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/maintenance'
200202```
201203
202204##Enable or disable maintenance mode
@@ -223,7 +225,7 @@ The possible values for `when` are `now` or any date parseable by
223225###Example
224226
225227``` command-line
226- $ 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+ $ curl -L -X POST 'https ://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>'
227229```
228230
229231##Retrieve authorized SSH keys
@@ -238,7 +240,7 @@ $ curl -L -X POST 'http://api_key:<em>your-amazing-password</em>@<em>hostname</e
238240###Example
239241
240242``` command-line
241- $ curl -L 'http ://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/settings/authorized-keys'
243+ $ curl -L 'https ://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/settings/authorized-keys'
242244```
243245
244246##Add a new authorized SSH key
@@ -259,7 +261,7 @@ Name | Type | Description
259261###Example
260262
261263``` command-line
262- $ 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+ $ curl -L -X POST 'https ://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>
263265```
264266
265267##Remove an authorized SSH key
@@ -280,5 +282,5 @@ Name | Type | Description
280282###Example
281283
282284``` command-line
283- $ 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+ $ curl -L -X DELETE 'https ://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>
284286```