Releases

Create

Create a new release.

post/releases

Request

Base URL
https://api.mirurobotics.com/beta
URL
https://api.mirurobotics.com/beta/releases
Auth
API key in header X-API-Key

Query parameters

expandReleaseExpansion[]

Fields to expand on the release resource.

[
  "config_schemas"
]

Request body

versionstring required

The version of the release.

descriptionstring nullable

A free-form description of the release.

config_schema_idsstring[] required

The IDs of the config schemas included in the release.

Example request

{
  "version": "v1.0.0",
  "description": "Add lidar calibration to motion control",
  "config_schema_ids": [
    "cfg_sch_123"
  ],
  "git_commit_ref": {
    "id": "git_cmt_123",
    "sha": "1a2b3c4d..."
  }
}

Response

Successfully created the release.

object'release' required

The object type, which is always release.

idstring required

ID of the release.

versionstring required

The version of the release.

descriptionstring nullable required

A free-form description of the release.

git_commit_idstring nullable required

The ID of the git commit associated with this release.

os'linux' | 'windows' required

An operating system family, from the agent's build-time OS vocabulary. Shared across resources (devices, config schemas, file rules, releases). This is the machine-readable OS kind, distinct from a human-readable version string.

linux
windows

created_atstring date-time required

Timestamp of when the release was created.

updated_atstring date-time required

Timestamp of when the release was last updated.

Example response

{
  "object": "release",
  "id": "rls_123",
  "version": "v1.0.0",
  "description": "Add lidar calibration to motion control",
  "git_commit_id": "git_commit_123",
  "os": "linux",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.