How to Import an Google API Gateway API Config into Terraform

Import Google API Gateway API Config with Terraback (recommended)

Terraback reverse-engineers your live infrastructure: it reads the Google API Gateway resource with read-only credentials, generates the HCL, and produces the exact import block. Two commands take you from a live Google API Gateway API Config to managed Terraform.

terraback scan all gcp --project my-gcp-project

terraback gcp import --method bulk

The Terraform import block

Terraback emits a Terraform 1.5+ import block like the one below. Because the block lives in your configuration, the import is reviewable in a pull request and repeatable across environments.

import {
  to = google_api_gateway_api_config.main
  id = "projects/my-project/locations/global/apis/my-api/configs/my-config"
}

Example google_api_gateway_api_config configuration

Here is a realistic Google API Gateway API Config block. Terraback generates a fuller version from your actual resource attributes; this is a minimal, valid starting point.

resource "google_api_gateway_api_config" "main" {
  api           = google_api_gateway_api.main.api_id
  api_config_id = "my-config"
  display_name  = "Production config"

  openapi_documents {
    document {
      path     = "spec.yaml"
      contents = base64encode(file("spec.yaml"))
    }
  }

  lifecycle {
    create_before_destroy = true
  }
}

Gotchas when importing a Google API Gateway API Config

• API configs are immutable; almost any change forces a new config, so create_before_destroy = true avoids a gap while gateways switch over.
• The location segment is always global for API Gateway configs, even though gateways themselves are regional.
• The openapi_documents or grpc_services content is not returned verbatim on read, so a plan may show a diff until you point contents at the same source file.
• The config is referenced by gateways via google_api_gateway_gateway; deleting a config still in use by a gateway fails.

Doing it manually with terraform import

The native approach is to write the google_api_gateway_api_config block by hand, then run terraform import google_api_gateway_api_config.example <import-id> for every resource, one at a time. That works for a handful of resources, but it does not scale: you author all the HCL yourself and repeat the command for each item. Terraback generates the HCL and the import blocks for your whole account in one pass.

Import other Google Cloud resources