What is an API channel?

An API channel is how Octoblu talks to your favorite APIs. Within your app.octoblu.com account you can setup and manage different APIs to be used within the Octoblu Flow Designer. This way you can easily drag and drop APIs and connect them together with other APIs or devices. The Octoblu UI then provides an intuitive drop-down of every endpoint in that API. No more crawling through docs and building out lengthy URI strings. Let us do the work for you!

Setting up a channel with Octoblu

  1. Log into app.octoblu.com (Or create an account if you haven't already - its free!)
  2. Click on "Things" on the side menu
  3. Select "Splunk" from the list of Things in the "Productivity" section
  4. When asked for a "domain" be sure to include just the IP or domain of your Splunk instance including the port required to access the api if necessary. The default is 8089. The api will also add https:// so you do not need to add that, however be aware that if you do not have HTTPS enabled on your instance the channel will not work.

Example

you enter: your.domain.com:8089
Octoblu will use: https://your.domain.com:8089

  1. You will next be asked for your Username and Password.
  2. After set-up is complete you will be taken to the designer, if your channel does not appear in the Things toolbox, do not panic - simply hit refresh.

Designing flows with example flows

Getting Started With Octoblu Tutorial Videos

Once you're within the Octoblu Designer and your Splunk channel has been configured, you can now use the entire Splunk API without having to do the heavy lifting. We'll outline the basics here and include some links to sample flows that you can import into your account.

  1. From the bottom right Things Toolbox in the designer, find your Splunk channel and drag it into the designer.
  2. Attach a trigger to the left-hand input of your Splunk channel and a debug node on the right-hand.
  3. Select the Splunk node and observe the Thing Inspector on the right hand side of the designer.
  4. The drop-down shown will provide you all the available endpoints for the Splunk API, to test - select List System Status Information
  5. This endpoint requires no fields - go ahead and hit "Deploy" - the play button in the top right.
  6. Once the flow successfully deploys, click the trigger and then observe the Debug panel (bottom right view window)
  7. This gives you a basic flow using Splunk

Example Flows

Intro Flow
Get and Parse Event Types and Check Specific Event Logs
Get Fired Alerts and Format a Message