GraphQL PBX APIs Documentation

The API module is new for PBX version 15+ and is still in development. It's possible that changes in APIs may occur while development is in progress.

 

We can always refer to API module's documentation section from PBX (FreePBX/ PBXact) GUI to find details of available APIs as mentioned in API GraphQL Documentation.

Intention of this wiki to capture currently supported modules APIs for quick reference purpose so we can easily see available request APIs call and response data.

 

API

Description

Module

API

Description

Module

addExtension 

Add or create an extension

Core

updateExtension

Update/Modify an extension

Core

deleteExtension

Delete an extension

Core

createRangeofExtension

Create range of extensions based on given range

Core

fetchExtension 

Fetch the status of an extension

Core

fetchAllExtensions 

Fetch all the configured extensions information

Core

addInboundRoute

Add Inbound Route

Core

updateInboundRoute

Update Inbound Route

Core

removeInboundRoute

Remove Inbound Route

Core

fetchAllInboundRoutes

Fetch All Inbound Route

Core

fetchInboundRoute

Fetch Inbound Route

Core

addCoreDevice

Add Core Device

Core

updateCoreDevice

Updates Core Device

Core

fetchCoreDevice

Fetch Particular Core Device

Core

fetchAllCoreDevice

Fetch All Core Device

Core

fetchAllValidExtensions

Fetch all vaild extensions

Core

deleteCoreDevice

Deletes Core Device

Core

updateAdvanceSettings

Updates Advance Settings details

Core

fetchAdvanceSetting

Fetch Particular Advance Setting details

Core

fetchAllAdvanceSettings

Fetch All Advance Settings details

Core

fetchAllCdrs

Fetch All CDR details

Cdr

fetchCdr

Fetch particular CDR details

Cdr

activateSystem

Activate the system

Sysadmin

updateLicence

Update the system license

Sysadmin

updateProvisionPort

Update system ports like HTTP, HTTPS etc. Valid only if system has active licensed sysadmin module

Sysadmin

fetchLicenceDetails

Fetch system license information

Sysadmin

fetchActivationStatus

Fetch system activation status

Sysadmin

addHostname

Set hostname of the system

Sysadmin

fetchHostname

Get hostname of the system

Sysadmin

installSSLCertificate

Install SSL certificate using certificate ID

Sysadmin

updateSSLCertificate

Update SSL certificate using certificate ID

Sysadmin

fetchSSLCertificates

List of upload SSL certificates

Sysadmin

updateProvisioningProtocols

Update Provisioning Protocols

Sysadmin

fetchProvisioningProtocols

Fetch all Provisioning Protocols

Sysadmin

updateSSLProtocol

Update SSL Protocol for Apache

Sysadmin

InstallModule

Install a module like core, ringgroup etc

Framework

uninstallModule

Uninstall a module like core, voicemail etc

Framework

enableModule

Enable a module like core, sysadmin etc

Framework

disableModule

Disable a module like core, etc

Framework

upgradeModule

Upgrade a module like core, xmpp etc

Framework

upgradeAllModules

Upgrade all module at once.

Framework

moduleOperation

Perform operations like install, uninstall, enable, disable and upgrade for modules like core etc

Framework

fetchModuleStatus

Fetch a module status

Framework

fetchApiStatus

Fetch asynchronous API status

Framework

fetchNeedReload

Operation to check if reload is required or not

Framework

doreload

Perform the reload/apply config

Framework

fetchAsteriskDetails

Fetch details of asterisk like version, status and amistatus

Framework

fetchDBStatus

Fetch the database status. whether its connected or not

Framework

fetchGUIMode

Fetch the GUI mode whether its basic or advanced

Framework

fetchAutomaticUpdate

Fetch Status of automatic updated

Framework

fetchSetupWizard

List's the modules for which setup wizard is completed

Framework

fwconsoleCommand

Run fwconsole command

Framework

fetchInstalledModules

Fetch all the installed modules list

Framework

enableVoiceMail

Enable Voicemail on a extension

Voicemail

disableVoiceMail

Disable Voicemail on a extension

Voicemail

fetchVoiceMail

Fetch Voicemail details

Voicemail

addRingGroup

Add/Create a Ringgroup

Ringgroup

updateRinggroup

Update a Ringgoup

Ringgroup

deleteRingGroup

Delete a Ringgroup

