We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Child pages
  • UAPI Functions - CCS::list_delegates
Skip to end of metadata
Go to start of metadata

Description

This function lists all calendar designations on the cPanel account.

Note:

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

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/CCS/list_delegates



Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List calendar delegates
$delegate_calendar = $cpanel->uapi(
    'CCS', 'list_delegates',
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List calendar delegates
my $delegate_calendar = $cpliveapi->uapi(
    'CCS', 'list_delegates',
);


Note:

For more information, read our Guide to the LiveAPI System.

 Command Line
uapi --user=username CCS list_delegates


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
	"messages": null,
	"errors": null,
	"status": 1,
	"metadata": {},
	"data": [{
			"delegator": "user1@example.com",
			"delegatee": "user2@example.com",
			"readonly": 1
		},
		{
			"delegator": "user3@example.com",
			"delegatee": "user4@example.com",
			"readonly": 1
		}
	]
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

ParameterTypeDescriptionPossible valuesExample
delegatorstring

The calendar's owner.

A valid email address on the cPanel account.

user1@example.com
delegateestring

The user with delegation rights.

A valid email address on the cPanel account.

user2@example.com
readonlyBoolean

Whether the delegatee has read-only access on the calendar.

  • 1 — Read-only access.
  • 0 — Full access.
1