CheckRepositoryAccess

POST/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"

Body ParametersJSONExpand Collapse

repositoryUrl: optional string

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).

formaturi

runnerId: optional string

formatuuid

ReturnsExpand Collapse

errorMessage: optional string

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

hasAccess: optional boolean

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

CheckRepositoryAccess

curl https://app.gitpod.io/api/gitpod.v1.RunnerService/CheckRepositoryAccess \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $GITPOD_API_KEY" \
    -d '{}'

{
  "errorMessage": "errorMessage",
  "hasAccess": true
}

Returns Examples

{
  "errorMessage": "errorMessage",
  "hasAccess": true
}