Update project
update_projectRename a project, update its description, change visibility, link access or lifecycle, or correct its run plan. The slug + URL stay the same. Setting run_plan only records how the project should be brought up; call init_project when you want it rebuilt.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | New project name. The slug and URL do not change. | |
| access | No | Who may open the URL. public = anyone with the link. team = sign-in required, and only for members of this account. password = anyone who enters the password set with access_password, no account needed. Switching away from password discards the password. | |
| run_plan | No | How this project installs and starts, as returned by get_project. Replaces the stored plan wholesale, so send every field you want kept. Set port to null when the project isn't a server (a library, a CLI, a batch job): bring-up then installs it and stops, instead of trying to serve it. | |
| lifecycle | No | persistent = lives until deleted. ephemeral = remove it with cleanup_project when its task is done. | |
| project_id | Yes | The project's id, as returned by create_project or list_projects. | |
| visibility | No | public = live at the project URL. private = not publicly reachable. The slug and URL stay the same either way. | |
| description | No | New one-line description. | |
| access_password | No | Set or change the password for access password. Required when switching to password unless one is already set; send it alone to change the password, which signs out everyone who used the old one. At least 4 characters, so a 4 digit code works. Write-only: it is stored encrypted and never returned. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Project id. | |
| url | No | Public URL. null while the project is private. | |
| name | No | Project name. | |
| access | No | Who may open the URL once it is public. | |
| run_plan | No | How bring-up installs and starts the project. | |
| lifecycle | No | ephemeral projects are removed with cleanup_project. | |
| updated_at | No | ISO 8601 timestamp. | |
| visibility | No | public = live at url. private = not publicly reachable. | |
| description | No | One-line description. |