52937ae5ca
Co-authored-by: Rachael Sewell <rachmari@github.com> Co-authored-by: Rachael Rose Renk <91027132+rachaelrenk@users.noreply.github.com> Co-authored-by: David Jarzebowski <davidjarzebowski@github.com> Co-authored-by: Anne-Marie <102995847+am-stead@users.noreply.github.com> Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> Co-authored-by: Steve Guntrip <stevecat@github.com> Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com> Co-authored-by: Sam Browning <106113886+sabrowning1@users.noreply.github.com> Co-authored-by: Torsten Walter <torstenwalter@github.com> Co-authored-by: Henry Mercer <henrymercer@github.com> Co-authored-by: Sarah Edwards <skedwards88@github.com>
3.0 KiB
title, intro, allowTitleToDifferFromFilename, redirect_from, versions, topics, shortTitle, children, autogenerated
| title | intro | allowTitleToDifferFromFilename | redirect_from | versions | topics | shortTitle | children | autogenerated | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GitHub Enterprise administration | Use the REST API to administer your enterprise. | true |
|
|
|
Enterprise administration |
|
rest |
{% ifversion fpt or ghec %}
{% note %}
Note: This information 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 %}
{% data reusables.user-settings.enterprise-admin-api-classic-pat-only %}
Endpoint URLs
These endpoints{% ifversion ghes %}—except Management Console 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 endpoints are only prefixed with a hostname:
http(s)://HOSTNAME/
{% endif %} {% ifversion ghae or ghes %}
Authentication
Your {% data variables.product.product_name %} installation's API endpoints accept the same authentication methods as the {% data variables.product.prodname_dotcom %} API. For more information, see "AUTOTITLE."
{% ifversion ghes %}OAuth tokens must have the site_admin OAuth scope when used with Enterprise-specific endpoints.{% endif %}
These endpoints are only accessible to authenticated {% data variables.product.product_name %} site administrators{% ifversion ghes %}, except for the Management Console endpoints, which requires the Management Console password{% endif %}.
{% endif %}
{% ifversion ghae or ghes %}
Version information
The current version of your enterprise is returned in the REST API response header:
X-GitHub-Enterprise-Version: {{currentVersion}}.0
You can also read the current version by calling the meta endpoint.
{% endif %}