# Gist에 대한 REST API 엔드포인트

REST API를 사용하여 GitHub 공개 요지를 나열, 만들기, 업데이트 및 삭제합니다.

## gist에 대하여

REST API를 사용하여 gist를 보고 수정할 수 있습니다. gist에 대한 자세한 내용은 [Gist가 있는 콘텐츠의 편집 및 공유](/ko/enterprise-server@3.20/get-started/writing-on-github/editing-and-sharing-content-with-gists)을(를) 참조하세요.

### 인증

토큰이 없는 익명 사용자를 위해 퍼블릭 gist를 읽고 만들 수 있습니다. 사용자를 대신하여 gist를 읽거나 쓰려면 gist OAuth 범위와 토큰이 필요합니다. 자세한 내용은 [OAuth 앱에 대한 범위](/ko/enterprise-server@3.20/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps)을(를) 참조하세요.

<!-- When an OAuth client does not have the gists scope, the API will return a 404 "Not Found" response regardless of the validity of the credentials. The API will return a 401 "Bad credentials" response if the gists scope was given to the application but the credentials are invalid. -->

### 잘림

API는 gist의 각 파일에 대해 최대 1MB의 콘텐츠를 제공합니다. API를 통해 gist용으로 반환된 각 파일에는 `truncated`라는 키가 있습니다.
`truncated`가 `true`인 경우 파일이 너무 커서 내용의 일부만 `content`에 반환된 것입니다.

파일의 전체 내용이 필요한 경우 `GET`에서 지정한 URL에 대해 `raw_url` 요청을 만들 수 있습니다. 10MB보다 큰 파일의 경우 `git_pull_url`에서 제공하는 URL을 통해 gist를 복제해야 합니다.

특정 파일의 내용이 잘리는 것 외에도 총 파일 수가 300개를 초과하면 전체 파일 목록이 잘릴 수 있습니다. 최상위 `truncated` 키가 `true`경우 처음 300개 파일만 파일 목록에 반환됩니다. gist의 파일을 모두 가져와야 하는 경우 `git_pull_url`에서 제공하는 URL을 통해 gist를 복제해야 합니다.

> \[!NOTE]
> Most endpoints use `Authorization: Bearer <YOUR-TOKEN>` and `Accept: application/vnd.github+json` headers, plus `X-GitHub-Api-Version: 2022-11-28`. Curl examples below omit these standard headers for brevity.

## List gists for the authenticated user

```
GET /gists
```

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

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`since`** (string)
  Only show results that were last 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). For more information, see "Using pagination in the REST API."
  Default: `30`

* **`page`** (integer)
  The page number of the results to fetch. For more information, see "Using pagination in the REST API."
  Default: `1`

### HTTP response status codes

* **200** - OK

* **304** - Not modified

