 |
This is a machine translation based on the English version of the article. It might or might not have already been subject to text preparation. If you find errors, please file a GitHub issue that states the paragraph that has to be improved. |
1. Introduction
Checkmk propose désormais toute une série d’interfaces variées, notamment l’API REST, grâce à laquelle vous pouvez effectuer une grande partie des opérations également possibles via l’interface Web. Il existe toutefois également des API pour les plug-ins de vérification, l’inventaire matériel/logiciel, l’Agent Bakery, etc. Des articles, des références et d’autres ressources concernant toutes ces interfaces sont disponibles dans le présent guide de l’utilisateur, sur le site Web et dans Checkmk même.
Dans cet article, nous vous proposons un aperçu de toutes les interfaces et ressources, ainsi que quelques conseils sur leur utilisation générale. De nombreux liens dans cet article sont redondants, car les informations sont destinées à répondre à trois approches ou questions différentes :
Quelles API Checkmk propose-t-il ?
Quels articles relatifs aux API trouve-t-on dans le guide de l'utilisateur ?
Quelles ressources relatives aux API sont disponibles dans Checkmk ?
L'interface la plus importante est sans aucun doute l'API REST de Checkmk, qui permet d'effectuer, d'un point de vue programmation, presque tout ce qui peut également être réalisé via l'interface web.
 |
L'interface graphique interactive de l'API REST offre une introduction rapide et pratique à l'API REST. Vous pouvez y envoyer et, si vous le souhaitez, modifier des requêtes prédéfinies. Vous trouverez cette interface graphique dans Checkmk même via Help > Developer resources > REST API interactive GUI. |
La deuxième interface majeure est constituée des API de plug-ins pour le développement de vos propres extensions. En fonction de votre niveau d'expérience, vous pouvez commencer ici par notre article d'introduction ou par la référence, que vous trouverez également directement dans Checkmk : Help > Developer resource > Plug-in API references.
|
Même sans site Checkmk en service, vous pouvez consulter une copie de la documentation des API de plug-ins à l'adresse docs.checkmk.com/plugin-api. |
Dans les tableaux ci-dessous, vous trouverez ces API, mais aussi des interfaces moins connues, telles que celles pour l'inventaire matériel/logiciel, des sous-interfaces pour le développement de plug-ins de contrôle, comme l'API Graphing explicite, ainsi que des quasi-interfaces, telles que le format de sortie des contrôles locaux, le précurseur simple et basé sur des scripts des plug-ins à part entière.
2. Les API dans Checkmk
| API | Guide de l'utilisateur | Web | Description |
|---|---|---|---|
API REST |
Fonctionnellement, il s'agit d'un sous-ensemble de l'interface Web. |
||
API Check |
Développement de plug-ins de vérification basés sur des agents |
Dans Checkmk :Help > Developer resources > Plug-in API references > Agent based ("Check API")
, |
Codage des plug-ins de vérification. |
API d'inventaire |
Dans Checkmk :Help > Developer resources > Plug-in API references > Agent based ("Check API") > Version 2
, |
Codage des plug-ins de vérification. |
|
API Bakery |
Dans Checkmk : Help > Developer resources > Plug-in API references > Bakery, |
Intégrer des plug-ins de vérification dans l'Agent Bakery. |
|
API DCD |
Dans Checkmk : Help > Developer resources > Plug-in API references > Dynamic configuration connector, |
Connexions personnalisées pour la gestion dynamique des hôtes avec le Dynamic Configuration Daemon (DCD). |
|
API de création de graphiques |
Personnalisation de l'affichage des métriques dans l'article sur le plug-in de vérification basé sur un agent |
Dans Checkmk : Help > Developer resources > Plug-in API references > Graphing, |
Inclure des métriques, des graphiques, des Perf-O-Meters. |
API des ensembles de règles |
Ensembles de règles pour les paramètres de contrôle dans l'article sur le plug-in de contrôle basé sur un agent |
Dans Checkmk : Help > Developer resources > Plug-in API references > Rulesets, |
Développez vos propres ensembles de règles. |
API des appels côté serveur |
Dans Checkmk : Help > Developer resources > Plug-in API references > Server-side calls, |
Développez des contrôles actifs et des agents spéciaux. |
|
API HW/SW |
n.a. |
API Web pour l'interrogation des données d'inventaire. |
|
Livestatus |
Récupération des données d'état via Livestatus, référence des commandes Livestatus |
n.a. |
Récupération directe des données d'état via le langage de requête Livestatus (LQL). |
Interface de la console d'événements |
L'interface d'état de la console d'événements |
n.a. |
Accès à l'état interne et exécution de commandes via un socket Unix. |
Vérifications locales |
n.a. |
« Mini-interface » pour vos propres vérifications basées sur des scripts. |
3. Articles du guide de l'utilisateur
| Section API | Guide de l'utilisateur | Description |
|---|---|---|
Automatisation |
Description de l'API REST, ainsi que sa documentation et ses utilisations possibles. |
|
Présentation de l'interface de données pour les informations relatives aux hôtes et aux services. |
||
Tous les tableaux, en-têtes, filtres et opérateurs. |
||
Description de l'API Web propre à l'inventaire pour l'accès externe. |
||
L'interface d'état de la console d'événements |
Les données peuvent être lues depuis la console d'événements et les commandes peuvent être envoyées via un socket Unix et un sous-ensemble du protocole Livestatus. |
|
Programmation |
Article de présentation présentant toutes les possibilités d'extensions et des liens vers des informations complémentaires. |
|
Description détaillée de la procédure de développement d'un plug-in de vérification. |
||
Description détaillée du développement d'un plug-in de vérification pour les données SNMP. |
||
Description détaillée de la procédure de développement d'un plug-in d'inventaire. |
4. Ressources dans Checkmk
| Dans Checkmk | Description |
|---|---|
Help > Developer resources > Plug-in API references |
Une documentation Sphinx répertoriant toutes les API pertinentes pour le développement de plug-ins Check. |
Help > Developer resources > REST API documentation |
Référence basée sur ReDoc/OpenAPI pour toutes les requêtes pertinentes pour Check, comprenant des exemples de code pour Requests (Python), Urllib (Python), httpie et curl. |
Help > Developer resources > REST API interactive GUI |
Interface Web interactive permettant de tester tous les points de terminaison de l'API, avec un retour d'information directement sur la page. |
Help > Developer resources > Plug-in API references > Agent based ("Check API") |
Dans la section «Version 2 > New in this version», vous trouverez des informations importantes concernant la migration des anciens plug-ins vers la version actuelle de l'API. |
5. Ressources en ligne
| Ressource | Description |
|---|---|
Tutoriel vidéo (en anglais) avec des exemples pratiques d'utilisation de l'API REST, par exemple pour définir des temps d'arrêt planifiés. |
|
Exemples Curl dans la base de connaissances Checkmk pour des requêtes concrètes, par exemple des requêtes liées par « AND ». |
|
Dans la boutique de plug-ins Checkmk, vous trouverez de nombreuses implémentations pratiques des API, y compris le code source. |