Network agents

Network agents API overview

The Network agents API allows integrators to manage network discovery agents, servers, and nodes used for discovery tasks within SCM.

The API supports the following actions:

Retrieving agent details
Updating agent details
Managing associated servers
Retrieving node information

Network agents API endpoints

The following tables list the endpoints for managing network agents, their servers, and nodes.
Click any action in the first column to open its API reference page.

1. Network agents

Action	Method	Path	Description
Get network agent details	GET	`/api/agent/v1/network/{id}`	Retrieve details of a specific network agent.
Update network agent details	PUT	`/api/agent/v1/network/{id}`	Update configuration details for a network agent.
Delete network agent	DELETE	`/api/agent/v1/network/{id}`	Delete a network agent.
List network agents	GET	`/api/agent/v1/network`	List all network agents.
Add network agent	POST	`/api/agent/v1/network`	Create a new network agent.

2. Servers

Action	Method	Path	Description
List servers	GET	`/api/agent/v1/network/{agentId}/server`	List servers associated with network agents.
Add a server	POST	`/api/agent/v1/network/{agentId}/server`	Create a new server entry for a network agent.
Get server details	GET	`/api/agent/v1/network/{agentId}/server/{id}`	Retrieve details for a specific server.
Update server details	PUT	`/api/agent/v1/network/{agentId}/server/{id}`	Update server configuration information.
Delete a server	DELETE	`/api/agent/v1/network/{agentId}/server/{id}`	Delete a server.

3. Nodes

Action	Method	Path	Description
List nodes	GET	`/api/agent/v1/network/{agentId}/server/{serverId}/node`	List nodes discovered by network agents.
Get node details	GET	`/api/agent/v1/network/{agentId}/server/{serverId}/node/{id}`	Retrieve details of a specific discovery node.