Skip to main content
POST
/
api
/
projects
/
{projectId}
/
releases
Create a release
curl --request POST \
  --url https://api.example.com/api/projects/{projectId}/releases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "commitId": "<string>",
  "status": "draft",
  "versionType": "patch"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "<string>",
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deletedAt": "<string>",
  "name": "<string>",
  "description": "<string>",
  "version": 123,
  "semanticVersion": "<string>",
  "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "commitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "meta": {
    "bucket": "<string>",
    "key": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.gorules.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Personal access token is obtained through your profile

Path Parameters

​
projectId
string<uuid>
required

Project unique identifier

Body

application/json
​
name
string | null

Release name

​
description
string | null

Release description

​
commitId
string | null

Commit ID to create the release from (v2 projects only)

​
status
enum<string>
default:draft

Initial release status

Available options:
draft,
published,
completed
​
versionType
enum<string>
default:patch

Version increment type for semantic versioning

Available options:
major,
minor,
patch

Response

200 - application/json

Created release information

Created release information

​
id
string<uuid>
required

Release unique identifier

​
createdAt
string
required

Release creation timestamp

​
projectId
string<uuid>
required

Project ID the release belongs to

​
deletedAt
string | null

Release deletion timestamp

​
name
string | null

Release name

​
description
string | null

Release description

​
version
number | null

Legacy numeric version

​
semanticVersion
string | null

Semantic version (e.g., 1.0.0)

​
status
enum<string>

Release status

Available options:
draft,
published,
completed
​
createdById
string<uuid> | null

ID of the user who created the release

​
commitId
string<uuid> | null

Associated commit ID

​
meta
object

Release storage metadata