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 |
|---|---|---|
Add or create an extension | Core | |
Update/Modify an extension | Core | |
Delete an extension | Core | |
Create range of extensions based on given range | Core | |
Fetch the status of an extension | Core | |
Fetch all the configured extensions information | Core | |
Add Inbound Route | Core | |
Update Inbound Route | Core | |
Remove Inbound Route | Core | |
Fetch All Inbound Route | Core | |
Fetch Inbound Route | Core | |
Add Core Device | Core | |
Updates Core Device | Core | |
Fetch Particular Core Device | Core | |
Fetch All Core Device | Core | |
Fetch all vaild extensions | Core | |
Deletes Core Device | Core | |
Updates Advance Settings details | Core | |
Fetch Particular Advance Setting details | Core | |
Fetch All Advance Settings details | Core | |
Fetch All CDR details | Cdr | |
Fetch particular CDR details | Cdr | |
Activate the system | Sysadmin | |
Update the system license | Sysadmin | |
Update system ports like HTTP, HTTPS etc. Valid only if system has active licensed sysadmin module | Sysadmin | |
Fetch system license information | Sysadmin | |
Fetch system activation status | Sysadmin | |
Set hostname of the system | Sysadmin | |
Get hostname of the system | Sysadmin | |
Install SSL certificate using certificate ID | Sysadmin | |
Update SSL certificate using certificate ID | Sysadmin | |
List of upload SSL certificates | Sysadmin | |
Update Provisioning Protocols | Sysadmin | |
Fetch all Provisioning Protocols | Sysadmin | |
Update SSL Protocol for Apache | Sysadmin | |
Install a module like core, ringgroup etc | Framework | |
Uninstall a module like core, voicemail etc | Framework | |
Enable a module like core, sysadmin etc | Framework | |
Disable a module like core, etc | Framework | |
Upgrade a module like core, xmpp etc | Framework | |
Upgrade all module at once. | Framework | |
Perform operations like install, uninstall, enable, disable and upgrade for modules like core etc | Framework | |
Fetch a module status | Framework | |
Fetch asynchronous API status | Framework | |
Operation to check if reload is required or not | Framework | |
Perform the reload/apply config | Framework | |
Fetch details of asterisk like version, status and amistatus | Framework | |
Fetch the database status. whether its connected or not | Framework | |
Fetch the GUI mode whether its basic or advanced | Framework | |
Fetch Status of automatic updated | Framework | |
List's the modules for which setup wizard is completed | Framework | |
Run fwconsole command | Framework | |
Fetch all the installed modules list | Framework | |
Enable Voicemail on a extension | Voicemail | |
Disable Voicemail on a extension | Voicemail | |
Fetch Voicemail details | Voicemail | |
Add/Create a Ringgroup | Ringgroup | |
Update a Ringgoup | Ringgroup | |
Delete a Ringgroup | Ringgroup | |
Fetch all Ringgroup details | Ringgroup | |
Fetch a particular Ringgroup Details | Ringgroup | |
Add a SIPStation key | Sipstation | |
Fetch SIPStation key | Sipstation | |
Fetch SIPStation status details | Sipstation | |
Remove SIPStation Key | Sipstation | |
Remove and delete SIPStation key and delete trunks. | Sipstation | |
Enable firewall configuration to into FreePBX/PBXact system | Firewall | |
Disable firewall configuration to into FreePBX/PBXact system | Firewall | |
Add an IP address that needs to be blocked | Firewall | |
Delete/Remove an blacklisted IP | Firewall | |
Add an IP to whitelist | Firewall | |
Update firewall configurations | Firewall | |
API to list all the whitelisted IPs | Firewall | |
Fetch the firewall configurations Set | Firewall | |
Fetch blacklisted IP's | Firewall | |
Fetch the application status of pm2 module | Pm2 | |
Generate a CSR file | Certman | |
Upload a SSL certificate | Certman | |
Fetch a CSR file | Certman | |
Delete a CSR file | Certman | |
Delete a Certificate by certificate ID | Certman | |
Creating an FTP instance | Filestore | |
Creating an S3 instance | Filestore | |
Fetch Filestore types | Filestore | |
Fetch list of AWS regions | Filestore | |
Fetch the list of filestore locations saved | Filestore | |
Updates FTP instance | Filestore | |
Fetch all filestores | Filestore | |
Create backup using the addbackup API | Backup | |
Restore a created backup | Backup | |
Fetch list of backup's | Backup | |
Fetch all backup configurations | Backup | |
Update backup | Backup | |
Add SIP NAT local IP | SipSettings | |
Update SIP NAT External IP | SipSettings | |
Get the SIP NAT network settings | SipSettings | |
Fetch Web Socket settings | SipSettings | |
Update Web Socket settings | SipSettings | |
Update EPM Global settings | EndpointManager | |
Fetch EPM Global settings | EndpointManager | |
Enable DPMA | EndpointManager | |
Disable DPMA | EndpointManager | |
Fetch Internal External IP's | EndpointManager | |
Update Internal External IP's | EndpointManager | |
Create new SMS web hook | SMS | |
Update SMS web hook | SMS | |
Delete SMS web hook | SMS | |
Fetch All SMS web hooks | SMS | |
Fetch particular SMS web hook | SMS | |
Fetch all details of Diskspace | Dashboard | |
Returns the follow me settings for a single extension. | Find Me / Follow Me | |
Enable follow me for the specified extension. | Find Me / Follow Me | |
Disable follow me for the specified extension. | Find Me / Follow Me | |
Update the follow me settings | Find Me / Follow Me | |
Fetch all firewall interfaces and default zones | Firewall | |
Update firewall interface by setting default zone for firewall interface | Firewall | |
Fetch all firewall advance settings | Firewall | |
Update firewall advance settings | Firewall | |
Upgrade pbx 15 to 16 | Versionupgrade |