SDK Reference
Node.js / TypeScript: Agents
Overview
List enabled catalog agents and query execution agent fleet status for orchestration scripts.
Use labels and capabilities filters to verify policy targeting before dispatching jobs.
Who should read this
- QA engineers, SREs, platform teams, and developers operating Zof Console and APIs.
Prerequisites
- Node.js / TypeScript runtime installed
- Organization API key
When to use this workflow
- Fleet health checks before large suite dispatch
- Automation verifying agent labels match environment
Step-by-step procedure
List fleet
client.agents.list({ status: "online" }) for capacity check.
Inspect capabilities and labels on each agent.
Target execution
Confirm policy allows agents for selected environment.
Use Agent Console for endpoint agent troubleshooting.
Key concepts
- Organization scope
- All Zof Console and API operations are isolated to your authenticated tenant.
- Governed execution
- Agent output and remediation follow policy packs with human approval when configured.
Best practices
- Filter by labels matching environment tags
- Alert when online count drops below minimum
Example
const agents = await client.agents.list({ status: 'online' });Was this page helpful?
