Utiliser l’API du serveur WAPT

Note

Cette documentation ne décrit pas toutes les APIs disponibles, mais va cependant se concentrer sur les plus utiles.

Toutes les URLs dispnibles peuvent être trouvées dans /opt/wapt/waptserver/server.py.

Les URLs sont formées en utilisant la bonne commande depuis le serveur WAPT ex: https://srvwapt/command_path.

Indication

Cette documentation contient des exemples en code Python ou bien en curl.

API V1

/api/v1/hosts

  • récupérer les données enregistrées d’un ou de plusieurs postes:

    # Args:
    #     has_errors (0/1): filter out hosts with packages errors
    #     need_upgrade (0/1): filter out hosts with outdated packages
    #     groups (csvlist of packages) : hosts with packages
    #     columns (csvlist of columns) :
    #     uuid (csvlist of uuid): <uuid1[,uuid2,...]>): filter based on uuid
    #     filter (csvlist of field):regular expression: filter based on attributes
    #     not_filter (0,1):
    #     limit (int) : 1000
    #     trusted_certs_sha256 (csvlist): filter out machines based on their trusted package certs
    
    # Returns:
    #     result (dict): {'records':[],'files':[]}
    #     query:
    #       uuid=<uuid>
    #     or
    #       filter=<csvlist of fields>:regular expression
    # """
    
  • liste tous les postes. Les paramètres disponibles sont;

    • reachable
    • computer_fqdn ==> computer_name
    • connected_ips
    • mac_addresses

    Cette exemple montre une requête avec des paramètres:

    advanced_hosts_wapt = wgets('https://%s:%s@%s/api/v1/hosts?columns=reachable,computer_fqdn,connected_ips,mac_addresses&limit=10000' % (wapt_user,wapt_password,wapt_url))
    parsed = json.loads(advanced_hosts_wapt)
    print(json.dumps(parsed, indent=1, sort_keys=True))
    

    Cette exemple est une requête globale:

    hosts_wapt = wgets('https://%s:%s@%s/api/v1/hosts' % (wapt_user,wapt_password,wapt_url))
    parsed = json.loads(hosts_wapt)
    print(json.dumps(parsed, indent=1, sort_keys=True))
    

    Indication

    Voici le même exemple avec une simple requête html:

    https://admin:MYPASSWORD@srvwapt/api/v1/hosts
    

    Ceui-ci donne une requête avec un statut joignable, le nom nom du poste, ses ip connectées et ses adresses mac. On n’affiche dans la limite de 10000 postes

    https://admin:MYPASSWORD@srvwapt/api/v1/hosts?columns=reachable,computer_fqdn,connected_ips,mac_addresses&limit=10000
    

/api/v1/groups

  • récupère tous les paquets groupes. Les groupes peuvent être trouvés avec la section groupe dans le paquet.

    group_wapt = wgets('https://%s:%s@%s/api/v1/groups' % (wapt_user,wapt_password,wapt_url))
    parsed = json.loads(group_wapt)
    print(json.dumps(parsed, indent=1, sort_keys=True))
    

    Indication

    Voici le même exemple avec une simple requête html:

    https://admin:MYPASSWORD@srvwapt/api/v1/groups
    

/api/v1/host_data

dmi

  • récupère toutes informations DMI d’un poste:

Note

# # Récupère des données supplémentaires d’un poste # query: # uuid=<uuid> # field=packages, dmi ou softwares

Exemple: récupérer les informations dmi du poste ayant l’UUID 14F620FF-DE70-9E5B-996A-B597E8F9B4AD: https://srvwapt.ad.mydomain.fr/api/v1/host_data?uuid=14F620FF-DE70-9E5B-996A-B597E8F9B4AD&field=dmi

Note

le dmi n’est pas la seule option disponible. Vous pouvez aussi chercher des informations en utilisant installed_packages, wsusupdates ou installed_softwares.

dmi_host_data_wapt = wgets('https://%s:%s@%s/api/v1/host_data?uuid=14F620FF-DE70-9E5B-996A-B597E8F9B4AD&field=dmi' % (wapt_user,wapt_password,wapt_url))
#print(dmi_host_data_wapt)
parsed = json.loads(dmi_host_data_wapt)
print(json.dumps(parsed, indent=1, sort_keys=True))

Indication

Voici le même exemple avec une simple requête html:

https://admin:MYPASSWORD@srvwapt/api/v1/host_data?uuid=14F620FF-DE70-9E5B-996A-B597E8F9B4AD&field=dmi

installed_packages

L’option installed_packages va lister tous les paquets installés sur un poste en particulier.

