OCS API

To browse the new OCS API documentation please go here.

The old documentation is still kept as it provides some additional documentation that is not completely covered in the new documentation:

• OCS OpenAPI tutorial
  • Requirements and prerequisites
    • App supports at least Nextcloud 28
    • Psalm is setup and configured
  • Tips and tricks
  • Best practices
    • PREFER to expose your APIs using OCS
    • DO type controller and helper methods as explicit as possible
    • PREFER to use null to represent empty data
    • DO NOT throw non-OCS*Exceptions
    • DO use the same data structures for the same group of responses
    • DO NOT use the addHeader method for setting headers for your responses
    • CONSIDER how your API will be used
    • DO set all descriptions for parameters and methods
  • How to add OpenAPI support to your OCS API
  • How to add response definitions to share type definitions
  • How to handle exceptions
  • How to ignore certain endpoints
  • How to expose Capabilities
  • Scopes
    • Tags
  • How to generate the specification
• OCS APIs overview
  • Authentication
  • Testing requests with curl
  • User metadata
  • User metadata - List user IDs
  • Capabilities API
  • Theming capabilities
  • Direct Download
  • Notifications
  • Auto-complete and user search
    • Filtering the auto-complete results
• OCS Share API
  • Local Shares
    • Get all Shares
    • Get Shares from a specific file or folder
    • Get information about a known Share
    • Create a new Share
    • Delete Share
    • Update Share
    • Share attributes
      • Download permission
      • File request
    • Send email
  • Federated Cloud Shares
    • Create a new Federated Cloud Share
    • List accepted Federated Cloud Shares
    • Get information about a known Federated Cloud Share
    • Delete an accepted Federated Cloud Share
    • List pending Federated Cloud Shares
    • Accept a pending Federated Cloud Share
    • Decline a pending Federated Cloud Share
• OCS Sharee API
  • Search
    • Search sharees
  • Recommendation
    • Sharee recommendations
• OCS Status API
  • User Status - Status Manipulation
    • Fetch your own status
    • Set your own status
    • Set a custom message (predefined)
    • Set a custom message (user-defined)
    • Clear message
  • User Status - Predefined statuses
    • Fetch the list of predefined statuses
  • User Status - Retrieve statuses
    • Fetch a list of all set user-statuses
    • Fetch a specific user’s status
    • Fetch a user’s backup status
    • Files Sharing
  • User status - Restore backup
• OCS Recommendations API
  • Recommendations - Retrieval
    • Fetch user-controlled recommendations
    • Fetch user setting and recommendations
• OCS user preferences API
  • Setting a preference
  • Setting multiple preference
  • Deleting a preference
  • Deleting multiple preference
• OCS Translation API
  • Get available translation options
    • Language tuple structure
  • Translate a string
• OCS TextProcessing API
  • Get available task types
  • Schedule a task
  • Fetch a task by ID
• OCS Text-To-Image API
  • Check availability
  • Schedule a task
  • Fetch a task by ID
  • Fetch a result image
  • Delete a task
  • List tasks by App
• OCS TaskProcessing API
  • Get available task types
  • Schedule a task
  • Fetch a task by ID
  • Cancel a task
  • Delete a task
  • Get task file contents
  • Set task progress
  • Set task result
• OCS Out-of-office API
  • Fetch ongoing data
  • Fetch upcoming or ongoing data
  • Modify out-of-office data
  • Clear data and disable out-of-office