Skip to content
Sangoma SBC REST PHP Examples
PHP
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
pest
README.md
application_archive_backup.php
application_archive_delete.php
application_archive_download.php
application_archive_list.php
application_archive_restore.php
application_archive_restore_test.php
application_archive_upload_post.php
application_archive_upload_put.php
application_archive_upload_test.php
application_configuration_apply.php
application_configuration_reload.php
application_configuration_status.php
application_core_delete.php
application_core_list.php
application_corebt_delete.php
application_corebt_list.php
application_license_info.php
application_license_retrieve.php
application_license_upload_post.php
application_license_upload_put.php
application_license_upload_test.php
application_log_delete.php
application_log_download.php
application_log_list.php
application_service_restart.php
application_service_start.php
application_service_status.php
application_service_stop.php
application_version_retrieve.php
cac_rule_create.php
cac_rule_delete.php
cac_rule_ipaddr_create.php
cac_rule_ipaddr_delete.php
cac_rule_ipaddr_list.php
cac_rule_ipaddr_retrieve.php
cac_rule_ipaddr_update.php
cac_rule_list.php
cac_rule_retrieve.php
cac_rule_user.php
cac_rule_user_create.php
cac_rule_user_delete.php
cac_rule_user_retrieve.php
cac_rule_user_update.php
cdr_cdr_delete.php
cdr_cdr_download.php
cdr_cdr_list.php
cdr_configuration_retrieve.php
cdr_configuration_update.php
certificate_ca_create.php
certificate_ca_delete.php
certificate_ca_list.php
certificate_ca_retrieve.php
certificate_ca_update.php
certificate_server_create.php
certificate_server_delete.php
certificate_server_list.php
certificate_server_retrieve.php
certificate_server_update.php
core_configuration_retrieve.php
core_configuration_update.php
directory_domain_create.php
directory_domain_delete.php
directory_domain_list.php
directory_domain_retrieve.php
directory_domain_update.php
directory_domain_user_create.php
directory_domain_user_delete.php
directory_domain_user_list.php
directory_domain_user_retrieve.php
directory_domain_user_update.php
distributor_configuration_retrieve.php
distributor_configuration_update.php
distributor_list_create.php
distributor_list_delete.php
distributor_list_list.php
distributor_list_resource_create.php
distributor_list_resource_delete.php
distributor_list_resource_list.php
distributor_list_resource_retrieve.php
distributor_list_resource_update.php
distributor_list_retrieve.php
distributor_list_update.php
enum_configuration_retrieve.php
enum_configuration_update.php
firewall_service_restart.php
firewall_service_start.php
firewall_service_status.php
firewall_service_stop.php
hardware_adapter_retrieve.php
lcr_carrier_create.php
lcr_carrier_delete.php
lcr_carrier_list.php
lcr_carrier_rate_create.php
lcr_carrier_rate_delete.php
lcr_carrier_rate_list.php
lcr_carrier_rate_retrieve.php
lcr_carrier_rate_update.php
lcr_carrier_retrieve.php
lcr_carrier_update.php
media_create.php
media_delete.php
media_list.php
media_retrieve.php
media_update.php
mediamon_configuration_retrieve.php
mediamon_configuration_update.php
mediamon_log_download.php
mediamon_service_status.php
network_route_create.php
network_route_delete.php
network_route_list.php
network_route_retrieve.php
network_route_update.php
radius_configuration_retrieve.php
radius_configuration_update.php
radius_vsas_create.php
radius_vsas_delete.php
radius_vsas_list.php
radius_vsas_retrieve.php
radius_vsas_update.php
rest_apikey_create.php
rest_apikey_delete.php
rest_apikey_list.php
rest_apikey_retrieve.php
rest_apikey_update.php
rest_configuration_retrieve.php
rest_configuration_update.php
rest_file_update.php
rest_ipaddr_create.php
rest_ipaddr_delete.php
rest_ipaddr_list.php
rest_ipaddr_retrieve.php
rest_ipaddr_update.php
rtcpmon_configuration_retrieve.php
rtcpmon_configuration_update.php
rtcpmon_log_download.php
rtcpmon_service_restart.php
rtcpmon_service_start.php
rtcpmon_service_status.php
rtcpmon_service_stop.php
setting.inc.php
sip_profile_create.php
sip_profile_delete.php
sip_profile_retrieve.php
sip_profile_update.php
sip_trunk_create.php
sip_trunk_delete.php
sip_trunk_retrieve.php
sip_trunk_update.php
sipsecmon_configuration_retrieve.php
sipsecmon_configuration_update.php
sipsecmon_log_download.php
sipsecmon_rules_create.php
sipsecmon_rules_delete.php
sipsecmon_rules_list.php
sipsecmon_rules_retrieve.php
sipsecmon_rules_update.php
sipsecmon_service_restart.php
sipsecmon_service_start.php
sipsecmon_service_status.php
sipsecmon_service_stop.php
sngms_configuration_retrieve.php
sngms_configuration_update.php
sngms_fwupdate.php
snort_service_restart.php
snort_service_start.php
snort_service_status.php
snort_service_stop.php
snortsam_service_restart.php
snortsam_service_start.php
snortsam_service_status.php
snortsam_service_stop.php
sshd_configuration_retrieve.php
sshd_configuration_update.php
sshd_service_restart.php
sshd_service_start.php
sshd_service_status.php
sshd_service_stop.php
system_restart.php
tooltip.php
update_package_delete.php
update_package_description.php
update_package_install.php
update_package_list.php
update_package_status.php
update_package_upload.php
webconfig_configuration_retrieve.php
webconfig_configuration_update.php
yahoo_com.pem

README.md

Sangoma SBC REST API Examples

  1. setting.inc.php
  • API_KEY: SBC API KEY created via pre-provisioning or SBC GUI
  • SERVER: SBC IP address
  1. Execute php examples
  • eg: php application_core_list.php
  1. REST Definition
  • safepy_def.json

Upgrade Procedure

  1. php update_package_upload.php [absolute path of sbc upgrade package]
  2. php update_package_list.php
  3. php application_service_stop.php
  4. php update_package_install.php [upgrade package name obtained from list php]
  5. php sngms_fwupdate.php
  6. php system_restart.php
  7. Wait for system to come back up via ping test
  8. php application_service_stop.php
  9. php application_configuration_apply.php
  10. php application_service_start.php

Backup

Set setting.inc.php for SBC that will be backed up

  1. php application_archive_backup.php
  2. php application_archive_list.php
  3. php application_archive_download.php
  • File will be written in /tmp directory

Restore

Set setting.inc.php for SBC that will receive restore

  1. php application_archive_upload_post.php <absolute path of backup download file in /tmp directory>
  2. php application_archive_list.php
  • Confirm restore is uploaded correctly
  1. php application_archive_restore.php
  • Confirm result
  1. php system_reboot.php
  • System must be rebooted
  1. Wait for system to come back up via ping test
  2. php application_archive_list.php
You can’t perform that action at this time.