Skip to main content
GET
/
serverinfo
Get Server Info
curl --request GET \
  --url https://use.hoop.dev/api/serverinfo
import requests

url = "https://use.hoop.dev/api/serverinfo"

response = requests.get(url)

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

fetch('https://use.hoop.dev/api/serverinfo', 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://use.hoop.dev/api/serverinfo",
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://use.hoop.dev/api/serverinfo"

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://use.hoop.dev/api/serverinfo")
.asString();
require 'uri'
require 'net/http'

url = URI("https://use.hoop.dev/api/serverinfo")

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
{
  "analytics_mode": "identified",
  "analytics_tracking": "enabled",
  "api_url": "https://api.johnwick.org",
  "auth_method": "local",
  "commit_sha": "e6b94e86352e934b66d9c7ab2821a267dc18dfee",
  "disable_clipboard_copy_cut": true,
  "disable_sessions_download": true,
  "feature_flags": {},
  "go_debug": "http2debug=2",
  "grpc_url": "127.0.0.1:8009",
  "has_ask_ai_credentials": true,
  "has_idp_audience": true,
  "has_idp_custom_scopes": true,
  "has_redact_credentials": true,
  "has_ssh_client_host_key": true,
  "has_webhook_app_key": true,
  "license_info": {
    "allowed_hosts": [
      "johnwick.org",
      "homolog.johnwick.org"
    ],
    "expire_at": 1722261422,
    "is_valid": true,
    "issued_at": 1722261321,
    "key_id": "f2fb0c3143822b08be26f8fc5b703e0a6689e675",
    "type": "enterprise",
    "verified_host": "homolog.johnwick.org",
    "verify_error": "unable to verify license"
  },
  "log_level": "INFO",
  "redact_provider": "gcp",
  "version": "1.35.0"
}
{
"message": "the error description"
}

Response

OK

analytics_mode
enum<string>

The analytics privacy mode for the caller's organization

Available options:
identified,
anonymous,
disabled
Example:

"identified"

analytics_tracking
enum<string>

Indicates if all tracking and analytics should be enabled or disabled. Derived from analytics_mode for backwards compatibility: "disabled" when analytics_mode is "disabled"; "enabled" otherwise.

  • enabled - Analytics/tracking are enabled
  • disabled - Analytics/tracking are disabled
Available options:
enabled,
disabled
Example:

"enabled"

api_url
string

API_URL advertise to clients

Example:

"https://api.johnwick.org"

auth_method
enum<string>

Auth method used by the server

Available options:
oidc,
local
Example:

"local"

commit_sha
string

Commit SHA of the version

Example:

"e6b94e86352e934b66d9c7ab2821a267dc18dfee"

disable_clipboard_copy_cut
boolean

Indicates if clipboard copy functionality is disabled

  • true - Clipboard copy and cut are disabled and not available to users
  • false - Clipboard copy and cut are enabled and available to users
disable_sessions_download
boolean

Indicates if session download functionality is disabled

  • true - Session download is disabled and not available to users
  • false - Session download is enabled and available to users
feature_flags
object

Effective feature flags for the caller's organization

go_debug
string

Expose GODEBUG flags enabled

Example:

"http2debug=2"

grpc_url
string

The GRPC_URL advertise to clients

Example:

"127.0.0.1:8009"

has_ask_ai_credentials
boolean

Report if ASK_AI_CREDENTIALS is set (openapi credentials)

has_idp_audience
boolean

Report if IDP_AUDIENCE env is set

has_idp_custom_scopes
boolean

Report if IDP_CUSTOM_SCOPES env is set

has_redact_credentials
boolean

Report if GOOGLE_APPLICATION_CREDENTIALS_JSON or MSPRESIDIO is set

has_ssh_client_host_key
boolean

Report if SSH_CLIENT_HOST_KEY is set

has_webhook_app_key
boolean

Report if WEBHOOK_APPKEY is set

idp_provider_name
enum<string>

The provider name identified based on the configured identity provider credentials

Available options:
microsoft-entra-id,
okta,
google,
aws-cognito,
jumpcloud,
unknown
license_info
object

License information

log_level
enum<string>

Log level of the server

Available options:
INFO,
WARN,
DEBUG,
ERROR
Example:

"INFO"

redact_provider
enum<string>

Redact Provider used by the server

Available options:
gcp,
mspresidio
Example:

"gcp"

tenancy_type
enum<string>

The tenancy type

Available options:
selfhosted,
multitenant
version
string

Version of the server

Example:

"1.35.0"