Site settings#
Read and change the settings of a site, and run maintenance tasks. Most of these calls need the Manage portal permission.
Each example uses the client from How to read these pages.
client.registry#
Configuration registry (@registry).
client.registry.get#
Value of a registry record.
See get().
Calls GET /@registry/plone.site_title (plone.restapi documentation).
client.registry.get("plone.site_title")
plone-client registry get plone.site_title
"Welcome to Plone 6"
GET /Plone/++api++/@registry/plone.site_title HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET http://localhost:8080/Plone/++api++/@registry/plone.site_title -H 'accept: application/json' -u admin:admin
"Welcome to Plone 6"
client.registry.list#
Registry records.
See list().
Calls GET /@registry (plone.restapi documentation).
list(client.registry.list("plone.site_"))
plone-client registry list plone.site_ --limit 1 -f name,value
[
{
"name": "plone.site_favicon",
"value": null
}
]
GET /Plone/++api++/@registry?q=plone.site_&b_size=100 HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET 'http://localhost:8080/Plone/++api++/@registry?q=plone.site_&b_size=100' -H 'accept: application/json' -u admin:admin
[
{
"name": "plone.site_favicon",
"value": null
},
{
"name": "plone.site_favicon_mimetype",
"value": "image/vnd.microsoft.icon"
}
]
This shows only name, value of each entry. This shows 2 of 4 entries.
client.registry.update#
Change registry records.
See update().
Calls PATCH /@registry (plone.restapi documentation).
client.registry.update({"plone.site_title": "Sample site"})
PATCH /Plone/++api++/@registry HTTP/1.1
Host: localhost:8080
Accept: application/json
Content-Type: application/json
Authorization: Basic YWRtaW46YWRtaW4=
{
"plone.site_title": "Sample site"
}
curl -i -X PATCH http://localhost:8080/Plone/++api++/@registry -H 'accept: application/json' -H 'content-type: application/json' -u admin:admin --data-raw '{"plone.site_title":"Sample site"}'
The site answers 204, and the method returns None.
client.registry.set#
Change one registry record.
See set().
Calls PATCH /@registry (plone.restapi documentation).
client.registry.set("plone.site_title", "Plone site")
plone-client registry set plone.site_title '"Plone site"'
{
"plone.site_title": "Plone site"
}
PATCH /Plone/++api++/@registry HTTP/1.1
Host: localhost:8080
Accept: application/json
Content-Type: application/json
Authorization: Basic YWRtaW46YWRtaW4=
{
"plone.site_title": "Plone site"
}
curl -i -X PATCH http://localhost:8080/Plone/++api++/@registry -H 'accept: application/json' -H 'content-type: application/json' -u admin:admin --data-raw '{"plone.site_title":"Plone site"}'
The site answers 204, and the method returns None.
client.controlpanels#
Control panels (@controlpanels).
client.controlpanels.list#
Control panels of the site.
See list().
Calls GET /@controlpanels (plone.restapi documentation).
client.controlpanels.list()
GET /Plone/++api++/@controlpanels HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET http://localhost:8080/Plone/++api++/@controlpanels -H 'accept: application/json' -u admin:admin
[
{
"@id": "http://localhost:8080/Plone/@controlpanels/date-and-time",
"group": "General",
"title": "Date and Time"
},
{
"@id": "http://localhost:8080/Plone/@controlpanels/language",
"group": "General",
"title": "Language"
}
]
This shows only @id, title, group of each entry. This shows 2 of 15 entries.
client.controlpanels.get#
A control panel, or an item inside it.
See get().
Calls GET /@controlpanels/editing (plone.restapi documentation).
client.controlpanels.get("editing")
GET /Plone/++api++/@controlpanels/editing HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET http://localhost:8080/Plone/++api++/@controlpanels/editing -H 'accept: application/json' -u admin:admin
{
"@id": "http://localhost:8080/Plone/@controlpanels/editing",
"group": "Content",
"title": "Editing"
}
This shows only @id, title, group.
client.controlpanels.update#
Change settings of a control panel, or of an item inside it.
See update().
Calls PATCH /@controlpanels/editing (plone.restapi documentation).
client.controlpanels.update("editing", {"ext_editor": False})
PATCH /Plone/++api++/@controlpanels/editing HTTP/1.1
Host: localhost:8080
Accept: application/json
Content-Type: application/json
Authorization: Basic YWRtaW46YWRtaW4=
{
"ext_editor": false
}
curl -i -X PATCH http://localhost:8080/Plone/++api++/@controlpanels/editing -H 'accept: application/json' -H 'content-type: application/json' -u admin:admin --data-raw '{"ext_editor":false}'
The site answers 204, and the method returns None.
client.controlpanels.create#
Add an item to a control panel, such as a content type.
See create().
Calls POST /@controlpanels/dexterity-types (plone.restapi documentation).
client.controlpanels.create("dexterity-types", {"title": "Event page"})
POST /Plone/++api++/@controlpanels/dexterity-types HTTP/1.1
Host: localhost:8080
Accept: application/json
Content-Type: application/json
Authorization: Basic YWRtaW46YWRtaW4=
{
"title": "Event page"
}
curl -i -X POST http://localhost:8080/Plone/++api++/@controlpanels/dexterity-types -H 'accept: application/json' -H 'content-type: application/json' -u admin:admin --data-raw '{"title":"Event page"}'
{
"@id": "http://localhost:8080/Plone/@controlpanels/dexterity-types/event_page",
"title": "Event page"
}
This shows only @id, title.
client.controlpanels.delete#
Remove an item from a control panel.
See delete().
Calls DELETE /@controlpanels/dexterity-types/event_page (plone.restapi documentation).
client.controlpanels.delete("dexterity-types", "event_page")
DELETE /Plone/++api++/@controlpanels/dexterity-types/event_page HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X DELETE http://localhost:8080/Plone/++api++/@controlpanels/dexterity-types/event_page -H 'accept: application/json' -u admin:admin
The site answers 204, and the method returns None.
client.addons#
Add-ons (@addons).
client.addons.list#
Add-ons available on the site.
See list().
Calls GET /@addons (plone.restapi documentation).
client.addons.list()
GET /Plone/++api++/@addons HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET http://localhost:8080/Plone/++api++/@addons -H 'accept: application/json' -u admin:admin
{
"items": [
{
"id": "Products.CMFPlacefulWorkflow",
"is_installed": false,
"title": "Workflow Policy Support (CMFPlacefulWorkflow)"
},
{
"id": "plone.app.caching",
"is_installed": true,
"title": "HTTP caching support"
}
]
}
This shows only items. This shows only id, title, is_installed of each entry. This shows 2 of 8 entries.
client.addons.get#
One add-on.
See get().
Calls GET /@addons/plone.session (plone.restapi documentation).
client.addons.get("plone.session")
GET /Plone/++api++/@addons/plone.session HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET http://localhost:8080/Plone/++api++/@addons/plone.session -H 'accept: application/json' -u admin:admin
{
"id": "plone.session",
"is_installed": false,
"profile_type": "default",
"title": "Session refresh support"
}
This shows only id, title, is_installed, profile_type.
client.addons.install#
Install an add-on.
See install().
Calls POST /@addons/plone.session/install (plone.restapi documentation).
client.addons.install("plone.session")
POST /Plone/++api++/@addons/plone.session/install HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X POST http://localhost:8080/Plone/++api++/@addons/plone.session/install -H 'accept: application/json' -u admin:admin
The site answers 204, and the method returns None.
client.addons.upgrade#
Run the pending upgrade steps of an add-on.
See upgrade().
Calls POST /@addons/plone.session/upgrade (plone.restapi documentation).
client.addons.upgrade("plone.session")
POST /Plone/++api++/@addons/plone.session/upgrade HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X POST http://localhost:8080/Plone/++api++/@addons/plone.session/upgrade -H 'accept: application/json' -u admin:admin
The site answers 204, and the method returns None.
client.addons.install_profile#
Import a GenericSetup profile of an add-on.
See install_profile().
Calls POST /@addons/plone.session/import/default (plone.restapi documentation).
client.addons.install_profile("plone.session", "default")
POST /Plone/++api++/@addons/plone.session/import/default HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X POST http://localhost:8080/Plone/++api++/@addons/plone.session/import/default -H 'accept: application/json' -u admin:admin
The site answers 204, and the method returns None.
client.addons.uninstall#
Uninstall an add-on.
See uninstall().
Calls POST /@addons/plone.session/uninstall (plone.restapi documentation).
client.addons.uninstall("plone.session")
POST /Plone/++api++/@addons/plone.session/uninstall HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X POST http://localhost:8080/Plone/++api++/@addons/plone.session/uninstall -H 'accept: application/json' -u admin:admin
The site answers 204, and the method returns None.
client.content_rules#
Content rules assigned to a folder (@content-rules).
client.content_rules.assign#
Assign a rule to a folder.
See assign().
Calls POST /news/@content-rules/rule-1 (plone.restapi documentation).
client.content_rules.assign("/news", "rule-1")
POST /Plone/++api++/news/@content-rules/rule-1 HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X POST http://localhost:8080/Plone/++api++/news/@content-rules/rule-1 -H 'accept: application/json' -u admin:admin
The site answers 200, and the method returns None.
client.content_rules.get#
Rules assigned to a folder, and rules that could be.
See get().
Calls GET /news/@content-rules (plone.restapi documentation).
client.content_rules.get("/news")["content-rules"]
GET /Plone/++api++/news/@content-rules HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET http://localhost:8080/Plone/++api++/news/@content-rules -H 'accept: application/json' -u admin:admin
{
"assigned_rules": [
{
"bubbles": true,
"enabled": true,
"id": "rule-1",
"title": "Log new comments"
}
]
}
This shows only assigned_rules. This shows only id, title, enabled, bubbles of each entry.
client.content_rules.apply_to_subfolders#
Apply rules to the subfolders of a folder, or stop doing so.
Calls PATCH /news/@content-rules (plone.restapi documentation).
client.content_rules.apply_to_subfolders("/news", "rule-1")
PATCH /Plone/++api++/news/@content-rules HTTP/1.1
Host: localhost:8080
Accept: application/json
Content-Type: application/json
Authorization: Basic YWRtaW46YWRtaW4=
{
"form.button.Bubble": true,
"rule_ids": [
"rule-1"
]
}
curl -i -X PATCH http://localhost:8080/Plone/++api++/news/@content-rules -H 'accept: application/json' -H 'content-type: application/json' -u admin:admin --data-raw '{"form.button.Bubble":true,"rule_ids":["rule-1"]}'
The site answers 200, and the method returns None.
client.content_rules.disable#
Disable rules on a folder.
See disable().
Calls PATCH /news/@content-rules (plone.restapi documentation).
client.content_rules.disable("/news", "rule-1")
PATCH /Plone/++api++/news/@content-rules HTTP/1.1
Host: localhost:8080
Accept: application/json
Content-Type: application/json
Authorization: Basic YWRtaW46YWRtaW4=
{
"form.button.Disable": true,
"rule_ids": [
"rule-1"
]
}
curl -i -X PATCH http://localhost:8080/Plone/++api++/news/@content-rules -H 'accept: application/json' -H 'content-type: application/json' -u admin:admin --data-raw '{"form.button.Disable":true,"rule_ids":["rule-1"]}'
The site answers 200, and the method returns None.
client.content_rules.enable#
Enable rules on a folder.
See enable().
Calls PATCH /news/@content-rules (plone.restapi documentation).
client.content_rules.enable("/news", "rule-1")
PATCH /Plone/++api++/news/@content-rules HTTP/1.1
Host: localhost:8080
Accept: application/json
Content-Type: application/json
Authorization: Basic YWRtaW46YWRtaW4=
{
"form.button.Enable": true,
"rule_ids": [
"rule-1"
]
}
curl -i -X PATCH http://localhost:8080/Plone/++api++/news/@content-rules -H 'accept: application/json' -H 'content-type: application/json' -u admin:admin --data-raw '{"form.button.Enable":true,"rule_ids":["rule-1"]}'
The site answers 200, and the method returns None.
client.content_rules.move#
Move a rule up or down in the folder’s list.
See move().
Calls PATCH /news/@content-rules (plone.restapi documentation).
client.content_rules.move("/news", "rule-1", up=False)
PATCH /Plone/++api++/news/@content-rules HTTP/1.1
Host: localhost:8080
Accept: application/json
Content-Type: application/json
Authorization: Basic YWRtaW46YWRtaW4=
{
"operation": "move_down",
"rule_id": "rule-1"
}
curl -i -X PATCH http://localhost:8080/Plone/++api++/news/@content-rules -H 'accept: application/json' -H 'content-type: application/json' -u admin:admin --data-raw '{"operation":"move_down","rule_id":"rule-1"}'
The site answers 200, and the method returns None.
client.content_rules.unassign#
Remove rules from a folder.
See unassign().
Calls DELETE /news/@content-rules (plone.restapi documentation).
client.content_rules.unassign("/news", "rule-1")
DELETE /Plone/++api++/news/@content-rules HTTP/1.1
Host: localhost:8080
Accept: application/json
Content-Type: application/json
Authorization: Basic YWRtaW46YWRtaW4=
{
"rule_ids": [
"rule-1"
]
}
curl -i -X DELETE http://localhost:8080/Plone/++api++/news/@content-rules -H 'accept: application/json' -H 'content-type: application/json' -u admin:admin --data-raw '{"rule_ids":["rule-1"]}'
The site answers 204, and the method returns None.
client.system#
Information about the site and maintenance tasks.
client.system.site#
Site settings used by frontends (@site).
See site().
Calls GET /@site (plone.restapi documentation).
client.system.site()
GET /Plone/++api++/@site HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET http://localhost:8080/Plone/++api++/@site -H 'accept: application/json' -u admin:admin
{
"features": {
"filter_aliases_by_date": true,
"multilingual": false
},
"plone.available_languages": [
"en"
],
"plone.site_title": "Welcome to Plone 6"
}
This shows only plone.site_title, plone.available_languages, features.
client.system.system#
Versions of Plone, Python, Zope and other components (@system).
See system().
Calls GET /@system (plone.restapi documentation).
client.system.system()
GET /Plone/++api++/@system HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET http://localhost:8080/Plone/++api++/@system -H 'accept: application/json' -u admin:admin
{
"plone_restapi_version": "9.15.6",
"plone_version": "6.1.5",
"python_version": "3.12.13 (main, Jun 24 2026, 02:14:59) [GCC 12.2.0]"
}
This shows only plone_version, plone_restapi_version, python_version.
client.system.database#
Database statistics (@database).
See database().
Calls GET /@database (plone.restapi documentation).
client.system.database()
GET /Plone/++api++/@database HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET http://localhost:8080/Plone/++api++/@database -H 'accept: application/json' -u admin:admin
{
"@id": "http://localhost:8080/Plone/@database",
"db_name": "/app/var/filestorage/Data.fs"
}
This shows only @id, db_name.
client.system.transactions#
Recent transactions (@transactions).
See transactions().
Calls GET /@transactions (plone.restapi documentation).
client.system.transactions()
GET /Plone/++api++/@transactions HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET http://localhost:8080/Plone/++api++/@transactions -H 'accept: application/json' -u admin:admin
[
{
"description": "/Plone/DELETE_application_json_@controlpanels",
"username": " admin"
}
]
This shows only description, username of each entry. This shows 1 of 150 entries.
client.system.revert_transactions#
Undo transactions.
Calls GET /@transactions, PATCH /@transactions (plone.restapi documentation).
latest = client.system.transactions()[0]
client.system.revert_transactions(latest["id"])
GET /Plone/++api++/@transactions HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
PATCH /Plone/++api++/@transactions HTTP/1.1
Host: localhost:8080
Accept: application/json
Content-Type: application/json
Authorization: Basic YWRtaW46YWRtaW4=
{
"transaction_ids": [
"QkF5M1o4a0I2VE09\n 2026-11-01T02:47:47 /Plone/PATCH_application_json_@registry "
]
}
curl -i -X GET http://localhost:8080/Plone/++api++/@transactions -H 'accept: application/json' -u admin:admin
curl -i -X PATCH http://localhost:8080/Plone/++api++/@transactions -H 'accept: application/json' -H 'content-type: application/json' -u admin:admin --data-raw '{"transaction_ids":["QkF5M1o4a0I2VE09\n 2026-11-01T02:47:47 /Plone/PATCH_application_json_@registry "]}'
{
"message": "Transactions have been reverted successfully."
}
client.system.upgrade_info#
Pending upgrade steps of the site (@upgrade).
See upgrade_info().
Calls GET /@upgrade (plone.restapi documentation).
client.system.upgrade_info()
GET /Plone/++api++/@upgrade HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET http://localhost:8080/Plone/++api++/@upgrade -H 'accept: application/json' -u admin:admin
{
"@id": "http://localhost:8080/Plone/@upgrade",
"upgrade_steps": {}
}
This shows only @id, upgrade_steps.
client.system.upgrade#
Run the site’s upgrade steps.
See upgrade().
Calls POST /@upgrade (plone.restapi documentation).
client.system.upgrade(dry_run=True)
POST /Plone/++api++/@upgrade HTTP/1.1
Host: localhost:8080
Accept: application/json
Content-Type: application/json
Authorization: Basic YWRtaW46YWRtaW4=
{
"dry_run": true
}
curl -i -X POST http://localhost:8080/Plone/++api++/@upgrade -H 'accept: application/json' -H 'content-type: application/json' -u admin:admin --data-raw '{"dry_run":true}'
{
"@id": "http://localhost:8080/Plone/@upgrade",
"dry_run": true,
"upgraded": true
}
This shows only @id, dry_run, upgraded.
client.system.login_providers#
External authentication providers (GET @login).
See login_providers().
Calls GET /@login (plone.restapi documentation).
client.system.login_providers()
GET /Plone/++api++/@login HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
curl -i -X GET http://localhost:8080/Plone/++api++/@login -H 'accept: application/json' -u admin:admin
{
"options": []
}
client.system.email_send#
Send an email through the site (@email-send).
See email_send().
Calls POST /@email-send (plone.restapi documentation).
Note
This example was not run against a site, because the site needs a mail server. The request below was built, and not sent.
client.system.email_send(
"editor@example.org",
"site@example.org",
"The report is ready.",
subject="Report",
)
POST /Plone/++api++/@email-send HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
Content-Type: application/json
{
"to": "editor@example.org",
"from": "site@example.org",
"message": "The report is ready.",
"subject": "Report"
}
curl -i -X POST http://localhost:8080/Plone/++api++/@email-send -H 'accept: application/json' -H 'content-type: application/json' -u admin:admin --data-raw '{"to":"editor@example.org","from":"site@example.org","message":"The report is ready.","subject":"Report"}'
client.system.email_notification#
Send a message to the site owner, like the contact form does.
See email_notification().
Calls POST /@email-notification (plone.restapi documentation).
Note
This example was not run against a site, because the site needs a mail server. The request below was built, and not sent.
client.system.email_notification(
"reader@example.org",
"I have a question.",
subject="Question",
)
POST /Plone/++api++/@email-notification HTTP/1.1
Host: localhost:8080
Accept: application/json
Authorization: Basic YWRtaW46YWRtaW4=
Content-Type: application/json
{
"from": "reader@example.org",
"message": "I have a question.",
"subject": "Question"
}
curl -i -X POST http://localhost:8080/Plone/++api++/@email-notification -H 'accept: application/json' -H 'content-type: application/json' -u admin:admin --data-raw '{"from":"reader@example.org","message":"I have a question.","subject":"Question"}'