Skip to content
Ona API Reference
Ona Docs
API Reference
Editors

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.

    editorId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
environmentId: "07e03a28-65a5-4d98-b532-8ea67b188048"
organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
ParametersExpand Collapse
editor_id: str

editorId is the ID of the editor to resolve the URL for

formatuuid
environment_id: str

environmentId is the ID of the environment to resolve the URL for

formatuuid
organization_id: str

organizationId is the ID of the organization to resolve the URL for

formatuuid
version: Optional[str]

version is the editor version to use If not provided, the latest version will be installed

Examples for JetBrains: 2025.2

ReturnsExpand Collapse
class EditorResolveURLResponse: …
url: str

url is the resolved editor URL

ResolveEditorURL

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)
{
  "url": "url"
}
Returns Examples
{
  "url": "url"
}