curl --request GET \
--url https://api.orbital-systems.com/client/showers/{id}/installation \
--header 'x-api-key: <api-key>'import requests
url = "https://api.orbital-systems.com/client/showers/{id}/installation"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.orbital-systems.com/client/showers/{id}/installation', 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.orbital-systems.com/client/showers/{id}/installation",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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.orbital-systems.com/client/showers/{id}/installation"
req, _ := http.NewRequest("GET", url, nil)
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.orbital-systems.com/client/showers/{id}/installation")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbital-systems.com/client/showers/{id}/installation")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d",
"timestamp": "2026-03-14T10:06:31.000Z",
"shower_id": "0b7a6c1e-5f2d-4c3b-8a9e-1d2f3a4b5c6d",
"test_id": "7a6b5c4d-3e2f-4a1b-9c8d-7e6f5a4b3c2d",
"description": "Test initiated successfully",
"included_tests": 14,
"current_test": "Initiating test",
"next_test": null,
"pass": true,
"status": "in progress",
"test_data": [],
"version": 2,
"created_at": "2026-03-14T09:12:44.000Z",
"updated_at": "2026-10-28T17:03:10.000Z"
}
]{
"message": "No test results were found",
"statusCode": 404,
"name": "NotFoundError"
}{
"message": "Internal server error"
}Get installation test
curl --request GET \
--url https://api.orbital-systems.com/client/showers/{id}/installation \
--header 'x-api-key: <api-key>'import requests
url = "https://api.orbital-systems.com/client/showers/{id}/installation"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.orbital-systems.com/client/showers/{id}/installation', 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.orbital-systems.com/client/showers/{id}/installation",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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.orbital-systems.com/client/showers/{id}/installation"
req, _ := http.NewRequest("GET", url, nil)
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.orbital-systems.com/client/showers/{id}/installation")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbital-systems.com/client/showers/{id}/installation")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d",
"timestamp": "2026-03-14T10:06:31.000Z",
"shower_id": "0b7a6c1e-5f2d-4c3b-8a9e-1d2f3a4b5c6d",
"test_id": "7a6b5c4d-3e2f-4a1b-9c8d-7e6f5a4b3c2d",
"description": "Test initiated successfully",
"included_tests": 14,
"current_test": "Initiating test",
"next_test": null,
"pass": true,
"status": "in progress",
"test_data": [],
"version": 2,
"created_at": "2026-03-14T09:12:44.000Z",
"updated_at": "2026-10-28T17:03:10.000Z"
}
]{
"message": "No test results were found",
"statusCode": 404,
"name": "NotFoundError"
}{
"message": "Internal server error"
}Authorizations
Send your API key in the x-api-key header of every request. The key belongs to one Orbital account, and requests act as that account: they see and control only the devices it owns or has been given access to. A missing or unknown key gets 403 with { "message": "Forbidden" }.
Path Parameters
The shower ID
Response
Success
ID of the test run.
"9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d"
When the shower reported this result (ISO 8601).
"2026-03-14T10:06:31.000Z"
ID of the shower.
"0b7a6c1e-5f2d-4c3b-8a9e-1d2f3a4b5c6d"
ID of the installation test that was run.
"7a6b5c4d-3e2f-4a1b-9c8d-7e6f5a4b3c2d"
Result or error message.
"Test initiated successfully"
Number of checks in the test.
14
Check running when the result was reported.
"Initiating test"
Check that runs next. null when none.
null
Whether the test passed.
true
Progress: start, in progress, done or aborted.
"in progress"
Results of the checks run so far.
[]
Version of the test.
2
When the record was created (ISO 8601).
"2026-03-14T09:12:44.000Z"
When the record was last changed (ISO 8601).
"2026-10-28T17:03:10.000Z"
Was this page helpful?