Yandex.Cloud
  • Services
  • Why Yandex.Cloud
  • Solutions
  • 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. API reference
  2. REST
  3. ApiGateway
  4. getOpenapiSpec

Method getOpenapiSpec

  • HTTP request
  • Path parameters
  • Query parameters
  • Response

Returns the OpenAPI specification of specified API gateway.

HTTP request

GET https://serverless-apigateway.api.cloud.yandex.net/apigateways/v1/apigateways/{apiGatewayId}:spec

Path parameters

Parameter Description
apiGatewayId Required. ID of the API gateway to get specification from.

Query parameters

Parameter Description
format Format of returned specification. Default is the original format used in CreateApiGatewayRequest.

Response

HTTP Code: 200 - OK

{
  "apiGatewayId": "string",
  "openapiSpec": "string"
}
Field Description
apiGatewayId string

ID of the API gateway.

openapiSpec string

The text of specification, JSON or YAML.

In this article:
  • HTTP request
  • Path parameters
  • Query parameters
  • Response
Language / Region
Careers
Privacy policy
Terms of use
Brandbook
© 2021 Yandex.Cloud LLC