Yandex Cloud
Documentation
PresentationContact UsTry it for free
© 2026 Direct Cursus Technology L.L.C.
Yandex API Gateway
  • Getting started
    • All guides
    • Creating an API gateway
      • Updating API gateways and their specifications
      • Adding a domain
      • Specifying a cloud network
      • Setting up variables
      • Setting up a canary release
      • Viewing monitoring charts
      • Removing a domain
      • Stopping and starting an API gateway
      • Migrating to the ru-central1-d availability zone
      • Deleting an API gateway
    • Viewing operations with service resources
  • Access management
  • Tools
  • Pricing policy
  • Terraform reference
  • Monitoring metrics
  • Audit Trails events
  • Public materials
  • Release notes
  • FAQ
  1. Step-by-step guides
  2. Managing an API gateway
  3. Stopping and starting an API gateway

Stopping and starting an API gateway

Written by
Yandex Cloud
Updated at November 2, 2026
View in Markdown

Once you have created an API gateway, you can stop it and start it again.

Stopping an API gateway

Management console
CLI
API
  1. In the management console, navigate to the folder where you want to stop an API gateway.

  2. Navigate to API Gateway.

  3. 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.

  1. See the description of the CLI command for stopping an API gateway:

    yc serverless api-gateway stop --help
    
  2. 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

Management console
CLI
API
  1. In the management console, navigate to the folder where you want to start an API gateway.

  2. Navigate to API Gateway.

  3. 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.

  1. See the description of the CLI command for starting an API gateway:

    yc serverless api-gateway resume --help
    
  2. 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.

Was the article helpful?

Previous
Removing a domain
Next
Migrating to the ru-central1-d availability zone
© 2026 Direct Cursus Technology L.L.C.