Fork a gist

POST/gists/{uuid}/forks

Forks the targeted gist for the authenticated caller, creating a new gist owned by them whose content clones the parent and whose visibility is inherited from it.

Forking is idempotent: if the caller has already forked this gist, the endpoint returns 200 with the existing fork instead of creating a duplicate. A newly created fork returns 201. Forking your own gist is rejected with 422.

A private parent resolves only for its owner with a gist:read-capable token; other callers get 404.

Request

Headers

Name	Type	Scopes
`Authorization`required	`string`	`gist:write`

Path parameters

Name	Type	Description
`uuid`required	`string`	The gist's UUID.

Responses

Status	Body	Description
`200`	`GistSimple`	The caller had already forked this gist; the existing fork is returned.
	Headers:`Location`
`201`	`GistSimple`	The newly created fork.
	Headers:`Location`
`401`	`Error`	Missing or invalid credentials.
`403`	`Error`	The token lacks the required scope or permission.
`404`	`Error`	The requested resource does not exist (or is not visible to the caller).
`422`	`Error`	The request body failed validation.

Request

bash

curl -X POST \
  --url "https://opengist.example.com/api/gists/{uuid}/forks" \
  -H "Authorization: Bearer og_xxxxxxxx"

Response 200

json

{
  "id": "string",
  "slug_url": "string",
  "owner": {
    "id": 1,
    "login": "string",
    "username": "string",
    "avatar_url": "https://opengist.example/...",
    "type": "string",
    "created_at": "2024-01-01T00:00:00Z"
  },
  "title": "string",
  "html_url": "https://opengist.example/...",
  "description": "string",
  "public": true,
  "visibility": "public",
  "like_count": 1,
  "fork_count": 1,
  "clone_url": "https://opengist.example/...",
  "ssh_url": "string",
  "topics": [
    "string"
  ],
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}