update-settings - Unkey Docs

Update selected build and runtime settings for an environment.

Usage#

unkey api environments update-settings [flags]

Flags#

--projectstringrequired#

Project identifier or slug.

--appstringrequired#

Application identifier or slug.

--environmentstringrequired#

Environment identifier or slug.

--dockerfilestring#

Dockerfile path.

--root-directorystring#

Build root directory.

--build-commandstring#

Command used to build the app.

--watch-pathsstring[]#

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

--auto-deploybool#

Whether pushes deploy automatically.

--portinteger#

Container port.

--v-cpusnumber#

CPU allocation in vCPUs.

--memory-mibinteger#

Memory allocation in MiB.

--storage-mibinteger#

Storage allocation in MiB.

--commandstring[]#

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

--healthcheckJSON string#

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

Show JSON schema

The JSON object uses the properties and constraints listed above.

--shutdown-signalstring#

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

--upstream-protocolstring#

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

--openapi-spec-pathstring#

OpenAPI specification path.

--regionsJSON string#

Regions with name and min/max replica bounds.

Show JSON schema

The JSON object uses the properties and constraints listed above.

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#

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

Note

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.