Skip to main content
POST
/
api
/
v1
/
repos
/
commit-pack
Commit Pack
curl --request POST \
  --url https://api.{cluster}.code.storage/api/v1/repos/commit-pack \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-ndjson' \
  --data '
"{\"metadata\":{\"target_branch\":\"main\",\"expected_head_sha\":\"d34db33fd34db33fd34db33fd34db33fd34db33f\",\"commit_message\":\"Update docs\",\"author\":{\"name\":\"Docs Bot\",\"email\":\"docs@example.com\"},\"files\":[{\"path\":\"docs/changelog.md\",\"operation\":\"upsert\",\"content_id\":\"blob-1\",\"mode\":\"100644\"},{\"path\":\"docs/legacy.txt\",\"operation\":\"delete\",\"content_id\":\"blob-2\"}]}}\n{\"blob_chunk\":{\"content_id\":\"blob-1\",\"data\":\"IyBWZXJzaW9uIDIuMS4wCi0gcmVmcmVzaCBkb2NzCg==\",\"eof\":true}}\n{\"blob_chunk\":{\"content_id\":\"blob-2\",\"data\":\"\",\"eof\":true}}\n"
'
{
  "commit": {
    "blob_count": 1,
    "commit_sha": "<string>",
    "pack_bytes": 1,
    "target_branch": "<string>",
    "tree_sha": "<string>"
  },
  "result": {
    "branch": "<string>",
    "new_sha": "<string>",
    "old_sha": "<string>",
    "status": "<string>",
    "success": true,
    "message": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/x-ndjson

Send newline-delimited JSON where the first line is a metadata object and each following line is a blob_chunk. This lets you stream file contents without a local Git client.

NDJSON stream. The first line must be metadata; subsequent lines must be blob_chunk payloads. Decoded blob chunks are limited to 4 MiB each.

Response

Commit created and written to the target branch.

Result of applying an NDJSON commit pack, including the resulting commit and branch update.

​
commit
object
required

Commit object information generated by the storage service.

​
result
object
required

Final branch update outcome.