---
title: "ParseContextURL"
method: POST
path: "/gitpod.v1.RunnerService/ParseContextURL"
tags: ["gitpod.v1.RunnerService"]
---

# ParseContextURL

`POST /gitpod.v1.RunnerService/ParseContextURL`

ParseContextURL asks a runner to parse a context URL, and return the parsed result.

 This call returns
  - FAILED_PRECONDITION if the user requires authentication on the runner to access the context URL
  - PERMISSION_DENIED if the user is not allowed to access the context URL using the credentials they have
  - INVALID_ARGUMENT if the context URL is invalid
  - NOT_FOUND if the repository or branch indicated by the context URL does not exist

## Request body

- GitpodV1ParseContextURLRequest
  - `contextUrl` string, uri
  - `runnerId` string, uuid

## Response `200`

Success

- GitpodV1ParseContextURLResponse
  - `git` GitpodV1ParseContextURLResponseGitContext
    - `branch` string
    - `cloneUrl` string
    - `commit` string
    - `host` string
    - `owner` string
    - `repo` string
    - `upstreamRemoteUrl` string
  - `originalContextUrl` string

## Other responses

- `default` — Error

## Changes

- **2025-02-18** `cd6a05ae99d2` — 1 warning
  - removed the optional property `detail` from the response with the `default` status

[Change history](https://skmtc.dev/gitpod-io/apis/gitpod-v1/changes/gitpod.v1.RunnerService/ParseContextURL/post.md)

---

[API](https://skmtc.dev/gitpod-io/apis/gitpod-v1.md) · [All operations](https://skmtc.dev/gitpod-io/apis/gitpod-v1/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/gitpod-io/gitpod-v1/revisions/cd6a05ae99d2/schema)