diff --git a/content/v3/enterprise/management_console.md b/content/v3/enterprise/management_console.md index 53950f25a3..e2915032a7 100644 --- a/content/v3/enterprise/management_console.md +++ b/content/v3/enterprise/management_console.md @@ -14,22 +14,24 @@ You must explicitly set the port number when making API calls to the Management If you don't want to provide a port number, you'll need to configure your tool to automatically follow redirects. +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). + {{/tip}} ## Authentication -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). +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). Use the `api_key` parameter to send this token with each request. For example: ``` command-line -$ curl -L 'http://hostname:admin_port/setup/api?api_key=your-amazing-password' +$ curl -L 'https://hostname:admin_port/setup/api?api_key=your-amazing-password' ``` You can also use standard HTTP authentication to send this token. For example: ``` command-line -$ curl -L 'http://api_key:your-amazing-password@hostname:admin_port/setup/api' +$ curl -L 'https://api_key:your-amazing-password@hostname:admin_port/setup/api' ``` ## Upload a license for the first time @@ -69,7 +71,7 @@ For a list of the available settings, see [the `/setup/api/settings` endpoint](# ### Example ``` command-line -$ curl -L -X POST 'http://hostname:admin_port/setup/api/start' -F license=@/path/to/github-enterprise.ghl -F "password=your-amazing-password" -F settings=</path/to/settings.json +$ curl -L -X POST 'https://hostname:admin_port/setup/api/start' -F license=@/path/to/github-enterprise.ghl -F "password=your-amazing-password" -F settings=</path/to/settings.json ``` ## Upgrade a license @@ -94,7 +96,7 @@ Name | Type | Description ### Example ``` command-line -$ curl -L -X POST 'http://api_key:your-amazing-password@hostname:admin_port/setup/api/upgrade' +$ curl -L -X POST 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/upgrade' ``` ## Check configuration status @@ -123,7 +125,7 @@ Status | Description ### Example ``` command-line -$ curl -L 'http://api_key:your-amazing-password@hostname:admin_port/setup/api/configcheck' +$ curl -L 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/configcheck' ``` ## Start a configuration process @@ -142,7 +144,7 @@ This endpoint allows you to start a configuration process at any time for your u ### Example ``` command-line -$ curl -L -X POST 'http://api_key:your-amazing-password@hostname:admin_port/setup/api/configure' +$ curl -L -X POST 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/configure' ``` ## Retrieve settings @@ -157,7 +159,7 @@ $ curl -L -X POST 'http://api_key:your-amazing-password@hostnameyour-amazing-password@hostname:admin_port/setup/api/settings' +$ curl -L 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/settings' ``` ## Modify settings @@ -179,7 +181,7 @@ Name | Type | Description ### Example ``` command-line -$ curl -L -X PUT 'http://api_key:your-amazing-password@hostname:admin_port/setup/api/settings' --data-urlencode "settings=`cat /path/to/settings.json`" +$ curl -L -X PUT 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/settings' --data-urlencode "settings=`cat /path/to/settings.json`" ``` ## Check maintenance status @@ -196,7 +198,7 @@ Check your installation's maintenance status: ### Example ``` command-line -$ curl -L 'http://api_key:your-amazing-password@hostname:admin_port/setup/api/maintenance' +$ curl -L 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/maintenance' ``` ## Enable or disable maintenance mode @@ -223,7 +225,7 @@ The possible values for `when` are `now` or any date parseable by ### Example ``` command-line -$ curl -L -X POST 'http://api_key:your-amazing-password@hostname:admin_port/setup/api/maintenance' -d 'maintenance={"enabled":true, "when":"now"}' +$ curl -L -X POST 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/maintenance' -d 'maintenance={"enabled":true, "when":"now"}' ``` ## Retrieve authorized SSH keys @@ -238,7 +240,7 @@ $ curl -L -X POST 'http://api_key:your-amazing-password@hostnameyour-amazing-password@hostname:admin_port/setup/api/settings/authorized-keys' +$ curl -L 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/settings/authorized-keys' ``` ## Add a new authorized SSH key @@ -259,7 +261,7 @@ Name | Type | Description ### Example ``` command-line -$ curl -L -X POST 'http://api_key:your-amazing-password@hostname:admin_port/setup/api/settings/authorized-keys' -F authorized_key=@/path/to/key.pub +$ curl -L -X POST 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/settings/authorized-keys' -F authorized_key=@/path/to/key.pub ``` ## Remove an authorized SSH key @@ -280,5 +282,5 @@ Name | Type | Description ### Example ``` command-line -$ curl -L -X DELETE 'http://api_key:your-amazing-password@hostname:admin_port/setup/api/settings/authorized-keys' -F authorized_key=@/path/to/key.pub +$ curl -L -X DELETE 'https://api_key:your-amazing-password@hostname:admin_port/setup/api/settings/authorized-keys' -F authorized_key=@/path/to/key.pub ```
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: