Create an API Version from a Project

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

 

POST /apim/create_from_project

Overview

This API creates an API version using the assets of an existing project.

The destination version can be in the same or another API, Project, Org, or Snaplex.

Prerequisites

  • Read access to the source project

  • Write access to the target Org

Request

Path Parameters

Key

Description

Key

Description

pod_path

Required. The path to your SnapLogic pod.

Example: elastic.snaplogic.com

Query Parameters

None.

Request Header

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

Request Body

{ "project_path" : ..., "plex_path" : ..., "api" : ..., "version" : ..., "tags" : [...], "description" : ..., "asset_types" : [...] }

Key

Type

Description

Key

Type

Description

project_path

string

Required. The path to the SnapLogic project.

Format: /{org}/{project_space}/{project_name}

Important: The path comparison is case-sensitive.

plex_path

string

The path to the Snaplex.

  • The path comparison is case-sensitive.

  • The path must be URL-escaped. That is, spaces must be replaced with %20.

Format: /{org}/{project_space}/{project_name}/{snaplex_name}

api

string

The name of the API for which to create a new version.

version

string

The new version. If not provided, the highest version number incremented by one is used.

tags

array

Tags to associate with the new version.

Default: An empty array

description

string

Additional information to associate with the new version.

Default: An empty string

asset_types

array

The list of asset types to export.

Valid values:

  • Account

  • File

  • Job

  • Pipeline

  • Policy

Default: All valid asset types.