Skip to main content
POST
Archive

Authorizations

X-API-Key
string
header
required

The API key to use for authentication.

Headers

Miru-Version
string
required

The API version the client was built against.

Example:

"2026-11-04.everglades"

Path Parameters

release_id
string
required

The unique identifier of the release.

Example:

"rls_123"

Query Parameters

expand
enum<string>[]

Fields to expand on the release resource.

Available options:
config_schemas,
created_by,
archived_by
Example:

Response

200 - application/json

Successfully archived 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"

description
string | null
required

A free-form description of the release.

Example:

"Add lidar calibration to motion control"

git_commit_id
string | null
required

The ID of the git commit associated with this release.

Example:

"git_commit_123"

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"

updated_at
string<date-time>
required

Timestamp of when the release was last updated.

Example:

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

created_by_id
string
required

ID of the principal who created the release.

Example:

"usr_123"

archived_at
string<date-time> | null
required

Timestamp of when the release was archived. Null if the release is not archived.

Example:

"2021-01-01T00:00:00Z"

archived_by_id
string | null
required

ID of the principal who archived the release. Null if the release is not archived or was archived before this field was recorded.

Example:

"usr_123"

created_by
Principal · object

The principal who created the release. Expand using expand=created_by in the query string.

Example:
archived_by
Principal · object | null

The principal who archived the release. Null if archived_by_id is null. Expand using expand=archived_by in the query string.

Example:
config_schemas
Config Schema · object[]

Expand the config schemas using expand=config_schemas in the query string.

Example: