Documentation for ownCloud (A Kiteworks Company)

ownCloud Server

    • Introduction
    • Admin Manual
      • Introduction
      • Useful Pages
      • FAQ
      • GDPR
      • Installation
        • Deployment Considerations
        • Deployment Recommendations
          • NFS
        • System Requirements
        • Configuration Notes and Tips
        • Installation Options
          • Installing With Docker
          • Manual Installation on Linux
            • Detailed Installation Guide
              • Detailed Installation on Ubuntu (various versions)
            • Quick Installation Guide
              • On Ubuntu 20.04
              • On Ubuntu 22.04
            • Linux Package Manager
              • Linux Package Manager Installation
          • The Installation Wizard
        • Troubleshooting
        • Changing Your ownCloud URL
        • Installing and Managing Apps
        • Supported Apps
          • Media Viewer
        • SELinux Configuration
        • Using Let’s Encrypt SSL Certificates
          • Using Letsencrypt
          • Apache
      • Configuration
        • Database
          • Database Conversion
          • Database Configuration
        • Encryption
          • Encryption Configuration
          • Encryption Configuration Quick Guide
        • External Storage
          • External Storage Configuration
          • External Storage Authentication Mechanisms
          • AmazonS3
          • Dropbox
          • FTP
          • Google
          • Local
          • ownCloud
          • S3 as Primary
          • SFTP
          • SMB
          • WebDAV
        • Files and Sharing
          • Big File Upload Configuration
          • Manual File Locking
          • Default Files Configuration
          • Federated Cloud Sharing Configuration
          • File Sharing Configuration
          • File Versioning
          • Transactional File Locking
          • Preview Configuration
          • Mimetypes
          • Managing the Trashbin
        • Integration
          • Microsoft Teams
          • ownCloud App for Splunk
        • General Topics
          • Code Signing
          • Impersonate Users
          • Full Text Search
        • Server
          • Activity Configuration
          • Background Jobs Configuration
          • Caching Configuration
          • Config Sample PHP Parameters
          • Config Apps Sample PHP Parameters
          • Custom Client Repos
          • Email Configuration
          • Excluded Blacklisted Files
          • External Sites
          • Harden Server
          • Import SSL Cert
          • Index PHP Less URLs
          • OCC Command
          • Language Configuration
          • Legal Settings Configuration
          • Logging
            • Logging Configuration
            • Request Tracing
          • Reverse Proxy Configuration
          • Security
            • Brute-Force Protection
            • OAuth2
            • Password policy
            • Security Setup Warnings
            • The HSM (Hardware Security Module) Daemon
            • Dependency Notes
          • Server Tuning
          • Third Party PHP Configuration
          • Virus Scanner Support
          • UI Configuration
        • User
          • User Management
          • User Roles
          • Reset Admin Password
          • Reset User Password
          • User Auth FTP SMB IMAP
          • User Auth LDAP
          • User Auth Two-Factor
          • User Auth OAuth2
          • User Provisioning API
          • Custom Groups App
          • Guests App
          • OpenID Connect (OIDC)
          • Login Policies
      • Maintenance
        • Upgrading
          • Manual Upgrade
          • Database Upgrade
          • Upgrading from Package
          • Using the Updater App
          • Upgrading PHP
          • Marketplace Apps
        • Backup and Restore
          • Backup
          • Restore
        • Maintenance Mode
        • Export and Import Instance Data
        • Manually Moving Data Folders
        • Encryption
          • Migrating from User Key to Master Key Encryption
        • Migrating to a Different Server
        • Migrating to Kiteworks PDN
      • Enterprise
        • Authentication
          • Enterprise Only Authentication
          • Kerberos Authentication
        • Clients
          • Custom Client Repos
        • Collaboration
          • Collabora Online / Secure View
          • Microsoft Office Online / WOPI Integration
        • Document Classification
          • Classify Documents and Enforce Policies
        • External Storage
          • LDAP Home Connector Configuration
          • Sharepoint integration Configuration
          • Windows Network Drive Configuration
          • WND Configuration Quick Guide
        • File Management
          • File Tagging
          • File Lifecycle Management
        • Firewall
          • File Firewall
        • Installation
          • Installing & Upgrading ownCloud Enterprise Edition
          • Oracle DB Setup & Configuration
        • Logging
          • Auditing
        • Reporting
          • Metrics
          • Generate a Config Report
        • Security
          • Ransomware Protection
        • User Management
          • Shibboleth Integration
          • SAML 2.0 Based SSO
      • Troubleshooting
        • General Troubleshooting
        • Path and Filename Length Limitations
        • Retrieve Log Files and Configuration Settings
        • Remove Non-Existent Background Jobs
      • Found a Mistake?
    • Developer Manual
      • Introduction
      • General Contributor Guidelines
        • Community Code of Conduct
        • Coding Style & General Guidelines
        • Debugging
        • Performance Considerations
        • Security Guidelines
        • Backporting
      • Help and Communication
      • Developing ownCloud Core
        • Introduction
        • Setup Your Development Environment
        • Application Configuration
        • Theming
        • Translation
        • Code Standards Compliance
        • Testing
          • ownCloud Test Pilots
          • Drone Testing
          • Unit Testing
          • Acceptance Tests
          • User Interface Testing
        • Available APIs
          • The External API
          • The Provisioning API
          • OCS
            • The OCS Notifications API (v1)
            • The OCS REST API
            • The OCS Recipient API
            • The OCS Share API
            • The OCS TOTP Validation API
            • The OCS User Sync API
            • Notify Public Link By Email
            • The Roles API
          • WebDAV APIs
            • The Comments API
            • The Custom Groups Management API
            • The Files Versions API
            • The Meta API
            • The Search API
            • The Tags API
            • The Trash Bin API
            • The Public Files API
      • Application Development
        • Fundamental Concepts
          • Application Metadata
          • The Classloader
          • Configuration
          • Routing
          • Controllers
          • Templates
          • JavaScript
          • CSS
          • Middleware
          • Database Connectivity
          • Background Jobs
          • Logging
          • Testing
          • The DI Container
          • Filesystem
          • RESTful API
          • Hooks
          • Publishing in the ownCloud Marketplace
          • Changelog
          • Market App
        • Advanced Concepts
          • Custom Filesystem Caches
          • Custom Storage Backends
          • Notifications
          • Storage Backends
          • External Storage Backends
          • Translation
          • Two-Factor Providers
          • User Management
          • Code Signing
        • Tutorial
          • Minimum Requirements
          • The Request Life Cycle
          • The Core Application Files
          • Routes and Controllers
          • Database Connectivity
          • Create Template Content
          • Create a Navigation Menu
          • Add JavaScript and CSS
          • Wiring it Up
          • Apply the Finishing Touches
          • Add a RESTful API
          • Writing Tests
      • Mobile Development
        • Android
          • Library Installation
          • Examples
        • iOS
          • Library Installation
          • Examples
      • Bugtracker
        • Code Reviews
        • Bug Triaging
      • Found a Mistake?
    • ownCloud Server UI
      • Introduction
      • The WebUI
        • Web Interface
        • Navigating the WebUI
        • Personal Settings
          • General
          • Storage
          • Sharing
          • Security
          • Custom Groups
        • Files
          • Access WebDAV
          • Sharing Files
          • Search & Full Text Search
          • Tagging Files
          • Comments
          • Version Control
          • Encrypting Files
          • Managing Deleted Files
          • Large File Uploads
          • Manual File Locking
          • File Lifecycle Management
        • Public Link Shares
        • Federated Cloud Sharing
        • Managing Connected Browsers and Devices
        • Online Collaboration
        • Storage Quotas
        • External Storage
        • Connecting to SharePoint
        • Desktop Mobile Sync
      • Apps
        • Activity
        • Calendar
        • Contacts
        • Market
        • Media Viewer App
      • Integration
        • Microsoft Teams
      • Synchronization Clients
        • Sync iOS
        • Sync KDE
        • Sync OSX
        • Sync Thunderbird
      • Troubleshooting
      • Found a Mistake?
ownCloud Server 10.15
  • Desktop App
    • next
    • 5.3
    • 5.2
  • Infinite Scale Documentation
    • next
    • 7.1
    • 7.0
  • Mobile App for Android
    • next
    • 4.5
    • 4.4
  • Mobile App for iOS
    • next
    • 12.5
    • 12.4
  • ownCloud Main Page
  • ownCloud Server
    • next
    • 10.15
    • 10.14
  • ownCloud Web User Interfaces
    • next
  • ownCloud Server
  • Developer Manual
  • Developing ownCloud Core
  • Available APIs
next 10.15 10.14
Edit this Page

APIs

In this section you will find all the details you need to use APIs in ownCloud.

User Interface Testing The External API

About ownCloud

  • The Secure Collaboration Platform
  • News
  • Privacy statement
  • Imprint

Resources

  • FAQ
  • Help
  • Security
  • Changelog
  • Get started

Interact

  • Rocket.Chat
  • Forum
  • Contribute
  • Customer support

© Copyright 2011-2025, The ownCloud developers.