Agent releases
The agent build to install: where to download each installer, how to check it, and the command that installs it.
AgentRelease object
The SparkLogs Agent build a workspace's update ring publishes now, with its installers and their install commands. During a staged rollout, it is the build being rolled out.
ringone of the values belowThe workspace's update ring, whose release this is.
canarySparkLogs engineering's quality assurance ring.early_accessEach version as soon as it is released.stableEach version after Early Access.
targetone of the values belowThe platform the installers are for.
windows_x86_64Windows on x64.
versionstringThe agent version.
publisherstringThe signer of both installers' Authenticode signature. Check it and the file's sha256 before running an installer.
installersarray of AgentInstallerThe EXE, then the MSI.
Read the agent release
/workspaces/{workspace_id}/agent-release Returns the SparkLogs Agent build the workspace's update ring publishes now, which during a staged rollout is the build being rolled out: its version, the EXE and MSI with each file's URL, SHA-256 and size, the signer of their Authenticode signature, and a silent install command for each. Answered only once SparkLogs' signature on the release verifies. The commands hold placeholders, never a secret: reveal-registration-token reads the token.
- Request
- Response
- curl
- PowerShell
- Python
curl -X GET \ "https://engine.sparklogs.app/app-api/workspaces/5e1f0a00-0000-4000-8000-000000000001/agent-release" \ -H "Authorization: Bearer $SPARKLOGS_TOKEN"Invoke-RestMethod -Method Get ` -Uri "https://engine.sparklogs.app/app-api/workspaces/5e1f0a00-0000-4000-8000-000000000001/agent-release" ` -Headers @{ Authorization = "Bearer $env:SPARKLOGS_TOKEN" }import os import requests response = requests.get( "https://engine.sparklogs.app/app-api/workspaces/5e1f0a00-0000-4000-8000-000000000001/agent-release" , headers={"Authorization": f"Bearer {os.environ['SPARKLOGS_TOKEN']}"},)response.raise_for_status(){ "agent_release": { "ring": "early_access", "target": "windows_x86_64", "version": "1.14.15", "publisher": "IT Lightning, LLC", "installers": [ { "kind": "exe", "file_name": "SparkLogsAgentSetup-x64-1.14.15.exe", "url": "https://cdn.sparklogs.app/agent/data/1.14.15/windows_x86_64/sha256_5e1fa9e75e1fa9e75e1fa9e75e1fa9e75e1fa9e75e1fa9e75e1fa9e75e1fa9e7/SparkLogsAgentSetup-x64-1.14.15.exe", "sha256": "5e1fa9e75e1fa9e75e1fa9e75e1fa9e75e1fa9e75e1fa9e75e1fa9e75e1fa9e7", "size_bytes": 15556216, "command": "SparkLogsAgentSetup-x64-1.14.15.exe /qn /norestart EULA=ACCEPT REGISTRATION_TOKEN=\"<REGISTRATION_TOKEN>\" RMMCLIENTID=\"<RMMCLIENTID>\" PSACLIENTID=\"<PSACLIENTID>\" CLIENTNAME=\"<CLIENTNAME>\" RMMDEVICEID=\"<RMMDEVICEID>\" PSADEVICEID=\"<PSADEVICEID>\"" }, { "kind": "msi", "file_name": "SparkLogsAgent-x64-1.14.15.msi", "url": "https://cdn.sparklogs.app/agent/data/1.14.15/windows_x86_64/sha256_a9e75e1fa9e75e1fa9e75e1fa9e75e1fa9e75e1fa9e75e1fa9e75e1fa9e75e1f/SparkLogsAgent-x64-1.14.15.msi", "sha256": "a9e75e1fa9e75e1fa9e75e1fa9e75e1fa9e75e1fa9e75e1fa9e75e1fa9e75e1f", "size_bytes": 19189760, "command": "msiexec /i SparkLogsAgent-x64-1.14.15.msi /qn /norestart EULA=ACCEPT REGISTRATION_TOKEN=\"<REGISTRATION_TOKEN>\" RMMCLIENTID=\"<RMMCLIENTID>\" PSACLIENTID=\"<PSACLIENTID>\" CLIENTNAME=\"<CLIENTNAME>\" RMMDEVICEID=\"<RMMDEVICEID>\" PSADEVICEID=\"<PSADEVICEID>\" /l*v %TEMP%\\SparkLogsAgent-install.log" } ] }, "message": "agent release retrieved"}Access
- Works with
- Signed-in person, Personal token, OAuth token, Workspace token
- Scope
workspace:read- Privilege
workspace.read
Needs workspace.read. Any grant in the workspace carries workspace.read.
Behavior
- Retry
- Safe to send again
Path parameters
workspace_id uuidrequiredThe workspace's id.
Query parameters
fieldsarray of stringComma-separated top-level fields of each object to return instead of the default set.
Sent by default: ringtargetversionpublisherinstallers
Response 200
The agent release.
messagestringrequiredWhat the call did, as a short phrase for a person to read. Its wording may change: act on the HTTP status.
Errors
400APP_API_ERR_BAD_PARAMETERS A query parameter it does not take, one given twice, or fields naming a field it does not have.No403APP_API_ERR_NO_PRIVILEGE token_scopeno_privilegeYou do not hold workspace.read. The same refusal comes when the path names a workspace other than the token's own.No404APP_API_ERR_RECORD_NOT_FOUND No build is published for the workspace's update ring.No502APP_API_ERR_AGENT_RELEASE_UNAVAILABLE The release could not be read, or its signature did not verify.After Retry-After503APP_API_ERR_NOT_CONFIGURED This server is not configured to read agent releases.After Retry-AfterPlus the errors every call can return.