cPanel module
6 functions, invoked through the cpanel_uapi tool.
scope cpanel:uapi
Call any function with cpanel_uapi(service_id, module="CPDAVD", function, params). Live availability depends on the cPanel features JetHost has enabled on your account — call list_cpanel_operations to see what is active.
add_delegate GET # Share a calendar
This function adds a share for the specified calendar.
calendar string Required
The calendar to share.
delegatee string Required
The person to whom you will share the calendar.
delegator string Required
The owner of the calendar, who wishes to share it to another user.
readonly integer Optional
If set, the provided access will be read-only.
Response — normalized as { ok, data, errors[], warnings[] } ; data contains:
shared integer
Whether the sharing succeeded. 1 — Shared. 0 — Not shared.
One of: 0 1
list_delegates GET # List calendar sharing.
This function lists the sharing configuration in calendars for this account.
No parameters.
Response — normalized as { ok, data, errors[], warnings[] } ; data is an array of:
calendar string
The calendar id.
calname string
The name of the calendar.
delegatee string
The person to whom the owner of the calendar shared it.
delegator string
The owner of the calendar.
readonly integer
If set to 1 , the delegatee only has read access to the calendar.
One of: 0 1
list_users GET # Update calendar sharing
This function lists the users that are available for use with CalDAV and CardDAV
No parameters.
Response — normalized as { ok, data, errors[], warnings[] } ; data is an array of:
Payload varies by call.
manage_collection GET # Perform an operation on a calendar, task list or address book.
This function creates, updates, or deletes a collection.
account string Required
The owner of the calendar.
action string Required
The action to perform (create, update, or delete a collection).
collection_type string Required
The collection type.
path string Required
The path to the collection.
calendar-color string Optional
The color of the calendar, if applicable.
description string Optional
The description of the collection.
name string Optional
The name of the collection. Required when creating a collection.
Response — normalized as { ok, data, errors[], warnings[] } ; data contains:
shared integer
Whether the operation succeeded. 1 — Operation succeeded. 0 — Operation did not succeed.
One of: 0 1
remove_delegate GET # Remove a share.
This function removes a share for the specified calendar.
calendar string Required
The calendar that was shared.
delegatee string Required
The person to whom the calendar was shared.
delegator string Required
The owner of the calendar, who wishes to remove the sharing.
Response — normalized as { ok, data, errors[], warnings[] } ; data contains:
shared integer
Whether the sharing removal succeeded. 1 — Removed. 0 — Not removed.
One of: 0 1
update_delegate GET # Update calendar sharing.
This function updates a share for the specified calendar.
calendar string Required
The calendar to share.
delegatee string Required
The person to whom you will share the calendar.
delegator string Required
The owner of the calendar, who wishes to change the details of the sharing.
readonly integer Optional
If set, the provided access will be read-only.
Response — normalized as { ok, data, errors[], warnings[] } ; data contains:
shared integer
Whether the sharing succeeded. 1 — Shared. 0 — Not shared.
One of: 0 1