> ## Documentation Index
> Fetch the complete documentation index at: https://platform.atlan.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Environments

> Every published environments operation, generated from the contract.

7 operations on `client.environments`.

Path parameters come first, positionally; the request body is last, as a plain
object. Method names are `snake_case` in Python and `camelCase` in
TypeScript, and resource names follow the same rule.

<CodeGroup>
  ```python Python theme={null}
  result = client.environments.aggregate(body)
  ```

  ```typescript TypeScript theme={null}
  const result = await client.environments.aggregate(body);
  ```
</CodeGroup>

## Operations

| Call                                               | Route                                                  | Does                           |
| -------------------------------------------------- | ------------------------------------------------------ | ------------------------------ |
| `client.environments.aggregate(body)`              | `POST /agent/v1/environments/aggregate`                | Aggregate sandbox environments |
| `client.environments.archive(environment_id)`      | `POST /agent/v1/environments/{environment_id}/archive` | Archive a sandbox environment  |
| `client.environments.create(body)`                 | `POST /agent/v1/environments`                          | Create a sandbox environment   |
| `client.environments.get(environment_id)`          | `GET /agent/v1/environments/{environment_id}`          | Get a sandbox environment      |
| `client.environments.list()`                       | `GET /agent/v1/environments`                           | List sandbox environments      |
| `client.environments.search(body)`                 | `POST /agent/v1/environments/search`                   | Search sandbox environments    |
| `client.environments.update(environment_id, body)` | `PATCH /agent/v1/environments/{environment_id}`        | Update a sandbox environment   |

## Related

<CardGroup cols={2}>
  <Card title="How the client is organised" icon="list" href="/sdk/operations">
    Resources, call shapes, and errors.
  </Card>

  <Card title="Errors and retries" icon="triangle-exclamation" href="/developers/errors-and-retries">
    What the SDK raises, and which calls are safe to retry.
  </Card>
</CardGroup>