Yandex.Cloud
  • Services
  • Why Yandex.Cloud
  • Pricing
  • Documentation
  • Contact us
Get started
Yandex API Gateway
  • Getting started
  • Step-by-step instructions
    • All instructions
    • Creating API gateways
    • Updating API gateways and their specifications
    • Connecting a domain
    • Deleting API gateways
    • Viewing monitoring charts
    • Viewing the execution log
  • Concepts
    • Relationship between service resources
    • Specification extensions
      • Overview
      • Static response
      • Invoking a function
      • Access via HTTP
      • Integration with Object Storage
    • Quotas and limits
  • Access management
  • Pricing policy
  • API reference
    • Authentication in the API
    • gRPC
      • Overview
      • ApiGatewayService
      • OperationService
    • REST
      • Overview
      • ApiGateway
        • Overview
        • create
        • delete
        • get
        • getOpenapiSpec
        • list
        • listAccessBindings
        • listOperations
        • setAccessBindings
        • update
        • updateAccessBindings
  • Questions and answers
  1. Concepts
  2. Specification extensions
  3. Access via HTTP

x-yc-apigateway-integration:http extension

  • Supported parameters
  • Extension specification

The x-yc-apigateway-integration:http extension redirects a request to the specified URL. The request is sent in the form it was received in from the client.

Supported parameters

The table below lists the parameters specific to API Gateway API gateways. Read more about other parameters in the OpenAPI Specification 3.0.

Parameter Type Description
url string URL to redirect the invocation to (must be accessible from the internet).
Parameters are substituted in url.
method enum Optional parameter. HTTP method used for the invocation. If the parameter is omitted, it defaults to the method of request to API Gateway.
headers map[string]string HTTP headers to be passed in addition to the original request headers.
Parameters are substituted in headers.
timeouts object Optional parameter. The read and connect invocation timeouts, in seconds.

Extension specification

Sample specification:

x-yc-apigateway-integration:
  type: http
  url: https://example.com/backend1
  method: POST
  headers:
    Authorization: Basic ZjTqBB3f$IF9gdYAGlMrs2fuINjHsz
  timeouts:
    connect: 0.5
    read: 5

Extension specifics:

  • By default, the original request headers are not passed, but this can be done through parameter substitution. In this case, you should provide the default parameter header.
In this article:
  • Supported parameters
  • Extension specification
Language
Careers
Privacy policy
Terms of use
© 2021 Yandex.Cloud LLC