Git BLOB

REST API を使用し、リポジトリ内の各ファイルのコンテンツを格納するために使われるオブジェクトの種類である Git BLOB (バイナリラージオブジェクト) を操作します。

Git BLOB について

Git blob (バイナリラージオブジェクト) は、各ファイルのコンテンツをリポジトリに保存する際に使用されるオブジェクトタイプです。ファイルの SHA-1 ハッシュが計算され、blob オブジェクトに保存されます。これらのエンドポイントを使うと、GitHub Enterprise Cloud 上の Git データベースの BLOB オブジェクトを読み書きできます。 BLOB では、これらのカスタムメディアの種類が利用されます。 API でのメディアタイプの使用に関する詳細については、こちらをお読みください。

Blob のカスタムメディアタイプ

これらは、blob でサポートされているメディアタイプです。

application/json
application/vnd.github.raw

詳しくは、「メディアの種類」を参照してください。

Create a blob

に対応 GitHub Apps

"Create a blob" のパラメーター

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.
パスパラメーター
名前, Type, 説明
`owner` string 必須 The account owner of the repository. The name is not case sensitive.
`repo` string 必須 The name of the repository. The name is not case sensitive.
本文のパラメーター
名前, Type, 説明
`content` string 必須 The new blob's content.
`encoding` string The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. Default: `utf-8`

"Create a blob" の HTTP 応答状態コード

状態コード	説明
`201`	Created
`403`	Forbidden
`404`	Resource not found
`409`	Conflict
`422`	Validation failed, or the endpoint has been spammed.

"Create a blob" のコードサンプル

post/repos/{owner}/{repo}/git/blobs

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/git/blobs \
  -d '{"content":"Content of the blob","encoding":"utf-8"}'

Response

Status: 201

{
  "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15",
  "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15"
}

Get a blob

に対応 GitHub Apps

The content in the response will always be Base64 encoded.

Note: This API supports blobs up to 100 megabytes in size.

"Get a blob" のパラメーター

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.
パスパラメーター
名前, Type, 説明
`owner` string 必須 The account owner of the repository. The name is not case sensitive.
`repo` string 必須 The name of the repository. The name is not case sensitive.
`file_sha` string 必須

"Get a blob" の HTTP 応答状態コード

状態コード	説明
`200`	OK
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

"Get a blob" のコードサンプル

get/repos/{owner}/{repo}/git/blobs/{file_sha}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/git/blobs/FILE_SHA

Response

Status: 200

{
  "content": "Q29udGVudCBvZiB0aGUgYmxvYg==",
  "encoding": "base64",
  "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15",
  "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15",
  "size": 19,
  "node_id": "Q29udGVudCBvZiB0aGUgYmxvYg=="
}