Migration

30 Endpunkte. Basis-URL: https://xapi.ambertech.cloud/api/v1

List migration source connections#

GET/migration/connectionsToken

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/migration/connections" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create a migration source connection (secret encrypted at rest)#

POST/migration/connectionsToken

Request-Body`application/jsonCreateConnectionDto`

Name	Typ	Beschreibung
`name`Pflicht	`string`	Human-readable connection name (unique per organization)
`product`Pflicht	`string`	Werte: `jiraconfluence`
`base_url`Pflicht	`string`	Base URL of the Jira/Confluence instance, e.g. https://acme.atlassian.net or http://host:8080
`auth_type`Pflicht	`string`	Werte: `basicpatoauth`
`auth_username`	`string`	Username (Server) or email (Cloud) — required for basic auth
`secret`Pflicht	`string`	Password / API token / PAT. Write-only — encrypted at rest, never returned.
`allow_insecure_http`	`boolean`	Allow plain HTTP (on-prem boxes without TLS)
`allow_private_networks`	`boolean`	Allow private/internal network targets (on-prem installs only)

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/migration/connections" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","product":"jira","base_url":"…","auth_type":"basic","secret":"…"}'

Partial-tolerant preview of a Jira project (counts + warnings) before job creation#

GET/migration/connections/{connectionId}/discovery/previewToken

Parameter

Name	Ort	Typ	Beschreibung
`connectionId`Pflicht	Pfad	`string`	–
`projectKey`Pflicht	Query	`string`	Jira project key to preview, e.g. "KAN"
`provisionUsers`	Query	`boolean`	Model a provisioning-enabled run: report which users WOULD get an account. Still read-only — nothing is created and no mail is sent.
`inviteUsers`	Query	`boolean`	Model an invite-enabled run: report who WOULD be invited and with which org role. Still read-only.

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/migration/connections/{connectionId}/discovery/preview" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List migratable sources (Jira projects) on a connection#

GET/migration/connections/{connectionId}/discovery/sourcesToken

Parameter

Name	Ort	Typ	Beschreibung
`connectionId`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/migration/connections/{connectionId}/discovery/sources" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Lightweight preview of a Confluence space (page count + warnings) before job creation#

GET/migration/connections/{connectionId}/discovery/space-previewToken

Parameter

Name	Ort	Typ	Beschreibung
`connectionId`Pflicht	Pfad	`string`	–
`spaceKey`Pflicht	Query	`string`	Confluence space key to preview, e.g. "M0"

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/migration/connections/{connectionId}/discovery/space-preview" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Read-only user mapping preview: email matches vs would-be placeholders (creates nothing, sends nothing)#

GET/migration/connections/{connectionId}/discovery/users-previewToken

Parameter

Name	Ort	Typ	Beschreibung
`connectionId`Pflicht	Pfad	`string`	–
`projectKey`Pflicht	Query	`string`	Jira project key to preview, e.g. "KAN"
`provisionUsers`	Query	`boolean`	Model a provisioning-enabled run: report which users WOULD get an account. Still read-only — nothing is created and no mail is sent.
`inviteUsers`	Query	`boolean`	Model an invite-enabled run: report who WOULD be invited and with which org role. Still read-only.

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/migration/connections/{connectionId}/discovery/users-preview" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Get a migration source connection#

GET/migration/connections/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/migration/connections/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Update a migration source connection#

