REST API のリソース

公式の GitHub Enterprise Server REST API を構成するリソースについて説明しています。ご不明な点やご要望がございましたら、your site administrator までご連絡く� さい。

スキーマ

API は http(s)://[hostname]/api/v3 からアクセスされます。すべてのデータは JSON として送受信されます。

$ curl -I http(s)://[hostname]/api/v3/users/octocat/orgs

> HTTP/2 200
> Server: nginx
> Date: Fri, 12 Oct 2012 23:33:14 GMT
> Content-Type: application/json; charset=utf-8
> ETag: "a00049ba79152d03380c34652f2cb612"
> X-GitHub-Media-Type: github.v3
> x-ratelimit-limit: 5000
> x-ratelimit-remaining: 4987
> x-ratelimit-reset: 1350085394
> X-GitHub-Enterprise-Version: 3.1.0
> Content-Length: 5
> Cache-Control: max-age=0, private, must-revalidate
> X-Content-Type-Options: nosniff

空白のフィールドは、省略されるのではなく null として含まれます。

すべてのタイ� スタンプは、 ISO 8601フォーマットのUTC時間で返されます。

YYYY-MM-DDTHH:MM:SSZ

タイ� スタンプのタイ� ゾーンの詳細については、このセクションを参照してく� さい。

要約表現

リソースのリストをフェッチすると、レスポンスにはそのリソースの属性のサブセットが含まれます。これは、リソースの「要約」表現です。（一部の属性では、API が提供する計算コストが高くなります。パフォーマンス上の理由から、要約表現はそれらの属性を除外します。これらの属性を取得するには、「詳細な」表現をフェッチします。）

例: リポジトリのリストを取得すると、各リポジトリの要約表現が表示されます。ここでは、octokit Organization が所有するリポジトリのリストを取得します。

GET /orgs/octokit/repos

詳細な表現

個々のリソースをフェッチすると、通常、レスポンスにはそのリソースのすべての属性が含まれます。これは、リソースの「詳細」表現です。（承認によって、表現に含まれる詳細の内容に影響する� �合があることにご注意く� さい。）

例: 個別のリポジトリを取得すると、リポジトリの詳細な表現が表示されます。ここでは、octokit/octokit.rb リポジトリをフェッチします。

GET /repos/octokit/octokit.rb

ドキュメントには、各 API メソッドのレスポンス例が記載されています。レスポンス例は、そのメソッドによって返されるすべての属性を示しています。

認証

GitHub Enterprise Server REST API を使用して認証する方法は 2 つあります。認証を必要とするリクエストは、� �所によって 403 Forbidden ではなく 404 Not Found を返します。これは、許可されていないユーザにプライベートリポジトリが誤って漏洩するのを防ぐためです。

Basic 認証

$ curl -u "username" http(s)://[hostname]/api/v3

OAuth2 トークン（ヘッダに送信）

$ curl -H "Authorization: token OAUTH-TOKEN" http(s)://[hostname]/api/v3

注: GitHub では、Authorization ヘッダを使用して OAuth トークンを送信することをお勧めしています。

OAuth2 の詳細をお読みく� さい。 OAuth2 トークンは、本番アプリケーションの Web アプリケーションフローで取得できることに注意してく� さい。

OAuth2 キー/シークレット

非推奨の注意: GitHubは、クエリパラメータを使ったAPIの認証を廃止します。 APIの認証はHTTPの基本認証で行わなければなりません。予定された一時停止を含む詳しい情� �についてはブログポストを参照してく� さい。

クエリパラメータを使ったAPIの認証は、利用はできるものの、セキュリティ上の懸念からサポートされなくなりました。その代わりに、インテグレータはアクセストークン、client_idもしくはclient_secretをヘッダに移すことをおすすめします。 GitHubは、クエリパラメータによる認証の削除を、事前に通知します。

curl -u my_client_id:my_client_secret 'http(s)://[hostname]/api/v3/user/repos'

client_id と client_secret を使用してもユーザとして認証されず、OAuth アプリケーションを識別してレート制限を増やす� けです。アクセス許可はユーザにのみ付与され、アプリケーションには付与されません。また、認証されていないユーザに表示されるデータのみが返されます。このため、サーバー間のシナリオでのみ OAuth2 キー/シークレットを使用する必要があります。 OAuth アプリケーションのクライアントシークレットをユーザーに漏らさないようにしてく� さい。

