Application

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/customdomain-ai/json-schema/customdomain-ai-application-schema.json",
  "title": "Application",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/customdomain-ai-applications-api-openapi.yml#/components/schemas/Application",
  "type": "object",
  "required": [
    "id",
    "name"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "tenant_id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "environment": {
      "$ref": "#/$defs/Environment"
    },
    "default_origin": {
      "type": "string"
    },
    "connect_target": {
      "$ref": "#/$defs/ConnectTarget"
    },
    "sandbox": {
      "type": "boolean",
      "description": "`true` for a **test mode** application, made with `\"sandbox\": true` on `POST /applications`. It runs the whole connect flow end to end (the widget, the API, webhooks) against simulated DNS, on reserved `.test` names only, and never touches a real domain, the free domain, the quota or billing. Fixed when the application is created. Omitted (treated as `false`) on a live application."
    },
    "nameserver_migration": {
      "$ref": "#/$defs/NameserverMigrationSetting"
    },
    "end_user_saved_access": {
      "type": "boolean",
      "default": true,
      "description": "A returning end user may reuse the access their own secure sign-in kept, for their next domain in this application, after one tap of consent. On by default; set it with `PATCH /applications/{id}`. The access is that end user's own: bound to them and to this application, never usable by your team or by another end user. Always `false` for a test mode application, whose sign-ins are simulated and keep nothing."
    },
    "secure_sign_in": {
      "$ref": "#/$defs/SecureSignInStatus"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    }
  },
  "$defs": {
    "ConnectTarget": {
      "type": "object",
      "required": [
        "cname_target"
      ],
      "properties": {
        "cname_target": {
          "type": "string"
        },
        "apex_ipv4": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "Environment": {
      "type": "string",
      "enum": [
        "production",
        "staging",
        "development"
      ]
    },
    "NameserverMigrationSetting": {
      "type": "object",
      "description": "Whether and how the application offers to move an end user's nameservers. It is the one switch for every DNS hosting offer the widget makes. `off` (the default): never offered, and the setting is omitted; a widget token can't start managed DNS either, nor while the target is `dns_host` or `custom`. `offer`: the widget shows the move as a quiet second choice beside adding records. `prefer`: the move is the first choice. Send `{\"mode\": \"off\"}` to clear it.",
      "required": [
        "mode",
        "target"
      ],
      "properties": {
        "mode": {
          "type": "string",
          "enum": [
            "off",
            "offer",
            "prefer"
          ]
        },
        "target": {
          "$ref": "#/$defs/NameserverTarget"
        }
      }
    },
    "NameserverTarget": {
      "type": "object",
      "description": "Where a domain's nameservers move. `managed`: CustomDomain™ hosts the zone (route 1). `dns_host`: a zone we create in the platform's own DNS host account, a connected provider account with continuous access at Cloudflare, Amazon Route 53, Google Cloud DNS or Azure DNS (route 2a). `custom`: the platform's own nameservers, 2 to 13 host names, whose zone the platform runs (route 2b).",
      "required": [
        "kind"
      ],
      "properties": {
        "kind": {
          "type": "string",
          "enum": [
            "managed",
            "dns_host",
            "custom"
          ]
        },
        "provider": {
          "type": "string",
          "description": "For `dns_host`: the DNS host (an adapter id such as `cloudflare`). Set from the account."
        },
        "account_id": {
          "type": "string",
          "description": "For `dns_host`: the connected provider account (`POST /provider-accounts`, continuous access). Saving it takes an admin, an owner or the member who connected it (`403 forbidden` for another member's); the account the application already has may be kept by anyone who may change the setting."
        },
        "nameservers": {
          "type": "array",
          "minItems": 2,
          "maxItems": 13,
          "items": {
            "type": "string"
          },
          "description": "For `custom`: the nameserver host names, stored lower case without a trailing dot."
        }
      }
    },
    "SecureSignInStatus": {
      "type": "object",
      "required": [
        "available"
      ],
      "description": "Whether the secure sign-in (the widget's cloud browser way to connect) can run for this application's workspace at all, for any provider. Read only: it follows how this deployment is set up, not a setting of the application. Whether it runs for one domain is the `cloud_browser` entry of that domain's `rails`.",
      "properties": {
        "available": {
          "type": "boolean"
        },
        "reason": {
          "type": "string",
          "enum": [
            "switched_off",
            "not_enabled_for_workspace"
          ],
          "description": "Present when `available` is `false`. `switched_off`: this deployment has the secure sign-in off. `not_enabled_for_workspace`: it is on for a pilot list of workspaces, and this one is not on it."
        }
      }
    }
  }
}