Create project from Git files
POST /project/create-project/{project_path}
Overview
This API creates a project using the files in the specified Git repository and branch.
Note:
You can track a maximum of 1000 assets per project.
If a check-in would exceed 1000 assets in the repository or if you try to check out a project with more than 1000 assets, an error is thrown.
Prerequisites
- Org admin (Environment admin) permissions
- Git hosting provider requirements:
- The Environment/Org must be correctly configured to use a Git hosting provider supported by SnapLogic.
- The user must have an authenticated account with the Git hosting provider.
Learn more: SnapLogic - Git Integration
Request
POST https://{pod_path}/api/1/rest/public/project/create-project/{project_path}
Path Parameters
Key | Description |
---|---|
pod_path |
Required. The path to your SnapLogic pod.
Example: |
project_path |
Required. The path to the SnapLogic project.
Format: Important: The path comparison is case-sensitive.
|
Query Parameters
None.
Request Header
Specify Basic
for authorization and application/json
for content type.
Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json
Request Body
{
"repo" : "...",
"ref" : "..."
}
Key | Type | Description |
---|---|---|
repo |
string | The Git repository containing the files to use with the new project. |
ref |
string | The name of the branch containing the files to use with the new project. |
Response
Response Body
{
"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 | An empty list. No files are overwritten, because the project is new. |
updated |
array | An empty list. No files are updated, because the project is new. |
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. |