Docs
API 1.39
Status
Programs

Point an alias at a version

PUT /v1/programs/{id}/aliases/{alias}: Point an alias at a version

PUT /v1/programs/{id}/aliases/{alias}
Operation idsetProgramAlias
Key scoperun: keys that run jobs (and admin keys)
SectionPrograms

#Parameters

NameInTypeRequiredDescription
idpathstringyesmin length 1
aliaspathstringyesmin length 1

#Request body

FieldTypeRequiredDescription
versionintegeryes≥ 1

#Example request

curl -X PUT "https://api.kaab.ist/v1/programs/{id}/aliases/{alias}" \
  -H "Authorization: Bearer $KAAB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"version":2}'

#Responses

#200

Program

Program

{
  "id": "prg_01j9zqk3q7m4n5p6r7s8t9v0wx",
  "object": "program",
  "name": "acme-report",
  "description": "Daily report export",
  "latest_version": 3,
  "aliases": {
    "latest": 3,
    "production": 2
  },
  "canary": {
    "enabled": true,
    "cron": "0 */6 * * *",
    "url": null
  },
  "created_at": "2026-09-18T10:00:00Z",
  "updated_at": "2026-09-18T10:00:00Z"
}

#Errors

Every error answers with the error envelope; its code is one of the error codes.

StatusWhen
400request_invalid: request validation failed
401Missing or invalid API key
402insufficient_credits: top up to continue
403The key's scope does not cover this operation
404Resource not found
409Conflicting state (see error.code)
422Semantically invalid request (see error.code)
429Rate limited; see Retry-After
500internal: unexpected server error

Was this page helpful?