Create a distribution with fixed channels

Owner/Admin, active workspace and project required. Permissions are checked again before commit.

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

Operation: createDistribution · 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": "The local HTTP exception uses the configured development session cookie."
}

Parameters

Name	Location	Required	Description
`workspaceId`	path	Yes	See constraints below.
`projectId`	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.
`Idempotency-Key`	header	Yes	Reuse with the identical request after a lost response. Different content returns 409.

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: DistributionInput.

Field	Type	Required	Constraints / description
`name`	string	Yes	minLength: `1`; maxLength: `100`
`origins`	Array of string	Yes	maxItems: `100`

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

Responses

202

Accepted. Poll the operation until both servers acknowledge activation or preparation completes.

Content type: application/json Schema reference: DistributionResult.

Field	Type	Required	Constraints / description
`distribution`	object	Yes	—
`job`	See schema	Yes	—

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

400

Invalid fields or content.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	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)$"`

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

401

Sign in required.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	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)$"`

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

403

Current role does not permit the operation.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	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)$"`

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

404

Resource unavailable within current scope.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	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)$"`

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

409

Stale version, pending activation or unmet publication prerequisite.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	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)$"`

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

413

Request limit exceeded.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	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)$"`

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

429

Request rate limit exceeded.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	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)$"`

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

503

A dependency is unavailable; no success is reported.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	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)$"`

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

Request errors and safe retries · Troubleshooting