SUP-able functions

FunctionArgumentsDescription
get_cluster/0
link_cluster/1(AccessCode)
link_cluster/2(AccessCode,ClusterName)
loaded/0
reset_cluster_secret/0
set_cluster_meta_kazoo_version/1(KazooVersion)
set_cluster_name/1(ClusterName)
set_cluster_secret/1(ClusterSecret)
unlink_cluster/0

get_cluster/0

Use this command to retrieve your cluster information which is saved while linking the cluster with 2600Hz Marketplace.

sup appex_client_maintenance get_cluster

Easy commands to link your cluster to 260Hz Marketplace. To link your cluster follow these steps:

  • start by getting an Access Code by login to 2600Hz Marketplace
  • Go to Manage Accounts -> Manage Cluster
  • Generate an Access Code and copy
  • Use Monster UI App Exchange -> Marketplace Connector
  • or run one of these maintenance commands like:
sup appex_client_maintenance link_cluster "{YOUR_ACCESS_CODE}"

# you can also give your cluster a name to identify on Marketplace:
sup appex_client_maintenance link_cluster "{YOUR_ACCESS_CODE}" "{CLUSTER_NAME}"

reset_cluster_secret/1

Use this command to request a new cluster secret, in case of

  • The old cluster secret was leaked
  • The owner wants to reset for any other reasons
sup appex_client_maintenance reset_cluster_secret

set_cluster_meta_kazoo_version/1

Use this command to update your meta kazoo version which is already saved while linking the cluster with 2600Hz Marketplace.

sup appex_client_maintenance set_cluster_meta_kazoo_version "{KAZOO_VERSION}"

set_cluster_name/1

Use this command to update your cluster name which is already saved while linking the cluster with 2600Hz Marketplace.

sup appex_client_maintenance set_cluster_name "{CLUSTER_NAME}"

set_cluster_secret/1

Use this command to set your new Marketplace secret to Kazoo Appex can connect to store.

  • If you did not initiated the process, login to 2600Hz Marketplace
  • Go to Manage Accounts -> Manage Cluster
  • Regenerate a new Cluster Secret and copy it
  • Use this command to set your new cluster secret:
sup appex_client_maintenance set_cluster_secret "{YOUR_NEW_CLUSTER_SECRET}"

Use this command to unlink your cluster from 2600Hz Marketplace.

Caution: This process cannot be undone, your purchased app(s) will be canceled.

On this page