Get

GET

releases

{release_id}

Python

import os
from miru_platform_sdk import Miru

client = Miru(
    api_key=os.environ.get("MIRU_API_KEY"),  # This is the default and can be omitted
)
release = client.releases.retrieve(
    release_id="rls_123",
)
print(release.id)

curl --request GET \
  --url https://api.mirurobotics.com/beta/releases/{release_id} \
  --header 'Miru-Version: <miru-version>' \
  --header 'X-API-Key: <api-key>'

const options = {
  method: 'GET',
  headers: {'Miru-Version': '<miru-version>', 'X-API-Key': '<api-key>'}
};

fetch('https://api.mirurobotics.com/beta/releases/{release_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mirurobotics.com/beta/releases/{release_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Miru-Version: <miru-version>",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mirurobotics.com/beta/releases/{release_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Miru-Version", "<miru-version>")
	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.mirurobotics.com/beta/releases/{release_id}")
  .header("Miru-Version", "<miru-version>")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mirurobotics.com/beta/releases/{release_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Miru-Version"] = '<miru-version>'
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "object": "release",
  "id": "rls_123",
  "version": "v1.0.0",
  "git_commit_id": "git_commit_123",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}

Scope	Required
`releases:read`	Yes

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-05-06.rainier"

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

Example:

["config_schemas"]

Response

200 - application/json

Successfully retrieved the release.

object

enum<string>

required

The object type, which is always release.

Available options:

release

Example:

"release"

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"

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"

config_schemas

Config Schema · object[]

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

Show child attributes

Example:

[
  {
    "object": "config_schema",
    "id": "cfg_sch_123",
    "digest": "sha256:1234567890",
    "config_type_name": "Motion Control",
    "instance_filepath": "/srv/miru/configs/v1/motion-control.json",
    "created_at": "2021-01-01T00:00:00Z",
    "updated_at": "2021-01-01T00:00:00Z",
    "config_type_id": "cfg_typ_123",
    "language": "jsonschema",
    "format": "json"
  },
  {
    "object": "config_schema",
    "id": "cfg_sch_124",
    "digest": "sha256:1234567890",
    "config_type_name": "Localization",
    "instance_filepath": "/srv/miru/configs/v1/localization.json",
    "created_at": "2021-01-01T00:00:00Z",
    "updated_at": "2021-01-01T00:00:00Z",
    "config_type_id": "cfg_typ_124",
    "language": "jsonschema",
    "format": "json"
  }
]

Last modified on May 27, 2026

ListList releases.

⌘I

Python

import os
from miru_platform_sdk import Miru

client = Miru(
    api_key=os.environ.get("MIRU_API_KEY"),  # This is the default and can be omitted
)
release = client.releases.retrieve(
    release_id="rls_123",
)
print(release.id)

curl --request GET \
  --url https://api.mirurobotics.com/beta/releases/{release_id} \
  --header 'Miru-Version: <miru-version>' \
  --header 'X-API-Key: <api-key>'

const options = {
  method: 'GET',
  headers: {'Miru-Version': '<miru-version>', 'X-API-Key': '<api-key>'}
};

fetch('https://api.mirurobotics.com/beta/releases/{release_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mirurobotics.com/beta/releases/{release_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Miru-Version: <miru-version>",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mirurobotics.com/beta/releases/{release_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Miru-Version", "<miru-version>")
	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.mirurobotics.com/beta/releases/{release_id}")
  .header("Miru-Version", "<miru-version>")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mirurobotics.com/beta/releases/{release_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Miru-Version"] = '<miru-version>'
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "object": "release",
  "id": "rls_123",
  "version": "v1.0.0",
  "git_commit_id": "git_commit_123",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}

Config Instances

Config Schemas

Config Types

Deployments

Devices

Provisioning Tokens

Git Commits

Principals

Releases

Authorizations

Headers

Path Parameters

Query Parameters

Response