update-settings

Update settings with the Unkey API CLI

Update selected build and runtime settings for an environment.

Usage

unkey api environments update-settings [flags]

Flags

--project · string · required

Project identifier or slug.

--app · string · required

Application identifier or slug.

--environment · string · required

Environment identifier or slug.

--dockerfile · string

Dockerfile path.

--root-directory · string

Build root directory.

--build-command · string

Command used to build the app.

--watch-paths · string[]

Paths that trigger a deployment. Pass an empty value to clear the current paths.

--auto-deploy · bool

Whether pushes deploy automatically.

--port · integer

Container port.

--v-cpus · number

CPU allocation in vCPUs.

--memory-mib · integer

Memory allocation in MiB.

--storage-mib · integer

Storage allocation in MiB.

--command · string[]

Container command. Pass an empty value to clear the current command.

--healthcheck · JSON string

Healthcheck with method, path, intervalSeconds, timeoutSeconds, failureThreshold, and initialDelaySeconds.

--shutdown-signal · string

Container shutdown signal. Valid choices are SIGTERM, SIGINT, SIGQUIT, and SIGKILL.

--upstream-protocol · string

Protocol used to reach the container. Valid choices are http1 and h2c.

--openapi-spec-path · string

OpenAPI specification path.

--regions · JSON string

Regions with name and min/max replica bounds.

Global Flags

Flag	Type	Description
--root-key	string	Override root key ($UNKEY_ROOT_KEY)
--api-url	string	Override API base URL (default: https://api.unkey.com)
--config	string	Path to config file (default: ~/.unkey/config.toml)
--output	string	Output format - use json for raw JSON
--body	string	Send this JSON string as the request body. You cannot combine it with request-building flags.

Examples

Basic

unkey api environments update-settings --project=payments --app=payments-api \
  --environment=production --port=8080 --shutdown-signal=SIGTERM \
  --upstream-protocol=http1

The current Go SDK can’t represent explicit null values for dockerfile, buildCommand, healthcheck, or openapiSpecPath. Use the HTTP API directly to clear these settings.

See the Update settings API reference.