Utilisation de l'API sur la VSPC

Introduction

Nous verrons dans cet article comment utiliser l'API de la VSPC.

Pré-requis

Les droits nécessaires pour l'utilisateur sont: Company Owner, Company Administrator ou Location Administrator.

Vous devez générer une clé API sur l'interface, pour cela cliquez sur le bouton Configuration en haut à droite.

Dans l'onglet API Keys, cliquez sur New puis Simple Key (Recommended):

Entrez une description, puis cliquez sur Create:

Copiez bien la private key, car il se ne sera pas possible de la récupérer ensuite:

Déroulé

Vous avez la possibilité d'utiliser l'interface Swagger de la VSPC pour explorer les possibilités via l'API.

Rendez vous sur Swagger.

Cliquez sur Authorize puis entrez bearer <votrecléapi>:

Vous êtes maintenant authentifié et vous pouvez tester les différentes requêtes possibles:

Python

Ci dessous un exemple en python pour télécharger le management agent de votre company sur une machine Linux.

N'oubliez pas de remplacer <votrecléapi>:

import requests
import json

url = f"https://veeam.ikoula.com/api/v3"
token = "<votrecléapi>"
headers = {"Content-Type": "application/json", "Authorization": "Bearer " + token}

get_company_uuid = f"{url}/organizations/companies"
response = requests.get(get_company_uuid, headers=headers, verify=True)
values = json.loads(response.content)
test = values['data'][0]['instanceUid']

call = f"{url}/infrastructure/managementAgents/packages/linux?organizationUid={test}"
response = requests.get(call, headers=headers, verify=True)
open("management_agent.sh", "wb").write(response.content)

cURL

Un exemple via cURL pour lister les backup agents actives de votre company:

N'oubliez pas de remplacer <votrecléapi>:

curl -sqX GET "https://veeam.ikoula.com/api/v3/infrastructure/backupAgents?filter=%5B%7B%22property%22%3A%22status%22%2C%22operation%22%3A%22equals%22%2C%22collation%22%3A%22ignorecase%22%2C%22value%22%3A%22active%22%7D%5D&limit=100&offset=0" -H "accept: application/json" -H "Authorization: bearer <votrecléapi>"

PHP

Un exemple via PHP pour lister les backup policies Windows de votre company:

N'oubliez pas de remplacer <votrecléapi>:

$httpType = "POST";

$url = "https://veeam.ikoula.com/api/v3/configuration/backupPolicies/windows";

$params = [];

 

$client = new \GuzzleHttp\Client();

$response = $client->request($httpType, $url, [

                            'headers' => ['Authorization' => '<votrecléapi>', 'Content-type' => 'application/json'],

                           \GuzzleHttp\RequestOptions::JSON => $params

                        ],

                    );

 

if(in_array($response->getStatusCode(), [200, 202]))

{

    $data = json_decode($response->getBody(), true);

}

else

    echo ("HTTP CODE ERROR: ".$response->getStatusCode());

A noter, l'utlisation de Guzzle, mais il est aussi possible de les faire avec cURL en PHP.

Conclusion

Vous pourrez retrouver d'autres articles sur Veeam dans notre catégorie Veeam

Cet article vous a semblé utile ?

0

Voter

Trier par date Trier par pointage

Activer l'actualisation automatique des commentaires

Vous n'êtes pas autorisé à publier de commentaire.