API 💡

The Canopsis API lets you connect our solution to your own ecosystem. It enables read and write interaction with the platform. In practice, it gives users, third-party tools, and scripts a set of entry points to work with.
With this API, you can:

• automate tasks,
• integrate data,
• or extract information.

Here are just a few of the possibilities:

• Publish events from the IT environment
• Put into maintenance state
• Import repositories
• Create incident tickets
• …

Update 2021: APIs rewritten

In 2021, we rewrote our APIs in Go. They were originally built in Python. This change improved performance and cut call execution times. It also made the APIs easier to maintain and secure.

The APIs are now OpenAPI-compliant. This means they’re self-documenting, so you always get accurate, up-to-date information on what’s available.

Access control has also improved. You can now secure access at the level of each API and each operation. This strengthens both flow control and information security.

Update 2025: Introduction of changelogs and breaking changes

Since 2025, the Canopsis API includes changelogs and breaking-change notes. Here’s what that means for you:

• Changelog: a list of properties, responses, and endpoints added or removed between two versions.
• Breaking changes: a list of changes that aren’t compatible with earlier versions.

Update 2026: Separation of public and private APIs

Starting in 2026, the Canopsis API splits into two separate scopes.

• For customers:

the public API will be versioned from release 26.10 onward, as /api/v5. This protects the stability of your scripts and integrations over time. We’re also rolling out JWT authentication to replace Basic Auth, step by step.

New documentation on backward compatibility and ACLs will clearly separate public from internal endpoints.

• For development teams :

the private API – /api/internal – evolves freely with no backward-compatibility constraints. This lets us speed up interface upgrades and internal optimizations.

For more technical information on the API and all other features, please visit our documentation. If any unanswered questions remain, you can also contact our team via the contact form.