cPanel module

CCS

5 functions, invoked through the cpanel_uapi tool.

scope cpanel:uapi

Call any function with cpanel_uapi(service_id, module="CCS", 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#

Add calendar delegation

This function delegates a user's calendar to another user.

Note:

You must install the Calendar and Contacts Server cPanel plugin to access this API function.

delegateestringRequired

The user to whom you wish to delegate the calendar.

delegatorstringRequired

The calendar's owner.

readonlyintegerOptional

Whether the delegatee will only have read-only access on the calendar. 1 - Read-only access. 0 - Full access.

list_delegates GET#

List cPanel account's calendar delegates

This function lists all calendar delegates on the cPanel account.

Note:

You must install the Calendar and Contacts Server cPanel plugin to access this API function.

No parameters.

Response — normalized as { ok, data, errors[], warnings[] }; data is an array of:

delegateestring

The user with delegation rights.

delegatorstring

The calendar's owner.

read_onlyinteger

Whether the delegatee has read-only access on the calendar. 1 - Read-only access. 0 - Full access.

One of: 1 0

list_users GET#

List cPanel account's calendar users

This function lists all calendar users on the cPanel account.

Note:

You must install the Calendar and Contacts Server cPanel plugin to access this API function.

No parameters.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.

remove_delegate GET#

Remove calendar delegation

This function removes a delegate from another user's calendar.

Note:

You must install the Calendar and Contacts Server cPanel plugin to access this API function.

delegateestringRequired

The user from whom you wish to remove delegation rights.

delegatorstringRequired

The calendar's owner.

update_delegate GET#

Update calendar delegation

This function updates the delegation of a user's calendar to another user.

Note:

You must install the Calendar and Contacts Server cPanel plugin to access this API function.

delegateestringRequired

The user to whom you delegated the calendar.

delegatorstringRequired

The calendar's owner.

readonlyintegerOptional

Whether the delegatee will only have read-only access on the calendar. 1 - Read-only access. 0 - Full access.