List Environments - Open Managed Agents

GET

/

v1

/

environments

List Environments

curl --request GET \
  --url http://localhost:38080/v1/environments \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('http://localhost:38080/v1/environments', 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 := "http://localhost:38080/v1/environments"

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

	req.Header.Add("X-Api-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

{
  "data": [
    {
      "type": "environment",
      "id": "env_011CZkZ9X2dpNyB7HsEFoRfW",
      "name": "python-data-analysis",
      "description": "Python environment with data-analysis packages.",
      "config": {
        "type": "cloud",
        "networking": {
          "type": "limited",
          "allowed_hosts": [
            "api.example.com"
          ],
          "allow_package_managers": true,
          "allow_mcp_servers": false
        },
        "packages": {
          "type": "packages",
          "pip": [
            "pandas",
            "numpy"
          ],
          "npm": [],
          "apt": [],
          "cargo": [],
          "gem": [],
          "go": []
        }
      },
      "metadata": {},
      "archived_at": null,
      "created_at": "2026-03-15T10:00:00Z",
      "updated_at": "2026-03-15T10:00:00Z"
    }
  ],
  "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

Every request requires ?beta=true.

Authorizations

X-Api-Key

string

header

default:sk-ant-local-default

required

OMA workspace API key.

Headers

anthropic-beta

string

Optional header to specify the beta version(s) you want to use.

To use multiple betas, use a comma separated list like beta1,beta2 or specify the header multiple times for each beta.

anthropic-version

string

The version of the OMA API you want to use.

Read more about versioning and our version history here.

Query Parameters

beta

enum<boolean>

required

Selects the beta API contract for this endpoint. Must be true.

Available options:

true

limit

integer

default:20

Maximum number of environments to return

Required range: 1 <= x <= 1000

page

string | null

Opaque cursor from previous response for pagination. Pass the next_page value from the previous response.

include_archived

boolean

default:false

Include archived environments in the response

Response

Successful Response

Response when listing environments.

This response model uses opaque cursor-based pagination. Use the page query parameter with the value from next_page to fetch the next page.

data

Environment · object[]

required

List of environments.

Show child attributes

next_page

string | null

required

Token for fetching the next page of results. If null, there are no more results available. Pass this value to the page parameter in the next request.

Example:

"page_MjAyNS0wNS0xNFQwMDowMDowMFo="

List Environments

curl --request GET \
  --url http://localhost:38080/v1/environments \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('http://localhost:38080/v1/environments', 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 := "http://localhost:38080/v1/environments"

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

	req.Header.Add("X-Api-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

{
  "data": [
    {
      "type": "environment",
      "id": "env_011CZkZ9X2dpNyB7HsEFoRfW",
      "name": "python-data-analysis",
      "description": "Python environment with data-analysis packages.",
      "config": {
        "type": "cloud",
        "networking": {
          "type": "limited",
          "allowed_hosts": [
            "api.example.com"
          ],
          "allow_package_managers": true,
          "allow_mcp_servers": false
        },
        "packages": {
          "type": "packages",
          "pip": [
            "pandas",
            "numpy"
          ],
          "npm": [],
          "apt": [],
          "cargo": [],
          "gem": [],
          "go": []
        }
      },
      "metadata": {},
      "archived_at": null,
      "created_at": "2026-03-15T10:00:00Z",
      "updated_at": "2026-03-15T10:00:00Z"
    }
  ],
  "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}