Where to find API release changes?

[hopewise]

Issue

I updated my frontend container to the latest keep-ui:latest version, but I can't find any release notes or changelog specifically for the API changes.
Since you have separate Docker images:

• keep-ui:latest (Frontend)
• keep-api:latest (Backend/API)

Questions

Are the frontend and API maintained in the same repository? Since you have separate Docker images, it's unclear if they're built from the same repo or separate repos.
Where can I find the release notes or changelog for API changes when updating from one version to another?

I need to know what API changes were made so I can understand:

• Breaking changes that might affect my integration
• New API endpoints or features available
• Any migration steps required

Current Problem

Updated frontend successfully
Cannot determine what API changes came with this release
No clear documentation on where to find API-specific release notes

Thanks!

[dosubot[bot]]

Both the frontend (keep-ui) and backend/API (keep-api) are maintained in the same repository, with separate directories for each component. There isn't a centralized changelog or release notes file specifically for API changes. Instead, API changes—including breaking changes, new endpoints, and migration steps—are typically documented in pull request descriptions. For example, a recent PR introduced breaking changes and new API endpoints, with details provided directly in the PR description (see PR #5002).

To track API changes, it's best to monitor recent pull requests that affect the backend/API directory and review their descriptions for any notes on breaking changes or new features. There is currently no dedicated documentation page or changelog for API-specific release notes.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}   

[hopewise]

So, according to https://github.com/keephq/keep/releases , all latest fixes sense Release v0.45.10 related to UI ?

[dosubot[bot]]

Not all fixes since v0.45.10 are related to the UI. There have been backend/API changes as well, such as updates to alert deduplication logic to ensure proper hashing of alerts with different key ordering (PR #5132), and fixes for incident enrichment workflows with MySQL, including database migration for UUID handling (PR #5098). Some backend/API changes may not be clearly highlighted in the release notes and are only described in pull request descriptions.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}   

[hopewise]

oh, are there any instructions to handle DB migration when updating keep API container? we are using postgres with Keep

[dosubot[bot]]

Database migrations are handled automatically when you update the keep API container—no manual steps are needed for standard upgrades with Postgres. When you start the new container, Keep runs all pending Alembic migrations before bringing the API online, unless you set the SKIP_DB_CREATION environment variable to true. This means you can usually just pull the new image and restart the service, and migrations will be applied for you. If you have a custom deployment or need to skip migrations, you can control this with SKIP_DB_CREATION.

If you ever hit a migration error (like a duplicate index), check the relevant GitHub issues for manual workarounds, but these are rare and fixes are usually merged quickly (example).

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}   

[shahargl]

hey @hopewise - a bit later to the party.

API docs can be found at https://api.keephq.dev/docs
you can also get the full openapi.json - https://api.keephq.dev/openapi.json

[hopewise]

Database migrations are handled automatically when you update the keep API container—no manual steps are needed for standard upgrades with Postgres. When you start the new container, Keep runs all pending Alembic migrations before bringing the API online, unless you set the SKIP_DB_CREATION environment variable to true. This means you can usually just pull the new image and restart the service, and migrations will be applied for you. If you have a custom deployment or need to skip migrations, you can control this with SKIP_DB_CREATION.

If you ever hit a migration error (like a duplicate index), check the relevant GitHub issues for manual workarounds, but these are rare and fixes are usually merged quickly (example).

@dosubot

alembic.util.exc.CommandError: Can't locate revision identified by '9dd1be4539e0'

[hopewise]

Thanks @shahargl, Can we rollback migrations just incase we had any issue after update to latest API image ? ( we use docker container )

Is the bot answer correct ? that we have the same repo for keep ui and keep backend ?

[shahargl]

yes, its the same repo.

regarding rollback migrations - yes, but not automatically. you need to rollback with the new code (before actually rollbacking the version), then rollback.