Migrate an API version

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

 

POST /apim/migrate_version/{version_path}

 

Overview

This API migrates an API version, including the selected asset types, to another version.

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

version_path

Required. The path of the source API version.

Format: {org}/apim/{apiname}/{apiversion}

Example: snaplogic/apim/My%20User%20API/1.0

Query Parameters

None.

Request Header

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

Request Body

Key

Type

Description

Key

Type

Description

dest_version_path

string

The path to the destination API version.

  • The path comparison is case-sensitive.

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

Format: /{org}/apim/{api_name}/{api_version}

dest_plex_path

string

The path to the destination 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}

asset_types

array

The list of asset types to migrate.

Valid values:

  • Account

  • File

  • Job

  • Pipeline

  • Policy

Default: All valid asset types.

If you are migrating or copying accounts or policies to a different Org,

  • The source Org must recognize the destination Org as a Trusted Org.

  • The destination Org must have at least the same security level as the source Org.

Learn how to add a trusted Org.

duplicate_check

Boolean

If true, throws an exception if a project with the same name already exists at the specified path.

If false, overwrites any existing project with the same name at the specified path.

Default: true

Response

Response Body

{ "response_map": { "successful": [ { "snode_id": "...", "name": "..." }, ... ], "failed": [], "warnings": [] }, "http_status_code": 200 }

 

Key

Type

Description

Key

Type

Description

snode_id

string

The ID of the asset in the destination JCC node.

name

string

The name of the copied asset.

Â