UpdateAppBody

Request body for updating an App.

Definition

TypeScript

interface UpdateAppBody {
  name?: string | undefined;
  description?: string | undefined;
  handle?: string | undefined;
  publicAccess?: boolean | undefined;
  defaultVersionId?: string | undefined;
  config?:
    | {
        [x: string]: unknown;
        nodeVersion?: string | undefined;
        env?: Record<string, string> | undefined;
      }
    | undefined;
}

Fields

Field	Type	Notes
`name`	`string \| undefined`	`optional` — New name
`description`	`string \| undefined`	`optional` — New description
`handle`	`string \| undefined`	`optional` — New URL handle
`publicAccess`	`boolean \| undefined`	`optional` — Toggle public access: `true` = reachable without auth, `false` = auth-gated.
`defaultVersionId`	`string \| undefined`	`optional` — Set default version (must have a successful deploy)
`config`	`{ [x: string]: unknown; nodeVersion?: string \| undefined; env?: Record<string, string> \| undefined; } \| undefined`	`optional` — Updated config