Child pages
  • UAPI Functions - Tokens::create_full_access
Skip to end of metadata
Go to start of metadata

Description

This function creates a new API token with full access to all of a cPanel account's features.

Note:

The token only grants access to the features that the account has access to. For example, if you disable the File Manager feature, the token can't access it.


Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Tokens/create_full_access?user=username&name=example


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.
 
// Create an API token with full access to the cPanel account's features.
$instances = $cpanel->uapi(
    'Tokens', 'create_full_access',
		array(
			'name'	=> 'example'
		)
);


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.
 
# Create an API token with full access to the cPanel account's features.
my $instances = $cpliveapi->uapi(
    'Tokens', 'create_full_access',
		{
			'name'	=> 'example'
		}
);


Note:

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

 cPanel Template Toolkit
<!-- Create an API token with full access to the cPanel account's features. -->
[% data = execute( 'Tokens', 'create_full_access', { 'name' => 'example' } ); %]
[% FOREACH q = data.create_full_access %]
     <p>
         [% q %]
     </p>
[% END %]


Note:

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

 Command Line
uapi --user=username Tokens create_full_access name=example


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":{
      "errors":null,
      "data":{
         "create_time":1549467298,
         "token":"JPQNSRU0DH448UJLGXH7KVJECC5QN9N9"
      },
      "metadata":{
      },
      "status":1,
      "messages":null,
      "warnings":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 name.

Note:

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

example

Returns

ReturnTypeDescriptionPossible valuesExample
create_timeintegerThe API token's creation date and time.A valid timestamp, in Unix Epoch format.

1549467298

tokenstringThe generated API token.A valid API token.

JPQNSRU0DH448UJLGXH7KVJECC5QN9N9