Skip to content

Commit 9f03254

Browse files
author
hubot
committed
Merge pull request github#643 from github/update-1416608966
2 parents 8b8c33d + 1780db0 commit 9f03254

File tree

1 file changed

+16
-18
lines changed

1 file changed

+16
-18
lines changed

‎content/v3/enterprise/management_console.md‎

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The Management Console API helps you manage your GitHub Enterprise installation.
1111

1212
## Authentication
1313

14-
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-and-software-package-for-the-first-time).
14+
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).
1515

1616
Use the `api_key` parameter to send this token with each request. For example:
1717

@@ -25,9 +25,9 @@ You can also use standard HTTP authentication to send this token. For example:
2525
$ curl 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api'
2626
</pre>
2727

28-
## Upload a license and software package for the first time
28+
## Upload a license for the first time
2929

30-
When you boot a virtual machine for the first time, you can use the following endpoint to upload a license and software package:
30+
When you boot a virtual machine for the first time, you can use the following endpoint to upload a license:
3131

3232
POST /setup/api/start
3333

@@ -38,7 +38,6 @@ Note that you need to POST to [`/setup/api/configure`](#start-a-configuration-pr
3838
Name | Type | Description
3939
-----|------|--------------
4040
`license`|`string` | **Required**. The content of your *.ghl* license file.
41-
`package`|`string`|**Required**. The content of your *.ghp* package file.
4241
`settings`| `string`| Optional path to a JSON file containing your installation settings.
4342

4443
For a list of the available settings, see [the `/setup/api/settings` endpoint](#retrieve-settings).
@@ -53,12 +52,12 @@ Location: http://<em>hostname</em>/setup/api/configcheck
5352
### Example
5453

5554
<pre class="terminal">
56-
curl -X POST 'http://license:<em>md5-checksum-of-license</em>@<em>hostname</em>/setup/api/start' -F package=@<em>/path/to/package.ghp</em> -F license=@<em>/path/to/github-enterprise.ghl</em> -F settings=&lt;<em>/path/to/settings.json</em>
55+
curl -X POST 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api/start' -F license=@<em>/path/to/github-enterprise.ghl</em> -F settings=&lt;<em>/path/to/settings.json</em>
5756
</pre>
5857

59-
## Upgrade a license or software package
58+
## Upgrade a license
6059

61-
This API upgrades your license or package and also triggers the configuration process:
60+
This API upgrades your license and also triggers the configuration process:
6261

6362
POST /setup/api/upgrade
6463

@@ -67,7 +66,6 @@ This API upgrades your license or package and also triggers the configuration pr
6766
Name | Type | Description
6867
-----|------|--------------
6968
`license`|`string` | The content of your new *.ghl* license file.
70-
`package`|`string`| The content of your new *.ghp* package file.
7169

7270
### Response
7371

@@ -79,7 +77,7 @@ Location: http://hostname/setup/api/configcheck
7977
### Example
8078

8179
<pre class="terminal">
82-
curl -X POST 'http://license:<em>md5-checksum-of-license</em>@<em>hostname</em>/setup/api/upgrade' -F package=@<em>/path/to/package.ghp</em>
80+
curl -X POST 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api/upgrade'
8381
</pre>
8482

8583
## Check configuration status
@@ -108,7 +106,7 @@ Status | Description
108106
### Example
109107

110108
<pre class="terminal">
111-
curl 'http://license:<em>md5-checksum-of-license</em>@<em>hostname</em>/setup/api/configcheck'
109+
curl 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api/configcheck'
112110
</pre>
113111

114112
## Start a configuration process
@@ -127,7 +125,7 @@ Location: http://hostname/setup/api/configcheck
127125
### Example
128126

129127
<pre class="terminal">
130-
curl -X POST 'http://license:<em>md5-checksum-of-license</em>@<em>hostname</em>/setup/api/configure'
128+
curl -X POST 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api/configure'
131129
</pre>
132130

133131
## Retrieve settings
@@ -142,7 +140,7 @@ curl -X POST 'http://license:<em>md5-checksum-of-license</em>@<em>hostname</em>/
142140
### Example
143141

144142
<pre class="terminal">
145-
curl 'http://license:<em>md5-checksum-of-license</em>@<em>hostname</em>/setup/api/settings'
143+
curl 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api/settings'
146144
</pre>
147145

148146
## Modify settings
@@ -164,7 +162,7 @@ HTTP/1.1 204 No Content
164162
### Example
165163

166164
<pre class="terminal">
167-
curl -X PUT 'http://license:<em>md5-checksum-of-license</em>@<em>hostname</em>/setup/api/settings' --data-urlencode "settings=`cat /path/to/settings.json`"
165+
curl -X PUT 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api/settings' --data-urlencode "settings=`cat /path/to/settings.json`"
168166
</pre>
169167

170168
## Check maintenance status
@@ -181,7 +179,7 @@ Check your installation's maintenance status:
181179
### Example
182180

183181
<pre class="terminal">
184-
curl 'http://license:<em>md5-checksum-of-license</em>@<em>hostname</em>/setup/api/maintenance'
182+
curl 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api/maintenance'
185183
</pre>
186184

187185
## Enable or disable maintenance mode
@@ -208,7 +206,7 @@ The possible values for `when` are `now` or any date parseable by
208206
### Example
209207

210208
<pre class="terminal">
211-
curl -X POST 'http://license:<em>md5-checksum-of-license</em>@<em>hostname</em>/setup/api/maintenance' -d 'maintenance=<em>{"enabled":true, "when":"now"}</em>'
209+
curl -X POST 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api/maintenance' -d 'maintenance=<em>{"enabled":true, "when":"now"}</em>'
212210
</pre>
213211

214212
## Retrieve authorized SSH keys
@@ -223,7 +221,7 @@ curl -X POST 'http://license:<em>md5-checksum-of-license</em>@<em>hostname</em>/
223221
### Example
224222

225223
<pre class="terminal">
226-
curl 'http://license:<em>md5-checksum-of-license</em>@<em>hostname</em>/setup/api/settings/authorized-keys'
224+
curl 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api/settings/authorized-keys'
227225
</pre>
228226

229227
## Add a new authorized SSH key
@@ -244,7 +242,7 @@ Name | Type | Description
244242
### Example
245243

246244
<pre class="terminal">
247-
curl -X POST 'http://license:<em>md5-checksum-of-license</em>@<em>hostname</em>/setup/api/settings/authorized-keys' -F authorized_key=@<em>/path/to/key.pub</em>
245+
curl -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>
248246
</pre>
249247

250248
## Remove an authorized SSH key
@@ -265,5 +263,5 @@ Name | Type | Description
265263
### Example
266264

267265
<pre class="terminal">
268-
curl -X DELETE 'http://license:<em>md5-checksum-of-license</em>@<em>hostname</em>/setup/api/settings/authorized-keys' -F authorized_key=@<em>/path/to/key.pub</em>
266+
curl -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>
269267
</pre>

0 commit comments

Comments
 (0)