Example

This example uses basic authentication. For a JWT example, refer to Authentication.

Minimal request

curl -X 'POST' \
  'https://elastic.snaplogic.com/api/1/rest/public/apim_service/service_migration' \
  -H 'Authorization: Basic {base64_encoded email:password}' \
  -H 'Content-Type: application/json' \
  -d '{
  "org_name": "snaplogic",
  "migrate_assets": [
    {
      "asset_path": "/snaplogic/apim/MyLegacyApi/1.0",
      "service_config": {
        "target_path": "/snaplogic/projects/destination"
      }
    }
  ]
}'

Full request with policy migration

curl -X 'POST' \
  'https://elastic.snaplogic.com/api/1/rest/public/apim_service/service_migration' \
  -H 'Authorization: Basic {base64_encoded email:password}' \
  -H 'Content-Type: application/json' \
  -d '{
  "org_name": "snaplogic",
  "migrate_assets": [
    {
      "asset_path": "/snaplogic/apim/MyLegacyApi/1.0",
      "service_config": {
        "target_path": "/snaplogic/projects/destination",
        "name": "MyService",
        "slug": "my-service",
        "version": "1.0"
      },
      "policy_config": {
        "migrate_policies": true,
        "policy_path": "/snaplogic/projects/destination/policies"
      }
    }
  ]
}'

Query parameters

None.

Request header

Request body

{
  "org_name": "...",
  "migrate_assets": [
    {
      "asset_path": "...",
      "service_config": {
        "target_path": "...",
        "name": "...",
        "slug": "...",
        "version": "..."
      },
      "policy_config": {
        "migrate_policies": true,
        "policy_path": "..."
      }
    }
  ]
}
        

Key	Type	Description
org_name	string	Required. The name of the environment (Org) for the migration.
migrate_assets	array	Required. A list of asset migration configurations. Each entry specifies a source asset and its migration target.

migrate_assets fields

Key	Type	Description
asset_path	string	Required. The path of the Classic APIM asset to migrate. If the path doesn't start with /, the API adds it automatically. The asset must be an API, API Version, or Proxy.
service_config	object	Required. The Service configuration for the migration target.
policy_config	object	Optional. Policy migration configuration. If omitted, policies aren't migrated.

service_config fields

Key	Type	Description
target_path	string	Required. The destination project path for the migrated Service. The project must exist. If the path doesn't start with /, the API adds it automatically.
name	string	Optional. The name for the new Service. Default: the source asset name.
slug	string	Optional. The slug for the new Service. Default: the name with spaces replaced by underscores. The API auto-increments duplicate slugs.
version	string	Optional. The version name for the migrated Service version. Default: the source version name or 1.0.

policy_config fields

Key	Type	Description
migrate_policies	boolean	Optional. If true, migrate policies from the source asset and apply them to the destination Service. Default: false.
policy_path	string	Required when migrate_policies is true. The destination path for migrated policies. If the path doesn't start with /, the API adds it automatically.

Response

The migration always runs asynchronously. The API returns a status_token for each asset, keyed by snode ID. Use the token with the Get Service migration status API to check migration progress.

{
  "response_map": {
    "<asset_snode_id>": {
      "status_token": "17ed9720-05b2-4e22-9955-04c4534451ae"
    }
  },
  "http_status_code": 200
}
        

Key	Type	Description
<asset_snode_id>	object	Contains one entry per migrated asset, keyed by the asset snode ID.
status_token	string	A UUID token for polling migration progress.

Error handling

HTTP status codes	Message	Resolution
400	Invalid request	Verify that you provided all required fields. Check that asset_path points to a supported asset type (API, API Version, or Proxy) and that target_path points to an existing project.
401	Unauthorized	Verify your credentials and that you have read permission on the source asset.
404	Not Found	Verify the environment name and asset path are correct.