# Deployment Settings

GIT Management / Deployment Settings

## Create Git deployment task

 - [GET /VersionControlDeployment/create](https://api.docs.cpanel.net/specifications/cpanel.openapi/deployment-settings/versioncontroldeployment-create.md): 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 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 documentation.

## Delete Git deployment task

 - [GET /VersionControlDeployment/delete](https://api.docs.cpanel.net/specifications/cpanel.openapi/deployment-settings/versioncontroldeployment-delete.md): This function deletes a deployment task. For more information, read our Guide to Git - Deployment documentation.

## Return Git deployment task status

 - [GET /VersionControlDeployment/retrieve](https://api.docs.cpanel.net/specifications/cpanel.openapi/deployment-settings/versioncontroldeployment-retrieve.md): 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 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.