---
title: "Starts a deployment for the specified environment."
method: POST
path: "/environments/{environmentId}/deployments"
tags: ["Deployments"]
---

# Starts a deployment for the specified environment.

`POST /environments/{environmentId}/deployments`

## Request

- Base URL: `https://api.acquia.com/v3`
- URL: `https://api.acquia.com/v3/environments/{environmentId}/deployments`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/acquia/apis/acquia-cloud-platform-api/docs/environments/:environmentId/deployments/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `environmentId` string, required

## Request body

- object
  - `run_hooks` boolean, required: Whether to run deployment hooks.
  - `code_reference` string, required: The code reference (branch or tag) to deploy.
  - `hooks_argument` string: Additional arguments passed to deployment hooks.

## Response `202`

Deployment started

- object
  - `_links` object, required: HAL links for the resource
    - `self` EnvironmentServiceAPIHalLink, required: HAL link object
      - `href` union, required: The target URI of the link (can be a URI or URI template)
        - string, uri
        - string, uri-template
      - `templated` boolean: Whether the link is a URI template
      - `type` string: Hint about the media type expected when dereferencing the target resource
      - `deprecation` string: A URL to a resource that provides deprecation information
      - `name` string: A secondary key for selecting links
      - `profile` string: A URI that hints about the profile of the target resource
      - `title` string: A human-readable identifier for the link
      - `hreflang` string: The language of the target resource
  - `_embedded` object: Embedded resources (optional)
  - `message` 'Deployment started.', required: Confirmation message that the deployment has been started.

## Other responses

- `400`: Validation Error
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `500`: Internal Server Error

---

[API](https://skmtc.dev/acquia/apis/acquia-cloud-platform-api.md) - [All operations](https://skmtc.dev/acquia/apis/acquia-cloud-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/acquia/apis/acquia-cloud-platform-api/revisions/508f8f94456d?raw)