Download agent installation script for Linux

This endpoint is used to download the agent installation script for Linux resources.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/agents/deployAgentsScript

Sample URLs

To download the Linux agent to directly connect to OpsRamp:

https://{api-url}/api/v2/tenants/client_1/agents/deployAgentsScript
+

To download the Linux agent to connect through the gateway to OpsRamp:

https://{api-url}/api/v2/tenants/client_1/agents/deployAgentsScript?profileId=1

Header format

HeaderValue
AuthorizationToken {accessToken}
Content-typeapplication/json
Acceptapplication/json

Parameters

FieldDefault ValueDescription
profileIdNULL(Optional) Used by the agent to connect to OpsRamp. If a profile ID is not provided, the agent connects directly to OpsRamp.

Sample response

This returns the JSON payload containing package name, package size, package checksum, and the package S3 bucket URL to directly download the agent.

{
"name": "<package-name>",
"downloadUrl": "<direct-s3-download-url>",
"version": "<agent-version>",
"size": <size-in-bytes>,
"checksum": "<checksum>",
"generation": "G2"
}