SearchRepositories

client.runners.searchRepositories(, ?): RunnerSearchRepositoriesResponse { lastPage, pagination, repositories }

POST/gitpod.v1.RunnerService/SearchRepositories

Searches for repositories across all authenticated SCM hosts.

Use this method to:

List available repositories
Search repositories by name or content
Discover repositories for environment creation

Returns repositories from all authenticated SCM hosts in natural sort order. If no repositories are found, returns an empty list.

Examples

List all repositories:

Returns up to 25 repositories from all authenticated hosts.
```
runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
```

Search repositories:

Searches for repositories matching the query across all hosts.

runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
searchString: "my-project"
limit: 10

ParametersExpand Collapse

body: RunnerSearchRepositoriesParams { limit, pagination, runnerId, 3 more }

Deprecatedlimit?: number

Maximum number of repositories to return. Default: 25, Maximum: 100 Deprecated: Use pagination.page_size instead

formatint32

maximum100

minimum1

pagination?: Pagination

Pagination parameters for repository search

token?: string

Token for the next set of results that was returned as next_token of a PaginationResponse

pageSize?: number

Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100.

formatint32

maximum100

runnerId?: string

formatuuid

scmHost?: string

The SCM’s host to retrieve repositories from

searchMode?: SearchMode

Search mode determines how search_string is interpreted

One of the following:

"SEARCH_MODE_UNSPECIFIED"

"SEARCH_MODE_KEYWORD"

"SEARCH_MODE_NATIVE"

searchString?: string

Search query - interpretation depends on search_mode

ReturnsExpand Collapse

RunnerSearchRepositoriesResponse { lastPage, pagination, repositories }

lastPage?: number

Deprecated: Use pagination token instead. Total pages can be extracted from token.

formatint32

pagination?: Pagination { nextToken }

Pagination information for the response. Token format: “NEXT_PAGE/TOTAL_PAGES/TOTAL_COUNT” (e.g., “2/40/1000”). Use -1 for unknown values (e.g., “2/-1/-1” when totals unavailable). Empty token means no more pages.

nextToken?: string

Token passed for retrieving the next set of results. Empty if there are no more results

repositories?: Array<Repository>

List of repositories matching the search criteria

name?: string

Repository name (e.g., “my-project”)

url?: string

Repository URL (e.g., “https://github.com/owner/my-project”)

SearchRepositories

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const response = await client.runners.searchRepositories({
  runnerId: 'd2c94c27-3b76-4a42-b88c-95a85e392c68',
});

console.log(response.lastPage);

{
  "lastPage": 0,
  "pagination": {
    "nextToken": "nextToken"
  },
  "repositories": [
    {
      "name": "name",
      "url": "url"
    }
  ]
}

Returns Examples

{
  "lastPage": 0,
  "pagination": {
    "nextToken": "nextToken"
  },
  "repositories": [
    {
      "name": "name",
      "url": "url"
    }
  ]
}