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).

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).

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

$ curl 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api'

</pre>

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

When you boot a virtual machine for the first time, you can use the following endpoint to upload a license:

Name | Type | Description

-----|------|--------------

`license`|`string` |**Required**. The content of your*.ghl* license file.

`package`|`string`|**Required**. The content of your*.ghp* package file.

`settings`|`string`| Optional path to a JSON file containing your installation settings.

For a list of the available settings, see[the`/setup/api/settings` endpoint](#retrieve-settings).

<preclass="terminal">

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>

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>

</pre>

This API upgrades your licenseor packageand also triggers the configuration process:

This API upgrades your license and also triggers the configuration process:

Name | Type | Description

-----|------|--------------

`license`|`string` | The content of your new*.ghl* license file.

`package`|`string`| The content of your new*.ghp* package file.

<preclass="terminal">

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>

curl -X POST 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api/upgrade'

</pre>

<preclass="terminal">

curl 'http://license:<em>md5-checksum-of-license</em>@<em>hostname</em>/setup/api/configcheck'

curl 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api/configcheck'

</pre>

<preclass="terminal">

curl -X POST 'http://license:<em>md5-checksum-of-license</em>@<em>hostname</em>/setup/api/configure'

curl -X POST 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api/configure'

</pre>

<preclass="terminal">

curl 'http://license:<em>md5-checksum-of-license</em>@<em>hostname</em>/setup/api/settings'

curl 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api/settings'

</pre>

<preclass="terminal">

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`"

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`"

</pre>

<preclass="terminal">

curl 'http://license:<em>md5-checksum-of-license</em>@<em>hostname</em>/setup/api/maintenance'

curl 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api/maintenance'

</pre>

<preclass="terminal">

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>'

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>'

</pre>

<preclass="terminal">

curl 'http://license:<em>md5-checksum-of-license</em>@<em>hostname</em>/setup/api/settings/authorized-keys'

curl 'http://api_key:<em>your-amazing-password</em>@<em>hostname</em>/setup/api/settings/authorized-keys'

</pre>

<preclass="terminal">

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>

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>

</pre>

<preclass="terminal">

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>

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>

</pre>