Create or update file contents - GitHub v3 REST API

Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the workflow scope to use this endpoint.

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.

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

{ "commit": { "author": { "date": "string", "email": "string", "name": "string" }, "committer": { "date": "string", "email": "string", "name": "string" }, "html_url": "string", "message": "string", "node_id": "string", "parents": [ { "html_url": "string", "sha": "string", "url": "string" } ], "sha": "string", "tree": { "sha": "string", "url": "string" }, "url": "string", "verification": { "payload": "string", "reason": "string", "signature": "string", "verified": true } }, "content": { "_links": { "git": "string", "html": "string", "self": "string" }, "download_url": "string", "git_url": "string", "html_url": "string", "name": "string", "path": "string", "sha": "string", "size": 0, "type": "string", "url": "string" } }

Request

Path Params

owner

string

required

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

repo

string

required

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

path

string

required

path parameter

Body Params application/json

author

object

optional

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

date

string

optional

Example:

"2013-01-15T17:13:22+05:00"

string

required

The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

name

string

required

The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

branch

string

optional

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

committer

object

optional

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

date

string

optional

Example:

"2013-01-05T13:13:22+05:00"

string

required

The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

name

string

required

The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

content

string

required

The new file content, using Base64 encoding.

message

string

required

The commit message.

sha

string

optional

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

Examples

Responses

🟢200Response

application/json

Body

File Commit

commit

object

required

author

object

optional

committer

object

optional

html_url

string

optional

message

string

optional

node_id

string

optional

parents

array [object {3}]

optional

sha

string

optional

tree

object

optional

url

string

optional

verification

object

optional

content

object | null

required

_links

object

optional

download_url

string

optional

git_url

string

optional

html_url

string

optional

name

string

optional

path

string

optional

sha

string

optional

size

integer

optional

type

string

optional

url

string

optional

🟢201Response

🟠404404

🟠409409

🟠422422