# Editors ## ListEditors `editors.list(EditorListParams**kwargs) -> SyncEditorsPage[Editor]` **post** `/gitpod.v1.EditorService/ListEditors` Lists all available code editors, optionally filtered to those allowed in an organization. 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. ```yaml pagination: pageSize: 20 ``` - List editors available to the organization: Shows all available editors that are allowed by the policies enforced in the organization with pagination. ```yaml pagination: pageSize: 20 filter: allowedByPolicy: true ``` ### Parameters - `token: Optional[str]` - `page_size: Optional[int]` - `filter: Optional[Filter]` filter contains the filter options for listing editors - `allowed_by_policy: Optional[bool]` allowed_by_policy filters the response to only editors that are allowed by the policies enforced in the organization - `pagination: Optional[Pagination]` pagination contains the pagination options for listing environments - `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. ### Returns - `class Editor: …` - `id: str` - `installation_instructions: str` - `name: str` - `url_template: str` - `alias: Optional[str]` - `icon_url: Optional[str]` - `short_description: Optional[str]` - `versions: Optional[List[EditorVersion]]` versions contains the list of available versions for this editor - `version: str` version is the version string of the editor Examples for JetBrains: 2025.2 ### Example ```python 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.editors.list( pagination={ "page_size": 20 }, ) page = page.editors[0] print(page.id) ``` #### Response ```json { "editors": [ { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "installationInstructions": "installationInstructions", "name": "name", "urlTemplate": "urlTemplate", "alias": "alias", "iconUrl": "iconUrl", "shortDescription": "shortDescription", "versions": [ { "version": "version" } ] } ], "pagination": { "nextToken": "nextToken" } } ``` ## ResolveEditorURL `editors.resolve_url(EditorResolveURLParams**kwargs) -> EditorResolveURLResponse` **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. ```yaml editorId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" environmentId: "07e03a28-65a5-4d98-b532-8ea67b188048" organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" ``` ### Parameters - `editor_id: str` editorId is the ID of the editor to resolve the URL for - `environment_id: str` environmentId is the ID of the environment to resolve the URL for - `organization_id: str` organizationId is the ID of the organization to resolve the URL for - `version: Optional[str]` version is the editor version to use If not provided, the latest version will be installed Examples for JetBrains: 2025.2 ### Returns - `class EditorResolveURLResponse: …` - `url: str` url is the resolved editor URL ### Example ```python import os from gitpod import Gitpod client = Gitpod( bearer_token=os.environ.get("GITPOD_API_KEY"), # This is the default and can be omitted ) response = client.editors.resolve_url( editor_id="d2c94c27-3b76-4a42-b88c-95a85e392c68", environment_id="07e03a28-65a5-4d98-b532-8ea67b188048", organization_id="b0e12f6c-4c67-429d-a4a6-d9838b5da047", ) print(response.url) ``` #### Response ```json { "url": "url" } ``` ## GetEditor `editors.retrieve(EditorRetrieveParams**kwargs) -> EditorRetrieveResponse` **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. ```yaml id: "d2c94c27-3b76-4a42-b88c-95a85e392c68" ``` ### Parameters - `id: str` id is the ID of the editor to get ### Returns - `class EditorRetrieveResponse: …` - `editor: Editor` editor contains the editor - `id: str` - `installation_instructions: str` - `name: str` - `url_template: str` - `alias: Optional[str]` - `icon_url: Optional[str]` - `short_description: Optional[str]` - `versions: Optional[List[EditorVersion]]` versions contains the list of available versions for this editor - `version: str` version is the version string of the editor Examples for JetBrains: 2025.2 ### Example ```python import os from gitpod import Gitpod client = Gitpod( bearer_token=os.environ.get("GITPOD_API_KEY"), # This is the default and can be omitted ) editor = client.editors.retrieve( id="d2c94c27-3b76-4a42-b88c-95a85e392c68", ) print(editor.editor) ``` #### Response ```json { "editor": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "installationInstructions": "installationInstructions", "name": "name", "urlTemplate": "urlTemplate", "alias": "alias", "iconUrl": "iconUrl", "shortDescription": "shortDescription", "versions": [ { "version": "version" } ] } } ``` ## Domain Types ### Editor - `class Editor: …` - `id: str` - `installation_instructions: str` - `name: str` - `url_template: str` - `alias: Optional[str]` - `icon_url: Optional[str]` - `short_description: Optional[str]` - `versions: Optional[List[EditorVersion]]` versions contains the list of available versions for this editor - `version: str` version is the version string of the editor Examples for JetBrains: 2025.2 ### Editor Version - `class EditorVersion: …` - `version: str` version is the version string of the editor Examples for JetBrains: 2025.2 ### Editor Resolve URL Response - `class EditorResolveURLResponse: …` - `url: str` url is the resolved editor URL ### Editor Retrieve Response - `class EditorRetrieveResponse: …` - `editor: Editor` editor contains the editor - `id: str` - `installation_instructions: str` - `name: str` - `url_template: str` - `alias: Optional[str]` - `icon_url: Optional[str]` - `short_description: Optional[str]` - `versions: Optional[List[EditorVersion]]` versions contains the list of available versions for this editor - `version: str` version is the version string of the editor Examples for JetBrains: 2025.2