プライベートモードでは、OAuth2 キーとシークレットを使用して認証することはできません。認証しようとすると 401 Unauthorized が返されます。詳しい情� �については、「プライベートモードを有効化する」を参照してく� さい。

無効な認証情� �で認証すると、401 Unauthorized が返されます。

$ curl -I http(s)://[hostname]/api/v3 -u foo:bar
> HTTP/2 401

> {
>   "message": "Bad credentials",
>   "documentation_url": "https://docs.github.com/enterprise/3.1/rest"
> }

API は、無効な認証情� �を含むリクエストを短期間に複数回検出すると、403 Forbidden で、そのユーザに対するすべての認証試行（有効な認証情� �を含む）を一時的に拒否します。

$ curl -i http(s)://[hostname]/api/v3 -u -u valid_username:valid_password 
> HTTP/2 403
> {
>   "message": "Maximum number of login attempts exceeded. Please try again later.",
>   "documentation_url": "https://docs.github.com/enterprise/3.1/rest"
> }

パラメータ

多くの API メソッドはオプションのパラメータを選択しています。 GET リクエストでは、パスのセグメントとして指定されていないパラメータは、HTTP クエリ文字列型パラメータとして渡すことができます。

$ curl -i "http(s)://[hostname]/api/v3/repos/vmg/redcarpet/issues?state=closed"

この例では、パスの :owner と :repo パラメータに「vmg」と「redcarpet」の値が指定され、クエリ文字列型で :state が渡されます。

POST、PATCH、PUT、および DELETE リクエストでは、URL に含まれていないパラメータは、Content-Type が「application/json」の JSON としてエンコードする必要があります。

$ curl -i -u username -d '{"scopes":["repo_deployment"]}' http(s)://[hostname]/api/v3/authorizations

ルートエンドポイント

ルートエンドポイントに GET リクエストを発行して、REST API がサポートするすべてのエンドポイントカテゴリを取得できます。

$ curl -u username:password http(s)://[hostname]/api/v3

GraphQL グローバルノード ID

REST API を介して node_id を検索し、それらを GraphQL 操作で使用する方法について詳しくは、「グローバルノード ID を使用する」のガイドを参照してく� さい。

クライアントエラー

リクエストの本文を受信する API 呼び出しのクライアントエラーには、次の 3 つのタイプがあります。

無効なJSONを送信すると、400 Bad Request レスポンスが返されます。
```
HTTP/2 400
Content-Length: 35

{"message":"Problems parsing JSON"}
```
間違ったタイプの JSON 値を送信すると、400 Bad Request レスポンスが返されます。
```
HTTP/2 400
Content-Length: 40

{"message":"Body should be a JSON object"}
```

無効なフィールドを送信すると、422 Unprocessable Entity レスポンスが返されます。

HTTP/2 422
Content-Length: 149

{
  "message": "Validation Failed",
  "errors": [
    {
      "resource": "Issue",
      "field": "title",
      "code": "missing_field"
    }
  ]
}

すべてのエラーオブジェクトにはリソースとフィールドのプロパティがあるため、クライアントは問題の内容を認識することができます。また、フィールドの問題点を知らせるエラーコードもあります。発生する可能性のある検証エラーコードは次のとおりです。

エラーコード名	説明
`missing`	リソースが存在しません。
`missing_field`	リソースの必� �フィールドが設定されていません。
`invalid`	フィールドのフォーマットが無効です。詳細については、ドキュメントを参照してく� さい。
`already_exists`	別のリソースに、このフィールドと同じ値があります。これは、一意のキー（ラベル名など）が必要なリソースで発生する可能性があります。
`unprocessable`	入力が無効です。

リソースはカスタ� 検証エラー（code が custom）を送信する� �合もあります。カスタ� エラーには常にエラーを説明する message フィールドがあり、ほとんどのエラーには、エラーの解決に役立つ可能性があるコンテンツを指す documentation_url フィールドも含まれます。

HTTP リダイレクト

