Export a project

GET /project/export/{project_path}

Overview

This API exports a zip file containing the specified project's files.

Prerequisites

  • Org admin (Environment admin) permissions

Request

 GET https://{controlplane_path}/api/1/rest/public/project/export/{project_path}?{query_parameters}

Path Parameters

Key Description
controlplane_path Required. The path to the SnapLogic control plane.

Example: control-plane-name.snaplogic.com

Where control-plane-name is the control plane you are using. For example,
  • elastic
  • uat
  • emea
project_path
Required. The path to the SnapLogic project.

Format: /{env_org}/{project_space}/{project_name}

Important: The path comparison is case-sensitive.

Query Parameters

Key Type Description
asset_types array The list of asset types to export.
Valid values:
  • Account
  • File
  • Job (task)
  • Pipeline

Default: All valid asset types.

force Boolean If true, the project is exported regardless of the file size limit.

Request Header

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

 Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json

Request Body

None.

Response

A zip file containing the project files is downloaded.