# Mendix Environments API

**Canonical:** https://apis.io/apis/mendix/mendix-environments-api/  
**Provider:** Mendix — https://apis.io/providers/mendix/  
**Base URL:** https://deploy.mendix.com/api/1  
**Documentation:** https://docs.mendix.com/apidocs-mxsdk/apidocs/deploy-api/

Mendix Environments API is one of 7 APIs that [Mendix](https://apis.io/providers/mendix/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Environment. The published artifact set on APIs.io includes an OpenAPI specification.

The Environments API from Mendix — 8 operation(s) for environments.

## Operations (9)

| Method | Path | Summary |
|---|---|---|
| GET | `/apps/{AppId}/environments` | List environments |
| GET | `/apps/{AppId}/environments/{Mode}` | Get environment |
| POST | `/apps/{AppId}/environments/{Mode}/start` | Start environment |
| GET | `/apps/{AppId}/environments/{Mode}/start/{JobId}` | Check environment start status |
| POST | `/apps/{AppId}/environments/{Mode}/stop` | Stop environment |
| POST | `/apps/{AppId}/environments/{Mode}/clean` | Clean environment data |
| GET | `/apps/{AppId}/environments/{Mode}/settings` | Get environment settings |
| POST | `/apps/{AppId}/environments/{Mode}/settings` | Update environment settings |
| POST | `/apps/{AppId}/environments/{Mode}/scale` | Scale memory and instances |

## Machine-readable artifacts (1)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/mendix/refs/heads/main/openapi/mendix-environments-api-openapi.yml

## Other Mendix APIs (6)

- [Mendix Build API](https://apis.io/apis/mendix/build-api/)
- [Mendix App Repository API](https://apis.io/apis/mendix/app-repository-api/)
- [Mendix Apps API](https://apis.io/apis/mendix/mendix-apps-api/)
- [Mendix Logs API](https://apis.io/apis/mendix/mendix-logs-api/)
- [Mendix Packages API](https://apis.io/apis/mendix/mendix-packages-api/)
- [Mendix Tags API](https://apis.io/apis/mendix/mendix-tags-api/)

## Tags

Environment

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/mendix/mendix-environments-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/mendix/.