install_packages_data_wapt = wgets('https://%s:%s@%s/api/v1/host_data?uuid=14F620FF-DE70-9E5B-996A-B597E8F9B4AD&field=installed_packages' % (wapt_user,wapt_password,wapt_url))
parsed = json.loads(install_packages_data_wapt)
print(json.dumps(parsed, indent=1, sort_keys=True))

Indication

Voici le même exemple avec une simple requête html:

https://admin:MYPASSWORD@srvwapt/api/v1/host_data?uuid=14F620FF-DE70-9E5B-996A-B597E8F9B4AD&field=installed_packages

installed_softwares

L’option installed_softwares va lister tous les logiciels installés sur un poste en particulier.

install_softwares_data_wapt = wgets('https://%s:%s@%s/api/v1/host_data?uuid=14F620FF-DE70-9E5B-996A-B597E8F9B4AD&field=installed_softwares' % (wapt_user,wapt_password,wapt_url))
#print(install_softwares_data_wapt)
parsed = json.loads(install_softwares_data_wapt)
print(json.dumps(parsed, indent=1, sort_keys=True))

Indication

Voici le même exemple avec une simple requête html:

https://admin:MYPASSWORD@srvwapt/api/v1/host_data?uuid=14F620FF-DE70-9E5B-996A-B597E8F9B4AD&field=installed_softwares

wsusupdates

L’option wsusupdates va lister toutes les mises à jour installés sur un poste en particulier.

wsusupdates_data_wapt = wgets('https://%s:%s@%s/api/v1/host_data?uuid=14F620FF-DE70-9E5B-996A-B597E8F9B4AD&field=wsusupdates' % (wapt_user,wapt_password,wapt_url))
#print(wsusupdates_data_wapt)
parsed = json.loads(wsusupdates_data_wapt)
print(json.dumps(parsed, indent=1, sort_keys=True))

Indication

Voici le même exemple avec une simple requête html:

https://admin:MYPASSWORD@srvwapt/api/v1/host_data?uuid=14F620FF-DE70-9E5B-996A-B597E8F9B4AD&field=wsusupdates

/api/v1/usage_statistics

Récupère les statistiques d’usage du serveur.

Indication

Cette API est utile si vous avez plusieurs serveurs WAPT et si vous voulez savoir combien de postes il y a.

usage_statistics_wapt =  wgets('https://%s:%s@%s/api/v1/usage_statistics' % (wapt_user,wapt_password,wapt_url))
#print(usage_statistics_wapt)
parsed = json.loads(usage_statistics_wapt)
print(json.dumps(parsed, indent=1, sort_keys=True))

Indication

Voici le même exemple avec une simple requête html:

https://admin:MYPASSWORD@srvwapt/api/v1/usage_statistics

API V2

/api/v2/waptagent_version

Affiche la version du waptagent.exe sur le serveur.

waptagent_version =  wgets('https://%s:%s@%s/api/v2/waptagent_version' % (wapt_user,wapt_password,wapt_url))
parsed = json.loads(waptagent_version)
print(json.dumps(parsed, indent=1, sort_keys=True))

Indication

Voici le même exemple avec une simple requête html:
https://admin:MYPASSWORD@srvwapt/api/v2/waptagent_version

API V3

/api/v3/packages

Liste les paquets sur le dépôt privé, il récupère le fichier control sur les paquets.

packages_wapt =  wgets('https://%s:%s@%s/api/v3/packages' % (wapt_user,wapt_password,wapt_url))
parsed = json.loads(packages_wapt)
print(json.dumps(parsed, indent=1, sort_keys=True))

Indication

Voici le même exemple avec une simple requête html:

https://admin:MYPASSWORD@srvwapt/api/v3/packages

/api/v3/known_packages

Liste tous les paquets avec l’infirmation signed_on.

known_packages_wapt =  wgets('https://%s:%s@%s/api/v3/known_packages' % (wapt_user,wapt_password,wapt_url))
parsed = json.loads(known_packages_wapt)
print(json.dumps(parsed, indent=1, sort_keys=True))

Indication

Voici le même exemple avec une simple requête html:

https://admin:MYPASSWORD@srvwapt/api/v3/known_packages

/api/v3/trigger_cancel_task

Annule une tâche en cours.

trigger_cancel_task =  wgets('https://%s:%s@%s/api/v3/trigger_cancel_task' % (wapt_user,wapt_password,wapt_url))
parsed = json.loads(trigger_cancel_task)
print(json.dumps(parsed, indent=1, sort_keys=True))

/api/v3/get_ad_ou

Liste les OU vues par les postes et affichées dans la console WAPT.

get_ad_ou =  wgets('https://%s:%s@%s/api/v3/get_ad_ou' % (wapt_user,wapt_password,wapt_url))
parsed = json.loads(get_ad_ou)
print(json.dumps(parsed, indent=1, sort_keys=True))

