The REST API is now versioned.For more information, see "About API versioning."

REST API endpoints for releases

Use the REST API to create, modify, and delete releases.

Note

These endpoints replace the endpoints to manage downloads. You can retrieve the download count and browser download URL from these endpoints.

List releases

This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use theRepository Tags API.

Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.

Fine-grained access tokens for "List releases"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Contents" repository permissions (read)

This endpoint can be used without authentication or the aforementioned permissions if only public resources are requested.

Parameters for "List releases"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository without the`.git` extension. The name is not case sensitive.

Query parameters
Name, Type, Description
`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 for "List releases"

Status code	Description
`200`	OK
`404`	Resource not found

Code samples for "List releases"

Request example

get/repos/{owner}/{repo}/releases

curl -L \  -H "Accept: application/vnd.github+json" \  -H "Authorization: Bearer <YOUR-TOKEN>" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/repos/OWNER/REPO/releases

Response

Status: 200

[  {    "url": "https://api.github.com/repos/octocat/Hello-World/releases/1",    "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0",    "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets",    "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}",    "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0",    "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0",    "id": 1,    "node_id": "MDc6UmVsZWFzZTE=",    "tag_name": "v1.0.0",    "target_commitish": "master",    "name": "v1.0.0",    "body": "Description of the release",    "draft": false,    "prerelease": false,    "immutable": false,    "created_at": "2013-02-27T19:35:32Z",    "published_at": "2013-02-27T19:35:32Z",    "author": {      "login": "octocat",      "id": 1,      "node_id": "MDQ6VXNlcjE=",      "avatar_url": "https://github.com/images/error/octocat_happy.gif",      "gravatar_id": "",      "url": "https://api.github.com/users/octocat",      "html_url": "https://github.com/octocat",      "followers_url": "https://api.github.com/users/octocat/followers",      "following_url": "https://api.github.com/users/octocat/following{/other_user}",      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",      "organizations_url": "https://api.github.com/users/octocat/orgs",      "repos_url": "https://api.github.com/users/octocat/repos",      "events_url": "https://api.github.com/users/octocat/events{/privacy}",      "received_events_url": "https://api.github.com/users/octocat/received_events",      "type": "User",      "site_admin": false    },    "assets": [      {        "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1",        "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",        "id": 1,        "node_id": "MDEyOlJlbGVhc2VBc3NldDE=",        "name": "example.zip",        "label": "short description",        "state": "uploaded",        "content_type": "application/zip",        "size": 1024,        "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255",        "download_count": 42,        "created_at": "2013-02-27T19:35:32Z",        "updated_at": "2013-02-27T19:35:32Z",        "uploader": {          "login": "octocat",          "id": 1,          "node_id": "MDQ6VXNlcjE=",          "avatar_url": "https://github.com/images/error/octocat_happy.gif",          "gravatar_id": "",          "url": "https://api.github.com/users/octocat",          "html_url": "https://github.com/octocat",          "followers_url": "https://api.github.com/users/octocat/followers",          "following_url": "https://api.github.com/users/octocat/following{/other_user}",          "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",          "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",          "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",          "organizations_url": "https://api.github.com/users/octocat/orgs",          "repos_url": "https://api.github.com/users/octocat/repos",          "events_url": "https://api.github.com/users/octocat/events{/privacy}",          "received_events_url": "https://api.github.com/users/octocat/received_events",          "type": "User",          "site_admin": false        }      }    ]  }]

Create a release

Users with push access to the repository can create a release.

This endpoint triggersnotifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."

Fine-grained access tokens for "Create a release"

This endpoint works with the following fine-grained token types:

The fine-grained token must have at least one of the following permission sets:

"Contents" repository permissions (write)
"Contents" repository permissions (write) and"Workflows" repository permissions (write)

Parameters for "Create a release"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository without the`.git` extension. The name is not case sensitive.

Body parameters
Name, Type, Description
`tag_name`stringRequired The name of the tag.
`target_commitish`string Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
`name`string The name of the release.
`body`string Text describing the contents of the tag.
`draft`boolean `true` to create a draft (unpublished) release,`false` to create a published one. Default:`false`
`prerelease`boolean `true` to identify the release as a prerelease.`false` to identify the release as a full release. Default:`false`
`discussion_category_name`string If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "Managing categories for discussions in your repository."
`generate_release_notes`boolean Whether to automatically generate the name and body for this release. If`name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If`body` is specified, the body will be pre-pended to the automatically generated notes. Default:`false`
`make_latest`string Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to`true` for newly published releases.`legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version. Default:`true` Can be one of:`true`,`false`,`legacy`

HTTP response status codes for "Create a release"

Status code	Description
`201`	Created
`404`	Not Found if the discussion category name is invalid
`422`	Validation failed, or the endpoint has been spammed.

Code samples for "Create a release"

Request example

post/repos/{owner}/{repo}/releases

curl -L \  -X POST \  -H "Accept: application/vnd.github+json" \  -H "Authorization: Bearer <YOUR-TOKEN>" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/repos/OWNER/REPO/releases \  -d '{"tag_name":"v1.0.0","target_commitish":"master","name":"v1.0.0","body":"Description of the release","draft":false,"prerelease":false,"generate_release_notes":false}'

Response

Status: 201

{  "url": "https://api.github.com/repos/octocat/Hello-World/releases/1",  "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0",  "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets",  "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}",  "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0",  "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0",  "discussion_url": "https://github.com/octocat/Hello-World/discussions/90",  "id": 1,  "node_id": "MDc6UmVsZWFzZTE=",  "tag_name": "v1.0.0",  "target_commitish": "master",  "name": "v1.0.0",  "body": "Description of the release",  "draft": false,  "prerelease": false,  "immutable": false,  "created_at": "2013-02-27T19:35:32Z",  "published_at": "2013-02-27T19:35:32Z",  "author": {    "login": "octocat",    "id": 1,    "node_id": "MDQ6VXNlcjE=",    "avatar_url": "https://github.com/images/error/octocat_happy.gif",    "gravatar_id": "",    "url": "https://api.github.com/users/octocat",    "html_url": "https://github.com/octocat",    "followers_url": "https://api.github.com/users/octocat/followers",    "following_url": "https://api.github.com/users/octocat/following{/other_user}",    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",    "organizations_url": "https://api.github.com/users/octocat/orgs",    "repos_url": "https://api.github.com/users/octocat/repos",    "events_url": "https://api.github.com/users/octocat/events{/privacy}",    "received_events_url": "https://api.github.com/users/octocat/received_events",    "type": "User",    "site_admin": false  },  "assets": [    {      "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1",      "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",      "id": 1,      "node_id": "MDEyOlJlbGVhc2VBc3NldDE=",      "name": "example.zip",      "label": "short description",      "state": "uploaded",      "content_type": "application/zip",      "size": 1024,      "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255",      "download_count": 42,      "created_at": "2013-02-27T19:35:32Z",      "updated_at": "2013-02-27T19:35:32Z",      "uploader": {        "login": "octocat",        "id": 1,        "node_id": "MDQ6VXNlcjE=",        "avatar_url": "https://github.com/images/error/octocat_happy.gif",        "gravatar_id": "",        "url": "https://api.github.com/users/octocat",        "html_url": "https://github.com/octocat",        "followers_url": "https://api.github.com/users/octocat/followers",        "following_url": "https://api.github.com/users/octocat/following{/other_user}",        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",        "organizations_url": "https://api.github.com/users/octocat/orgs",        "repos_url": "https://api.github.com/users/octocat/repos",        "events_url": "https://api.github.com/users/octocat/events{/privacy}",        "received_events_url": "https://api.github.com/users/octocat/received_events",        "type": "User",        "site_admin": false      }    }  ]}

Generate release notes content for a release

Generate a name and body describing arelease. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.

Fine-grained access tokens for "Generate release notes content for a release"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Contents" repository permissions (write)

Parameters for "Generate release notes content for a release"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository without the`.git` extension. The name is not case sensitive.

Body parameters
Name, Type, Description
`tag_name`stringRequired The tag name for the release. This can be an existing tag or a new one.
`target_commitish`string Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.
`previous_tag_name`string The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.
`configuration_file_path`string Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.

HTTP response status codes for "Generate release notes content for a release"

Status code	Description
`200`	Name and body of generated release notes
`404`	Resource not found

Code samples for "Generate release notes content for a release"

Request example

post/repos/{owner}/{repo}/releases/generate-notes

curl -L \  -X POST \  -H "Accept: application/vnd.github+json" \  -H "Authorization: Bearer <YOUR-TOKEN>" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/repos/OWNER/REPO/releases/generate-notes \  -d '{"tag_name":"v1.0.0","target_commitish":"main","previous_tag_name":"v0.9.2","configuration_file_path":".github/custom_release_config.yml"}'

Name and body of generated release notes

Status: 200

{ "name": "Release v1.0.0 is now available!", "body": "##Changes in Release v1.0.0 ... ##Contributors @monalisa"}

Get the latest release

View the latest published full release for the repository.

The latest release is the most recent non-prerelease, non-draft release, sorted by thecreated_at attribute. Thecreated_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.

Fine-grained access tokens for "Get the latest release"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Contents" repository permissions (read)

This endpoint can be used without authentication or the aforementioned permissions if only public resources are requested.

Parameters for "Get the latest release"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository without the`.git` extension. The name is not case sensitive.

HTTP response status codes for "Get the latest release"

Status code	Description
`200`	OK

Code samples for "Get the latest release"

Request example

get/repos/{owner}/{repo}/releases/latest

curl -L \  -H "Accept: application/vnd.github+json" \  -H "Authorization: Bearer <YOUR-TOKEN>" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/repos/OWNER/REPO/releases/latest

Response

Status: 200

{  "url": "https://api.github.com/repos/octocat/Hello-World/releases/1",  "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0",  "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets",  "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}",  "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0",  "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0",  "discussion_url": "https://github.com/octocat/Hello-World/discussions/90",  "id": 1,  "node_id": "MDc6UmVsZWFzZTE=",  "tag_name": "v1.0.0",  "target_commitish": "master",  "name": "v1.0.0",  "body": "Description of the release",  "draft": false,  "prerelease": false,  "immutable": false,  "created_at": "2013-02-27T19:35:32Z",  "published_at": "2013-02-27T19:35:32Z",  "author": {    "login": "octocat",    "id": 1,    "node_id": "MDQ6VXNlcjE=",    "avatar_url": "https://github.com/images/error/octocat_happy.gif",    "gravatar_id": "",    "url": "https://api.github.com/users/octocat",    "html_url": "https://github.com/octocat",    "followers_url": "https://api.github.com/users/octocat/followers",    "following_url": "https://api.github.com/users/octocat/following{/other_user}",    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",    "organizations_url": "https://api.github.com/users/octocat/orgs",    "repos_url": "https://api.github.com/users/octocat/repos",    "events_url": "https://api.github.com/users/octocat/events{/privacy}",    "received_events_url": "https://api.github.com/users/octocat/received_events",    "type": "User",    "site_admin": false  },  "assets": [    {      "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1",      "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",      "id": 1,      "node_id": "MDEyOlJlbGVhc2VBc3NldDE=",      "name": "example.zip",      "label": "short description",      "state": "uploaded",      "content_type": "application/zip",      "size": 1024,      "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255",      "download_count": 42,      "created_at": "2013-02-27T19:35:32Z",      "updated_at": "2013-02-27T19:35:32Z",      "uploader": {        "login": "octocat",        "id": 1,        "node_id": "MDQ6VXNlcjE=",        "avatar_url": "https://github.com/images/error/octocat_happy.gif",        "gravatar_id": "",        "url": "https://api.github.com/users/octocat",        "html_url": "https://github.com/octocat",        "followers_url": "https://api.github.com/users/octocat/followers",        "following_url": "https://api.github.com/users/octocat/following{/other_user}",        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",        "organizations_url": "https://api.github.com/users/octocat/orgs",        "repos_url": "https://api.github.com/users/octocat/repos",        "events_url": "https://api.github.com/users/octocat/events{/privacy}",        "received_events_url": "https://api.github.com/users/octocat/received_events",        "type": "User",        "site_admin": false      }    }  ]}

Get a release by tag name

Get a published release with the specified tag.

Fine-grained access tokens for "Get a release by tag name"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Contents" repository permissions (read)

This endpoint can be used without authentication or the aforementioned permissions if only public resources are requested.

Parameters for "Get a release by tag name"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository without the`.git` extension. The name is not case sensitive.
`tag`stringRequired tag parameter

HTTP response status codes for "Get a release by tag name"

Status code	Description
`200`	OK
`404`	Resource not found

Code samples for "Get a release by tag name"

Request example

get/repos/{owner}/{repo}/releases/tags/{tag}

curl -L \  -H "Accept: application/vnd.github+json" \  -H "Authorization: Bearer <YOUR-TOKEN>" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/repos/OWNER/REPO/releases/tags/TAG

Response

Status: 200

{  "url": "https://api.github.com/repos/octocat/Hello-World/releases/1",  "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0",  "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets",  "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}",  "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0",  "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0",  "discussion_url": "https://github.com/octocat/Hello-World/discussions/90",  "id": 1,  "node_id": "MDc6UmVsZWFzZTE=",  "tag_name": "v1.0.0",  "target_commitish": "master",  "name": "v1.0.0",  "body": "Description of the release",  "draft": false,  "prerelease": false,  "immutable": false,  "created_at": "2013-02-27T19:35:32Z",  "published_at": "2013-02-27T19:35:32Z",  "author": {    "login": "octocat",    "id": 1,    "node_id": "MDQ6VXNlcjE=",    "avatar_url": "https://github.com/images/error/octocat_happy.gif",    "gravatar_id": "",    "url": "https://api.github.com/users/octocat",    "html_url": "https://github.com/octocat",    "followers_url": "https://api.github.com/users/octocat/followers",    "following_url": "https://api.github.com/users/octocat/following{/other_user}",    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",    "organizations_url": "https://api.github.com/users/octocat/orgs",    "repos_url": "https://api.github.com/users/octocat/repos",    "events_url": "https://api.github.com/users/octocat/events{/privacy}",    "received_events_url": "https://api.github.com/users/octocat/received_events",    "type": "User",    "site_admin": false  },  "assets": [    {      "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1",      "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",      "id": 1,      "node_id": "MDEyOlJlbGVhc2VBc3NldDE=",      "name": "example.zip",      "label": "short description",      "state": "uploaded",      "content_type": "application/zip",      "size": 1024,      "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255",      "download_count": 42,      "created_at": "2013-02-27T19:35:32Z",      "updated_at": "2013-02-27T19:35:32Z",      "uploader": {        "login": "octocat",        "id": 1,        "node_id": "MDQ6VXNlcjE=",        "avatar_url": "https://github.com/images/error/octocat_happy.gif",        "gravatar_id": "",        "url": "https://api.github.com/users/octocat",        "html_url": "https://github.com/octocat",        "followers_url": "https://api.github.com/users/octocat/followers",        "following_url": "https://api.github.com/users/octocat/following{/other_user}",        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",        "organizations_url": "https://api.github.com/users/octocat/orgs",        "repos_url": "https://api.github.com/users/octocat/repos",        "events_url": "https://api.github.com/users/octocat/events{/privacy}",        "received_events_url": "https://api.github.com/users/octocat/received_events",        "type": "User",        "site_admin": false      }    }  ]}

Get a release

Gets a public release with the specified release ID.

Note

This returns anupload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "Getting started with the REST API."

Fine-grained access tokens for "Get a release"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Contents" repository permissions (read)

This endpoint can be used without authentication or the aforementioned permissions if only public resources are requested.

Parameters for "Get a release"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository without the`.git` extension. The name is not case sensitive.
`release_id`integerRequired The unique identifier of the release.

HTTP response status codes for "Get a release"

Status code	Description
`200`	Note: This returns an`upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "Getting started with the REST API."
`401`	Unauthorized

