KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #codex #typescript #ai-agents #claude-code #dsh #dsh-plugin #open-source #cli #deepseek-harness #macos #ai-agent

plone.restapi

★ 108 Open GitHub ↗

RESTful API for Plone.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![image](https://github.com/plone/plone.restapi/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/plone/plone.restapi/actions/workflows/tests.yml)

[![image](https://coveralls.io/repos/github/plone/plone.restapi/badge.svg?branch=main)](https://coveralls.io/github/plone/plone.restapi?branch=main)

[![image](https://app.readthedocs.org/projects/plonerestapi/badge)](https://6.docs.plone.org/plone.restapi/docs/source/index.html)

[![image](https://img.shields.io/pypi/v/plone.restapi.svg)](https://pypi.org/project/plone.restapi/)

# Introduction

`plone.restapi` is a RESTful hypermedia API for Plone.

# Documentation

https://6.docs.plone.org/plone.restapi/docs/source/index.html

# Getting started

A live demo of Plone 6 with the latest `plone.restapi` release is
available at:

<https://demo.plone.org/>

An example GET request on the portal root is the following.

```shell
curl -i https://demo.plone.org/++api++ -H "Accept: application/json"
```

An example POST request to create a new document is the following.

```shell
curl -i -X POST https://demo.plone.org/++api++ \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    --data-raw '{"@type": "Document", "title": "My Document"}' \
    --user admin:admin
```

> [!NOTE]
> You will need some kind of API browser application to explore the API.
> You will also need to first obtain a basic authorization token.
> We recommend using [Postman](https://www.postman.com/) which makes it
> easier to obtain a basic authorization token.

# Installation

`plone.restapi` is included in Plone 6 if you install the `Plone` package.

If it is not installed, add it using requirements.txt or as a dependency of another package.

# Python / Plone Compatibility

plone.restapi 10 requires Python 3 and works with Plone 6.2, 6.1, 6.0, and 5.2.

plone.restapi 9 entered "maintenance" mode with the release of
plone.restapi 10 (end of 2025). It is not planned to backport any
features to this version and we highly recommend to upgrade to
the latest version of plone.restapi.

Python versions that reached their
[end-of-life](https://devguide.python.org/versions/), including Python
3.6 and Python 3.7, are not supported any longer.

Use plone.restapi 7 if you are running Python 2.7 or Plone versions
below 5.2.

# Contribute

- Issue Tracker: https://github.com/plone/plone.restapi/issues
- Source Code: https://github.com/plone/plone.restapi
- Documentation: https://6.docs.plone.org/plone.restapi/docs/source/index.html

# Examples

`plone.restapi` has been used in production since its first alpha
release. It can be seen in action at the following sites:

- Zeelandia GmbH & Co. KG: https://www.zeelandia.de (by kitconcept
  GmbH)
- VHS-Ehrenamtsportal: https://vhs-ehrenamtsportal.de (by kitconcept
  GmbH)
- German Physical Society: https://www.dpg-physik.de (by kitconcept
  GmbH)

# Support

If you are having issues, please let us know via the [issue
tracker](https://github.com/plone/plone.restapi/issues).

If you require professional support, here is a list of Plone solution
providers that contributed significantly to `plone.restapi` in the past.

- [kitconcept GmbH](https://kitconcept.com) (Germany)
- [Fabasoft (acquired 4teamwork)](https://www.fabasoft.com/de/fabasoft-schweiz) (Switzerland)
- [CodeSyntax](https://www.codesyntax.com/en) (Spain)

# License

The project is licensed under the GPLv2.

plone.restapi

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README