projects

Rename a project

Rename a project or template. Bumps updated_at; the head and its version are unchanged.

patch/v1/projects/{project_id}

Request

  • Base URL: https://api.framelane.io
  • URL: https://api.framelane.io/v1/projects/{project_id}
  • Auth: HTTP bearer

Path parameters

project_idstring required

Request body

namestring required

New display name.

Response

Successful Response

idstring required

Unique project id.

namestring required

Display name.

versioninteger required

Head version. Bumped on every applied ops batch.

workspace_idstring required

Owning workspace id.

editor_urlstring required

Open this project in the authenticated console.

kind'project' | 'template'

project, or template: a project used as a copy source.

source_project_idstring nullable

The project or template this one was copied from.

source_kind'project' | 'template' | 'public_template' nullable

What the source was: project (a duplicate), template (one of your templates) or public_template (a published template from the gallery).

thumbnail_urlstring nullable

A poster image of the head; null until one is generated.

thumbnail_versioninteger nullable

The head version the thumbnail shows. It is stale while this is below version.

created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.