{"id":31816735,"url":"https://github.com/splunk/splunk-cloud-sdk-js","last_synced_at":"2025-10-11T09:58:02.451Z","repository":{"id":35447255,"uuid":"127044810","full_name":"splunk/splunk-cloud-sdk-js","owner":"splunk","description":"The Splunk Cloud SDK for JavaScript, contains libraries for building apps for the Splunk Cloud Services Platform.","archived":false,"fork":false,"pushed_at":"2023-04-01T12:07:41.000Z","size":3711,"stargazers_count":11,"open_issues_count":19,"forks_count":5,"subscribers_count":33,"default_branch":"master","last_synced_at":"2024-04-15T02:58:42.064Z","etag":null,"topics":["javascript","js","sdk","splunk-cloud","typescript"],"latest_commit_sha":null,"homepage":"https://dev.splunk.com/scs/docs","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/splunk.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null}},"created_at":"2018-03-27T20:54:53.000Z","updated_at":"2022-01-26T00:04:14.000Z","dependencies_parsed_at":"2023-01-15T21:31:28.449Z","dependency_job_id":null,"html_url":"https://github.com/splunk/splunk-cloud-sdk-js","commit_stats":null,"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"purl":"pkg:github/splunk/splunk-cloud-sdk-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fsplunk-cloud-sdk-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fsplunk-cloud-sdk-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fsplunk-cloud-sdk-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fsplunk-cloud-sdk-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/splunk","download_url":"https://codeload.github.com/splunk/splunk-cloud-sdk-js/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fsplunk-cloud-sdk-js/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279006749,"owners_count":26084185,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-11T02:00:06.511Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","js","sdk","splunk-cloud","typescript"],"created_at":"2025-10-11T09:57:56.846Z","updated_at":"2025-10-11T09:58:02.443Z","avatar_url":"https://github.com/splunk.png","language":"TypeScript","readme":"# Splunk Cloud Services SDK for JavaScript\n\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\n\nThe Splunk Cloud Services software development kit (SDK) for JavaScript contains library code and examples to enable you to build apps using the Splunk Cloud Services services with the JavaScript programming language.\n\n## Terms of Service (TOS)\n[Splunk Cloud Services Terms of Service](https://auth.scp.splunk.com/tos)\n\nLog in to [Splunk Investigate](https://si.scp.splunk.com/) and accept the Terms of Service when prompted.\n\n## Get started\n\n### Install the SDK\n\nInstall the SDK to enable your app project to interact with Splunk Cloud Services services.\n\nRun the following command from your project directory:\n\n```sh\nnpm install @splunkdev/cloud-sdk\n```\n\n### Example usage\n\nThis example shows how to use one service client to access all supported services:\n\n```js\nrequire('isomorphic-fetch'); // or a fetch polyfill of your choosing\n\nconst { SplunkCloud } = require('@splunkdev/cloud-sdk');\n\nconst svc = new SplunkCloud({ tokenSource: AUTH_TOKEN, defaultTenant: TENANT });\n\n// Retrieve the datasets for this tenant from the Catalog service\nsvc.catalog.getDatasets();\n\n// Run a search on the \"main\" index\nsvc.search.createJob({ \"query\": \"| from index:main | head 5\" });\n\n...\n\n```\n\nIf your app needs to work with one specific service, use a specific client for only the required service as follows:\n\n```javascript\nrequire('isomorphic-fetch'); // or a fetch polyfill of your choosing\n\nconst { IdentityService } = require('@splunkdev/cloud-sdk/services/identity');\n\nconst ENDPOINT_URL = \"https://api.scp.splunk.com\";\n\nconst identity = new IdentityService(ENDPOINT_URL, AUTH_TOKEN, TENANT);\n\n// Get the user profile from the Identity API\nidentity.getPrincipal(PRINCIPAL_NAME);\n\n...\n\n```\n\n## Documentation\nFor general documentation, see the [Splunk Developer Portal](https://dev.splunk.com/scs/).\n\nFor reference documentation, see the [Splunk Cloud Services SDK for JavaScript API Reference](https://dev.splunk.com/scs/reference/sdk/splunk-cloud-sdk-js).\n\n## Contributing\n\nA detailed quickstart guide for setting up a development environment and contributing to this project [can be found here](https://github.com/splunk/splunk-cloud-sdk-js/wiki/Development).\n\nDo not directly edit any source file in the `/src/generated` directory because these files were generated from service specifications.\n\n## Contact\nIf you have questions, reach out to us on [Slack](https://splunkdevplatform.slack.com) in the **#sdc** channel or email us at _devinfo@splunk.com_.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsplunk%2Fsplunk-cloud-sdk-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsplunk%2Fsplunk-cloud-sdk-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsplunk%2Fsplunk-cloud-sdk-js/lists"}