---
title: "Return Git deployment task status"
method: GET
path: "/VersionControlDeployment/retrieve"
tags: ["VersionControlDeployment", "Deployment Settings"]
---

# Return Git deployment task status

`GET /VersionControlDeployment/retrieve`

This function retrieves the status of deployment tasks. 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.

**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.

## 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[] — An array of objects containing deployment task data.
      - `deploy_id` integer — The deployment ID number.
      - `log_path` string, path — The absolute path to the task's log file.
      - `repository_root` string, path — The aboslute path to the cPanel-managed repository directory.
      - `repository_state` object — An object containing information about the repository's state at the time of deployment.
        - `author` string — The most-recent commit's author's name and email address as they exist in the user's Git configuration files.
        - `branch` string — The repository's current branch.
        - `date` integer — The timestamp for the most-recent commit, in Unix time format.
        - `identifier` string — The identifier (SHA-1 value) for the most-recent commit.
        - `message` string — The commit message.
      - `sse_url` string, url-path — The SSE interface to track the progress of the deployment process.
      - `task_id` string — The [Task Queue](https://go.cpanel.net/whmdocsTaskQueueMonitor) system's task ID number.
      - `timestamps` object — An object containing timestamps for the deployment process.
        - `active` string — The time at which the system started the deployment process, in Unix time format.
        - `canceled` string — The time at which the system cancelled the deployment process, in Unix time format. **Note:** * The function only returns this value if the system cancelled the deployment process. * The system logs messages for this function in the `~/.cpanel/logs/vc_TIMESTAMP_git_deploy.log` file, where `TIMESTAMP` represents the Unix timestamp.
        - `failed` string — The time at which the deployment process failed, in Unix time format. **Note:** * The function only returns this value if the deployment process failed. * The system logs messages for this function in the `~/.cpanel/logs/vc_TIMESTAMP_git_deploy.log` file, where `TIMESTAMP` represents the Unix timestamp.
        - `queued` string — The time at which the deployment process entered the task queue, in Unix time format.
        - `succeeded` string — The time at which the deployment process finished successfully, in Unix time format. **Note:** The function only returns this value if the deployment process succeeded.
    - `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)