Shipreleases
GET/repositories/{repo_id}/releases/{tag_name}
Get a release by its tag
get_release
release:read
A token needs therelease:readscope: View releases and download release assetsGranted bymcp_agent,mcp_agent_write,read_api,read_repository,write_api,write_repository.Every operation this scope unlocks
Returns the release's title, notes, flags, author, assets and source-archive links. Anyone who can read the repository's releases may call it, without signing in on a public repository; a draft is visible only to those who can manage releases, and to anyone else it is not found.
Parameters
Path
- repo_idRepositoryId (string · uuid)Repository ID
- tag_nameTagName (string)Tag name
Responses
200Release foundapplication/json
authorActorSummaryWho created the release.
- The ActorSummary schema
- emailstring
- idstring
- usernamestring
- avatar_urlstring or nulloptional
- commit_shaCommitHash (string)The commit the tag pointed to when the release was created.
- created_atstring
- nameReleaseName (string)
- repository_idRepositoryId (string · uuid)
- tag_nameTagName (string)
- updated_atstring
assetsarray of ReleaseAssetoptionalThe release's files. Included when a single release is fetched.
- The ReleaseAsset schema
- asset_idReleaseAssetId (string · uuid)
- content_typestring
- created_atstring
- nameAssetName (string)
- repository_idRepositoryId (string · uuid)
- sizeinteger · int640–∞
- stateAssetStateuploadingavailableWhether a release file has been uploaded:
uploading(an upload URL was issued, but the upload has not been confirmed yet) oravailable. - tag_nameTagName (string)
- updated_atstring
uploaderActorSummaryWho uploaded the file.
- The ActorSummary schema
- emailstring
- idstring
- usernamestring
- avatar_urlstring or nulloptional
- download_urlstring or nulloptionalWhere to download the file.
- bodyReleaseBody (string) or nulloptional
- draftbooleanoptionalWhether the release is an unpublished draft, visible only to people with Developer access or above.
- prereleasebooleanoptionalWhether the release is marked as a pre-release. A pre-release is never returned as the latest release.
- published_atstring or nulloptionalSet when the release leaves draft.
- tarball_urlstring or nulloptionalWhere to download the tagged source as a
.tar.gzarchive. - versioninteger · int64optional0–∞Increases with every change. Send it with an update so that a change made since you read the release is not overwritten.
- zipball_urlstring or nulloptionalWhere to download the tagged source as a
.ziparchive.
200 exampleSynthesized example
{
"author": {
"email": "tomas@acme.example",
"id": "id-e9cd",
"username": "tomas",
"avatar_url": "https://gitmoap.example/acme/8fbaec69"
},
"commit_sha": "9f8503d8a1f43fe8ba9c463a4f3e7357dcd61dfa",
"created_at": "2026-10-16T19:22:29Z",
"name": "payments-api",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70",
"tag_name": "payments-api",
"updated_at": "2026-10-14T23:11:38Z",
"assets": [
{
"asset_id": "4974f4c1-bcea-4b29-ae5c-8eef736ea45d",
"content_type": "content-type-fdf6",
"created_at": "2026-10-10T21:44:36Z",
"name": "payments-api",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70",
"size": 2,
"state": "uploading",
"tag_name": "payments-api",
"updated_at": "2026-10-10T21:08:00Z",
"uploader": {
"email": "mara@acme.example",
"id": "id-2cbd",
"username": "lin"
}
}
],
"body": "Renders each region as density contours of its operations.",
"draft": false,
"prerelease": false,
"published_at": "2026-10-14T13:33:34Z",
"tarball_url": "https://gitmoap.example/acme/a549fb8b",
"version": 87,
"zipball_url": "https://gitmoap.example/acme/26f53939"
}
400Bad request — a path parameter is not a well-formed value of its typeapplication/json
Error codes
- BAD_REQUESTThe request is malformed: a parameter or a body field is not a well-formed value of its type
errorErrorBody
- The ErrorBody schema
- codestringThe coarse category, tied to the status:
NOT_FOUND,CONFLICT,INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all. - messagestringWhat went wrong, for a person. Written to be read, not parsed: match on
reasonorcode. - fieldstring or nulloptionalOn a
400that refused one field's value, the field, as its JSON path:email,items[0].name. Put the message under that input. Absent on every other error. - reasonstring or nulloptionalThe specific code, when the error has one:
LAST_ORGANIZATION_OWNER,BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and oncodeotherwise. - required_scopestring or nulloptionalThe scope the access token was missing, on
INSUFFICIENT_SCOPE. - violationsanyoptionalPresent on the structured-validation errors (
PROVIDER_VALIDATION_FAILEDper-node,PIPELINE_VALIDATION_FAILEDDAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
400 exampleSynthesized example
{
"error": {
"code": "code-0c63",
"message": "Draw the region map from operation density"
}
}
401Unauthenticated — no credential, or an invalid oneapplication/json
Error codes
- UNAUTHORIZEDNo credential was sent, or the one sent is invalid, expired or revoked
errorErrorBody
- The ErrorBody schema
- codestringThe coarse category, tied to the status:
NOT_FOUND,CONFLICT,INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all. - messagestringWhat went wrong, for a person. Written to be read, not parsed: match on
reasonorcode. - fieldstring or nulloptionalOn a
400that refused one field's value, the field, as its JSON path:email,items[0].name. Put the message under that input. Absent on every other error. - reasonstring or nulloptionalThe specific code, when the error has one:
LAST_ORGANIZATION_OWNER,BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and oncodeotherwise. - required_scopestring or nulloptionalThe scope the access token was missing, on
INSUFFICIENT_SCOPE. - violationsanyoptionalPresent on the structured-validation errors (
PROVIDER_VALIDATION_FAILEDper-node,PIPELINE_VALIDATION_FAILEDDAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
401 exampleSynthesized example
{
"error": {
"code": "code-8a33",
"message": "Stream pipeline status into the run header"
}
}
403Forbidden — the caller's access level or token scope is insufficientapplication/json
Error codes
- FORBIDDENYou are signed in but may not do this here;
reasonnames the permission or the rule that refused it - INSUFFICIENT_SCOPEThe access token lacks the scope this operation needs;
required_scopenames it - PERMISSION_REQUIREDYou need a permission you do not hold here; the message names it
errorErrorBody
- The ErrorBody schema
- codestringThe coarse category, tied to the status:
NOT_FOUND,CONFLICT,INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all. - messagestringWhat went wrong, for a person. Written to be read, not parsed: match on
reasonorcode. - fieldstring or nulloptionalOn a
400that refused one field's value, the field, as its JSON path:email,items[0].name. Put the message under that input. Absent on every other error. - reasonstring or nulloptionalThe specific code, when the error has one:
LAST_ORGANIZATION_OWNER,BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and oncodeotherwise. - required_scopestring or nulloptionalThe scope the access token was missing, on
INSUFFICIENT_SCOPE. - violationsanyoptionalPresent on the structured-validation errors (
PROVIDER_VALIDATION_FAILEDper-node,PIPELINE_VALIDATION_FAILEDDAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
403 exampleSynthesized example
{
"error": {
"code": "code-2bbf",
"message": "Draw the region map from operation density"
}
}
404Release not foundapplication/json
Error codes
- NOT_FOUNDThe resource does not exist — or exists and you cannot see it: a private resource you have no access to answers exactly as an absent one does
errorErrorBody
- The ErrorBody schema
- codestringThe coarse category, tied to the status:
NOT_FOUND,CONFLICT,INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all. - messagestringWhat went wrong, for a person. Written to be read, not parsed: match on
reasonorcode. - fieldstring or nulloptionalOn a
400that refused one field's value, the field, as its JSON path:email,items[0].name. Put the message under that input. Absent on every other error. - reasonstring or nulloptionalThe specific code, when the error has one:
LAST_ORGANIZATION_OWNER,BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and oncodeotherwise. - required_scopestring or nulloptionalThe scope the access token was missing, on
INSUFFICIENT_SCOPE. - violationsanyoptionalPresent on the structured-validation errors (
PROVIDER_VALIDATION_FAILEDper-node,PIPELINE_VALIDATION_FAILEDDAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
404 exampleSynthesized example
{
"error": {
"code": "code-1ec1",
"message": "Pin a page's payload to the build that rendered it"
}
}
CLI
gitmoap releases get
- --repo-ididRepository ID (id or owner/repo path)
- --tag-nameidTag name