OlammaAPI
Menu

Ship release

After a production deploy, ship the open release. Changes from the deployed pull requests ship; the rest move to a new open release. Only for changelogs that release on deploy.

POST/v1/w/{workspace}/releases/ship

Send an Idempotency-Key. This may answer 202 while it waits for approval.

Path parameters

workspacestringrequired

Your workspace’s address name.

Headers

Idempotency-Keystring

8–100 characters. Repeat the same key and body to get the first outcome back instead of writing twice.

Body

changelogIdstring

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

productstring

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

versionstring

Defaults to the next one for the day, like 2026.12.01.1.

commitstring

The deployed commit.

previousCommitstring

The commit deployed before it.

deployedAtstring

When it deployed.

pullRequestsobject[]

The deployed pull requests; their changes ship.

changeIdsstring[]

Or name the changes to ship.

Response

releaseobject

Details

Ship a changelog's open release for a production deploy, when its release cycle is “every deploy” (list_changelogs shows it; scheduled and hand-released changelogs refuse). The changes whose pull requests are in the deploy (or the changeIds you name) go out with it; the rest move to a new open release. Pull requests in the deploy without a change are listed as missing, unless they say noChangelog. With neither pullRequests nor changeIds, every change in the open release ships. Sending the same commit again changes nothing (alreadyShipped). Publishing stays with a lead in Olamma.

Since 2026-12. Errors are listed in Errors.