Check service health

GET

health

curl --request GET \
  --url https://{host}/v1/health

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/v1/health",
  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}/v1/health"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/v1/health")

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

{
  "ok": true,
  "timestamp": 1759834200000,
  "version": "2.14.0",
  "api_version": 6,
  "started_at": 1759830000000,
  "command_outbox_pending": 0,
  "command_outbox_failed": 0,
  "inbound_dedup_count": 412
}

{
  "ok": false,
  "error": "Internal server error",
  "code": "internal_error"
}

Response

Success.

enum<boolean>

required

Always true on success.

Available options:

true

timestamp

number

Server time (epoch milliseconds).

version

string

CliqHub Core version.

api_version

integer

API version; clients compare it to what they support.

started_at

number

When this CliqHub process started (epoch milliseconds).

command_outbox_pending

integer

Commands waiting to be delivered to daemons.

command_outbox_failed

integer

Commands that gave up.

inbound_dedup_count

integer

Requests remembered for de-duplication.

Check service health

curl --request GET \
  --url https://{host}/v1/health

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/v1/health",
  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}/v1/health"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/v1/health")

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

{
  "ok": true,
  "timestamp": 1759834200000,
  "version": "2.14.0",
  "api_version": 6,
  "started_at": 1759830000000,
  "command_outbox_pending": 0,
  "command_outbox_failed": 0,
  "inbound_dedup_count": 412
}

{
  "ok": false,
  "error": "Internal server error",
  "code": "internal_error"
}

Introduction

System

Auth

Users

Organizations

Invitations

Teams

Realms

Daemons

Workspaces

Runs

Artifacts

Events

Reviews

Notification channels

Notifications

Agents

Settings

Mesh

Jira

A2A

Check service health

Response