リポジトリコンテンツ - GitHub Enterprise Server 3.1 Docs

これらの API エンドポイントを使用すると、リポジトリ内の Base64 でエンコードされたコンテンツを作成、変更、削除できます。

Repository contents APIについて

Raw 形式またはレンダリングされた HTML (サポートされている� �合) をリクエストするには、リポジトリのコンテンツにカスタ� メディアタイプを使用します。

リポジトリコンテンツのカスタ� メディアタイプ

README、ファイル、シンボリックリンクは以下のカスタ� メディアタイプをサポートしています。

application/vnd.github.VERSION.raw
application/vnd.github.VERSION.html

ファイルのコンテンツを取得するには、.raw メディアタイプを使ってく� さい。

Markdown や AsciiDoc などのマークアップファイルでは、.html メディアタイプを使用して、レンダリングされた HTML を取得できます。マークアップ言語は、オープンソースのマークアップライブラリを使用して HTML にレンダリングされます。

すべてのオブジェクトは、以下のカスタ� メディアタイプをサポートしています。

application/vnd.github.VERSION.object

コンテンツのタイプに関係なく、一貫したオブジェクトフォーマットを取得するには、object メディアタイプパラメータを使用します。たとえば、レスポンスはディレクトリに対するオブジェクトの配列ではなく、オブジェクトの配列を含む entries 属性のオブジェクトになります。

API でのメディアタイプの使用について詳しくは、こちらをご覧く� さい。

Get repository content

Works with GitHub Apps

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit :path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

Files and symlinks support a custom media type for retrieving the raw content or rendered HTML (when supported). All content types support a custom media type to ensure the content is returned in a consistent object format.

Note:

To get a repository's contents recursively, you can recursively get the tree.
This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees API.
This API supports files up to 1 megabyte in size.

If the content is a directory

The response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value should be "submodule". This behavior exists in API v3 for backwards compatibility purposes. In the next major version of the API, the type will be returned as "submodule".

If the content is a symlink

If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object describing the symlink itself.

If the content is a submodule

The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit.

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links["git"]) and the github.com URLs (html_url and _links["html"]) will have null values.

パラメータ

Headers
名前, 種類, 説明
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
名前, 種類, 説明
`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.
`path`string必� � path parameter
クエリパラメータ
名前, 種類, 説明
`ref`string The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)

HTTP response status codes

Status code	説明
`200`	OK
`302`	Found
`403`	Forbidden
`404`	Resource not found

コードサンプル

get/repos/{owner}/{repo}/contents/{path}

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/contents/PATH

Response if content is a file

Status: 200

{
  "type": "file",
  "encoding": "base64",
  "size": 5362,
  "name": "README.md",
  "path": "README.md",
  "content": "encoded content ...",
  "sha": "3d21ec53a331a6f037a91c368710b99387d012c1",
  "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
  "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
  "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md",
  "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md",
  "_links": {
    "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
    "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
    "html": "https://github.com/octokit/octokit.rb/blob/master/README.md"
  }
}

Create or update file contents

Works with GitHub Apps

Creates a new file or replaces an existing file in a repository.

パラメータ

Headers

名前, 種類, 説明

acceptstring

Setting to application/vnd.github.v3+json is recommended.

Path parameters

名前, 種類, 説明

ownerstring必� �

The account owner of the repository. The name is not case sensitive.

repostring必� �

The name of the repository. The name is not case sensitive.

pathstring必� �

path parameter

Body parameters

名前, 種類, 説明

messagestring必� �

The commit message.

contentstring必� �

The new file content, using Base64 encoding.

shastring

Required if you are updating a file. The blob SHA of the file being replaced.

branchstring

The branch name. Default: the repository’s default branch (usually master)

committerobject

The person that committed the file. Default: the authenticated user.

Properties of thecommitterobject

名前, 種類, 説明
`name`string必� � The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.
`email`string必� � The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.
`date`string

authorobject

The author of the file. Default: The committer or the authenticated user if you omit committer.

Properties of theauthorobject

名前, 種類, 説明
`name`string必� � The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.
`email`string必� � The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.
`date`string

HTTP response status codes

Status code	説明
`200`	OK
`201`	Created
`404`	Resource not found
`409`	Conflict
`422`	Validation failed

コードサンプル

put/repos/{owner}/{repo}/contents/{path}

curl \
  -X PUT \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/contents/PATH \
  -d '{"message":"my commit message","committer":{"name":"Monalisa Octocat","email":"octocat@github.com"},"content":"bXkgbmV3IGZpbGUgY29udGVudHM="}'

Response

Status: 201

{
  "content": {
    "name": "hello.txt",
    "path": "notes/hello.txt",
    "sha": "95b966ae1c166bd92f8ae7d1c313e738c731dfc3",
    "size": 9,
    "url": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt",
    "html_url": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt",
    "git_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3",
    "download_url": "https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt",
    "type": "file",
    "_links": {
      "self": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt",
      "git": "https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3",
      "html": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt"
    }
  },
  "commit": {
    "sha": "7638417db6d59f3c431d3e1f261cc637155684cd",
    "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==",
    "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd",
    "html_url": "https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd",
    "author": {
      "date": "2014-11-07T22:01:45Z",
      "name": "Monalisa Octocat",
      "email": "octocat@github.com"
    },
    "committer": {
      "date": "2014-11-07T22:01:45Z",
      "name": "Monalisa Octocat",
      "email": "octocat@github.com"
    },
    "message": "my commit message",
    "tree": {
      "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb",
      "sha": "691272480426f78a0138979dd3ce63b77f706feb"
    },
    "parents": [
      {
        "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5",
        "html_url": "https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5",
        "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5"
      }
    ],
    "verification": {
      "verified": false,
      "reason": "unsigned",
      "signature": null,
      "payload": null
    }
  }
}

Delete a file

Works with GitHub Apps

Deletes a file in a repository.

You can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.

The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.

You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.

パラメータ

Headers

名前, 種類, 説明

acceptstring

Setting to application/vnd.github.v3+json is recommended.

Path parameters

名前, 種類, 説明

ownerstring必� �

The account owner of the repository. The name is not case sensitive.

repostring必� �

The name of the repository. The name is not case sensitive.

pathstring必� �

path parameter

Body parameters

名前, 種類, 説明

messagestring必� �

The commit message.

shastring必� �

The blob SHA of the file being replaced.

branchstring

The branch name. Default: the repository’s default branch (usually master)

committerobject

object containing information about the committer.

Properties of thecommitterobject

名前, 種類, 説明
`name`string The name of the author (or committer) of the commit
`email`string The email of the author (or committer) of the commit

authorobject

object containing information about the author.

Properties of theauthorobject

名前, 種類, 説明
`name`string The name of the author (or committer) of the commit
`email`string The email of the author (or committer) of the commit

HTTP response status codes

Status code	説明
`200`	OK
`404`	Resource not found
`409`	Conflict
`422`	Validation failed
`503`	Service unavailable

コードサンプル

delete/repos/{owner}/{repo}/contents/{path}

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/contents/PATH \
  -d '{"message":"my commit message","committer":{"name":"Monalisa Octocat","email":"octocat@github.com"},"sha":"329688480d39049927147c162b9d2deaf885005f"}'

Response

Status: 200

{
  "content": null,
  "commit": {
    "sha": "7638417db6d59f3c431d3e1f261cc637155684cd",
    "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==",
    "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd",
    "html_url": "https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd",
    "author": {
      "date": "2014-11-07T22:01:45Z",
      "name": "Monalisa Octocat",
      "email": "octocat@github.com"
    },
    "committer": {
      "date": "2014-11-07T22:01:45Z",
      "name": "Monalisa Octocat",
      "email": "octocat@github.com"
    },
    "message": "my commit message",
    "tree": {
      "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb",
      "sha": "691272480426f78a0138979dd3ce63b77f706feb"
    },
    "parents": [
      {
        "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5",
        "html_url": "https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5",
        "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5"
      }
    ],
    "verification": {
      "verified": false,
      "reason": "unsigned",
      "signature": null,
      "payload": null
    }
  }
}

Get a repository README

Works with GitHub Apps

Gets the preferred README for a repository.

READMEs support custom media types for retrieving the raw content or rendered HTML.

パラメータ

Headers
名前, 種類, 説明
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
名前, 種類, 説明
`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.
クエリパラメータ
名前, 種類, 説明
`ref`string The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)

