Create Project from Git Files

This page is no longer maintained (Mar 29, 2023). For the most current information, go to https://docs.snaplogic.com/public-apis/post-project-create-project-project-path.html.

 

POST /project/create-project/{project_path}

Overview

This API creates a project using the files in the specified Git repository and branch.

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

  • Org Admin permissions

  • GitHub- or GHES-related requirements:

    • The Org must be correctly configured to use GitHub or GHES.

    • The user must have an authenticated GitHub or GHES account.

    Learn more: SnapLogic - Git Integration

Request

Path Parameters

Key

Description

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}

The path comparison is case-sensitive.

Query Parameters

None.

Request Header

Specify Basic for authorization and application/json for content type.

Request Body

{ "repo" : ..., "ref" : ... }

Key

Type

Description

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

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.