/v2/projects/{project_id} ------------------------------------------------------------------------------------------------------------------------------------------ .. contents:: GET /v2/projects/**{project_id}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Get a project Parameters ********** - **project_id**: Project UUID Response status codes ********************** - **200**: Project information returned - **404**: The project doesn't exist Sample session *************** .. literalinclude:: ../../../examples/controller_get_projectsprojectid.txt PUT /v2/projects/**{project_id}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Update a project instance Response status codes ********************** - **200**: Node updated - **400**: Invalid request - **404**: Instance doesn't exist Input ******* .. raw:: html
Name Mandatory Type Description
name ['string', 'null'] Project name
path ['string', 'null'] Path of the project on the server (work only with --local)
Output ******* .. raw:: html
Name Mandatory Type Description
filename ['string', 'null'] Project filename
name ['string', 'null'] Project name
path ['string', 'null'] Project directory
project_id string Project UUID
status enum Possible values: opened, closed
Sample session *************** .. literalinclude:: ../../../examples/controller_put_projectsprojectid.txt DELETE /v2/projects/**{project_id}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Delete a project from disk Parameters ********** - **project_id**: Project UUID Response status codes ********************** - **404**: The project doesn't exist - **204**: Changes have been written on disk Sample session *************** .. literalinclude:: ../../../examples/controller_delete_projectsprojectid.txt