Platform Status
curl --request GET \
--url https://api.thehyperstack.com/v1/infoimport requests
url = "https://api.thehyperstack.com/v1/info"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.thehyperstack.com/v1/info', 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.thehyperstack.com/v1/info",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.thehyperstack.com/v1/info"
req, _ := http.NewRequest("GET", url, nil)
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.thehyperstack.com/v1/info")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.thehyperstack.com/v1/info")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"status": "live",
"message": "Hyperstack is live and running.",
"applications": {}
}
{
"status": "live",
"message": "Hyperstack is live and running.",
"applications": {},
"success": true,
"account_name": "Acme Academy",
"account_id": "acme-academy",
"credit_balance": 1250,
"has_sufficient_credits": true
}
{
"status": "live",
"message": "Hyperstack is live and running.",
"applications": {},
"success": false,
"error": "Invalid token or organization not found",
"error_code": "invalid_token"
}
API Guide
Platform Status
GET
/
v1
/
info
Platform Status
curl --request GET \
--url https://api.thehyperstack.com/v1/infoimport requests
url = "https://api.thehyperstack.com/v1/info"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.thehyperstack.com/v1/info', 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.thehyperstack.com/v1/info",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.thehyperstack.com/v1/info"
req, _ := http.NewRequest("GET", url, nil)
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.thehyperstack.com/v1/info")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.thehyperstack.com/v1/info")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"status": "live",
"message": "Hyperstack is live and running.",
"applications": {}
}
{
"status": "live",
"message": "Hyperstack is live and running.",
"applications": {},
"success": true,
"account_name": "Acme Academy",
"account_id": "acme-academy",
"credit_balance": 1250,
"has_sufficient_credits": true
}
{
"status": "live",
"message": "Hyperstack is live and running.",
"applications": {},
"success": false,
"error": "Invalid token or organization not found",
"error_code": "invalid_token"
}
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 acceptsGET 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.
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
{
"status": "live",
"message": "Hyperstack is live and running.",
"applications": {}
}
{
"status": "live",
"message": "Hyperstack is live and running.",
"applications": {},
"success": true,
"account_name": "Acme Academy",
"account_id": "acme-academy",
"credit_balance": 1250,
"has_sufficient_credits": true
}
{
"status": "live",
"message": "Hyperstack is live and running.",
"applications": {},
"success": false,
"error": "Invalid token or organization not found",
"error_code": "invalid_token"
}
curl "https://api.thehyperstack.com/v1/info" \
-H "Authorization: Bearer YOUR_API_KEY"
Last modified on October 20, 2026
Was this page helpful?

