Sign in

v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
DAV
Calendar and Contacts (DAV)

Return CalDAV and CardDAV connection information

This function returns the connection information to set up the CalDAV and CardDAV clients.

get/DAV/get_calendar_contacts_config

Query parameters

string username

A cPanel account.

OR
string email

A valid email account.

Example:username

A cPanel account or valid email account user.

If you do not include this parameter, the function defaults to the current authenticated user.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "get_calendar_contacts_config",
  "module": "DAV",
  "result": {
    "data": {
      "activesync": {
        "enabled": 1,
        "port": 2091,
        "server": "example.com",
        "user": "username"
      },
      "no_ssl": {
        "calendars": [
          {
            "description": "Custom calendar 1.",
            "name": "Calendar 1",
            "path": "/calendars/example/calendar:ZcG9JBH68WXxfMVUgvSrUw1",
            "url": "http://example.com:2079/calendars/example/calendar:ZcG9JBH68WXxfMVUgvSrUw1"
          }
        ],
        "contacts": [
          {
            "description": "Custom address book 1.",
            "name": "Custom 1",
            "path": "/addressbooks/example/contacts:E-KKA5uQZyQJbTBKcGP3OQ6",
            "url": "https://example.com:2080/addressbooks/example/contacts:E-KKA5uQZyQJbTBKcGP3OQ6"
          }
        ],
        "free_busy": "http://server.example.com:2079/kronolith/fb.php?u=example",
        "full_server": "http://example.com:2079/rpc/principal/example",
        "port": 2079,
        "server": "http://example.com:2079"
      },
      "ssl": {
        "calendars": [
          {
            "description": "Custom calendar 2.",
            "name": "Calendar 2",
            "path": "/calendars/example/calendar:ZcG9JBH68WXxfMVUgvSrUw1",
            "url": "http://example.com:2080/calendars/example/calendar:ZcG9JBH68WXxfMVUgvSrUw1"
          }
        ],
        "contacts": [
          {
            "description": "Custom address book 2.",
            "name": "Address book 2",
            "path": "/addressbooks/example/contacts:E-KKA5uQZyQJbTBKcGP3OQ6",
            "url": "https://example.com:2080/addressbooks/example/contacts:E-KKA5uQZyQJbTBKcGP3OQ6"
          }
        ],
        "free_busy": "http://server.example.com:2080/kronolith/fb.php?u=example",
        "full_server": "http://example.com:2080/rpc/principal/example",
        "is_self_signed": 1,
        "port": 2080,
        "server": "https://example.com:2080"
      },
      "user": "username"
    },
    "status": 1
  }
}