UpCloud

Network Gateways

Network Gateways provide NAT (Network Address Translation) and VPN connectivity for private networks. They enable secure outbound internet access and site-to-site VPN connections.

GET/1.3/gateway/plans

List plans

Returns a list of available network gateway plans.

Request

GET
/1.3/gateway/plans
curl -X GET https://api.upcloud.com/1.3/gateway/plans \
  -u your_username:your_password
GET/1.3/gateway/plans/{name}

Get plan details

Returns details of a specific gateway plan.

Request

GET
/1.3/gateway/plans/{name}
curl -X GET https://api.upcloud.com/1.3/gateway/plans/advanced \
  -u your_username:your_password
GET/1.3/gateway

List services

Returns a list of all network gateways in the account.

Request

GET
/1.3/gateway
curl -X GET https://api.upcloud.com/1.3/gateway \
  -u your_username:your_password
GET/1.3/gateway/{uuid}

Get service details

Returns detailed information about a specific network gateway.

Request

GET
/1.3/gateway/{uuid}
curl -X GET https://api.upcloud.com/1.3/gateway/04b87f79-1a17-4f64-ad8e-33bd4c3f5c1b \
  -u your_username:your_password
POST/1.3/gateway

Create service

Creates a new network gateway.

Attributes

  • Name
    name
    Type
    string
    Description

    Gateway name. Required.

  • Name
    zone
    Type
    string
    Description

    Zone identifier. Required.

  • Name
    plan
    Type
    string
    Description

    Plan name. Required.

  • Name
    features
    Type
    object
    Description

    Feature configuration (NAT, VPN). Required.

  • Name
    routers
    Type
    array
    Description

    Routers to attach. Required.

  • Name
    configured_status
    Type
    string
    Description

    Initial status: "started" or "stopped".

  • Name
    labels
    Type
    array
    Description

    Labels for classification.

Request

POST
/1.3/gateway
curl -X POST https://api.upcloud.com/1.3/gateway \
  -u your_username:your_password \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-gateway",
    "zone": "fi-hel1",
    "plan": "advanced",
    "features": {
      "nat": {
        "enabled": true
      }
    },
    "routers": [
      {
        "uuid": "04c0df35-2658-4b0c-8ac7-962090f4e92a"
      }
    ],
    "configured_status": "started"
  }'
PATCH/1.3/gateway/{uuid}

Modify service

Modifies an existing network gateway.

Request

PATCH
/1.3/gateway/{uuid}
curl -X PATCH https://api.upcloud.com/1.3/gateway/04b87f79-1a17-4f64-ad8e-33bd4c3f5c1b \
  -u your_username:your_password \
  -H "Content-Type: application/json" \
  -d '{
    "name": "updated-gateway",
    "configured_status": "stopped"
  }'
DELETE/1.3/gateway/{uuid}

Delete service

Deletes a network gateway.

Request

DELETE
/1.3/gateway/{uuid}
curl -X DELETE https://api.upcloud.com/1.3/gateway/04b87f79-1a17-4f64-ad8e-33bd4c3f5c1b \
  -u your_username:your_password