Service Ping

GET /schema

Service Ping

cURL

curl --request GET \
  --url https://deployments.sourcebot.dev/schema

import requests

url = "https://deployments.sourcebot.dev/schema"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://deployments.sourcebot.dev/schema', 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://deployments.sourcebot.dev/schema",
  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://deployments.sourcebot.dev/schema"

	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://deployments.sourcebot.dev/schema")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://deployments.sourcebot.dev/schema")

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

No sensitive data (source code, AI inputs/outputs, credentials, user information, etc) is ever transmitted.

By default, all Sourcebot deployments will send a Service Ping, which is an HTTPS encrypted ping to https://deployments.sourcebot.dev/ping at port 443, every 24 hours.

The data contained within the Service Ping is limited to:

Field	Type	Description
installId	string	Random UUID generated for your deployment.
hostname	string	Hostname of your Sourcebot deployment.
version	string	Sourcebot version (e.g. v5.3.0).
userCount	integer	Total registered users.
repoCount	integer	Total indexed repositories.
dauCount	integer	Daily active users.
wauCount	integer	Weekly active users.
mauCount	integer	Monthly active users.
deploymentType	string	Deployment flavor (e.g. docker, helm).
isTelemetryEnabled	boolean	Whether anonymous product telemetry is enabled.
isLanguageModelConfigured	boolean	Whether at least one language model is configured.
activationCode	string	Activation code, if your instance has one bound.
systemInfo	object	Resource facts about the deployment (CPU, memory, disk). See below.

The systemInfo object contains a best-effort snapshot of the resources the deployment is running with. It is used to diagnose resource issues (e.g. insufficient RAM). Any field that cannot be read is reported as null.

Field	Type	Description
platform	string	Operating system platform (e.g. linux).
arch	string	CPU architecture (e.g. x64, arm64).
cpuQuota	number | null	Effective cgroup CPU limit in cores, or null if unlimited.
memoryLimitMiB	number | null	cgroup memory limit in MiB, or null if unlimited.
memoryUsedMiB	number | null	Current cgroup memory usage, in MiB.
diskTotalMiB	number | null	Total disk space for the data volume, in MiB.
diskFreeMiB	number | null	Free disk space for the data volume, in MiB.

You can fetch the schema for the Service Ping by submitting a GET request to https://deployments.sourcebot.dev/schema

Example Service Ping

{
  "method": "POST",
  "url": "http://localhost:3003/ping",
  "path": "/ping",
  "headers": {
    "accept": "*/*",
    "accept-encoding": "gzip, deflate",
    "accept-language": "*",
    "connection": "keep-alive",
    "content-length": "253",
    "content-type": "application/json",
    "host": "localhost:3003",
    "sec-fetch-mode": "cors",
    "user-agent": "node"
  },
  "query": {}
}
body: {
  "installId": "524a8f59-90aa-480d-a571-92dd8bzzzzze",
  "version": "v4.17.2",
  "userCount": 1,
  "repoCount": 3,
  "dauCount": 1,
  "wauCount": 1,
  "mauCount": 1,
  "deploymentType": "other",
  "isTelemetryEnabled": true,
  "isLanguageModelConfigured": true,
  "systemInfo": {
    "platform": "linux",
    "arch": "x64",
    "cpuQuota": 4,
    "memoryLimitMiB": 8192,
    "memoryUsedMiB": 3072,
    "diskTotalMiB": 102400,
    "diskFreeMiB": 54968
  },
  "activationCode": "sb_act_3a925f51...."
}