Stopping and starting an API gateway
Once you have created an API gateway, you can stop it and start it again.
Stopping an API gateway
-
In the management console, navigate to the folder where you want to stop an API gateway.
-
Navigate to API Gateway.
-
In the API gateway row, click and select Stop.
The API gateway will switch to
Stopped.
If you do not have the Yandex Cloud CLI yet, install and initialize it.
The folder used by default is the one specified when creating the CLI profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also specify a different folder for any command using --folder-name or --folder-id.
If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.
-
See the description of the CLI command for stopping an API gateway:
yc serverless api-gateway stop --help -
Stop your API gateway:
yc serverless api-gateway stop <API_gateway_name_or_ID>Result:
id: d5daqt0ofc4t******** folder_id: b1g681qpemb4******** created_at: "2026-08-20T12:56:16.354Z" name: my-gateway status: STOPPED domain: d5daqt0ofc4t********.********.apigw.yandexcloud.net connectivity: {} log_options: disabled: true folder_id: b1g681qpemb4******** execution_timeout: 300s
To stop an API gateway, use the stop REST API method for the ApiGateway resource or the ApiGatewayService/Stop gRPC API call.
Starting an API gateway
-
In the management console, navigate to the folder where you want to start an API gateway.
-
Navigate to API Gateway.
-
In the API gateway row, click and select Start.
The API gateway will switch to
Active.
If you do not have the Yandex Cloud CLI yet, install and initialize it.
The folder used by default is the one specified when creating the CLI profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also specify a different folder for any command using --folder-name or --folder-id.
If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.
-
See the description of the CLI command for starting an API gateway:
yc serverless api-gateway resume --help -
Start your API gateway:
yc serverless api-gateway resume <API_gateway_name_or_ID>Result:
id: d5daqt0ofc4t******** folder_id: b1g681qpemb4******** created_at: "2026-08-20T12:56:16.354Z" name: my-gateway status: ACTIVE domain: d5daqt0ofc4t********.********.apigw.yandexcloud.net connectivity: {} log_options: disabled: true folder_id: b1g681qpemb4******** execution_timeout: 300s
To start an API gateway, use the resume REST API method for the ApiGateway resource or the ApiGatewayService/Resume gRPC API call.