Indication

Voici le même exemple avec une simple requête html:

https://admin:MYPASSWORD@srvwapt/api/v3/get_ad_ou

/api/v3/get_ad_sites

Liste les sites Active Directory

get_ad_sites =  wgets('https://%s:%s@%s/api/v3/get_ad_sites' % (wapt_user,wapt_password,wapt_url))
parsed = json.loads(get_ad_sites)
print(json.dumps(parsed, indent=1, sort_keys=True))

Indication

Voici le même exemple avec une simple requête html:

https://admin:MYPASSWORD@srvwapt/api/v3/get_ad_sites

/api/v3/hosts_for_package

Liste les postes qui ont un paquet spécifique d’installé https://srvwapt.ad.domain.fr/api/v3/hosts_for_package?package=demo-nompaquet

hosts_for_package =  wgets('https://%s:%s@%s/api/v3/hosts_for_package?package=demo-namepackage' % (wapt_user,wapt_password,wapt_url))
parsed = json.loads(hosts_for_package)
print(json.dumps(parsed, indent=1, sort_keys=True))

Indication

Voici le même exemple avec une simple requête html:

https://admin:MYPASSWORD@srvwapt/api/v3/hosts_for_package?package=demo-namepackage

/api/v3/host_tasks_status

Liste les tâches d’un poste en particulier.

Exemple avec l’uuid d’un poste: https://srvwapt.ad.domain.fr/api/v3/host_tasks_status?uuid=14F620FF-DE70-9E5B-996A-B597E8F9B4AD

host_tasks_status =  wgets('https://%s:%s@%s/api/v3/host_tasks_status?uuid=14F620FF-DE70-9E5B-996A-B597E8F9B4AD' % (wapt_user,wapt_password,wapt_url))
parsed = json.loads(host_tasks_status)
print(json.dumps(parsed, indent=1, sort_keys=True))

Indication

Voici le même exemple avec une simple requête html:

https://admin:MYPASSWORD@srvwapt/api/v3/host_tasks_status?uuid=14F620FF-DE70-9E5B-996A-B597E8F9B4AD

Attention

Les prochaines API suivent la méthode POST.

/api/v3/upload_packages

À faire

Tests

/api/v3/upload_hosts

À faire

Tests

/api/v3/change_password

Change le mot de passe du compte admin [ce compte uniquement]. La requête doit être un dictionnaire python {}. Les clés doivent être:

  • user
  • password
  • new_password
curl --insecure -X POST --data-raw '{"user":"admin","password":"OLDPASSWORD","new_password":"NEWPASSWORD"}' -H "Content-Type: application/json" "https://admin:OLDPASSWORD@srvwapt/api/v3/change_password"

/api/v3/login

Initialiser une connexion au serveur.

curl --insecure -X POST --data-raw '{"user":"admin","password":"MYPASSWORD"}' -H "Content-Type: application/json" "https://srvwapt/api/v3/login"

{"msg": "Authentication OK", "result": {"edition": "enterprise", "hosts_count": 6, "version": "1.7.4", "server_domain": "ad.domain.fr", "server_uuid": "32464dd6-c261-11e8-87be-cee799b43a00"}, "success": true, "request_time": 0.03377699851989746}

Indication

Nous pouvons faire une connexion avec un formulaire html plutôt que POST: https://admin:MYPASSWORD@srvwapt/api/v3/get_ad_sites

/api/v3/packages_delete

Supprime un paquet d’une version précise. La requête doit être une liste []. Elle peut prendre plusieurs paquets séparés par des virgules ,.

Exemple:

curl --insecure -X POST --data-raw '["demo-libreoffice-stable_5.4.6.2-3_all.wapt"]' -H "Content-Type: application/json" "https://admin:MYPASSWORD@srvwapt/api/v3/packages_delete"

/api/v3/reset_hosts_sid

Il y a plusieurs possiblités : https://srvwapt.ad.domain.fr/api/v3/reset_hosts_sid va réinitialiser toutesles connexions des postes.

Pour la méthode POST:

la syntaxe est : --data-raw : un dictionnaire avec pour clé uuids et pour valeur l’uuid du poste

curl --insecure -X POST --data-raw '{"uuids":["114F620FF-DE70-9E5B-996A-B597E8F9B4C"]}' -H "Content-Type: application/json" "https://admin:MUPASSWORD@srvwapt/api/v3/reset_hosts_sid"

