Daytona Config API

openapi: 3.2.0
info:
  contact:
    email: support@daytona.com
    name: Daytona Platforms Inc.
    url: https://www.daytona.io
  description: Daytona AI platform API Docs
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  title: Daytona Config API
  version: '1.0'
servers:
- url: http://localhost:3000
tags:
- name: Config
paths:
  /config:
    get:
      operationId: ConfigController_getConfig
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DaytonaConfiguration'
          description: Daytona configuration
      summary: Get config
      tags:
      - Config
components:
  schemas:
    SsoOidcConfig:
      properties:
        issuer:
          description: OIDC issuer for org-SSO logins (Daytona Auth)
          example: https://api.example.com/api/oidc
          type: string
        clientId:
          description: OIDC client ID for org-SSO logins
          example: daytona-dashboard
          type: string
      required:
      - clientId
      - issuer
      type: object
    CliOidcConfig:
      properties:
        issuer:
          description: WorkOS issuer of the Daytona CLI application
          example: https://auth.example.com/user_management/client_123
          type: string
        clientId:
          description: WorkOS client ID of the Daytona CLI application
          example: client_123
          type: string
      required:
      - clientId
      - issuer
      type: object
    DaytonaConfiguration:
      example:
        sshGatewayPublicKey: ssh-gateway-public-key
        proxyToolboxUrl: https://proxy.example.com/toolbox
        posthog: ''
        maxAutoArchiveInterval: 43200
        pylonAppId: pylon-app-123
        maintananceMode: false
        forcedFeatureFlags:
        - forcedFeatureFlags
        - forcedFeatureFlags
        sshGatewayPort: 22
        sshGatewayHostKeys:
        - ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIBh7nbXJuVs1AkREaeJsOxlKD219FLKyrf37BmRKq8A
        dashboardUrl: https://dashboard.example.com
        ssoOidc: ''
        rateLimit: ''
        analyticsApiUrl: https://analytics.example.com
        buildSha: 1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b
        billingApiUrl: https://billing.example.com
        linkedAccountsEnabled: true
        stripePublishableKey: pk_live_...
        version: 0.0.1
        oidc: ''
        sshGatewayHostKeyFingerprints:
        - SHA256:+0Mw+mXcYJg98TZSC4utJjM8amxj8SSRaEAGo9nkbWk
        proxyTemplateUrl: https://{{PORT}}-{{sandboxId}}.proxy.example.com
        environment: production
        defaultSnapshot: ubuntu:22.04
        sshGatewayCommand: ssh -p 2222 {{TOKEN}}@localhost
        announcements:
          feature-update:
            text: New feature available!
            learnMoreUrl: https://example.com
        sshGatewayHost: ssh.app.daytona.io
      properties:
        version:
          description: Daytona version
          example: 0.0.1
          type: string
        buildSha:
          description: Commit sha of the source the app was built from
          example: 1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b
          type: string
        posthog:
          allOf:
          - $ref: '#/components/schemas/PosthogConfig'
          description: PostHog configuration
        oidc:
          allOf:
          - $ref: '#/components/schemas/OidcConfig'
          description: OIDC configuration
        ssoOidc:
          allOf:
          - $ref: '#/components/schemas/SsoOidcConfig'
          description: OIDC configuration for org-SSO logins (Daytona Auth issuer). Present only when the secondary (org-SSO) issuer is configured; the dashboard uses it as its authority when entered via an organization SSO link.
        forcedFeatureFlags:
          description: Feature flags forced on for this deployment regardless of PostHog targeting. Lets environments without PostHog (previews, local dev) enable flag-gated dashboard features.
          items:
            type: string
          type: array
        linkedAccountsEnabled:
          description: Whether linked accounts are enabled
          example: true
          type: boolean
        announcements:
          additionalProperties:
            $ref: '#/components/schemas/Announcement'
          description: System announcements
          example:
            feature-update:
              text: New feature available!
              learnMoreUrl: https://example.com
          type: object
        pylonAppId:
          description: Pylon application ID
          example: pylon-app-123
          type: string
        proxyTemplateUrl:
          description: Proxy template URL
          example: https://{{PORT}}-{{sandboxId}}.proxy.example.com
          type: string
        proxyToolboxUrl:
          description: Toolbox template URL
          example: https://proxy.example.com/toolbox
          type: string
        defaultSnapshot:
          description: Default snapshot for sandboxes
          example: ubuntu:22.04
          type: string
        dashboardUrl:
          description: Dashboard URL
          example: https://dashboard.example.com
          type: string
        maxAutoArchiveInterval:
          description: Maximum auto-archive interval in minutes
          example: 43200
          type: number
        maintananceMode:
          description: Whether maintenance mode is enabled
          example: false
          type: boolean
        environment:
          description: Current environment
          example: production
          type: string
        billingApiUrl:
          description: Billing API URL
          example: https://billing.example.com
          type: string
        analyticsApiUrl:
          description: Analytics API URL
          example: https://analytics.example.com
          type: string
        stripePublishableKey:
          description: Stripe publishable key for client-side Stripe.js
          example: pk_live_...
          type: string
        sshGatewayCommand:
          description: SSH Gateway command
          example: ssh -p 2222 {{TOKEN}}@localhost
          type: string
        sshGatewayPublicKey:
          description: Base64 encoded SSH Gateway public key
          example: ssh-gateway-public-key
          type: string
        sshGatewayHost:
          description: Hostname of the SSH Gateway that sandbox SSH connections terminate at
          example: ssh.app.daytona.io
          type: string
        sshGatewayPort:
          description: TCP port of the SSH Gateway
          example: 22
          type: number
        sshGatewayHostKeys:
          description: SSH host public keys presented by the SSH Gateway, as OpenSSH public key lines (`<type> <base64>`). To build a known_hosts entry, prefix each with `sshGatewayHost` when `sshGatewayPort` is 22, or with `[sshGatewayHost]:sshGatewayPort` otherwise.
          example:
          - ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIBh7nbXJuVs1AkREaeJsOxlKD219FLKyrf37BmRKq8A
          items:
            type: string
          type: array
        sshGatewayHostKeyFingerprints:
          description: SHA256 fingerprints of sshGatewayHostKeys, in the same order, in `ssh-keygen -lf` format. Compare against the fingerprint published at https://github.com/daytona/.github/blob/main/SECURITY.md#ssh-host-key-verification
          example:
          - SHA256:+0Mw+mXcYJg98TZSC4utJjM8amxj8SSRaEAGo9nkbWk
          items:
            type: string
          type: array
        rateLimit:
          allOf:
          - $ref: '#/components/schemas/RateLimitConfig'
          description: Rate limit configuration
      required:
      - announcements
      - dashboardUrl
      - defaultSnapshot
      - environment
      - linkedAccountsEnabled
      - maintananceMode
      - maxAutoArchiveInterval
      - oidc
      - proxyTemplateUrl
      - proxyToolboxUrl
      - version
      type: object
    OidcConfig:
      properties:
        issuer:
          description: OIDC issuer
          example: https://auth.example.com
          type: string
        clientId:
          description: OIDC client ID
          example: daytona-client
          type: string
        audience:
          description: OIDC audience
          example: daytona-api
          type: string
        provider:
          description: 'Which identity provider the advertised issuer above belongs to. The dashboard needs this because provider-specific logout URLs are not discoverable from the issuer alone: ending an Auth0 session uses its proprietary /v2/logout, which does not exist on WorkOS AuthKit. Anything that branches on provider behaviour must read this rather than pattern-matching the issuer hostname.'
          enum:
          - auth0
          - workos
          example: auth0
          type: string
        authApiHostname:
          description: WorkOS "Authentication API" custom domain the dashboard's client-side SDK should call instead of api.workos.com, so the refresh-token cookie is first-party. Present only when the provider is workos and a custom domain is configured (WorkOS production environments only); absent means the SDK runs in devMode and keeps the refresh token in localStorage.
          example: auth.example.com
          type: string
        cli:
          allOf:
          - $ref: '#/components/schemas/CliOidcConfig'
          description: WorkOS application the Daytona CLI logs in through, configured apart from the dashboard's so CLI sessions can have their own lifetime. Present only when the provider is workos and a CLI application is configured; absent means the CLI uses the issuer and client ID above.
      required:
      - audience
      - clientId
      - issuer
      - provider
      type: object
    Announcement:
      properties:
        text:
          description: The announcement text
          example: New feature available!
          type: string
        learnMoreUrl:
          description: URL to learn more about the announcement
          example: https://example.com/learn-more
          type: string
      required:
      - text
      type: object
    PosthogConfig:
      properties:
        apiKey:
          description: PostHog API key
          example: phc_abc123
          type: string
        host:
          description: PostHog host URL
          example: https://app.posthog.com
          type: string
      required:
      - apiKey
      - host
      type: object
    RateLimitEntry:
      properties:
        ttl:
          description: Rate limit TTL in seconds
          example: 60
          type: number
        limit:
          description: Rate limit max requests
          example: 100
          type: number
      type: object
    RateLimitConfig:
      properties:
        failedAuth:
          allOf:
          - $ref: '#/components/schemas/RateLimitEntry'
          description: Failed authentication rate limit
        authenticated:
          allOf:
          - $ref: '#/components/schemas/RateLimitEntry'
          description: Authenticated rate limit
        sandboxCreate:
          allOf:
          - $ref: '#/components/schemas/RateLimitEntry'
          description: Sandbox create rate limit
        sandboxLifecycle:
          allOf:
          - $ref: '#/components/schemas/RateLimitEntry'
          description: Sandbox lifecycle rate limit
        sandboxList:
          allOf:
          - $ref: '#/components/schemas/RateLimitEntry'
          description: Sandbox list rate limit
      type: object
  securitySchemes:
    bearer:
      bearerFormat: JWT
      description: API Key access
      scheme: bearer
      type: http
    oauth2:
      openIdConnectUrl: http://localhost:3000/.well-known/openid-configuration
      type: openIdConnect
x-provenance:
  method: harvested
  publisher: Daytona
  source: https://www.daytona.io/docs/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)