-
Notifications
You must be signed in to change notification settings - Fork 235
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d97436b
commit 760cf60
Showing
32 changed files
with
256 additions
and
240 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -68503,15 +68503,15 @@ | |
| }, | ||
| "/manage/v1/config/init": { | ||
| "post": { | ||
| "summary": "Initialize instance configuration with license upload", | ||
| "description": "When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.\n\nNote that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/[email protected]/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process.\n\nThis endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", | ||
| "summary": "Initialize instance configuration with license and password", | ||
| "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/[email protected]/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", | ||
| "operationId": "enterprise-admin/initialize-instance-configuration", | ||
| "tags": [ | ||
| "enterprise-admin" | ||
| ], | ||
| "externalDocs": { | ||
| "description": "API method documentation", | ||
| "url": "https://docs.github.com/[email protected]/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload" | ||
| "url": "https://docs.github.com/[email protected]/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" | ||
| }, | ||
| "servers": [ | ||
| { | ||
|
|
@@ -68554,7 +68554,7 @@ | |
| "default": { | ||
| "value": { | ||
| "license": "@enterprise.ghl", | ||
| "password": "secret-password!" | ||
| "password": "provide-password-here!" | ||
| } | ||
| } | ||
| } | ||
|
|
@@ -68749,7 +68749,7 @@ | |
| }, | ||
| "put": { | ||
| "summary": "Upload an enterprise license", | ||
| "description": "Uploads an enterprise license. This operation does not automatically activate the license.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", | ||
| "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", | ||
| "operationId": "enterprise-admin/license-upload", | ||
| "tags": [ | ||
| "enterprise-admin" | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19011,13 +19011,14 @@ paths: | |
| subcategory: manage-ghes | ||
| "/manage/v1/config/init": | ||
| post: | ||
| summary: Initialize instance configuration with license upload | ||
| summary: Initialize instance configuration with license and password | ||
| description: |- | ||
| When you boot a GitHub instance for the first time, you can use this endpoint to upload a license. | ||
| When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. | ||
|
|
||
| Note that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/[email protected]/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process. | ||
| > [!IMPORTANT] | ||
| > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/[email protected]/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) | ||
|
|
||
| This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console. | ||
| The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. | ||
|
|
||
| > [!NOTE] | ||
| > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). | ||
|
|
@@ -19026,7 +19027,7 @@ paths: | |
| - enterprise-admin | ||
| externalDocs: | ||
| description: API method documentation | ||
| url: https://docs.github.com/[email protected]/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload | ||
| url: https://docs.github.com/[email protected]/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password | ||
| servers: | ||
| - url: "{protocol}://{hostname}" | ||
| variables: | ||
|
|
@@ -19057,7 +19058,7 @@ paths: | |
| default: | ||
| value: | ||
| license: "@enterprise.ghl" | ||
| password: secret-password! | ||
| password: provide-password-here! | ||
| responses: | ||
| '202': | ||
| description: Response | ||
|
|
@@ -19202,7 +19203,7 @@ paths: | |
| put: | ||
| summary: Upload an enterprise license | ||
| description: |- | ||
| Uploads an enterprise license. This operation does not automatically activate the license. | ||
| Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. | ||
|
|
||
| > [!NOTE] | ||
| > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -68503,15 +68503,15 @@ | |
| }, | ||
| "/manage/v1/config/init": { | ||
| "post": { | ||
| "summary": "Initialize instance configuration with license upload", | ||
| "description": "When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.\n\nNote that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/[email protected]/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process.\n\nThis endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", | ||
| "summary": "Initialize instance configuration with license and password", | ||
| "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/[email protected]/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", | ||
| "operationId": "enterprise-admin/initialize-instance-configuration", | ||
| "tags": [ | ||
| "enterprise-admin" | ||
| ], | ||
| "externalDocs": { | ||
| "description": "API method documentation", | ||
| "url": "https://docs.github.com/[email protected]/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload" | ||
| "url": "https://docs.github.com/[email protected]/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" | ||
| }, | ||
| "servers": [ | ||
| { | ||
|
|
@@ -68554,7 +68554,7 @@ | |
| "default": { | ||
| "value": { | ||
| "license": "@enterprise.ghl", | ||
| "password": "secret-password!" | ||
| "password": "provide-password-here!" | ||
| } | ||
| } | ||
| } | ||
|
|
@@ -68749,7 +68749,7 @@ | |
| }, | ||
| "put": { | ||
| "summary": "Upload an enterprise license", | ||
| "description": "Uploads an enterprise license. This operation does not automatically activate the license.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", | ||
| "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", | ||
| "operationId": "enterprise-admin/license-upload", | ||
| "tags": [ | ||
| "enterprise-admin" | ||
|
|
||
Oops, something went wrong.