Getting Started with Mist API

Introduction

Version: 2604.1.1

Date: May 13, 2026

NOTE:
Some important API changes will be introduced. Please make sure to read the announcements

Additional Documentation

Helpful Resources

Mist Web Browser Extension:

Install the Package

Install the gem from the command line:

gem install juniper-mist-sdk -v 0.0.1

Or add the gem to your Gemfile and run bundle:

gem 'juniper-mist-sdk', '0.0.1'

For additional gem details, see the RubyGems page for the juniper-mist-sdk gem.

IRB Console Usage

You can explore the SDK interactively using IRB in two ways

1. Use IRB with Installed Gem

Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.

irb

Now you can load the SDK in the IRB

require 'mist_api'
include MistApi

2. Use IRB within SDK

Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.

cd path/to/mist_api

Now you can start the preconfigured irb console by running the following command

ruby bin/console

Note: This automatically loads the SDK from lib/

Test the SDK

To run the tests, navigate to the root directory of the SDK in your terminal and execute the following command:

rake

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
accept String Default: 'application/json, application/vnd.api+json'
environment Environment The API environment.
Default: Environment.MIST_GLOBAL_01
connection Faraday::Connection The Faraday connection object passed by the SDK user for making requests
adapter Faraday::Adapter The Faraday adapter object passed by the SDK user for performing http requests
timeout Float The value to use for connection timeout.
Default: 60
max_retries Integer The number of times to retry an endpoint call if it fails.
Default: 0
retry_interval Float Pause in seconds between retries.
Default: 1
backoff_factor Float The amount to multiply each successive retry's interval amount by in order to provide backoff.
Default: 2
retry_statuses Array A list of HTTP statuses to retry.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array A list of HTTP methods to retry.
Default: %i[get put]
http_callback HttpCallBack The Http CallBack allows defining callables for pre and post API calls.
proxy_settings ProxySettings Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration LoggingConfiguration The SDK logging configuration for API calls
api_token_credentials ApiTokenCredentials The credential object for Custom Header Signature
basic_auth_credentials BasicAuthCredentials The credential object for Basic Authentication
csrf_token_credentials CsrfTokenCredentials The credential object for Custom Header Signature

The API client can be initialized as follows:

Code-Based Client Initialization

require 'mist_api'
include MistApi

client = Client.new(
  accept: 'application/json, application/vnd.api+json',
  api_token_credentials: ApiTokenCredentials.new(
    authorization: 'Authorization'
  ),
  basic_auth_credentials: BasicAuthCredentials.new(
    username: 'Username',
    password: 'Password'
  ),
  csrf_token_credentials: CsrfTokenCredentials.new(
    x_csrf_token: 'X-CSRFToken'
  ),
  environment: Environment::MIST_GLOBAL_01,
  logging_configuration: LoggingConfiguration.new(
    log_level: Logger::INFO,
    request_logging_config: RequestLoggingConfiguration.new(
      log_body: true
    ),
    response_logging_config: ResponseLoggingConfiguration.new(
      log_headers: true
    )
  )
)

Environment-Based Client Initialization

require 'mist_api'
include MistApi

# Create client from environment
client = Client.from_env

See the Environment-Based Client Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name Description
MIST_GLOBAL_01 Default
MIST_GLOBAL_02 -
MIST_GLOBAL_03 -
MIST_GLOBAL_04 -
MIST_GLOBAL_05 -
MIST_EMEA_01 -
MIST_EMEA_02 -
MIST_EMEA_03 -
MIST_EMEA_04 -
MIST_APAC_01 -
MIST_APAC_02 -
MIST_APAC_03 -

Authorization

This API uses the following authentication schemes.

List of APIs

Webhooks

SDK Infrastructure

Configuration

HTTP

Utilities