Code samples for "Get a release"

Request example

get/repos/{owner}/{repo}/releases/{release_id}

curl -L \  -H "Accept: application/vnd.github+json" \  -H "Authorization: Bearer <YOUR-TOKEN>" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/repos/OWNER/REPO/releases/RELEASE_ID

Note: This returns an`upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "Getting started with the REST API."

Status: 200

{  "url": "https://api.github.com/repos/octocat/Hello-World/releases/1",  "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0",  "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets",  "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}",  "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0",  "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0",  "discussion_url": "https://github.com/octocat/Hello-World/discussions/90",  "id": 1,  "node_id": "MDc6UmVsZWFzZTE=",  "tag_name": "v1.0.0",  "target_commitish": "master",  "name": "v1.0.0",  "body": "Description of the release",  "draft": false,  "prerelease": false,  "immutable": false,  "created_at": "2013-02-27T19:35:32Z",  "published_at": "2013-02-27T19:35:32Z",  "author": {    "login": "octocat",    "id": 1,    "node_id": "MDQ6VXNlcjE=",    "avatar_url": "https://github.com/images/error/octocat_happy.gif",    "gravatar_id": "",    "url": "https://api.github.com/users/octocat",    "html_url": "https://github.com/octocat",    "followers_url": "https://api.github.com/users/octocat/followers",    "following_url": "https://api.github.com/users/octocat/following{/other_user}",    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",    "organizations_url": "https://api.github.com/users/octocat/orgs",    "repos_url": "https://api.github.com/users/octocat/repos",    "events_url": "https://api.github.com/users/octocat/events{/privacy}",    "received_events_url": "https://api.github.com/users/octocat/received_events",    "type": "User",    "site_admin": false  },  "assets": [    {      "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1",      "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",      "id": 1,      "node_id": "MDEyOlJlbGVhc2VBc3NldDE=",      "name": "example.zip",      "label": "short description",      "state": "uploaded",      "content_type": "application/zip",      "size": 1024,      "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255",      "download_count": 42,      "created_at": "2013-02-27T19:35:32Z",      "updated_at": "2013-02-27T19:35:32Z",      "uploader": {        "login": "octocat",        "id": 1,        "node_id": "MDQ6VXNlcjE=",        "avatar_url": "https://github.com/images/error/octocat_happy.gif",        "gravatar_id": "",        "url": "https://api.github.com/users/octocat",        "html_url": "https://github.com/octocat",        "followers_url": "https://api.github.com/users/octocat/followers",        "following_url": "https://api.github.com/users/octocat/following{/other_user}",        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",        "organizations_url": "https://api.github.com/users/octocat/orgs",        "repos_url": "https://api.github.com/users/octocat/repos",        "events_url": "https://api.github.com/users/octocat/events{/privacy}",        "received_events_url": "https://api.github.com/users/octocat/received_events",        "type": "User",        "site_admin": false      }    }  ]}

Update a release

Users with push access to the repository can edit a release.

Fine-grained access tokens for "Update a release"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Contents" repository permissions (write)

Parameters for "Update a release"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository without the`.git` extension. The name is not case sensitive.
`release_id`integerRequired The unique identifier of the release.

Body parameters
Name, Type, Description
`tag_name`string The name of the tag.
`target_commitish`string Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
`name`string The name of the release.
`body`string Text describing the contents of the tag.
`draft`boolean `true` makes the release a draft, and`false` publishes the release.
`prerelease`boolean `true` to identify the release as a prerelease,`false` to identify the release as a full release.
`make_latest`string Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to`true` for newly published releases.`legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version. Default:`true` Can be one of:`true`,`false`,`legacy`
`discussion_category_name`string If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see "Managing categories for discussions in your repository."

