Check Out Project Files from Git
POST /project/checkout/{project_path}
Overview
This API checks out the specified Git branch for the specified project. Equivalent to git checkout
.
You can use Git APIs in Continuous Integration / Continuous Deployment (CI/CD) workflows to pull files from Git repositories. You can use this API to update a project to a newly tagged version or to revert to a previously stable tag.
The project must already exist.
You can track a maximum of 1,000 assets per project. If you try to check out a project with more than 1,000 assets, SnapLogic throws an error.
Prerequisites
Write access to the assets to be added or updated
Request
Path Parameters
Key | Description |
---|---|
| Required. The path to your SnapLogic pod. Example: |
| Required. The path to the SnapLogic Project. Format: The path comparison is case-sensitive. |
Query Parameters
None.
Request Header
Specify Basic
for authorization and application/json
for content type.
Request Body
{
"repo" : "git_repository",
"ref" : "branch_name",
"hard_reset" : true,
"discard_untracked_file" : true
}
Key | Type | Description |
---|---|---|
| string | The Git repository to check out. If not specified, the repository that was previously associated with the project is used. Default: None |
| string | Required. The Git branch to check out. Format: |
| Boolean | If Default: False |
| Boolean | If Default: False |
Response
Response Body
Key | Type | Description |
---|---|---|
| string | The status of the process. |
| array | The list of files that were overwritten. |
| array | The list of files that were updated. |
| array | Any error messages that were thrown during the process. |
| array | Asset files that were copied from the Git repository into the project. |
| array | Asset files that exist in the Git repository but were not copied into the project. |
Related Links
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.