This documentation does not describe all available APIs. It focuses on the most useful ones.
Currently, it is only possible to use Python code to interact with the an API.
Most of the available APIs can be found in the server.py file located at /opt/wapt/waptserver/server.py on Debian.
Additional APIs are available in other files such as enterprise.py, repositories.py, wads.py, etc.
Warning
Since version 2.5, most API URLs are protected with SSL client certificates. Therefore, it is no longer possible to use HTML requests like: https://admin:MYPASSWORD@srvwapt.mydomain.lan/api/v1/hosts.
1- Create a WAPT user and assign the ACL “launch requests” (It is recommended to create a new user for requests because the password is included in the request).
In the waptconsole : Go to Tools > Manage Wapt users and rights.
New account > F2 name like reporting.
Change User password on Wapt server (an key appear on the right on your reporting user in the red on the picture below).
Click on “Run Reports” ACL ( in green in the picture below).
2- Depending on the request, it may be necessary to add ACLs on the reporting user. This can be see in the request file You can see this in the request in the api source file.
The Command-Line Method involves executing API requests directly from the command line interface (CLI) using tools like cmd on Windows or bash on Unix-based systems.
This method is quick and efficient for simple or one-off requests.
The Script-Based Method requires creating a Python script (.py file) to define and execute the API request.
This method is more flexible and powerful, allowing for complex logic, error handling, and data processing.
Connect to a WAPT Windows agent.
Create a directory named waptdev at the root of your disk, like, c:\waptdev\API_request.
Create a .py file in this directory to edit the request, like, api-1.py.
Copy the python script below and personalize the password for your user “reporting” and the desired API.
Run the file with the following command: “C:\Program Files (x86)\wapt\wapt-get.exe” c:\waptdev\API_request\api-1.py.
The output can be displayed in CSV format: cat api-1.csv.
Connect to a WAPT Linux agent.
Create a directory named waptdev at the root of your disk, like, /wapdev/.
Create a .py file in this directory to edit the request, like, api-1.py.
Copy the python script below and personalize the password for your user “reporting” and the desired API.
Run the file with the following command: /opt/wapt/wapt-get.bin /wapdev/api-1.py.
The output can be displayed in CSV format: cat api-1.csv.
Connect to a WAPT Linux agent.
Create a directory named waptdev at the root of your disk, like, /wapdev/.
Create a .py file in this directory to edit the request, like, api-1.py.
Copy the python script below and personalize the password for your user “reporting” and the desired API.
Run the file with the following command: /opt/wapt/wapt-get.bin /wapdev/api-1.py.
The output can be displayed in CSV format: cat api-1.csv.
The python script
importjsonimportwaptlicencesimportcsvimportsyssys.path.append('/opt/wapt')fromcommonimportWaptWAPT=Wapt()ini_wapt_path=WAPT.config_filenameuser="reporting"password="[Enter the password for user reporting]"defrun_report():auth_context=waptlicences.waptserver_login(ini_wapt_path,user=user,password=password)try:res=waptlicences.waptserver_request(ini_wapt_path,action='[enter the desired api like /api/v1/hosts]',auth_context=auth_context)ifres['http_status']==200:data=json.loads(res['content'])['result']# Debugging: Print the raw data received from the APIprint("Raw data from API:",json.dumps(data,indent=2))# Check if data is not emptyifnotdata:print("No data received from the API.")return[]# Check if the first element of data is a listifisinstance(data[0],list):forrowindata:# Assuming row is a list of stringsfori,valueinenumerate(row):ifisinstance(value,list):row[i]='|'.join(value)withopen('test.csv','w',newline='',encoding='utf-8')ascsvfile:fieldnames=data[0]writer=csv.writer(csvfile,delimiter=';')writer.writerow(fieldnames)writer.writerows(data[1:])# Write the rest of the dataelse:print("Unexpected data format. First element is not a list.")return[]returndataelse:raiseException('Request failed with status %s : %s'%(res['http_status'],res['content']))finally:waptlicences.waptserver_logout(ini_wapt_path)# Call the function and print the returned datadata=run_report()print(repr(data))
Here is a python script that executes a query with a specific id from WAPT Console Reporting tab. In this script, user “reporting” should have “Run reports” ACL.
It works on every platform (windows, linux and mac agents).