Ringgroup

fetchAllRingGroup

Fetch all Ringgroup details

Ringgroup

fetchRingGroup

Fetch a particular Ringgroup Details

Ringgroup

addSipStationKey

Add a SIPStation key

Sipstation

fetchSipStationkey

Fetch SIPStation key

Sipstation

fetchSipStationStatus

Fetch SIPStation status details

Sipstation

removeSipStationKey

Remove SIPStation Key

Sipstation

removeSipStationKeyAndDeleteTrunk

Remove and delete SIPStation key and delete trunks.

Sipstation

enableFirewall

Enable firewall configuration to into FreePBX/PBXact system

Firewall

disableFirewall

Disable firewall configuration to into FreePBX/PBXact system

Firewall

addBlackListIP

Add an IP address that needs to be blocked

Firewall

deleteBlackListIP

Delete/Remove an blacklisted IP

Firewall

addWhiteListIP

Add an IP to whitelist

Firewall

updateFirewallConfiguration

Update firewall configurations

Firewall

fetchAllWhitelistIPs

API to list all the whitelisted IPs

Firewall

fetchFirewallConfiguration

Fetch the firewall configurations Set

Firewall

fetchBlacklistIp

Fetch blacklisted IP's

Firewall

fetchPm2AppStatus

Fetch the application status of pm2 module

Pm2

generateCSR

Generate a CSR file

Certman

uploadSSLCertificate

Upload a SSL certificate

Certman

fetchCSRFile

Fetch a CSR file

Certman

deleteCSRFile

Delete a CSR file

Certman

deleteCertificate

Delete a Certificate by certificate ID

Certman

addFTPInstance

Creating an FTP instance

Filestore

addS3Instance

Creating an S3 instance

Filestore

fetchFilestoreTypes

Fetch Filestore types

Filestore

fetchAWSregions

Fetch list of AWS regions

Filestore

fetchFilestoreLocations

Fetch the list of filestore locations saved

Filestore

updateFTPInstance

Updates FTP instance

Filestore

fetchAllFilestores

Fetch all filestores

Filestore

addBackup

Create backup using the addbackup API

Backup

restoreBackup

Restore a created backup

Backup

fetchBackupFiles

Fetch list of backup's

Backup

fetchAllBackupConfigurations

Fetch all backup configurations

Backup

updateBackup

Update backup

Backup

addSipNatLocalIp

Add SIP NAT local IP

SipSettings

updateSipNatExternalIp

Update SIP NAT External IP

SipSettings

fetchSipNatNetworkSettings

Get the SIP NAT network settings

SipSettings

fetchWSSettings

Fetch Web Socket settings

SipSettings

updateWSSettings

Update Web Socket settings

SipSettings

updateEndpointManagerGlobalSettings

Update EPM Global settings

EndpointManager

fetchEndpointManagerGlobalSettings

Fetch EPM Global settings

EndpointManager

enableDPMA

Enable DPMA

EndpointManager

disableDPMA

Disable DPMA

EndpointManager

fetchInternalExternalIPs

Fetch Internal External IP's

EndpointManager

updateEndpointGlobalSettings

Update Internal External IP's

EndpointManager

addSmsWebhook

Create new SMS web hook

SMS

updateSmsWebhook

Update SMS web hook

SMS

deleteSmsWebhook

Delete SMS web hook

SMS

fetchAllSmsWebhook

Fetch All SMS web hooks

SMS

fetchSmsWebhook

Fetch particular SMS web hook

SMS

checkdiskspace

Fetch all details of Diskspace

Dashboard

fetchFollowMe

Returns the follow me settings for a single extension.

Find Me / Follow Me

enableFollowMe

Enable follow me for the specified extension.

Find Me / Follow Me

disableFollowMe

Disable follow me for the specified extension.

Find Me / Follow Me

updateFollowMe

Update the follow me settings

Find Me / Follow Me

fetchInterface 

Fetch all firewall interfaces and default zones

Firewall

updateFirewallInterface

Update firewall interface by setting default zone for firewall interface

Firewall

fetchFirewallAdvanceSettings 

Fetch all firewall advance settings

Firewall

updateFirewallAdvanceSettings

Update firewall advance settings

Firewall

upgradepbx15to16

Upgrade pbx 15 to 16 

Versionupgrade

Return to Documentation Home I Return to Sangoma Support