Gists

Use the REST API to list, create, update and delete the public gists on GitHub.

Acerca de los gists

Puedes usar la API REST para ver y modificar gists. Para obtener más información sobre los gists, consulta "Edición y uso compartido de contenido con gists".

Authentication

Puede leer gists públicos y crearlos para usuarios anónimos sin un token. Para leer o escribir gists en nombre de un usuario, necesita el ámbito OAuth para gists y un token. Para más información, vea "Ámbitos para aplicaciones de OAuth".

Truncamiento

La API proporciona hasta un megabyte de contenido para cada archivo del gist. Cada archivo que se devuelve para un gist mediante la API tiene una clave denominada truncated. Si truncated es true, el archivo es demasiado grande y solo se devuelve una parte del contenido en content.

Si necesita el contenido completo del archivo, puede realizar una solicitud GET a la URL que se especifica en raw_url. Tenga en cuenta que, para los archivos mayores de 10 GB, tendrá que clonar el gist por medio de la URL que ha proporcionado git_pull_url.

Adicionalmente a el truncamiento del contenido específico del archivo, la lista de archivos completa podría truncarse si la cantidad total excede los 300 archivos. Si la clave truncated de nivel superior es true, solo se han devuelto los primeros 300 archivos de la lista de archivos. Si tiene que recuperar todos los archivos del gist, tendrá que clonarlo por medio de la URL proporcionada por git_pull_url.

Tipos de medios personalizados para los gists

Estos son los tipos de medios compatibles para recuperar el contenido de los gists.

application/vnd.github.raw
application/vnd.github.base64

Para más información, vea "Tipos de soporte físico".

List gists for the authenticated user

Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:

Parameters for "List gists for the authenticated user"

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Query parameters
Name, Type, Description
`since`string Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
`per_page`integer The number of results per page (max 100). Default: `30`
`page`integer Page number of the results to fetch. Default: `1`

HTTP response status codes for "List gists for the authenticated user"

Status code	Description
`200`	OK
`304`	Not modified
`403`	Forbidden

Code samples for "List gists for the authenticated user"

get/gists

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/gists

Response

Status: 200

[
  {
    "url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d",
    "forks_url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d/forks",
    "commits_url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d/commits",
    "id": "aa5a315d61ae9438b18d",
    "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
    "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
    "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
    "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
    "files": {
      "hello_world.rb": {
        "filename": "hello_world.rb",
        "type": "application/x-ruby",
        "language": "Ruby",
        "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
        "size": 167
      }
    },
    "public": true,
    "created_at": "2010-04-14T02:15:15Z",
    "updated_at": "2011-06-20T11:34:15Z",
    "description": "Hello World Examples",
    "comments": 0,
    "user": null,
    "comments_url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d/comments/",
    "owner": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://HOSTNAME/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://HOSTNAME/users/octocat/followers",
      "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
      "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
      "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
      "organizations_url": "https://HOSTNAME/users/octocat/orgs",
      "repos_url": "https://HOSTNAME/users/octocat/repos",
      "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
      "received_events_url": "https://HOSTNAME/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "truncated": false
  }
]

Create a gist

Allows you to add a new gist with one or more files.

Note: Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.

Parameters for "Create a gist"

Headers

Name, Type, Description

acceptstring

Setting to application/vnd.github+json is recommended.

Body parameters

Name, Type, Description

descriptionstring

Description of the gist

filesobjectRequired

Names and content for the files that make up the gist

Properties of files

Name, Type, Description

keyobject

A user-defined key to represent an item in files.

Properties of key

Name, Type, Description
`content`stringRequired Content of the file

publicboolean or string

Flag indicating whether the gist is public

HTTP response status codes for "Create a gist"

Status code	Description
`201`	Created
`304`	Not modified
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Code samples for "Create a gist"

post/gists

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/gists \
  -d '{"description":"Example of a gist","public":false,"files":{"README.md":{"content":"Hello World"}}}'

Response

Status: 201

