Skip to main content

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 below

The workspace's update ring, whose release this is.

  • canary SparkLogs engineering's quality assurance ring.
  • early_access Each version as soon as it is released.
  • stable Each version after Early Access.
targetone of the values below

The platform the installers are for.

  • windows_x86_64 Windows on x64.
versionstring

The agent version.

publisherstring

The signer of both installers' Authenticode signature. Check it and the file's sha256 before running an installer.

installersarray of AgentInstaller

The EXE, then the MSI.

Read the agent release​

GET/workspaces/{workspace_id}/agent-release
Preview

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.

curl -X GET \  "https://engine.sparklogs.app/app-api/workspaces/5e1f0a00-0000-4000-8000-000000000001/agent-release" \  -H "Authorization: Bearer $SPARKLOGS_TOKEN"

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_iduuidrequired

The workspace's id.

Query parameters

fieldsarray of string

Comma-separated top-level fields of each object to return instead of the default set.

Sent by default: ringtargetversionpublisherinstallers

Response 200

agent_releaseAgentReleaserequired

The agent release.

messagestringrequired

What the call did, as a short phrase for a person to read. Its wording may change: act on the HTTP status.

Errors

StatusCodeWhenSend again?
400APP_API_ERR_BAD_PARAMETERSA query parameter it does not take, one given twice, or fields naming a field it does not have.No
403APP_API_ERR_NO_PRIVILEGEtoken_scopeno_privilegeYou do not hold workspace.read. The same refusal comes when the path names a workspace other than the token's own.No
404APP_API_ERR_RECORD_NOT_FOUNDNo build is published for the workspace's update ring.No
502APP_API_ERR_AGENT_RELEASE_UNAVAILABLEThe release could not be read, or its signature did not verify.After Retry-After
503APP_API_ERR_NOT_CONFIGUREDThis server is not configured to read agent releases.After Retry-After

Plus the errors every call can return.