curl --request GET \
--url https://use.hoop.dev/api/serverinfoimport 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{
"admin_role_name": "admin",
"analytics_mode": "identified",
"analytics_tracking": "enabled",
"api_url": "https://api.johnwick.org",
"application_mode": "gateway",
"approver_role_name": "approver",
"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,
"idp_provider_name": "microsoft-entra-id",
"license_info": {
"allowed_hosts": [
"johnwick.org",
"homolog.johnwick.org"
],
"expire_at": 1722261422,
"features": [
"access-control",
"provisioning-hub"
],
"is_valid": true,
"issued_at": 1722261321,
"key_id": "f2fb0c3143822b08be26f8fc5b703e0a6689e675",
"status": "valid",
"type": "enterprise",
"verified_host": "homolog.johnwick.org",
"verify_error": "unable to verify license"
},
"log_level": "INFO",
"postgres_proxy_enabled": true,
"redact_provider": "gcp",
"tenancy_type": "selfhosted",
"version": "1.35.0"
}{
"message": "the error description"
}Get Server Info
Get server information
curl --request GET \
--url https://use.hoop.dev/api/serverinfoimport 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{
"admin_role_name": "admin",
"analytics_mode": "identified",
"analytics_tracking": "enabled",
"api_url": "https://api.johnwick.org",
"application_mode": "gateway",
"approver_role_name": "approver",
"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,
"idp_provider_name": "microsoft-entra-id",
"license_info": {
"allowed_hosts": [
"johnwick.org",
"homolog.johnwick.org"
],
"expire_at": 1722261422,
"features": [
"access-control",
"provisioning-hub"
],
"is_valid": true,
"issued_at": 1722261321,
"key_id": "f2fb0c3143822b08be26f8fc5b703e0a6689e675",
"status": "valid",
"type": "enterprise",
"verified_host": "homolog.johnwick.org",
"verify_error": "unable to verify license"
},
"log_level": "INFO",
"postgres_proxy_enabled": true,
"redact_provider": "gcp",
"tenancy_type": "selfhosted",
"version": "1.35.0"
}{
"message": "the error description"
}Response
OK
Group name that carries the admin role, renamed by ADMIN_USERNAME or the auth server config
"admin"
The analytics privacy mode for the caller's organization
identified, anonymous, disabled "identified"
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
enabled, disabled "enabled"
API_URL advertise to clients
"https://api.johnwick.org"
Which component this process runs as
gateway, control-plane "gateway"
Group name that carries the approver role
"approver"
Auth method used by the server
oidc, local "local"
Commit SHA of the version
"e6b94e86352e934b66d9c7ab2821a267dc18dfee"
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
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
Effective feature flags for the caller's organization
Show child attributes
Show child attributes
Expose GODEBUG flags enabled
"http2debug=2"
The GRPC_URL advertise to clients
"127.0.0.1:8009"
Report if ASK_AI_CREDENTIALS is set (openapi credentials)
Report if IDP_AUDIENCE env is set
Report if IDP_CUSTOM_SCOPES env is set
Report if the server can enforce data masking: the credentials of the configured provider are set (GOOGLE_APPLICATION_CREDENTIALS_JSON or MSPRESIDIO), or the provider is alcatraz, which needs none
Report if SSH_CLIENT_HOST_KEY is set
Report if WEBHOOK_APPKEY is set
The provider name identified based on the configured identity provider credentials
microsoft-entra-id, okta, google, aws-cognito, jumpcloud, unknown License information
Show child attributes
Show child attributes
Log level of the server
INFO, WARN, DEBUG, ERROR "INFO"
Report if the Postgres proxy server has a listen address configured
Redact Provider configured for the server via the DLP_PROVIDER env
gcp, mspresidio, alcatraz "gcp"
The tenancy type
selfhosted, multitenant Version of the server
"1.35.0"
Was this page helpful?