Download agent for Windows

This endpoint is used to download the agent for Windows resources.

Leave Feedback

URL

GET https://{api-url}/tenants/{clientId}/agents/windows

Sample URLs

To download the Windows agent directly:

https://{api-url}/api/v2/tenants/client_93/agents/windows

To download the Windows agent through the gateway:

https://{api-url}/api/v2/tenants/client_93/agents/windows?profileId=10

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"
}