Skip to content
This repository was archived by the owner on Nov 1, 2017. It is now read-only.

every curl needs optional s, and admin port #859

Merged
merged 5 commits into from
Sep 22, 2015
Merged

every curl needs optional s, and admin port #859

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f0868f0
every curl needs optional s, and admin port
brntbeer Sep 11, 2015
74071af
remove (s) from curl commands
brntbeer Sep 13, 2015
277d62f
response location should be <em>'d and have admin_port
brntbeer Sep 13, 2015
8630086
forgot to remove the last (s)
brntbeer Sep 13, 2015
83f0f99
remove duplicate admin_port
brntbeer Sep 14, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions content/v3/enterprise/management_console.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ You need to pass your [Management Console password](https://help.github.com/ente
Use the `api_key` parameter to send this token with each request. For example:

<pre class="terminal">
$ curl -L 'http://<em>hostname</em>/setup/api?api_key=<em>your-amazing-password</em>'
$ curl -L 'http://<em>hostname</em>:<em>admin_port</em>/setup/api?api_key=<em>your-amazing-password</em>'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe console_port or mention admin_port specifically above?

</pre>

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

<pre class="terminal">
$ curl -L 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api'
$ curl -L 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api'
</pre>

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

<pre class="terminal">
HTTP/1.1 202 Created
Location: http://<em>hostname</em>/setup/api/configcheck
Location: http://<em>hostname</em>:<em>admin_port</em>/setup/api/configcheck
</pre>

### Example

<pre class="terminal">
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>
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>
</pre>

## Upgrade a license
Expand All @@ -89,13 +89,13 @@ Name | Type | Description

<pre class="terminal">
HTTP/1.1 202 Accepted
Location: http://hostname/setup/api/configcheck
Location: http://<em>hostname</em>:<em>admin_port</em>/setup/api/configcheck
</pre>

### Example

<pre class="terminal">
curl -L -X POST 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api/upgrade'
curl -L -X POST 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/upgrade'
</pre>

## Check configuration status
Expand Down Expand Up @@ -124,7 +124,7 @@ Status | Description
### Example

<pre class="terminal">
curl -L 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api/configcheck'
curl -L 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/configcheck'
</pre>

## Start a configuration process
Expand All @@ -137,13 +137,13 @@ This endpoint allows you to start a configuration process at any time:

<pre class="terminal">
HTTP/1.1 202 Accepted
Location: http://hostname/setup/api/configcheck
Location: http://<em>hostname</em>:<em>admin_port</em>/setup/api/configcheck
</pre>

### Example

<pre class="terminal">
curl -L -X POST 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api/configure'
curl -L -X POST 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/configure'
</pre>

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

<pre class="terminal">
curl -L 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api/settings'
curl -L 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/settings'
</pre>

## Modify settings
Expand All @@ -180,7 +180,7 @@ HTTP/1.1 204 No Content
### Example

<pre class="terminal">
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`"
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`"
</pre>

## Check maintenance status
Expand All @@ -197,7 +197,7 @@ Check your installation's maintenance status:
### Example

<pre class="terminal">
curl -L 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api/maintenance'
curl -L 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/maintenance'
</pre>

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

<pre class="terminal">
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>'
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>'
</pre>

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

<pre class="terminal">
curl -L 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api/settings/authorized-keys'
curl -L 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>:<em>admin_port</em>/setup/api/settings/authorized-keys'
</pre>

## Add a new authorized SSH key
Expand All @@ -260,7 +260,7 @@ Name | Type | Description
### Example

<pre class="terminal">
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>
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>
</pre>

## Remove an authorized SSH key
Expand All @@ -281,5 +281,5 @@ Name | Type | Description
### Example

<pre class="terminal">
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>
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>
</pre>
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy