Docs
API 1.39
Status
Objects

Program

The Program object of the Kaabist API.

FieldTypeRequiredDescription
idstringyespattern ^prg_[0-9a-hjkmnp-tv-z]{26}$
object"program"yes
namestringyespattern ^[a-z0-9][a-z0-9-]{1,62}$
descriptionstring or nullyes
latest_versionintegeryes≥ 0
aliasesmap of integeryes
canaryobject or nullyes
canary.enabledboolean
canary.cronstring or nullyesmin length 1
canary.urlstring or null
canary.aliasstringpattern ^[a-z][a-z0-9-]{0,31}$
created_atstring (date-time)yes
updated_atstring (date-time)yes

#Example

{
  "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"
}

Was this page helpful?