gh api

all

Make authenticated HTTP requests to the GitHub API and print the response.

More info →

Options (5)

-H, --headerboolean

Create a reaction for a specific issue

Example:

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

-f, --raw-fieldboolean

Create a reaction for a specific issue

Example:

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

-F, --fieldboolean

Display the result of a GraphQL query in JSON format

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

-X, --methodboolean

Send a request using a custom HTTP method

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

-i, --includeboolean

Include the HTTP response headers in the output

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

Examples (8)

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

made by @shridhargupta | data from tldr-pages