Create a tree

POST

/repos/{owner}/{repo}/git/trees

The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.

If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "Create a commit" and "Update a reference."

Returns an error if you try to delete a file that does not exist.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.github.com/repos///git/trees' \
--header 'Content-Type: application/json' \
--data-raw '{
    "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312",
    "tree": [
        {
            "mode": "100644",
            "path": "file.rb",
            "sha": "44b4fc6d56897b048c772eb4087f854f46256132",
            "type": "blob"
        }
    ]
}'

Response Example

201 - Example 1

{
    "sha": "string",
    "tree": [
        {
            "mode": "100644",
            "path": "file.rb",
            "properties": {
                "mode": {
                    "type": "string"
                },
                "path": {
                    "type": "string"
                },
                "sha": {
                    "type": "string"
                },
                "size": {
                    "type": "integer"
                },
                "type": {
                    "type": "string"
                },
                "url": {
                    "type": "string"
                }
            },
            "required": [
                "path",
                "mode",
                "type",
                "sha",
                "url",
                "size"
            ],
            "sha": "44b4fc6d56897b048c772eb4087f854f46256132",
            "size": 30,
            "type": "blob",
            "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132"
        }
    ],
    "truncated": true,
    "url": "http://example.com"
}

Request

Path Params

Body Params application/json

Examples

Responses

🟢201Response

application/json

Body

🟠403403

🟠404404

🟠422422

Modified at 2023-08-15 02:59:30

Get a tag

Get a tree