API Migration

This guide helps users migrate their scripts between Squore REST API versions. Each API version may introduce new features, behavioral changes, deprecated functionality, or breaking changes that require updates to existing clients.

The following sections describe the differences between API versions and provide practical migration instructions, including updated endpoints, data model changes, compatibility considerations, and removed features.

We strongly recommend migrating to the latest supported API version whenever possible to benefit from the latest features, performance improvements, and ongoing support.

Supported API

The table below summarizes the availability of each REST API version across Squore releases and highlights their support status.

Version

v1

v2

v3

v4

26.0

❌

⚠️

⚠️

✅

25.0

⚠️

⚠️

✅

❌

24.0

⚠️

✅

❌

❌

23.0

⚠️

✅

❌

❌

22.0

✅

❌

❌

❌

21.0

✅

❌

❌

❌

Where:

  • ✅ Supported and recommended

  • ⚠️ Supported and deprecated (will be removed in future release)

  • ❌ Unsupported

The Version column refers to major Squore releases and includes all corresponding minor releases.

Migrate from v3 to v4

The following changes were introduced in API v4.

  • Removed

    • API v1.

    • Pagination.

    • Endpoints related to Action Items.

  • Updated

    • Trend computation is now disabled by default for certain API endpoints.

    • API version is now specified in the URL path instead of the Accept header.

    • Some DTO names have been renamed.

For detailed migration instructions, examples, and affected endpoints, see Migrate from v3 to v4

Migrate from v2 to v3

The following changes were introduced in API v3.

  • Removed

    • Synchronous calls are no longer supported for long-running Task Management API operations.

  • Updated

    • The term "artefact" has been replaced with "artifact.

    • A 200 status is returned with an empty array, rather than a 204.

    • Rule definitions have been removed from findings endpoints.

For detailed migration instructions, examples, and affected endpoints, see Migrate from v2 to v3

Migrate from v1 to v2

Looking for guidance about API v1? Start with the following recommendation.

The following changes were introduced in API v2.

  • Additions

    • Added support for selecting API versions using the Accept header.

  • Removed

    • Links and pagination information and restructured endpoints that return collections.

  • Updated

    • Changed date format for improved readability.

    • Simplified API paths by introducing default values and query parameters.

    • Renamed branchId field to mainId in project objects.

    • Changed the response status code from 200 to 201 after resource creation, in compliance with REST standards.

For detailed migration instructions, examples, and affected endpoints, see Migrate from v1 to v2