Admin
Get system status
Check this API instance and the services it uses: version, uptime, database, WebSockets, Redis fan-out, SMTP, object storage, sign-in providers and integration providers. Each check gives up after a few seconds, so one unreachable service can’t block the response. Only statuses, counts and short error categories are returned, never hosts, credentials or secrets. Requires the system:read instance permission; API keys are rejected.
GET
/
admin
/
system
Get system status
curl --request GET \
--url https://cloud.kaneo.app/api/admin/system \
--header 'Authorization: Bearer <token>'import requests
url = "https://cloud.kaneo.app/api/admin/system"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://cloud.kaneo.app/api/admin/system', 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://cloud.kaneo.app/api/admin/system",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://cloud.kaneo.app/api/admin/system"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://cloud.kaneo.app/api/admin/system")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.kaneo.app/api/admin/system")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"checkedAt": "2023-11-07T05:31:56Z",
"version": "<string>",
"api": {
"status": "ok",
"uptimeSeconds": 123,
"nodeVersion": "<string>"
},
"database": {
"status": "ok",
"serverVersion": "<string>",
"latencyMs": 123,
"migrationsApplied": 123,
"errorCode": "<string>"
},
"realtime": {
"status": "ok",
"adapter": "in-memory",
"connections": 123,
"connectedUsers": 123
},
"redis": {
"status": "ok",
"mode": "standalone",
"errorCode": "<string>"
},
"email": {
"status": "ok",
"configured": true,
"errorCode": "<string>"
},
"storage": {
"status": "ok",
"configured": true,
"errorCode": "<string>"
},
"auth": {
"passwordSignIn": true,
"emailOtpSignIn": true,
"registration": true,
"passwordRegistration": true,
"guestAccess": true,
"workspaceCreation": true,
"providers": [
{
"id": "github",
"name": "<string>",
"status": "ok"
}
]
},
"integrations": [
{
"type": "<string>",
"name": "<string>",
"status": "ok",
"requiresInstanceSetup": true,
"connectedProjects": 123
}
]
}{
"message": "Task not found",
"code": "NOT_FOUND",
"issues": [
{
"path": "body.title",
"message": "Required"
}
],
"missingPermissions": [
"task:update"
]
}{
"message": "Task not found",
"code": "NOT_FOUND",
"issues": [
{
"path": "body.title",
"message": "Required"
}
],
"missingPermissions": [
"task:update"
]
}{
"message": "Task not found",
"code": "NOT_FOUND",
"issues": [
{
"path": "body.title",
"message": "Required"
}
],
"missingPermissions": [
"task:update"
]
}Response
Status of this instance
Was this page helpful?
⌘I
Get system status
curl --request GET \
--url https://cloud.kaneo.app/api/admin/system \
--header 'Authorization: Bearer <token>'import requests
url = "https://cloud.kaneo.app/api/admin/system"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://cloud.kaneo.app/api/admin/system', 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://cloud.kaneo.app/api/admin/system",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://cloud.kaneo.app/api/admin/system"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://cloud.kaneo.app/api/admin/system")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.kaneo.app/api/admin/system")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"checkedAt": "2023-11-07T05:31:56Z",
"version": "<string>",
"api": {
"status": "ok",
"uptimeSeconds": 123,
"nodeVersion": "<string>"
},
"database": {
"status": "ok",
"serverVersion": "<string>",
"latencyMs": 123,
"migrationsApplied": 123,
"errorCode": "<string>"
},
"realtime": {
"status": "ok",
"adapter": "in-memory",
"connections": 123,
"connectedUsers": 123
},
"redis": {
"status": "ok",
"mode": "standalone",
"errorCode": "<string>"
},
"email": {
"status": "ok",
"configured": true,
"errorCode": "<string>"
},
"storage": {
"status": "ok",
"configured": true,
"errorCode": "<string>"
},
"auth": {
"passwordSignIn": true,
"emailOtpSignIn": true,
"registration": true,
"passwordRegistration": true,
"guestAccess": true,
"workspaceCreation": true,
"providers": [
{
"id": "github",
"name": "<string>",
"status": "ok"
}
]
},
"integrations": [
{
"type": "<string>",
"name": "<string>",
"status": "ok",
"requiresInstanceSetup": true,
"connectedProjects": 123
}
]
}{
"message": "Task not found",
"code": "NOT_FOUND",
"issues": [
{
"path": "body.title",
"message": "Required"
}
],
"missingPermissions": [
"task:update"
]
}{
"message": "Task not found",
"code": "NOT_FOUND",
"issues": [
{
"path": "body.title",
"message": "Required"
}
],
"missingPermissions": [
"task:update"
]
}{
"message": "Task not found",
"code": "NOT_FOUND",
"issues": [
{
"path": "body.title",
"message": "Required"
}
],
"missingPermissions": [
"task:update"
]
}