HTTP response status codes for "Update a release"

Status code	Description
`200`	OK
`404`	Not Found if the discussion category name is invalid

Code samples for "Update a release"

Request example

patch/repos/{owner}/{repo}/releases/{release_id}

curl -L \  -X PATCH \  -H "Accept: application/vnd.github+json" \  -H "Authorization: Bearer <YOUR-TOKEN>" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/repos/OWNER/REPO/releases/RELEASE_ID \  -d '{"tag_name":"v1.0.0","target_commitish":"master","name":"v1.0.0","body":"Description of the release","draft":false,"prerelease":false}'

Response

Status: 200

{  "url": "https://api.github.com/repos/octocat/Hello-World/releases/1",  "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0",  "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets",  "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}",  "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0",  "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0",  "discussion_url": "https://github.com/octocat/Hello-World/discussions/90",  "id": 1,  "node_id": "MDc6UmVsZWFzZTE=",  "tag_name": "v1.0.0",  "target_commitish": "master",  "name": "v1.0.0",  "body": "Description of the release",  "draft": false,  "prerelease": false,  "immutable": false,  "created_at": "2013-02-27T19:35:32Z",  "published_at": "2013-02-27T19:35:32Z",  "author": {    "login": "octocat",    "id": 1,    "node_id": "MDQ6VXNlcjE=",    "avatar_url": "https://github.com/images/error/octocat_happy.gif",    "gravatar_id": "",    "url": "https://api.github.com/users/octocat",    "html_url": "https://github.com/octocat",    "followers_url": "https://api.github.com/users/octocat/followers",    "following_url": "https://api.github.com/users/octocat/following{/other_user}",    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",    "organizations_url": "https://api.github.com/users/octocat/orgs",    "repos_url": "https://api.github.com/users/octocat/repos",    "events_url": "https://api.github.com/users/octocat/events{/privacy}",    "received_events_url": "https://api.github.com/users/octocat/received_events",    "type": "User",    "site_admin": false  },  "assets": [    {      "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1",      "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",      "id": 1,      "node_id": "MDEyOlJlbGVhc2VBc3NldDE=",      "name": "example.zip",      "label": "short description",      "state": "uploaded",      "content_type": "application/zip",      "size": 1024,      "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255",      "download_count": 42,      "created_at": "2013-02-27T19:35:32Z",      "updated_at": "2013-02-27T19:35:32Z",      "uploader": {        "login": "octocat",        "id": 1,        "node_id": "MDQ6VXNlcjE=",        "avatar_url": "https://github.com/images/error/octocat_happy.gif",        "gravatar_id": "",        "url": "https://api.github.com/users/octocat",        "html_url": "https://github.com/octocat",        "followers_url": "https://api.github.com/users/octocat/followers",        "following_url": "https://api.github.com/users/octocat/following{/other_user}",        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",        "organizations_url": "https://api.github.com/users/octocat/orgs",        "repos_url": "https://api.github.com/users/octocat/repos",        "events_url": "https://api.github.com/users/octocat/events{/privacy}",        "received_events_url": "https://api.github.com/users/octocat/received_events",        "type": "User",        "site_admin": false      }    }  ]}

Delete a release

Users with push access to the repository can delete a release.

Fine-grained access tokens for "Delete a release"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Contents" repository permissions (write)

Parameters for "Delete a release"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository without the`.git` extension. The name is not case sensitive.
`release_id`integerRequired The unique identifier of the release.

HTTP response status codes for "Delete a release"

Status code	Description
`204`	No Content

Code samples for "Delete a release"

Request example

delete/repos/{owner}/{repo}/releases/{release_id}

curl -L \  -X DELETE \  -H "Accept: application/vnd.github+json" \  -H "Authorization: Bearer <YOUR-TOKEN>" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/repos/OWNER/REPO/releases/RELEASE_ID

Response

Status: 204

Movatterモバイル変換

REST API endpoints for releases

Request example

Response

Request example

Response

Request example

Name and body of generated release notes

Request example

Response

Request example

Response

Request example

Note: This returns anupload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "Getting started with the REST API."

Request example

Response

Request example

Response

Note: This returns an`upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "Getting started with the REST API."