Bitbucket Data Center API Client
    Preparing search index...

    Interface BitbucketClientOptions

    Constructor options for BitbucketClient.

    interface BitbucketClientOptions {
        apiPath: string;
        apiUrl: string;
        authType?: AuthType;
        retry?: RetryOptions;
        token: string;
        user?: string;
    }
    Index

    Properties

    apiPath apiUrl authType? retry? token user?

    Properties

    apiPath: string

    The API path to prepend to every request (e.g., 'rest/api/latest')

    apiUrl: string

    The host URL of the Bitbucket Data Center instance (e.g., https://bitbucket.example.com)

    authType?: AuthType

    The authentication scheme to use. Defaults to 'basic'; use 'bearer' for HTTP access tokens.

    retry?: RetryOptions

    Retry/backoff behaviour applied when the API responds with 429 Too Many Requests.

    token: string

    The personal access token or password to authenticate with

    user?: string

    The username to authenticate with. Required when authType is 'basic' (the default).

    Settings

    Member Visibility

    On This Page

    Properties