8000 Merge pull request #859 from github/admin_ports · toyhub/developer.github.com@15f3bd7 · GitHub
[go: up one dir, main page]
Skip to content

Commit 15f3bd7

Browse files
kdaiglekdaigle
committed
Merge pull request github#859 from github/admin_ports
every curl needs optional s, and admin port
2 parents edcc8eb + 83f0f99 commit 15f3bd7

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

‎content/v3/enterprise/management_console.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ You need to pass your [Management Console password](https://help.github.com/ente
2424
Use the `api_key` parameter to send this token with each request. For example:
2525

2626
<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>'
2828
</pre>
2929

3030
You can also use standard HTTP authentication to send this token. For example:
3131

3232
<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'
3434
</pre>
3535

3636
## Upload a license for the first time
@@ -64,13 +64,13 @@ For a list of the available settings, see [the `/setup/api/settings` endpoint](#
6464

6565
<pre class="terminal">
6666
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
6868
</pre>
6969

7070
### Example
7171

7272
<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=&lt;<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=&lt;<em>/path/to/settings.json</em>
7474
</pre>
7575

7676
## Upgrade a license
@@ -89,13 +89,13 @@ Name | Type | Description
8989

9090
<pre class="terminal">
9191
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
9393
</pre>
9494

9595
### Example
9696

9797
<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'
9999
</pre>
100100

101101
## Check configuration status
@@ -124,7 +124,7 @@ Status | Description
124124
### Example
125125

126126
<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'
128128
</pre>
129129

130130
## Start a configuration process
@@ -137,13 +137,13 @@ This endpoint allows you to start a configuration process at any time for your u
137137

138138
<pre class="terminal">
139139
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
141141
</pre>
142142

143143
### Example
144144

145145
<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'
147147
</pre>
148148

149149
## Retrieve settings
@@ -158,7 +158,7 @@ curl -L -X POST 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>
158158
### Example
159159

160160
<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'
162162
</pre>
163163

164164
## Modify settings
@@ -180,7 +180,7 @@ HTTP/1.1 204 No Content
180180
### Example
181181

182182
<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`"
184184
</pre>
185185

186186
## Check maintenance status
@@ -197,7 +197,7 @@ Check your installation's maintenance status:
197197
### Example
198198

199199
<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'
201201
</pre>
202202

203203
## Enable or disable maintenance mode
@@ -224,7 +224,7 @@ The possible values for `when` are `now` or any date parseable by
224224
### Example
225225

226226
<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>'
228228
</pre>
229229

230230
## Retrieve authorized SSH keys
@@ -239,7 +239,7 @@ curl -L -X POST 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>
239239
### Example
240240

241241
<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'
243243
</pre>
244244

245245
## Add a new authorized SSH key
@@ -260,7 +260,7 @@ Name | Type | Description
260260
### Example
261261

262262
<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>
264264
</pre>
265265

266266
## Remove an authorized SSH key
@@ -281,5 +281,5 @@ Name | Type | Description
281281
### Example
282282

283283
<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>
285285
</pre>

0 commit comments

Comments
 (0)
0