v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

DAV

Calendar and Contacts (DAV)

Return whether global address book is enabled

This function checks whether the shared global address book is enabled on the current cPanel account's webmail accounts.

get/DAV/has_shared_global_addressbook

Query parameters

namestring

Example:user

cPanel account user name or a Webmail user's email address. If you do not specify a user, this parameter defaults to the currently-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": "has_shared_global_addressbook",
  "module": "DAV",
  "result": {
    "data": {
      "shared": 1
    },
    "status": 1
  }
}