--- title: "Migrate Public API" slug: "migrate-public-api" updated: 2026-11-03T12:52:05Z published: 2026-11-03T12:52:05Z canonical: "skthelp.syniti.com/migrate-public-api" --- > ## Documentation Index > Fetch the complete documentation index at: https://skthelp.syniti.com/llms.txt > Use this file to discover all available pages before exploring further. # Migrate Public API ### Overview Syniti Migrate Public API enables organizations to automate enterprise data migrations at scale. You can programmatically orchestrate the entire migration lifecycle—from project setup and datasource integration to mapping, testing, and deployment—while maintaining complete traceability of data transformations and ensuring compliance requirements are met. The API provides comprehensive control across project governance, data integration, transformation, testing automation, and deployment. You can create migration projects, register datasources, define business data mappings, and execute snapshot-based replication jobs. Migrate Public API is tenant-specific and supports the following authentication types: - [SKP OAuth 2.0 Bearer Token](/v1/docs/migrate-public-api#skp-oauth-20-bearer-token) - [API Key](/v1/docs/migrate-public-api#create-a-migrate-public-api-token1) To access public API reference documentation, replace in the following URL with your tenant name: https://.migrate.syniti.com/swagger/index.html ### SKP OAuth 2.0 Bearer Token You can authenticate using OAuth 2.0 with the Client Credentials grant type. The authentication process is a two-step workflow: 1. [Obtain a Bearer Token](/v1/docs/migrate-public-api#obtain-a-bearer-token) 2. [Use the Bearer Token in Migrate Public API Requests](/v1/docs/migrate-public-api#use-the-bearer-token-in-migrate-public-api-requests) #### Prerequisites Raise a [support ticket](/v1/docs/contact-support#contact-syniti-support) to configure an API User account to enable the API to perform tasks for your tenant. This account provides credentials for API operations. When those operations are completed, assets indicate that the API User completed them. #### Obtain a Bearer Token Request an access token by calling the OAuth 2.0 token endpoint with your API User credentials (client ID and client secret). **Authorization Endpoint** ```plaintext curl -X POST https://api.syniti.com/oauth2/tokens \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "grant_type=client_credentials" \ -d "client_id=YOUR_CLIENT_ID" \ -d "client_secret=YOUR_CLIENT_SECRET" ``` **Response** ```plaintext { "access_token": "eyJhbG.............................", "expires_in": 900 } ``` > [!NOTE] > Note > > Enter the appropriate endpoint based on your region. > > - **Americas:** https://api.syniti.com/oauth2/tokens > - **EMEA:** https://api.syniti.eu/oauth2/tokens > - **Australia:** https://api.syniti.au/oauth2/tokens > - **Canada:** https://api.syniti.ca/oauth2/tokens #### Use the Bearer Token in Migrate Public API Requests Include the bearer token in the **Authorization** header for all API calls. **Header Format** ```plaintext Authorization: Bearer ``` **Example API Call** ```plaintext curl -X POST https://.migrate.syniti.com/vl/testing-datasets \  -H 'Authorization: Bearer eyJhbG.............................' \  -H 'Content-Type: application/json' \  -d '{    "name": "BD9 - Sales Order Creation: BD9",    "description": "BD9 - Sales Order Creation",    "test_dataset_id": "TDS-01KC2JK4JJTZD0ZQP07JDDFPHV", "test_created_by": "Bob Jones",    "test_created_on": "2020-01-01",    "test_updated_by": "Bob Jones",    "test_updated_on": "2020-01-01" }' ``` > [!NOTE] > Note > > Bearer tokens expire after 15 minutes. Always refresh your token before expiration to avoid 401 Unauthorized errors during API operations. If needed, implement automatic token refresh when receiving unauthorized errors. ### Create a Migrate Public API Token > [!NOTE] > Note > > Previously known as the report refresh token, the Migrate Public API Token now supports integration with any external system. Both the `report-refresh-token` and `api-key` headers are accepted for backward compatibility, though `api-key` is the recommended approach for new implementations. This token, which is specific to the user and the tenant, is used to access Migrate API and integrate with external systems, for example, accessing Data Services systems for Migration Reporting. The reporting API must be secure. The communication between Data Services and the reporting API must have a type of password access for security. The token is that security. To create a Migrate Public API token: 1. Click the **User Profile** ![](https://cdn.document360.io/ca09b4e9-1857-4c63-9f0e-1f25f166f447/Images/Documentation/7d8bbc6d-ef4e-4db7-a1cb-a2a3786f2f0b.png?sv=2026-02-06&spr=https&st=2026-11-17T19%3A15%3A13Z&se=2026-11-17T20%3A15%3A13Z&sr=b&sp=r&sig=Nt7tRnWK1d56w1g%2FdEu%2BqEIFOeCx6eHq%2Fw%2BYgjM7rLs%3D) icon and select **My Profile**. 2. Under Migrate Public API Token, click the **Create New Token** button to generate a new API token. This token GUID can be used in Data Services to provide security for running reporting. 3. Click the **Continue** button on the Validation warning. > [!NOTE] > Note > > Store this Migrate Public API token in a secure location, as you cannot view the token after it is initially created. Migrate hashes this token against the token stored, and if they don't match, it does not run the reports in the integrated systems. This new Authorization Policy is in effect only in the Migration Reports Refresh area. If a user has authenticated via a token, then they are allowed to hit these endpoints.. That is the only area of Migrate that these tokens grant access to. > [!NOTE] > Note > > In Data Services, you must add this token in the User Specific Variables section. #### Use the Public API Token You can use this token to authenticate API requests by including it in the HTTP header: - **Recommended:** Use the `api-key` header: `api-key: <your-token>` - **Legacy:** Use the `report-refresh-token` header: `report-refresh-token: <your-token>` Both headers are supported for backward compatibility. #### Data Services Integration (Legacy) 1. In Data Services, create the WebService Datastore. 2. Add the Migrate Public API Token to the **Standard HTTP Header Fields** section as shown below. After clicking the detail for the Standard HTTP Header Fields option, paste the Migrate Public API Token into the **Default Value** field. - Header Name: `api-key` (or `report-refresh-token` for legacy systems) - Default Value: `<your-public-api-token>` ![](https://cdn.document360.io/ca09b4e9-1857-4c63-9f0e-1f25f166f447/Images/Documentation/802bd1f2-31cb-4b29-873e-70c118030a26.png?sv=2026-02-06&spr=https&st=2026-11-17T19%3A15%3A13Z&se=2026-11-17T20%3A15%3A13Z&sr=b&sp=r&sig=DQyttEriJe13%2B230vEhQ4ma%2FZN%2FtZcA%2BD8uDbl2w%2Foo%3D) Datastore for xAppMigrate_WebService 3. Click **OK**. ### Related Articles [Knowledge Platform API](/v1/docs/knowledge-platform-api)