---
title: "POST /api/v1/hosting/apps/{app_id}/environments"
method: POST
path: "/api/v1/hosting/apps/{app_id}/environments"
tags: ["hosting"]
---

# POST /api/v1/hosting/apps/{app_id}/environments

`POST /api/v1/hosting/apps/{app_id}/environments`

## Request

- Base URL: `https://composal.com` (the document declares no server; this is the origin it was published from)
- URL: `https://composal.com/api/v1/hosting/apps/{app_id}/environments`
- Auth: HTTP bearer

## Path parameters

- `app_id` string, required

## Request body

- AppEnvironmentCreatePayload
  - `slug` string, required
  - `name` string, required
  - `kind` 'production' | 'staging' | 'development' | 'preview' | 'ephemeral' | 'custom', required
  - `status` 'active' | 'paused' | 'archived', required
  - `location_id` string, required
  - `branch_pattern` string
  - `base_domain` string
  - `auto_deploy` boolean, required

## Response `200`

App environment created

- object
  - `environment` AppEnvironment, required
    - `id` string, required
    - `hosted_app_id` string, required
    - `location_id` string, required
    - `slug` string, required
    - `name` string, required
    - `kind` 'production' | 'staging' | 'development' | 'preview' | 'ephemeral' | 'custom', required
    - `status` 'active' | 'paused' | 'archived', required
    - `location` HostingLocation, required
      - `id` string, required
      - `code` string, required
      - `name` string, required
      - `nomad_datacenter` string, required
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
    - `branch_pattern` string, nullable, required
    - `base_domain` string, nullable, required
    - `auto_deploy` boolean, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `created_at_label` string, nullable, required
    - `updated_at_label` string, nullable, required

## Other responses

- `201`: App environment created
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `422`: Deployment request failed validation
- `502`: Bad gateway

---

[API](https://skmtc.dev/composal/apis/vex-api.md) - [All operations](https://skmtc.dev/composal/apis/vex-api/llms.txt) - [OpenAPI document](https://skmtc.dev/composal/apis/vex-api/revisions/19698ba051dc?raw)