Skip to main content
Manja / GitHub

Get a release

**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#hypermedia).

GET/repos/{owner}/{repo}/releases/{release_id}
Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Request

Path Parameters
owner string
required
repo string
required
release_id integer
required

release_id parameter

Responses

application/json Release object

**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#hypermedia).

assets array[Release Asset object]
required
items Release Asset object

Data related to a release.

browser_download_url string<uri>
required
content_type string
required
created_at string<date-time>
required
download_count integer
required
id integer
required
label string
requirednullable
name string
required

The file name of the asset.

Example: Team Environment

node_id string
required
size integer
required
state string
required

State of the release asset.

Allowed: "uploaded""open"

updated_at string<date-time>
required
uploader Simple User object
requirednullable

Simple User

avatar_url string<uri>
required

Example: https://github.com/images/error/octocat_happy.gif

email string
optionalnullable
events_url string
required

Example: https://api.github.com/users/octocat/events{/privacy}

followers_url string<uri>
required

Example: https://api.github.com/users/octocat/followers

following_url string
required

Example: https://api.github.com/users/octocat/following{/other_user}

gists_url string
required

Example: https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id string
requirednullable

Example: 41d064eb2195891e12d0413f63227ea7

html_url string<uri>
required

Example: https://github.com/octocat

id integer
required

Example: 1

login string
required

Example: octocat

name string
optionalnullable
node_id string
required

Example: MDQ6VXNlcjE=

organizations_url string<uri>
required

Example: https://api.github.com/users/octocat/orgs

received_events_url string<uri>
required

Example: https://api.github.com/users/octocat/received_events

repos_url string<uri>
required

Example: https://api.github.com/users/octocat/repos

site_admin boolean
required
starred_at string
optional

Example: "2020-07-09T00:17:55Z"

starred_url string
required

Example: https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url string<uri>
required

Example: https://api.github.com/users/octocat/subscriptions

type string
required

Example: User

url string<uri>
required

Example: https://api.github.com/users/octocat

url string<uri>
required
assets_url string<uri>
required
author Simple User object
required

Simple User

avatar_url string<uri>
required

Example: https://github.com/images/error/octocat_happy.gif

email string
optionalnullable
events_url string
required

Example: https://api.github.com/users/octocat/events{/privacy}

followers_url string<uri>
required

Example: https://api.github.com/users/octocat/followers

following_url string
required

Example: https://api.github.com/users/octocat/following{/other_user}

gists_url string
required

Example: https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id string
requirednullable

Example: 41d064eb2195891e12d0413f63227ea7

html_url string<uri>
required

Example: https://github.com/octocat

id integer
required

Example: 1

login string
required

Example: octocat

name string
optionalnullable
node_id string
required

Example: MDQ6VXNlcjE=

organizations_url string<uri>
required

Example: https://api.github.com/users/octocat/orgs

received_events_url string<uri>
required

Example: https://api.github.com/users/octocat/received_events

repos_url string<uri>
required

Example: https://api.github.com/users/octocat/repos

site_admin boolean
required
starred_at string
optional

Example: "2020-07-09T00:17:55Z"

starred_url string
required

Example: https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url string<uri>
required

Example: https://api.github.com/users/octocat/subscriptions

type string
required

Example: User

url string<uri>
required

Example: https://api.github.com/users/octocat

body string
optionalnullable
body_html string
optional
body_text string
optional
created_at string<date-time>
required
draft boolean
required

true to create a draft (unpublished) release, false to create a published one.

Example: false

html_url string<uri>
required
id integer
required
name string
requirednullable
node_id string
required
prerelease boolean
required

Whether to identify the release as a prerelease or a full release.

Example: false

published_at string<date-time>
requirednullable
reactions Reaction Rollup object
optional
+1 integer
required
-1 integer
required
confused integer
required
eyes integer
required
heart integer
required
hooray integer
required
laugh integer
required
rocket integer
required
total_count integer
required
url string<uri>
required
tag_name string
required

The name of the tag.

Example: v1.0.0

tarball_url string<uri>
requirednullable
target_commitish string
required

Specifies the commitish value that determines where the Git tag is created from.

Example: master

upload_url string
required
url string<uri>
required
zipball_url string<uri>
requirednullable
application/json Basic Error object

Resource not found

documentation_url string
optional
message string
optional
status string
optional
url string
optional