Skip to main content
GET
Platform Status

Description

Tells you whether Hyperstack is up. It works without an API key. If you send an API key, the response also has your organization’s name and credit balance. This endpoint accepts GET only.

Headers

string
Optional. Your API key: Bearer YOUR_API_KEY. Create a key in the Studio under Settings → Developers.

Response Fields

string
"live" when Hyperstack is up.
string
A short status message, such as "Hyperstack is live and running.".
object
Reserved. Empty for now.
These fields are only in the response when you send an API key:
boolean
true when the key is valid.
string
The display name of your organization.
string
Your organization’s unique ID (its URL slug).
number
How many credits your organization has left.
boolean
true when you can issue credentials now. When it is false, issuing returns 402 with the error code low_balance.

Responses

Last modified on October 20, 2026