cPanel API 2 Functions - ZoneEdit::edit_zone_record - Knowledgebase

Description

This function edits a zone record.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=ZoneEdit&cpanel_jsonapi_func=edit_zone_record&Line=5&domain=example.com&name=sub&type=A&txtdata=v=blahblahblah&cname=example.com&address=10.10.10.10&ttl=14400&class=IN

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Edit a type "A" zone record on "example.com"
$edit_zone_record = $cpanel->api2(
    'ZoneEdit', 'edit_zone_record',
 array(
        'Line' => '5',
        'domain' => 'example.com',
        'name' => 'sub',
        'type' => 'A',
        'address' => '10.10.10.10',
        'ttl' => '14400',
        'class' => 'IN',
  )
);
 
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Edit a type "CNAME" zone record on "example.com"
$edit_zone_record = $cpanel->api2(
    'ZoneEdit', 'edit_zone_record',
 array(
        'Line' => '5',
        'domain' => 'example.com',
        'name' => 'sub',
        'type' => 'CNAME',
        'cname' => 'example.com',
        'ttl' => '14400',
        'class' => 'IN',
  )
);
 
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Edit a type "TXT" Zone Record on "example.com"
$edit_zone_record = $cpanel->api2(
    'ZoneEdit', 'edit_zone_record',
 array(
        'Line' => '5',
        'domain' => 'example.com',
        'name' => 'sub',
        'type' => 'TXT',
        'txtdata' => 'v=blahblahblah',
        'ttl' => '14400',
        'class' => 'IN',
  )
);
 
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Edit a type "AAAA" Zone Record on "example.com"
$edit_zone_record = $cpanel->api2(
    'ZoneEdit', 'edit_zone_record',
 array(
        'Line' => '5',
        'domain' => 'example.com',
        'name' => 'genesis',
        'type' => 'AAAA',
        'address' => 'abac:abab:acab:abac:abab:acab:abac:ab11',
        'ttl' => '14400',
        'class' => 'IN',
  )
);
 
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Edit a type "SRV" Zone Record on "example.com"
$edit_zone_record = $cpanel->api2(
    'ZoneEdit', 'edit_zone_record',
 array(
        'Line' => '5',
        'domain' => 'example.com',
        'name' => 'autocorrect',
        'type' => 'SRV',
        'txtdata' => 'v=blahblahblah',
        'ttl' => '14400',
        'class' => 'IN',
  )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Edit a type "A" Zone Record on "example.com"
my $edit_zone_record = $cpliveapi->api2(
    'ZoneEdit', 'edit_zone_record',
{
        'Line' => '5',
        'domain' => 'example.com',
        'name' => 'sub',
        'type' => 'A',
        'address' => '10.10.10.10',
        'ttl' => '14400',
        'class' => 'IN',
   }
);
 
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Edit a type "CNAME Zone Record on "example.com"
my $add_zone_record = $cpliveapi->api2(
    'ZoneEdit', 'edit_zone_record',
{
        'Line' => '5',
        'domain' => 'example.com',
        'name' => 'sub',
        'type' => 'CNAME',
        'cname' => 'example.com',
        'ttl' => '14400',
        'class' => 'IN',
   }
);
 
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Edit a type "TXT" Zone Record on "example.com"
my $edit_zone_record = $cpliveapi->api2(
    'ZoneEdit', 'edit_zone_record',
{
        'Line' => '5',
        'domain' => 'example.com',
        'name' => 'sub',
        'type' => 'TXT',
        'txtdata' => 'v=blahblahblah',
        'ttl' => '14400',
        'class' => 'IN',
   }
);
 
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Edit a type "AAAA" Zone Record on "example.com"
my $add_zone_record = $cpliveapi->api2(
    'ZoneEdit', 'edit_zone_record',
{
        'Line' => '5',
        'domain' => 'example.com',
        'name' => 'genesis',
        'type' => 'CNAME',
        'address' => 'abac:abab:acab:abac:abab:acab:abac:ab11',
        'ttl' => '14400',
        'class' => 'IN',
   }
);
 
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Edit a type "TXT" Zone Record on "example.com"
my $edit_zone_record = $cpliveapi->api2(
    'ZoneEdit', 'edit_zone_record',
{
        'Line' => '5',
        'domain' => 'example.com',
        'name' => 'autocorrect',
        'type' => 'SRV',
        'txtdata' => 'v=blahblahblah',
        'ttl' => '14400',
        'class' => 'IN',
   }
);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read ourDeprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

cpapi2 --user=username ZoneEdit edit_zone_record Line=5 domain=example.com name=sub type=A txtdata=v%3Dblahblahblah cname=example.com address=10.10.10.10 ttl=14400 class="IN"

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "edit_zone_record",
    "data": [
      {
        "result": {
          "newserial": 2014101603,
          "statusmsg": "Bind reloading on hostname using rndc zone: [example.com]\n",
          "status": 1
        }
      }
    ],
    "event": {
      "result": 1
    },
    "module": "ZoneEdit"
  }
}

Note:

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

Parameters

Parameters	Type	Description	Possible values	Example
Line	integer	Required The line in the zone file to edit.	A positive integer.	5
domain	string	Required The record's domain.	A valid domain name.	example.com
name	string	Required The record's name, which maps to the subdomain.	A valid string.	sub
type	string	Required The type of record.	A AAAA CNAME SRV TXT	A
txtdata	string	The record's text data. Note: This parameter is required if the typeparameter's value is TXT or SRV.	A valid string.	v=blahblahblah
cname	string	The record's canonical name. Note: This parameter is required if the typeparameter's value is CNAME.	A valid canonical name.	example.com
address	string	The IP address to map to the record. Note: This parameter is required if the typeparameter's value is A or AAAA.	A valid IPv4 or IPv6 address.	10.10.10.10
ttl	integer	The record's time to live. This value defaults to 14400.	A valid positive integer that represents the record's time to live, in seconds.	14400
class	string	The record's class. This value defaults to IN.	IN	IN

Returns

Return	Type	Description	Possible values	Example
result	hash	A hash of the zone record information.	The hash includes the newserial, statusmsg, and statusreturns.
newserial	integer	The new serial number of the zone file. The function returns this value in the result hash.	A positive integer.	2014101603
statusmsg	string	A status message from the DNS server. The function returns this value in the result hash.	A string.
status	Boolean	Whether the function succeeded. The function returns this value in the result hash.	1 — The function succeeded. 0 — The function failed.	1
reason	string	A reason for failure. Note: This function only returns areason value if it failed.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories