TrylleDocs
API ReferenceOpenAPI 3 reference

Releases

listRepoReleases

GET
/v1/repositories/{owner}/{name}/releases

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name from the {name} path segment.

Length1 <= length

Query Parameters

page?integer

One-indexed page. Handler clamps values below 1 to 1.

Formatint64
Range1 <= value
Default1
per_page?integer

Items per page. Handler defaults to 30 and clamps above 100.

Formatint64
Range1 <= value <= 100
Default30
cursor?string

Base64 cursor encoding page and per_page; overrides page/per_page when valid.

query?string

Forwarded to Forgejo release list filtering when supported.

Response Body

application/json

curl -X GET "https://example.com/v1/repositories/aa/aa/releases?page=2&per_page=2&cursor=abc123&query=abc123"
"abc123"

createRepoRelease

POST
/v1/repositories/{owner}/{name}/releases

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name from the {name} path segment.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/repositories/aa/aa/releases" \  -H "Content-Type: application/json" \  -d '{    "hideArchiveLinks": false,    "isDraft": false,    "isPrerelease": false,    "notes": "abc123",    "tagName": "aa",    "target": "abc123",    "title": "aa"  }'
"abc123"

getRepoRelease

GET
/v1/repositories/{owner}/{name}/releases/tags/{tag}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name from the {name} path segment.

Length1 <= length
tag*string

Release Git tag.

Length1 <= length

Response Body

application/json

curl -X GET "https://example.com/v1/repositories/aa/aa/releases/tags/aa"
"abc123"

updateRepoRelease

PATCH
/v1/repositories/{owner}/{name}/releases/tags/{tag}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name from the {name} path segment.

Length1 <= length
tag*string

Release Git tag.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://example.com/v1/repositories/aa/aa/releases/tags/aa" \  -H "Content-Type: application/json" \  -d '{    "hideArchiveLinks": false,    "isDraft": false,    "isPrerelease": false,    "notes": "abc123",    "tagName": "abc123",    "target": "abc123",    "title": "aa"  }'
"abc123"

deleteRepoRelease

DELETE
/v1/repositories/{owner}/{name}/releases/tags/{tag}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

owner*string

Repository owner namespace.

Length1 <= length
name*string

Repository name from the {name} path segment.

Length1 <= length
tag*string

Release Git tag.

Length1 <= length

Response Body

application/json

curl -X DELETE "https://example.com/v1/repositories/aa/aa/releases/tags/aa"
"abc123"

Webhooks

Previous Page

Issues

Next Page