Endpoints da API REST para gerenciar o GitHub Enterprise Server
Use a API REST para gerenciar sua GitHub Enterprise Server instância.
Sobre a API de Gerenciamento GitHub Enterprise Server
Você pode gerenciar sua instância do GitHub Enterprise Server usando a API de Gerenciamento GitHub Enterprise Server . Por exemplo, você pode recuperar informações sobre a versão do GitHub Enterprise Server software em execução na instância ou em instâncias com vários nós, exibir o status da replicação.
Dica
Você pode usar essa API para substituir a funcionalidade da API do Console de Gerenciamento, que foi removida na GitHub Enterprise Server versão 3.15.
Especifique o número da porta ao fazer chamadas de API para os endpoints da API de Gerenciamento GitHub Enterprise Server. Se a instância usar TLS, o número da porta será 8443. Caso contrário, o número da porta será 8080. Se não for possível fornecer um número de porta, será necessário configurar o seu cliente para seguir redirecionamentos automaticamente. Para saber mais, confira Configurando o TLS.
Você também pode usar a extensão GitHub Enterprise Server do GitHub CLI para invocar endpoints na API de Gerenciamento GitHub Enterprise Server. Para obter mais informações, confira o repositório github/gh-es.
Autenticação
Para autenticar solicitações à API de Gerenciamento GitHub Enterprise Server, especifique a senha da conta de administrador do site raiz da instância como um token de autenticação. Use a autenticação HTTP padrão para enviar a senha. O usuário api_key identifica o administrador do site raiz. O exemplo a seguir demonstra a autenticação para essa API. Substitua ROOT-SITE-ADMINISTRATOR-PASSWORD pela senha e ADMINISTRATION-PORT por 8443 ou 8080.
curl -L -u "api_key:ROOT-SITE-ADMINISTRATOR-PASSWORD" 'http(s)://HOSTNAME:ADMINISTRATION-PORT/manage'
Autenticação como usuário Console de Gerenciamento
Console de Gerenciamento as contas de usuário também podem autenticar-se para acessar esses endpoints. Para saber mais, confira [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/managing-access-to-the-management-console#management-console-user).
Para autenticar com a senha de uma Console de Gerenciamento conta de usuário, use a autenticação HTTP padrão. No exemplo a seguir, substitua YOUR_USER_NAME e YOUR_PASSWORD pelo nome de usuário e senha da conta.
curl -L -u "YOUR_USER_NAME:YOUR_PASSWORD" 'http(s)://HOSTNAME:ADMINISTRATION-PORT/manage'
Parâmetros de consulta
Por padrão, a resposta inclui informações sobre todos os nós configurados para a instância. Em uma instância com vários nós, os detalhes se originam de /data/user/common/cluster.conf. Você pode usar os parâmetros de consulta a seguir para filtrar a resposta para obter informações sobre nós específicos.
| Parâmetro de consulta | Descrição |
|---|---|
uuid | Identificador exclusivo para o nó. |
cluster_role | Para nodos de um cluster, as funções que se aplicam ao nó. Para saber mais, confira Sobre os nós do cluster. |
Você pode especificar vários valores para o parâmetro de consulta delimitando os valores com uma vírgula. Por exemplo, a solicitação a seguir usa curl para retornar quaisquer nós com a função web-server ou storage-server.
curl -L -u "api_key:ROOT-SITE-ADMINISTRATOR-PASSWORD" 'http(s)://HOSTNAME:ADMINISTRATION-PORT/manage/v1/config/nodes?cluster_role=WebServer,StorageServer'
Get the configured SSH keys
Gets the configured SSH keys on all available nodes. For more information, see "Accessing the administrative shell (SSH)."
http_status_code
| status_code | Descrição |
|---|---|
200 | OK |
400 | Bad request |
401 | Unauthorized |
code_samples
request_example
curl -L \
-u "api_key:your-password" \
-H "Content-Type: application/json" \
http(s)://HOSTNAME/manage/v1/access/sshResponse
Status: 200[
{
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCwcd9tu20xsJVBMWbIs+JDVQTvkLtrJ8A7eblSwC+zECver22QExC9d6zHy10MAyk1Ck7Bu6/0Z+rr/31vMcAOmNOLjExzWxBCXbtDf3758Qfw7FuvkaTE1sHztwSFi/yNhZSw7uPEWeGQiRY4UldSKG9zZvrZmxpnP8mNZzPriQ==",
"fingeprint": "bd:26:d3:a2:ad:97:c0:7c:2d:57:a4:64:f3:fb:44:45"
},
{
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCg73sgCdLL9rWcmVTmvcOgAWZaokZTeNnMFEoaZWZcVtsP4Ed+ICuSbT1wDuyL/XXzr0O2u2bKwx8Np/3UGHb4R9Re+qiz//l5OCBd3KonO2GFICQwKGmVeZ+ki89aN2JDKgfemHbvclHYBD/r56lnbt/kinw7JqGPp+ndzH8nBw==",
"fingeprint": "e1:1e:a0:f1:3f:a9:70:2d:99:dd:02:9d:39:1c:8b:a4"
}
]Set a new SSH key
Adds a SSH key to the authorized_keys file for your GitHub Enterprise Server instance. This will grant access via SSH to your instance. For more information, see "Accessing the administrative shell (SSH)."
Parâmetros para "Set a new SSH key"
| Nome, Tipo, Descrição |
|---|
key string ObrigatórioThe public SSH key to add to the |
http_status_code
| status_code | Descrição |
|---|---|
200 | OK |
400 | Bad request |
401 | Unauthorized |
500 | Internal error |
code_samples
request_example
curl -L \
-X POST \
-u "api_key:your-password" \
-H "Content-Type: application/json" \
http(s)://HOSTNAME/manage/v1/access/ssh \
-d '{"key":"ssh-rsa AAAAB3NzaC1yc2EAAAADCIABAAAAgQCY/ZiDDOFWcZnYXPwMbvwQDofXPdHxLfxPK+HWGVPd1DLcDncYBUSB0bmCU2g9Sc+oHKLoHhXp0ivau9h+EpmQJ7V8vqsRdD9pc4aL/WAnUyF4o3Y7xL94rlRpVbVo/tNjzcvqxxyzBiYyy3GciCMpYQh/uKt56B94/5PNyIGEEw=="}'Response
Status: 200[
{
"hostname": "ghe-local-primary",
"uuid": "1b6cf518-f97c-11ed-8544-061d81f7eedb",
"message": "SSH key added successfully",
"modified": true
}
]Delete a SSH key
Deletes a SSH key from the authorized_keys file for your GitHub Enterprise Server instance. This will remove access via SSH to your instance. For more information, see "Accessing the administrative shell (SSH)."
Parâmetros para "Delete a SSH key"
| Nome, Tipo, Descrição |
|---|
key string ObrigatórioThe public SSH key to remove from the |
http_status_code
| status_code | Descrição |
|---|---|
200 | OK |
400 | Bad request |
401 | Unauthorized |
500 | Internal error |
code_samples
request_example
curl -L \
-X DELETE \
-u "api_key:your-password" \
-H "Content-Type: application/json" \
http(s)://HOSTNAME/manage/v1/access/ssh \
-d '{"key":"ssh-rsa AAAAB3NzaC1yc2EAAAADCIABAAAAgQCY/ZiDDOFWcZnYXPwMbvwQDofXPdHxLfxPK+HWGVPd1DLcDncYBUSB0bmCU2g9Sc+oHKLoHhXp0ivau9h+EpmQJ7V8vqsRdD9pc4aL/WAnUyF4o3Y7xL94rlRpVbVo/tNjzcvqxxyzBiYyy3GciCMpYQh/uKt56B94/5PNyIGEEw=="}'Response
Status: 200[
{
"hostname": "ghe-local-primary",
"uuid": "1b6cf518-f97c-11ed-8544-061d81f7eedb",
"message": "SSH key removed successfully"
}
]Get the system requirement check results for configured cluster nodes
Checks if the minimum requirements for system hardware resources are met on each configured cluster node. This endpoint may take several seconds to reply.
http_status_code
| status_code | Descrição |
|---|---|
200 | OK |
400 | Bad request |
500 | Internal error |
code_samples
request_example
curl -L \
-u "api_key:your-password" \
-H "Content-Type: application/json" \
http(s)://HOSTNAME/manage/v1/checks/system-requirementsResponse
Status: 200{
"status": "OK",
"nodes": [
{
"hostname": "ghe-local-app",
"status": "OK",
"roles_status": [
{
"status": "OK",
"role": "ConsulServer"
},
{
"status": "OK",
"role": "JobServer"
},
{
"status": "OK",
"role": "WebServer"
}
]
},
{
"hostname": "ghe-local-app2",
"status": "OK",
"roles_status": [
{
"status": "OK",
"role": "ConsulServer"
},
{
"status": "OK",
"role": "GitServer"
}
]
}
]
}Get the status of services running on all cluster nodes
Gets the status of all services running on each cluster node. This endpoint may take several seconds to reply.
http_status_code
| status_code | Descrição |
|---|---|
200 | OK |
401 | Unauthorized |
500 | Internal error |
code_samples
request_example
curl -L \
-u "api_key:your-password" \
-H "Content-Type: application/json" \
http(s)://HOSTNAME/manage/v1/cluster/statusResponse
Status: 200{
"status": "OK",
"nodes": [
{
"hostname": "ghe-local-app",
"status": "OK",
"services": [
{
"status": "OK",
"name": "es",
"details": "Elasticsearch cluster is in sync (0 shards initializing, 0 shards unassigned)"
},
{
"status": "OK",
"name": "git-replication",
"details": "Git replication is in sync"
},
{
"status": "OK",
"name": "kafka-lite-admin-healthcheck",
"details": ""
},
{
"status": "OK",
"name": "kafka-lite-broker-is-reachable",
"details": ""
},
{
"status": "OK",
"name": "memcache",
"details": ""
},
{
"status": "OK",
"name": "metrics",
"details": ""
},
{
"status": "OK",
"name": "mysql-replication",
"details": "Replication is running"
},
{
"status": "OK",
"name": "mysql-failover",
"details": ""
},
{
"status": "OK",
"name": "pages",
"details": "Pages replication is in sync"
},
{
"status": "OK",
"name": "redis",
"details": "Redis is OK"
},
{
"status": "OK",
"name": "storage",
"details": "Storage replication is in sync"
}
]
},
{
"hostname": "ghe-local-app2",
"status": "OK",
"services": [
{
"status": "OK",
"name": "kafka-lite-admin-healthcheck",
"details": ""
},
{
"status": "OK",
"name": "kafka-lite-broker-is-reachable",
"details": ""
}
]
}
]
}Get the status of a ghe-config-apply run
Displays the current status of ghe-config-apply in the environment or the status of a historical run by ID.
Parâmetros para "Get the status of a ghe-config-apply run"
| Nome, Tipo, Descrição |
|---|
run_id string The unique run ID of the |
http_status_code
| status_code | Descrição |
|---|---|
200 | OK |
400 | Bad request |
401 | Unauthorized |
code_samples
request_example
curl -L \
-u "api_key:your-password" \
-H "Content-Type: application/json" \
http(s)://HOSTNAME/manage/v1/config/applyResponse
Status: 200{
"running": true,
"successful": false,
"nodes": [
{
"run_id": "d34db33f",
"hostname": "ghes-01.lan",
"running": true,
"successful": false
}
]
}Trigger a ghe-config-apply run
Triggers a run of ghe-config-apply from the ghes-manage agent on your Nomad Delegate instance.
You can provide a run ID or allow one to be generated randomly.
Parâmetros para "Trigger a ghe-config-apply run"
| Nome, Tipo, Descrição |
|---|
run_id string The run ID to execute |
http_status_code
| status_code | Descrição |
|---|---|
200 | OK |
400 | Bad request |
401 | Unauthorized |
code_samples
request_example
curl -L \
-X POST \
-u "api_key:your-password" \
-H "Content-Type: application/json" \
http(s)://HOSTNAME/manage/v1/config/apply \
-d '{"run_id":"d34db33f"}'Response
Status: 200{
"run_id": "d34db33f"
}List events from ghe-config-apply
Lists events from an in-process ghe-config-apply run on your Github Enterprise Server instance.
Parâmetros para "List events from ghe-config-apply"
| Nome, Tipo, Descrição |
|---|
last_request_id string The unique ID of the last response from a host, used for pagination. |
http_status_code
| status_code | Descrição |
|---|---|
200 | OK |
400 | Bad request |
401 | Unauthorized |
code_samples
request_example
curl -L \
-u "api_key:your-password" \
-H "Content-Type: application/json" \
http(s)://HOSTNAME/manage/v1/config/apply/eventsResponse
Status: 200{
"nodes": [
{
"node": "ghes-01.lan",
"last_request_id": "387cd628c06d606700e79be368e5e574:0cde553750689c76:0000000000000000",
"events": [
{
"timestamp": "2023-01-01T13:00:00+00:00",
"severity_text": "INFO",
"body": "Validating services",
"event_name": "Enterprise::ConfigApply::PhaseValidation#config_phase_validation",
"topology": "multinode",
"hostname": "ghes-01.lan",
"config_run_id": "d34db33f",
"trace_id": "387cd628c06d606700e79be368e5e574",
"span_id": "0cde553750689c76",
"span_parent_id": 0,
"span_depth": 0
}
]
}
]
}Initialize instance configuration with license and password
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.
Important
To start the configuration process and apply the license, you need to POST to /manage/v1/config/apply
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.
Parâmetros para "Initialize instance configuration with license and password"
| Nome, Tipo, Descrição |
|---|
license string ObrigatórioThe content of your .ghl license file. |
password string ObrigatórioThe root site administrator password. |
http_status_code
| status_code | Descrição |
|---|---|
202 | Accepted |
400 | Bad request |
401 | Unauthorized |
500 | Internal error |
code_samples
request_example
curl -L \
-X POST \
-u "api_key:your-password" \
-H "Content-Type: multipart/form-data" \
http(s)://HOSTNAME/manage/v1/config/init \
--form 'license=@enterprise.ghl' --form 'password=provide-password-here!'Response
Status: 202Get the enterprise license information
Gets information about the license that is currently set for the enterprise.
http_status_code
| status_code | Descrição |
|---|---|
200 | OK |
401 | Unauthorized |
500 | Internal error |
code_samples
request_example
curl -L \
-u "api_key:your-password" \
-H "Content-Type: application/json" \
http(s)://HOSTNAME/manage/v1/config/licenseResponse
Status: 200[
{
"advancedSecurityEnabled": true,
"advancedSecuritySeats": 0,
"clusterSupport": false,
"company": "GitHub",
"croquetSupport": true,
"customTerms": true,
"evaluation": false,
"expireAt": "2025-01-02T07:59:59Z",
"insightsEnabled": true,
"insightsExpireAt": "2025-01-02T07:59:59.999Z",
"learningLabEvaluationExpires": "2023-01-02T07:59:59Z",
"learningLabSeats": 100,
"perpetual": false,
"referenceNumber": "32a145",
"seats": 0,
"sshAllowed": true,
"supportKey\"": "",
"unlimitedSeating": true
}
]Upload an enterprise 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.
Parâmetros para "Upload an enterprise license"
| Nome, Tipo, Descrição |
|---|
apply boolean Whether to instantly apply changes from the license. Otherwise the new license can be applied using the |
| Nome, Tipo, Descrição |
|---|
license string ObrigatórioThe content of your .ghl license file. |
http_status_code
| status_code | Descrição |
|---|---|
201 | Created |
202 | Accepted |
401 | Unauthorized |
500 | Internal error |
code_samples
request_examples
curl -L \
-X PUT \
-u "api_key:your-password" \
-H "Content-Type: multipart/form-data" \
http(s)://HOSTNAME/manage/v1/config/license \
--form 'license=@enterprise.ghl'Created
Status: 201Check a license
Check the status of the license that is currently set for the enterprise.
http_status_code
| status_code | Descrição |
|---|---|
200 | OK |
401 | Unauthorized |
500 | Internal error |
code_samples
request_example
curl -L \
-u "api_key:your-password" \
-H "Content-Type: application/json" \
http(s)://HOSTNAME/manage/v1/config/license/checkResponse
Status: 200[
{
"status": "valid"
}
]Get GHES node metadata for all nodes
Get node metadata for all configured nodes in the current cluster. For more information, see "About clustering."
Parâmetros para "Get GHES node metadata for all nodes"
| Nome, Tipo, Descrição |
|---|
uuid string The UUID which identifies a node. |
cluster_roles string The cluster roles from the cluster configuration file. |
http_status_code
| status_code | Descrição |
|---|---|
200 | OK |
401 | Unauthorized |
500 | Internal error |
code_samples
request_example
curl -L \
-u "api_key:your-password" \
-H "Content-Type: application/json" \
http(s)://HOSTNAME/manage/v1/config/nodesResponse
Status: 200{
"topology": "Cluster",
"nodes": [
{
"hostname": "data1",
"uuid": "1b6cf518-f97c-11ed-8544-061d81f7eedb",
"cluster_roles": [
"ConsulServer",
"ElasticsearchServer",
"GitServer",
"StorageServer"
]
},
{
"hostname": "data2",
"uuid": "228406d4-f97c-11ed-ab01-062281bbcf03",
"cluster_roles": [
"ElasticsearchServer",
"StorageServer",
"PagesServer"
]
}
]
}Get the GHES settings
Gets a list of settings for a GitHub Enterprise Server instance.
http_status_code
| status_code | Descrição |
|---|---|
200 | OK |
400 | Bad request |
401 | Unauthorized |
code_samples
request_example
curl -L \
-u "api_key:your-password" \
-H "Content-Type: application/json" \
http(s)://HOSTNAME/manage/v1/config/settingsResponse
Status: 200{
"private_mode": false,
"public_pages": false,
"subdomain_isolation": true,
"signup_enabled": false,
"github_hostname": "ghe.local",
"identicons_host": "dotcom",
"auth_mode": "default",
"expire_sessions": false,
"configuration_id": 1401777404,
"configuration_run_count": 4,
"avatar": {
"enabled": false,
"uri": ""
},
"customer": {
"name": "GitHub",
"email": "stannis@themannis.biz",
"uuid": "af6cac80-e4e1-012e-d822-1231380e52e9",
"secret_key_data": "-----BEGIN PGP PRIVATE KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\nlQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx...\n-----END PGP PRIVATE KEY BLOCK-----\n",
"public_key_data": "-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\nmI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7....\n-----END PGP PUBLIC KEY BLOCK-----\n"
},
"license": {
"seats": 0,
"evaluation": false,
"perpetual": false,
"unlimited_seating": true,
"support_key": "ssh-rsa AAAAB3N....",
"ssh_allowed": true,
"cluster_support": false,
"expire_at": "2016-04-27T00:00:00-07:00"
},
"github_ssl": {
"enabled": false,
"cert": null,
"key": null
},
"ldap": {
"host": null,
"port": 0,
"base": [],
"uid": null,
"bind_dn": null,
"password": null,
"method": "Plain",
"search_strategy": "detect",
"user_groups": [],
"admin_group": null,
"virtual_attribute_enabled": false,
"recursive_group_search": false,
"posix_support": true,
"user_sync_emails": false,
"user_sync_keys": false,
"user_sync_interval": 4,
"team_sync_interval": 4,
"sync_enabled": false,
"reconciliation": {
"user": null,
"org": null
},
"profile": {
"uid": "uid",
"name": null,
"mail": null,
"key": null
}
},
"cas": {
"url": null
},
"saml": {
"sso_url": null,
"certificate": null,
"certificate_path": null,
"issuer": null,
"idp_initiated_sso": false,
"disable_admin_demote": false
},
"github_oauth": {
"client_id": "12313412",
"client_secret": "kj123131132",
"organization_name": "Homestar Runners",
"organization_team": "homestarrunners/characters"
},
"smtp": {
"enabled": true,
"address": "smtp.example.com",
"authentication": "plain",
"port": "1234",
"domain": "blah",
"username": "foo",
"user_name": "mr_foo",
"enable_starttls_auto": true,
"password": "bar",
"discard-to-noreply-address": true,
"support_address": "enterprise@github.com",
"support_address_type": "email",
"noreply_address": "noreply@github.com"
},
"ntp": {
"primary_server": "0.pool.ntp.org",
"secondary_server": "1.pool.ntp.org"
},
"snmp": {
"enabled": false,
"community": ""
},
"syslog": {
"enabled": false,
"server": null,
"protocol_name": "udp"
},
"pages": {
"enabled": true
},
"collectd": {
"enabled": false,
"server": null,
"port": 0,
"encryption": null,
"username": null,
"password": null
},
"mapping": {
"enabled": true,
"tileserver": null,
"basemap": "company.map-qsz2zrvs",
"token": null
},
"prometheus": {
"enabled": false,
"trusted_ips": "10.0.0.1, 192.168.1.0/8"
}
}Set settings
Updates the settings on your instance. For a list of the available settings, see the Get settings endpoint.
Notes:
- The request body only requires the settings parameters that should be updated to be specified, all other parameters will be unmodified or populated from the default values.
- You cannot set the Management Console root site administrator password with this API endpoint. Use the
ghe-set-passwordutility to change the management console password. For more information, see "Command-line utilities."
http_status_code
| status_code | Descrição |
|---|---|
204 | No Content |
400 | Bad request |
401 | Unauthorized |
500 | Internal error |
code_samples
request_example
curl -L \
-X PUT \
-u "api_key:your-password" \
-H "Content-Type: application/json" \
http(s)://HOSTNAME/manage/v1/config/settings \
-d '{"public_pages":true}'Response
Status: 204Get the status of maintenance mode
Gets the status and details of maintenance mode on all available nodes. For more information, see "Enabling and scheduling maintenance mode."
Parâmetros para "Get the status of maintenance mode"
| Nome, Tipo, Descrição |
|---|
uuid string The UUID which identifies a node. |
cluster_roles string The cluster roles from the cluster configuration file. |
http_status_code
| status_code | Descrição |
|---|---|
200 | OK |
400 | Bad request |
401 | Unauthorized |
500 | Internal error |
code_samples
request_example
curl -L \
-u "api_key:your-password" \
-H "Content-Type: application/json" \
http(s)://HOSTNAME/manage/v1/maintenanceResponse
Status: 200[
{
"hostname": "ghe-local-primary",
"uuid": "1b6cf518-f97c-11ed-8544-061d81f7eedb",
"status": "scheduled",
"scheduled_time": "2006-01-02T15:04:05+00:00",
"connection_services": [
{
"name": "git operations",
"number": 15
},
{
"name": "mysql queries",
"number": 6
},
{
"name": "resque jobs",
"number": 10
},
{
"name": "aqueduct jobs",
"number": 0
}
],
"can_unset_maintenance": true,
"ip_exception_list": [
"1.1.1.1"
],
"maintenance_mode_message": "Scheduled maintenance for upgrading."
}
]Set the status of maintenance mode
Sets or schedules the maintenance mode. For more information, see "Enabling and scheduling maintenance mode."
Parâmetros para "Set the status of maintenance mode"
| Nome, Tipo, Descrição |
|---|
enabled boolean ObrigatórioWhether to enable maintenance mode. |
uuid string The UUID of the node to target. This parameter is incompatible with maintenance mode scheduling. Only use |
when string The time to enable maintenance mode. If this parameter is empty or set to |
ip_exception_list array of strings The list of IP addresses to exclude from maintenance mode. IPv4, IPv6, and CIDR addresses are supported. |
maintenance_mode_message string The message to display to users when maintenance mode is enabled. |
http_status_code
| status_code | Descrição |
|---|---|
200 | OK |
400 | Bad request |
401 | Unauthorized |
500 | Internal error |
code_samples
request_example
curl -L \
-X POST \
-u "api_key:your-password" \
-H "Content-Type: application/json" \
http(s)://HOSTNAME/manage/v1/maintenance \
-d '{"enabled":true,"when":"2006-01-02T15:04:05+00:00","ip_exception_list":["192.168.1.0/24","1.1.1.1"]}'Response
Status: 200[
{
"hostname": "ghe-local-primary",
"uuid": "1b6cf518-f97c-11ed-8544-061d81f7eedb",
"message": "maintenance mode scheduled with exception list [1.1.1.1]"
}
]Get the status of services running on all replica nodes
Gets the status of all services running on each replica node. This endpoint may take several seconds to reply.
Parâmetros para "Get the status of services running on all replica nodes"
| Nome, Tipo, Descrição |
|---|
uuid string The UUID which identifies a node. |
cluster_roles string The cluster roles from the cluster configuration file. |
http_status_code
| status_code | Descrição |
|---|---|
200 | OK |
401 | Unauthorized |
500 | Internal error |
code_samples
request_example
curl -L \
-u "api_key:your-password" \
-H "Content-Type: application/json" \
http(s)://HOSTNAME/manage/v1/replication/statusResponse
Status: 200{
"status": "OK",
"nodes": [
{
"hostname": "ghe-local-primary",
"status": "OK",
"services": []
},
{
"hostname": "ghe-local-replica",
"status": "OK",
"services": [
{
"status": "OK",
"name": "redis",
"details": "replication is in sync"
},
{
"status": "OK",
"name": "elasticsearch",
"details": "cluster is in sync (0 shards initializing, 0 shards unassigned)"
},
{
"status": "OK",
"name": "git",
"details": "replication is in sync"
},
{
"status": "OK",
"name": "pages",
"details": "replication is in sync"
},
{
"status": "OK",
"name": "alambic",
"details": "replication is in sync"
},
{
"status": "OK",
"name": "git-hooks",
"details": "replication is in sync"
},
{
"status": "OK",
"name": "consul",
"details": "replication is in sync"
},
{
"status": "OK",
"name": "mysql",
"details": "replication is in sync"
}
]
}
]
}Get all GHES release versions for all nodes
Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see "GitHub Enterprise Server releases."
Parâmetros para "Get all GHES release versions for all nodes"
| Nome, Tipo, Descrição |
|---|
uuid string The UUID which identifies a node. |
cluster_roles string The cluster roles from the cluster configuration file. |
http_status_code
| status_code | Descrição |
|---|---|
200 | OK |
401 | Unauthorized |
500 | Internal error |
code_samples
request_example
curl -L \
-u "api_key:your-password" \
-H "Content-Type: application/json" \
http(s)://HOSTNAME/manage/v1/versionResponse
Status: 200[
{
"hostname": "ghe-local-primary",
"version": {
"version": "3.9.0",
"platform": "azure",
"build_id": "fc542058b5",
"build_date": "2023-05-02"
}
}
]