Archive
Archive a release.
Authorizations
The API key to use for authentication.
Headers
The API version the client was built against.
"2026-11-04.everglades"
Path Parameters
The unique identifier of the release.
"rls_123"
Query Parameters
Fields to expand on the release resource.
config_schemas, created_by, archived_by Response
Successfully archived the release.
The object type, which is always release.
release "release"
ID of the release.
"rls_123"
The version of the release.
"v1.0.0"
A free-form description of the release.
"Add lidar calibration to motion control"
The ID of the git commit associated with this release.
"git_commit_123"
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.
linux, windows "linux"
Timestamp of when the release was created.
"2024-01-01T00:00:00Z"
Timestamp of when the release was last updated.
"2024-01-01T00:00:00Z"
ID of the principal who created the release.
"usr_123"
Timestamp of when the release was archived. Null if the release is not archived.
"2021-01-01T00:00:00Z"
ID of the principal who archived the release. Null if the release is not archived or was archived before this field was recorded.
"usr_123"
The principal who created the release. Expand using expand=created_by in the query string.
The principal who archived the release. Null if archived_by_id is null. Expand using expand=archived_by in the query string.
Expand the config schemas using expand=config_schemas in the query string.

