Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Juniper Mist AI Orgs Licenses API

Licenses are a type of service or access that customers can purchase for various features or services offered by a company.Subscriptions can have different statuses, such as active, expired, exceeded, or trial, depending on their validity and usage. The status of a subscription determines whether it is currently active and valid, has expired, has exceeded the allowed usage limit, or is in a trial period.Licenses can be activated using an activation code, and the activation process confirms the inputted code and activates the subscription.

Juniper Mist AI Orgs Licenses API is one of 211 APIs that Juniper Mist AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Orgs Licenses. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 4 paths, and defines 44 schemas. It is described by OpenAPI 3.1.0, at version 2604.1.1.

Requests are made against 12 base URLs: https://api.mist.com, https://api.gc1.mist.com, https://api.ac2.mist.com, https://api.gc2.mist.com, https://api.gc4.mist.com, https://api.eu.mist.com, https://api.gc3.mist.com, https://api.ac6.mist.com, https://api.gc6.mist.com, https://api.ac5.mist.com, https://api.gc5.mist.com, https://api.gc7.mist.com.

5 operations 4 paths 44 schemas 3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2604.1.1
Base URL
https://api.mist.com/api/v1
Authentication
API Key, HTTP Basic, API Key
License
Resource Areas
1

Authentication & Security 3

Juniper Mist AI Orgs Licenses API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiToken). It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as X-CSRFToken (csrfToken). By default, every request must be authenticated.

  • apiToken — Like many other API providers, it’s also possible to generate API Tokens to be used (in HTTP Header) for authentication. An API token ties to a Admin with equa…
  • basicAuth — While our current UI uses Session / Cookie-based authentication, it’s also possible to do Basic Auth.
  • csrfToken — This protects the website against [Cross Site Request Forgery](https://en.wikipedia.org/wiki/Cross-siterequestforgery), all the POST / PUT / DELETE APIs needs…

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Orgs Licenses 5

Licenses are a type of service or access that customers can purchase for various features or services offered by a company. Subscriptions can have different statuses, such as acti…

POST
/api/v1/orgs/{org_id}/claim
claimOrgLicense
claimOrgLicense 1 param body → 200400401403404429
GET
/api/v1/orgs/{org_id}/claim/status
GetOrgLicenseAsyncClaimStatus
GetOrgLicenseAsyncClaimStatus 2 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/licenses
getOrgLicensesSummary
getOrgLicensesSummary 1 param → 200400401403404429
PUT
/api/v1/orgs/{org_id}/licenses
moveOrDeleteOrgLicenseToAnotherOrg
moveOrDeleteOrgLicenseToAnotherOrg 1 param body → 200400401403404429
GET
/api/v1/orgs/{org_id}/licenses/usages
getOrgLicensesBySite
getOrgLicensesBySite 1 param → 200400401403404429

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are license_sub (11 properties), response_async_license (10 properties), license_amendment (8 properties), license (6 properties). Each schema is shown below with its type and property counts.

id
string
Unique ID of the object instance in the Mist Organization
response_claim_license_inventory_pending
array
for async claim
licenses
array
license_amendment
object
8 properties
response_http403
object
1 property
response_async_license
object
10 properties
response_claim_license_inventory_duplicated
array
license
object
License
6 properties
response_claim_license_license_added
array
response_claim_license
object
6 properties 5 required
site_id
string
response_claim_license_inventory_pending_item
object
1 property
usage_org_licenses
array
license_type
string
Type of license. The list of supported license type can be retrieve with the [List License Type](/operations/listLicenseTypes) API request.
response_async_license_completed
array
response_http404
object
1 property
license_usage_org
object
6 properties 3 required
timestamp
number
Epoch (seconds)
license_fully_loaded
object
Maximum number of licenses that may be required if the service is enabled on all the Organization Devices. Property key is the service name (e.g. "SUB-MAN").
org_license_action_operation
string
to move a license, use the amend operation. enum: amend, annotate, delete, unamend
response_claim_license_license_error
array
response_http400
object
1 property
response_async_license_details
array
device_type_default_ap
string
enum: ap, gateway, switch
org_license_action
object
6 properties 1 required
response_claim_license_inventory_item
object
5 properties 5 required
response_async_license_detail
object
detail claim status per device
3 properties
claim_activation
object
4 properties 2 required
response_http429
object
1 property
claim_type
string
what to claim. enum: all, inventory, license
license_summary
object
Number of licenses currently consumed. Property key is license type (e.g. SUB-MAN).
response_claim_license_license_duplicated
array
response_claim_license_license_item
object
4 properties 4 required
license_amendments
array
license_sub
object
11 properties
response_claim_license_license_error_item
object
2 properties 2 required
response_async_license_incompleted
array
Current incompleted lists (macs)
license_usages
object
Number of available licenes. Property key is the service name (e.g. "SUB-MAN"). name (e.g. "SUB-MAN")
response_async_license_status
string
processing status of async. enum: prepared, ongoing, done
response_http401
object
1 property
response_claim_license_inventory_added
array
org_id
string
modified_time
number
When the object has been modified for the last time, in epoch
created_time
number
When the object has been created, in epoch

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-ai-orgs-licenses-api-openapi.yml Raw ↑

Other APIs Juniper Mist AI publishes across the network.

Juniper Mist WebSocket Streaming API
Juniper Mist Webhooks API
Juniper Mist AI Admins API
Juniper Mist AI Admins Login API
Juniper Mist AI Admins Login - OAuth2 API
Juniper Mist AI Admins Logout API
Juniper Mist AI Admins Lookup API
Juniper Mist AI Admins Recover Password API
Juniper Mist AI Constants Definitions API
Juniper Mist AI Constants Events API
Juniper Mist AI Constants Models API
Juniper Mist AI Installer API