Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
UAPI Functions - Tokens::rename - Developer Documentation - cPanel Documentation
Child pages
  • UAPI Functions - Tokens::rename
Skip to end of metadata
Go to start of metadata

Description

This function renames a cPanel account's existing API token.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Tokens/rename?name=example&new_name=newexample


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.
 
// Rename an existing API token on the cPanel account.
$instances = $cpanel->uapi(
    'Tokens', 'rename'
);


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.
 
# Rename an existing API token on the cPanel account.
my $instances = $cpliveapi->uapi(
    'Tokens', 'rename',
);


Note:

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

 Command Line
uapi --user=username Tokens rename name=example new_name=newexample


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)
{
   "result":{
      "messages":null,
      "status":1,
      "metadata":{
      },
      "warnings":null,
      "errors":null,
      "data":null
   }
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
namestring

Required

The API token's name.

A valid API token name.example
new_namestring

Required

The new name for the API token.

A valid name.

Note:

An API token name’s maximum length is 50 characters. The name may only contain alphanumeric characters, dashes (-), and underscores (_).

newexample

Returns

This function only returns metadata.