Create an API version from a project

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, Environment/Org, or Snaplex.

Prerequisites

  • Read access to the source project
  • Write access to the target Org

Request

 POST https://{controlplane_path}/api/1/rest/public/apim/create_from_project

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

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

 {
  "project_path" : "...",
  "plex_path" : "...",
  "api" : "...",
  "version" : "...",
  "tags" : [...],
  "description" : "...",
  "asset_types" : [...]
}
Key Type Description
project_path string
Required. The path to the SnapLogic project.

Format: /{env_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: /{env_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.
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 copy to the new version.
Valid values:
  • Account
  • File
  • Job (task)
  • Pipeline
  • Policy

Default: All valid asset types.

Response

Status code only.