foliot docs

API reference / Workflows / Point an alias at a version

Point an alias at a version

PUT/apps/{appId}/workflows/{workflow}/aliases/{alias}

Authenticate with an app API key or a signed-in Foliot Console session.

Creates the alias or moves it. A run started with this alias from now on gets that version; runs already started stay on theirs. Pointing default pins the version a run that names neither a version nor an alias gets, so registering a new version no longer moves those runs: delete default to have it follow the newest version again. The version must be registered, or this is a 404. A workflow may have a limited number of aliases besides default; a new one past that is a 409, while moving one that exists, or default, is never refused.

Path parameters

appId
string
REQUIRED

The app's id, not its name, returned as app.id when the app is created. The id never changes.

workflow
string
REQUIRED
alias
string
REQUIRED

pattern ^[a-z][a-z0-9-]{0,39}$

Request body

version
integer (int64)
REQUIRED

min 1 · max 2147483647

Responses

200 object OK
400 Error Invalid request.
401 Error Missing, malformed or unknown bearer token.
403 Error The token is valid but not permitted on this route.
404 Error No such resource.
409 Error Conflicts with existing state.
503 Error A dependency this route needs is unreachable.