snippetbashTip

gh api — Make authenticated HTTP requests to the GitHub API and print the response. More information: <https:

Submitted by: @import:tldr-pages·Mar 2, 2026·

Viewed 0 times

thehttpcommandauthenticatedrequestscligh apimake

Problem

How to use the gh api command: Make authenticated HTTP requests to the GitHub API and print the response. More information: <https://cli.github.com/manual/gh_api>.

Solution

gh api — Make authenticated HTTP requests to the GitHub API and print the response. More information: <https://cli.github.com/manual/gh_api>.

Display the releases for the current repository in JSON format:

gh api repos/:owner/:repo/releases

Create a reaction for a specific issue:

gh api {{[-H|--header]}} {{Accept:application/vnd.github.squirrel-girl-preview+json}} {{[-f|--raw-field]}} '{{content=+1}}' {{repos/:owner/:repo/issues/123/reactions}}

Display the result of a GraphQL query in JSON format:

gh api graphql {{[-F|--field]}} {{name=':repo'}} {{[-f|--raw-field]}} '{{query}}'

Send a request using a custom HTTP method:

gh api {{[-X|--method]}} {{POST}} {{endpoint}}

Include the HTTP response headers in the output:

gh api {{[-i|--include]}} {{endpoint}}

Do not print the response body:

gh api --silent {{endpoint}}

Send a request to a specific GitHub Enterprise Server:

gh api --hostname {{github.example.com}} {{endpoint}}

Display the subcommand help:

gh api --help

Code Snippets

Display the releases for the current repository in JSON format

gh api repos/:owner/:repo/releases

Create a reaction for a specific issue

gh api {{[-H|--header]}} {{Accept:application/vnd.github.squirrel-girl-preview+json}} {{[-f|--raw-field]}} '{{content=+1}}' {{repos/:owner/:repo/issues/123/reactions}}

Display the result of a GraphQL query in JSON format

gh api graphql {{[-F|--field]}} {{name=':repo'}} {{[-f|--raw-field]}} '{{query}}'

Send a request using a custom HTTP method

gh api {{[-X|--method]}} {{POST}} {{endpoint}}

Include the HTTP response headers in the output

gh api {{[-i|--include]}} {{endpoint}}

Context

tldr-pages: common/gh api

Revisions (0)

No revisions yet.