git

Update a reference

Updates the provided reference to point to a new SHA. For more information, see "Git References" in the Git documentation.

patch/repos/{owner}/{repo}/git/refs/{ref}

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/repos/{owner}/{repo}/git/refs/{ref}
  • Auth: none declared

Path parameters

ownerstring required

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

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

refstring required

The Git reference. For more information, see "Git References" in the Git documentation.

Request body

shastring required

The SHA1 value to set this reference to

forceboolean

Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.

Response

Response

refstring required
node_idstring required
urlstring uri required

Example response

{
  "object": {
    "sha": "7638417db6d59f3c431d3e1f261cc637155684cd"
  }
}

Changes

No recorded changes to this operation across all 23 revisions of this API.