Skip to main content

このバージョンの GitHub Enterprise サーバーはこの日付をもって終了となりました: 2024-03-26. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの向上、新機能の向上を図るために、最新バージョンの GitHub Enterprise サーバーにアップグレードしてください。 アップグレードに関するヘルプについては、GitHub Enterprise サポートにお問い合わせください

サイト管理者が Enterprise Server インスタンスを Enterprise Server 3.9 以降にアップグレードすると、REST API はバージョン管理されます。 インスタンスのバージョンを検索する方法については、「GitHub Docs のバージョンについて」を参照してください。 詳細については、「API のバージョン管理について」を参照してください。

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

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

エンドポイント URL

これらのエンドポイント (管理コンソール エンドポイントを除く) の前には、次の URL が付けられます。

http(s)://<em>HOSTNAME</em>/api/v3

管理コンソール エンドポイントの前にはホスト名のみが付きます。

http(s)://HOSTNAME/

認証

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

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

これらのエンドポイントには、認証された GitHub Enterprise Server サイト管理者のみがアクセスできます。ただし、管理コンソールのパスワードが必要な管理コンソール エンドポイントは除きます。

バージョン情報

Enterprise の現在のバージョンは、REST API の応答ヘッダー X-GitHub-Enterprise-Version: enterprise-server@3.8.0 で返されます。 GET /metaを呼び出すことで、現在のバージョンを読み取ることもできます。 詳しくは、「メタデータ用 REST API エンドポイント」を参照してください。

エンドポイント