{"msg": "Hosts connection reset launched for 1 host(s)", "result": {}, "success": true, "request_time": null}[

Indication

Si vous voulez plusieurs postes:

curl --insecure -X POST --data-raw '{"uuids":["114F620FF-DE70-9E5B-996A-B597E8F9B4C","04F98281-7D37-B35D-8803-8577E0049D15"]}' -H "Content-Type: application/json" "https://admin:MYPASSWORD@srvwapt/api/v3/reset_hosts_sid"

{"msg": "Hosts connection reset launched for 2 host(s)", "result": {}, "success": true, "request_time": null}

/api/v3/trigger_wakeonlan

Si les postes ont le WakeOnLan d’activé, cette API est utile.

la syntaxe est : --data-raw : un dictionnaire avec pour clé uuids et pour valeur une liste d’uuid de postes

curl --insecure -X POST --data-raw '{"uuids":["04F98281-7D37-B35D-8803-8577E0049D15"]}' -H "Content-Type: application/json" "https://admin:MYPASSWORD@srvwapt/api/v3/trigger_wakeonlan"

{"msg": "Wakeonlan packets sent to 1 machines.", "result": [{"computer_fqdn": "win10-1809.ad.domain.fr", "mac_addresses": ["7e:c4:f4:9a:87:2d"], "uuid": "04F98281-7D37-B35D-8803-8577E0049D15"}], "success": true, "request_time": null}

Indication

Si vous voulez plusieurs postes:

curl --insecure -X POST --data-raw '{"uuids":["04F98281-7D37-B35D-8803-8577E0049D15","14F620FF-DE70-9E5B-996A-B597E8F9B4AD"]}' -H "Content-Type: application/json" "https://admin:MYPASSWORD@srvwapt/api/v3/trigger_wakeonlan"

{"msg": "Wakeonlan packets sent to 2 machines.", "result": [{"computer_fqdn": "win10-1803.ad.domain.fr", "mac_addresses": ["02:4f:25:74:67:71"], "uuid": "14F620FF-DE70-9E5B-996A-B597E8F9B4AD"}, {"computer_fqdn": "win10-1809.ad.alejeune.fr", "mac_addresses": ["7e:c4:f4:9a:87:2d"], "uuid": "04F98281-7D37-B35D-8803-8577E0049D15"}], "success": true, "request_time": null}

/api/v3/hosts_delete

"""Remove one or several hosts from Server DB and optionnally the host packages

Args:
    uuids (list) : list of uuids to delete
    filter (csvlist of field:regular expression): filter based on attributes
    delete_packages (bool) : delete host's packages
    delete_inventory (bool) : delete host's inventory

Returns:
    result (dict):
"""

Si vous voulez supprimer un poste de l’inventaire:

curl --insecure -X POST --data-raw '{"uuids":["04F98281-7D37-B35D-8803-8577E0049D15"],"delete_inventory":"True","delete_packages":"True"}' -H "Content-Type: application/json" "https://admin:MYPASSWORD@srvwapt/api/v3/hosts_delete"

{"msg": "1 files removed from host repository\n1 hosts removed from DB", "result": {"files": ["/var/www/wapt-host/04F98281-7D37-B35D-8803-8577E0049D15.wapt"], "records": [{"computer_fqdn": "win10-1809.ad.domain.fr", "uuid": "04F98281-7D37-B35D-8803-8577E0049D15"}]}, "success": true, "request_time": null}

Si vous ne voulez pas le supprimer de l’inventaire du serveur:

curl --insecure -X POST --data-raw '{"uuids":["04F98281-7D37-B35D-8803-8577E0049D15"],"delete_inventory":"False","delete_packages":"False"}' -H "Content-Type: application/json" "https://admin:MYPASSWORD@srvwapt/api/v3/hosts_delete"

{"msg": "0 files removed from host repository\n1 hosts removed from DB", "result": {"files": [], "records": [{"computer_fqdn": "win10-1809.ad.domain.fr", "uuid": "04F98281-7D37-B35D-8803-8577E0049D15"}]}, "success": true, "request_time": null}

/api/v3/trigger_host_action

À faire

Tests

/upload_waptsetup

# Upload waptsetup

#Handle the upload of customized waptagent.exe into wapt repository

### NE MARCHE PAS
#curl --insecure -X POST -H  "Content-Type: multipart/form-data" -F 'data=@waptagent.exe' "https://admin:MYPASSWORD@srvwapt/upload_waptsetup"

/ping

Ping va récupérer les informations générales d’un serveur WAPT.

# https://srvwapt.ad.domain.fr/ping
# Liste les infos du serveur

ping_wapt =  wgets('https://%s:%s@%s/ping' % (wapt_user,wapt_password,wapt_url))
parsed = json.loads(ping_wapt)
print(json.dumps(parsed, indent=1, sort_keys=True))