* **403** - Forbidden

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  http(s)://HOSTNAME/api/v3/gists
```

**Response schema (Status: 200):**

Array of `Base Gist`:

* `url`: required, string, format: uri
* `forks_url`: required, string, format: uri
* `commits_url`: required, string, format: uri
* `id`: required, string
* `node_id`: required, string
* `git_pull_url`: required, string, format: uri
* `git_push_url`: required, string, format: uri
* `html_url`: required, string, format: uri
* `files`: required, object, additional properties: object
* `public`: required, boolean
* `created_at`: required, string, format: date-time
* `updated_at`: required, string, format: date-time
* `description`: required, string or null
* `comments`: required, integer
* `comments_enabled`: boolean
* `user`: required, any of:
  * **null**
  * **Simple User**
    * `name`: string or null
    * `email`: string or null
    * `login`: required, string
    * `id`: required, integer, format: int64
    * `node_id`: required, string
    * `avatar_url`: required, string, format: uri
    * `gravatar_id`: required, string or null
    * `url`: required, string, format: uri
    * `html_url`: required, string, format: uri
    * `followers_url`: required, string, format: uri
    * `following_url`: required, string
    * `gists_url`: required, string
    * `starred_url`: required, string
    * `subscriptions_url`: required, string, format: uri
    * `organizations_url`: required, string, format: uri
    * `repos_url`: required, string, format: uri
    * `events_url`: required, string
    * `received_events_url`: required, string, format: uri
    * `type`: required, string
    * `site_admin`: required, boolean
    * `starred_at`: string
    * `user_view_type`: string
* `comments_url`: required, string, format: uri
* `owner`: `Simple User` (see above)
* `truncated`: boolean
* `forks`: array of object
* `history`: array of object

## Create a gist

```
POST /gists
```

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

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Body parameters

* **`description`** (string)
  Description of the gist

* **`files`** (object) (required)
  Names and content for the files that make up the gist
  * **`key`** (object)
    A user-defined key to represent an item in files.
    * **`content`** (string) (required)
      Content of the file

* **`public`** (boolean or string)
  Flag indicating whether the gist is public

### HTTP response status codes

* **201** - Created

* **304** - Not modified

* **403** - Forbidden

* **404** - Resource not found

* **422** - Validation failed, or the endpoint has been spammed.

### Code examples

#### Creating a gist

**Request:**

```curl
curl -L \
  -X POST \
  http(s)://HOSTNAME/api/v3/gists \
  -d '{
  "description": "Example of a gist",
  "public": false,
  "files": {
    "README.md": {
      "content": "Hello World"
    }
  }
}'
```

**Response schema (Status: 201):**

* `forks`: array of objects or null:
  * `id`: string
  * `url`: string, format: uri
  * `user`: `Public User`:
    * `login`: required, string
    * `id`: required, integer, format: int64
    * `user_view_type`: string
    * `node_id`: required, string
    * `avatar_url`: required, string, format: uri
    * `gravatar_id`: required, string or null
    * `url`: required, string, format: uri
    * `html_url`: required, string, format: uri
    * `followers_url`: required, string, format: uri
    * `following_url`: required, string
    * `gists_url`: required, string
    * `starred_url`: required, string
    * `subscriptions_url`: required, string, format: uri
    * `organizations_url`: required, string, format: uri
    * `repos_url`: required, string, format: uri
    * `events_url`: required, string
    * `received_events_url`: required, string, format: uri
    * `type`: required, string
    * `site_admin`: required, boolean
    * `name`: required, string or null
    * `company`: required, string or null
    * `blog`: required, string or null
    * `location`: required, string or null
    * `email`: required, string or null, format: email
    * `notification_email`: string or null, format: email
    * `hireable`: required, boolean or null
    * `bio`: required, string or null
    * `twitter_username`: string or null
    * `public_repos`: required, integer
    * `public_gists`: required, integer
    * `followers`: required, integer
    * `following`: required, integer
    * `created_at`: required, string, format: date-time
    * `updated_at`: required, string, format: date-time
    * `plan`: object:
      * `collaborators`: required, integer
      * `name`: required, string
      * `space`: required, integer
      * `private_repos`: required, integer
    * `private_gists`: integer
    * `total_private_repos`: integer
    * `owned_private_repos`: integer
    * `disk_usage`: integer
    * `collaborators`: integer
  * `created_at`: string, format: date-time
  * `updated_at`: string, format: date-time
* `history`: array of `Gist History` or null:
  * `user`: any of:
    * **null**
    * **Simple User**
      * `name`: string or null
      * `email`: string or null
      * `login`: required, string
      * `id`: required, integer, format: int64
      * `node_id`: required, string
      * `avatar_url`: required, string, format: uri
      * `gravatar_id`: required, string or null
      * `url`: required, string, format: uri
      * `html_url`: required, string, format: uri
      * `followers_url`: required, string, format: uri
      * `following_url`: required, string
      * `gists_url`: required, string
      * `starred_url`: required, string
      * `subscriptions_url`: required, string, format: uri
      * `organizations_url`: required, string, format: uri
      * `repos_url`: required, string, format: uri
      * `events_url`: required, string
      * `received_events_url`: required, string, format: uri
      * `type`: required, string
      * `site_admin`: required, boolean
      * `starred_at`: string
      * `user_view_type`: string
  * `version`: string
  * `committed_at`: string, format: date-time
  * `change_status`: object:
    * `total`: integer
    * `additions`: integer
    * `deletions`: integer
  * `url`: string, format: uri
* `fork_of`: `Gist`:
  * `url`: required, string, format: uri
  * `forks_url`: required, string, format: uri
  * `commits_url`: required, string, format: uri
  * `id`: required, string
  * `node_id`: required, string
  * `git_pull_url`: required, string, format: uri
  * `git_push_url`: required, string, format: uri
  * `html_url`: required, string, format: uri
  * `files`: required, object, additional properties: object
  * `public`: required, boolean
  * `created_at`: required, string, format: date-time
  * `updated_at`: required, string, format: date-time
  * `description`: required, string or null
  * `comments`: required, integer
  * `comments_enabled`: boolean
  * `user`: required, any of:
    * **null**
    * **Simple User** (see above)
  * `comments_url`: required, string, format: uri
  * `owner`: any of:
    * **null**
    * **Simple User** (see above)
  * `truncated`: boolean
  * `forks`: array of object
  * `history`: array of object
* `url`: string
* `forks_url`: string
* `commits_url`: string
* `id`: string
* `node_id`: string
* `git_pull_url`: string
* `git_push_url`: string
* `html_url`: string
* `files`: object, additional properties: object or null
* `public`: boolean
* `created_at`: string
* `updated_at`: string
* `description`: string or null
* `comments`: integer
* `comments_enabled`: boolean
* `user`: string or null
* `comments_url`: string
* `owner`: `Simple User` (see above)
* `truncated`: boolean

## List public gists

```
GET /gists/public
```

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

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`since`** (string)
  Only show results that were last 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). For more information, see "Using pagination in the REST API."
  Default: `30`

* **`page`** (integer)
  The page number of the results to fetch. For more information, see "Using pagination in the REST API."
  Default: `1`

### HTTP response status codes

* **200** - OK

* **304** - Not modified

* **403** - Forbidden

* **422** - Validation failed, or the endpoint has been spammed.

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  http(s)://HOSTNAME/api/v3/gists/public
```

