Synadia Control Plane

CLI Setup

The syn-cp CLI uses a personal access token to authenticate with Control Plane's API and provides functionality not exposed via the UI.

Download the CLI

Download the latest version of the CLI from Github.

Generate a Personal Access Token

Personal access tokens are generated in your Profile under the Personal Access Token tab. They take the form of:

uat_vHVOMYLvwoAzJziEYzlxUeuvvKFDYlNSAbjBYdhCiZancDkKGILvlKrDUSPQljOo

Configure the CLI

syn-cp requires Control Plane's API address and personal access token be provide for every command.

  • Server

Use the --server flag or set the SCP_SERVER environment variable:

export SCP_SERVER=http://127.0.0.1:8080
  • Personal Access token

Use the --token flag or set the SCP_TOKEN environment variable:

export SCP_TOKEN=uat_vHVOMYLvwoAzJziEYzlxUeuvvKFDYlNSAbjBYd...
Previous
CLI