• 7.0.0latest○1Docs2026-07-17 12:04

  Change detail

  a7d7607cf663 → fe728087be02 · 1 change across 1 operation

  AllBreakingWarningInfo

  • PATCH/v7/release(<ID>)1
• API: Document how to mark devices for Queued OS Updatesno API changesDocs01636822026-04-30 08:51
• Re-add examples section and reduce the influence of examples on OpenAPI▲55○40Docs27047f32026-04-16 16:52

  Change detail

  9ebee1bfff77 → 7aef9556473c · 95 changes across 93 operations and 1 section

  AllBreakingWarningInfo

  • POST/api-key/user/full1 breaking1
  • GET/download1 breaking1
  • GET/user/v1/whoami1 breaking1
  • PATCH/v7/api_key({ID})1 breaking1
  • DELETE/v7/application({ID})1 breaking1
  • GET/v7/application({ID})1 breaking1
  • PATCH/v7/application({ID})1 breaking1
  • GET/v7/application(slug='{SLUG}')1 breaking1
  • PATCH/v7/application(slug='{SLUG}')1 breaking1
  • POST/v7/application1 breaking1
  • DELETE/v7/application_config_variable({ID})1 breaking1
  • PATCH/v7/application_config_variable({ID})1 breaking1
  • POST/v7/application_config_variable1 breaking1
  • DELETE/v7/application_environment_variable({ID})1 breaking1
  • PATCH/v7/application_environment_variable({ID})1 breaking1
  • POST/v7/application_environment_variable1 breaking1
  • DELETE/v7/application_tag/({ID})1 breaking1
  • PATCH/v7/application_tag/({ID})1 breaking1
  • POST/v7/application_tag1 breaking1
  • DELETE/v7/device({ID})1 breaking1
  • GET/v7/device({ID})1 breaking1
  • PATCH/v7/device({ID})1 breaking1
  • GET/v7/device(uuid='{UUID}')1 breaking1
  • PATCH/v7/device(uuid='{UUID}')1 breaking1
  • DELETE/v7/device_config_variable({ID})1 breaking1
  • PATCH/v7/device_config_variable({ID})1 breaking1
  • POST/v7/device_config_variable1 breaking1
  • DELETE/v7/device_environment_variable({ID})1 breaking1
  • PATCH/v7/device_environment_variable({ID})1 breaking1
  • POST/v7/device_environment_variable1 breaking1
  • DELETE/v7/device_service_environment_variable({ID})1 breaking1
  • PATCH/v7/device_service_environment_variable({ID})1 breaking1
  • POST/v7/device_service_environment_variable1 breaking1
  • DELETE/v7/device_tag({TAG-ID})1 breaking1
  • PATCH/v7/device_tag(device={DEVICE_ID},tag_key='{EXISTING-KEY}')1 breaking1
  • POST/v7/device_tag1 breaking1
  • GET/v7/device_type({ID})1 breaking1
  • GET/v7/device_type(slug='{DEVICE TYPE SLUG}')1 breaking1
  • GET/v7/organization({ID})1 breaking1
  • GET/v7/organization(handle='{HANDLE}')1 breaking1
  • GET/v7/release#List_Supervisor_releases1 breaking1
  • GET/v7/release#Release1 breaking1
  • GET/v7/release({ID})1 breaking1
  • POST/v7/release_tag1 breaking1
  • DELETE/v7/service_environment_variable({ID})1 breaking1
  • PATCH/v7/service_environment_variable({ID})1 breaking1
  • POST/v7/service_environment_variable1 breaking1
  • DELETE/v7/team({ID})1 breaking1
  • GET/v7/team({ID})1 breaking1
  • POST/v7/team1 breaking1
  • DELETE/v7/user__has__public_key({ID})1 breaking1
  • GET/v7/user__has__public_key({ID})1 breaking1
  • POST/v7/user__has__public_key1 breaking1
  • DELETE/v7/user__is_member_of__application(is_member_of__application={ID},user={USER ID})1 breaking1
  • POST/v7/user__is_member_of__application1 breaking1
  • GET/v7/release2
  • PATCH/v7/api_key(<ID>)1
  • DELETE/v7/application(<ID>)1
  • GET/v7/application(<ID>)1
  • PATCH/v7/application(<ID>)1
  • GET/v7/application(slug='<SLUG>')1
  • PATCH/v7/application(slug='<SLUG>')1
  • DELETE/v7/application_config_variable(<ID>)1
  • PATCH/v7/application_config_variable(<ID>)1
  • DELETE/v7/application_environment_variable(<ID>)1
  • PATCH/v7/application_environment_variable(<ID>)1
  • DELETE/v7/application_tag/(<ID>)1
  • PATCH/v7/application_tag/(<ID>)1
  • DELETE/v7/device(<ID>)1
  • GET/v7/device(<ID>)1
  • PATCH/v7/device(<ID>)1
  • GET/v7/device(uuid='<UUID>')1
  • PATCH/v7/device(uuid='<UUID>')1
  • DELETE/v7/device_config_variable(<ID>)1
  • PATCH/v7/device_config_variable(<ID>)1
  • DELETE/v7/device_environment_variable(<ID>)1
  • PATCH/v7/device_environment_variable(<ID>)1
  • DELETE/v7/device_service_environment_variable(<ID>)1
  • PATCH/v7/device_service_environment_variable(<ID>)1
  • DELETE/v7/device_tag(<TAG-ID>)1
  • PATCH/v7/device_tag(device=<DEVICE_ID>,tag_key='<EXISTING-KEY>')1
  • GET/v7/device_type(<ID>)1
  • GET/v7/device_type(slug='<DEVICE TYPE SLUG>')1
  • GET/v7/organization(<ID>)1
  • GET/v7/organization(handle='<HANDLE>')1
  • GET/v7/release(<ID>)1
  • DELETE/v7/service_environment_variable(<ID>)1
  • PATCH/v7/service_environment_variable(<ID>)1
  • DELETE/v7/team(<ID>)1
  • GET/v7/team(<ID>)1
  • DELETE/v7/user__has__public_key(<ID>)1
  • GET/v7/user__has__public_key(<ID>)1
  • DELETE/v7/user__is_member_of__application(is_member_of__application=<ID>,user=<USER ID>)1
  • components1
