Endpoints

This part of the documentation explains the endpoints of Plone REST API.

Table of Contents

• Add-ons
  • Reading add-ons records
  • Listing add-ons records
  • Installing an add-on
  • Uninstalling an add-on
  • Upgrading an add-on
  • Install a profile of an add-on
• Aliases
  • Adding new URL aliases for a Page
  • Listing URL aliases of a Page
  • Removing URL aliases of a Page
  • Adding URL aliases in bulk via JSON
  • Adding URL aliases in bulk via CSV
  • Listing all available aliases via JSON
  • Listing all available aliases via CSV
  • Filter aliases
  • Bulk removing aliases
• Breadcrumbs
• Comments
  • Listing Comments
  • Adding a Comment
  • Replying to a Comment
  • Updating a Comment
  • Deleting a Comment
• Content Types
  • Plone Portal Root
  • Plone Folder
  • Plone Document
  • News Item
  • Event
  • Image
  • File
  • Link
  • Collection
• Content Rules
  • Assigning a new Content rule with POST
  • Getting content rule for a context with GET
  • Changing content rules for a context with PATCH
  • Unassign content rules with DELETE
• Context Navigation
  • Top-Level Navigation
• Control Panels
  • Listing Control Panels
  • Retrieve a single Control Panel
  • Updating a Control Panel with PATCH
  • Control Panels not based on plone.registry
• Copy and Move
  • Copying an object
  • Moving an object
  • Copying or moving multiple objects
• Database
• Email Notification
  • Contact Site Owner (Contact Form)
  • Contact Portal Users
• Email Send
  • Send Mail to Arbitrary Addresses
• Groups
  • List Groups
  • Create Group
  • Read Group
  • Update Group
  • Delete Group
• History
  • Listing the History of a Content Object
  • Get a Historical Version
  • Revert to a Historical Version
• Link Integrity
• Locking
  • Locking an object
  • Unlocking an object
  • Refreshing a lock
  • Getting lock information
  • Updating a locked object
• Navigation
  • Top-Level Navigation
  • Navigation Tree
• Navigation root
  • Expansion
• Portal Actions
  • Listing available actions
• Portraits
  • Get self portrait
  • Get specific user portrait
• Principals
  • Search Principals
• Querystring
  • Get querystring configuration
• Querystring Search
  • Parameters
• Registry
  • Reading registry records
  • Listing registry records
  • Updating registry records
• Relations
  • Getting statistics for all relations
  • Querying relations
  • Creating relations
  • Deleting relations
  • Fix relations
• Roles
  • List Roles
• Search
  • Query format
  • Retrieving additional metadata
  • Retrieving full objects
  • Restrict search results to Plone's search settings
• Sharing
  • Retrieving Local Roles
  • Searching for principals
  • Updating Local Roles
• Site
• System
• Transactions
  • Listing the Transactions of a Content Object
  • Reverting a Transaction or a group of Transactions
• Translations
  • Creating a translation from an existing content
  • Get location in the tree for new translations
  • Expansion
• TUS resumable upload
  • Creating an Upload URL
  • Uploading a File
  • Partial Upload
  • Replacing Existing Files
  • Asking for the Current File Offset
  • Configuration and Options
  • CORS Configuration
  • Temporary Upload Directory
• Types
  • Add schema fieldset or field with POST
  • Get the schema with GET
  • Update schema with PATCH
  • Update schema with PUT
  • Removing schema field/fieldset with DELETE
• Upgrade
  • Get upgrade information
  • Dry run the upgrade
  • Run upgrade
• Users
  • List Users
  • Create User
  • Read User
  • Update User
  • Delete User
  • User registration
  • Reset User Password
• User schema
  • Getting the user schema
• Vocabularies and Sources
  • Concepts
  • Endpoints overview
  • List all vocabularies
  • Get a vocabulary
  • Get a source
  • Querying a query source
• Workflow
• Working Copy
  • Create working copy (a.k.a., check-out)
  • Get the working copy
  • Check-in
  • Delete the working copy (cancel check-out)