PATCH/migration/connections/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/jsonUpdateConnectionDto`

Name	Typ	Beschreibung
`name`	`string`	–
`base_url`	`string`	–
`auth_type`	`string`	Werte: `basicpatoauth`
`auth_username`	`string`	–
`secret`	`string`	New secret; omit to keep the existing one
`allow_insecure_http`	`boolean`	–
`allow_private_networks`	`boolean`	–

Antworten

200OK

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/migration/connections/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","base_url":"…","auth_type":"basic"}'

Delete a migration source connection#

DELETE/migration/connections/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/migration/connections/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Test a saved connection; persists detected deployment/version#

POST/migration/connections/{id}/testToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/migration/connections/{id}/test" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Test connection credentials without saving#

POST/migration/connections/testToken

Request-Body`application/jsonTestConnectionDto`

Name	Typ	Beschreibung
`product`Pflicht	`string`	Werte: `jiraconfluence`
`base_url`Pflicht	`string`	–
`auth_type`Pflicht	`string`	Werte: `basicpatoauth`
`auth_username`	`string`	–
`secret`Pflicht	`string`	Password / API token / PAT (not persisted for an ad-hoc test)
`allow_insecure_http`	`boolean`	–
`allow_private_networks`	`boolean`	–

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/migration/connections/test" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"product":"jira","base_url":"…","auth_type":"basic","secret":"…"}'

List migration jobs#

GET/migration/jobsToken

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/migration/jobs" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create a migration job (draft)#

POST/migration/jobsToken

Request-Body`application/jsonCreateMigrationJobDto`

Name	Typ	Beschreibung
`name`Pflicht	`string`	Human-readable job name (unique per organization)
`connection_id`Pflicht	`string`	Migration connection id (same organization)
`source_kind`Pflicht	`string`	Werte: `jira_projectconfluence_space`
`source_ref`Pflicht	`string`	Source reference — Jira project key or Confluence space key
`target_space_id`	`string`	Existing target space id (same organization); omitted when the migration creates a new space
`scope`Pflicht	`MigrationScopeDto`	–
`scope.issue_type_ids`	`string[]`	Source issue type ids to include; omitted/empty means all issue types
`scope.include_boards`Pflicht	`boolean`	Include boards (and their sprints)
`scope.include_comments`Pflicht	`boolean`	Include issue comments
`scope.include_attachments`Pflicht	`boolean`	Include attachments
`scope.include_links`Pflicht	`boolean`	Include issue links
`scope.jql`	`string`	Optional JQL filter narrowing which issues are migrated
`options`Pflicht	`MigrationOptionsDto`	–
`options.mode`Pflicht	`string`	Werte: `dry_runlive`
`options.batch_size`Pflicht	`number`	Items per batch when iterating the source (10–100)
`options.macro_strategy`Pflicht	`string`	Werte: `semanticfallback`
`options.user_mapping`Pflicht	`string`	Werte: `match_or_placeholder`
`options.provision_users`	`boolean`	Create a real XISUITE account for every source user who has a usable email and no existing account, and mail them a set-password link. Defaults to false. Outward-facing and irreversible (real logins, one message per user through the deployment's own relay), so review the dry-run preview's `wouldCreate` list before enabling it. Standard: `false`
`options.invite_users`	`boolean`	Invite every source user who has a usable email but no account in this organization. Jira administrators are invited as admin, everyone else as member; accepting hands them their migrated work and project roles. Defaults to false; never sends during a dry run. Standard: `false`

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/migration/jobs" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","connection_id":"…","source_kind":"jira_project","source_ref":"…","scope":"…","options":"…"}'

Get a migration job#

GET/migration/jobs/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/migration/jobs/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Update a migration job (connection/source are immutable after creation)#

PATCH/migration/jobs/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/jsonUpdateMigrationJobDto`

