Note
これらのエンドポイントでは、personal access token (classic) を使う認証のみがサポートされます。 詳しくは、「個人用アクセス トークンを管理する」を参照してください。
エンドポイント URL
これらのエンドポイント (Manage GitHub Enterprise Server API と Management Console API を除く) の前には、次の URL が付けられます。
http(s)://HOSTNAME/api/v3
Manage GitHub Enterprise Server API と Management Console API のエンドポイントの前には、ホスト名と管理ポートのみが付けられます。
http(s)://HOSTNAME:ADMINISTRATION-PORT/
認証
GitHub Enterprise Server のインストールの API エンドポイントは、GitHub API と同じ認証方法を受け入れます。 詳しくは、「REST API に対する認証」をご覧ください。
これらのエンドポイントで使用する場合、OAuth トークンには site_admin OAuth スコープが必要です。
これらのエンドポイントには、認証された GitHub Enterprise Server サイト管理者のみがアクセスできます。ただし、管理コンソール ユーザーとして認証できる GitHub Enterprise Server の管理用の REST API エンドポイント API と 管理コンソール用の REST API エンドポイント API のエンドポイントは除きます。 「Web UI からインスタンスを管理する」を参照してください。
Note
[Management Console] エンドポイントは、GitHub Enterprise Server の将来のバージョンでは非推奨になります。 GitHub Enterprise Server エンドポイントを使用して、同じ機能にアクセスできます。 詳しくは、「GitHub Enterprise Server の管理用の REST API エンドポイント」を参照してください。
バージョン情報
Enterprise の現在のバージョンは、REST API の応答ヘッダー X-GitHub-Enterprise-Version: enterprise-server@3.12.0 で返されます。
GET /metaを呼び出すことで、現在のバージョンを読み取ることもできます。 詳しくは、「メタデータ用 REST API エンドポイント」をご覧ください。