Update environment settings

Update the build, runtime, and regional settings for an environment.

All settings fields are optional. Omit a field to leave it unchanged. For
nullable fields (dockerfile, healthcheck, openapiSpecPath), send null
to clear the value. When regions is present it replaces the full set of
regions for the environment.

Required Permissions

Your root key must have one of the following permissions:

environment.*.update_environment (to update any environment)
environment.<environment_id>.update_environment (to update a specific environment)

1 min read

post/v2/environments.updateSettings

Request example

package main

import(
	"context"
	"os"
	unkey "github.com/unkeyed/sdks/api/go/v2"
	"github.com/unkeyed/sdks/api/go/v2/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := unkey.New(
        unkey.WithSecurity(os.Getenv("UNKEY_ROOT_KEY")),
    )

    res, err := s.Environments.UpdateSettings(ctx, components.V2EnvironmentsUpdateSettingsRequestBody{
        Project: "payments",
        App: "payments-api",
        Environment: "production",
        Regions: []components.EnvironmentRegion{
            components.EnvironmentRegion{
                Name: "us-east-1",
                Replicas: components.Replicas{
                    Min: 1,
                    Max: 3,
                },
            },
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2EnvironmentsUpdateSettingsResponseBody != nil {
        // handle response
    }
}

Response

{
  "data": {},
  "meta": {
    "requestId": "req_1234abcd"
  }
}

post/v2/environments.updateSettings

Authorization

Authorizationstringheaderrequired#

Unkey uses bearer tokens for authentication. Public integrations use root keys, while the dashboard proxy uses short-lived JWTs.
To authenticate, include the token in the Authorization header of each request:

Authorization: Bearer unkey_123

Root keys have specific permissions attached to them, controlling what operations they can perform. Legacy permissions use tuple strings like api.*.create_key; resource permissions use Unkey Resource Names plus actions, like unkey:v1:ws_123:keyspaces/*#create_key.
Security best practices:

Keep root keys secure and never expose them in client-side code
Use different root keys for different environments
Rotate keys periodically, especially after team member departures
Create keys with minimal necessary permissions following least privilege principle
Monitor key usage with audit logs.

Body

application/json

projectstringrequired#

Identifies a resource by either its unique ID or its slug.
Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Length: 3–255Pattern: ^[a-zA-Z0-9_-]+$

appstringrequired#

Identifies a resource by either its unique ID or its slug.
Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Length: 3–255Pattern: ^[a-zA-Z0-9_-]+$

environmentstringrequired#

Identifies a resource by either its unique ID or its slug.
Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Length: 3–255Pattern: ^[a-zA-Z0-9_-]+$

dockerfilestring#

Path to the Dockerfile used for builds.
Omit to leave unchanged; set null to clear and fall back to Railpack.

Length: 1–500

rootDirectorystring#

The directory your app lives in. Unkey builds from here.
Use "." for the repository root, or set a subdirectory when your app
is nested (e.g., services/api). Omit to leave unchanged.

Length: 1–500

buildCommandstring#

Overrides the build command auto-detected by Railpack.
Omit to leave unchanged; set null to clear and fall back to auto-detection.

Length: 1–1000

watchPathsstring[]#

Glob paths that trigger auto-deploys when changed.
Omit to leave unchanged.

Items: max 10

autoDeployboolean#

Whether pushes auto-deploy.
Omit to leave unchanged.

portinteger#

Container port the app listens on.
Omit to leave unchanged.

Range: 1–65535

vCpusnumber#

CPU allocation in vCPUs. Minimum 0.25 (1/4 vCPU), in steps of 0.25.
The upper bound is your workspace's per-instance quota; exceeding it returns 400.
Omit to leave unchanged.

Range: >= 0.25Multiple of: 0.25

memoryMibinteger#

Memory allocation in MiB. Minimum 256, in steps of 256.
The upper bound is your workspace's per-instance quota; exceeding it returns 400.
Omit to leave unchanged.

Range: >= 256Multiple of: 256

storageMibinteger#

Ephemeral storage allocation in MiB, in steps of 512 (0 for none).
The upper bound is your workspace's per-instance quota; exceeding it returns 400.
Omit to leave unchanged.

Range: >= 0Multiple of: 512

commandstring[]#

Override container entrypoint command.
Omit to leave unchanged.

Items: max 10

healthcheckobject · null#

HTTP healthcheck configuration.
Omit to leave unchanged; set null to remove.

Show child attributes

Any of

methodenum<string>required#

HTTP method used to probe the container.

Options:GETPOST

pathstringrequired#

HTTP path probed on the container. Must start with a slash.

Length: 1–512Pattern: ^(/[\w\-]+)+(\.[\w]+)?$

intervalSecondsinteger#

How often the probe runs, in seconds. Defaults to 10 when omitted.

Range: 1–3600

timeoutSecondsinteger#

Per-probe timeout, in seconds. Defaults to 5 when omitted.

Range: 1–3600

failureThresholdinteger#

Consecutive failures before the container is restarted. Defaults to 3 when omitted.

Range: 1–100

initialDelaySecondsinteger#

Delay before the first probe runs, in seconds. Defaults to 0 when omitted.

Range: 0–3600

shutdownSignalenum<string>#

Signal sent to the container on shutdown.

Options:SIGTERMSIGINTSIGQUITSIGKILL

upstreamProtocolenum<string>#

Protocol used to reach the container.

Options:http1h2c

openapiSpecPathstring#

Path to the OpenAPI spec file within the build. Must start with a slash.
Omit to leave unchanged; set null to clear.

Length: 1–512Pattern: ^(/[\w\-]+)+(\.[\w]+)?$

regionsobject[]#

Desired set of regions with per-region replica bounds.
Omit to leave regions unchanged; when present, this replaces the full set
(regions absent from the list are removed). At least one region is required;
an empty list is rejected because an environment cannot have zero regions.

Items: 1–5

Show child attributes

namestringrequired#

Region name, such as us-east-1.

Length: 1–64

replicasobjectrequired#

Min and max replica bounds for autoscaling in a region.

Show child attributes

minintegerrequired#

Minimum number of replicas.

maxintegerrequired#

Maximum number of replicas.

Responses

application/json

Successfully updated the environment settings.

metaobjectrequired#

Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The requestId is particularly important when troubleshooting issues with the Unkey support team.

Show child attributes

requestIdstringrequired#

A unique id for this request. Always include this ID when contacting support about a specific API request. This identifier allows Unkey's support team to trace the exact request through logs and diagnostic systems to provide faster assistance.

dataobjectrequired#

Empty response object by design. A successful response indicates this operation was successfully executed.

metaobjectrequired#

Show child attributes

requestIdstringrequired#

errorobjectrequired#

Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP response content.

Show child attributes

detailstringrequired#

A human-readable explanation specific to this occurrence of the problem. This provides detailed information about what went wrong and potential remediation steps. The message is intended to be helpful for developers troubleshooting the issue.

statusintegerrequired#

HTTP status code that corresponds to this error. This will match the status code in the HTTP response. Common codes include 400 (Bad Request), 401 (Unauthorized), 403 (Forbidden), 404 (Not Found), 409 (Conflict), and 500 (Internal Server Error).

titlestringrequired#

A short, human-readable summary of the problem type. This remains constant from occurrence to occurrence of the same problem and should be used for programmatic handling.

typestringrequired#

A URI reference that identifies the problem type. This provides a stable identifier for the error that can be used for documentation lookups and programmatic error handling. When followed, this URI should provide human-readable documentation for the problem type.

errorsobject[]required#

List of individual validation errors that occurred in the request. Each error provides specific details about what failed validation, where the error occurred in the request, and suggestions for fixing it. This granular information helps developers quickly identify and resolve multiple issues in a single request without having to make repeated API calls.

Show child attributes

locationstringrequired#

JSON path indicating exactly where in the request the error occurred. This helps pinpoint the problematic field or parameter. Examples include:

'body.name' (field in request body)
'body.items[3].tags' (nested array element)
'path.apiId' (path parameter)
'query.limit' (query parameter)
Use this location to identify exactly which part of your request needs correction.

messagestringrequired#

Detailed error message explaining what validation rule was violated. This provides specific information about why the field or parameter was rejected, such as format errors, invalid values, or constraint violations.

fixstring#

A human-readable suggestion describing how to fix the error. This provides practical guidance on what changes would satisfy the validation requirements. Not all validation errors include fix suggestions, but when present, they offer specific remediation advice.

Set environment variables List policies