7.2.1.14. Project Databases API

Endpoints

POST

/api/project_databases/install_project

Install a project

POST

/api/project_databases/uninstall_project

Uninstall a project
POST /api/project_databases/install_project

Install a project.

Allows admins to install a project from a database file

Parameters:

  • dbfile – query

    The server side path of the database file. If it is relative it will be interpreted relative to the Dashboard server configuration directory.

  • name – query

    The name to give the new project.

  • altername – query

    Whether the Dashboard shall choose a different name if the specified one cannot be used for some reason. See here on how to specify a boolean as a string.

  • installifnotfound – query

    Install the project as specified even if no file is found at the given path. See here on how to specify a boolean as a string.

Status Codes:

  • 200 OK –

    Body Type: string

    The name of the installed project

POST /api/project_databases/uninstall_project

Uninstall a project.

Allows Admins to uninstall a project

Parameters:

  • name – query

    The name of the project to uninstall

Status Codes: