Jump to >

Remote Repository List Resource

Added in 2.5

Returns information on remote repositories on a hosting service.

This can be used to look up the information needed to connect to a remote repository or to add a repository to Review Board. Only remote repositories that are accessible to the linked hosting service account (i.e., that of the parent resource) will be provided by this resource.

Details

Name remote_repositories
URI /api/hosting-service-accounts/{account_id}/remote-repositories/
Token Policy ID remote_repository
HTTP Methods
  • GET - Returns the list of remote repositories on the hosting service.
Parent Resource Hosting Service Account Resource
Child Resources
Anonymous Access Yes, if anonymous site access is enabled

HTTP GET

Returns the list of remote repositories on the hosting service.

Different hosting service backends have different criteria for performing the lookups. Some hosting services have multiple types of owners, specified by passing owner-type. Filtering may also be possible by passing filter-type. Performing lookups requires knowing the possible values for the service ahead of time and passing the proper parameters in the query string.

Pagination works a bit differently for this resource than most. Instead of ?start= taking an index into the number of results, this resource’s ?start= takes a 0-based index of the page of results.

?max-results= and ?counts-only= are not supported, as they’re not compatible with all hosting services.

Callers should always use the next and prev links for navigation, and should not build page indexes themselves.

Request Parameters

filter-typeString Filters the list of results. Allowed values are dependent on the hosting service. Unexpected values will be ignored.
ownerString The owner (user account or organization) to look up repositories for. Defaults to the owner of the hosting service account.
owner-typeString Indicates what sort of account the owner represents. This may be required by some services, and the values are dependent on that service.
startInteger The 0-based index of the first page of results to fetch.

Errors

100 - Does Not ExistHTTP 404 - Not Found Object does not exist
101 - Permission DeniedHTTP 403 - Forbidden You don’t have permission for this
103 - Not Logged InHTTP 401 - Unauthorized You are not logged in
105 - Invalid Form DataHTTP 400 - Bad Request One or more fields had errors