Controller: Themes

API Controller /nodeworx/themes
Required Permissions ["THEMES"]
Action Description
add Add a new theme.
delete Delete a theme.
list List installed themes.
listDeletable List deletable themes.
switchAllUsersTheme Switch users from one theme to another.
syncTheme Sychronizes a theme to the cluster nodes.
update Upgrade a theme.

Action: add

Add a new theme.

Input Parameters

Name Type Notes Required?
archive string Yes

Action: delete

Delete a theme.

Input Parameters

Name Type Notes Required?
theme string
Example Values
blue_steel, calliope, coolfreshness, interstate, nexcess
 Yes

Action: list

List installed themes.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      0 => 'blue_steel',
      1 => 'Blue Steel',
    ),
    1 => 
    array (
      0 => 'calliope',
      1 => 'Calliope',
    ),
    2 => 
    array (
      0 => 'coolfreshness',
      1 => 'Cool Freshness',
    ),
  ),
)

Action: listDeletable

List deletable themes.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      0 => 'blue_steel',
      1 => 'Blue Steel',
    ),
    1 => 
    array (
      0 => 'calliope',
      1 => 'Calliope',
    ),
    2 => 
    array (
      0 => 'coolfreshness',
      1 => 'Cool Freshness',
    ),
  ),
)

Action: switchAllUsersTheme

Switch users from one theme to another.

Input Parameters

Name Type Notes Required?
change_from string
Example Values
blue_steel, calliope, coolfreshness, interstate, interworx, nexcess, vanillaice
 Yes
change_to string
Example Values
calliope, coolfreshness, interstate, interworx, nexcess, vanillaice
 Yes

Action: syncTheme (Added in version 4.6.0-323)

Sychronizes a theme to the cluster nodes.

Input Parameters

Name Type Notes Required?
theme string
Example Values
nexcess
 Yes

Action: update

Upgrade a theme.

Input Parameters

Name Type Notes Required?
theme string
Example Values
nexcess
 Yes
archive string Yes