update_ddnsuser()

Update a dynamic DNS user.

All API functions DDNS Settings

Signature

update_ddnsuser(array $parameters): mixed

Parameters

Pass these parameters as KasRequestParams. Every request also requires kas_login, kas_auth_type, and kas_auth_data, as shown in SOAP with PHP.

Name Description Requirement
dyndns_login The login Required
dyndns_password The new password Optional
dyndns_comment The comment Optional
dyndns_dual_stack Dual stack mode Optional

PHP example

<?php

// $sessionToken is returned by KasAuth, see SOAP with PHP.
$parameters = [
    'dyndns_login' => 'dyn0123456',
    'dyndns_comment' => 'at home',
    'dyndns_password' => 'password',
];

try {
    $client = new SoapClient('https://kasapi.kasserver.com/soap/wsdl/KasApi.wsdl');
    $response = $client->KasApi(json_encode([
        'kas_login' => 'w0123456',
        'kas_auth_type' => 'session',
        'kas_auth_data' => $sessionToken,
        'kas_action' => 'update_ddnsuser',
        'KasRequestParams' => $parameters,
    ]));
    print_r($response);
} catch (SoapFault $fault) {
    echo 'Error: ' . $fault->faultstring;
}
Open interactive example

Responses and error codes

  • TRUE the action was carried out
  • missing_parameter a required parameter is missing
  • nothing_to_do nothing was changed
  • dyndns_login_not_found
  • dyndns_comment_syntax_incorrect
  • password_syntax_incorrect
  • dyndns_target_ip_syntax_incorrect
  • dyndns_target_ip6_syntax_incorrect
  • dns_settings_not_allowed
  • ddns_service_temporarily_not_available
  • dyndns_dual_stack_syntax_incorrect