michaeljamesparsons / splunk-cloud-sdk-js

The Splunk Cloud SDK for JavaScript, contains libraries for building apps for the Splunk Cloud Platform.

Splunk Cloud SDK for JavaScript

The Splunk Cloud software development kit (SDK) for JavaScript contains library code and examples to enable you to build apps using the Splunk Cloud services with the JavaScript programming language.

To use the Splunk Cloud SDKs, you must be included in the Splunk Investigates Beta Program. Sign up here: https://si.scp.splunk.com/.

Terms of Service (TOS)

Log in to Splunk Investigate and accept the Terms of Service when prompted.

Get started

Install the SDK

Install the SDK to enable your app project to interact with Splunk Cloud services.

Run the following command from your project directory:

npm install @splunkdev/cloud-sdk

Example usage

This example shows how to use one service client to access all supported services:

require('isomorphic-fetch'); // or a fetch polyfill of your choosing

const { SplunkCloud } = require('@splunkdev/cloud-sdk');

const svc = new SplunkCloud({ tokenSource: AUTH_TOKEN, defaultTenant: TENANT });

// Retrieve the datasets for this tenant from the Catalog service
svc.catalog.getDatasets();

// Run a search on the "main" index
svc.search.createJob({ "query": "| from index:main | head 5" });

...

If your app needs to work with one specific service, use a specific client for only the required service as follows:

require('isomorphic-fetch'); // or a fetch polyfill of your choosing

const { IdentityService } = require('@splunkdev/cloud-sdk/services/identity');

const ENDPOINT_URL = "https://api.scp.splunk.com";

const identity = new IdentityService(ENDPOINT_URL, AUTH_TOKEN, TENANT);

// Get the user profile from the Identity API
identity.getPrincipal(PRINCIPAL_NAME);

...

Documentation

For general documentation, see the Splunk Developer Cloud Portal.

For reference documentation, see the Splunk Cloud SDK for JavaScript API Reference.

Contributing

Do not directly edit any source file in the /src/generated directory because these files were generated from service specifications.

Contact

If you have questions, reach out to us on Slack in the #sdc channel or email us at [email protected].