Skip to main content
POST
/
workspaces
/
{workspace_id}
/
workflows
/
sync
/
export
/
preview
Error
A valid request URL is required to generate request examples
{
  "resource_counts": {},
  "files": [
    "<string>"
  ],
  "resources": [
    {
      "source_id": "<string>",
      "name": "<string>",
      "path": "<string>"
    }
  ],
  "resource_diffs": [
    {
      "resource_type": "<string>",
      "source_id": "<string>",
      "source_path": "<string>",
      "title": "<string>",
      "diff": "<string>",
      "truncated": false
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

​
fastapiusersauth
string
cookie
required

Path Parameters

​
workspace_id
string<uuid>
required

Body

application/json

Request a dry-run projection of what an export would push to Git.

​
resources
ResourceRef · object[] | null

Specific resources to preview, or None for all.

​
include_schedules
boolean
default:false

Whether to include workflow schedules in the preview.

​
compare_ref
string | null

Repository ref to compare the projected export against. When omitted, the preview only returns the export manifest summary.

Response

Successful Response

Projection summary of the resources an export would commit.

Mirrors the pull dry-run preview: it projects the selected resources locally without writing to Git or mutating sync mappings.

​
resource_counts
Resource Counts · object
required

Count of resources to commit, keyed by resource type.

​
files
string[]
required

Repository-relative paths the export would write.

​
resources
WorkspaceSyncPreviewResource · object[]

Displayable resources included in the export preview.

​
resource_diffs
PullResourceDiff · object[]

Per-resource file diffs between the comparison ref and projected export.