Important
This is a preview release. We are preparing to migrate our primary API reference resources to a newly designed page. Customers are requested to plan accordingly as we'll be deprecating the old page in future.
- Old page: docs.jumpcloud.com
- New page: docs.jumpcloud.com/new
We will notify you via official channels before the new page goes live.
New Unified API Pages#
We have simplified our API documentation. Instead of separating everything by version numbers onto different pages, we have combined them. For example, you can now find all Console endpoints (V1 and V2) on a single page (https://docs.jumpcloud.com/new). This keeps all related tools together so you don't have to jump back and forth between different links.
If you download OpenAPI specs directly (for example, in CI pipelines or client generators), the YAML URLs change when you switch to the new docs. Console API V1 and V2 are now a single combined spec. Directory Insights no longer uses a version segment in the path. Use the table below to update bookmarks and automation.
| Previous direct download URL | New direct download URL (during the preview) |
|---|---|
| https://docs.jumpcloud.com/api/1.0/index.yaml | https://docs.jumpcloud.com/new/console/index.yaml |
| https://docs.jumpcloud.com/api/2.0/index.yaml | https://docs.jumpcloud.com/new/console/index.yaml |
| https://docs.jumpcloud.com/api/insights/directory/1.0/index.yaml | https://docs.jumpcloud.com/new/api/insights/directory/index.yaml |
NOTE: Our legacy documentation (https://docs.jumpcloud.com) will continue to serve the older upstream IDs until the official final cutover date, giving your engineering teams ample time to test and adapt.
Standardized operationId Generation#
We’re updating the naming convention for operation IDs in our OpenAPI specs. The new format is: HTTP Method Host-Root Path.
- What’s changing: We are replacing older operation IDs (e.g.,
groups_system_list) with a new, standardized format (e.g.,getApiV2Systemgroups) in our new spec bundles. - How this affects you: If you generate API clients or SDKs using these operation IDs, your generated method names will change.
- Migration support: To help you migrate your downstream SDKs and software development lifecycles, our CI/CD pipeline now publishes a machine-readable sidecar mapping file alongside each aggregated documentation bundle. The mapping files are published here:
- JumpCloud Console APIs
- Directory Insights APIs
- These files list the old and new operation IDs alongside their method and path details to help you prepare for the change.
- We have removed the
x-tagGroupsattribute from the API specifications. You won’t see duplicate endpoints/operations in the documentation. - See the Migrating to standardized operation IDs article for more details on migration support.
When the new docs go live#
Today’s preview uses the /new path prefix. When we cut over to the redesigned docs as the primary experience:
- New docs (default): https://docs.jumpcloud.com/ — the
/newprefix goes away - Legacy docs: https://docs.jumpcloud.com/legacy/ — today’s docs pages move here for a transition period
Legacy versioned YAML files remain available under /legacy/ until we announce their retirement.