You're not viewing the latest version. Click here to go to latest.
logo
Pydio Documentation
Index
Initializing search
    GitHub
    • Home
    • Admin guide
    • Cellsflows
    • Developer guide
    • Knowledge base
    GitHub
    • Home
    • Admin guide
      • Quick Start
        • Requirements
        • Cells Installation
          • Install Static Binaries
          • Docker
          • Open Virtual Format
          • Amazon AMI
          • Advanced setups
        • Quick Admin Tour
        • Sharing Features
        • Add Collaboration Tools
          • Collabora Online
          • [Ent] Only Office
        • Connect Desktop Sync
        • Mobile Apps
        • Glossary
      • Run Cells in Production
        • Best practices
          • Recommended Architectures
          • Create a Dedicated MySQL User
          • Create a Service User
          • Linux Service
          • Working Directories
          • System Logs
        • Configuring Cells URLs
          • Manage Sites
          • Configure Cells with a reverse-proxy
          • Configure TLS
        • Configuring Mongo Storage
        • Configuring Email Delivery
        • Upgrades
          • Software Upgrades
          • Major Versions Upgrade Informations
        • Operational Maintenance
          • Truncate Logs / Audits
          • Purge Activities / Notifications
          • Monitoring Tools
          • Backup / Recover
        • Deploying Cells in a Distributed Environment
          • Kubernetes Quick install
          • Going Stateless
          • External Services
          • Configuring with URLs
          • Deploying Cells Nodes
          • Migrating from Single Node
          • K8s Advanced Parameters
          • Providing HA with Docker Compose
        • Troubleshooting
      • Connect your users
        • Manage Users
        • Single-Sign-On Features
          • Cells as Identity Provider
          • [Ent] Using SSO with an External Identity Provider
          • [Ent] LDAP / AD
          • [Ent] LDAP / AD (Advanced)
          • [Ent] AD + Kerberos Support
        • Users / Teams Visibility
        • [Ent] Group Tenancy
        • [Ent] Admin Delegation
        • Additional APIs
          • Webdav Server Access
          • [Ent] SFTP Access
          • Personal Access Tokens
      • Connect your Storage
        • Datasources overview
        • Datasource Format
          • Structured Storage - Best for accessing the files directly
          • Flat Storage - Best for performances
          • Recovering a Flat Storage Datasource with Cells Fuse
          • Switching Datasource Storage Formats
        • Create datasources
          • Common Options
          • File System Storage
          • Mounts / NAS
          • S3 Compatible Storage
          • [Ent] Google Cloud Storage
          • [Ent] Azure Blob Storage
        • Versioning Policies
        • Encryption
        • Metadata
        • [Ent] Enable image and video annotations
        • [Ent] Assign quotas
        • [Ent] Shard with template path
      • Secure your data
        • Workspaces / Cells
        • Role-based Access Control
        • [Ent] Dynamic Access Control
          • Using Security Policies
          • Rules Conditions
        • [Ent] Hardening Security
          • [Ent] Password Complexity
          • [Ent] Multi factor authentication
          • [Ent] IP Ban
        • [Ent] Audits & Compliance
          • [Ent] Viewing and Exporting Audit Logs
          • [Ent] Visualize Shared Resources
          • [Ent] Explore Storage Usage
          • [Ent] Adding Terms of Service
        • UX Actions / Parameters
      • Customize interface
        • [Ent] Logos and Wording
        • [Ent] Brand Theme
        • [Ent] Email Templates
        • [Ent] EasyTransfer Layout
        • [Ent] Using SmartForm
      • Advanced
        • Migrate Pydio 8 to Cells
        • Scheduler / Cells Flows
        • YAML/JSON Installation
        • Pydio Cells Internals
        • Advanced configurations
    • Cellsflows
      • Cells Flows Manual
        • Introduction to Cells Flows
        • Anatomy of a Flow
          • Actions and Messages
          • Data Types, Queries, Filters
          • Triggers
          • Parameters
          • Tasks Logs
        • Demo of a simple Flow (video)
        • Building your own Flows
          • Business Requirements
          • Debugging Tools
          • Parallelism and Concurrency
          • Runtime Parameters and Variables
          • Combining multiple triggers
        • Providing End-User Interactions
          • Webhooks & Buttons
          • Smart Forms
        • Scripting Capabilities
          • Using Golang Templates
          • Templates Functions
          • Anko Pseudo-Script
          • Using Javascript
          • Live Playground
          • Scripting Cheatsheet
        • Managing Flows
          • Creating, renaming and deleting
          • Import/Export JSON File
          • Templates and Presets
          • Flows Versioning
      • Preset Flows
        • Intelligent File Management
          • Detect metadata change
          • Move Files Automatically
          • Personal Files Preset
        • Efficient System Maintenance
          • Backup Personal Files
          • Capture Snapshots
          • Check Software Updates
          • Daily Snapshots (Flat)
          • Disable Links Older...
          • Empty All Recycles
          • Purge Activities
          • Purge Files Activities
          • Purge Users Notifications
          • Truncate Logs
          • Unlock Public Links
        • Automated Identity and Access Management
          • Batch Create Links
          • Batch Delete Link
          • Clear OTP setup
          • Import Users (CSV)
          • List Locked Users
          • Modify a User Login
          • Role for each Workspace
          • WS First Connection
        • Data Analysis, Insights and Reporting
          • Export Audits Report
          • Export Users Permissions
          • Folder Content Report
          • Purge Files Older...
          • Read License Stats
          • Storage Usage
        • Workflow Automation
          • Create SmartForm
          • SmartForm Submission
          • Validation Workflow
        • Data Formatting and Conversion
          • Broken Thumbnails
          • Convert Tools
          • PDF Thumbnails
          • Recompute hashes
          • Scan with Antivirus
          • Tika Contents Extraction
          • Users PDF Actions
      • Actions
        • Files/Folders Operations
          • User metadata
          • Copy/Move
          • Delete files
          • Resources Exist
          • Store Internal Meta
          • Create Folder
          • Write To File
          • Read from File
          • JSON Snapshot
          • Synchronize Folders
        • Archives Operations
          • Create Archive
          • Extract Archive
        • Scheduler Tools / Internals
          • Message, Variable, Error
          • Clear Action
          • Trigger Another Flow
          • Advanced Logging, Artifacts
          • Empty Action
          • Sort Input
          • Anko Script
          • JavaScript
          • Sleep
        • Upload/Download to External Servers
          • Http Get
          • FTP Put
          • Scp put
          • Webhook
        • Atomic Commands and Scripts
          • Capture Datasource
          • Resynchronize
          • gRPC Request
          • Shell Command
        • Contents Processing
          • Docx Replacement
          • ClamAV Scan
          • Cells Convert Tools
          • Gotenberg PDF Previews
          • Doconv Extractor
          • Markdown Actions
          • PDF Actions
          • Tika Extractor
          • Clean Thumbs
          • Extract EXIF
          • Create Thumbs
          • Compute Hash
        • Identity Management
          • User Permissions
          • Load or Create Cell
          • Modify Cell
          • Save/Delete Cell
          • Context User
          • Delete Identity Data
          • Create Link
          • Delete Link
          • Persist Identity Data
          • Add/remove user role
          • Set user attribute
          • Remove Users
          • Workspace Roots
          • Modify Workspace
        • Notifications and Emails
          • Send Email
          • Send Notification
          • Email Digest
        • Extract/Load/Transform
          • DocStore Query
          • Data Transformation
          • Sync. Directories
          • Import from CSV
          • Load SQL Schema
          • Flush SQL Schema
          • Select SQL Data
          • Modify SQL Data
        • Internal Actions
          • Prune tokens
          • Sync. Directories
          • Global meta from P8
          • Legacy meta from P8
          • Sync. workspaces
          • Sync. Shares
          • Expired ACLs clean up
          • User-data clean up
          • Prune Jobs
          • Set Datasource Attribute
          • Write To File (v1)
          • Read from File (v1)
          • Reset policies
          • File versioning
          • Backup Versions
          • Prune Versions
          • Upgrade DataSource Format
          • Fake Users
      • Filters & Queries
        • Files/Folders Selector
        • Users Selector
        • Roles Selector
        • Workspaces Selector
        • ACL Selector
        • Task Message Filter
        • Request Metadata Filter
        • Arbitrary Data Selector
        • Job Trigger Filter
        • DataSource Selector
      • Template Functions
        • cells
        • go
        • gval
        • humanize
        • sprig
    • Developer guide
      • Introduction
        • Main APIs presentation
        • Authentication
        • Consumers Examples
          • Using Postman
          • Using cURL
        • Other APIs
      • Clients / SDKs
        • Cells Client
        • Cells SDK for Go
        • Cells SDK for JavaScript
        • Cells SDK for Java
      • Rest API
        • [Enterprise] Audit Service
          • GET /a/audit/data/reports
          • POST /a/audit/data/shares
        • [Enterprise] Config Service
          • DELETE /a/config/directories/{ConfigId}
          • DELETE /a/config/oauth2clients/{ClientID}
          • DELETE /a/config/oauth2clients/{client_id}
          • DELETE /a/config/oauth2connectors/{id}
          • DELETE /a/config/versioning/{Uuid}
          • DELETE /a/config/virtualnodes/{Uuid}
          • GET /a/config/directories
          • GET /a/config/oauth2clients
          • GET /a/config/oauth2connectors
          • GET /a/config/sites
          • POST /a/config/directories-test/ping
          • POST /a/config/directories-test/search
          • POST /a/config/versioning/{Uuid}
          • POST /a/config/virtualnodes/{Uuid}
          • PUT /a/config/directories/{ConfigId}
          • PUT /a/config/oauth2clients/{ClientID}
          • PUT /a/config/oauth2clients/{client_id}
          • PUT /a/config/oauth2connectors
          • PUT /a/config/oauth2connectors/{id}
        • [Enterprise] Front Service
          • GET /a/frontend/auth/state
          • GET /a/frontend/login/connectors
        • [Enterprise] License Service
          • GET /a/license/stats
          • PUT /a/license/update
        • [Enterprise] Log Service
          • POST /a/log/audit
          • POST /a/log/audit/chartdata
          • POST /a/log/audit/export
          • POST /a/log/sys/export
        • [Enterprise] Policy Service
          • DELETE /a/policy/{Uuid}
          • GET /a/policy/ipbans
          • GET /a/policy/iplists/{Name}
          • POST /a/policy/ipbans
          • POST /a/policy/iplists
          • PUT /a/policy
        • [Enterprise] Scheduler Service
          • DELETE /a/scheduler/jobs/{JobID}
          • DELETE /a/scheduler/templates/actions/{TemplateName}
          • DELETE /a/scheduler/templates/jobs/{Name}
          • DELETE /a/scheduler/templates/selectors/{TemplateName}
          • DELETE /a/scheduler/versions/{JobID}/{VersionID}
          • GET /a/scheduler/templates/docs/{Type}
          • PATCH /a/scheduler/versions/{JobID}/{VersionID}
          • POST /a/scheduler/hooks/{HookSlug}
          • POST /a/scheduler/templates/actions
          • POST /a/scheduler/templates/jobs
          • POST /a/scheduler/templates/playground
          • POST /a/scheduler/templates/selectors
          • POST /a/scheduler/versions/{JobID}
          • PUT /a/scheduler/jobs
          • PUT /a/scheduler/templates/actions
          • PUT /a/scheduler/templates/jobs/{Name}
          • PUT /a/scheduler/templates/selectors
        • [Enterprise] Templates Service
          • DELETE /a/templates/meta/{TemplateUuid}
          • DELETE /a/templates/node/{TemplateUuid}
          • GET /a/templates/meta
          • POST /a/templates/node
          • PUT /a/templates/meta
        • [Enterprise] Token Service
          • DELETE /a/auth/tokens/{TokenId}
          • POST /a/auth/token/impersonate
          • POST /a/auth/token/personal
          • POST /a/auth/tokens
        • ACL Service
          • POST /a/acl
          • POST /a/acl/bulk/delete
          • PUT /a/acl
        • Activity Service
          • POST /a/activity/stream
          • POST /a/activity/subscribe
          • POST /a/activity/subscriptions
        • Admin Tree Service
          • POST /a/tree/admin/list
          • POST /a/tree/admin/stat
        • Config Service
          • DELETE /a/config/datasource/{Name}
          • GET /a/config/ctl
          • GET /a/config/datasource
          • GET /a/config/datasource/{Name}
          • GET /a/config/discovery
          • GET /a/config/discovery/forms/{ServiceName}
          • GET /a/config/discovery/openapi
          • GET /a/config/peers
          • GET /a/config/scheduler/actions
          • GET /a/config/scheduler/actions/{ActionName}
          • GET /a/config/sites/{Filter}
          • GET /a/config/versioning
          • GET /a/config/versioning/{Uuid}
          • GET /a/config/virtualnodes
          • GET /a/config/{FullPath}
          • POST /a/config/buckets
          • POST /a/config/ctl
          • POST /a/config/datasource/{Name}
          • POST /a/config/encryption/create
          • POST /a/config/encryption/delete
          • POST /a/config/encryption/export
          • POST /a/config/encryption/list
          • POST /a/config/peers/{PeerAddress}
          • POST /a/config/processes
          • POST /a/config/registry
          • PUT /a/config/buckets/{BucketName}
          • PUT /a/config/encryption/import
          • PUT /a/config/peers/{PeerAddress}
          • PUT /a/config/{FullPath}
        • Frontend Service
          • GET /a/frontend/binaries/{BinaryType}/{Uuid}
          • GET /a/frontend/bootconf
          • GET /a/frontend/messages/{Lang}
          • GET /a/frontend/plugins/{Lang}
          • GET /a/frontend/settings-menu
          • GET /a/frontend/state
          • POST /a/frontend/binaries/{BinaryType}/{Uuid}
          • POST /a/frontend/enroll
          • POST /a/frontend/session
        • Graph Service
          • GET /a/graph/relation/{UserId}
          • GET /a/graph/state/{Segment}
          • POST /a/graph/recommend
        • Install Service
          • GET /a/install
          • GET /a/install/agreement
          • GET /a/install/events
          • POST /a/install
          • POST /a/install/check
        • Jobs Service
          • POST /a/jobs/tasks/delete
          • POST /a/jobs/tasks/logs
          • POST /a/jobs/user
          • PUT /a/jobs/user
          • PUT /a/jobs/user/{JobName}
        • Log Service
          • POST /a/log/sys
        • Mailer Service
          • POST /a/mailer/send
        • Meta Service
          • POST /a/meta/bulk/get
          • POST /a/meta/delete/{NodePath}
          • POST /a/meta/get/{NodePath}
          • POST /a/meta/set/{NodePath}
        • Policy Service
          • POST /a/policy
        • Role Service
          • DELETE /a/role/{Uuid}
          • GET /a/role/{Uuid}
          • POST /a/role
          • PUT /a/role/{Uuid}
        • Search Service
          • POST /a/search/nodes
        • Share Service
          • DELETE /a/share/cell/{Uuid}
          • DELETE /a/share/link/{Uuid}
          • GET /a/share/cell/{Uuid}
          • GET /a/share/link/{Uuid}
          • POST /a/share/resources
          • PUT /a/share/cell
          • PUT /a/share/link
          • PUT /a/share/policies
        • Templates Service
          • GET /a/templates
        • Token Service
          • POST /a/auth/reset-password
          • POST /a/auth/token/document
          • POST /a/auth/token/revoke
          • PUT /a/auth/reset-password-token/{UserLogin}
        • Tree Service
          • GET /a/tree/stat/{Node}
          • POST /a/tree/create
          • POST /a/tree/delete
          • POST /a/tree/restore
          • POST /a/tree/selection
          • POST /a/tree/stats
        • Update Service
          • PATCH /a/update/{TargetVersion}
          • POST /a/update
        • UserMeta Service
          • DELETE /a/user-meta/tags/{Namespace}/{Tags}
          • GET /a/user-meta/namespace
          • GET /a/user-meta/tags/{Namespace}
          • POST /a/user-meta/bookmarks
          • POST /a/user-meta/search
          • POST /a/user-meta/tags/{Namespace}
          • PUT /a/user-meta/namespace
          • PUT /a/user-meta/update
        • Users Service
          • DELETE /a/user/{Login}
          • GET /a/user/{Login}
          • POST /a/user
          • PUT /a/user/roles/{Login}
          • PUT /a/user/{Login}
        • Workspace Service
          • DELETE /a/workspace/{Slug}
          • POST /a/workspace
          • PUT /a/workspace/{Slug}
      • Command line reference
        • Cells Binary
          • cells
          • cells admin
          • cells admin acl
          • cells admin acl create
          • cells admin acl delete
          • cells admin acl patch-recycle-personal
          • cells admin acl search
          • cells admin cert
          • cells admin cert import
          • cells admin clean
          • cells admin clean acls
          • cells admin clean activities
          • cells admin clean logs
          • cells admin clean reset-jobs
          • cells admin clean resync
          • cells admin config
          • cells admin config check
          • cells admin config copy
          • cells admin config db
          • cells admin config db add
          • cells admin config db list
          • cells admin config db move
          • cells admin config db set
          • cells admin config delete
          • cells admin config history
          • cells admin config list
          • cells admin config set
          • cells admin datasource
          • cells admin datasource capture
          • cells admin datasource migrate
          • cells admin datasource rehash
          • cells admin datasource resync
          • cells admin datasource rethumb
          • cells admin datasource snapshot
          • cells admin file
          • cells admin file create-bench
          • cells admin file ls
          • cells admin file meta-put
          • cells admin file meta-read
          • cells admin user
          • cells admin user create
          • cells admin user delete
          • cells admin user search
          • cells admin user set-profile
          • cells admin user set-pwd
          • cells admin user token
          • cells admin user unlock
          • cells configure
          • cells configure sites
          • cells configure sites add
          • cells configure sites delete
          • cells ctl
          • cells ctl service-level
          • cells start
          • cells update
          • cells version
        • Cells Client (cec)
          • cec
          • cec clear
          • cec completion
          • cec completion bash
          • cec completion zsh
          • cec config
          • cec config add
          • cec config add client-auth
          • cec config add oauth
          • cec config add token
          • cec config check-keyring
          • cec config ls
          • cec config rm
          • cec config use
          • cec cp
          • cec idm
          • cec idm list-acls
          • cec idm list-groups
          • cec idm list-roles
          • cec idm list-users
          • cec idm list-workspaces
          • cec info
          • cec ls
          • cec mkdir
          • cec mv
          • cec rm
          • cec scp
          • cec share
          • cec storage
          • cec storage list-datasources
          • cec storage resync-ds
          • cec update
          • cec version
        • Cells Sync
          • cells-sync
          • cells-sync autotest
          • cells-sync capture
          • cells-sync completion
          • cells-sync completion bash
          • cells-sync completion fish
          • cells-sync completion powershell
          • cells-sync completion zsh
          • cells-sync config
          • cells-sync config account
          • cells-sync config add
          • cells-sync config delete
          • cells-sync config edit
          • cells-sync doc
          • cells-sync service
          • cells-sync start
          • cells-sync systray
          • cells-sync version
          • cells-sync webview
        • Cells Enterprise
          • cells-enterprise
          • cells-enterprise admin
          • cells-enterprise admin acl
          • cells-enterprise admin acl create
          • cells-enterprise admin acl delete
          • cells-enterprise admin acl patch-recycle-personal
          • cells-enterprise admin acl search
          • cells-enterprise admin cert
          • cells-enterprise admin cert import
          • cells-enterprise admin clean
          • cells-enterprise admin clean acls
          • cells-enterprise admin clean activities
          • cells-enterprise admin clean logs
          • cells-enterprise admin clean reset-jobs
          • cells-enterprise admin clean resync
          • cells-enterprise admin config
          • cells-enterprise admin config check
          • cells-enterprise admin config copy
          • cells-enterprise admin config db
          • cells-enterprise admin config db add
          • cells-enterprise admin config db list
          • cells-enterprise admin config db move
          • cells-enterprise admin config db set
          • cells-enterprise admin config delete
          • cells-enterprise admin config history
          • cells-enterprise admin config list
          • cells-enterprise admin config set
          • cells-enterprise admin datasource
          • cells-enterprise admin datasource capture
          • cells-enterprise admin datasource migrate
          • cells-enterprise admin datasource rehash
          • cells-enterprise admin datasource resync
          • cells-enterprise admin datasource rethumb
          • cells-enterprise admin datasource snapshot
          • cells-enterprise admin file
          • cells-enterprise admin file create-bench
          • cells-enterprise admin file ls
          • cells-enterprise admin file meta-put
          • cells-enterprise admin file meta-read
          • cells-enterprise admin jobs
          • cells-enterprise admin jobs templates
          • cells-enterprise admin jobs unlock-public
          • cells-enterprise admin license
          • cells-enterprise admin license stats
          • cells-enterprise admin license update
          • cells-enterprise admin user
          • cells-enterprise admin user create
          • cells-enterprise admin user delete
          • cells-enterprise admin user search
          • cells-enterprise admin user set-profile
          • cells-enterprise admin user set-pwd
          • cells-enterprise admin user token
          • cells-enterprise admin user unlock
          • cells-enterprise configure
          • cells-enterprise configure sites
          • cells-enterprise configure sites add
          • cells-enterprise configure sites delete
          • cells-enterprise ctl
          • cells-enterprise ctl service-level
          • cells-enterprise start
          • cells-enterprise update
          • cells-enterprise version
      • Cells Development
        • Developing on Cells
          • Setup dev environment
          • How to contribute
          • Vendoring
        • Microservices
          • Introduction
          • Discovery
          • Communication
          • Api gateway model
          • Architecture overview
        • Services categories
          • Identity managment
          • Broker
          • Data
          • Scheduler
          • Gateway
        • Security model
          • Role based security rules
          • Resource based security rules
        • Activity streams
        • Miscellaneous
          • Logging
          • Tracing
          • Javascript Frontend
    • Knowledge base
      • Access Control
        • Changing Token Lifespan
        • Fully disabling Cells
        • ACL use cases
        • Managing resources ownership
      • Cells in Production
        • Changing the default datasource storage type
        • Cleanup Strategies for Production Instances
        • Installing ClamAV on a server
        • Migrate a Cells instance to a new server
        • Datasources & Workspaces Layout Recommendations
      • Client Applications
        • Using WebDAV clients
        • Setup Cells Server for CellsSync
      • Deployment
        • Install Cells on Debian/Ubuntu
        • Install Cells on CentOS/RHEL
        • Install Cells on MacOSX
        • Install Cells on Windows
        • Install Cells on Raspberry
        • No private IP detected issue
        • Monitoring Cells with Prometheus & Grafana
        • Running Cells behind an Apache reverse proxy
        • Running Cells behind a Caddy2 reverse proxy
        • Running Cells behind a Nginx reverse proxy
        • Running a Cells container behind a Traefik reverse proxy
        • Running Cells as a service with Supervisor
        • Running Cells as a service with Systemd
      • Identity Management
        • Using AWS Cognito as an Identity Provider
        • Connect to Pydio Cells via Microsoft Identity
        • Using Github as an Identity Provider
        • Using Google as an Identity Provider
        • Connect to Pydio Cells via On-Premise ADFS server
        • Connect to Pydio Cells via SimpleSAML PHP
        • Using Pydio Cells as an Identity Provider for WordPress

    Index

    This service provides endpoints for reading and saving enterprise license.

    • GET /a/license/stats
    • PUT /a/license/update

    Auto generated by Pydio Cells Enterprise Distribution v4.4.13 on 7-May-2025

    Made with Material for MkDocs