• Run `npm run generate-openapi`▲37○37Docs651bf0f2026-03-02 19:56

  Change detail

  2dc5ba35c31c → 9ebee1bfff77 · 74 changes across 74 operations

  AllBreakingWarningInfo

  • PATCH/v7/api_key/{ID}1 breaking1
  • DELETE/v7/application/{ID}1 breaking1
  • GET/v7/application/{ID}1 breaking1
  • PATCH/v7/application/{ID}1 breaking1
  • GET/v7/application/slug='{SLUG}'1 breaking1
  • PATCH/v7/application/slug='{SLUG}'1 breaking1
  • DELETE/v7/application_config_variable/{ID}1 breaking1
  • PATCH/v7/application_config_variable/{ID}1 breaking1
  • DELETE/v7/application_environment_variable/{ID}1 breaking1
  • PATCH/v7/application_environment_variable/{ID}1 breaking1
  • DELETE/v7/application_tag//{ID}1 breaking1
  • PATCH/v7/application_tag//{ID}1 breaking1
  • DELETE/v7/device/{ID}1 breaking1
  • GET/v7/device/{ID}1 breaking1
  • PATCH/v7/device/{ID}1 breaking1
  • GET/v7/device/uuid='{UUID}'1 breaking1
  • PATCH/v7/device/uuid='{UUID}'1 breaking1
  • DELETE/v7/device_config_variable/{ID}1 breaking1
  • PATCH/v7/device_config_variable/{ID}1 breaking1
  • DELETE/v7/device_environment_variable/{ID}1 breaking1
  • PATCH/v7/device_environment_variable/{ID}1 breaking1
  • DELETE/v7/device_service_environment_variable/{ID}1 breaking1
  • PATCH/v7/device_service_environment_variable/{ID}1 breaking1
  • DELETE/v7/device_tag/{TAG-ID}1 breaking1
  • PATCH/v7/device_tag/device={DEVICE_ID},tag_key='{EXISTING-KEY}'1 breaking1
  • GET/v7/device_type/{ID}1 breaking1
  • GET/v7/device_type/slug='{DEVICE TYPE SLUG}'1 breaking1
  • GET/v7/organization/{ID}1 breaking1
  • GET/v7/organization/handle='{HANDLE}'1 breaking1
  • GET/v7/release/{ID}1 breaking1
  • DELETE/v7/service_environment_variable/{ID}1 breaking1
  • PATCH/v7/service_environment_variable/{ID}1 breaking1
  • DELETE/v7/team/{ID}1 breaking1
  • GET/v7/team/{ID}1 breaking1
  • DELETE/v7/user__has__public_key/{ID}1 breaking1
  • GET/v7/user__has__public_key/{ID}1 breaking1
  • DELETE/v7/user__is_member_of__application/is_member_of__application={ID},user={USER ID}1 breaking1
  • PATCH/v7/api_key({ID})1
  • DELETE/v7/application({ID})1
  • GET/v7/application({ID})1
  • PATCH/v7/application({ID})1
  • GET/v7/application(slug='{SLUG}')1
  • PATCH/v7/application(slug='{SLUG}')1
  • DELETE/v7/application_config_variable({ID})1
  • PATCH/v7/application_config_variable({ID})1
  • DELETE/v7/application_environment_variable({ID})1
  • PATCH/v7/application_environment_variable({ID})1
  • DELETE/v7/application_tag/({ID})1
  • PATCH/v7/application_tag/({ID})1
  • DELETE/v7/device({ID})1
  • GET/v7/device({ID})1
  • PATCH/v7/device({ID})1
  • GET/v7/device(uuid='{UUID}')1
  • PATCH/v7/device(uuid='{UUID}')1
  • DELETE/v7/device_config_variable({ID})1
  • PATCH/v7/device_config_variable({ID})1
  • DELETE/v7/device_environment_variable({ID})1
  • PATCH/v7/device_environment_variable({ID})1
  • DELETE/v7/device_service_environment_variable({ID})1
  • PATCH/v7/device_service_environment_variable({ID})1
  • DELETE/v7/device_tag({TAG-ID})1
  • PATCH/v7/device_tag(device={DEVICE_ID},tag_key='{EXISTING-KEY}')1
  • GET/v7/device_type({ID})1
  • GET/v7/device_type(slug='{DEVICE TYPE SLUG}')1
  • GET/v7/organization({ID})1
  • GET/v7/organization(handle='{HANDLE}')1
  • GET/v7/release({ID})1
  • DELETE/v7/service_environment_variable({ID})1
  • PATCH/v7/service_environment_variable({ID})1
  • DELETE/v7/team({ID})1
  • GET/v7/team({ID})1
  • DELETE/v7/user__has__public_key({ID})1
  • GET/v7/user__has__public_key({ID})1
  • DELETE/v7/user__is_member_of__application(is_member_of__application={ID},user={USER ID})1