{
  "url": "https://HOSTNAME/gists/2decf6c462d9b4418f2",
  "forks_url": "https://HOSTNAME/gists/2decf6c462d9b4418f2/forks",
  "commits_url": "https://HOSTNAME/gists/2decf6c462d9b4418f2/commits",
  "id": "2decf6c462d9b4418f2",
  "node_id": "G_kwDOBhHyLdZDliNDQxOGYy",
  "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git",
  "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git",
  "html_url": "https://gist.github.com/2decf6c462d9b4418f2",
  "files": {
    "README.md": {
      "filename": "README.md",
      "type": "text/markdown",
      "language": "Markdown",
      "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md",
      "size": 23,
      "truncated": false,
      "content": "Hello world from GitHub"
    }
  },
  "public": true,
  "created_at": "2022-09-20T12:11:58Z",
  "updated_at": "2022-09-21T10:28:06Z",
  "description": "An updated gist description.",
  "comments": 0,
  "user": null,
  "comments_url": "https://HOSTNAME/gists/2decf6c462d9b4418f2/comments",
  "owner": {
    "login": "monalisa",
    "id": 104456405,
    "node_id": "U_kgDOBhHyLQ",
    "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4",
    "gravatar_id": "",
    "url": "https://HOSTNAME/users/monalisa",
    "html_url": "https://github.com/monalisa",
    "followers_url": "https://HOSTNAME/users/monalisa/followers",
    "following_url": "https://HOSTNAME/users/monalisa/following{/other_user}",
    "gists_url": "https://HOSTNAME/users/monalisa/gists{/gist_id}",
    "starred_url": "https://HOSTNAME/users/monalisa/starred{/owner}{/repo}",
    "subscriptions_url": "https://HOSTNAME/users/monalisa/subscriptions",
    "organizations_url": "https://HOSTNAME/users/monalisa/orgs",
    "repos_url": "https://HOSTNAME/users/monalisa/repos",
    "events_url": "https://HOSTNAME/users/monalisa/events{/privacy}",
    "received_events_url": "https://HOSTNAME/users/monalisa/received_events",
    "type": "User",
    "site_admin": true
  },
  "forks": [],
  "history": [
    {
      "user": {
        "login": "monalisa",
        "id": 104456405,
        "node_id": "U_kgyLQ",
        "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4",
        "gravatar_id": "",
        "url": "https://HOSTNAME/users/monalisa",
        "html_url": "https://github.com/monalisa",
        "followers_url": "https://HOSTNAME/users/monalisa/followers",
        "following_url": "https://HOSTNAME/users/monalisa/following{/other_user}",
        "gists_url": "https://HOSTNAME/users/monalisa/gists{/gist_id}",
        "starred_url": "https://HOSTNAME/users/monalisa/starred{/owner}{/repo}",
        "subscriptions_url": "https://HOSTNAME/users/monalisa/subscriptions",
        "organizations_url": "https://HOSTNAME/users/monalisa/orgs",
        "repos_url": "https://HOSTNAME/users/monalisa/repos",
        "events_url": "https://HOSTNAME/users/monalisa/events{/privacy}",
        "received_events_url": "https://HOSTNAME/users/monalisa/received_events",
        "type": "User",
        "site_admin": true
      },
      "version": "468aac8caed5f0c3b859b8286968",
      "committed_at": "2022-09-21T10:28:06Z",
      "change_status": {
        "total": 2,
        "additions": 1,
        "deletions": 1
      },
      "url": "https://HOSTNAME/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968"
    }
  ],
  "truncated": false
}

List public gists

List public gists sorted by most recently updated to least recently updated.

Note: With pagination, you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.

Parameters for "List public gists"

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Query parameters
Name, Type, Description
`since`string Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
`per_page`integer The number of results per page (max 100). Default: `30`
`page`integer Page number of the results to fetch. Default: `1`

HTTP response status codes for "List public gists"

Status code	Description
`200`	OK
`304`	Not modified
`403`	Forbidden
`422`	Validation failed, or the endpoint has been spammed.

Code samples for "List public gists"

get/gists/public

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/gists/public

Response

Status: 200

[
  {
    "url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d",
    "forks_url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d/forks",
    "commits_url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d/commits",
    "id": "aa5a315d61ae9438b18d",
    "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
    "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
    "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
    "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
    "files": {
      "hello_world.rb": {
        "filename": "hello_world.rb",
        "type": "application/x-ruby",
        "language": "Ruby",
        "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
        "size": 167
      }
    },
    "public": true,
    "created_at": "2010-04-14T02:15:15Z",
    "updated_at": "2011-06-20T11:34:15Z",
    "description": "Hello World Examples",
    "comments": 0,
    "user": null,
    "comments_url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d/comments/",
    "owner": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://HOSTNAME/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://HOSTNAME/users/octocat/followers",
      "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
      "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
      "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
      "organizations_url": "https://HOSTNAME/users/octocat/orgs",
      "repos_url": "https://HOSTNAME/users/octocat/repos",
      "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
      "received_events_url": "https://HOSTNAME/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "truncated": false
  }
]

