Splunk Cloud Services CLI
Splunk Cloud Services CLI, scloud, is a command-line tool for developers to make API calls to Splunk Cloud Services. The Splunk Cloud Services CLI uses the Splunk Cloud Services SDK for Go for many API calls and is a great way to explore the available functionality.
Terms of Service (TOS)
Log in to Splunk Investigate and accept the Terms of Service when prompted.
Download from GitHub
-
Download the Splunk Cloud Services CLI package for your operating system from the /releases directory in this repository.
-
Extract the package file to a home directory on your computer.
For example:
-
On *nix, extract the .tar.gz file to a directory such as /usr/local/bin.
-
On Windows, unzip the package to a directory such as C:\scloud. Consider adding this location to the PATH system variable.
-
Accept the Terms of Service by logging in to Splunk Investigate.
Install from Homebrew (macOS, Linux)
If you have Homebrew installed, install the Splunk Cloud Services CLI by doing the following:
-
Register the Splunk Homebrew Tap. At the command line, enter:
brew tap splunk/tap
-
Install the Splunk Cloud Services CLI package:
brew install scloud
-
Accept the Terms of Service by logging in to Splunk Investigate.
Run Splunk Cloud Services CLI
To access the Splunk Cloud Services CLI, you need:
- A user account with Splunk Cloud Services
- A shell prompt, command prompt, or PowerShell session
Then, use scloud <command> at the command line to perform almost any operation in Splunk Cloud Services.
Here are some commands to get started:
| To... |
Enter: |
| Get help for all commands |
scloud help |
| Get help for a specific command |
scloud <commandname> help |
| Log in |
scloud -u <username> login |
| Save your user name in settings |
scloud set username <username> |
| Save a tenant name in settings |
scloud set tenant <tenantname> |
| Display saved settings |
scloud get-settings |
| List your tenants |
scloud provisioner list-tenants |
Documentation
For more about using scloud, see Splunk Cloud Services CLI on the Splunk Developer Portal.
If you have questions, reach out to us on Slack in the #sdc channel or email us at devinfo@splunk.com.