Name	Typ	Beschreibung
`name`	`string`	Human-readable job name (unique per organization)
`target_space_id`	`string`	Existing target space id (same organization)
`scope`	`MigrationScopeDto`	–
`scope.issue_type_ids`	`string[]`	Source issue type ids to include; omitted/empty means all issue types
`scope.include_boards`Pflicht	`boolean`	Include boards (and their sprints)
`scope.include_comments`Pflicht	`boolean`	Include issue comments
`scope.include_attachments`Pflicht	`boolean`	Include attachments
`scope.include_links`Pflicht	`boolean`	Include issue links
`scope.jql`	`string`	Optional JQL filter narrowing which issues are migrated
`options`	`MigrationOptionsDto`	–
`options.mode`Pflicht	`string`	Werte: `dry_runlive`
`options.batch_size`Pflicht	`number`	Items per batch when iterating the source (10–100)
`options.macro_strategy`Pflicht	`string`	Werte: `semanticfallback`
`options.user_mapping`Pflicht	`string`	Werte: `match_or_placeholder`
`options.provision_users`	`boolean`	Create a real XISUITE account for every source user who has a usable email and no existing account, and mail them a set-password link. Defaults to false. Outward-facing and irreversible (real logins, one message per user through the deployment's own relay), so review the dry-run preview's `wouldCreate` list before enabling it. Standard: `false`
`options.invite_users`	`boolean`	Invite every source user who has a usable email but no account in this organization. Jira administrators are invited as admin, everyone else as member; accepting hands them their migrated work and project roles. Defaults to false; never sends during a dry run. Standard: `false`
`status`	`string`	Werte: `draftready`

Antworten

200OK

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/migration/jobs/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","target_space_id":"…","scope":"…"}'

Delete a migration job#

DELETE/migration/jobs/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/migration/jobs/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Start a run for a saved job (defaults to dry-run)#

POST/migration/jobs/{jobId}/runsToken

Parameter

Name	Ort	Typ	Beschreibung
`jobId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonStartRunDto`

Name	Typ	Beschreibung
`mode`	`string`	Werte: `dry_runlive`

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/migration/jobs/{jobId}/runs" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"mode":"dry_run"}'

Undo a migration: delete everything this job created (requires the job name as confirmation)#

POST/migration/jobs/{jobId}/undoToken

Parameter

Name	Ort	Typ	Beschreibung
`jobId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonDeleteTargetsDto`

Name Typ Beschreibung

Name	Typ	Beschreibung
`confirm_job_name`Pflicht	`string`	The exact name of the job being undone, retyped. Must match, or the request is rejected. Beispiel: `SDP → Engineering`

confirm_job_namePflicht

string

The exact name of the job being undone, retyped. Must match, or the request is rejected.

Beispiel: SDP → Engineering

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/migration/jobs/{jobId}/undo" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"confirm_job_name":"SDP → Engineering"}'

List runs (optionally for one job)#

GET/migration/runsToken

Parameter

Name	Ort	Typ	Beschreibung
`job_id`	Query	`string`	Filter runs to one job

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/migration/runs" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Get one run with live item counts#

GET/migration/runs/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/migration/runs/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Cancel a run; open items are skipped#

POST/migration/runs/{id}/cancelToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/migration/runs/{id}/cancel" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List a run’s work items (filterable by status/stage)#

GET/migration/runs/{id}/itemsToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–
`status`	Query	`string`	Werte: `pendingrunningsleepingsucceededfailedskippedpausedblockeddead`
`stage`	Query	`string`	–
`limit`	Query	`number`	–
`offset`	Query	`number`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/migration/runs/{id}/items" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List a run’s structured logs (newest first)#

GET/migration/runs/{id}/logsToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–
`level`	Query	`string`	Werte: `debuginfowarnerror`
`limit`	Query	`number`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/migration/runs/{id}/logs" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Pause a running run (in-flight items finish)#

POST/migration/runs/{id}/pauseToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/migration/runs/{id}/pause" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create a non-destructive repair run for a completed live import#

POST/migration/runs/{id}/repairToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/jsonRepairRunDto`

Name	Typ	Beschreibung
`scope`	`string`	Werte: `profile_macros`

Antworten

200OK

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/migration/runs/{id}/repair" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"scope":"profile_macros"}'

Migration audit report for a run (json | csv | pdf)#

GET/migration/runs/{id}/reportToken

Parameter

Name Ort Typ Beschreibung

idPflicht Pfad string –

format

Query

string

Response format. Defaults to json.

Werte: jsoncsvpdf

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/migration/runs/{id}/report" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List sanitized audit rows for a migration report#

GET/migration/runs/{id}/report/itemsToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–
`status`	Query	`string`	Werte: `pendingrunningsleepingsucceededfailedskippedpausedblockeddead`
`stage`	Query	`string`	–
`entity_type`	Query	`string`	–
`item_kind`	Query	`string`	Werte: `collectionentity`
`limit`	Query	`number`	–
`offset`	Query	`number`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/migration/runs/{id}/report/items" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Resume a paused run#

POST/migration/runs/{id}/resumeToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/migration/runs/{id}/resume" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Re-queue failed/dead items and reopen the run#

POST/migration/runs/{id}/retry-failedToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/migration/runs/{id}/retry-failed" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Stream live run state via Server-Sent Events#

GET/migration/runs/{id}/streamToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/migration/runs/{id}/stream" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Migration

List migration source connections#

Antworten

Create a migration source connection (secret encrypted at rest)#

Request-Bodyapplication/jsonCreateConnectionDto

Antworten

Partial-tolerant preview of a Jira project (counts + warnings) before job creation#

Parameter

Antworten

List migratable sources (Jira projects) on a connection#

Parameter

Antworten

Lightweight preview of a Confluence space (page count + warnings) before job creation#

Parameter

Antworten

Read-only user mapping preview: email matches vs would-be placeholders (creates nothing, sends nothing)#

Parameter

Antworten

Get a migration source connection#

Parameter

Antworten

Update a migration source connection#

Parameter

Request-Bodyapplication/jsonUpdateConnectionDto

Antworten

Delete a migration source connection#

Parameter

Antworten

Test a saved connection; persists detected deployment/version#

Parameter

Antworten

Test connection credentials without saving#

Request-Bodyapplication/jsonTestConnectionDto

Antworten

List migration jobs#

Antworten

Create a migration job (draft)#

Request-Bodyapplication/jsonCreateMigrationJobDto

Antworten

Get a migration job#

Parameter

Antworten

Update a migration job (connection/source are immutable after creation)#

Parameter

Request-Bodyapplication/jsonUpdateMigrationJobDto

Antworten

Delete a migration job#

Parameter

Antworten

Start a run for a saved job (defaults to dry-run)#

Parameter

Request-Bodyapplication/jsonStartRunDto

Antworten

Undo a migration: delete everything this job created (requires the job name as confirmation)#

Parameter

Request-Bodyapplication/jsonDeleteTargetsDto

Antworten

List runs (optionally for one job)#

Parameter

Antworten

Get one run with live item counts#

Parameter

Antworten

Cancel a run; open items are skipped#

Parameter

Antworten

List a run’s work items (filterable by status/stage)#

Parameter

Antworten

List a run’s structured logs (newest first)#

Parameter

Antworten

Pause a running run (in-flight items finish)#

Parameter

Antworten

Create a non-destructive repair run for a completed live import#

Parameter

Request-Bodyapplication/jsonRepairRunDto

Antworten

Migration audit report for a run (json | csv | pdf)#

Request-Body`application/jsonCreateConnectionDto`

Request-Body`application/jsonUpdateConnectionDto`

Request-Body`application/jsonTestConnectionDto`

Request-Body`application/jsonCreateMigrationJobDto`

Request-Body`application/jsonUpdateMigrationJobDto`

Request-Body`application/jsonStartRunDto`

Request-Body`application/jsonDeleteTargetsDto`

Request-Body`application/jsonRepairRunDto`