Sample - GitHub REST API
GET/repos/{owner}/{repo}/releases/tags/{tag}

Get a release by tag name

Retrieves a published release associated with a specific tag in a repository. Supply tag together with the repository owner and name to identify the release. Use the returned release metadata to access its assets, URLs, publication state, and target commit.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 parameters
ownerstringrequired
The account owner of the repository; the name is not case sensitive.
repostringrequired
The repository name without the `.git` extension; the name is not case sensitive.
tagstringrequired
The name of the tag associated with the release.

2 status codes
200Returns the release object, including its tag name, target commit, publication state, release name, URLs, identifiers, and release metadata.
urlstringrequired
html_urlstringrequired
assets_urlstringrequired
upload_urlstringrequired
tarball_urlstringrequired
zipball_urlstringrequired
idintegerrequired
node_idstringrequired
tag_namestringrequired
The name of the tag.
target_commitishstringrequired
Specifies the commitish value that determines where the Git tag is created from.
namestringrequired
bodystringoptional
draftbooleanrequired
true to create a draft (unpublished) release, false to create a published one.
prereleasebooleanrequired
Whether to identify the release as a prerelease or a full release.
immutablebooleanoptional
Whether or not the release is immutable.
created_atstringrequired
published_atstringrequired
updated_atstringoptional
authorobjectrequired
A GitHub user.
assetsarray<ReleaseAsset>required
body_htmlstringoptional
body_textstringoptional
mentions_countintegeroptional
discussion_urlstringoptional
The URL of the release discussion.
reactionsobjectoptional
404Returned when no release exists for the specified repository and tag.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 404 is returned when no published release exists for the specified owner, repo, and tag. repo must omit the .git extension, and tag must identify the release tag to retrieve.