StackUpBody

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/briq-cloud/json-schema/briq-cloud-stack-up-body-schema.json",
  "title": "StackUpBody",
  "x-generated": "2026-11-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/briq-cloud-v1-openapi.json#/components/schemas/StackUpBody",
  "type": "object",
  "properties": {
    "file": {
      "type": "string",
      "minLength": 1,
      "description": "The stack file's content, YAML or JSON (briq.yaml)"
    },
    "stack": {
      "type": "string",
      "description": "The stack to bring up instead of the file's `stack`: a branch's, a fork's"
    },
    "secrets": {
      "type": "object",
      "additionalProperties": {
        "type": "string",
        "maxLength": 32768
      },
      "description": "Values for the secrets the file names as { secret: NAME }: an API key briq cannot generate. Never in the file. A secret without a value here is generated"
    },
    "expose": {
      "type": "boolean",
      "description": "Reach the stack from outside briq: database ports get TLS endpoints, and outputs use them and the URLs the file publishes. Waits for the briqs. The file's own `expose` still decides each URL's mode"
    },
    "wait": {
      "type": "boolean",
      "default": true,
      "description": "Answer once the briqs are ready (healthcheck passed, or process started)"
    },
    "waitTimeoutMs": {
      "type": "integer",
      "maximum": 300000,
      "default": 120000,
      "description": "How long to wait; a briq still creating then is on its way"
    }
  },
  "required": [
    "file"
  ]
}