API Reference

Gateways

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

ListGateways

gateways.list(GatewayListParams**kwargs) -> SyncGatewaysPage[Gateway]

POST/gitpod.v1.GatewayService/ListGateways

ListGateways

ParametersExpand Collapse

token: Optional[str]

page_size: Optional[int]

maximum100

minimum0

pagination: Optional[Pagination]

pagination contains the pagination options for listing gateways

token: Optional[str]

Token for the next set of results that was returned as next_token of a PaginationResponse

page_size: Optional[int]

Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100.

formatint32

maximum100

ReturnsExpand Collapse

class Gateway: …

Gateway represents a system gateway that provides access to services

name: str

name is the human-readable name of the gateway. name is unique across all gateways.

url: str

url of the gateway

region: Optional[str]

region is the geographical region where the gateway is located

ListGateways

Python

HTTP

TypeScript

Python

Go

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
page = client.gateways.list()
page = page.gateways[0]
print(page.name)

200 example

{
  "gateways": [
    {
      "name": "name",
      "url": "url",
      "region": "region"
    }
  ],
  "pagination": {
    "nextToken": "nextToken"
  }
}

Returns Examples

200 example

{
  "gateways": [
    {
      "name": "name",
      "url": "url",
      "region": "region"
    }
  ],
  "pagination": {
    "nextToken": "nextToken"
  }
}