Get Environment

curl --request GET \
  --url https://sdk.localops.co/v1/environments/{envId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sdk.localops.co/v1/environments/{envId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sdk.localops.co/v1/environments/{envId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "message": "success",
  "data": {
    "environment": {
      "id": "6a1f7e0c-0000-0000-0000-000000000000",
      "name": "production",
      "state": "available",
      "cloud_region_code": "aws-us-east-1",
      "ingress_host": "k8s-ingress-a1b2c3d4.elb.us-east-1.amazonaws.com",
      "public_nat_ips": [
        "43.204.246.44"
      ],
      "svc_role_arn": "arn:aws:iam::123456789012:role/lops-prod-a1b2-svc-role",
      "default_origin": "https://production-a1b2.localops.co",
      "created_at": "2026-07-02T11:20:31Z"
    }
  }
}

Environments

Get Environment

Read an environment’s identity, lifecycle state, network edges and workload identity.

Three fields exist so you can wire your own infrastructure to the environment, and all three are read live from the environment’s infrastructure on every request:

ingress_host is the load balancer in front of the environment’s ingress. Point your own DNS records at it - a CNAME when it is a hostname (AWS), an A record when it is an IP address (GCP).
public_nat_ips are the NAT gateway addresses the environment’s outbound traffic leaves from. Allowlist them in your own firewalls and database security groups.
svc_role_arn is the IAM role the environment’s pods assume on AWS. Name it as a principal in your own bucket, queue and KMS key policies. It is an identifier and not a credential, so naming it grants nothing until you also set up the trust in your own account.

All three are empty until the environment is provisioned. svc_role_arn is always empty on GCP, where the equivalent identity is a service account rather than a role.

GET

environments

{envId}

Get Environment

curl --request GET \
  --url https://sdk.localops.co/v1/environments/{envId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sdk.localops.co/v1/environments/{envId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sdk.localops.co/v1/environments/{envId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "message": "success",
  "data": {
    "environment": {
      "id": "6a1f7e0c-0000-0000-0000-000000000000",
      "name": "production",
      "state": "available",
      "cloud_region_code": "aws-us-east-1",
      "ingress_host": "k8s-ingress-a1b2c3d4.elb.us-east-1.amazonaws.com",
      "public_nat_ips": [
        "43.204.246.44"
      ],
      "svc_role_arn": "arn:aws:iam::123456789012:role/lops-prod-a1b2-svc-role",
      "default_origin": "https://production-a1b2.localops.co",
      "created_at": "2026-07-02T11:20:31Z"
    }
  }
}

Authorizations

Authorization

string

header

required

Your account API token, sent as Authorization: Bearer <api_token>. Owners and admins can read the token from the LocalOps console.

Path Parameters

envId

string<uuid>

required

The unique identifier of the environment

Response

Environment details

message

string

data

object

Show child attributes

Getting Started

Endpoints

No Access Delivery

Get Environment

Authorizations

Path Parameters

Response