LogoGitpod API Reference

Editors

editors

Methods

List Editors -> EditorsPage<
Editor
>
post/gitpod.v1.EditorService/ListEditors

Lists all available code editors.

Use this method to:

  • View supported editors
  • Get editor capabilities
  • Browse editor options
  • Check editor availability

Examples

  • List editors:

    Shows all available editors with pagination.

    pagination:
  pageSize: 20
Resolve Editor URL -> { url }
post/gitpod.v1.EditorService/ResolveEditorURL

Resolves the URL for accessing an editor in a specific environment.

Use this method to:

  • Get editor access URLs
  • Launch editors for environments
  • Set up editor connections
  • Configure editor access

Examples

  • Resolve editor URL:

    Gets the URL for accessing an editor in an environment.

    editorId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
environmentId: "07e03a28-65a5-4d98-b532-8ea67b188048"
organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
Get Editor -> { editor }
post/gitpod.v1.EditorService/GetEditor

Gets details about a specific editor.

Use this method to:

  • View editor information
  • Get editor configuration

Examples

  • Get editor details:

    Retrieves information about a specific editor.

    id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"

Domain types

Editor = { id, installationInstructions, name, 4 more... }