Framework Module GraphQL APIs
- Nathaniel Halbrooks
- 1 Install a Module
- 2 Uninstall a Module
- 3 Enable a Module
- 4 Disable a Module
- 5 Upgrade a Module
- 6 Upgrade All Modules
- 7 Module operation
- 8 Fetch module status
- 9 Asynchronous API Status
- 10 Check if reload required
- 11 Perform reload
- 12 Fetch Asterisk Details
- 13 Fetch DB Status
- 14 Fetch GUI Mode
- 15 Fetch Automatic updates
- 16 Fetch Setup Wizard
- 17 Run fwconsole command
- 18 Fetch Installed Modules
This section will capture the APIs related with Framework or Module admin.
Install a Module
API - InstallModule
API Parameter -
Name | Required | Type | Default | Description |
|---|---|---|---|---|
module | Mandatory | String |
| Specify the module name. This could be full name of the module like ' core'. |
forceDownload | Optional | Boolean | false | Whether to download a module before installing. |
Query Parameters
status
message
transaction_id |
API Request
mutation {
installModule(input: {
module: "xmpp"
forceDownload: true }) {
status message transaction_id
}
} |
API Response
{
"data": {
"installModule": {
"status": true,
"message": "Action[downloadinstall] on module[xmpp] has been initiated. Please check the status using fetchApiStatus api with the returned transaction id",
"transaction_id": "90"
}
}
} |
Uninstall a Module
API - uninstallModule
API Parameter -
Name | Required | Type | Default | Description |
|---|---|---|---|---|
module | Mandatory | String |
| Specify the module name. This could be full name of the module like ' core'. |
RemoveCompletely | Optional | Boolean | false | After uninstalling the module, completely remove module from the filesystem as well. |
Query Parameters
API Request
API Response
Enable a Module
API: enableModule
API Parameter -
Name | Required | Type | Default | Description |
|---|---|---|---|---|
module | Mandatory | String |
| Specify the module name. This could be full name of the module like ' core'. |
Query Parameters
API Request
API Response
Disable a Module
API: disableModule
API Parameter -
Name | Required | Type | Default | Description |
|---|---|---|---|---|
module | Mandatory | String |
| Specify the module name. This could be full name of the module like ' core'. |
Query Parameters
API Request
API Response
Upgrade a Module
To upgrade a module.
API - upgradeModule
API Parameter -
Name | Required | Type | Default | Description |
|---|---|---|---|---|
module | Mandatory | String |
| Specify the module name. This could be full name of the module like ' core'. |
Query Parameters
API Request
API Response
Upgrade All Modules
To upgrade all modules.
API - upgradeAllModules
API Parameter -
Name | Required | Type | Default | Description |
|---|---|---|---|---|
runReloadCommand | Mandatory | Boolean | true | If true executes reload command after running module upgradation. By default this is true. |
runChownCommand | Mandatory | Boolean | true | If true executes chown command after running module upgradation. By default this is true |
Query Parameters
API Request
API Response
Module operation
A generic API to perform all operation's e.g install/uninstall, enable/disable , delete/upgrade.
API - moduleOperation
API Parameter -
Name | Required | Type | Default | Description |
|---|---|---|---|---|
module | Mandatory | String |
| Specify the module name. This could be full name of the module like ' core'. |
action | Mandatory | String |
| Action is to either install or uninstall a module. |
Query Parameters
API Request
API Response
Fetch module status
An API to fetch the module status.
API - fetchModuleStatus
API Parameter -
Name | Required | Type | Default | Description |
|---|---|---|---|---|
moduleName | Mandatory | String |
| Specify the module name. This could be full name of the module like ' core'. |
Query Parameters
API Request
API Response
Asynchronous API Status
An API to check for the long-running api status
API - fetchApiStatus
API Parameter -
Name | Required | Type | Default | Description |
|---|---|---|---|---|
txnId | Mandatory | ID |
| Id of the transaction you want to see the status of. |
status | optional | Boolean |
| Will get the status of the request performed |
message | optional | String |
| Response message. |
Query Parameters
API Request
API Response
Check if reload required
An API to check for if reload is required
API - fetchNeedReload
API Parameter - none
Query Parameters
API Request
API Response
Perform reload
An API to perform reload
API - doreload
API Parameter - none
Query Parameters
API Request
API Response
Fetch Asterisk Details
An API to fetch the asterisk details.
API - fetchAsteriskDetails
API Parameter: none
Query Parameters
API Request
API Response
Fetch DB Status
An API to fetch the database details.
API -fetchDBStatus
API Parameter: none
Query Parameters
API Request
API Response
Fetch GUI Mode
An API to fetch the GUI mode.
API -fetchGUIMode
API Parameter: none
Query Parameters
API Request
API Response
Fetch Automatic updates
An API to fetch the automatic update details.
API- fetchAutomaticUpdate
API Parameter: none
Query Parameters
API Request
API Response
Fetch Setup Wizard
An API to fetch the setup wizard details.
API- fetchSetupWizard
API Parameter: none
Query Parameters
API Request
API Response
Run fwconsole command
API: fwconsoleCommand
API Parameter -
Name | Required | Type | Default | Description |
|---|---|---|---|---|
command | Mandatory | Enum |
| Specify the command. The possible commands which can be given are r, reload, restart and chown. These commands should be passed as an input without double quotes or single quotes |
Query Parameters
API Request
API Response
Fetch Installed Modules
An API to fetch all the installed modules.
API - fetchInstalledModules
API Parameter: none
Query Parameters
API Request
API Response