Child pages
  • UAPI Functions - Market::get_provider_specific_dcv_constraints
Skip to end of metadata
Go to start of metadata

Description


This function returns the provider's filename requirements for Domain Control Validation (DCV) checks.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Market/get_provider_specific_dcv_constraints?provider=cPStore


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.
 
// Check DCV filename constraints for cPStore provider.
$rock_me_amadeus = $cpanel->uapi(
    'Market', 'get_provider_specific_dcv_constraints',
     array(
        'provider'           => 'cPStore'
 )
);


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.
 
# Check DCV filename constraints for cPStore provider.
my $rock_me_amadeus = $cpliveapi->uapi(
    'Market', 'get_provider_specific_dcv_constraints',    {
       'provider'           => 'cPStore'
   }
);


Note:

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

 

 cPanel Template Toolkit
<!-- Check DCV filename constraints for cPStore provider. -->
[% execute('Market', 'get_provider_specific_dcv_constraints',{ provider => 'cPStore'} ) %]


Note:

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

 

 Command Line
uapi --user=username Market get_provider_specific_dcv_constraints provider=cPStore


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":{  
      "transformed":1
   },
   "data":
         {  
            "dcv_file_allowed_characters":
              ["a","b","c","0","1","2","3","4","5","6","7","8","9"],
            "dcv_file_random_character_count":32,
            "dcv_file_extension":"txt",
            "dcv_file_relative_path":".well-known/acme-challenge",
            "dcv_user_agent_string":"SECTIGO DCV"
         }
}


Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
providerstring

Required

The cPanel Market provider's name.

A valid string.cPStore


Returns

ReturnTypeDescriptionPossible valuesExample
dcv_file_allowed_characters
array

An array that lists the characters which the provider allows in the DCV check file's filename.

A valid character.
 Click to view...
"a","b","c","0","1","2","3","4","5","6","7","8","9"
dcv_file_random_character_count
integerThe number of characters that the provider allows in the DCV check file's filename.A valid integer.32
dcv_file_extension
string

The DCV check file extension that the provider requires.

A valid file extension.txt
dcv_file_relative_pathstringThe path to the DCV check file, relative to the document root directory.A valid file path, relative to the domain's document root directory..well-known/acme-challenge
dcv_user_agent_stringstringThe user agent string that the system will use for the imitated local DCV check.A valid agent string.SECTIGO DCV