Manage gateways

You can update the configuration of an existing VPN gateway to modify its descriptive name or adjust global routing settings. Note that while you can change parameters like the displayName, core architectural settings—such as the routingType—are defined during provisioning and cannot be modified.

Prerequisites

Before you update a connection, ensure you have the following:

• The STACKIT project ID and the region of your gateway.
• The updated configuration parameters

API

Identify the gateway

To update a specific gateway, you must first retrieve its unique identifier (gatewayId).

1. List all VPN gateways in your project:

   GET /v1beta1/projects/{projectId}/regions/{region}/gateways

2. Locate the target gateway in the response and copy the id field.

Apply configuration changes

To update the gateway, send a PUT request to the gateway endpoint. This method replaces the existing configuration with the values provided in your request body.

1. Prepare the JSON request body. You must include all required fields, even if they remain unchanged, such as the planId and availabilityZones.

2. Send the request to the following endpoint:

   PUT /v1beta1/projects/{projectId}/regions/{region}/gateways/{gatewayId}

Example request

This example demonstrates updating the displayName for an existing gateway.

{
  "displayName": "production-gateway-v2",
  "planId": "p500",
  "routingType": "BGP_ROUTE_BASED",
  "availabilityZones": {
    "tunnel1": "eu01-1",
    "tunnel2": "eu01-2"
  },
  "bgp": {
    "localAsn": 64512,
    "overrideAdvertisedRoutes": [
      "10.0.0.0/16",
      "10.1.0.0/16"
    ]
  }
}

Portal

Portal integration not yet available.

CLI

CLI functions not yet available.

Terraform

Terraform functions not yet available.

Verify the update

After you send the update request, the gateway status transitions to PENDING while the system applies the changes.

1. Monitor the gateway state via the the gateway details endpoint.
2. Confirm that the status returns to READY.
3. Check the resource details to ensure the changes such as the new displayName are reflected correctly.

Some changes may be updated immediately, while a change such as changing an availability zone can take multiple minutes to take effect.

Important: Changing the Availability Zone will result in temporary interruptions for all tunnels operating on respective instance.

Once the update is complete, the system returns READY. If the gateway enters an ERROR state during the update, review your configuration parameters or contact the STACKIT support team for assistance.