v18

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014211,6201.8 MB
gitpod.v1.RunnerService

ParseContextURL

Parses a context URL and returns the parsed result.

Use this method to:

  • Validate context URLs
  • Check repository access
  • Verify branch existence

Returns:

  • FAILED_PRECONDITION if authentication is required
  • PERMISSION_DENIED if access is not allowed
  • INVALID_ARGUMENT if URL is invalid
  • NOT_FOUND if repository/branch doesn't exist

Examples

  • Parse URL:

    Parses and validates a context URL.

    contextUrl: "https://github.com/org/repo/tree/main"
    
post/gitpod.v1.RunnerService/ParseContextURL

Request body

contextUrlstring uri
runnerIdstring uuid

Response

Success

originalContextUrlstring
projectIdsstring[]

project_ids is a list of projects to which the context URL belongs to.

recommendedEnvironmentClassesstring[]

recommended_environment_classes is an ordered list of environment class IDs that are suitable for creating an environment for this context URL.

scmIdstring

scm_id is the unique identifier of the SCM provider (e.g., "github", "gitlab", "bitbucket")