Security Controls REST API

Home 

Agent Tasks

An agent task defines how and when a certain operation will be performed on an agent machine. An agent policy can contain several type of tasks, including check-in tasks, patch tasks, asset tasks and power tasks.

Base URL

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

Supported Requests

Method URL Input Return

DELETE

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

 

Success code

GET

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

  AgentPolicyTask

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

 

ExecutedTask

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

 

QueuedTask

POST

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

  Success code

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

 

ExecutedTask

Input Model

None

Example with Sample Response

Find all tasks associated with agent ID A1A2A3A4B1B2B3B4C1C2C3C4D1D2D3D4E1E2E3E4

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/agenttasks/A1A2A3A4B1B2B3B4C1C2C3C4D1D2D3D4E1E2E3E4/tasks

Sample Response

{

"count": 4,

"value": [

{

"agentId": "A1A2A3A4B1B2B3B4C1C2C3C4D1D2D3D4E1E2E3E4",

"links": {

"self": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/agenttasks/A1A2A3A4B1B2B3B4C1C2C3C4D1D2D3D4E1E2E3E4/tasks/f9cac0bc-20ba-41f8-b1ac-d347cd8dee21"

}

},

"taskId": "f9cac0bc-20ba-41f8-b1ac-d347cd8dee21",

"taskName": "Update Binaries",

"taskType": "None"

},

{

"agentId": "A1A2A3A4B1B2B3B4C1C2C3C4D1D2D3D4E1E2E3E4",

"links": {

"self": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/agenttasks/A1A2A3A4B1B2B3B4C1C2C3C4D1D2D3D4E1E2E3E4/tasks/d939fb15-e5e0-402a-b169-b3b4e8de781a"

}

},

"taskId": "d939fb15-e5e0-402a-b169-b3b4e8de781a",

"taskName": "Update Patch Data",

"taskType": "None"

},

{

"agentId": "A1A2A3A4B1B2B3B4C1C2C3C4D1D2D3D4E1E2E3E4",

"links": {

"self": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/agenttasks/A1A2A3A4B1B2B3B4C1C2C3C4D1D2D3D4E1E2E3E4/tasks/d006644d-e16f-4036-a5f2-99aa04f65d3a"

}

},

"taskId": "d006644d-e16f-4036-a5f2-99aa04f65d3a",

"taskName": "Clear Retry Counts",

"taskType": "None"

},

{

"agentId": "D0C5F75A80FFD5DEA9A2073A2202FF890C2B6223",

"links": {

"self": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/agenttasks/D0C5F75A80FFD5DEA9A2073A2202FF890C2B6223/tasks/026aa493-b898-4748-b800-ad5609496b23"

}

},

"taskId": "026aa493-b898-4748-b800-ad5609496b23",

"taskName": "WinTask1",

"taskType": "Patch"

}

]

}

Other Request Examples

Output Models


Was this article useful?    

The topic was:

Inaccurate

Incomplete

Not what I expected

Other