Updates on API Versioning Standards & Deprecation Timelines

Early this year, we introduced API versioning standards for several product lines, including VMDR, Policy Audit, Custom Remediation & Assessment (CAR), and others. API Versioning is an industry standard followed by most organizations. The purpose of the versioning standards is to give our customers full visibility and provide additional timelines for upgrading their existing integrations.

As part of this initiative, we are beginning the process of retiring older API versions. To ensure uninterrupted access and take advantage of the latest features and security enhancements, we strongly encourage you to migrate your integrations to the latest API versions as soon as possible. Transitioning now will give you the necessary time to test, adapt, and fully leverage the capabilities outlined in our versioning standards before earlier versions are deprecated.

Advantages of the API Versioning Standards

The API Endpoints for each of the Qualys Product lines serve as a critical component for any of your integrations (native, home-grown, or standard integration tools).

• Extended Testing Window: More than 30 days are provided for API testing and integration.
• Dual API Access: Simultaneous access to old and new API versions to support seamless transition and minimize risk.
• Enhanced Agility: Streamlined versioning and clear EOS frameworks enable faster API updates and quicker response to the evolving needs.
• This will benefit Security teams and resolver owners to act upon swiftly, tackling upcoming threats.

Deprecation Strategies for Earlier API Endpoints

As part of these strategies, we are coming up with End of Support (EOS) and End of Life (EOL) policies for the earlier released APIs, and you will observe this for all earlier and upcoming new endpoints.

EOS and EOL timelines:

For API endpoints supporting versioning standards, customers get an overall 12 months to shift to the latest versions.

• End of Support (EOS): Six months after the latest deployment for your respective POD. During this EOS period, new enhancements will not be supported. Any identified bugs will be addressed in the older version. In the API response output, you will notice the EOS timelines for the respective endpoint.
• End of Life (EOL): An Additional six months’ lead time starting from the EOS timelines is available to switch to the latest versions. During this EOL period, new enhancements will not be supported, and bugs will be addressed in the latest versions. After this lead time, the API endpoint will be decommissioned after 3 months. In the API response output, you will notice the past due of EOS and the EOL timelines for the respective endpoint.

When can you expect this?

These changes will be rolled out by mid-October 2025. The API documentation for the existing API Docs will be updated with these timelines, capturing the changes introduced in the latest API versioning standards. The same changes will be observed in the API release notes.

List of Product Lines and respective API Endpoints with EOS & EOL

Here is the list of product offerings with the respective API endpoints that are targeted for the EOS and EOL.

For further information, detailed guidance, or to start testing the new API versions, please visit our documentation page.

We understand you may have questions or require further clarification on how these changes could impact your existing systems. Our Support team is fully prepared to provide you with the personalized support necessary for a smooth transition. Connect with us here.