Create a branch from a snapshot

Owner/Admin/Editor. Source token must match. Copies all keys, languages, tags and file identities, including archived or inactive content; transfer jobs and private files are not copied. Limits: 10,000 keys, 50,000 values, 100 MiB.

POST /api/v1/workspaces/{workspaceId}/projects/{projectId}/branches

Operation: forkBranch · 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.
`Origin`	header	Yes	See constraints below.
`X-CSRF-Token`	header	Yes	See constraints below.
`Idempotency-Key`	header	Yes	See constraints below.

workspaceId

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

projectId

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

Origin

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

X-CSRF-Token

{
  "type": "string"
}

Idempotency-Key

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

Request body

Required: Yes.

application/json

Schema reference: Fork.

Field	Type	Required	Constraints / description
`name`	string	Yes	minLength: `1`; maxLength: `100`
`sourceId`	string	Yes	format: `"uuid"`
`sourceToken`	string	Yes	pattern: `"^[0-9]+$"`

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

Responses

202

Operation queued; poll its state.

Response headers:

{
  "Cache-Control": {
    "schema": {
      "type": "string",
      "const": "no-store"
    }
  }
}

Content type: application/json Schema reference: BranchJob.

Field	Type	Required	Constraints / description
`id`	string	Yes	format: `"uuid"`
`workspaceId`	string	Yes	format: `"uuid"`
`projectId`	string	Yes	format: `"uuid"`
`kind`	`fork`, `compare`, `merge`, `delete`	Yes	—
`state`	`queued`, `processing`, `ready`, `completed`, `failed`, `conflict`, `cancelled`, `expired`	Yes	—
`version`	integer	Yes	minimum: `1`; maximum: `2147483646`
`summary`	object	Yes	—
`resultBranchId`	See schema	Yes	—
`appliedJobId`	See schema	Yes	—
`errorCode`	See schema	Yes	—
`createdAt`	string	Yes	format: `"date-time"`
`expiresAt`	string	Yes	format: `"date-time"`
`sourceBranchId`	See schema	Yes	—
`targetBranchId`	See schema	Yes	—
`actorId`	string	Yes	format: `"uuid"`

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