Yandex Cloud
Documentation
PresentationContact UsTry it for free
© 2026 Direct Cursus Technology L.L.C.
Yandex API Gateway
  • Getting started
    • Resource relationships
    • Networking
      • Overview
      • Greedy parameters
      • Generic HTTP method
      • Authorization using a Cloud Functions function
      • Authorization using a JWT
      • WebSocket protocol support
      • Data validation
      • CORS
      • Specification parameterization
      • Canary release
      • Request rate limit
      • Response code replacement
      • Transformation of response and request bodies
    • Quotas and limits
  • Access management
  • Tools
  • Pricing policy
  • Terraform reference
  • Monitoring metrics
  • Audit Trails events
  • Public materials
  • Release notes
  • FAQ

In this article:

  • Usage
  • Use cases
  1. Concepts
  2. Specification extensions
  3. Canary release

Canary release

Written by
Yandex Cloud
Updated at April 18, 2025
View in Markdown
  • Usage
  • Use cases

Canary release is a way to roll out and deploy a new software version for testing purposes. While testing, the current version remains active and the new one is only used in a certain percentage of cases.

With an API gateway's canary release, incoming requests are randomly divided between the two versions as per the set percentage value. The canary release usually handles a small number of requests, while the current release, all the remaining ones. You can increase or decrease the percentage of requests to test the changes.

UsageUsage

To create a canary release, write an OpenAPI specification using one or more variables (see Specification parameterization), and then create or update an API gateway. Specify the following:

  • Specification with variables.
  • Variable values for the canary release.
  • Percentage of requests to process by the canary release.

If the canary release handles a request, a response returned by API Gateway will contain an additional header, x-yc-apigateway-release, set to canary.

Use casesUse cases

  • Canary release of a Cloud Functions function

Was the article helpful?

Previous
Specification parameterization
Next
Request rate limit
© 2026 Direct Cursus Technology L.L.C.