Skip to main content
GET
/
ping
Ping Kubex API subsystem
curl --request GET \
  --url https://{host}/api/ping
import requests

url = "https://{host}/api/ping"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://{host}/api/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://{host}/api/ping",
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://{host}/api/ping"

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://{host}/api/ping")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{host}/api/ping")

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
{
  "message": "ok",
  "status": 200
}
{
"message": "Timeout value valid range: 15-180",
"status": 400
}
{
"message": "<string>"
}

Query Parameters

timeout
integer
default:30

Maximum time in seconds for the server to respond before returning a timeout error. Default is 30. Valid range is 15–180.

Required range: 15 <= x <= 180

Response

Successful response; API subsystem is healthy.

status
enum<integer>
required

HTTP response code for the request.

Available options:
200,
400,
500
message
string

Detailed message for the response status.