Skip to main content
POST
Error

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.

package_include
string[] | null

Include file patterns to preview for a managed resources package export. None uses the include file at compare_ref.

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.