POST /project/checkout/{project_path}
Overview
This API checks out the specified GitHub Git branch for the specified project. Equivalent to git checkout
.
You can use GitHub Git APIs in Continuous Integration / Continuous Deployment (CI/CD) workflows to pull files from GitHub 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
Appsplus panel macro confluence macro |
---|
data | {"features":["rounded"],"title":"","titleColor":"#FFFFFF","titleColorBG":"#0052CC","titleSize":16,"titleBold":false,"titleItalic":false,"titleUnderline":false,"link":"","linkIcon":false,"linkTab":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#dedede","borderColor":"#4C9AFF","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false} |
---|
|
POST https://{pod_path}/api/1/rest/public/project/checkout/{project_path}
|
Path Parameters
Key | Description |
---|
pod_path
| Required. The path to your SnapLogic pod. Example: elastic.snaplogic.com |
project_path
| Required. The path to the SnapLogic Project. Format: {org}/{project_space}/{project_name} Note |
---|
The path comparison is case-sensitive. |
|
Query Parameters
None.
Specify Basic
for authorization and application/json
for content type.
Appsplus panel macro confluence macro |
---|
data | {"features":["rounded"],"title":"","titleColor":"#FFFFFF","titleColorBG":"#0052CC","titleSize":16,"titleBold":false,"titleItalic":false,"titleUnderline":false,"link":"","linkIcon":false,"linkTab":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#dedede","borderColor":"#4C9AFF","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false} |
---|
|
Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json
|
Request Body
Code Block |
---|
{
"repo" : "git_repository",
"ref" : "branch_name",
"hard_reset" : true,
"discard_untracked_file" : true
} |
Key | Type | Description |
---|
repo
| string | The Git repository to check out. If not specified, the repository that was previously associated with the project is used. Default: None |
ref
| string | Required. The Git branch to check out. Format: git_repository/branch_name |
hard_reset
| Boolean | If true , modified assets are discarded and new assets are force-pulled from the repository. Default: False |
discard_untracked_file
| Boolean | If true , untracked assets are discarded. Default: False |
Response
Response Body
Appsplus panel macro confluence macro |
---|
data | {"features":["rounded"],"title":"","titleColor":"#FFFFFF","titleColorBG":"#0052CC","titleSize":16,"titleBold":false,"titleItalic":false,"titleUnderline":false,"link":"","linkIcon":false,"linkTab":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#dedede","borderColor":"#4C9AFF","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false} |
---|
|
Code Block |
---|
{
"response_map": {
"status": "",
"overwritten": [],
"updated": [],
"error_msgs": [],
"created": [],
"ignored": []
},
"http_status_code": 200
} |
|
Key | Type | Description |
---|
status
| string | The status of the process. |
overwritten
| array | The list of files that were overwritten. |
updated
| array | The list of files that were updated. |
error_msgs
| array | Any error messages that were thrown during the process. |
created
| array | Asset files that were copied from the Git repository into the project. |
ignored
| array | Asset files that exist in the Git repository but were not copied into the project. |
...