Skip to main content
REST API はバージョン化されました。 詳細については、「API のバージョン管理について」を参照してください。

GitHub Enterprise 管理用の REST API エンドポイント

REST API を使うと、Enterprise の管理ができます。

これらのステップを実行してください:

メモ

これらのエンドポイントでは、personal access token (classic) を使う認証のみがサポートされます。 詳しくは、「個人用アクセス トークンを管理する」をご覧ください。

エンドポイント URL

これらのエンドポイントは、Manage GitHub Enterprise Server APIを除き、次の URL で始まります。

http(s)://HOSTNAME/api/v3

Manage GitHub Enterprise Server API のエンドポイントには、ホスト名と管理ポートのみがプレフィックスとして付けられます。

http(s)://HOSTNAME:ADMINISTRATION-PORT/

認証

GitHub Enterprise Server のインストールの API エンドポイントは、GitHub API と同じ認証方法を受け入れます。 詳しくは、「REST API に対する認証」をご覧ください。

これらのエンドポイントで使用する場合、OAuth トークンには site_adminOAuth スコープが必要です。

これらのエンドポイントには、認証された GitHub Enterprise Server サイト管理者のみがアクセスできます。ただし、管理コンソール ユーザーとして認証できる GitHub Enterprise Server を管理するための REST API エンドポイント API のエンドポイントは除きます。 「Web UI からインスタンスを管理する」を参照してください。

メモ

将来のバージョンのGitHub Enterprise Serverでは、[Management Console]エンドポイントが終了される予定です。 GitHub Enterprise Server エンドポイントを使用して、同じ機能にアクセスできます。 詳しくは、「GitHub Enterprise Server を管理するための REST API エンドポイント」をご覧ください。

バージョン情報

Enterprise の現在のバージョンは、REST API の応答ヘッダー X-GitHub-Enterprise-Version: [email protected] で返されます。

          `GET /meta`を呼び出すことで、現在のバージョンを読み取ることもできます。 詳しくは、「[AUTOTITLE](/rest/meta)」をご覧ください。

エンドポイント