Sign in

v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Tokens
API Token Management

Create cPanel API token

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.

get/Tokens/create_full_access

Query parameters

namestring required
Example:example

The API token's name.

Note:

The name may only contain alphanumeric characters, dashes (-), and underscores (_).

expires_atinteger
Example:1609372800

The API token's expiration time.

Important:

  • When an API token expires the system does not delete it. You must manually delete expired API tokens.
  • If you do not use this parameter, the API token will not expire.
readonly1 | 0
Example:1

Restrict the API token to read-only operations.

Note:

A read-only token retains full access to the account's features but may only call operations that do not modify state. Write operations are rejected server-side.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "create_full_access",
  "module": "Tokens",
  "result": {
    "data": {
      "create_time": 1549467298,
      "token": "JPQNSRU0DH448UJLGXH7KVJECC5QN9N9"
    },
    "status": 1
  }
}