Migrate a dashboard to another project

Copies a dashboard to a different project, remapping all resource references (connections, semantic domains, data models, and linked visuals) to their target-project equivalents.

Two-step workflow:

Call migration analysis to discover required resources
Call this endpoint with mappings for each resource

Mapping rules:

connectionMapping — required for every connection. Connections cannot be auto-created.
domainMapping / datamodelMapping / visualMapping — set the value to an existing target resource ID to reuse it, or null to create a copy.
visualMapping supports "unlink" to remove the visual reference instead of copying it.

Set replaceExistingId to overwrite an existing dashboard in the target project instead of creating a new one. A newly created target copies the source dashboard's canonical tags and remains non-public. A replacement keeps the existing target dashboard's tags; this operation accepts no tag override.

Provide commitMessage to commit the resulting target dashboard. The target project's commit-on-save setting determines whether that message is optional or required.

Authorization

BearerAuth

AuthorizationBearer <token>

A project-scoped or dashboard-scoped access token. Generate one via the Token API using your project ID and project secret.

In: header

Path Parameters

dashboardId*string

Dashboard identifier.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

targetProjectId*string

The project to migrate the dashboard into.

title?string

Override the dashboard title in the target project.

description?string

Override the dashboard description in the target project.

connectionMapping*

Map each source connection ID to an existing connection in the target project. Every connection used by the dashboard must be mapped — connections cannot be auto-created.

domainMapping*

Map each source domain ID to a target domain ID (reuse) or null (create a copy).

domainsToCreate*array<string>

Source domain IDs to copy into the target project.

datamodelMapping*

Map each source data model ID to a target ID (reuse) or null (create a copy).

datamodelsToCreate*array<string>

Source data model IDs to copy into the target project.

visualMapping*

Map each source visual ID to a target visual ID (reuse), null (create a copy), or "unlink" (remove the visual reference from the dashboard).

visualsToCreate*array<string>

Source visual IDs to copy into the target project.

replaceExistingId?string

If set, overwrites this existing dashboard in the target project instead of creating a new one.

preserveSharing?boolean

Whether to keep existing sharing entries when replacing a dashboard. Defaults to true.

commitMessage?string

Commit the migrated target dashboard to GitHub with this message. Required when the target project has commit on save enabled.

Length1 <= length

Response Body

`application/json`

curl -X post "https://semaphor.cloud/api/management/v1/dashboards/string/migrate" \  -H "Content-Type: application/json" \  -d '{    "targetProjectId": "string",    "connectionMapping": {      "property1": "string",      "property2": "string"    },    "domainMapping": {      "property1": "string",      "property2": "string"    },    "domainsToCreate": [      "string"    ],    "datamodelMapping": {      "property1": "string",      "property2": "string"    },    "datamodelsToCreate": [      "string"    ],    "visualMapping": {      "property1": "string",      "property2": "string"    },    "visualsToCreate": [      "string"    ]  }'

{
  "success": true,
  "dashboard": {
    "id": "dashboard_target",
    "title": "Operations Dashboard",
    "projectId": "project_target",
    "secret": "dashboard_secret",
    "tags": [
      "audience:operations",
      "product:inbound-ticketing"
    ]
  },
  "createdResources": {
    "domains": [
      {
        "sourceId": "string",
        "newId": "string",
        "name": "string"
      }
    ],
    "datamodels": [
      {
        "sourceId": "string",
        "newId": "string",
        "name": "string"
      }
    ],
    "visuals": [
      {
        "sourceId": "string",
        "newId": "string",
        "name": "string"
      }
    ]
  },
  "replaced": true,
  "versionControl": {
    "status": "committed",
    "commitSha": "string",
    "commitUrl": "http://example.com"
  }
}

{
  "error": "string",
  "code": "string",
  "errorCode": "string",
  "details": {},
  "success": true
}

{
  "error": "string",
  "code": "string",
  "errorCode": "string",
  "details": {},
  "success": true
}

{
  "error": "string",
  "code": "string",
  "errorCode": "string",
  "details": {},
  "success": true
}

{
  "error": "string",
  "code": "string",
  "errorCode": "string",
  "details": {},
  "success": true
}

{
  "error": "string",
  "code": "string",
  "errorCode": "string",
  "details": {},
  "success": true
}

{
  "success": false,
  "error": "string",
  "errorCode": "COMMIT_FAILED",
  "dashboardSaved": true,
  "migration": {
    "success": true,
    "dashboard": {
      "id": "dashboard_target",
      "title": "Operations Dashboard",
      "projectId": "project_target",
      "secret": "dashboard_secret",
      "tags": [
        "audience:operations",
        "product:inbound-ticketing"
      ]
    },
    "createdResources": {
      "domains": [
        {
          "sourceId": "string",
          "newId": "string",
          "name": "string"
        }
      ],
      "datamodels": [
        {
          "sourceId": "string",
          "newId": "string",
          "name": "string"
        }
      ],
      "visuals": [
        {
          "sourceId": "string",
          "newId": "string",
          "name": "string"
        }
      ]
    },
    "replaced": true,
    "versionControl": {
      "status": "committed",
      "commitSha": "string",
      "commitUrl": "http://example.com"
    }
  },
  "versionControl": {
    "status": "committed",
    "commitSha": "string",
    "commitUrl": "http://example.com"
  }
}

Migrate a dashboard to another project

Authorization

Path Parameters

Request Body

Response Body

201application/json

400application/json

403application/json

404application/json

409application/json

500application/json

502application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`