API v3 は、必要に応じて HTTP リダイレクトを使用します。クライアントは、リクエストがリダイレクトされる可能性があることを想定する必要があります。 HTTP リダイレクトの受信はエラーではなく、クライアントはそのリダイレクトに従う必要があります。リダイレクトのレスポンスには、クライアントがリクエストを繰り返す必要があるリソースの URI を含む Location ヘッダフィールドがあります。

ステータスコード	説明
`301`	Permanent redirection（恒久的なリダイレクト）。リクエストに使用した URI は、`Location`ヘッダフィールドで指定されたものに置き換えられています。このリソースに対する今後のすべてのリクエストは、新しい URI に送信する必要があります。
`302`、`307`	Temporary redirection（一時的なリダイレクト）。リクエストは、`Location` ヘッダフィールドで指定された URI に逐語的に繰り返される必要がありますが、クライアントは今後のリクエストで元の URI を引き続き使用する必要があります。

その他のリダイレクトステータスコードは、HTTP 1.1 仕様に従って使用できます。

HTTP メソッド

API v3 は、可能な限り各アクションに適切な HTTPメソッドを使用しようとします。

メソッド	説明
`HEAD`	HTTP ヘッダ情� �のみを取得するために、任意のリソースに対して発行できます。
`GET`	リソースを取得するために使用します。
`POST`	リソースを作成するために使用します。
`PATCH`	部分的な JSON データでリソースを更新するために使用します。たとえば、Issue リソースには `title` と `body` の属性があります。 `PATCH`リクエストは、リソースを更新するための1つ以上の属性を受け付けることがあります。
`PUT`	リソースまたはコレクションを置き換えるために使用します。 `body` 属性のない `PUT` リクエストでは、必ず `Content-Length` ヘッダをゼロに設定してく� さい。
`DELETE`	リソースを削除するために使用します。

ハイパーメディア

すべてのリソースには、他のリソースにリンクしている 1 つ以上の *_url プロパティがある� �合があります。これらは、適切な API クライアントが自分で URL を構築する必要がないように、明示的な URL を提供することを目的としています。 API クライアントには、これらを使用することを強くお勧めしています。そうすることで、開発者が今後の API のアップグレードを容易に行うことができます。すべての URL は、適切な RFC 6570 URI テンプレートであることが前提となります。

次に、uri_template などを使用して、これらのテンプレートを展開できます。

>> tmpl = URITemplate.new('/notifications{?since,all,participating}')
>> tmpl.expand
=> "/notifications"

>> tmpl.expand :all => 1
=> "/notifications?all=1"

>> tmpl.expand :all => 1, :participating => 1
=> "/notifications?all=1&participating=1"

ページネーション

複数のアイテ� を返すリクエストは、デフォルトで 30 件ごとにページ分けされます。 page パラメータを使用すると、さらにページを指定できます。一部のリソースでは、per_page パラメータを使用してカスタ� ページサイズを最大 100 に設定することもできます。技術的な理由により、すべてのエンドポイントが per_page パラメータを尊重するわけではないことに注意してく� さい。例については、イベントを参照してく� さい。

$ curl 'http(s)://[hostname]/api/v3/user/repos?page=2&per_page=100'

ページ番号は 1 から始まり、page パラメータを省略すると最初のページが返されることに注意してく� さい。

カーソルベースのページネーションを使用するエンドポイントもあります。カーソルとは、結果セットで� �所を示す文字列です。カーソルベースのページネーションでは、結果セットで「ページ」という概念がなくなるため、特定のページに移動することはできません。かわりに、before または after パラメータを使用して結果の中を移動できます。

ページネーションの詳細については、ページネーションでトラバースするのガイドをご覧く� さい。

リンクヘッダ

注釈: 独自の URL を作成するのではなく、Link ヘッダ値を使用して呼び出しを形成することが重要です。

Link ヘッダには、ページネーション情� �が含まれています。例:

Link: <http(s)://[hostname]/api/v3/user/repos?page=3&per_page=100>; rel="next",
  <http(s)://[hostname]/api/v3/user/repos?page=50&per_page=100>; rel="last"

この例は、読みやすいように改行されています。

エンドポイントでカーソルベースのページネーションを使用する� �合:

