Nous vous rappelons qu'il est nécessaire, au préalable à toute utilisation de nos API, d'effectuer une demande de clé d'API auprès de l'équipe support RG.

Une fois celle-ci reçue, vous pourrez générer votre token via la doc API RG (ou un utilitaire type Postman) en renseignant vos username/password et la clé d'API.

 

mceclip0.png

 

 

Pour la suite de cet article, vous trouverez en bas de page des exemples complets d'appels et de retour au format JSON

Remonter les datas d'un agent

Effectuer un appel en get pour chaque agent concerné sur la route : 

https://api.rg-supervision.com/api/{token}/agent/{agent}/objects

{agent} correspond à l'id agent RG

{token} correspond à votre token d'API

Ex :
https://api.rg-supervision.com/api/{token}/agent/NQ12-T0-V9/objects

Cet appel retourne l'ensemble des données relatives à l'activité d'un agent :

"result": {
..................
},
"data": {

..................
"Disk": {
"name": "Disques",
"rank": 40,
"isMonoObject": false,
"objects": {
"25934058": {
"name": "C:",
"description": null,
"creationDate": "2021-02-12T10:27:00+00:00",
"charts": {
"1": {
"name": "Utilisation Disque",
"rank": 1,
"counters": [
"DiskSize",
"DskUsedSpc"
]
}
}
}
}
},
"Processor": {
"name": "Processeurs",
"rank": 60,
"isMonoObject": false,
"objects": {
"25934084": {
"name": "CPU _Total",
"description": null,
"creationDate": "2021-02-12T10:27:42+00:00",
"charts": {
"5": {
"name": "% CPU",
"rank": 1,
"counters": [
"UsedPCT"
]..................
}
}
}
}
},

  • Exemple sur les données graphiques d'un disque

Effectuer un second appel en get sur la route : 

https://api.rg-supervision.com/api/{token}/chart/data/{object}/{chart}/{scale}

Concernant les variables, pour cet exemple, dans "Disk", "objects":

{object} correspond à l'id du lecteur cible ( dans cet exemple l'id 25934058 correspond bien au lecteur C)
{chart} correspond à l'id du charts ( dans cet exemple l'id 1 correspond bien au charts "name": "Utilisation Disque")
{scale} peut avoir plusieurs niveaux de granularité: day, week, month, year

Ex :
https://api.rg-supervision.com/api/{token}/chart/data/25934058/1/day

permet de suivre l'évolution de "DiskSize" ainsi que de "DskUsedSpc".

  • Exemple sur l'utilisation CPU

Effectuer un second appel en get sur la route : 

https://api.rg-supervision.com/api/{token}/chart/data/{object}/{chart}/{scale}

Concernant les variables, pour cet exemple permettant de remonter l'usage CPU, chercher dans "Processor", "objects":

{object} correspond à l'id de la cible ( dans cet exemple l'id "25934084" correspond bien au "CPU _Total")
{chart} correspond à l'id du charts ( dans cet exemple l'id "5" correspond bien au charts "name": "% CPU")
{scale} peut avoir plusieurs niveaux de granularité: day, week, month, year 

Ex :
https://api.rg-supervision.com/api/{token}/chart/data/25934084/5/day

permet de remonter l'évolution de "UsedPCT".

 

Remonter l'ensemble du pedigree pour un node donné

Effectuer un appel en get sur la route : 

https://api.rg-supervision.com/api/{token}/node/{node}/pedigree

permet de remonter l'ensemble du pedigree pour un node

{node} correspond à l'id du node

{token} correspond à votre token d'API

Ex :

 https://api.rg-supervision.com/api/{token}/node/130333/pedigree

  • Exemple de tri : 

En fonction de la plateforme :

agentPlatform=w ---->  Windows

agentPlatform=l ---->  Linux

agentPlatform=m ---->  Mac Os

 

En fonction du type d'agent :

agentType=s ---> serveur

agentType=w----> workstation

Ex : 
https://api.rg-supervision.com/api/{token}/node/130333/pedigree?agentPlatform=w&agentType=s

 

 

Remonter l'ensemble des tickets pour un node donné

Effectuer un appel en get sur la route : 

https://api.rg-supervision.com/api/{{token}}/ticket/list/{node}

Ex : 

https://api.rg-supervision.com/api/{{tokenProd}}/ticket/list/130333

Différents filtres sont disponibles : 

--criticality : low, medium, critical

--state : opened, closed, active

--agentTypes : w, s

--creationDateBegin

--creationDateEnd

Ex :

https://api.rg-supervision.com/api/{token}/ticket/list/130333?agentTypes=s&criticality=medium&state=active

 

Remonter le résultat de Custom Script

Afin de pouvoir remonter le résultat des CS pour un node, il va falloir effectuer 3 appels.

Effectuer un premier appel en get sur la route : 

https://api.rg-supervision.com/api​/{token}​/node​/{node}​/customscriptresult

Ex : 

https://api.rg-supervision.com/api​/{token}​/node​/14419/customscriptresult

Cet appel permet de remonter tous les CS présent sur un node donné.

 

Effectuer un second appel en get sur :

https://api.rg-supervision.com/api​/{token}​/node​/{node}/csn/{csn}/customscriptresult

Ex : 

https://api.rg-supervision.com/api​/{token}​/node​/{node}/csn/10748/customscriptresult

Cet appel remonte tous les agents concernés par un même CS sur un node donné, le {csn} étant l'ID du CSNS.

Enfin, effectuer un dernier appel en get sur la route : 

https://api.rg-supervision.com/api​/{token}​/object/{object}/customscriptresult

{object} correspondant à l'id de "objects"

Ex : 

https://api.rg-supervision.com/api/{token}/object/20702272/customscriptresult

Cet appel remonte le résultat du CS pour un agent