cPanel API 2 Functions - Branding::createpkg

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function creates a branding package's directory.

Note:

cPanel API 2's Branding module only modifies data for the x3 theme. We removed the x3 theme. For more information, read our cPanel Deprecation Plan documentation.

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=Branding&cpanel_jsonapi_func=createpkg&pkg="mypkg"

Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Create a new branding package.
$new_branding_pkg = $cpanel->api2(
    'Branding', 'createpkg',
        array(        
            'pkg'      => 'mypkg',
    )
 );

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 a new branding package.
my $new_branding_pkg = $cpliveapi->api2(
    'Branding', 'createpkg',
    {
            'pkg'      => 'mypkg',
    }
 );

Note:

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

cPanel Tag System (deprecated)

Warnings:

cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

cpapi2 --user=username Branding createpkg pkg=mypkg

Notes:

You must URI-encode values.
username represents your account-level username.
You must run the --user=username option.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "createpkg",
    "data": [
      {
        "pkg": "mypkg"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Branding"
  }
}

Note:

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

Parameters

Input Type Description Possible values Example

Input	Type	Description	Possible values	Example
`pkg`	string	Required The new branding package name.	A string value. You cannot use the following values: `root` A blank value. Any value that contains a forward slash (`/`).	`mypkg`

pkg

string

Required

The new branding package name.

A string value.

You cannot use the following values:

root
A blank value.
Any value that contains a forward slash (/).

mypkg

Returns

Return	Type	Description	Possible values	Example
`error`	string	An error message. This function only returns an `error` value if it failed.	A string that describes the error.	`Branding package names may not contain the "/" character.`
`pkg`	string	The branding package name.	The `pkg` parameter's value.	`mypkg`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`