Rename a project

Requires current Owner/Admin membership and an active workspace. Existing-project writes also require an active project, except restore. Supply the last observed project version; a stale version returns 409.

PATCH /api/v1/workspaces/{workspaceId}/projects/{projectId}

Operation: renameProject · 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.

workspaceId

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

projectId

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

Origin

{
  "type": "string",
  "description": "Must exactly match the configured panel origin."
}

X-CSRF-Token

{
  "type": "string"
}

Request body

Required: Yes.

application/json

Schema reference: RenameProject.

Field	Type	Required	Constraints / description
version	integer	Yes	minimum: 1
name	string	Yes	Trimmed; control characters are rejected. Names need not be unique.; minLength: 1; maxLength: 100

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

Responses

200

Success

Response headers:

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

Content type: application/json Schema reference: Project.

Field	Type	Required	Constraints / description
id	string	Yes	format: "uuid"
workspaceId	string	Yes	format: "uuid"
name	string	Yes	Trimmed; control characters are rejected. Names need not be unique.; minLength: 1; maxLength: 100
sourceLocale	string	Yes	minLength: 2; maxLength: 255
version	integer	Yes	minimum: 1
archivedAt	string or null	Yes	format: "date-time"
createdAt	string	Yes	format: "date-time"
mainBranchId	string	Yes	format: "uuid"

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

400

Invalid fields or unsupported locale

Response headers:

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

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
error	unauthorized, forbidden, invalid_request, not_found, conflict, rate_limited, unavailable	Yes	—
message	string	Yes	—
requestId	string	No	—
details	object	No	—

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

401

Authentication required

Response headers:

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

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
error	unauthorized, forbidden, invalid_request, not_found, conflict, rate_limited, unavailable	Yes	—
message	string	Yes	—
requestId	string	No	—
details	object	No	—

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

403

Insufficient role or invalid CSRF/Origin

Response headers:

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

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
error	unauthorized, forbidden, invalid_request, not_found, conflict, rate_limited, unavailable	Yes	—
message	string	Yes	—
requestId	string	No	—
details	object	No	—

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

404

Resource unavailable in the current workspace

Response headers:

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

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
error	unauthorized, forbidden, invalid_request, not_found, conflict, rate_limited, unavailable	Yes	—
message	string	Yes	—
requestId	string	No	—
details	object	No	—

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

409

Version, lifecycle, graph or idempotency conflict

Response headers:

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

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
error	unauthorized, forbidden, invalid_request, not_found, conflict, rate_limited, unavailable	Yes	—
message	string	Yes	—
requestId	string	No	—
details	object	No	—

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

429

Request limit reached

Response headers:

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

Content type: application/json

Field	Type	Required	Constraints / description
message	string	Yes	—
error	string	No	—
statusCode	integer	No	—

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "error": {
      "type": "string"
    },
    "statusCode": {
      "type": "integer"
    }
  },
  "required": [
    "message"
  ],
  "description": "Fastify route limits or the aggregate application limit may supply this response."
}

503

Dependency unavailable

Response headers:

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

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
error	unauthorized, forbidden, invalid_request, not_found, conflict, rate_limited, unavailable	Yes	—
message	string	Yes	—
requestId	string	No	—
details	object	No	—

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

Related guidance

Request errors and safe retries · Troubleshooting