Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function checks whether the DAV service is enabled.

Examples


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

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.
 
// Verify that the system has the DAV service enabled.
$DAV = $cpanel->uapi(
    'DAV', 'is_dav_service_enabled'
);

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.
  
# Verify that the system has the DAV service enabled.
my $is_dav_service_enabled = $cpliveapi->uapi(
    'DAV', 'is_dav_service_enabled',
);

Note:

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

 

 cPanel Template Toolkit
<!-- Verify that the system has the DAV service enabled. -->
[% data = execute( 'DAV', 'is_dav_service_enabled' ); %]
[% FOREACH q = data %]
     <p>
         [% q %]
     </p>
[% END %]

Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username DAV is_dav_service_enabled

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. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
    "messages": null,
    "errors": null,
    "status": 1,
    "metadata": {},
    "data": {
        "enabled": 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

ReturnTypeDescriptionPossible valuesExample
enabledBoolean

Whether the DAV service is enabled.

  • 1 — Enabled.
  • 0 — Disabled.
1