MS agents

MS agents API overview

The MS agents API allows integrators to manage Microsoft directory discovery agents and related discovery tasks within SCM.

The API supports the following actions:

  • Retrieving MS agents
  • Creating MS agents
  • Updating MS agents
  • Deleting MS agents that participate in directory-based certificate discovery

MS agents API endpoints

The following table lists the endpoints for managing MS agents.
Click any action in the first column to open its API reference page.

ActionMethodPathDescription
Get MS agent detailsGET/api/agent/v1/ms/{id}Retrieve configuration and status information for a specific MS agent.
Update MS agent detailsPUT/api/agent/v1/ms/{id}Update configuration details for an MS agent.
Delete MS agentDELETE/api/agent/v1/ms/{id}Delete an MS agent.
List MS agentsGET/api/agent/v1/msList all MS agents registered in the system.
Add MS agentPOST/api/agent/v1/msCreate a new MS agent.