Sign in

v18

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

CheckRepositoryAccess

Checks if a principal has read access to a repository.

Use this method to:

  • Validate repository access before workflow execution
  • Verify executor credentials for automation bindings

Returns:

  • has_access: true if the principal can read the repository
  • FAILED_PRECONDITION if authentication is required
  • INVALID_ARGUMENT if the repository URL is invalid

Examples

  • Check access:

    Verifies read access to a repository.

    runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
repositoryUrl: "https://github.com/org/repo"
post/gitpod.v1.RunnerService/CheckRepositoryAccess

Request body

repositoryUrlstring uri

repository_url is the URL of the repository to check access for. Can be a clone URL (https://github.com/org/repo.git) or web URL (https://github.com/org/repo).

runnerIdstring uuid

Response

Success

errorMessagestring

error_message provides details when access check fails. Empty when has_access is true.

hasAccessboolean

has_access indicates whether the principal has read access to the repository.