TechIDManager’s REST API lets you dynamically retrieve agent binaries and metadata — including the latest agent releases — which you can use for automated deployments and scripting. This guide walks you through how that works, where to find the documentation, and which URLs matter most—so you can automate agent deployment with confidence.
Why This Matters
Enables you to pull the latest agent version automatically:
- Saves time when deploying or updating agents across many clients
- Avoids hard-coding version URLs in scripts
- Enables integration with RMM tools, CI/CD pipelines, or custom automation logic
Whether you’re installing agents manually or orchestrating large deployments, knowing these REST API endpoints unlocks powerful automation options.
What You’ll Learn
- Where to find TechIDManager’s REST API documentation
- How agent releases are initiated through the API
- How to retrieve metadata about an agent version
- How to download the latest TechID Agent using a stable URL
- Why understanding this API unlocks more automation power
Prerequisites
- An active TechIDManager tenant
- Access to the TechIDManager portal
- A basic understanding of REST APIs (helpful, but not required)
|
1
|
Understand Where the REST API Lives TechIDManager publishes a full Swagger specification for its REST API documentation. Navigate to the Swagger UI for your installation to explore all available endpoints: |
|||||||||||
|
2
|
Identify Your Server Hostname All REST API paths shown in Swagger are the second half of the full URL. The base hostname comes from your own TechIDManager installation. To find your server address:
You’ll use that host in all the REST URLs below. |
|||||||||||
|
3
|
Retrieve Version Metadata (JSON) To get details about a specific agent build (version numbers, SHA-256 hash, release type, and download URLs): Example: TechIDAgent for Windows (metadata) This returns JSON with fields including:
This is useful for auditing, verification, and automation logic that selects specific builds. |
|||||||||||
|
4
|
Download the Latest Agent Build To get the latest stable agent binary — without needing to know the version number — use the latest files endpoint. Latest binary (Windows example): This URL:
You can swap out TechIDAgent and Windows for other products/platforms (e.g., macOS agents or TechIDClient) using the same pattern. |
|||||||||||
|
5
|
Quick Reference (TL;DR) | |||||||||||
(Always replace <your-host> with your TechIDManager server hostname.) |
||||||||||||
|
6
|
Next Steps & Automation Ideas Once you understand how these REST endpoints work, you can:
|
|||||||||||
Key Notes
- The URLs shown in Swagger represent the second half of the request. The server hostname is specific to your TechIDManager deployment.
- TechIDManager’s Swagger documentation shows many more endpoints you can call with proper authentication to automate tasks beyond agent downloads.
TL;DR (Quick Reference)
- Latest agent binary:
/release/files/latest/TechIDAgent/Windows - Agent metadata (JSON):
/release/TechIDAgent/Windows - API documentation:
https://chdoc.ruffiansoftware.com/swagger
(Replace the hostname with your own TechIDManager server address.)
Go Further with the REST API
The Swagger documentation includes many additional endpoints that—when used with proper authentication—allow you to automate actions across TechIDManager.
You’ll also find real-world REST API examples in the TechIDManager How-To Guides.
Remember: The URLs shown in Swagger represent the second half of the request. The server hostname is specific to your TechIDManager deployment.
Happy automating!
Support
If you have questions or need help implementing any of this, reach out to our team at support@techidmanager.com
