Contact Us
Help Center Home > APIs > What’s New – API Docs and Operation ID Migration

What’s New – API Docs and Operation ID Migration

Note:

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.

We will notify you via official channels before the new page goes live.

Here is a video summarizing the upcoming changes:

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.

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 will be published here:
  • 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-tagGroups attribute from the API specifications. You won’t see duplicate endpoints/operations in the documentation.

See FAQs: New API Docs and Operation ID Migration to learn more.

Back to Top

List IconIn this Article

Notebook IconLearn More

FAQs: New API Docs and Operation ID Migration

Migrating to Standardized OpenAPI Operation IDs

Still Have Questions?

If you cannot find an answer to your question in our FAQ, you can always contact us.

Submit a Case