UNunkeyed
environments

Get environment

Changed on

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)
post/v2/environments.getEnvironment

Request

  • Base URL
    https://api.unkey.com
  • URL
    https://api.unkey.com/v2/environments.getEnvironment
  • Auth
    HTTP bearer

Request body

projectstring required

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

appstring required

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

environmentstring required

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

Example request

{
  "project": "proj_1234abcd",
  "app": "proj_1234abcd",
  "environment": "proj_1234abcd"
}

Response

Successfully retrieved the environment.

Example response

{
  "meta": {
    "requestId": "req_123"
  },
  "data": {
    "id": "env_1234abcd",
    "slug": "production",
    "description": "Production environment",
    "kind": "production",
    "createdAt": 1704067200000,
    "updatedAt": 1704153600000,
    "runtime": {
      "port": 8080,
      "vCpus": 0.25,
      "memoryMib": 256,
      "command": [
        "node",
        "server.js"
      ],
      "healthcheck": {
        "method": "GET",
        "path": "/healthz",
        "intervalSeconds": 10,
        "timeoutSeconds": 2,
        "failureThreshold": 3,
        "initialDelaySeconds": 5
      },
      "shutdownSignal": "SIGTERM",
      "upstreamProtocol": "http1",
      "openapiSpecPath": "/openapi.yaml"
    },
    "build": {
      "dockerfile": "Dockerfile",
      "rootDirectory": ".",
      "buildCommand": "pnpm --filter api build",
      "watchPaths": [
        "src/**"
      ],
      "autoDeploy": true
    },
    "regions": [
      {
        "name": "us-east-1",
        "replicas": {
          "min": 1,
          "max": 3
        }
      }
    ]
  }
}

Changes

  • 96d3a2d38aceRevision changes
    • info

      added the required property / to the response with the status

  • 43ad1ce9a152Revision changes
    • info

      the endpoint scheme security bearer was added to the API

    • info

      the endpoint scheme security rootKey was removed from the API