MImirurobotics
Releases

Get

Changed on

Retrieve a release by its ID.

get/releases/{release_id}

Request

  • Base URL
    http://localhost/v0.2
  • URL
    http://localhost/v0.2/releases/{release_id}
  • Auth
    • none
    • or HTTP bearer

Path parameters

release_idstring required
Example:rls_123

The unique identifier of the release.

Response

Successfully retrieved 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.

git_commit_idstring nullable required

The ID of the git commit associated with this release.

file_rule_idsstring[] required

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

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.

Example response

{
  "object": "release",
  "id": "rls_123",
  "version": "v1.0.0",
  "git_commit_id": "git_commit_123",
  "file_rule_ids": [
    "file_rule_123"
  ],
  "os": "linux",
  "created_at": "2024-01-01T00:00:00Z"
}

Changes

  • 6c5a928176c5Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      removed from the response body allOf list for the response status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status