Skip to main content
GET
Get installation test

Authorizations

x-api-key
string
header
required

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

id
string
required

The shower ID

Response

Success

id
string<uuid>

ID of the test run.

Example:

"9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d"

timestamp
string

When the shower reported this result (ISO 8601).

Example:

"2026-03-14T10:06:31.000Z"

shower_id
string<uuid>

ID of the shower.

Example:

"0b7a6c1e-5f2d-4c3b-8a9e-1d2f3a4b5c6d"

test_id
string<uuid>

ID of the installation test that was run.

Example:

"7a6b5c4d-3e2f-4a1b-9c8d-7e6f5a4b3c2d"

description
string | null

Result or error message.

Example:

"Test initiated successfully"

included_tests
number

Number of checks in the test.

Example:

14

current_test
string | null

Check running when the result was reported.

Example:

"Initiating test"

next_test
string | null

Check that runs next. null when none.

Example:

null

pass
boolean

Whether the test passed.

Example:

true

status
string

Progress: start, in progress, done or aborted.

Example:

"in progress"

test_data
any[]

Results of the checks run so far.

Example:
version
number

Version of the test.

Example:

2

created_at
string

When the record was created (ISO 8601).

Example:

"2026-03-14T09:12:44.000Z"

updated_at
string

When the record was last changed (ISO 8601).

Example:

"2026-10-28T17:03:10.000Z"