Health check
curl --request GET \
--url https://api.hypermid.io/v1/ping \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hypermid.io/v1/ping"
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.hypermid.io/v1/ping', 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.hypermid.io/v1/ping",
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.hypermid.io/v1/ping"
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.hypermid.io/v1/ping")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hypermid.io/v1/ping")
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{
"data": {
"status": "ok",
"version": "1.0.0",
"timestamp": 1711234588
},
"error": null,
"meta": {
"requestId": "d0a1b2c3-d4e5-6789-3456-890123456789",
"timestamp": 1711234588,
"rateLimit": {
"limit": 2000,
"remaining": 1970,
"reset": 1711234627
}
}
}
System
Ping
Health check endpoint
GET
/
v1
/
ping
Health check
curl --request GET \
--url https://api.hypermid.io/v1/ping \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hypermid.io/v1/ping"
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.hypermid.io/v1/ping', 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.hypermid.io/v1/ping",
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.hypermid.io/v1/ping"
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.hypermid.io/v1/ping")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hypermid.io/v1/ping")
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{
"data": {
"status": "ok",
"version": "1.0.0",
"timestamp": 1711234588
},
"error": null,
"meta": {
"requestId": "d0a1b2c3-d4e5-6789-3456-890123456789",
"timestamp": 1711234588,
"rateLimit": {
"limit": 2000,
"remaining": 1970,
"reset": 1711234627
}
}
}
Simple health check endpoint to verify the API is operational. Does not require authentication.
{
"data": {
"status": "ok",
"version": "1.0.0",
"timestamp": 1711234588
},
"error": null,
"meta": {
"requestId": "d0a1b2c3-d4e5-6789-3456-890123456789",
"timestamp": 1711234588,
"rateLimit": {
"limit": 2000,
"remaining": 1970,
"reset": 1711234627
}
}
}
const ping = await client.ping();
console.log("API status:", ping.status);
console.log("Version:", ping.version);
curl https://api.hypermid.io/v1/ping
resp, _ := http.Get("https://api.hypermid.io/v1/ping")
Use this endpoint for uptime monitoring. It does not count against your rate limit when called without an API key.
Authorizations
Partner API key. Optional for public endpoints, required for /v1/partner/*.
⌘I