Get - Miru

GET

/

api_keys

/

{api_key_id}

Get

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

import requests

url = "https://api.mirurobotics.com/beta/api_keys/{api_key_id}"

headers = {
    "Miru-Version": "<miru-version>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.mirurobotics.com/beta/api_keys/{api_key_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/api_keys/{api_key_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/api_keys/{api_key_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))

}

require 'uri'
require 'net/http'

url = URI("https://api.mirurobotics.com/beta/api_keys/{api_key_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": "api_key",
  "id": "api_key_123",
  "name": "My CI/CD Key",
  "description": "CI token for the staging deploy pipeline",
  "scopes": [
    "devices:read",
    "deployments:read"
  ],
  "last_used_at": "2021-01-01T00:00:00Z",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z",
  "deleted_at": null,
  "created_by_id": "usr_123"
}

Scope	Required
`api_keys: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-11-04.everglades"

Path Parameters

api_key_id

string

required

The unique identifier of the API key.

Example:

"api_key_123"

Response

200 - application/json

Successfully retrieved the API key.

object

enum<string>

required

The object type, which is always api_key.

Available options:

api_key

Example:

"api_key"

id

string

required

ID of the API key. Attribution fields such as created_by_id on other resources hold this ID when the API key performed the action.

Example:

"api_key_123"

name

string

required

Name of the API key.

Example:

"My CI/CD Key"

description

string | null

required

A free-form description of the API key.

Example:

"CI token for the staging deploy pipeline"

scopes

string[]

required

Slugs of the scopes granted to the API key.

Example:

["devices:read", "deployments:read"]

last_used_at

string<date-time> | null

required

Timestamp of when the API key last successfully authenticated a request. Null if the API key has never been used.

Example:

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

created_at

string<date-time>

required

Timestamp of when the API key was created.

Example:

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

updated_at

string<date-time>

required

Timestamp of when the API key was last updated.

Example:

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

deleted_at

string<date-time> | null

required

Timestamp of when the API key was deleted. Null if the API key is active. A deleted API key can no longer authenticate requests.

Example:

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

created_by_id

string

required

ID of the user who created the API key.

Example:

"usr_123"

⌘I

Get

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

import requests

url = "https://api.mirurobotics.com/beta/api_keys/{api_key_id}"

headers = {
    "Miru-Version": "<miru-version>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.mirurobotics.com/beta/api_keys/{api_key_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/api_keys/{api_key_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/api_keys/{api_key_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))

}

require 'uri'
require 'net/http'

url = URI("https://api.mirurobotics.com/beta/api_keys/{api_key_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": "api_key",
  "id": "api_key_123",
  "name": "My CI/CD Key",
  "description": "CI token for the staging deploy pipeline",
  "scopes": [
    "devices:read",
    "deployments:read"
  ],
  "last_used_at": "2021-01-01T00:00:00Z",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z",
  "deleted_at": null,
  "created_by_id": "usr_123"
}