Bitbucket Data Center API Client
    Preparing search index...

    Interface ArchiveParams

    Query parameters accepted by GET /rest/api/latest/projects/{key}/repos/{slug}/archive.

    interface ArchiveParams {
        at?: string;
        filename?: string;
        format?: "zip" | "tar" | "tar.gz" | "tgz";
        path?: string | string[];
        prefix?: string;
    }
    Index

    Properties

    at? filename? format? path? prefix?

    Properties

    at?: string

    Branch, tag, or commit to archive; defaults to the default branch

    filename?: string

    Filename suggested in the Content-Disposition response header

    format?: "zip" | "tar" | "tar.gz" | "tgz"

    Archive format; defaults to 'zip'

    path?: string | string[]

    Paths to include in the archive; omit to archive the whole repository

    prefix?: string

    Prefix prepended to every entry in the archive (e.g. 'my-repo/')

    Settings

    Member Visibility

    On This Page

    Properties