Update a reference - GitHub v3 REST API

curl --location --request PATCH 'https://api.github.com/repos///git/refs/refs/head/master' \ --header 'Content-Type: application/json' \ --data-raw '{ "force": true, "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd" }'

{ "node_id": "string", "object": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "type": "string", "url": "http://example.com" }, "ref": "string", "url": "http://example.com" }

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.

ref

string

required

The name of the fully qualified reference to update. For example, refs/heads/master. If the value doesn't start with refs and have at least two slashes, it will be rejected.

Example:

refs/head/master

Body Params application/json

force

boolean

optional

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.

Default:

false

sha

string

required

The SHA1 value to set this reference to

Examples

Responses

🟢200Response

application/json

Body

Git references within a repository

node_id

string

required

object

required

sha

string

required

SHA for the reference

>= 40 characters<= 40 characters

Example:

7638417db6d59f3c431d3e1f261cc637155684cd

type

string

required

url

string <uri>

required

ref

string

required

url

string <uri>

required

🟠422422