Bitbucket Data Center API Client
    Preparing search index...

    Interface SearchReposParams

    Query parameters accepted by BitbucketClient.search, which applies a % contains-match prefix to name before calling GET /rest/api/latest/repos.

    For a 1:1 mapping of the documented endpoint parameters use GlobalReposParams with BitbucketClient.repos() instead.

    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)

    Index

    Properties

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

    Properties

    limit?: number

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

    name?: string

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

    permission?: string

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

    projectkey?: string

    Filter by project key (exact match)

    projectname?: string

    Filter by project name (case-insensitive prefix match)

    start?: number

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

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

    Filter by repository state

    visibility?: "public" | "private"

    Filter by visibility: 'public' or 'private'

    Settings

    Member Visibility

    On This Page

    Properties