Retrieve Server Settings

Returns the server’s current in-memory settings view as the typed ServerSettings payload.

GET /api/v1/settings

Retrieve Server Settings

cURL

curl --request GET \
  --url https://api.example.com/api/v1/settings \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/api/v1/settings"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/v1/settings', 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.example.com/api/v1/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.example.com/api/v1/settings"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.example.com/api/v1/settings")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "server": {
    "listen": {
      "type": "tcp",
      "address": "<string>"
    },
    "api": {
      "url": "<string>"
    },
    "web": {
      "enabled": true,
      "url": "<string>"
    },
    "auth": {
      "methods": [],
      "github": {
        "allowed_usernames": [
          "<string>"
        ]
      }
    },
    "sandbox": {
      "providers": {
        "local": {
          "enabled": true
        },
        "docker": {
          "enabled": true
        },
        "daytona": {
          "enabled": true
        }
      }
    },
    "storage": {
      "root": "<string>"
    },
    "artifacts": {
      "prefix": "<string>",
      "store": {
        "type": "local",
        "root": "<string>"
      }
    },
    "slatedb": {
      "prefix": "<string>",
      "store": {
        "type": "local",
        "root": "<string>"
      },
      "flush_interval": "<string>",
      "disk_cache": true
    },
    "scheduler": {
      "max_concurrent_runs": 123
    },
    "logging": {
      "level": "<string>"
    },
    "integrations": {
      "github": {
        "enabled": true,
        "app_id": "<string>",
        "client_id": "<string>",
        "slug": "<string>",
        "webhooks": {}
      },
      "slack": {
        "enabled": true,
        "default_channel": "<string>"
      }
    }
  }
}

Authorizations

BearerAuthSessionCookie

Authorization · string · header · required

Raw dev token passed as Authorization: Bearer fabro_dev_... when server.auth.methods includes dev-token.

Response

200 - application/json

Server settings

Current in-memory server settings view.

server · object · required

Show child attributes