Create or update file contents

PUT

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

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

Note: If you use this endpoint and the "Delete a file" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The workflow scope is also required in order to modify files in the .github/workflows directory.

リクエストパラメータ

パスパラメータ

リクエストボディパラメータapplication/json

例

レスポンス

🟢200OK

application/json

Response

ボディapplication/json

🟢201Created

🟠404Record Not Found

🟠409409

🟠422Parameter Error

リクエストExample

Shell

JavaScript

Java

Swift

cURL

Example for creating a fileExample for updating a file

curl --location --request PUT 'https://service1.exmaple.com/repos///contents/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "message": "my commit message",
    "committer": {
        "name": "Monalisa Octocat",
        "email": "octocat@github.com"
    },
    "content": "bXkgbmV3IGZpbGUgY29udGVudHM="
}'

レスポンスExample

200 - example-for-updating-a-file

{
    "content": {
        "name": "hello.txt",
        "path": "notes/hello.txt",
        "sha": "a56507ed892d05a37c6d6128c260937ea4d287bd",
        "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/a56507ed892d05a37c6d6128c260937ea4d287bd",
        "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/a56507ed892d05a37c6d6128c260937ea4d287bd",
            "html": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt"
        }
    },
    "commit": {
        "sha": "18a43cd8e1e3a79c786e3d808a73d23b6d212b16",
        "node_id": "MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg==",
        "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16",
        "html_url": "https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16",
        "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/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f",
            "sha": "9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f"
        },
        "parents": [
            {
                "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6",
                "html_url": "https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6",
                "sha": "da5a433788da5c255edad7979b328b67d79f53f6"
            }
        ],
        "verification": {
            "verified": false,
            "reason": "unsigned",
            "signature": null,
            "payload": null
        }
    }
}

更新日時 2025-06-12 06:47:19

Get repository content

Delete a file