List starred gists

List the authenticated user's starred gists:

Parameters for "List starred gists"

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Query parameters
Name, Type, Description
`since`string Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
`per_page`integer The number of results per page (max 100). Default: `30`
`page`integer Page number of the results to fetch. Default: `1`

HTTP response status codes for "List starred gists"

Status code	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

Code samples for "List starred gists"

get/gists/starred

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/gists/starred

Response

Status: 200

[
  {
    "url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d",
    "forks_url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d/forks",
    "commits_url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d/commits",
    "id": "aa5a315d61ae9438b18d",
    "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
    "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
    "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
    "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
    "files": {
      "hello_world.rb": {
        "filename": "hello_world.rb",
        "type": "application/x-ruby",
        "language": "Ruby",
        "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
        "size": 167
      }
    },
    "public": true,
    "created_at": "2010-04-14T02:15:15Z",
    "updated_at": "2011-06-20T11:34:15Z",
    "description": "Hello World Examples",
    "comments": 0,
    "user": null,
    "comments_url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d/comments/",
    "owner": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://HOSTNAME/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://HOSTNAME/users/octocat/followers",
      "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
      "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
      "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
      "organizations_url": "https://HOSTNAME/users/octocat/orgs",
      "repos_url": "https://HOSTNAME/users/octocat/repos",
      "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
      "received_events_url": "https://HOSTNAME/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "truncated": false
  }
]

Get a gist

Parameters for "Get a gist"

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`gist_id`stringRequired The unique identifier of the gist.

HTTP response status codes for "Get a gist"

Status code	Description
`200`	OK
`304`	Not modified
`403`	Forbidden Gist
`404`	Resource not found

Code samples for "Get a gist"

