Security Controls REST API

Home 

Agents

Agents are installed on distinct physical and online virtual machines and have the ability to independently initiate specific actions. With the Agents functions you can:

Delete an agent from a machine

Query for information about current agent installations

Assign a different policy to an agent

Base URL

        https://<consoleFQDN:port>/st/console/api/v1.0/agents

Supported Requests

Method URL Input Return

DELETE

https://<consoleFQDN:port>/st/console/api/v1.0/agents/{agentId}

Request Body

Success code

GET

https://<consoleFQDN:port>/st/console/api/v1.0/agents

URL Parameters

AgentDetail

https://<consoleFQDN:port>/st/console/api/v1.0/agents/{agent ID}

 

AgentDetail

https://<consoleFQDN:port>/st/console/api/v1.0/agents/{agent ID}/status

 

AgentStatus

PUT

https://<consoleFQDN:port>/st/console/api/v1.0/agents/{agentId}/policy

Request Body Success code

Input Models

Example with Sample Response

Find all agent installations

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/agents

Sample Response

{

"count": 1,

"links": {

"next": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/agents?start=2"

}

},

"value": [

{

"agentId": "D0C5F75A80FFD5DEA9A2073A2202FF890C2B6223",

"assignedPolicyId": "c09064c8-3825-4bcb-8dae-16c71e6bc986",

"dnsName": "device-name.fakedomain.com",

"domain": "FAKE",

"frameworkVersion": "9.5.3677.0",

"isListening": true,

"lastCheckIn": "2019-09-25T19:39:57.17",

"links": {

"self": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/agents/D0C5F75A80FFD5DEA9A2073A2202FF890C2B6223"

},

"status": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/agents/D0C5F75A80FFD5DEA9A2073A2202FF890C2B6223/status"

},

"checkin": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/agenttasks/D0C5F75A80FFD5DEA9A2073A2202FF890C2B6223/checkin"

},

"tasks": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/agenttasks/D0C5F75A80FFD5DEA9A2073A2202FF890C2B6223/tasks"

},

"queuedTasks": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/agenttasks/D0C5F75A80FFD5DEA9A2073A2202FF890C2B6223/queuedTask"

}

},

"listeningPort": 4155,

"machineName": "device-name",

"reportedPolicyId": "c09064c8-3825-4bcb-8dae-16c71e6bc986",

"status": "Installed"

}

]

}

Other Request Examples

Output Models


Was this article useful?    

The topic was:

Inaccurate

Incomplete

Not what I expected

Other