Link: <http(s)://[hostname]/api/v3/orgs/ORG/audit-log?after=MTYwMTkxOTU5NjQxM3xZbGI4VE5EZ1dvZTlla09uWjhoZFpR&before=>; rel="next",

この Link レスポンスヘッダには、1 つ以上のハイパーメディアリンク関係が含まれています。その一部には、URI テンプレートとしての拡張が必要な� �合があります。

使用可能な rel の値は以下のとおりです。

名前	説明
`次`	結果のすぐ次のページのリンク関係。
`last`	結果の最後のページのリンク関係。
`first`	結果の最初のページのリンク関係。
`prev`	結果の直前のページのリンク関係。

レート制限

GitHub Enterprise Serverインスタンスへの様々な種類のAPIリクエストは、様々なレート制限に従います。

� えて、Search APIには専用の制限があります。詳しい情� �についてはREST APIのドキュメンテーションの「検索」を参照してく� さい。

Note: The following rate limits are the default rate limits for GitHub Enterprise Server. Contact your site administrator to confirm the rate limits for GitHub Enterprise Serverインスタンス.

Note: You can confirm your current rate limit status at any time. For more information, see "Checking your rate limit status."

個人アカウントからのリクエスト

個人アクセストークンで認証された直接のAPIリクエストは、user-to-serverリクエストです。 OAuth AppあるいはGitHub Appは、ユーザが認可した後、user-to-serverリクエストをユーザの代わりに発行することもできます。詳しい情� �については「個人アクセストークンの作成」、「OAuth Appの認可」、「GitHub Appの認可」を参照してく� さい。

GitHub Enterprise Serverは、すべてのuser-to-serverリクエストを認証されたユーザと関連づけます。 OAuth App及びGitHubについては、これはアプリケーションを認可したユーザです。すべてのuser-to-serverリクエストは、認証されたユーザのレート制限に対してカウントされます。

By default, user-to-server requests are limited to 5,000 requests per hour and per authenticated user. All requests from OAuth applications authorized by a user or a personal access token owned by the user, and requests authenticated with any of the user's authentication credentials, share the same quota of 5,000 requests per hour for that user.

GitHub Appからのリクエスト

GitHub Appからのリクエストは、user-to-serverあるいはserver-to-serverリクエストのいずれかになります。 GitHub Appのレート制限に関する詳しい情� �については「GitHub Appのレート制限」を参照してく� さい。

GitHub Actionsからのリクエスト

GitHub Actionsワークフロー内のリクエストの認証には、ビルトインのGITHUB_TOKENが使えます。詳しい情� �については「自動トークン認証」を参照してく� さい。

GITHUB_TOKENを使う� �合、レート制限はリポジトリごとに1時間あたり1,000リクエストです。

レート制限のステータスのチェック

レート制限APIとレスポンスのHTTPヘッダは、任意の時点におけるユーザまたはユーザのアプリケーションが利用できるAPIコール数の信� �できるソースです。

レート制限API

レート制限APIを使って、現在の制限に達することなくレート制限のステータスをチェックできます。詳しい情� �については「レート制限」を参照してく� さい。

レート制限HTTPヘッダ

API リクエストの返された HTTP ヘッダは、現在のレート制限ステータスを示しています。

$ curl -I http(s)://[hostname]/api/v3/users/octocat
> HTTP/2 200
> Date: Mon, 01 Jul 2013 17:27:06 GMT
> x-ratelimit-limit: 60
> x-ratelimit-remaining: 56
> x-ratelimit-reset: 1372700873

ヘッダ名	説明
`x-ratelimit-limit`	1 時間あたりのリクエスト数の上限。
`x-ratelimit-remaining`	現在のレート制限ウィンドウに残っているリクエストの数。
`x-ratelimit-reset`	現在のレート制限ウィンドウが UTC エポック秒でリセットされる時刻。

時刻に別の形式を使用する必要がある� �合は、最新のプログラミング言語で作業を完了できます。たとえば、Web ブラウザでコンソールを開くと、リセット時刻を JavaScript の Date オブジェクトとして簡単に取得できます。