• Configure CI for GitBook branch (disable versionist, enable Flowzone)▲1○3Docs1c7631a2026-02-20 15:32

  Change detail

  f214e5485f05 → 2dc5ba35c31c · 4 changes across 3 operations

  AllBreakingWarningInfo

  • GET/v7/release#List_balenaOS_releases1 breaking1
  • GET/v7/release2
  • GET/v7/release#Release1
• Add OpenAPI spec generator from resource.json▲38○55Docsbabe6f12026-02-13 00:16

  Change detail

  previous → f214e5485f05 · 93 changes across 93 operations

  AllBreakingWarningInfo

  • PATCH/v7/api_key(<ID>)1 breaking1
  • DELETE/v7/application(<ID>)1 breaking1
  • GET/v7/application(<ID>)1 breaking1
  • PATCH/v7/application(<ID>)1 breaking1
  • GET/v7/application(slug='<SLUG>')1 breaking1
  • PATCH/v7/application(slug='<SLUG>')1 breaking1
  • DELETE/v7/application_config_variable(<ID>)1 breaking1
  • PATCH/v7/application_config_variable(<ID>)1 breaking1
  • DELETE/v7/application_environment_variable(<ID>)1 breaking1
  • PATCH/v7/application_environment_variable(<ID>)1 breaking1
  • DELETE/v7/application_tag/(<ID>)1 breaking1
  • PATCH/v7/application_tag/(<ID>)1 breaking1
  • DELETE/v7/device(<ID>)1 breaking1
  • GET/v7/device(<ID>)1 breaking1
  • PATCH/v7/device(<ID>)1 breaking1
  • GET/v7/device(uuid='<UUID>')1 breaking1
  • PATCH/v7/device(uuid='<UUID>')1 breaking1
  • DELETE/v7/device_config_variable(<ID>)1 breaking1
  • PATCH/v7/device_config_variable(<ID>)1 breaking1
  • DELETE/v7/device_environment_variable(<ID>)1 breaking1
  • PATCH/v7/device_environment_variable(<ID>)1 breaking1
  • DELETE/v7/device_service_environment_variable(<ID>)1 breaking1
  • PATCH/v7/device_service_environment_variable(<ID>)1 breaking1
  • DELETE/v7/device_tag(<TAG-ID>)1 breaking1
  • PATCH/v7/device_tag(device=<DEVICE_ID>,tag_key='<EXISTING-KEY>')1 breaking1
  • GET/v7/device_type(<ID>)1 breaking1
  • GET/v7/device_type(slug='<DEVICE TYPE SLUG>')1 breaking1
  • GET/v7/organization(<ID>)1 breaking1
  • GET/v7/organization(handle='<HANDLE>')1 breaking1
  • GET/v7/release(<ID>)1 breaking1
  • PATCH/v7/release(<ID>)1 breaking1
  • DELETE/v7/service_environment_variable(<ID>)1 breaking1
  • PATCH/v7/service_environment_variable(<ID>)1 breaking1
  • DELETE/v7/team(<ID>)1 breaking1
  • GET/v7/team(<ID>)1 breaking1
  • DELETE/v7/user__has__public_key(<ID>)1 breaking1
  • GET/v7/user__has__public_key(<ID>)1 breaking1
  • DELETE/v7/user__is_member_of__application(is_member_of__application=<ID>,user=<USER ID>)1 breaking1
  • POST/api-key/user/full1
  • GET/download1
  • GET/user/v1/whoami1
  • PATCH/v7/api_key/{ID}1
  • DELETE/v7/application/{ID}1
  • GET/v7/application/{ID}1
  • PATCH/v7/application/{ID}1
  • POST/v7/application1
  • GET/v7/application/slug='{SLUG}'1
  • PATCH/v7/application/slug='{SLUG}'1
  • DELETE/v7/application_config_variable/{ID}1
  • PATCH/v7/application_config_variable/{ID}1
  • POST/v7/application_config_variable1
  • DELETE/v7/application_environment_variable/{ID}1
  • PATCH/v7/application_environment_variable/{ID}1
  • POST/v7/application_environment_variable1
  • DELETE/v7/application_tag//{ID}1
  • PATCH/v7/application_tag//{ID}1
  • POST/v7/application_tag1
  • DELETE/v7/device/{ID}1
  • GET/v7/device/{ID}1
  • PATCH/v7/device/{ID}1
  • GET/v7/device/uuid='{UUID}'1
  • PATCH/v7/device/uuid='{UUID}'1
  • DELETE/v7/device_config_variable/{ID}1
  • PATCH/v7/device_config_variable/{ID}1
  • POST/v7/device_config_variable1
  • DELETE/v7/device_environment_variable/{ID}1
  • PATCH/v7/device_environment_variable/{ID}1
  • POST/v7/device_environment_variable1
  • DELETE/v7/device_service_environment_variable/{ID}1
  • PATCH/v7/device_service_environment_variable/{ID}1
  • POST/v7/device_service_environment_variable1
  • DELETE/v7/device_tag/{TAG-ID}1
  • PATCH/v7/device_tag/device={DEVICE_ID},tag_key='{EXISTING-KEY}'1
  • POST/v7/device_tag1
  • GET/v7/device_type/{ID}1
  • GET/v7/device_type/slug='{DEVICE TYPE SLUG}'1
  • GET/v7/organization/{ID}1
  • GET/v7/organization/handle='{HANDLE}'1
  • GET/v7/release#List_Supervisor_releases1
  • GET/v7/release#List_balenaOS_releases1
  • GET/v7/release/{ID}1
  • POST/v7/release_tag1
  • DELETE/v7/service_environment_variable/{ID}1
  • PATCH/v7/service_environment_variable/{ID}1
  • POST/v7/service_environment_variable1
  • DELETE/v7/team/{ID}1
  • GET/v7/team/{ID}1
  • POST/v7/team1
  • DELETE/v7/user__has__public_key/{ID}1
  • GET/v7/user__has__public_key/{ID}1
  • POST/v7/user__has__public_key1
  • DELETE/v7/user__is_member_of__application/is_member_of__application={ID},user={USER ID}1
  • POST/v7/user__is_member_of__application1

Revisions go back to the API's first capture.