---
title: "Create Git deployment task"
method: GET
path: "/VersionControlDeployment/create"
tags: ["VersionControlDeployment", "Deployment Settings"]
---

# Create Git deployment task

`GET /VersionControlDeployment/create`

This function deploys the changes from a cPanel-managed repository.

**Important:**

The system logs messages for this function in the `~/.cpanel/logs/vc_TIMESTAMP_git_deploy.log` file, where TIMESTAMP represents the time in Unix epoch time. The system pulls changes with the `--ff-only` option and will only succeed if the branch's HEAD commit is up-to-date or Git can fast forward it. For more information about our suggested deployment configuration and how users can set it up, read our [Guide to Git™ - Deployment](https://go.cpanel.net/GitDeployment) documentation. Before deployment, repositories must meet the following requirements:
  * A valid checked-in `.cpanel.yml` file in the top-level directory.
  * One or more local or remote branches.
  * A clean working tree.

If a repository does **not** meet these requirements, the system will **not** display deployment information. Also, it will disable deployment functionality. For more information, read our [Guide to Git™ - Deployment](https://go.cpanel.net/GitDeployment) documentation.

## Query parameters

- `repository_root` string, path, required

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object
      - `deploy_id` string — The deployment ID number.
      - `log_path` string, path — The absolute path to the task's log file vc_TIMESTAMP_git_deploy.log, where TIMESTAMP represents the time in Unix epoch time.
      - `repository_root` string, path — The repository's directory.
      - `sse_url` string, url-path — The SSE interface to track the progress of the deployment process.
      - `task_id` string — The Task Queue system's task ID number.
      - `timestamps` object — A hash of timestamps for the deployment process.
        - `queued` string — The time at which the deployment process. entered the task queue.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
    - `status` 0 | 1 — - 1 - Success - 0 - Failed: Check the errors field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/revisions/632e2f8e6d04/schema)