HTTP response status codes

Status code	説明
`200`	OK
`404`	Resource not found
`422`	Validation failed

コードサンプル

get/repos/{owner}/{repo}/readme

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/readme

Response

Status: 200

{
  "type": "file",
  "encoding": "base64",
  "size": 5362,
  "name": "README.md",
  "path": "README.md",
  "content": "encoded content ...",
  "sha": "3d21ec53a331a6f037a91c368710b99387d012c1",
  "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
  "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
  "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md",
  "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md",
  "_links": {
    "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
    "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
    "html": "https://github.com/octokit/octokit.rb/blob/master/README.md"
  }
}

Get a repository README for a directory

Works with GitHub Apps

Gets the README from a repository directory.

READMEs support custom media types for retrieving the raw content or rendered HTML.

パラメータ

Headers
名前, 種類, 説明
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
名前, 種類, 説明
`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.
`dir`string必� � The alternate path to look for a README file
クエリパラメータ
名前, 種類, 説明
`ref`string The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)

HTTP response status codes

Status code	説明
`200`	OK
`404`	Resource not found
`422`	Validation failed

コードサンプル

get/repos/{owner}/{repo}/readme/{dir}

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/readme/DIR

Response

Status: 200

{
  "type": "file",
  "encoding": "base64",
  "size": 5362,
  "name": "README.md",
  "path": "README.md",
  "content": "encoded content ...",
  "sha": "3d21ec53a331a6f037a91c368710b99387d012c1",
  "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
  "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
  "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md",
  "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md",
  "_links": {
    "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
    "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
    "html": "https://github.com/octokit/octokit.rb/blob/master/README.md"
  }
}

Download a repository archive (tar)

Works with GitHub Apps

Gets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually master) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use the Location header to make a second GET request. Note: For private repositories, these links are temporary and expire after five minutes.

パラメータ

Headers
名前, 種類, 説明
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
名前, 種類, 説明
`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.
`ref`string必� �

HTTP response status codes

Status code	説明
`302`	Found

コードサンプル

get/repos/{owner}/{repo}/tarball/{ref}

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/tarball/REF

Response

Status: 302

Download a repository archive (zip)

Works with GitHub Apps

Gets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually master) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use the Location header to make a second GET request. Note: For private repositories, these links are temporary and expire after five minutes.

パラメータ

Headers
名前, 種類, 説明
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
名前, 種類, 説明
`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.
`ref`string必� �

HTTP response status codes

Status code	説明
`302`	Found

コードサンプル

get/repos/{owner}/{repo}/zipball/{ref}

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/zipball/REF

Response

Status: 302