gateway

Create Service

Create a new service.

post/1.3/gateway

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/gateway
  • Auth: HTTP bearer

Request body

namestring required

Name of the service

planstring required

Plan

zonestring required

Zone

featuresGatewayServiceFeatures[] required

Active features

configured_status'started' | 'stopped' required

Service configured status

automatic_tunnel_internal_ip_allocationboolean

Allocate and use tunnel internal IPs automatically

Example request

{
  "name": "gateway-service",
  "plan": "development-gwaas-1c2g",
  "zone": "fi-hel1",
  "features": [],
  "routers": [],
  "addresses": [],
  "connections": [],
  "labels": [],
  "configured_status": "started",
  "automatic_tunnel_internal_ip_allocation": true
}

Response

OK

uuidstring uuid

The unique identifier for the resource.

namestring

Name of the service

zonestring

Zone of the service

planstring

Plan

featuresGatewayServiceFeatures[]

Active features

configured_status'started' | 'stopped'

Service configured status

operational_state'pending' | 'setup-agent' | 'setup-link-network' | 'setup-service' | 'setup-network' | 'setup-gw' | 'checkup' | 'setup-dns' | 'running' | 'stopped' | 'delete-dns' | 'delete-gw' | 'delete-network' | 'delete-server' | 'delete-link-network' | 'delete-service' | 'detach-link-network'

Service operational state

automatic_tunnel_internal_ip_allocationboolean

Allocate and use tunnel internal IPs automatically

created_atstring date-time

Timestamp of when the service was created.

updated_atstring date-time

Timestamp of when the service was last updated.

Example response

{
  "uuid": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "gateway-service",
  "zone": "fi-hel1",
  "plan": "development-gwaas-1c2g",
  "features": [],
  "addresses": [],
  "connections": [],
  "configured_status": "started",
  "automatic_tunnel_internal_ip_allocation": true,
  "labels": [],
  "created_at": "2025-03-26T12:34:56Z",
  "updated_at": "2025-03-26T12:34:56Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.