**Response schema (Status: 200):**

Same response schema as [List gists for the authenticated user](#list-gists-for-the-authenticated-user).

## List starred gists

```
GET /gists/starred
```

List the authenticated user's starred gists:

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`since`** (string)
  Only show results that were last 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). For more information, see "Using pagination in the REST API."
  Default: `30`

* **`page`** (integer)
  The page number of the results to fetch. For more information, see "Using pagination in the REST API."
  Default: `1`

### HTTP response status codes

* **200** - OK

* **304** - Not modified

* **401** - Requires authentication

* **403** - Forbidden

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  http(s)://HOSTNAME/api/v3/gists/starred
```

**Response schema (Status: 200):**

Same response schema as [List gists for the authenticated user](#list-gists-for-the-authenticated-user).

## Get a gist

```
GET /gists/{gist_id}
```

Gets a specified gist.
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.

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`gist_id`** (string) (required)
  The unique identifier of the gist.

### HTTP response status codes

* **200** - OK

* **304** - Not modified

* **403** - Forbidden Gist

* **404** - Resource not found

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  http(s)://HOSTNAME/api/v3/gists/GIST_ID
```

**Response schema (Status: 200):**

Same response schema as [Create a gist](#create-a-gist).

## 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.

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`gist_id`** (string) (required)
  The unique identifier of the gist.

#### Body parameters

* **`description`** (string)
  The description of the gist.

* **`files`** (object)
  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. The file will also be
  deleted if the specified object does not contain at least one of content or filename.
  * **`key`** (object)
    A user-defined key to represent an item in files.
    * **`content`** (string)
      The new content of the file.
    * **`filename`** (string or null)
      The new filename for the file.

### HTTP response status codes

* **200** - OK

* **404** - Resource not found

* **422** - Validation failed, or the endpoint has been spammed.

### Code examples

#### Updating a gist

**Request:**

```curl
curl -L \
  -X PATCH \
  http(s)://HOSTNAME/api/v3/gists/GIST_ID \
  -d '{
  "description": "An updated gist description",
  "files": {
    "README.md": {
      "content": "Hello World from GitHub"
    }
  }
}'
```

**Response schema (Status: 200):**

Same response schema as [Create a gist](#create-a-gist).

#### Deleting a gist file

**Request:**

```curl
curl -L \
  -X PATCH \
  http(s)://HOSTNAME/api/v3/gists/GIST_ID \
  -d '{
  "files": {
    "hello.py": null
  }
}'
```

**Response schema (Status: 200):**

Same response schema as [Create a gist](#create-a-gist).

#### Renaming a gist file

**Request:**

```curl
curl -L \
  -X PATCH \
  http(s)://HOSTNAME/api/v3/gists/GIST_ID \
  -d '{
  "files": {
    "hello.py": {
      "filename": "goodbye.py"
    }
  }
}'
```

**Response schema (Status: 200):**

Same response schema as [Create a gist](#create-a-gist).

## Delete a gist

```
DELETE /gists/{gist_id}
```

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`gist_id`** (string) (required)
  The unique identifier of the gist.

### HTTP response status codes

* **204** - No Content

* **304** - Not modified

* **403** - Forbidden

* **404** - Resource not found

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X DELETE \
  http(s)://HOSTNAME/api/v3/gists/GIST_ID
```

**Response schema (Status: 204):**

## List gist commits

```
GET /gists/{gist_id}/commits
```

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`gist_id`** (string) (required)
  The unique identifier of the gist.

* **`per_page`** (integer)
  The number of results per page (max 100). For more information, see "Using pagination in the REST API."
  Default: `30`

* **`page`** (integer)
  The page number of the results to fetch. For more information, see "Using pagination in the REST API."
  Default: `1`

### HTTP response status codes

* **200** - OK

* **304** - Not modified

* **403** - Forbidden

* **404** - Resource not found

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  http(s)://HOSTNAME/api/v3/gists/GIST_ID/commits
```

**Response schema (Status: 200):**

Array of `Gist Commit`:

* `url`: required, string, format: uri
* `version`: required, string
* `user`: required, any of:
  * **null**
  * **Simple User**
    * `name`: string or null
    * `email`: string or null
    * `login`: required, string
    * `id`: required, integer, format: int64
    * `node_id`: required, string
    * `avatar_url`: required, string, format: uri
    * `gravatar_id`: required, string or null
    * `url`: required, string, format: uri
    * `html_url`: required, string, format: uri
    * `followers_url`: required, string, format: uri
    * `following_url`: required, string
    * `gists_url`: required, string
    * `starred_url`: required, string
    * `subscriptions_url`: required, string, format: uri
    * `organizations_url`: required, string, format: uri
    * `repos_url`: required, string, format: uri
    * `events_url`: required, string
    * `received_events_url`: required, string, format: uri
    * `type`: required, string
    * `site_admin`: required, boolean
    * `starred_at`: string
    * `user_view_type`: string
* `change_status`: required, object:
  * `total`: integer
  * `additions`: integer
  * `deletions`: integer
* `committed_at`: required, string, format: date-time

## List gist forks

```
GET /gists/{gist_id}/forks
```

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`gist_id`** (string) (required)
  The unique identifier of the gist.

* **`per_page`** (integer)
  The number of results per page (max 100). For more information, see "Using pagination in the REST API."
  Default: `30`

* **`page`** (integer)
  The page number of the results to fetch. For more information, see "Using pagination in the REST API."
  Default: `1`

### HTTP response status codes

* **200** - OK

* **304** - Not modified

* **403** - Forbidden

* **404** - Resource not found

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  http(s)://HOSTNAME/api/v3/gists/GIST_ID/forks
```

**Response schema (Status: 200):**

Array of `Gist Simple`:

* `forks`: array of objects or null:
  * `id`: string
  * `url`: string, format: uri
  * `user`: `Public User`:
    * `login`: required, string
    * `id`: required, integer, format: int64
    * `user_view_type`: string
    * `node_id`: required, string
    * `avatar_url`: required, string, format: uri
    * `gravatar_id`: required, string or null
    * `url`: required, string, format: uri
    * `html_url`: required, string, format: uri
    * `followers_url`: required, string, format: uri
    * `following_url`: required, string
    * `gists_url`: required, string
    * `starred_url`: required, string
    * `subscriptions_url`: required, string, format: uri
    * `organizations_url`: required, string, format: uri
    * `repos_url`: required, string, format: uri
    * `events_url`: required, string
    * `received_events_url`: required, string, format: uri
    * `type`: required, string
    * `site_admin`: required, boolean
    * `name`: required, string or null
    * `company`: required, string or null
    * `blog`: required, string or null
    * `location`: required, string or null
    * `email`: required, string or null, format: email
    * `notification_email`: string or null, format: email
    * `hireable`: required, boolean or null
    * `bio`: required, string or null
    * `twitter_username`: string or null
    * `public_repos`: required, integer
    * `public_gists`: required, integer
    * `followers`: required, integer
    * `following`: required, integer
    * `created_at`: required, string, format: date-time
    * `updated_at`: required, string, format: date-time
    * `plan`: object:
      * `collaborators`: required, integer
      * `name`: required, string
      * `space`: required, integer
      * `private_repos`: required, integer
    * `private_gists`: integer
    * `total_private_repos`: integer
    * `owned_private_repos`: integer
    * `disk_usage`: integer
    * `collaborators`: integer
  * `created_at`: string, format: date-time
  * `updated_at`: string, format: date-time
* `history`: array of `Gist History` or null:
  * `user`: any of:
    * **null**
    * **Simple User**
      * `name`: string or null
      * `email`: string or null
      * `login`: required, string
      * `id`: required, integer, format: int64
      * `node_id`: required, string
      * `avatar_url`: required, string, format: uri
      * `gravatar_id`: required, string or null
      * `url`: required, string, format: uri
      * `html_url`: required, string, format: uri
      * `followers_url`: required, string, format: uri
      * `following_url`: required, string
      * `gists_url`: required, string
      * `starred_url`: required, string
      * `subscriptions_url`: required, string, format: uri
      * `organizations_url`: required, string, format: uri
      * `repos_url`: required, string, format: uri
      * `events_url`: required, string
      * `received_events_url`: required, string, format: uri
      * `type`: required, string
      * `site_admin`: required, boolean
      * `starred_at`: string
      * `user_view_type`: string
  * `version`: string
  * `committed_at`: string, format: date-time
  * `change_status`: object:
    * `total`: integer
    * `additions`: integer
    * `deletions`: integer
  * `url`: string, format: uri
* `fork_of`: `Gist`:
  * `url`: required, string, format: uri
  * `forks_url`: required, string, format: uri
  * `commits_url`: required, string, format: uri
  * `id`: required, string
  * `node_id`: required, string
  * `git_pull_url`: required, string, format: uri
  * `git_push_url`: required, string, format: uri
  * `html_url`: required, string, format: uri
  * `files`: required, object, additional properties: object
  * `public`: required, boolean
  * `created_at`: required, string, format: date-time
  * `updated_at`: required, string, format: date-time
  * `description`: required, string or null
  * `comments`: required, integer
  * `comments_enabled`: boolean
  * `user`: required, any of:
    * **null**
    * **Simple User** (see above)
  * `comments_url`: required, string, format: uri
  * `owner`: any of:
    * **null**
    * **Simple User** (see above)
  * `truncated`: boolean
  * `forks`: array of object
  * `history`: array of object
* `url`: string
* `forks_url`: string
* `commits_url`: string
* `id`: string
* `node_id`: string
* `git_pull_url`: string
* `git_push_url`: string
* `html_url`: string
* `files`: object, additional properties: object or null
* `public`: boolean
* `created_at`: string
* `updated_at`: string
* `description`: string or null
* `comments`: integer
* `comments_enabled`: boolean
* `user`: string or null
* `comments_url`: string
* `owner`: `Simple User` (see above)
* `truncated`: boolean

## Fork a gist

```
POST /gists/{gist_id}/forks
```

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`gist_id`** (string) (required)
  The unique identifier of the gist.

### HTTP response status codes

* **201** - Created

* **304** - Not modified

* **403** - Forbidden

* **404** - Resource not found

* **422** - Validation failed, or the endpoint has been spammed.

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X POST \
  http(s)://HOSTNAME/api/v3/gists/GIST_ID/forks
```

**Response schema (Status: 201):**

* `url`: required, string, format: uri
* `forks_url`: required, string, format: uri
* `commits_url`: required, string, format: uri
* `id`: required, string
* `node_id`: required, string
* `git_pull_url`: required, string, format: uri
* `git_push_url`: required, string, format: uri
* `html_url`: required, string, format: uri
* `files`: required, object, additional properties: object
* `public`: required, boolean
* `created_at`: required, string, format: date-time
* `updated_at`: required, string, format: date-time
* `description`: required, string or null
* `comments`: required, integer
* `comments_enabled`: boolean
* `user`: required, any of:
  * **null**
  * **Simple User**
    * `name`: string or null
    * `email`: string or null
    * `login`: required, string
    * `id`: required, integer, format: int64
    * `node_id`: required, string
    * `avatar_url`: required, string, format: uri
    * `gravatar_id`: required, string or null
    * `url`: required, string, format: uri
    * `html_url`: required, string, format: uri
    * `followers_url`: required, string, format: uri
    * `following_url`: required, string
    * `gists_url`: required, string
    * `starred_url`: required, string
    * `subscriptions_url`: required, string, format: uri
    * `organizations_url`: required, string, format: uri
    * `repos_url`: required, string, format: uri
    * `events_url`: required, string
    * `received_events_url`: required, string, format: uri
    * `type`: required, string
    * `site_admin`: required, boolean
    * `starred_at`: string
    * `user_view_type`: string
* `comments_url`: required, string, format: uri
* `owner`: `Simple User` (see above)
* `truncated`: boolean
* `forks`: array of object
* `history`: array of object

## Check if a gist is starred

```
GET /gists/{gist_id}/star
```

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`gist_id`** (string) (required)
  The unique identifier of the gist.

### HTTP response status codes

* **204** - Response if gist is starred

* **304** - Not modified

* **403** - Forbidden

* **404** - Not Found if gist is not starred

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  http(s)://HOSTNAME/api/v3/gists/GIST_ID/star
```

**Response schema (Status: 204):**

## Star a gist

```
PUT /gists/{gist_id}/star
```

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

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`gist_id`** (string) (required)
  The unique identifier of the gist.

### HTTP response status codes

* **204** - No Content

* **304** - Not modified

* **403** - Forbidden

* **404** - Resource not found

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X PUT \
  http(s)://HOSTNAME/api/v3/gists/GIST_ID/star
```

**Response schema (Status: 204):**

## Unstar a gist

```
DELETE /gists/{gist_id}/star
```

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`gist_id`** (string) (required)
  The unique identifier of the gist.

### HTTP response status codes

* **204** - No Content

* **304** - Not modified

* **403** - Forbidden

* **404** - Resource not found

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X DELETE \
  http(s)://HOSTNAME/api/v3/gists/GIST_ID/star
```

**Response schema (Status: 204):**

## Get a gist revision

```
GET /gists/{gist_id}/{sha}
```

Gets a specified gist revision.
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.

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`gist_id`** (string) (required)
  The unique identifier of the gist.

* **`sha`** (string) (required)

### HTTP response status codes

* **200** - OK

* **403** - Forbidden

* **404** - Resource not found

* **422** - Validation failed, or the endpoint has been spammed.

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  http(s)://HOSTNAME/api/v3/gists/GIST_ID/SHA
```

**Response schema (Status: 200):**

Same response schema as [Create a gist](#create-a-gist).

## List gists for a user

```
GET /users/{username}/gists
```

Lists public gists for the specified user:

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`username`** (string) (required)
  The handle for the GitHub user account.

* **`since`** (string)
  Only show results that were last 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). For more information, see "Using pagination in the REST API."
  Default: `30`

* **`page`** (integer)
  The page number of the results to fetch. For more information, see "Using pagination in the REST API."
  Default: `1`

### HTTP response status codes

* **200** - OK

* **422** - Validation failed, or the endpoint has been spammed.

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  http(s)://HOSTNAME/api/v3/users/USERNAME/gists
```

**Response schema (Status: 200):**

Same response schema as [List gists for the authenticated user](#list-gists-for-the-authenticated-user).