List environments

POST

environments.listEnvironments

Go (SDK)

package main

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

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

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

    res, err := s.Environments.ListEnvironments(ctx, components.V2EnvironmentsListEnvironmentsRequestBody{
        Project: "payments-service",
        App: "payments-api",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2EnvironmentsListEnvironmentsResponseBody != nil {
        // handle response
    }
}

from unkey.py import Unkey


with Unkey(
    root_key="<YOUR_BEARER_TOKEN_HERE>",
) as unkey:

    res = unkey.environments.list_environments(project="payments-service", app="payments-api")

    # Handle response
    print(res)

import { Unkey } from "@unkey/api";

const unkey = new Unkey({
  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
});

async function run() {
  const result = await unkey.environments.listEnvironments({
    project: "payments-service",
    app: "payments-api",
  });

  console.log(result);
}

run();

curl --request POST \
  --url https://api.unkey.com/v2/environments.listEnvironments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "app": "payments-api",
  "project": "payments-service"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({app: 'payments-api', project: 'payments-service'})
};

fetch('https://api.unkey.com/v2/environments.listEnvironments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unkey.com/v2/environments.listEnvironments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'app' => 'payments-api',
    'project' => 'payments-service'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://api.unkey.com/v2/environments.listEnvironments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"app\": \"payments-api\",\n  \"project\": \"payments-service\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unkey.com/v2/environments.listEnvironments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"app\": \"payments-api\",\n  \"project\": \"payments-service\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "build": {
        "autoDeploy": true,
        "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
    },
    {
      "build": {
        "autoDeploy": true,
        "buildCommand": "pnpm --filter api build",
        "rootDirectory": ".",
        "watchPaths": [
          "src/**"
        ]
      },
      "createdAt": 1704240000000,
      "deleteProtection": false,
      "description": "Staging environment",
      "id": "env_5678efgh",
      "runtime": {
        "command": [
          "node",
          "server.js"
        ],
        "memoryMib": 256,
        "port": 8080,
        "shutdownSignal": "SIGTERM",
        "storageMib": 0,
        "upstreamProtocol": "http1",
        "vCpus": 0.25
      },
      "slug": "staging"
    }
  ],
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "error": {
    "detail": "The app field is required.",
    "errors": [
      {
        "fix": "Provide the app id or slug",
        "location": "body.app",
        "message": "missing required field"
      }
    ],
    "status": 400,
    "title": "Bad Request",
    "type": "validation-error"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "error": {
    "detail": "Your root key requires the 'environment.*.read_environment' permission to perform this operation",
    "status": 403,
    "title": "Forbidden",
    "type": "forbidden"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "error": {
    "detail": "The requested app does not exist.",
    "status": 404,
    "title": "Not Found",
    "type": "not-found"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

Authorizations

Authorization

string

header

required

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

project

string

required

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

Required string length: 3 - 255

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"proj_1234abcd"

app

string

required

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

Required string length: 3 - 255

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"proj_1234abcd"

Response

Successfully retrieved the app's environments.

meta

object

required

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

data

object[]

required

Array of environments in the app, ordered by environment id.

Show child attributes

⌘I

Go (SDK)

package main

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

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

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

    res, err := s.Environments.ListEnvironments(ctx, components.V2EnvironmentsListEnvironmentsRequestBody{
        Project: "payments-service",
        App: "payments-api",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2EnvironmentsListEnvironmentsResponseBody != nil {
        // handle response
    }
}

from unkey.py import Unkey


with Unkey(
    root_key="<YOUR_BEARER_TOKEN_HERE>",
) as unkey:

    res = unkey.environments.list_environments(project="payments-service", app="payments-api")

    # Handle response
    print(res)

import { Unkey } from "@unkey/api";

const unkey = new Unkey({
  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
});

async function run() {
  const result = await unkey.environments.listEnvironments({
    project: "payments-service",
    app: "payments-api",
  });

  console.log(result);
}

run();

curl --request POST \
  --url https://api.unkey.com/v2/environments.listEnvironments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "app": "payments-api",
  "project": "payments-service"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({app: 'payments-api', project: 'payments-service'})
};

fetch('https://api.unkey.com/v2/environments.listEnvironments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unkey.com/v2/environments.listEnvironments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'app' => 'payments-api',
    'project' => 'payments-service'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://api.unkey.com/v2/environments.listEnvironments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"app\": \"payments-api\",\n  \"project\": \"payments-service\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unkey.com/v2/environments.listEnvironments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"app\": \"payments-api\",\n  \"project\": \"payments-service\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "build": {
        "autoDeploy": true,
        "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
    },
    {
      "build": {
        "autoDeploy": true,
        "buildCommand": "pnpm --filter api build",
        "rootDirectory": ".",
        "watchPaths": [
          "src/**"
        ]
      },
      "createdAt": 1704240000000,
      "deleteProtection": false,
      "description": "Staging environment",
      "id": "env_5678efgh",
      "runtime": {
        "command": [
          "node",
          "server.js"
        ],
        "memoryMib": 256,
        "port": 8080,
        "shutdownSignal": "SIGTERM",
        "storageMib": 0,
        "upstreamProtocol": "http1",
        "vCpus": 0.25
      },
      "slug": "staging"
    }
  ],
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "error": {
    "detail": "The app field is required.",
    "errors": [
      {
        "fix": "Provide the app id or slug",
        "location": "body.app",
        "message": "missing required field"
      }
    ],
    "status": 400,
    "title": "Bad Request",
    "type": "validation-error"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "error": {
    "detail": "Your root key requires the 'environment.*.read_environment' permission to perform this operation",
    "status": 403,
    "title": "Forbidden",
    "type": "forbidden"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "error": {
    "detail": "The requested app does not exist.",
    "status": 404,
    "title": "Not Found",
    "type": "not-found"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

Compute

API Management

Authorizations

Body

Response