API 💡

Canopsis Application Programming Interface enables read and write interaction with the platform. Indeed, it offers a set of entry points enabling users, third-party tools and scripts:

• 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

To start with, rewriting APIs in Go (originally in Python) improves performance and call execution times, while making them easier to maintain and secure.

This is accompanied by OpenAPI-compliant self-documentation, automatically generating reliable, up-to-date information on available APIs.

Access can now be secured down to the very last detail, at the level of each API and each operation, reinforcing the control of flows and the protection of the information system.

Update 2025: Introduction of changelogs and breaking changes

The Canopsis API now includes a number of changes that you need to take into account:

• Changelog: List of removed and added properties, responses, endpoints and all the other changes between two successive versions.
• Breaking changes: List of removed and added properties, responses, endpoints and all the other changes incompatible with earlier versions.

Update 2026: Separation of public and private APIs

The Canopsis API will now be divided into two distinct scopes.

• For customers:

The public API will be versioned as of version 26.10: /api/v5. It guarantees the stability of your scripts and integrations over time. Security is enhanced with the gradual introduction of modern authentication (JWT), replacing Basic Auth.

What’s more, the new backward compatibility documentation andACL will clearly distinguish between public and internal endpoints.

• For development teams :

The private API – /api/internal – will evolve freely, with no backward compatibility constraints, to accelerate 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.