Chapter 57: Controller: /nodeworx/twofactorauth Up Part II: NodeWorx API Spec Chapter 59: Controller: /nodeworx/users 

58 Controller: /nodeworx/updates

Required Permissions "UPDATES"
Action: apply
Added in version 4.8.0-393
Description Apply available updates for specified packages.
Input Parameters
Name Type Notes Required?
package struct (integer) No*
* indicates that it’s actually required, but probably already has a valid default value
Action: channels
Added in version 4.11.4-467
Description Update software channels.
Input Parameters
Name Type Notes Required?
interworx_channel string Help Entry
Changes the channel that InterWorx receives updates via. <ul><li><b>Release</b> - the default channel.</li><li><b>Stable</b> - The Stable channel is updated with the contents of Release after a period of stability. This applies to ALL updates - including security updates.</li><li><b>Release Candidate</b> - This channel contains features that have passed through the Beta process and are scheduled for near-future release.</li><li><b>Beta</b> - contains pre-release versions. Recommended for customers that want not-yet-released features or bug fixes, and are willing to help test and provide bug reports.</li></ul>
Example Values
stable, release, release-candidate, beta
Example Default Value
beta
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: editRepository
Added in version 5.0.14-579
Description Edit a repository.
Input Parameters
Name Type Notes Required?
repository string Yes
file string Example Values
/etc/yum.repos.d/784.repo, /etc/yum.repos.d/CentOS-Base.repo, /etc/yum.repos.d/CentOS-Debuginfo.repo, /etc/yum.repos.d/CentOS-Media.repo, /etc/yum.repos.d/CentOS-fasttrack.repo, /etc/yum.repos.d/interworx-hotfix.repo
Yes
enabled integer Example Values
1, 0
Example Default Value
1
No*
exclude struct (string) Help Entry
List of packages to exclude from updates or installs. Shell globs using wildcards (eg. * and ?) are allowed.
No
include struct (string) Help Entry
Inverse of exclude. This is a list of packages you want to use from a repository. If this option lists only one package, then that is all yum will ever see from the repository. Defaults to an empty list.
No
* indicates that it’s actually required, but probably already has a valid default value
Action: listAvailableUpdates
Added in version 4.8.0-393
Description Lists available updates.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
),
)
Action: listRecentUpdates
Added in version 4.8.0-393
Description Lists recent updates.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’name’ => ’bind-utils’,
’summary’ => ’Utilities for querying DNS name servers’,
’version’ => ’9.8.2’,
’release’ => ’0.47.rc1.el6_8.4’,
’repo’ => ’updates’,
’has_history’ => ’1’,
’action_time’ => ’1484739238’,
’action’ => ’updated’,
),
1 =>
array (
’name’ => ’bind-libs’,
’summary’ => ’Libraries used by the BIND DNS packages’,
’version’ => ’9.8.2’,
’release’ => ’0.47.rc1.el6_8.4’,
’repo’ => ’updates’,
’has_history’ => ’1’,
’action_time’ => ’1484739237’,
’action’ => ’updated’,
),
2 =>
array (
’name’ => ’kernel-headers’,
’summary’ => ’Header files for the Linux kernel for use by glibc’,
’version’ => ’2.6.32’,
’release’ => ’642.13.1.el6’,
’repo’ => ’updates’,
’has_history’ => ’1’,
’action_time’ => ’1484307318’,
’action’ => ’updated’,
),
),
)
Action: listRepositories
Added in version 5.0.14-579
Description Lists software repositories.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’name’ => ’InterWorx Build 784 Test - Generic’,
’repository’ => ’interworx-build-test-noarch’,
’is_enabled’ => 1,
’file’ => ’/etc/yum.repos.d/784.repo’,
),
1 =>
array (
’name’ => ’InterWorx Build 784 Test’,
’repository’ => ’interworx-build-test’,
’is_enabled’ => 1,
’file’ => ’/etc/yum.repos.d/784.repo’,
),
2 =>
array (
’name’ => ’CentOS-$releasever - Base’,
’repository’ => ’base’,
’is_enabled’ => 1,
’file’ => ’/etc/yum.repos.d/CentOS-Base.repo’,
),
),
)
Action: listUpdateChannel
Added in version 5.0.14-579
Description Lists the current update channel for InterWorx.
Sample output
array (
’status’ => 0,
’payload’ => ’beta’,
)
Action: options
Added in version 4.7.0-339
Description Set auto-update options.
Input Parameters
Name Type Notes Required?
osupdates integer Example Values
1, 0
Example Default Value
1
No*
update_email string Help Entry
InterWorx can send an email to notify recipients that an update has occurred.
No
* indicates that it’s actually required, but probably already has a valid default value
Action: queryChannels
Added in version 5.1.0-838
Description Displays the information available to the action "channels".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’interworx_channel’ => ’beta’,
),
)
Action: queryEditRepository
Added in version 5.1.0-838
Description Displays the information available to the action "editRepository".
Input Parameters
Name Type Notes Required?
repository string Yes
file string Example Values
/etc/yum.repos.d/784.repo, /etc/yum.repos.d/CentOS-Base.repo, /etc/yum.repos.d/CentOS-Debuginfo.repo, /etc/yum.repos.d/CentOS-Media.repo, /etc/yum.repos.d/CentOS-fasttrack.repo, /etc/yum.repos.d/interworx-hotfix.repo
Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’name’ => ’InterWorx Build 784 Test’,
’enabled’ => ’1’,
’exclude’ =>
array (
),
’include’ =>
array (
),
’repository’ => ’interworx-build-test’,
’file’ => ’/etc/yum.repos.d/784.repo’,
),
)
Action: queryHistory
Added in version 4.8.0-393
Description Lists history for a specific package.
Input Parameters
Name Type Notes Required?
package string Yes
Action: queryOptions
Added in version 5.1.0-838
Description Displays the information available to the action "options".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’osupdates’ => ’1’,
’iworxupdates’ => ’##LG_ENABLED##’,
’update_email’ => ’’,
),
)
Action: queryUpgradeStep
Added in version 5.0.14-579
Description Check the status of an upgrade step.
Input Parameters
Name Type Notes Required?
step integer Yes
 Chapter 57: Controller: /nodeworx/twofactorauth Up Part II: NodeWorx API Spec Chapter 59: Controller: /nodeworx/users 

(C) 2017 by InterWorx LLC