new Date(1372700873 * 1000)
// => Mon Jul 01 2013 13:47:53 GMT-0400 (EDT)

レート制限を超えると、次のようなエラーレスポンスが返されます。

> HTTP/2 403
> Date: Tue, 20 Aug 2013 14:50:41 GMT
> x-ratelimit-limit: 60
> x-ratelimit-remaining: 0
> x-ratelimit-reset: 1377013266

> {
>    "message": "API rate limit exceeded for xxx.xxx.xxx.xxx. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.)",
>    "documentation_url": "https://docs.github.com/enterprise/3.1/rest/overview/resources-in-the-rest-api#rate-limiting"
> }

OAuth Appの認証されていないレート制限の増�

OAuth Appが認証されていない呼び出しをより高いレート制限で行う必要がある� �合は、エンドポイントルートの前にアプリのクライアント ID とシークレットを渡すことができます。

$ curl -u my_client_id:my_client_secret -I http(s)://[hostname]/api/v3/user/repos
> HTTP/2 200
> Date: Mon, 01 Jul 2013 17:27:06 GMT
> x-ratelimit-limit: 5000
> x-ratelimit-remaining: 4966
> x-ratelimit-reset: 1372700873

注釈: クライアントシークレットを他のユーザと共有したり、クライアント側のブラウザコードに含めたりしないでく� さい。こちらに示す方法は、サーバー間の呼び出しにのみ使用してく� さい。

レート制限内に収める

Basic 認証または OAuth を使用してレート制限を超えた� �合、API レスポンスをキャッシュし、条件付きリクエストを使用することで問題を解決できます。

セカンダリレート制限

GitHub Enterprise Server で高品質のサービスを提供するにあたって、API を使用するときに、いくつかのアクションに追� のレート制限が適用される� �合があります。たとえば、API を使用してコンテンツを急速に作成する、webhook を使用する代わりに積極的にポーリングする、複数の同時リクエストを行う、計算コストが高いデータを繰り返しリクエストするなどの行為によって、セカンダリレート制限が適用される� �合があります。

セカンダリレート制限は、API の正当な使用を妨げることを意図したものではありません。通常のレート制限が、ユーザにとって唯一の制限であるべきです。優良な API ユーザにふさわしい振る舞いをしているかどうかを確認するには、ベストプラクティスのガイドラインをご覧く� さい。

アプリケーションがこのレート制限をトリガーすると、次のような有益なレスポンスを受け取ります。

> HTTP/2 403
> Content-Type: application/json; charset=utf-8
> Connection: close

> {
>   "message": "You have exceeded a secondary rate limit and have been temporarily blocked from content creation. Please retry your request again later.",
>   "documentation_url": "https://docs.github.com/enterprise/3.1/rest/overview/resources-in-the-rest-api#secondary-rate-limits"
> }

条件付きリクエスト

ほとんどのレスポンスでは ETag ヘッダが返されます。多くのレスポンスでは Last-Modified ヘッダも返されます。これらのヘッダーの値を使用して、それぞれ If-None-Match ヘッダと If-Modified-Since ヘッダを使い、それらのリソースに対して後続のリクエストを行うことができます。リソースが変更されていない� �合、サーバーは 304 Not Modified を返します。

$ curl -I http(s)://[hostname]/api/v3/user
> HTTP/2 200
> Cache-Control: private, max-age=60
> ETag: "644b5b0155e6404a9cc4bd9d8b1ae730"
> Last-Modified: Thu, 05 Jul 2012 15:31:30 GMT
> Vary: Accept, Authorization, Cookie
> x-ratelimit-limit: 5000
> x-ratelimit-remaining: 4996
> x-ratelimit-reset: 1372700873

$ curl -I http(s)://[hostname]/api/v3/user -H 'If-None-Match: "644b5b0155e6404a9cc4bd9d8b1ae730"'
> HTTP/2 304
> Cache-Control: private, max-age=60
> ETag: "644b5b0155e6404a9cc4bd9d8b1ae730"
> Last-Modified: Thu, 05 Jul 2012 15:31:30 GMT
> Vary: Accept, Authorization, Cookie
> x-ratelimit-limit: 5000
> x-ratelimit-remaining: 4996
> x-ratelimit-reset: 1372700873

