Sign in

v1

latestOpenAPI 3.0.12026-07-17635367.2 KB
server

Get the server configuration

Get the server configuration

get/server/config

Response

OK

apiPortinteger required
binariesPathstring required
buildImageNamespacestring
builderImagestring required
builderRegistryServerstring required
defaultProjectImagestring required
defaultProjectUserstring required
headscalePortinteger required
idstring required
localBuilderRegistryImagestring required
localBuilderRegistryPortinteger required
providersDirstring required
registryUrlstring required
samplesIndexUrlstring
serverDownloadUrlstring required

Example response

{
  "registryUrl": "registryUrl",
  "localBuilderRegistryPort": 5,
  "localBuilderRegistryImage": "localBuilderRegistryImage",
  "defaultProjectUser": "defaultProjectUser",
  "builderRegistryServer": "builderRegistryServer",
  "builderImage": "builderImage",
  "apiPort": 0,
  "headscalePort": 1,
  "buildImageNamespace": "buildImageNamespace",
  "serverDownloadUrl": "serverDownloadUrl",
  "binariesPath": "binariesPath",
  "logFile": {
    "localTime": true,
    "path": "path",
    "compress": true,
    "maxAge": 5,
    "maxBackups": 2,
    "maxSize": 7
  },
  "samplesIndexUrl": "samplesIndexUrl",
  "defaultProjectImage": "defaultProjectImage",
  "providersDir": "providersDir",
  "id": "id",
  "frps": {
    "protocol": "protocol",
    "port": 6,
    "domain": "domain"
  }
}