Pydio Documentation Library

Deploy, administrate & extend Pydio

Pydio v8

Provisioning API (v1)

Administration task : users/groups/workspaces provisionning, maintenance tasks, etc... Generally performed using /settings/ as workspace alias.

Admin Driver

Access Pydio configuration data.

  • /settings/ls/dir+
    List the content of the config. Depending on the path, will return users, workspaces, roles, etc..
    Details
  • /settings/admin_search/query/dir+
    Remote search implementation, currently only supporting users search.
    Details
  • /settings/stat
    To comply with GUI client, always returns true.
    Details
  • /settings/list_all_plugins_actions/
    Returns a structured JSON object of all plugins and all their available actions
    Details
  • /settings/list_all_plugins_parameters/
    Returns a structured JSON object of all plugins and all their available parameter
    Details
  • /settings/parameters_to_form_definitions/
    Takes in input a list of plugin parameters and builds the corresponding XML to create a standard form.
    Details
  • /settings/list_all_repositories/
    Returns all repository (output format is XML)
    Details
  • /settings/list_all_repositories_json/
    Returns all repository (output format is JSON)
    Details
  • /settings/list_all_users/
    Returns all users
    Details
  • /settings/generate_api_docs/version
    Generate API docs
    Details
  • /settings/get_plugin_manifest/plugin_id
    Send a plugin Manifest file.
    Details
  • /settings/run_plugin_action/action_plugin_id/action_plugin_method
    Execute a class method on a plugin. Used for example for testing a DB connexion.
    Details
  • /settings/create_user/new_user_login/new_user_pwd
    Create a user with login and password in the AUTH directory.
    Details
  • /settings/create_role/role_id
    Create an empty role
    Details
  • /settings/create_group/group_label/group_path+
    Create a new group of users
    Details
  • /settings/user_update_group/file/group_path+
    Move an existing user to an existing group
    Details
  • /settings/create_repository/json_data
    Create a workspace ( = repository, it's the same ) by passing a structured JSON object.
    Details
  • /settings/user_update_role/file/update_role_action/role_id
    Add or remove a given role to a set of users. The rest access can only handle one user at a time, using the file parameter.
    Details
  • /settings/edit/sub_action
    Shortcut for various actions, calling edit with subaction parameter.
    Details
  • /settings/edit_repository_label/repository_id/newLabel
    Update a workspace label
    Details
  • /settings/save_user_preference/user_id/pref_name_0/pref_value_0
    Sets a user preference value. Rest can only take one value, but CLI or http GET can pass many preferences, using _1, _2, _3, etc.
    Details
  • /settings/meta_source_edit/repository_id/plugId/json_data
    Edit an existing meta source parameters.
    Details
  • /settings/meta_source_add/repository_id/plugId/json_data
    Add a meta source to a repository, setting its parameters.
    Details
  • /settings/meta_source_delete/repository_id/plugId
    Remove a given meta source from a repository.
    Details
  • /settings/delete/data_type/data_id+
    Generic delete action for config driver, used to delete users, workspaces, roles, etc.
    Details
  • /settings/user_update_right/repository_id/user_id/right
    Update a user access right on a given workspace.
    Details
  • /settings/role_update_right/repository_id/role_id/right
    Update a role access right on a given workspace.
    Details

Tasks Scheduler

Register tasks to be run on a regular basis instead of writing them one by one in cron tab.

  • /settings/scheduler_generateCronExpression
    Generate a correct expression to be inserted in Crontab, in order to trigger the {runAll} action on a regular basis.
    Details
  • /settings/scheduler_runAll
    Run the scheduler: check if some tasks must be run now, and launch them. Generally launched from command line.
    Details
  • /settings/scheduler_loadTask
    Returns a JSON representation of the task parameters
    Details
  • /settings/scheduler_addTask
    Create a new task by posting parameters
    Details
  • /settings/scheduler_runTask
    Force running a specific task
    Details
  • /settings/scheduler_removeTask
    Remove a given task from scheduler
    Details
  • /settings/scheduler_fakeLongTask
    Launch a fake long task.
    Details

Update Engine

Detect necessary upgrades for Pydio packages.

  • /settings/get_upgrade_path/
    Check if there are packages available for upgrade.
    Details
  • /settings/display_upgrade_note/
    Display upgrade note
    Details
  • /settings/perform_upgrade/
    Apply the update following available upgrade path.
    Details
Back to top