$ curl -I http(s)://[hostname]/api/v3/user -H "If-Modified-Since: Thu, 05 Jul 2012 15:31:30 GMT"
> HTTP/2 304
> Cache-Control: private, max-age=60
> Last-Modified: Thu, 05 Jul 2012 15:31:30 GMT
> Vary: Accept, Authorization, Cookie
> x-ratelimit-limit: 5000
> x-ratelimit-remaining: 4996
> x-ratelimit-reset: 1372700873

API は、任意のオリジンからの AJAX リクエストに対して、オリジン間リソース共有（CORS）をサポートします。 CORS W3C Recommendation、または HTML 5 セキュリティガイドのこちらの概要をご確認く� さい。

http://example.com にアクセスするブラウザから送信されたサンプルリクエストは次のとおりです。

$ curl -I http(s)://[hostname]/api/v3 -H "Origin: http://example.com"
HTTP/2 302
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: ETag, Link, X-GitHub-OTP, x-ratelimit-limit, x-ratelimit-remaining, x-ratelimit-reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval

CORS プリフライトリクエストは次のようになります。

$ curl -I http(s)://[hostname]/api/v3 -H "Origin: http://example.com" -X OPTIONS
HTTP/2 204
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Authorization, Content-Type, If-Match, If-Modified-Since, If-None-Match, If-Unmodified-Since, X-GitHub-OTP, X-Requested-With
Access-Control-Allow-Methods: GET, POST, PATCH, PUT, DELETE
Access-Control-Expose-Headers: ETag, Link, X-GitHub-OTP, x-ratelimit-limit, x-ratelimit-remaining, x-ratelimit-reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval
Access-Control-Max-Age: 86400

JSON-P コールバック

?callback パラメータを任意の GET 呼び出しに送信して、結果を JSON 関数でラップできます。これは通常、ブラウザがクロスドメインの問題を回避することにより、GitHub Enterprise Server のコンテンツを Web ページに埋め込む� �合に使用されます。レスポンスには、通常の API と同じデータ出力と、関連する HTTP ヘッダ情� �が含まれます。

$ curl http(s)://[hostname]/api/v3?callback=foo

> /**/foo({
>   "meta": {
>     "status": 200,
>     "x-ratelimit-limit": "5000",
>     "x-ratelimit-remaining": "4966",
>     "x-ratelimit-reset": "1372700873",
>     "Link": [ // pagination headers and other links
>       ["http(s)://[hostname]/api/v3?page=2", {"rel": "next"}]
>     ]
>   },
>   "data": {
>     // the data
>   }
> })

JavaScript ハンドラを記述して、コールバックを処理できます。以下は、試すことができる最も簡易な例です。

<html>
<head>
<script type="text/javascript">
function foo(response) {
  var meta = response.meta;
  var data = response.data;
  console.log(meta);
  console.log(data);
}

var script = document.createElement('script');
script.src = 'http(s)://[hostname]/api/v3?callback=foo';

document.getElementsByTagName('head')[0].appendChild(script);
</script>
</head>

<body>
  <p>Open up your browser's console.</p>
</body>
</html>

すべてのヘッダは HTTP ヘッダと同じ文字列型の値ですが、例外の 1つとして「Link」があります。 Link ヘッダは事前に解析され、[url, options] タプルの配列として渡されます。

リンクは次のようになります。

Link: <url1>; rel="next", <url2>; rel="foo"; bar="baz"

... コールバック出力では次のようになります。

{
  "Link": [
    [
      "url1",
      {
        "rel": "next"
      }
    ],
    [
      "url2",
      {
        "rel": "foo",
        "bar": "baz"
      }
    ]
  ]
}

タイ� ゾーン

新しいコミットの作成など、新しいデータを作成する一部のリクエストでは、タイ� スタンプを指定または生成するときにタイ� ゾーン情� �を提供できます。そういったAPI 呼び出しのタイ� ゾーン情� �を決定する際に、優先� �位に従って次のルールを適用します。

ISO 8601 タイ� スタンプにタイ� ゾーン情� �を明示的に提供する
Time-Zone ヘッダを使用する
ユーザが最後に認識されたタイ� ゾーンを使用する
他のタイ� ゾーン情� �を含まない UTC をデフォルトにする

これらのルールは、APIに渡されたデータに対してのみ適用され、APIが返す日付には適用されないことに注意してく� さい。「スキーマ」にあるように、APIが返すタイ� スタンプはUTCでISO8601フォーマットです。

ISO 8601 タイ� スタンプにタイ� ゾーン情� �を明示的に提供する

タイ� スタンプを指定できる API 呼び出しの� �合、その正確なタイ� スタンプを使用します。これはコミット API の例です。

これらのタイ� スタンプは、2014-02-27T15:05:06+01:00 のようになります。これらのタイ� スタンプを指定する方法については、こちらの例も参照してく� さい。

`Time-Zone` ヘッダを使用する

Olson データベースの名前のリストに従ってタイ� ゾーンを定義する Time-Zone ヘッダを提供することができます。

$ curl -H "Time-Zone: Europe/Amsterdam" -X POST http(s)://[hostname]/api/v3/repos/github/linguist/contents/new_file.md

つまり、このヘッダが定義するタイ� ゾーンで API 呼び出しが行われた時のタイ� スタンプが生成されます。たとえば、コンテンツ API は追� または変更ごとに git コミットを生成し、タイ� スタンプとして現在の時刻を使用します。このヘッダは、現在のタイ� スタンプの生成に使用されたタイ� ゾーンを決定します。

ユーザが最後に認識されたタイ� ゾーンを使用する

Time-Zone ヘッダが指定されておらず、API への認証された呼び出しを行う� �合、認証されたユーザが最後に認識されたタイ� ゾーンが使用されます。最後に認識されたタイ� ゾーンは、GitHub Enterprise Server Web サイトを閲覧するたびに更新されます。

他のタイ� ゾーン情� �を含まない UTC をデフォルトにする

上記の手� �で情� �が得られない� �合は、UTC をタイ� ゾーンとして使用して git コミットを作成します。

ここには以下の内容があります:

最新バージョン

スキーマ

要約表現

詳細な表現

認証

Basic 認証

OAuth2 トークン（ヘッダに送信）

OAuth2 キー/シークレット

パラメータ

ルートエンドポイント

GraphQL グローバルノード ID

クライアントエラー

HTTP リダイレクト

HTTP メソッド

ハイパーメディア

リンクヘッダ

レート制限

個人アカウントからのリクエスト

GitHub Appからのリクエスト

GitHub Actionsからのリクエスト

レート制限のステータスのチェック

レート制限API

レート制限HTTPヘッダ

OAuth Appの認証されていないレート制限の増�

レート制限内に収める

セカンダリレート制限

条件付きリクエスト

JSON-P コールバック

タイ� ゾーン

ISO 8601 タイ� スタンプにタイ� ゾーン情� �を明示的に提供する

`Time-Zone` ヘッダを使用する

ユーザが最後に認識されたタイ� ゾーンを使用する

他のタイ� ゾーン情� �を含まない UTC をデフォルトにする

REST API のリソース

ここには以下の内容があります:

最新バージョン

スキーマ

要約表現

詳細な表現

認証

Basic 認証

OAuth2 トークン（ヘッダに送信）

OAuth2 キー/シークレット

ログイン失敗の制限

パラメータ

ルートエンドポイント

GraphQL グローバルノード ID

クライアントエラー

HTTP リダイレクト

HTTP メソッド

ハイパーメディア

ページネーション

リンクヘッダ

レート制限

個人アカウントからのリクエスト

GitHub Appからのリクエスト

GitHub Actionsからのリクエスト

レート制限のステータスのチェック

レート制限API

レート制限HTTPヘッダ

OAuth Appの認証されていないレート制限の増�

レート制限内に収める

セカンダリレート制限

条件付きリクエスト

オリジン間リソース共有

JSON-P コールバック

タイ� ゾーン

ISO 8601 タイ� スタンプにタイ� ゾーン情� �を明示的に提供する

Time-Zone ヘッダを使用する

ユーザが最後に認識されたタイ� ゾーンを使用する

他のタイ� ゾーン情� �を含まない UTC をデフォルトにする

`Time-Zone` ヘッダを使用する