Queue a preview without applying changes

Current membership, explicit branch scope and version checks apply. Previews expire after 24 hours. A pull request is not synchronized until the actual merge result is verified. See the Git synchronization guide for permissions and recovery.

POST /api/v1/workspaces/{workspaceId}/projects/{projectId}/branches/{branchId}/git-sync/mappings/{id}/previews

Operation: createGitPreview · Download OpenAPI

Access

This operation does not use the panel session as its authentication mechanism. Follow the operation-specific checks described above.

session

{
  "type": "apiKey",
  "in": "cookie",
  "name": "__Host-localisync-session"
}

Parameters

Name	Location	Required	Description
`workspaceId`	path	Yes	See constraints below.
`projectId`	path	Yes	See constraints below.
`branchId`	path	Yes	See constraints below.
`id`	path	Yes	See constraints below.
`X-CSRF-Token`	header	Yes	See constraints below.
`Origin`	header	Yes	See constraints below.
`Idempotency-Key`	header	Yes	See constraints below.

workspaceId

{
  "type": "string",
  "format": "uuid"
}

projectId

{
  "type": "string",
  "format": "uuid"
}

branchId

{
  "type": "string",
  "format": "uuid"
}

id

{
  "type": "string",
  "format": "uuid"
}

X-CSRF-Token

{
  "type": "string"
}

Origin

{
  "type": "string",
  "format": "uri"
}

Idempotency-Key

{
  "type": "string",
  "format": "uuid"
}

Request body

Required: Yes.

application/json

Schema reference: Preview.

Field	Type	Required	Constraints / description
`direction`	`import`, `export`	Yes	—

{
  "$ref": "#/components/schemas/Preview"
}

Responses

202

Operation accepted or result returned. Remote completion is indicated only by the job state.

Content type: application/json Schema reference: Job.

Field	Type	Required	Constraints / description
`id`	string	Yes	format: `"uuid"`; pattern: `"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}\|00000000-0000-0000-0000-000000000000\|ffffffff-ffff-ffff-ffff-ffffffffffff)$"`
`mappingId`	string	Yes	format: `"uuid"`; pattern: `"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}\|00000000-0000-0000-0000-000000000000\|ffffffff-ffff-ffff-ffff-ffffffffffff)$"`
`direction`	`import`, `export`	Yes	—
`state`	`queued`, `processing`, `ready`, `approved`, `sending`, `open`, `completed`, `failed`, `outcome_unknown`, `cancelled`, `expired`	Yes	—
`version`	integer	Yes	maximum: `9007199254740991`
`error`	string or null	Yes	—
`expiresAt`	string	Yes	format: `"date-time"`; pattern: `"^(?:(?:\\d\\d[2468][048]\|\\d\\d[13579][26]\|\\d\\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\\d\|30)\|(?:02)-(?:0[1-9]\|1\\d\|2[0-8])))T(?:(?:[01]\\d\|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"`
`request`	See schema	Yes	—
`preview`	See schema	Yes	—

{
  "$ref": "#/components/schemas/Job"
}