How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Mist 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.

Mist Orgs Licenses API is one of 212 APIs that Mist 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.

This API exposes 8 operations across 6 paths, and defines 49 schemas. It is described by OpenAPI 3.2.0, at version 2606.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.

8 operations 6 paths 49 schemas 5 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2606.1.1
Base URL
https://api.mist.com/api/v1
Authentication
API Key, API Key
License
Resource Areas
1

Authentication & Security 2

Mist Orgs Licenses API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiToken). An API key is passed in the header as X-CSRFToken (csrfToken). By default, every request must be authenticated.

  • apiToken — Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header. Format: Authorization: Token {apitoken} N…
  • csrfToken — Session-based authentication for browser or login/password flows. After a successful [Login](/operations/login) request, Mist returns a csrftoken cookie. Send…

Paths & Operations 8

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

Orgs Licenses 8

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}/claims
listOrgAsyncClaims
listOrgAsyncClaims 2 params → 200400401403404429
POST
/api/v1/orgs/{org_id}/claims
createOrgAsyncClaim
createOrgAsyncClaim 1 param body → 200400401403404429
GET
/api/v1/orgs/{org_id}/claims/{claim_id}
getOrgAsyncClaimStatus
getOrgAsyncClaimStatus 3 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 49

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

license_amendments
array
Read-only list of license amendments
response_claim_license_license_error
array
License claim errors returned by order number
response_http403
object
Standard HTTP 403 permission error response
1 property
response_async_license_details
array
Per-device asynchronous license claim status details
license_summary
object
Number of licenses currently consumed. Property key is license type (e.g. SUB-MAN).
org_id
string
Unique identifier of a Mist organization
licenses
array
License subscriptions for the organization
response_http400
object
Standard HTTP 400 bad request error response
1 property
license_usages
object
Number of available licenses. Property key is the service name (e.g. "SUB-MAN").
usage_org_licenses
array
Organization license usage records returned by a usage response
response_async_claim_create
object
Response to an async inventory claim request
2 properties
response_async_claim_status
object
Async inventory claim job status
12 properties
response_async_claims_list
object
List of async inventory claim jobs for the organization
1 property
response_claim_license_inventory_item
object
Inventory device returned by a license claim
5 properties 5 required
response_async_license_status
string
Processing state for an asynchronous license claim. enum: prepared, ongoing, done
claim_type
string
what to claim. enum: all, inventory, license
response_claim_license_license_added
array
License entitlements added by the claim operation
timestamp
number
Epoch timestamp, in seconds
response_async_license
object
Asynchronous license claim progress response
10 properties
response_claim_license_license_error_item
object
License order that could not be claimed
2 properties 2 required
modified_time
number
When the object has been modified for the last time, in epoch
org_license_action
object
Request to amend, annotate, delete, or unamend an organization license
6 properties 1 required
license_usage_org
object
License usage record for an organization usage scope
6 properties 3 required
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").
response_claim_license_inventory_duplicated
array
Inventory devices already present during the claim operation
response_async_license_detail
object
Per-device asynchronous license claim status
3 properties
response_http404
object
Standard HTTP 404 not found error response
1 property
license
object
Organization license entitlement, subscription, and usage summary
6 properties
response_http401
object
Standard HTTP 401 authentication error response
1 property
response_http429
object
Standard HTTP 429 rate limit error response
1 property
response_claim_license
object
Result of claiming licenses or activation codes
6 properties 5 required
response_claim_license_inventory_pending_item
object
Inventory device pending asynchronous claim processing
1 property
response_claim_license_inventory_pending
array
Inventory devices pending asynchronous claim processing
claim_activation_async
object
Request to schedule an asynchronous inventory claim
3 properties 2 required
id
string
Unique ID of the object instance in the Mist Organization
claim_activation
object
Request to claim organization licenses or activation codes
3 properties 2 required
response_async_license_incompleted
array
Device MAC addresses not yet completed in asynchronous license claim processing
site_id
string
Unique identifier of a Mist site
license_amendment
object
Read-only change applied to a license subscription
8 properties
created_time
number
When the object has been created, in epoch
org_license_action_operation
string
to move a license, use the amend operation. enum: amend, annotate, delete, unamend
response_claim_license_license_duplicated
array
License entitlements already present during the claim operation
response_claim_license_inventory_added
array
Inventory devices added by the claim operation
license_sub
object
Read-only license subscription record
11 properties
response_async_license_completed
array
Device MAC addresses that completed asynchronous license claim processing
claim_type_async
string
Claim scope for async inventory claiming. enum: all, inventory
response_claim_license_license_item
object
License entitlement returned by a claim operation
4 properties 4 required
license_type
string
Type of license. The list of supported license type can be retrieve with the [List License Type](/operations/listLicenseTypes) API request.
device_type_default_ap
string
enum: ap, gateway, switch

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Mist publishes across the network.

Mist Admins API
Mist Admins Login API
Mist Admins Login - OAuth2 API
Mist Admins Logout API
Mist Admins Lookup API
Mist Admins Recover Password API
Mist Constants Definitions API
Mist Constants Events API
Mist Constants Models API
Mist Installer API
Mist MSPs Admins API
Mist MSPs API
Where this information came from

This is an independent, third-party profile of Mist Orgs Licenses API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.