Skip to content
Ona API Reference
Ona Docs
API Reference
Editors

ResolveEditorURL

client.editors.resolveURL(EditorResolveURLParams { editorId, environmentId, organizationId, version } body, RequestOptionsoptions?): EditorResolveURLResponse { 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"
ParametersExpand Collapse
body: EditorResolveURLParams { editorId, environmentId, organizationId, version }
editorId: string

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

formatuuid
environmentId: string

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

formatuuid
organizationId: string

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

formatuuid
version?: string

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

Examples for JetBrains: 2025.2

ReturnsExpand Collapse
EditorResolveURLResponse { url }
url: string

url is the resolved editor URL

ResolveEditorURL

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const response = await client.editors.resolveURL({
  editorId: 'd2c94c27-3b76-4a42-b88c-95a85e392c68',
  environmentId: '07e03a28-65a5-4d98-b532-8ea67b188048',
  organizationId: 'b0e12f6c-4c67-429d-a4a6-d9838b5da047',
});

console.log(response.url);
{
  "url": "url"
}
Returns Examples
{
  "url": "url"
}