Migration of Orchestrator API to OpenAPI 3.0 and deprecation/removal of old specification V20 (Swagger 2.0)

Japan Knowledge Base
1

■Overview

The default API specification of Orchestrator has been updated to comply with OpenAPI 3.0. The old specification V20 (based on Swagger 2.0) is deprecated and will be removed after a limited period provided for backward compatibility.

The removal of V20 means the discontinuation of providing the Swagger definition (JSON) for V20, but it does not mean that existing Orchestrator API endpoints will be uniformly deleted because of V20’s removal.

■Deprecation and Removal Timeline

  • Automation Cloud: Deprecated in August 2026 and removed in September 2026
  • Automation Suite: Deprecated and removed in the 2.2610 release

■Check and Switch API Definition

Swagger UI can be accessed at the following URL:

You can switch the API definition to reference in the top right of the screen by selecting “Select a definition.”

1024×174 35.3 KB

In Automation Cloud, you can choose between two options:

■Impact

  • There is basically no impact on existing APIs or API clients that were generated in the past.
  • The URL for V20’s Swagger.json is expected to be deprecated, and any processes referring to it directly will be affected.

■Necessary Actions

  • Please change any references to the URL for V20’s Swagger.json to the URL for OpenAPI 3.0’s Swagger.json.

■Action Deadline

  • Automation Cloud: Until the removal of the V20 definition in September 2026
  • Automation Suite: Until the upgrade to the 2.2610 release.
2

Hi @system

Thanks for sharing this update. This is an important change for anyone using the Orchestrator API.

For existing integrations, the main action is to check whether any application, script, Postman collection, custom integration, or process is directly referencing the V20 swagger.json URL.

If so, it should be updated to the OpenAPI 3.0 public.json definition before the V20 definition is removed in September 2026.

It is also good to note that this change does not mean the existing Orchestrator API endpoints are being removed. The primary impact is the removal of the old V20 Swagger 2.0 specification.

For teams using API clients generated from the old Swagger definition, I would recommend reviewing and testing those integrations against the OpenAPI 3.0 definition well before the deadline.

Thanks for the clarification and timeline.