get/gists/{gist_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/gists/GIST_ID

Response

Status: 200

{
  "url": "https://HOSTNAME/gists/2decf6c462d9b4418f2",
  "forks_url": "https://HOSTNAME/gists/2decf6c462d9b4418f2/forks",
  "commits_url": "https://HOSTNAME/gists/2decf6c462d9b4418f2/commits",
  "id": "2decf6c462d9b4418f2",
  "node_id": "G_kwDOBhHyLdZDliNDQxOGYy",
  "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git",
  "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git",
  "html_url": "https://gist.github.com/2decf6c462d9b4418f2",
  "files": {
    "README.md": {
      "filename": "README.md",
      "type": "text/markdown",
      "language": "Markdown",
      "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md",
      "size": 23,
      "truncated": false,
      "content": "Hello world from GitHub"
    }
  },
  "public": true,
  "created_at": "2022-09-20T12:11:58Z",
  "updated_at": "2022-09-21T10:28:06Z",
  "description": "An updated gist description.",
  "comments": 0,
  "user": null,
  "comments_url": "https://HOSTNAME/gists/2decf6c462d9b4418f2/comments",
  "owner": {
    "login": "monalisa",
    "id": 104456405,
    "node_id": "U_kgDOBhHyLQ",
    "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4",
    "gravatar_id": "",
    "url": "https://HOSTNAME/users/monalisa",
    "html_url": "https://github.com/monalisa",
    "followers_url": "https://HOSTNAME/users/monalisa/followers",
    "following_url": "https://HOSTNAME/users/monalisa/following{/other_user}",
    "gists_url": "https://HOSTNAME/users/monalisa/gists{/gist_id}",
    "starred_url": "https://HOSTNAME/users/monalisa/starred{/owner}{/repo}",
    "subscriptions_url": "https://HOSTNAME/users/monalisa/subscriptions",
    "organizations_url": "https://HOSTNAME/users/monalisa/orgs",
    "repos_url": "https://HOSTNAME/users/monalisa/repos",
    "events_url": "https://HOSTNAME/users/monalisa/events{/privacy}",
    "received_events_url": "https://HOSTNAME/users/monalisa/received_events",
    "type": "User",
    "site_admin": true
  },
  "forks": [],
  "history": [
    {
      "user": {
        "login": "monalisa",
        "id": 104456405,
        "node_id": "U_kgyLQ",
        "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4",
        "gravatar_id": "",
        "url": "https://HOSTNAME/users/monalisa",
        "html_url": "https://github.com/monalisa",
        "followers_url": "https://HOSTNAME/users/monalisa/followers",
        "following_url": "https://HOSTNAME/users/monalisa/following{/other_user}",
        "gists_url": "https://HOSTNAME/users/monalisa/gists{/gist_id}",
        "starred_url": "https://HOSTNAME/users/monalisa/starred{/owner}{/repo}",
        "subscriptions_url": "https://HOSTNAME/users/monalisa/subscriptions",
        "organizations_url": "https://HOSTNAME/users/monalisa/orgs",
        "repos_url": "https://HOSTNAME/users/monalisa/repos",
        "events_url": "https://HOSTNAME/users/monalisa/events{/privacy}",
        "received_events_url": "https://HOSTNAME/users/monalisa/received_events",
        "type": "User",
        "site_admin": true
      },
      "version": "468aac8caed5f0c3b859b8286968",
      "committed_at": "2022-09-21T10:28:06Z",
      "change_status": {
        "total": 2,
        "additions": 1,
        "deletions": 1
      },
      "url": "https://HOSTNAME/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968"
    }
  ],
  "truncated": false
}

Update a gist

Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.

Parameters for "Update a gist"

Headers

Name, Type, Description

acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters

Name, Type, Description

gist_idstringRequired

The unique identifier of the gist.

Body parameters

Name, Type, Description

descriptionstring

The description of the gist.

filesobject

The gist files to be updated, renamed, or deleted. Each key must match the current filename (including extension) of the targeted gist file. For example: hello.py.

To delete a file, set the whole file to null. For example: hello.py : null.

Properties of files

Name, Type, Description

keyobject

A user-defined key to represent an item in files.

Properties of key

Name, Type, Description
`content`string The new content of the file.
`filename`string or null The new filename for the file.

HTTP response status codes for "Update a gist"

Status code	Description
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Code samples for "Update a gist"

patch/gists/{gist_id}

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/gists/GIST_ID \
  -d '{"description":"An updated gist description","files":{"README.md":{"content":"Hello World from GitHub"}}}'

Response

Status: 200

{
  "url": "https://HOSTNAME/gists/2decf6c462d9b4418f2",
  "forks_url": "https://HOSTNAME/gists/2decf6c462d9b4418f2/forks",
  "commits_url": "https://HOSTNAME/gists/2decf6c462d9b4418f2/commits",
  "id": "2decf6c462d9b4418f2",
  "node_id": "G_kwDOBhHyLdZDliNDQxOGYy",
  "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git",
  "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git",
  "html_url": "https://gist.github.com/2decf6c462d9b4418f2",
  "files": {
    "README.md": {
      "filename": "README.md",
      "type": "text/markdown",
      "language": "Markdown",
      "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md",
      "size": 23,
      "truncated": false,
      "content": "Hello world from GitHub"
    }
  },
  "public": true,
  "created_at": "2022-09-20T12:11:58Z",
  "updated_at": "2022-09-21T10:28:06Z",
  "description": "An updated gist description.",
  "comments": 0,
  "user": null,
  "comments_url": "https://HOSTNAME/gists/2decf6c462d9b4418f2/comments",
  "owner": {
    "login": "monalisa",
    "id": 104456405,
    "node_id": "U_kgDOBhHyLQ",
    "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4",
    "gravatar_id": "",
    "url": "https://HOSTNAME/users/monalisa",
    "html_url": "https://github.com/monalisa",
    "followers_url": "https://HOSTNAME/users/monalisa/followers",
    "following_url": "https://HOSTNAME/users/monalisa/following{/other_user}",
    "gists_url": "https://HOSTNAME/users/monalisa/gists{/gist_id}",
    "starred_url": "https://HOSTNAME/users/monalisa/starred{/owner}{/repo}",
    "subscriptions_url": "https://HOSTNAME/users/monalisa/subscriptions",
    "organizations_url": "https://HOSTNAME/users/monalisa/orgs",
    "repos_url": "https://HOSTNAME/users/monalisa/repos",
    "events_url": "https://HOSTNAME/users/monalisa/events{/privacy}",
    "received_events_url": "https://HOSTNAME/users/monalisa/received_events",
    "type": "User",
    "site_admin": true
  },
  "forks": [],
  "history": [
    {
      "user": {
        "login": "monalisa",
        "id": 104456405,
        "node_id": "U_kgyLQ",
        "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4",
        "gravatar_id": "",
        "url": "https://HOSTNAME/users/monalisa",
        "html_url": "https://github.com/monalisa",
        "followers_url": "https://HOSTNAME/users/monalisa/followers",
        "following_url": "https://HOSTNAME/users/monalisa/following{/other_user}",
        "gists_url": "https://HOSTNAME/users/monalisa/gists{/gist_id}",
        "starred_url": "https://HOSTNAME/users/monalisa/starred{/owner}{/repo}",
        "subscriptions_url": "https://HOSTNAME/users/monalisa/subscriptions",
        "organizations_url": "https://HOSTNAME/users/monalisa/orgs",
        "repos_url": "https://HOSTNAME/users/monalisa/repos",
        "events_url": "https://HOSTNAME/users/monalisa/events{/privacy}",
        "received_events_url": "https://HOSTNAME/users/monalisa/received_events",
        "type": "User",
        "site_admin": true
      },
      "version": "468aac8caed5f0c3b859b8286968",
      "committed_at": "2022-09-21T10:28:06Z",
      "change_status": {
        "total": 2,
        "additions": 1,
        "deletions": 1
      },
      "url": "https://HOSTNAME/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968"
    }
  ],
  "truncated": false
}

Delete a gist

Parameters for "Delete a gist"

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`gist_id`stringRequired The unique identifier of the gist.

HTTP response status codes for "Delete a gist"

Status code	Description
`204`	No Content
`304`	Not modified
`403`	Forbidden
`404`	Resource not found

Code samples for "Delete a gist"

delete/gists/{gist_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/gists/GIST_ID

Response

Status: 204

List gist commits

Parameters for "List gist commits"

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`gist_id`stringRequired The unique identifier of the gist.
Query parameters
Name, Type, Description
`per_page`integer The number of results per page (max 100). Default: `30`
`page`integer Page number of the results to fetch. Default: `1`

HTTP response status codes for "List gist commits"

Status code	Description
`200`	OK
`304`	Not modified
`403`	Forbidden
`404`	Resource not found

Code samples for "List gist commits"

get/gists/{gist_id}/commits

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/gists/GIST_ID/commits

Response

Status: 200

[
  {
    "url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f",
    "version": "57a7f021a713b1c5a6a199b54cc514735d2d462f",
    "user": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://HOSTNAME/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://HOSTNAME/users/octocat/followers",
      "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
      "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
      "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
      "organizations_url": "https://HOSTNAME/users/octocat/orgs",
      "repos_url": "https://HOSTNAME/users/octocat/repos",
      "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
      "received_events_url": "https://HOSTNAME/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "change_status": {
      "deletions": 0,
      "additions": 180,
      "total": 180
    },
    "committed_at": "2010-04-14T02:15:15Z"
  }
]

List gist forks

Parameters for "List gist forks"

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`gist_id`stringRequired The unique identifier of the gist.
Query parameters
Name, Type, Description
`per_page`integer The number of results per page (max 100). Default: `30`
`page`integer Page number of the results to fetch. Default: `1`

HTTP response status codes for "List gist forks"

Status code	Description
`200`	OK
`304`	Not modified
`403`	Forbidden
`404`	Resource not found

Code samples for "List gist forks"

get/gists/{gist_id}/forks

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/gists/GIST_ID/forks

Response

Status: 200

[
  {
    "url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d",
    "forks_url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d/forks",
    "commits_url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d/commits",
    "id": "aa5a315d61ae9438b18d",
    "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
    "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
    "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
    "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
    "files": {
      "hello_world.rb": {
        "filename": "hello_world.rb",
        "type": "application/x-ruby",
        "language": "Ruby",
        "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
        "size": 167
      }
    },
    "public": true,
    "created_at": "2010-04-14T02:15:15Z",
    "updated_at": "2011-06-20T11:34:15Z",
    "description": "Hello World Examples",
    "comments": 1,
    "user": null,
    "comments_url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d/comments/",
    "owner": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://HOSTNAME/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://HOSTNAME/users/octocat/followers",
      "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
      "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
      "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
      "organizations_url": "https://HOSTNAME/users/octocat/orgs",
      "repos_url": "https://HOSTNAME/users/octocat/repos",
      "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
      "received_events_url": "https://HOSTNAME/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    }
  }
]

Fork a gist

Parameters for "Fork a gist"

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`gist_id`stringRequired The unique identifier of the gist.

HTTP response status codes for "Fork a gist"

Status code	Description
`201`	Created
`304`	Not modified
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Code samples for "Fork a gist"

post/gists/{gist_id}/forks

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/gists/GIST_ID/forks

Response

Status: 201

{
  "url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d",
  "forks_url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d/forks",
  "commits_url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d/commits",
  "id": "aa5a315d61ae9438b18d",
  "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
  "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
  "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
  "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
  "files": {
    "hello_world.rb": {
      "filename": "hello_world.rb",
      "type": "application/x-ruby",
      "language": "Ruby",
      "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
      "size": 167
    }
  },
  "public": true,
  "created_at": "2010-04-14T02:15:15Z",
  "updated_at": "2011-06-20T11:34:15Z",
  "description": "Hello World Examples",
  "comments": 0,
  "user": null,
  "comments_url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d/comments/",
  "owner": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://HOSTNAME/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://HOSTNAME/users/octocat/followers",
    "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
    "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
    "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
    "organizations_url": "https://HOSTNAME/users/octocat/orgs",
    "repos_url": "https://HOSTNAME/users/octocat/repos",
    "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
    "received_events_url": "https://HOSTNAME/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "truncated": false
}

Check if a gist is starred

Parameters for "Check if a gist is starred"

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`gist_id`stringRequired The unique identifier of the gist.

HTTP response status codes for "Check if a gist is starred"

Status code	Description
`204`	Response if gist is starred
`304`	Not modified
`403`	Forbidden
`404`	Not Found if gist is not starred

Code samples for "Check if a gist is starred"

get/gists/{gist_id}/star

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/gists/GIST_ID/star

Response if gist is starred

Status: 204

Star a gist

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

Parameters for "Star a gist"

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`gist_id`stringRequired The unique identifier of the gist.

HTTP response status codes for "Star a gist"

Status code	Description
`204`	No Content
`304`	Not modified
`403`	Forbidden
`404`	Resource not found

Code samples for "Star a gist"

put/gists/{gist_id}/star

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/gists/GIST_ID/star

Response

Status: 204

Unstar a gist

Parameters for "Unstar a gist"

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`gist_id`stringRequired The unique identifier of the gist.

HTTP response status codes for "Unstar a gist"

Status code	Description
`204`	No Content
`304`	Not modified
`403`	Forbidden
`404`	Resource not found

Code samples for "Unstar a gist"

delete/gists/{gist_id}/star

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/gists/GIST_ID/star

Response

Status: 204

Get a gist revision

Parameters for "Get a gist revision"

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`gist_id`stringRequired The unique identifier of the gist.
`sha`stringRequired

HTTP response status codes for "Get a gist revision"

Status code	Description
`200`	OK
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Code samples for "Get a gist revision"

get/gists/{gist_id}/{sha}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/gists/GIST_ID/SHA

Response

Status: 200

{
  "url": "https://HOSTNAME/gists/2decf6c462d9b4418f2",
  "forks_url": "https://HOSTNAME/gists/2decf6c462d9b4418f2/forks",
  "commits_url": "https://HOSTNAME/gists/2decf6c462d9b4418f2/commits",
  "id": "2decf6c462d9b4418f2",
  "node_id": "G_kwDOBhHyLdZDliNDQxOGYy",
  "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git",
  "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git",
  "html_url": "https://gist.github.com/2decf6c462d9b4418f2",
  "files": {
    "README.md": {
      "filename": "README.md",
      "type": "text/markdown",
      "language": "Markdown",
      "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md",
      "size": 23,
      "truncated": false,
      "content": "Hello world from GitHub"
    }
  },
  "public": true,
  "created_at": "2022-09-20T12:11:58Z",
  "updated_at": "2022-09-21T10:28:06Z",
  "description": "An updated gist description.",
  "comments": 0,
  "user": null,
  "comments_url": "https://HOSTNAME/gists/2decf6c462d9b4418f2/comments",
  "owner": {
    "login": "monalisa",
    "id": 104456405,
    "node_id": "U_kgDOBhHyLQ",
    "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4",
    "gravatar_id": "",
    "url": "https://HOSTNAME/users/monalisa",
    "html_url": "https://github.com/monalisa",
    "followers_url": "https://HOSTNAME/users/monalisa/followers",
    "following_url": "https://HOSTNAME/users/monalisa/following{/other_user}",
    "gists_url": "https://HOSTNAME/users/monalisa/gists{/gist_id}",
    "starred_url": "https://HOSTNAME/users/monalisa/starred{/owner}{/repo}",
    "subscriptions_url": "https://HOSTNAME/users/monalisa/subscriptions",
    "organizations_url": "https://HOSTNAME/users/monalisa/orgs",
    "repos_url": "https://HOSTNAME/users/monalisa/repos",
    "events_url": "https://HOSTNAME/users/monalisa/events{/privacy}",
    "received_events_url": "https://HOSTNAME/users/monalisa/received_events",
    "type": "User",
    "site_admin": true
  },
  "forks": [],
  "history": [
    {
      "user": {
        "login": "monalisa",
        "id": 104456405,
        "node_id": "U_kgyLQ",
        "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4",
        "gravatar_id": "",
        "url": "https://HOSTNAME/users/monalisa",
        "html_url": "https://github.com/monalisa",
        "followers_url": "https://HOSTNAME/users/monalisa/followers",
        "following_url": "https://HOSTNAME/users/monalisa/following{/other_user}",
        "gists_url": "https://HOSTNAME/users/monalisa/gists{/gist_id}",
        "starred_url": "https://HOSTNAME/users/monalisa/starred{/owner}{/repo}",
        "subscriptions_url": "https://HOSTNAME/users/monalisa/subscriptions",
        "organizations_url": "https://HOSTNAME/users/monalisa/orgs",
        "repos_url": "https://HOSTNAME/users/monalisa/repos",
        "events_url": "https://HOSTNAME/users/monalisa/events{/privacy}",
        "received_events_url": "https://HOSTNAME/users/monalisa/received_events",
        "type": "User",
        "site_admin": true
      },
      "version": "468aac8caed5f0c3b859b8286968",
      "committed_at": "2022-09-21T10:28:06Z",
      "change_status": {
        "total": 2,
        "additions": 1,
        "deletions": 1
      },
      "url": "https://HOSTNAME/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968"
    }
  ],
  "truncated": false
}

List gists for a user

Lists public gists for the specified user:

Parameters for "List gists for a user"

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`username`stringRequired The handle for the GitHub user account.
Query parameters
Name, Type, Description
`since`string Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
`per_page`integer The number of results per page (max 100). Default: `30`
`page`integer Page number of the results to fetch. Default: `1`

HTTP response status codes for "List gists for a user"

Status code	Description
`200`	OK
`422`	Validation failed, or the endpoint has been spammed.

Code samples for "List gists for a user"

get/users/{username}/gists

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/users/USERNAME/gists

Response

Status: 200

[
  {
    "url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d",
    "forks_url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d/forks",
    "commits_url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d/commits",
    "id": "aa5a315d61ae9438b18d",
    "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
    "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
    "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
    "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
    "files": {
      "hello_world.rb": {
        "filename": "hello_world.rb",
        "type": "application/x-ruby",
        "language": "Ruby",
        "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
        "size": 167
      }
    },
    "public": true,
    "created_at": "2010-04-14T02:15:15Z",
    "updated_at": "2011-06-20T11:34:15Z",
    "description": "Hello World Examples",
    "comments": 0,
    "user": null,
    "comments_url": "https://HOSTNAME/gists/aa5a315d61ae9438b18d/comments/",
    "owner": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://HOSTNAME/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://HOSTNAME/users/octocat/followers",
      "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
      "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
      "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
      "organizations_url": "https://HOSTNAME/users/octocat/orgs",
      "repos_url": "https://HOSTNAME/users/octocat/repos",
      "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
      "received_events_url": "https://HOSTNAME/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "truncated": false
  }
]