Interface SearchReposParams

Query parameters accepted by GET /rest/api/latest/repos (global repository search).

See

https://developer.atlassian.com/server/bitbucket/rest/v819/api-group-repository/#api-api-latest-repos-get

interface SearchReposParams {
    limit?: number;
    name?: string;
    permission?: string;
    projectkey?: string;
    projectname?: string;
    start?: number;
    state?: "AVAILABLE" | "INITIALISING" | "INITIALISATION_FAILED";
    visibility?: "public" | "private";
}

Hierarchy (View Summary)

Properties

limit? name? permission? projectkey? projectname? start? state? visibility?

Properties

Optionallimit

limit?: number

Maximum number of results to return per page. Bitbucket default is 25, maximum is 1000.

Optionalname

name?: string

Filter by repository name. A % prefix is automatically prepended to perform a contains-style match (e.g. 'api' → '%api').

Optionalpermission

permission?: string

Filter by the permission the authenticated user has on the repository. e.g. 'REPO_READ', 'REPO_WRITE', 'REPO_ADMIN'

Optionalprojectkey

projectkey?: string

Filter by project key (exact match)

Optionalprojectname

projectname?: string

Filter by project name (case-insensitive prefix match)

Optionalstart

start?: number

0-based index of the first result to return. Use nextPageStart from the previous response to paginate forward.

Optionalstate

state?: "AVAILABLE" | "INITIALISING" | "INITIALISATION_FAILED"

Filter by repository state

Optionalvisibility

visibility?: "public" | "private"

Filter by visibility: 'public' or 'private'

Settings

Member Visibility

On This Page

Properties