gateway

List Services

List available services.

get/1.3/gateway

Request

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

Query parameters

limitinteger

Schema for a query parameter specifying the maximum number of entries to return (limit).

Example:10

Number of entries to receive at most.

offsetinteger

Schema for a query parameter specifying the offset for pagination.

Offset for retrieved results.

sort'created_at' | '-created_at' | 'name' | '-name' | 'uuid' | '-uuid'

Sort services by field. Prefix with '-' for descending order.

Example:-created_at

Sort resources by field. Prefix with '-' for descending order.

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

[]

Changes

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