Cancel a transfer

All current project members. Responses use Cache-Control: no-store. Creator and current revision required. Cancellation is rejected once atomic apply has started or the job completed. Existing content is preserved.

POST /api/v1/workspaces/{workspaceId}/projects/{projectId}/branches/{branchId}/transfers/{id}/cancel

Operation: cancelTransfer · Download OpenAPI

Access

Requires an authenticated Localisync panel session. The API checks current membership and permissions for workspace operations. See authentication and request rules.

sessionCookie

{
  "type": "apiKey",
  "in": "cookie",
  "name": "__Host-localisync-session",
  "description": "Production Secure HttpOnly session. Explicit local HTTP uses 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.
`Origin`	header	Yes	Must equal the configured panel origin.
`X-CSRF-Token`	header	Yes	Session-bound token from auth/me.

workspaceId

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

projectId

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

branchId

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

id

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

Origin

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

X-CSRF-Token

{
  "type": "string"
}

Request body

Required: Yes.

application/json

Schema reference: Revision.

Field	Type	Required	Constraints / description
`revision`	integer	Yes	maximum: `9007199254740991`

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

Responses

201

Successful response. Queued jobs still require polling; completion is explicit.

Content type: application/json Schema reference: Transfer.

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)$"`
`workspaceId`	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)$"`
`projectId`	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)$"`
`branchId`	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)$"`
`kind`	`import`, `export`	Yes	—
`state`	`mapping`, `queued`, `processing`, `ready`, `applying`, `completed`, `failed`, `conflict`, `cancelled`, `expired`	Yes	—
`revision`	integer	Yes	maximum: `9007199254740991`
`options`	See schema	Yes	—
`files`	Array of object	Yes	—
`discovery`	Array of object	Yes	—
`summary`	object	Yes	—
`artifact`	See schema	Yes	—
`errorCode`	string or null	Yes	—
`createdAt`	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))$"`
`updatedAt`	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))$"`
`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))$"`

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