Agent Deployment Scripts

Generate Agent Deployment Scripts

post/agentdeploymentscripts

Generate agent deployment scripts by platform.

Related SDK Methods:
Java

AgentDeploymentScriptsApi.generateAgentDeploymentScript([param1, param2, ...])
Python

AgentDeploymentScriptsApi.generate_agent_deployment_script([param1, param2, ...])
JavaScript

AgentDeploymentScriptsApi.generateAgentDeploymentScript([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key
Request
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

The platform type and activation details for the agent.

activationRequired
boolean

Activate the agent at startup.

computerGroupID
integer <int32>

ID of the computer group to which the computer belongs.

dsmProxyID
integer <int32>

ID of the proxy server for contacting Deep Security Manager.

dsmProxyIsSG
boolean

True if the specified proxy server is Service Gateway.

platform
string

Platform type for agent deployment.

Enum: "linux" "windows" "solaris" "aix" "openshift" "macos"
policyID
integer <int32>

ID of the policy assigned to the computer.

relayGroupID
integer <int32>

ID of the relay group to which the computer belongs.

relayProxyID
integer <int32>

ID of the proxy server for contacting Relay(s).

relayProxyIsSG
boolean

True if the specified relay proxy server is Service Gateway.

validateCertificateRequired
boolean

Validate if Deep Security Manager is using a valid TLS certificate from a trusted certificate authority (CA) when downloading the agent software.

validateDigitalSignatureRequired
boolean

Validate digital signature of Deep Security Agent installer.

Responses
200

successful operation

403

Not authorized to retrieve agent deployment scripts.

Request samples
application/json
{
  • "platform": "linux",
  • "validateCertificateRequired": true,
  • "validateDigitalSignatureRequired": true,
  • "activationRequired": true,
  • "dsmProxyID": 0,
  • "dsmProxyIsSG": true,
  • "relayProxyID": 0,
  • "relayProxyIsSG": true,
  • "policyID": 0,
  • "relayGroupID": 0,
  • "computerGroupID": 0
}
Response samples
application/json
{
  • "platform": "linux",
  • "validateCertificateRequired": true,
  • "validateDigitalSignatureRequired": true,
  • "activationRequired": true,
  • "dsmProxyID": 0,
  • "dsmProxyIsSG": true,
  • "relayProxyID": 0,
  • "relayProxyIsSG": true,
  • "policyID": 0,
  • "relayGroupID": 0,
  • "computerGroupID": 0,
  • "scriptBody": "string"
}
➔ Next to Agent Scan Controls