Update a gist

PATCH

/gists/{gist_id}

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.

At least one of description or files is required.

This endpoint supports the following custom media types. For more information, see "Media types."

application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.

application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.

リクエストパラメータ

パスパラメータ

リクエストボディパラメータapplication/json

例

レスポンス

🟢200OK

application/json

Response

ボディapplication/json

🟠404Record Not Found

🟠422Parameter Error

リクエストExample

Shell

JavaScript

Java

Swift

cURL

Updating a gistDeleting a gist fileRenaming a gist file

curl --location --request PATCH 'https://service1.exmaple.com/gists/' \
--header 'Content-Type: application/json' \
--data '{
    "description": "An updated gist description",
    "files": {
        "README.md": {
            "content": "Hello World from GitHub"
        }
    }
}'

レスポンスExample

200 - updateGist

{
    "url": "https://api.github.com/gists/2decf6c462d9b4418f2",
    "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks",
    "commits_url": "https://api.github.com/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://api.github.com/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://api.github.com/users/monalisa",
        "html_url": "https://github.com/monalisa",
        "followers_url": "https://api.github.com/users/monalisa/followers",
        "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
        "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
        "organizations_url": "https://api.github.com/users/monalisa/orgs",
        "repos_url": "https://api.github.com/users/monalisa/repos",
        "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
        "received_events_url": "https://api.github.com/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://api.github.com/users/monalisa",
                "html_url": "https://github.com/monalisa",
                "followers_url": "https://api.github.com/users/monalisa/followers",
                "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
                "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
                "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
                "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
                "organizations_url": "https://api.github.com/users/monalisa/orgs",
                "repos_url": "https://api.github.com/users/monalisa/repos",
                "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
                "received_events_url": "https://api.github.com/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://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968"
        }
    ],
    "truncated": false
}

更新日時 2025-06-12 06:47:19

Get a gist

Delete a gist