IBM Cloud Platform Services Node.js SDK

Node.js client library to interact with various IBM Cloud Platform Service APIs.

Disclaimer: this SDK is being released initially as a pre-release version. Changes might occur which impact applications that use this SDK.

Table of Contents

• Overview
• Prerequisites
• Installation
• Using the SDK
• Questions
• Issues
• Open source @ IBM
• Contributing
• License

Overview

The IBM Cloud Platform Services Node.js SDK allows developers to programmatically interact with the following IBM Cloud services:

Service Name	Import Path
Case Management	ibm-platform-services/case-management/v1
Catalog Management	ibm-platform-services/catalog-management/v1
Configuration Governance	ibm-platform-services/configuration-governance/v1
Enterprise Billing Units	ibm-platform-services/enterprise-billing-units/v1
Enterprise Management	ibm-platform-services/enterprise-management/v1
Enterprise Usage Reports	ibm-platform-services/enterprise-usage-reports/v1
Global Catalog	ibm-platform-services/global-catalog/v1
Global Search	ibm-platform-services/global-search/v2
Global Tagging	ibm-platform-services/global-tagging/v1
IAM Access Groups	ibm-platform-services/iam-access-groups/v2
IAM Identity Service	ibm-platform-services/iam-identity/v1
IAM Policy Management	ibm-platform-services/iam-policy-management/v1
Open Service Broker	ibm-platform-services/open-service-broker/v1
Resource Controller	ibm-platform-services/resource-controller/v2
Resource Manager	ibm-platform-services/resource-manager/v2
Usage Metering	ibm-platform-services/usage-metering/v4
Usage Reports	ibm-platform-services/usage-reports/v4
User Management	ibm-platform-services/user-management/v1

Prerequisites

• You need an IBM Cloud account.
• Node.js >=10: This SDK is tested with Node.js versions 10 and up. It may work on previous versions but this is not officially supported.

Installation

npm install ibm-platform-services

Using the SDK

For general SDK usage information, please see this link

Questions

If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question at Stack Overflow.

Issues

If you encounter an issue with the SDK, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible someone has already encountered this issue.

Open source @ IBM

Find more open source projects on the IBM Github Page

Contributing

See CONTRIBUTING.

License

The IBM Cloud Platform Services Node.js SDK is released under the Apache 2.0 license. The license's full text can be found in LICENSE.