Migration · version 0.1.0

Get migration workspace summary

GET/api/migration/summary

Returns the migration workspace's high-level status: capability flags, latest report, language summaries, drift, docs scan results, and the SEO queue. Used by the dashboard "Welcome" view; safe to call without an active migration.

Request

cURL

curl -X GET 'https://sourced.sh/api/migration/summary' \
  -H 'Authorization: Bearer $SOURCED_API_KEY'

TypeScript

const response = await fetch("https://sourced.sh/api/migration/summary", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.SOURCED_API_KEY}`,
  },
});
const data = await response.json();

Python

import os
import requests

response = requests.request(
    "GET",
    "https://sourced.sh/api/migration/summary",
    headers={"Authorization": f"Bearer {os.environ['SOURCED_API_KEY']}"},
)

data = response.json()

Responses

200

Workspace summary.

application/json

Schema

MigrationSummary:
  type: object
  required: capabilities, project
  properties:
    capabilities (required): Capabilities
      Capabilities:
        type: object
    project (required): object
      type: object
      required: name
      properties:
        name (required): string
        baseUrl: string
    status: array
      type: array
    languages: array
      type: array
    reports: array
      type: array
    controlPlane: object

500

Persistence setup failed (e.g. misconfigured DATABASE_URL).

application/json

Schema

Error:
  type: object
  required: error
  properties:
    error (required): string
      Stable machine-readable error code.
    message: string
      Optional human-readable description.