ResolveEditorURL

client.Editors.ResolveURL(ctx, body) (*EditorResolveURLResponse, error)

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 param.Field[string]

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

formatuuid

EnvironmentID param.Field[string]

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

formatuuid

OrganizationID param.Field[string]

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

formatuuid

Version param.Field[string]Optional

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

Examples for JetBrains: 2025.2

ReturnsExpand Collapse

type EditorResolveURLResponse struct{…}

URL string

url is the resolved editor URL

ResolveEditorURL

package main

import (
  "context"
  "fmt"

  "github.com/gitpod-io/gitpod-sdk-go"
  "github.com/gitpod-io/gitpod-sdk-go/option"
)

func main() {
  client := gitpod.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  response, err := client.Editors.ResolveURL(context.TODO(), gitpod.EditorResolveURLParams{
    EditorID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"),
    EnvironmentID: gitpod.F("07e03a28-65a5-4d98-b532-8ea67b188048"),
    OrganizationID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da047"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.URL)
}

{
  "url": "url"
}

Returns Examples

{
  "url": "url"
}