Security Controls REST API

Home 

Agent Deployments

This function is used to deploy an agent policy to all of the machines contained in one or more machine groups.

Base URL

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

Supported Requests

Method URL Input Return

GET

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

  AgentDeploymentStatus

POST

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

Request Body

Success code

See the Deployment and Operation location links in the header

Input Model

Example with Sample Response

Queue an installation of an agent policy to all machines contained in a machine group

POST Request

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

{

"machinegroupids": [1],

"policyid": "4997c76c-3e47-4b97-bae5-265d586431e9'

}

Sample Response

Body

Status code: 202 Accepted

Headers

Contains links to track the progress of the installation. For example:

Content-Length →0

Date →Tue, 01 Oct 2019 15:55:07 GMT

Location →https://device-name.fakedomain.com:3121/st/console/api/v1.0/agents/deployment/7fdb25e5-06ea-49b2-b148-6877f641cf2e

Operation-Location →https://device-name.fakedomain.com:3121/st/console/api/v1.0/operations/7fdb25e5-06ea-49b2-b148-6877f641cf2e

Server →Microsoft-HTTPAPI/2.0

Other Request Examples

Output Models


Was this article useful?    

The topic was:

Inaccurate

Incomplete

Not what I expected

Other