Get deployment facts
curl --request GET \
--url https://api.onecli.sh/v1/instanceimport requests
url = "https://api.onecli.sh/v1/instance"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.onecli.sh/v1/instance', 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://api.onecli.sh/v1/instance",
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://api.onecli.sh/v1/instance"
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://api.onecli.sh/v1/instance")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onecli.sh/v1/instance")
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{
"edition": "cloud",
"entitled": true,
"version": "<string>",
"runners": {
"registered": true,
"online": true,
"homeDurability": "<string>"
},
"origins": {
"external": "<string>",
"api": "<string>",
"gateway": "<string>",
"mode": "<string>"
},
"ssh": {
"host": "<string>",
"port": 123
}
}Instance
Get deployment edition and settings
Returns deployment facts with no authentication: the edition, whether Enterprise features are on, public origins, hosted-agent availability, and SSH access.
GET
/
instance
Get deployment facts
curl --request GET \
--url https://api.onecli.sh/v1/instanceimport requests
url = "https://api.onecli.sh/v1/instance"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.onecli.sh/v1/instance', 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://api.onecli.sh/v1/instance",
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://api.onecli.sh/v1/instance"
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://api.onecli.sh/v1/instance")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onecli.sh/v1/instance")
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{
"edition": "cloud",
"entitled": true,
"version": "<string>",
"runners": {
"registered": true,
"online": true,
"homeDurability": "<string>"
},
"origins": {
"external": "<string>",
"api": "<string>",
"gateway": "<string>",
"mode": "<string>"
},
"ssh": {
"host": "<string>",
"port": 123
}
}Returns facts about the deployment, never data. Use it to detect which features a deployment offers. See Editions.
The edition, whether Enterprise features are enabled, the public origins, hosted-agent availability, and the SSH front door. Posture only, never data. No authentication.
Availability: Cloud · Community (self-hosted) · Enterprise (self-hosted)
Response
200 - application/json
Instance facts
Available options:
cloud, onprem Whether Enterprise features are enabled on this deployment (always true on Cloud).
Hosted-agent availability.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Present when the SSH front door is configured.
Show child attributes
Show child attributes