Skip to main content
GET
curl (Linux)

Authorizations

Authorization
string
header
required

The token from the agent's discovery file. Required over loopback TCP; not used over the Unix socket.

Path Parameters

release_id
string
required

The unique identifier of the release.

Example:

"rls_123"

Response

200 - application/json

Successfully retrieved the release.

object
enum<string>
required

The object type, which is always release.

Available options:
release
Example:

"release"

id
string
required

ID of the release.

Example:

"rls_123"

version
string
required

The version of the release.

Example:

"v1.0.0"

git_commit_id
string | null
required

The ID of the git commit associated with this release.

Example:

"git_commit_123"

file_rule_ids
string[]
required

IDs of the file rules included in this release. Retrieve each file rule with GET /file_rules/{file_rule_id}.

Example:
os
enum<string>
required

The operating system family this release targets, derived from its config schemas and file rules, which must all agree. A release with neither is linux. Read-only: clients cannot set it.

Available options:
linux,
windows
Example:

"linux"

created_at
string<date-time>
required

Timestamp of when the release was created.

Example:

"2024-01-01T00:00:00Z"

Last modified on October 9, 2026