Get started
Yandex API Gateway

Method get

Written by

Returns the specified API gateway. Note that only API gateway basic attributes are returned.
To get associated openapi specification, make a getOpenapiSpec request.

To get the list of all available API gateways, make a list request.

HTTP request

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

Path parameters

Parameter Description
apiGatewayId Required. ID of the API gateway to return. To get a API gateway ID make a list request.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "status": "string",
  "domain": "string",
  "logGroupId": "string",
  "attachedDomains": [
    {
      "domainId": "string",
      "certificateId": "string",
      "enabled": true,
      "domain": "string"
    }
  ]
}
Field Description
id string

ID of the API gateway. Generated at creation time.
folderId string

ID of the folder that the API gateway belongs to.
createdAt string (date-time)

Creation timestamp for the API-gateway.

String in RFC3339 text format.
name string

Name of the API gateway. The name is unique within the folder.
description string

Description of the API gateway.
labels object

API gateway labels as key:value pairs.
status string

Status of the API gateway.

  • CREATING: API gateway is being created.
  • ACTIVE: API gateway is ready for use.
  • DELETING: API gateway is being deleted.
  • ERROR: API gateway failed. The only allowed action is delete.
  • UPDATING: API gateway is being updated.
domain string

Default domain for the API gateway. Generated at creation time.
logGroupId string

ID of the log group for the API gateway.
attachedDomains[] object

List of domains attached to API gateway.
attachedDomains[].
domainId		 string

ID of the domain.
attachedDomains[].
certificateId		 string

ID of the domain certificate.
attachedDomains[].
enabled		 boolean (boolean)

Enabling flag.
attachedDomains[].
domain		 string

Name of the domain.
In this article: