Create or update file contents

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

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

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Request

Path Parameters

owner string required
repo string required
path string required: path parameter

Body Params

required

application/jsonobject

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"

email 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"

email 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.

Responses

application/json File Commit object

Response

commit object

required

author object

optional

date string

optional

email string

optional

name string

optional

committer object

optional

date string

optional

email string

optional

name string

optional

html_url string

optional

message string

optional

node_id string

optional

parents array[object]

optional

items object

html_url string

optional

sha string

optional

url string

optional

sha string

optional

tree object

optional

sha string

optional

url string

optional

url string

optional

verification object

optional

payload string

optionalnullable

reason string

optional

signature string

optionalnullable

verified boolean

optional

content object

requirednullable

_links object

optional

git string

optional

html string

optional

self string

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

Response Example: 200 application/json

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

application/json File Commit object

Response

commit object

required

author object

optional

date string

optional

email string

optional

name string

optional

committer object

optional

date string

optional

email string

optional

name string

optional

html_url string

optional

message string

optional

node_id string

optional

parents array[object]

optional

items object

html_url string

optional

sha string

optional

url string

optional

sha string

optional

tree object

optional

sha string

optional

url string

optional

url string

optional

verification object

optional

payload string

optionalnullable

reason string

optional

signature string

optionalnullable

verified boolean

optional

content object

requirednullable

_links object

optional

git string

optional

html string

optional

self string

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

Response Example: 201 application/json

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

application/json Basic Error object

Resource not found

documentation_url string

optional

message string

optional

status string

optional

url string

optional

application/json Basic Error object

Conflict

documentation_url string

optional

message string

optional

status string

optional

url string

optional

application/json Validation Error object

Validation failed

documentation_url string

required

errors array[object]

optional

items object

code string

required

field string

optional

index integer

optional

message string

optional

resource string

optional

value

optional

message string

required

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

owner *

repo *

path *

path parameter

Request Sample: Shell / cURL

curl --request PUT \
  --url {protocol}://{hostname}/api/v3/repos/{owner}/{repo}/contents/{path} \
  --header 'content-type: application/json' \
  --data '{
  "committer": {
    "email": "[email protected]",
    "name": "Monalisa Octocat"
  },
  "content": "bXkgbmV3IGZpbGUgY29udGVudHM=",
  "message": "my commit message"
}'