La Public API de XorMon permet de récupérer les tags et leurs associations aux équipements.

Les tags de XorMon s’organisent de deux façons :

1. un tag isolé (par ex. « production », « critical »)
2. un tag sous une catégorie (par ex. catégorie « environment » -> tag « production »)

Les catégories sont facultatives. Un équipement peut être affecté à un tag, que ce tag appartienne ou non à une catégorie.

Récupérer les tags par la Public API :

Vous utilisez déjà GET /api/public/v1/hostcfg pour obtenir vos équipements.
Le hostcfg_id retourné pour chaque équipement est le même que l’item_id employé dans l’API Tags.
Voici la marche à suivre, étape par étape :

1. Obtenez vos équipements (ce que vous faites déjà) :

   GET /api/public/v1/hostcfg
   apiKey: {your-api-key}
   

   Chaque équipement de la réponse porte un hostcfg_id, égal à l’item_id.
   
   
2. Obtenez toutes les catégories de tags (clés de regroupement facultatives) :

   GET /api/public/v1/tags/categories
   apiKey: {your-api-key}
   
   Returns:
   {
     "statusCode": 200,
     "data": [
       { "category_id": "cat-uuid-1", "label": "location" },
       { "category_id": "cat-uuid-2", "label": "environment" }
     ]
   }
   

3. Obtenez tous les tags :

   GET /api/public/v1/tags
   apiKey: {your-api-key}
   

   Retourne tous les tags. Certains appartiennent à une catégorie, d’autres sont isolés.
   
   
4. Obtenez les équipements affectés à chaque tag :

   GET /api/public/v1/tags/{tag_id}/items
   apiKey: {your-api-key}
   

   Retourne la liste des items (item_id = hostcfg_id), ou filtrez sur le subsystem device, affectés à ce tag.
   
   

Autre voie : rechercher des items par libellé de tag, éventuellement filtrés par catégorie :

• Par tag seul (tags avec ou sans catégorie) :

  GET /api/public/v1/tags/search-items?tag=production
  apiKey: {your-api-key}
  

• Par tag au sein d’une catégorie précise :

  GET /api/public/v1/tags/search-items?tag=production&category=environment
  apiKey: {your-api-key}
  

Créer des tags :

Si vous n’avez pas encore créé de tags ni de catégories, vous pouvez le faire depuis l’interface de XorMon
ou par l’API :

• Créer une catégorie (facultatif) :

    POST /api/public/v1/tags/categories
    { "category_label": "environment" }
  

• Créer un tag (avec ou sans catégorie) :

    POST /api/public/v1/tags
    { "label": "production", "category_label": "environment" }
  
    POST /api/public/v1/tags
    { "label": "critical" }
  

• Affecter des équipements à un tag :

    POST /api/public/v1/tags/{tag_id}/items
    { "item_ids": ["hostcfg-id-1", "hostcfg-id-2"] }
  

RÉCAPITULATIF DES POINTS D’API

  GET  /api/public/v1/hostcfg                           -> list devices
  GET  /api/public/v1/tags                              -> list all tags
  GET  /api/public/v1/tags/categories                   -> list all categories
  GET  /api/public/v1/tags/{tag_id}/items               -> items assigned to a tag
  GET  /api/public/v1/tags/search-items?tag=            -> search by tag label
  GET  /api/public/v1/tags/search-items?tag=&category=  -> search by tag + category
  POST /api/public/v1/tags                              -> create a tag
  POST /api/public/v1/tags/categories                   -> create a category
  POST /api/public/v1/tags/{tag_id}/items               -> assign items to a tag

Tous les points d’API demandent l’en-tête apiKey.
Une clé d’API se génère par « POST /api/public/v1/auth », avec vos nom d’utilisateur et mot de passe.