Get Service migration status

GET https://{controlplane_path}/api/1/rest/public/apim_service/migration_status/{org_name}

Retrieve the migration status for one or more Service version migrations, or list all migration records for an environment filtered by status.

Important: This API applies to APIM 3.0, not Classic APIM.

Prerequisites

Environment admin permissions.

By status token

Retrieve the migration status for one or more migrations identified by their status tokens.

GET https://{controlplane_path}/api/1/rest/public/apim_service/migration_status/{org_name}?status_token={token1}&status_token={token2}

By status type

Retrieve all migration records for an environment, filtered by status type.

GET https://{controlplane_path}/api/1/rest/public/apim_service/migration_status/{org_name}/all?status_type={status_type}

Example

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

The following cURL examples use my-environment for the environment name.

By status token:

curl -X 'GET' \
  'https://elastic.snaplogic.com/api/1/rest/public/apim_service/migration_status/my-environment?status_token=17ed9720-05b2-4e22-9955-04c4534451ae' \
  -H 'Authorization: Basic {base64_encoded email:password}'

By status type:

curl -X 'GET' \
  'https://elastic.snaplogic.com/api/1/rest/public/apim_service/migration_status/my-environment/all?status_type=Completed' \
  -H 'Authorization: Basic {base64_encoded email:password}'

Path parameters


Key	Description
`controlplane_path`	Required. The path to the SnapLogic control plane: `elastic.snaplogic.com` For the UAT or EMEA control plane, substitute the name for `elastic`. For example: `uat.elastic.snaplogic.com` `emea.snaplogic.com`
`org_name`	The name of the environment (Org).

Query parameters


Key	Description
`status_token`	The token returned by a migration request. You can provide multiple `status_token` parameters to check the status of multiple migrations in a single request. Used with the `/{org_name}` path.
`status_type`	Filter migration records by status. Accepted values: `Started`, `Completed`, `Failed`. Used with the `/{org_name}/all` path.

Request header

Use the application/json content type with basic authentication (email and password) or a JWT. For examples, refer to Authentication.

Request body

None.

Response

By status token — The response maps each token to its status document:


{
  "response_map": {
    "17ed9720-05b2-4e22-9955-04c4534451ae": {
      "status": "Completed",
      "asset_snid": "...",
      "asset_type": "API_SERVICE_VERSION",
      "target_path": "target-env/my-proj-space/my-proj",
      "service_name": "BookStoreService",
      "service_slug": "bookstore-service",
      "user_id": "[email protected]",
      "create_time": "2026-04-28T10:30:00.000000",
      "completed_time": "2026-04-28T10:30:45.000000",
      "status_token": "17ed9720-05b2-4e22-9955-04c4534451ae"
    }
  },
  "http_status_code": 200
}

If a token is not found, the value is {"status": "Not Found"}.

By status type — The response maps each status type to an array of matching records:


{
  "response_map": {
    "Completed": [
      {
        "status": "Completed",
        "asset_snid": "...",
        "target_path": "...",
        "user_id": "[email protected]",
        "create_time": "2026-04-28T10:30:00.000000",
        "completed_time": "2026-04-28T10:30:45.000000"
      }
    ]
  },
  "http_status_code": 200
}


Key	Type	Description
`status`	string	The migration status: `Started`, `Migrating`, `Completed`, or `Failed`.
`asset_snid`	string	The snode ID of the asset being migrated.
`asset_type`	string	The type of the asset being migrated.
`target_path`	string	The destination path for the migration.
`service_name`	string	The name of the target Service. Present after migration begins.
`service_slug`	string	The slug identifier of the target Service. Present after migration begins.
`user_id`	string	The email address of the user who initiated the migration.
`create_time`	string	The timestamp when the migration was created.
`completed_time`	string	The timestamp when the migration completed. Present only for completed migrations.
`status_token`	string	The unique identifier for this migration.

Error handling


HTTP status codes	Message	Resolution
401	Unauthorized	Verify your credentials and that you have Environment admin privileges.
404	Not Found	Verify the environment name and status token are correct.