Note: Our APIs referenced in this guide are only available from Faddom version 2025.2 and above
β
Overview
The Faddom REST API provides programmatic access to your Faddom data, enabling integration with external monitoring systems, automation workflows, and custom reporting tools.
What You Can Do With the API
The Faddom API allows you to:
Query server inventory - Search and retrieve detailed server information, including hardware specs, operating systems, and custom tags
Analyze network connections - Access connection data between servers, ports, and protocols
Integrate monitoring events - Push external events from monitoring systems (Zabbix, Nagios, PRTG, SolarWinds etc) into Faddom
Access cloud and virtualization data - Retrieve tags and metadata from AWS, Azure, GCP, VMware, Nutanix, and Hyper-V
Authentication
All API requests require Bearer token authentication. You can see how to get this in our guide Creating an API Token:
Authorization: Bearer <your_access_token>
Interactive API Documentation
For complete API reference documentation, example requests, and the ability to test endpoints directly, you can access the Swagger UI using
βhttps:/<FaddomServerIpAddress>/WebServices/api/swagger-ui/index.html#/
The Swagger interface provides:
Full endpoint documentation with parameters and response schemas
Interactive request builder to test API calls
Example request/response payloads
Authentication setup and testing
How To Use the API
Obtain an API access token from your Faddom administrator
Review the Swagger documentation for endpoint details
Test your first API call using the interactive Swagger UI
Integrate the API into your automation workflows or monitoring systems
If you have any questions or need help with API integration, please contact support@faddom.com.
