!npm

IBM Cloud Networking Node.js SDK

Node.js client library to interact with various IBM Cloud Networking 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 Networking Service Node.js SDK allows developers to programmatically interact with the following
IBM Cloud services:

Service Name | Import Path
--- | ---
Cloud Internet Service | ibm-networking-services/cis/{service-name}/v1
Direct Link | ibm-networking-services/direct-link/v1
Direct Link Provider | ibm-networking-services/direct-link-provider/v2
DNS Service | ibm-networking-services/dns-svcs/v1
Transit Gateway | ibm-networking-services/transit-gateway-apis/v1

Prerequisites

* You need an [IBM Cloud][ibm-cloud-onboarding] 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.

[ibm-cloud-onboarding]: http://cloud.ibm.com/registration

Installation

``sh
npm install ibm-networking-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

This project is released under the Apache 2.0 license.
The license's full text can be found in
LICENSE