95e6f3d3ab
* add 3.1 to deprecated versions * rewrite img src to use azure blob storage in archive script Co-authored-by: rachmari <rachmari@users.noreply.github.com> * remove static files for ghes 3.1 * remove liquid conditionals and content for ghes 3.1 * remove outdated hardware reqs reusable * Fix liquid conditional uncaught by script * Close liquid conditionals missed by script * Apply @mattpollard's suggestions Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> Co-authored-by: rachmari <rachmari@users.noreply.github.com> Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
3.1 KiB
title, intro, allowTitleToDifferFromFilename, redirect_from, versions, topics, miniTocMaxHeadingLevel, shortTitle, children
| title | intro | allowTitleToDifferFromFilename | redirect_from | versions | topics | miniTocMaxHeadingLevel | shortTitle | children | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GitHub Enterprise administration | You can use these endpoints to administer your enterprise. | true |
|
|
|
3 | Enterprise administration |
|
{% ifversion fpt or ghec %}
{% note %}
Note: This article applies to {% data variables.product.prodname_ghe_cloud %}. To see the {% data variables.product.prodname_ghe_managed %} or {% data variables.product.prodname_ghe_server %} version, use the {% data ui.pages.article_version %} drop-down menu.
{% endnote %}
{% endif %}
Endpoint URLs
REST API endpoints{% ifversion ghes %}—except Management Console API endpoints—{% endif %} are prefixed with the following URL:
{% data variables.product.api_url_pre %}
{% ifversion fpt or ghec %}
When endpoints include {enterprise}, replace {enterprise} with the handle for your enterprise account, which is included in the URL for your enterprise settings. For example, if your enterprise account is located at https://github.com/enterprises/octo-enterprise, replace {enterprise} with octo-enterprise.
{% endif %}
{% ifversion ghes %} Management Console API endpoints are only prefixed with a hostname:
http(s)://<em>hostname</em>/
{% endif %} {% ifversion ghae or ghes %}
Authentication
Your {% data variables.product.product_name %} installation's API endpoints accept the same authentication methods as the GitHub.com API. You can authenticate yourself with OAuth tokens {% ifversion ghes %}(which can be created using the Authorizations API) {% endif %}or basic authentication. {% ifversion ghes %}
OAuth tokens must have the site_admin OAuth scope when used with Enterprise-specific endpoints.{% endif %}
Enterprise administration API endpoints are only accessible to authenticated {% data variables.product.product_name %} site administrators{% ifversion ghes %}, except for the Management Console API, which requires the Management Console password{% endif %}.
{% endif %}
{% ifversion ghae or ghes %}
Version information
The current version of your enterprise is returned in the response header of every API:
X-GitHub-Enterprise-Version: {{currentVersion}}.0
You can also read the current version by calling the meta endpoint.
{% endif %}