Get environment

Retrieve a single environment by its id.

Use this to fetch environment details after creation or to verify an environment exists before performing operations.

Required Permissions

Your root key must have one of the following permissions:

environment.*.read_environment (to read any environment)
environment.<environment_id>.read_environment (to read a specific environment)

1 min read

post/v2/environments.getEnvironment

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.GetEnvironment(ctx, components.V2EnvironmentsGetEnvironmentRequestBody{
        Project: "payments",
        App: "payments-api",
        Environment: "env_1234abcd",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2EnvironmentsGetEnvironmentResponseBody != nil {
        // handle response
    }
}

Response

{
  "data": {
    "build": {
      "autoDeploy": true,
      "buildCommand": "pnpm --filter api build",
      "dockerfile": "Dockerfile",
      "rootDirectory": ".",
      "watchPaths": [
        "src/**"
      ]
    },
    "createdAt": 1704067200000,
    "deleteProtection": false,
    "description": "Production environment",
    "id": "env_1234abcd",
    "regions": [
      {
        "name": "us-east-1",
        "replicas": {
          "max": 3,
          "min": 1
        }
      }
    ],
    "runtime": {
      "command": [
        "node",
        "server.js"
      ],
      "memoryMib": 256,
      "port": 8080,
      "shutdownSignal": "SIGTERM",
      "storageMib": 0,
      "upstreamProtocol": "http1",
      "vCpus": 0.25
    },
    "slug": "production",
    "updatedAt": 1704153600000
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

post/v2/environments.getEnvironment

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_-]+$

Responses

application/json

Successfully retrieved the environment.

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#

Show child attributes

idstringrequired#

The unique identifier of the environment, generated by Unkey.

slugstringrequired#

Human-readable slug of the environment, unique within its app.

descriptionstringrequired#

Human-readable description of this environment.
Empty string if none was provided.

kindenum<string>required#

The deployment lifecycle role of an environment.

production: Deployments serve production traffic, support promotion and rollback, and cannot be stopped.
preview: Deployments can be stopped and started and are eligible for preview lifecycle automation.

Options:productionpreview

deleteProtectionbooleanrequired#

Whether delete protection is enabled for this environment.
When true, the environment cannot be deleted until protection is disabled.

createdAtintegerrequired#

Unix timestamp in milliseconds when the environment was created.

Range: 0–9223372036854776000

updatedAtinteger#

Unix timestamp in milliseconds when the environment was last updated.
Omitted if the environment has never been updated.

Range: 0–9223372036854776000

runtimeobject#

Runtime settings that control how the container runs.
Omitted until the environment has runtime settings.

Show child attributes

portintegerrequired#

Port the container listens on.

vCpusnumberrequired#

CPU allocation in vCPUs (1 = one vCPU, 0.5 = half a vCPU).

memoryMibintegerrequired#

Memory allocation in mebibytes.

storageMibintegerrequired#

Ephemeral storage allocation in mebibytes.

commandstring[]required#

Container entrypoint command override.

healthcheckobject#

Show child attributes

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>required#

Signal sent to the container on shutdown.

Options:SIGTERMSIGINTSIGQUITSIGKILL

upstreamProtocolenum<string>required#

Protocol used to reach the container.

Options:http1h2c

openapiSpecPathstring#

Path to the OpenAPI spec served by the container, if any.

buildobject#

Build settings that control how the app is built.
Omitted until the environment has build settings.

Show child attributes

dockerfilestring#

Path to the Dockerfile used to build the app, if any.

rootDirectorystringrequired#

The directory the app is built from. "." for the repository root.

buildCommandstring#

Overrides the build command auto-detected by Railpack, so monorepos can
scope the build to a single app. Omitted when left to auto-detection or
for Dockerfile builds.

watchPathsstring[]required#

Paths that trigger a rebuild when changed.

autoDeploybooleanrequired#

Whether pushes automatically trigger a deployment.

regionsobject[]#

Per-region deployment settings for this environment.
Empty until regional settings are configured.

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.

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.

Verify domain List environment variables