To load data into Squirro, you need to set up a connection. This requires configuration options that are used by the various command-line tools, including the SDK, APIs, etc.
To connect to Squirro through the command line, you will require three pieces of information:
| Table of Contents |
|---|
Follow the steps in the guide below to obtain this information from your Squirro account.
Locate Your Cluster URL
Generally, the cluster url is structured as: https://<yourproject>.squirro.cloud
For detailed instructions on how to locate your cluster URL, follow the steps below:
1. Log in to http://start.squirro.com using your Squirro ID.
2. Click My Instances in the upper right-hand corner of the dashboard.
...
3. Select the instance you’d like to connect to, or create a new instance using the Plus Icon (
) in the upper right-hand corner of the dashboard.
...
4. Locate your instance in the list and copy the Endpoint URL. Your cluster URL is the same as the Endpoint URL listed next to the instance name.
🗒️ Example: In the screen capture below, the cluster URL for the demos instance is https://demos.squirro.cloud
...
Locate Your Project Identifier
To locate your project identifier, follow the steps below:
Log in to http://start.squirro.com using your Squirro ID.
Navigate to your desired project.
Navigate to Setup > Settings.
Click Properties from the left menu.
Copy your Project Identifier from the displayed information.
Generate an Authentication Token
1. Log in tohttp://start.squirro.com using your Squirro ID.
2. Click My Instances in the upper right-hand corner of the dashboard.
...
3. Click on the specific Instance you’d like to connect to.
4. After the instance loads, click on your initials (two letters within a circle) in the upper-right hand corner menu bar of the dashboard.
...
5. Click My Account.
6. Click API Access from the menu on the left-hand side of the screen.
...
7. Click Generate under the User Token heading.
...
8. Copy the token and store it securely, you now have all the information you need to connect.
⚠️ Warning: Do not share your token, anyone with a copy of it can access your project. Treat it like a password!
🗒️ Note: If you need to change your token, simply navigate back to the API Access screen and click Renew to generate a new token. (Your previously-generated token will no longer work, and will need to be updated anywhere it is currently in use.)
...
This page can now be found at Connecting to Squirro on the Squirro Docs site.