{ "info": { "_postman_id": "4accd35f-8603-4413-b9f3-3ad305b9708d", "name": "GitHub Setup API", "description": "The GitHub Setup APIs provide endpoints for configuring and managing the initial setup and administrative settings of GitHub Enterprise Server instances. These APIs allow system administrators to programmatically control enterprise-level configurations such as authentication settings, license management, maintenance mode operations, server statistics and health checks, and other foundational setup tasks required to deploy and maintain a GitHub Enterprise Server installation. This API is primarily used by DevOps teams and system administrators to automate GitHub Enterprise Server deployments, integrate server management into infrastructure-as-code workflows, monitor server health and performance, and ensure consistent configuration across multiple enterprise instances.\n\nContact Support:\n Name: Support", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T13:18:08.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "lastUpdatedBy": "35240", "uid": "35240-4accd35f-8603-4413-b9f3-3ad305b9708d" }, "item": [ { "name": "setup", "item": [ { "name": "api", "item": [ { "name": "configcheck", "item": [ { "name": "GitHub Get the Configuration Status", "id": "ba0b4a89-53f4-4733-8d35-643bdb1c4698", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{protocol}}://:hostname/setup/api/configcheck", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "configcheck" ], "variable": [ { "id": "c57814fa-eee3-4758-8c43-2c3959602299", "key": "hostname", "value": "HOSTNAME" } ] }, "description": "This endpoint allows you to check the status of the most recent configuration process:\n\nNote that you may need to wait several seconds after you start a process before you can check its status.\n\nThe different statuses are:\n\n| Status | Description |\n| - | |\n| `PENDING` | The job has not started yet |\n| `CONFIGURING` | The job is running |\n| `DONE` | The job has finished correctly |\n| `FAILED` | The job has finished unexpectedly |" }, "response": [ { "id": "9829ef6a-893c-456e-9c82-e82bf0f544c6", "name": "Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{protocol}}://:hostname/setup/api/configcheck", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "configcheck" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"progress\": [\n {\n \"status\": \"\",\n \"key\": \"\"\n },\n {\n \"status\": \"\",\n \"key\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-9829ef6a-893c-456e-9c82-e82bf0f544c6" }, { "id": "48b19dde-6ec5-4057-8970-321eb7c39126", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{protocol}}://:hostname/setup/api/configcheck", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "configcheck" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-48b19dde-6ec5-4057-8970-321eb7c39126" } ], "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-ba0b4a89-53f4-4733-8d35-643bdb1c4698" } ], "id": "1e10c3ec-7935-403a-b51b-86d8990847f4", "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-1e10c3ec-7935-403a-b51b-86d8990847f4" }, { "name": "configure", "item": [ { "name": "GitHub Start Configuration Process", "id": "626d9fd1-d988-412b-a818-d2580cd0bfc9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{protocol}}://:hostname/setup/api/configure", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "configure" ], "variable": [ { "id": "2793c6cc-e828-4fb2-a7da-aea50fc06927", "key": "hostname", "value": "HOSTNAME" } ] }, "description": "The GitHub Setup API's `/setup/api/configure` endpoint accepts POST requests to initiate the configuration process for a new GitHub Enterprise Server instance. This endpoint is typically called during the initial setup phase when administrators need to establish basic system settings such as management console password, hostname, and other foundational configurations. The API operation triggers the configuration workflow that prepares the instance for use, and it returns a response indicating whether the configuration process has successfully started or if any errors occurred during initialization." }, "response": [ { "id": "19e3a893-5357-4a7e-9282-df0b7c45294c", "name": "Response", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{protocol}}://:hostname/setup/api/configure", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "configure" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-19e3a893-5357-4a7e-9282-df0b7c45294c" }, { "id": "08e4df1c-7448-4d87-aa75-ee1d5c54abfc", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{protocol}}://:hostname/setup/api/configure", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "configure" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-08e4df1c-7448-4d87-aa75-ee1d5c54abfc" } ], "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-626d9fd1-d988-412b-a818-d2580cd0bfc9" } ], "id": "26938299-defb-42d0-9925-45655f46ccb5", "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-26938299-defb-42d0-9925-45655f46ccb5" }, { "name": "maintenance", "item": [ { "name": "GitHub Get the Maintenance Status", "id": "31203c4e-85f9-4d48-837b-c06ccd73ac9c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{protocol}}://:hostname/setup/api/maintenance", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "maintenance" ], "variable": [ { "id": "200b0186-7649-4c39-82ef-47edbf8fdbf0", "key": "hostname", "value": "HOSTNAME" } ] }, "description": "The GitHub Setup API endpoint `/setup/api/maintenance` using the GET method retrieves the current maintenance status of a GitHub Enterprise Server instance. This operation allows administrators and monitoring systems to programmatically check whether the server is currently in maintenance mode, which is useful for coordinating deployments, upgrades, or troubleshooting activities. The endpoint returns information about the maintenance state, helping teams understand if the instance is available for normal operations or if maintenance procedures are currently active, enabling better orchestration of administrative tasks and communication with users about system availability." }, "response": [ { "id": "cca06a84-73c1-4c8f-a90f-19f4baaa1cd0", "name": "Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{protocol}}://:hostname/setup/api/maintenance", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "maintenance" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"scheduled_time\": \"\",\n \"connection_services\": [\n {\n \"name\": \"\",\n \"number\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-cca06a84-73c1-4c8f-a90f-19f4baaa1cd0" }, { "id": "7f0c4936-27dd-4ec4-89a3-f5788611beb7", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{protocol}}://:hostname/setup/api/maintenance", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "maintenance" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-7f0c4936-27dd-4ec4-89a3-f5788611beb7" } ], "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-31203c4e-85f9-4d48-837b-c06ccd73ac9c" }, { "name": "GitHub Enable or Disable Maintenance Mode", "id": "2ae2c83c-149b-419a-a035-d574f3a3c4dc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) A JSON string with the attributes `enabled` and `when`.\n\nThe possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.\n\nThe possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic).", "key": "maintenance", "value": "" } ] }, "url": { "raw": "{{protocol}}://:hostname/setup/api/maintenance", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "maintenance" ], "variable": [ { "id": "75b83d06-15c4-4264-8a71-562050fa5f10", "key": "hostname", "value": "HOSTNAME" } ] }, "description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode)." }, "response": [ { "id": "f4867b84-89de-4374-829e-c244abdc9efb", "name": "Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) A JSON string with the attributes `enabled` and `when`.\n\nThe possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.\n\nThe possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic).", "key": "maintenance", "value": "" } ] }, "url": { "raw": "{{protocol}}://:hostname/setup/api/maintenance", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "maintenance" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"scheduled_time\": \"\",\n \"connection_services\": [\n {\n \"name\": \"\",\n \"number\": \"\"\n },\n {\n \"name\": \"\",\n \"number\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-f4867b84-89de-4374-829e-c244abdc9efb" }, { "id": "cc4a48e1-841f-4fed-9662-51b6c0314451", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) A JSON string with the attributes `enabled` and `when`.\n\nThe possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.\n\nThe possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic).", "key": "maintenance", "value": "" } ] }, "url": { "raw": "{{protocol}}://:hostname/setup/api/maintenance", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "maintenance" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-cc4a48e1-841f-4fed-9662-51b6c0314451" } ], "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-2ae2c83c-149b-419a-a035-d574f3a3c4dc" } ], "id": "cbddd673-ebef-495d-a4e3-991d13ac1798", "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-cbddd673-ebef-495d-a4e3-991d13ac1798" }, { "name": "settings", "item": [ { "name": "authorized-keys", "item": [ { "name": "GitHub Get All Authorized Ssh Keys", "id": "60f279e9-8664-4ecc-8970-3a6c60e1b2e3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{protocol}}://:hostname/setup/api/settings/authorized-keys", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "settings", "authorized-keys" ], "variable": [ { "id": "7866281f-190f-401d-9443-baf1617aa461", "key": "hostname", "value": "HOSTNAME" } ] }, "description": "The GitHub Setup API endpoint `/setup/api/settings/authorized-keys` with the GET method retrieves a complete list of all authorized SSH keys that have been configured for the GitHub instance. This operation allows administrators to view all SSH public keys that are currently authorized for authentication purposes, providing visibility into which keys have access to the system. The endpoint returns information about each authorized key, which typically includes details such as the key fingerprint, key type, and associated metadata. This is particularly useful for security audits, access management, and ensuring that only approved SSH keys maintain access to the GitHub server." }, "response": [ { "id": "985100e9-ae81-4d0f-88a0-d2e5c5e3b89b", "name": "Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{protocol}}://:hostname/setup/api/settings/authorized-keys", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "settings", "authorized-keys" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"pretty-print\": \"\"\n },\n {\n \"key\": \"\",\n \"pretty-print\": \"\"\n }\n]", "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-985100e9-ae81-4d0f-88a0-d2e5c5e3b89b" }, { "id": "5eb795e7-676c-43d6-ba26-4b793f20c9ad", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{protocol}}://:hostname/setup/api/settings/authorized-keys", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "settings", "authorized-keys" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-5eb795e7-676c-43d6-ba26-4b793f20c9ad" } ], "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-60f279e9-8664-4ecc-8970-3a6c60e1b2e3" }, { "name": "GitHub Add an Authorized Ssh Key", "id": "10d0ae18-27b3-4549-8915-40fda64be4be", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) The public SSH key.", "key": "authorized_key", "value": "" } ] }, "url": { "raw": "{{protocol}}://:hostname/setup/api/settings/authorized-keys", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "settings", "authorized-keys" ], "variable": [ { "id": "05e808a1-e41a-4590-9436-6d96ddc6e46a", "key": "hostname", "value": "HOSTNAME" } ] }, "description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode)." }, "response": [ { "id": "14a61553-a3cc-4215-be7a-d1622897dfdb", "name": "Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) The public SSH key.", "key": "authorized_key", "value": "" } ] }, "url": { "raw": "{{protocol}}://:hostname/setup/api/settings/authorized-keys", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "settings", "authorized-keys" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"pretty-print\": \"\"\n },\n {\n \"key\": \"\",\n \"pretty-print\": \"\"\n }\n]", "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-14a61553-a3cc-4215-be7a-d1622897dfdb" }, { "id": "43cf3680-e099-45a0-90e9-37e6af31bd94", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) The public SSH key.", "key": "authorized_key", "value": "" } ] }, "url": { "raw": "{{protocol}}://:hostname/setup/api/settings/authorized-keys", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "settings", "authorized-keys" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-43cf3680-e099-45a0-90e9-37e6af31bd94" } ], "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-10d0ae18-27b3-4549-8915-40fda64be4be" }, { "name": "GitHub Remove an Authorized Ssh Key", "id": "c0f3850f-769c-407a-a9a7-c66587bd526b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) The public SSH key.", "key": "authorized_key", "value": "" } ] }, "url": { "raw": "{{protocol}}://:hostname/setup/api/settings/authorized-keys", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "settings", "authorized-keys" ], "variable": [ { "id": "b7ee9b5b-7027-49dd-a5b9-3d4fe5d72cf9", "key": "hostname", "value": "HOSTNAME" } ] }, "description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode)." }, "response": [ { "id": "8481d82d-8027-4e18-82a5-c1334fc17c8c", "name": "Response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) The public SSH key.", "key": "authorized_key", "value": "" } ] }, "url": { "raw": "{{protocol}}://:hostname/setup/api/settings/authorized-keys", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "settings", "authorized-keys" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"key\": \"\",\n \"pretty-print\": \"\"\n },\n {\n \"key\": \"\",\n \"pretty-print\": \"\"\n }\n]", "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-8481d82d-8027-4e18-82a5-c1334fc17c8c" }, { "id": "c90e230f-19a6-4bad-a5c7-fa88af2981ca", "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) The public SSH key.", "key": "authorized_key", "value": "" } ] }, "url": { "raw": "{{protocol}}://:hostname/setup/api/settings/authorized-keys", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "settings", "authorized-keys" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-c90e230f-19a6-4bad-a5c7-fa88af2981ca" } ], "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-c0f3850f-769c-407a-a9a7-c66587bd526b" } ], "id": "324ced7d-4566-405d-a4da-75f00b76bf6f", "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-324ced7d-4566-405d-a4da-75f00b76bf6f" }, { "name": "GitHub Get Settings", "id": "60068b0b-0685-4954-aadd-f38833af9030", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{protocol}}://:hostname/setup/api/settings", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "settings" ], "variable": [ { "id": "ff4a19de-0724-429a-8724-b8bbc17756f1", "key": "hostname", "value": "HOSTNAME" } ] }, "description": "Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#set-settings).\n\n**Note:** You cannot retrieve the management console password with the Enterprise administration API." }, "response": [ { "id": "c3efa723-2900-40db-afec-2a83a6bde041", "name": "Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{protocol}}://:hostname/setup/api/settings", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "settings" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"enterprise\": {\n \"private_mode\": \"\",\n \"public_pages\": \"\",\n \"subdomain_isolation\": \"\",\n \"signup_enabled\": \"\",\n \"github_hostname\": \"\",\n \"identicons_host\": \"\",\n \"http_proxy\": \"\",\n \"auth_mode\": \"\",\n \"expire_sessions\": \"\",\n \"admin_password\": \"\",\n \"configuration_id\": \"\",\n \"configuration_run_count\": \"\",\n \"avatar\": {\n \"enabled\": \"\",\n \"uri\": \"\"\n },\n \"customer\": {\n \"name\": \"\",\n \"email\": \"\",\n \"uuid\": \"\",\n \"secret_key_data\": \"\",\n \"public_key_data\": \"\"\n },\n \"license\": {\n \"seats\": \"\",\n \"evaluation\": \"\",\n \"perpetual\": \"\",\n \"unlimited_seating\": \"\",\n \"support_key\": \"\",\n \"ssh_allowed\": \"\",\n \"cluster_support\": \"\",\n \"expire_at\": \"\"\n },\n \"github_ssl\": {\n \"enabled\": \"\",\n \"cert\": \"\",\n \"key\": \"\"\n },\n \"ldap\": {\n \"host\": \"\",\n \"port\": \"\",\n \"uid\": \"\",\n \"bind_dn\": \"\",\n \"password\": \"\",\n \"method\": \"\",\n \"search_strategy\": \"\",\n \"admin_group\": \"\",\n \"virtual_attribute_enabled\": \"\",\n \"recursive_group_search\": \"\",\n \"posix_support\": \"\",\n \"user_sync_emails\": \"\",\n \"user_sync_keys\": \"\",\n \"user_sync_interval\": \"\",\n \"team_sync_interval\": \"\",\n \"sync_enabled\": \"\",\n \"reconciliation\": {\n \"user\": \"\",\n \"org\": \"\"\n },\n \"profile\": {\n \"uid\": \"\",\n \"name\": \"\",\n \"mail\": \"\",\n \"key\": \"\"\n }\n },\n \"cas\": {\n \"url\": \"\"\n },\n \"saml\": {\n \"sso_url\": \"\",\n \"certificate\": \"\",\n \"certificate_path\": \"\",\n \"issuer\": \"\",\n \"idp_initiated_sso\": \"\",\n \"disable_admin_demote\": \"\"\n },\n \"github_oauth\": {\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"organization_name\": \"\",\n \"organization_team\": \"\"\n },\n \"smtp\": {\n \"enabled\": \"\",\n \"address\": \"\",\n \"authentication\": \"\",\n \"port\": \"\",\n \"domain\": \"\",\n \"username\": \"\",\n \"user_name\": \"\",\n \"enable_starttls_auto\": \"\",\n \"password\": \"\",\n \"discard-to-noreply-address\": \"\",\n \"support_address\": \"\",\n \"support_address_type\": \"\",\n \"noreply_address\": \"\"\n },\n \"ntp\": {\n \"primary_server\": \"\",\n \"secondary_server\": \"\"\n },\n \"timezone\": \"\",\n \"snmp\": {\n \"enabled\": \"\",\n \"community\": \"\"\n },\n \"syslog\": {\n \"enabled\": \"\",\n \"server\": \"\",\n \"protocol_name\": \"\"\n },\n \"assets\": \"\",\n \"pages\": {\n \"enabled\": \"\"\n },\n \"collectd\": {\n \"enabled\": \"\",\n \"server\": \"\",\n \"port\": \"\",\n \"encryption\": \"\",\n \"username\": \"\",\n \"password\": \"\"\n },\n \"mapping\": {\n \"enabled\": \"\",\n \"tileserver\": \"\",\n \"basemap\": \"\",\n \"token\": \"\"\n },\n \"load_balancer\": \"\"\n },\n \"run_list\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-c3efa723-2900-40db-afec-2a83a6bde041" }, { "id": "af5da856-2d65-448b-ac14-2d2a17ef91d4", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{protocol}}://:hostname/setup/api/settings", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "settings" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-af5da856-2d65-448b-ac14-2d2a17ef91d4" } ], "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-60068b0b-0685-4954-aadd-f38833af9030" }, { "name": "GitHub Set Settings", "id": "7d780c75-85d2-4f67-9bfe-cc97c9588f56", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings).", "key": "settings", "value": "" } ] }, "url": { "raw": "{{protocol}}://:hostname/setup/api/settings", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "settings" ], "variable": [ { "id": "536396c2-14fb-46db-b765-a4c301ad7bef", "key": "hostname", "value": "HOSTNAME" } ] }, "description": "Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings).\n\n**Notes:**\n\n- The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).\n- You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see \"[Command-line utilities](https://docs.github.com/enterprise-server@3.9/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password).\"" }, "response": [ { "id": "947a1537-eae8-4080-ae15-481a20663e3d", "name": "Response", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings).", "key": "settings", "value": "" } ] }, "url": { "raw": "{{protocol}}://:hostname/setup/api/settings", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "settings" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-947a1537-eae8-4080-ae15-481a20663e3d" }, { "id": "2444252a-4396-43bb-a631-ce3368d4c44c", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings).", "key": "settings", "value": "" } ] }, "url": { "raw": "{{protocol}}://:hostname/setup/api/settings", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "settings" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-2444252a-4396-43bb-a631-ce3368d4c44c" } ], "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-7d780c75-85d2-4f67-9bfe-cc97c9588f56" } ], "id": "e1b5d07c-fb7c-4822-b694-1daee1361baa", "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-e1b5d07c-fb7c-4822-b694-1daee1361baa" }, { "name": "start", "item": [ { "name": "GitHub Create Github License", "id": "399a7901-2962-4626-b766-60e40d1a9699", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The content of your _.ghl_ license file.", "key": "license", "value": "", "type": "text" }, { "description": "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.", "key": "password", "value": "", "type": "text" }, { "description": "An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings).", "key": "settings", "value": "", "type": "text" } ] }, "url": { "raw": "{{protocol}}://:hostname/setup/api/start", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "start" ], "variable": [ { "id": "6c2d33d1-ac0c-4cbb-9871-2106854a4248", "key": "hostname", "value": "HOSTNAME" } ] }, "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. 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.\n\n**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)." }, "response": [ { "id": "937d2f55-0713-4457-851a-13227d564a5f", "name": "Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The content of your _.ghl_ license file.", "key": "license", "value": "", "type": "text" }, { "description": "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.", "key": "password", "value": "", "type": "text" }, { "description": "An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings).", "key": "settings", "value": "", "type": "text" } ] }, "url": { "raw": "{{protocol}}://:hostname/setup/api/start", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "start" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-937d2f55-0713-4457-851a-13227d564a5f" }, { "id": "9801b813-bed7-4373-a678-c2e5a5f02e55", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The content of your _.ghl_ license file.", "key": "license", "value": "", "type": "text" }, { "description": "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.", "key": "password", "value": "", "type": "text" }, { "description": "An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings).", "key": "settings", "value": "", "type": "text" } ] }, "url": { "raw": "{{protocol}}://:hostname/setup/api/start", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "start" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-9801b813-bed7-4373-a678-c2e5a5f02e55" } ], "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-399a7901-2962-4626-b766-60e40d1a9699" } ], "id": "7f433d5a-4729-4ba6-b65c-ad8d2b5950e7", "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-7f433d5a-4729-4ba6-b65c-ad8d2b5950e7" }, { "name": "upgrade", "item": [ { "name": "GitHub Upgrade License", "id": "db4a87f6-8268-4524-a57f-068aad03faa3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" } ], "body": { "mode": "formdata", "formdata": [ { "description": "The content of your new _.ghl_ license file.", "key": "license", "value": "", "type": "text" } ] }, "url": { "raw": "{{protocol}}://:hostname/setup/api/upgrade", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "upgrade" ], "variable": [ { "id": "5e6bd124-6b48-41ac-8838-64c7c8142894", "key": "hostname", "value": "HOSTNAME" } ] }, "description": "This API upgrades your license and also triggers the configuration process.\n\n**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)." }, "response": [ { "id": "fb96508e-34b9-4162-9ce9-4f9661130a8b", "name": "Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "description": "The content of your new _.ghl_ license file.", "key": "license", "value": "", "type": "text" } ] }, "url": { "raw": "{{protocol}}://:hostname/setup/api/upgrade", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "upgrade" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-fb96508e-34b9-4162-9ce9-4f9661130a8b" }, { "id": "41fd0822-b43d-4dfa-aefc-78a22c6ec2e8", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "description": "The content of your new _.ghl_ license file.", "key": "license", "value": "", "type": "text" } ] }, "url": { "raw": "{{protocol}}://:hostname/setup/api/upgrade", "protocol": "{{protocol}}", "port": "hostname", "path": [ "setup", "api", "upgrade" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-41fd0822-b43d-4dfa-aefc-78a22c6ec2e8" } ], "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-db4a87f6-8268-4524-a57f-068aad03faa3" } ], "id": "b23a84e3-e118-4817-8d70-d15046d0efb5", "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-b23a84e3-e118-4817-8d70-d15046d0efb5" } ], "id": "dbd36bdd-c1cb-4cea-85de-cb0cfdfa8b76", "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-dbd36bdd-c1cb-4cea-85de-cb0cfdfa8b76" } ], "id": "b1c9debd-8978-4b8e-aac0-e44dc991ea48", "createdAt": "2026-06-05T13:18:09.000Z", "updatedAt": "2026-06-05T13:18:09.000Z", "uid": "35240-b1c9debd-8978-4b8e-aac0-e44dc991ea48" } ], "variable": [ { "key": "hostname", "value": "HOSTNAME" }, { "key": "protocol", "value": "http" }, { "key": "baseUrl", "value": "{{protocol}}://{{hostname}}/api/v3" } ] }