---
title: "Get the current server config"
method: GET
path: "/admin/serverconfig"
tags: ["Internal", "Admin"]
---

# Get the current server config

`GET /admin/serverconfig`

## Response `200`

Current server config

- AdminServerConfig
  - `instanceDetails` AdminWebConfig
    - `appearanceVariables` object
    - `version` string
    - `welcomeMessage` string
    - `offlineMessage` string
    - `logo` string
    - `name` string
    - `extraPageContent` string
    - `streamTitle` string
    - `customStyles` string
    - `customJavascript` string
    - `summary` string
    - `tags` string[]
    - `socialHandles` SocialHandle[]
      - `platform` string
      - `url` string
      - `icon` string
    - `nsfw` boolean
    - `autoplay` 'off' | 'always' | 'sound-only'
  - `notifications` AdminNotificationsConfig
    - `browser` BrowserNotificationConfiguration
      - `goLiveMessage` string
      - `enabled` boolean
    - `discord` DiscordNotificationConfiguration
      - `webhook` string
      - `goLiveMessage` string
      - `enabled` boolean
  - `yp` AdminYPInfo
    - `instanceUrl` string
    - `enabled` boolean
  - `ffmpegPath` string
  - `adminPassword` string
  - `socketHostOverride` string
  - `webServerIP` string
  - `videoCodec` string
  - `videoServingEndpoint` string
  - `s3` S3Info
    - `endpoint` string
    - `accessKey` string
    - `secret` string
    - `bucket` string
    - `region` string
    - `acl` string
    - `pathPrefix` string
    - `enabled` boolean
    - `forcePathStyle` boolean
  - `federation` AdminFederationConfig
    - `username` string
    - `goLiveMessage` string
    - `blockedDomains` string[]
    - `enabled` boolean
    - `isPrivate` boolean
    - `showEngagement` boolean
    - `enableQuotes` boolean
    - `hideFollowersTab` boolean
  - `supportedCodecs` string[]
  - `externalActions` ExternalAction[]
    - `url` string
    - `html` string
    - `title` string
    - `description` string
    - `icon` string
    - `color` string
    - `openExternally` boolean
  - `forbiddenUsernames` string[]
  - `suggestedUsernames` string[]
  - `streamKeys` StreamKey[]
    - `key` string
    - `comment` string
  - `videoSettings` AdminVideoSettings
    - `videoQualityVariants` StreamOutputVariant[]
      - `name` string
      - `videoPassthrough` boolean
      - `audioPassthrough` boolean
      - `videoBitrate` integer
      - `audioBitrate` integer
      - `scaledWidth` integer
      - `scaledHeight` integer
      - `framerate` integer
      - `cpuUsageLevel` integer
    - `latencyLevel` integer
  - `rtmpServerPort` integer
  - `rtmpServerAddress` string
  - `webServerPort` integer
  - `chatDisabled` boolean
  - `chatJoinMessagesEnabled` boolean
  - `chatEstablishedUserMode` boolean
  - `disableSearchIndexing` boolean
  - `streamKeyOverridden` boolean
  - `hideViewerCount` boolean

## Other responses

- `400` — Bad request
- `401` — Basic auth failure
- `default` — Unexpected error

---

[API](https://skmtc.net/owncast/apis/owncast-apis.md) · [All operations](https://skmtc.net/owncast/apis/owncast-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/owncast/owncast-apis/versions/d3510588e78e/schema)