Get environment

from unkey.py import Unkey


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

    res = unkey.environments.get_environment(project="payments", app="payments-api", environment="env_1234abcd")

    # 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.getEnvironment({
    project: "payments",
    app: "payments-api",
    environment: "env_1234abcd",
  });

  console.log(result);
}

run();

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
    }
}

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

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

fetch('https://api.unkey.com/v2/environments.getEnvironment', 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.getEnvironment",
  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',
    'environment' => 'env_1234abcd',
    'project' => 'payments'
  ]),
  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.getEnvironment")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"app\": \"payments-api\",\n  \"environment\": \"env_1234abcd\",\n  \"project\": \"payments\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"environment\": \"env_1234abcd\",\n  \"project\": \"payments\"\n}"

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

{
  "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"
  }
}

{
  "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",
    "errors": [
      {
        "location": "body.permissions[0].name",
        "message": "Must be at least 3 characters long",
        "fix": "Ensure the name uses only alphanumeric characters, underscores, and hyphens"
      }
    ]
  }
}

{
  "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 environment 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"
  }
}