Upload a license for the first time

When you boot a GitHub Enterprise Server instance for the first time, you can use the following endpoint to upload a license:

POST /setup/api/start

Note that you need to POST to /setup/api/configure to start the actual configuration process.

When using this endpoint, your GitHub Enterprise Server instance must have a password set. This can be accomplished two ways:

  1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.
  2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.

Parameters

Name Type Description
license string Required. The content of your .ghl license file.
password string You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.
settings string An optional JSON string containing the installation settings.

For a list of the available settings, see the Retrieve settings endpoint.

Example

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"

Response

HTTP/1.1 202 Created
Location: http://hostname:admin_port/setup/api/configcheck