LogoGitpod Documentation

Editors

editors

Methods

List Editors -> EditorsPage<{ id, alias, iconUrl, 4 more... }>
post/gitpod.v1.EditorService/ListEditors

ListEditors lists all editors available to the caller

Security
Bearer Auth

Example: Authorization: Bearer My Bearer Token

Parameters
token: string
Optional
pageSize: number
Optional
(maximum: 100, minimum: 0)
Response fields
editors: Array<{ id, alias, iconUrl, 4 more... }>
Optional

editors contains the list of editors

pagination: { token, pageSize }
Optional

pagination contains the pagination options for listing environments

Request example
200Example
Resolve Editor URL -> { url }
post/gitpod.v1.EditorService/ResolveEditorURL

ResolveEditorURL resolves the editor's URL for an environment

Get Editor -> { editor }
post/gitpod.v1.EditorService/GetEditor

GetEditor returns the editor with the given ID