Check release

See whether a release is ready to publish, and if not, the problems to fix in order: pull requests without a change, no headline, nothing for customers.

GET/v1/w/{workspace}/releases/check

Path parameters

workspacestringrequired

Your workspace’s address name.

Query parameters

changelogIdstring

The changelog, like cl_…; or give product instead.

productstring

The product’s key, like APP; each product has one changelog.

versionstring

A shipped version, like 2026.12.01.1.

openboolean

true for the open release, which collects new changes. With none of these, the newest shipped release.

idstring

The release, like cr_abc123.

Response

releaseobjectrequired

readybooleanrequired

problemsstring[]required

Details

Check a release is ready to publish: every pull request it shipped has a change or a reason it needs none, it has a headline, and customers have something to read. Lists what to fix, in order.

Since 2026-12. Errors are listed in Errors.

cURL

curl -G "https://api.olamma.sh/v1/w/your-workspace/releases/check" \
  -H "Authorization: Bearer $OLAMMA_KEY" \
  --data-urlencode 'product=APP'

Response 200

{
  "release": {
    "id": "<string>",
    "changelog": {
      "id": "<string>",
      "name": "<string>",
      "product": "<string>"
    },
    "version": "<string>",
    "headline": "<string>",
    "status": "<string>",
    "deployedAt": "2026-12-01T09:30:00Z",
    "publishedAt": "2026-12-01T09:30:00Z",
    "url": "<string>"
  },
  "ready": true,
  "problems": [
    "<string>"
  ]
}