Skip to main content

Ionburst Cloud SDKs

Develop and deploy applications with the Ionburst Cloud SDK

SDKs are currently available for the Ionburst Cloud API in the following languages:

.NET

The Ionburst SDK for .NET/.NET Core is available now on NuGeT.

Repository

The source code for the Ionburst .NET/.NET Core SDK is available here.

NuGeT

Ionburst.SDK

Node.js

The Ionburst SDK for Node.js is available now on npm.

Repository

The source code for the Ionburst Node.js SDK is available here.

NPM

ionburst-sdk-javascript

Python

The Ionburst SDK for Python is available now on PyPI (pip).

Repository

The source code for the Ionburst Python SDK is available here.

PyPi

ionburst-sdk-python

Go

The Ionburst SDK for Go is available now as a Go module.

Repository

The source code for the Ionburst Go SDK is available here.

pkg.go.dev

ionburst-sdk-go

Configuration

The Ionburst SDKs can be configured using two main methods:

  • Environment variables
  • Credentials file

This list should be taken as the order of precedence.

Environment Variables

If the credentials file is not used, then environment variables can be used:

  • Ionburst API ID: IONBURST_ID
  • Ionburst API Key: IONBURST_KEY
export IONBURST_ID=IB******************
export IONBURST_KEY=eW91aGF2ZXRvb211Y2h0aW1lb255b3VyaGFuZHMh

Credentials File

The Ionburst credentials file is stored within a well-known directory in the user's home folder.

  • MacOS/Linux: ~/.ionburst/credentials
  • Windows: %USERPROFILE%\.ionburst\credentials

The credentials file is INI formatted, and allows multiple sets of credentials to be used:

[example_profile]
ionburst_id=IB******************
ionburst_key=eW91aGF2ZXRvb211Y2h0aW1lb255b3VyaGFuZHMh
[example_profile2]
ionburst_id=IB******************
ionburst_key=c2VyaW91c2x5Li4uZ29vdXRzaWRlYW5kcGxheSEK
ionburst_uri=https://api.example.ionburst.cloud/

Further Configuration

Further configuration of the Ionburst SDK can be specified in a configuration file, placed in the root of the project.