API call index

Consumer

status: Get status of this instance Isolate

Get status of this instance

JSON result description:

  {
    "version": mini-buildd's version
    "identity": Instance identity
    "url": Instance URL (HTTP)
    "incoming_url": Incoming URL (currently FTP)
    "load": Instance's (0 =< load <= 1). If negative, the instance is stopped
    "chroots": List of active chroots
    "remotes": Active or auto-reactivatable remotes
    ["repositories": Simplified structural representation of all repositories]
  }


Authorization: NONE
Optional arguments 
with_repositories: Also list all repositories (may be longish)

Format: Checkbox
output: Desired result format

html: Return result as HTML (popup with JS, else full HTML page)
plain: Plain result
json: Return raw json result


Format: Choice
pub_key: Get ASCII-armored GnuPG public key of this instance Isolate

Get ASCII-armored GnuPG public key of this instance

Used to sign the APT repositories ('APT key') and for authorization across instances.

See ``Customer's  Manual, APT Bootstrap`` for ways to employ the APT key on yor local system.

Authorization: NONE
dput_conf: Get recommended dput config snippet Isolate

Get recommended dput config snippet

Usually, this is for integration in your personal ``~/.dput.cf`` (which will work
for both, ``dput`` and ``dput-ng``).

Administrators may add custom site targets via ``~mini-buildd/etc/dput.cf``.

Authorization: NONE
Optional arguments 
without_global: Exclude recommended global config

Format: Checkbox
dput_ng_profile: Output dput-ng (json) profile (instead of traditional dput.cf config snippet) only

Format: Checkbox
output: Desired result format

html: Return result as HTML (popup with JS, else full HTML page)
plain: Plain result
json: Return raw json result


Format: Choice
sources_list: Get sources.list (apt lines) Isolate

Get sources.list (apt lines)

Usually, this output is put to a file like ``/etc/apt/sources.list.d/mini-buildd-xyz.list``.

Authorization: NONE
Optional arguments
Clear Paste default 
codenames: Codenames (like 'buster', 'bullseye')

Format: List as comma-separated strings
Clear Paste default 
repositories: Repository identities (like 'test', the default sandbox repo identity)

Format: List as comma-separated strings
Clear Paste default 
suites: Suite names (like 'stable', 'unstable')

Format: List as comma-separated strings
Clear Paste default 
types: Types of apt lines ('deb', 'deb-src')

Format: List as comma-separated strings
Clear 
options: Apt line options ('deb[-src] [<options>] ...'). See 'man 5 source.list'

Format: Plain string
Clear Paste default 
rollbacks: Select (maximal) <n> rollback sources (``0``: no rollbacks, ``< 0``: all rollbacks)

Format: Integer number
Clear 
snapshot: Select a repository snapshot (see ``snapshot_ls``)

Format: Plain string
Clear 
mirror: URL of a mirror to use (instead of mini-buildd's native URL)

Format: Plain string
with_extra: Also list extra sources (non-base sources used for building)

Format: Checkbox
with_comment: Add comment line above apt line

Format: Checkbox
output: Desired result format

html: Return result as HTML (popup with JS, else full HTML page)
plain: Plain result
json: Return raw json result


Format: Choice
ls: List source package in repository Isolate

List source package in repository

Authorization: NONE
Clear 
source: Source package name

Format: Plain string
Optional arguments
Clear Paste default 
repositories: Repository identities (like 'test', the default sandbox repo identity)

Format: List as comma-separated strings
Clear Paste default 
codenames: Codenames (like 'buster', 'bullseye')

Format: List as comma-separated strings
Clear 
version: Limit to exactly this version

Format: Plain string
Clear 
min_version: Limit to this version or greater

Format: Plain string
output: Desired result format

html: Return result as HTML (popup with JS, else full HTML page)
plain: Plain result
json: Return raw json result


Format: Choice
show: Show source package in repository Isolate

Show source package in repository

Authorization: NONE
Clear 
source: Source package name

Format: Plain string
Optional arguments
Clear Paste default 
repositories: Repository identities (like 'test', the default sandbox repo identity)

Format: List as comma-separated strings
Clear Paste default 
codenames: Codenames (like 'buster', 'bullseye')

Format: List as comma-separated strings
Clear 
version: Limit to exactly this version

Format: Plain string
Clear 
min_version: Limit to this version or greater

Format: Plain string
output: Desired result format

html: Return result as HTML (popup with JS, else full HTML page)
plain: Plain result
json: Return raw json result


Format: Choice
search: Search for source or binary package names in ``repositories``, ``builds`` and ``events`` Isolate

Search for source or binary package names in ``repositories``, ``builds`` and ``events``

Be cautious with binary package files found outside of ``repositories``:

* Matches only found in ``builds`` usually failed installation as some criteria is not met.
* Matches found in ``events`` originate from the initial (non source-only) user upload (and thus are local builds).

Authorization: NONE
Clear 
pattern: Pattern for binary or source package name.

Value is a glob pattern; '*' is added automatically to begin and end of the pattern.

Format: Plain string
debdiff: Compare two internal source packages Isolate

Compare two internal source packages

Authorization: NONE
Clear 
source: Source package name

Format: Plain string
Clear 
repository: Repository identity (like 'test', the default sandbox repo identity)

Format: Plain string
Optional arguments
Clear 
versiona: Version a to compare

Format: Plain string
Clear 
versionb: Version b to compare

Format: Plain string
output: Desired result format

html: Return result as HTML (popup with JS, else full HTML page)
plain: Plain result
json: Return raw json result


Format: Choice
subscribe: Subscribe to (email) notifications Isolate

Subscribe to (email) notifications

Authorization: LOGIN
Optional arguments
Clear 
source: Source package name

Leave empty for all source packages

Format: Plain string
Clear 
distribution: Distribution name (<codename>-<id>-<suite>[-rollback<n>])

Leave empty for all distributions

Format: Plain string
output: Desired result format

html: Return result as HTML (popup with JS, else full HTML page)
plain: Plain result
json: Return raw json result


Format: Choice
unsubscribe: Unsubscribe from (email) notifications Isolate

Unsubscribe from (email) notifications

Authorization: LOGIN
Optional arguments
Clear 
source: Source package name

Leave empty for all source packages

Format: Plain string
Clear 
distribution: Distribution name (<codename>-<id>-<suite>[-rollback<n>])

Leave empty for all distributions

Format: Plain string
output: Desired result format

html: Return result as HTML (popup with JS, else full HTML page)
plain: Plain result
json: Return raw json result


Format: Choice
snapshot_ls: Get list of repository snapshots for a distribution Isolate

Get list of repository snapshots for a distribution

Authorization: NONE
Clear 
distribution: Distribution name (<codename>-<id>-<suite>[-rollback<n>])

Format: Plain string

Developer

migrate: Migrate source package Isolate

Migrate source package

Migrates a source package along with all its binary packages. If
run for a rollback distribution, this will perform a rollback
restore.

Authorization: STAFF
Clear 
source: Source package name

Format: Plain string
Clear 
distribution: Distribution name (<codename>-<id>-<suite>[-rollback<n>])

Migrates *from* this distribution

Format: Plain string
Optional arguments 
full: Migrate all 'migrates_to' suites up (f.e. unstable->testing->stable)

Format: Checkbox
Clear 
version: Migrate exactly this version. Use as safeguard, or for rare cases of multiple version of the same package in one distribution (in different components)

Format: Plain string
output: Desired result format

html: Return result as HTML (popup with JS, else full HTML page)
plain: Plain result
json: Return raw json result


Format: Choice
port: Port internal source package Isolate

Port internal source package

An internal 'port' is a no-changes (i.e., only the changelog will be adapted)
rebuild of the given locally-installed package.

When ``from_distribution`` equals ``to_distribution``, a rebuild will be done.

Authorization: STAFF
Clear 
source: Source package name

Format: Plain string
Clear 
from_distribution: Distribution name (<codename>-<id>-<suite>[-rollback<n>])

Format: Plain string
Clear 
to_distributions: Distribution names

Format: List as comma-separated strings
Optional arguments
Clear 
version: Port exactly this version. Use as safeguard, or for rare cases of multiple version of the same package in one distribution (in different components)

Format: Plain string
Clear Paste default 
options: List of upload options, separated by '|':

  (lintian|piuparts|autopkgtest)-mode[<arch>]=<mode>
    'DISABLED' (Don't run check), 'IGNORE' (Run check but ignore results), 'ERRFAIL' (Run check and fail on errors), 'WARNFAIL' (Run check and fail on warnings)
  internal-apt-priority[<arch>]=<prio>
    Apt prio for our repo packages when building (use 500 to always prefer).
  auto-ports=<dist>,...
    List of distributions (comma-separated) to automatically run ports for after successful install.
  deb-build-options[<arch>]=<option> <option>...
    Contents of DEB_BUILD_OPTIONS environment for building (see https://www.debian.org/doc/debian-policy/ch-source.html#debian-rules-and-deb-build-options).
  deb-build-profiles[<arch>]=<profile> <profile>...
    Contents of DEB_BUILD_PROFILES environment for building (see https://wiki.debian.org/BuildProfileSpec).
  add-depends[<arch>]=<dep>,<dep>...
    List of additional dependencies (comma-separated, like in ``debian/control``) (see ``sbuild --add-depends``).


Format: Plain string
output: Desired result format

html: Return result as HTML (popup with JS, else full HTML page)
plain: Plain result
json: Return raw json result


Format: Choice
port_ext: Port external source package Isolate

Port external source package

An external 'port' is a no-changes (i.e., only the changelog will be adapted)
rebuild of any given source package.

Authorization: STAFF
Clear 
dsc: URL of any Debian source package (dsc) to port

Format: URL string
Clear 
distributions: Distribution names

Format: List as comma-separated strings
Optional arguments 
allow_unauthenticated: Don't verify downloaded DSC against Debian keyrings (see ``man dget``)

Format: Checkbox
Clear Paste default 
options: List of upload options, separated by '|':

  (lintian|piuparts|autopkgtest)-mode[<arch>]=<mode>
    'DISABLED' (Don't run check), 'IGNORE' (Run check but ignore results), 'ERRFAIL' (Run check and fail on errors), 'WARNFAIL' (Run check and fail on warnings)
  internal-apt-priority[<arch>]=<prio>
    Apt prio for our repo packages when building (use 500 to always prefer).
  auto-ports=<dist>,...
    List of distributions (comma-separated) to automatically run ports for after successful install.
  deb-build-options[<arch>]=<option> <option>...
    Contents of DEB_BUILD_OPTIONS environment for building (see https://www.debian.org/doc/debian-policy/ch-source.html#debian-rules-and-deb-build-options).
  deb-build-profiles[<arch>]=<profile> <profile>...
    Contents of DEB_BUILD_PROFILES environment for building (see https://wiki.debian.org/BuildProfileSpec).
  add-depends[<arch>]=<dep>,<dep>...
    List of additional dependencies (comma-separated, like in ``debian/control``) (see ``sbuild --add-depends``).


Format: Plain string
output: Desired result format

html: Return result as HTML (popup with JS, else full HTML page)
plain: Plain result
json: Return raw json result


Format: Choice
retry: Retry a previously failed source package Isolate

Retry a previously failed source package

JSON result description:

  Changes file name that has been re-uploaded

Authorization: STAFF
Clear 
bkey: Package bkey (``<source>/<version>/<timecode>/source[ <arch>]``) of a past packaging try (see ``extra.bkey`` of a failed PACKAGING event)

Format: Plain string
cancel: Cancel an ongoing package build Isolate

Cancel an ongoing package build

Authorization: STAFF
Clear 
bkey: Build key (``<source>/<version>/<timecode>/<arch>`` of ongoing builds; see ``extra.bkey`` in BUILDING events)

Format: Plain string
set_user_key: Set a user's GnuPG public key Isolate

Set a user's GnuPG public key

Authorization: LOGIN
key: GnuPG public key; multiline inputs will be handled as ascii armored full key, one-liners as key ids

Format: Multiline string
wake: Wake a remote instance Isolate

Wake a remote instance

Authorization: STAFF
Clear 
remote: Undocumented

Format: Plain string
Optional arguments
Clear Paste default 
sleep: Sleep between wake attempts

Format: Integer number
Clear Paste default 
attempts: Max number attempts

Format: Integer number
output: Desired result format

html: Return result as HTML (popup with JS, else full HTML page)
plain: Plain result
json: Return raw json result


Format: Choice

Administrator

remove: Remove source package Isolate

Remove source package

Removes a source package along with all its binary packages.

Authorization: ADMIN
Clear 
source: Source package name

Format: Plain string
Clear 
distribution: Distribution name (<codename>-<id>-<suite>[-rollback<n>])

Format: Plain string
Optional arguments 
without_rollback: Don't copy to rollback distribution

Format: Checkbox
Clear 
version: Remove exactly this version. Use as safeguard, or for rare cases of multiple version of the same package in one distribution (in different components)

Format: Plain string
output: Desired result format

html: Return result as HTML (popup with JS, else full HTML page)
plain: Plain result
json: Return raw json result


Format: Choice
remake_chroots: Remake chroots Isolate

Remake chroots

Run actions 'remove', 'prepare', 'check' and 'activate'.

This is a MAINTENANCE call: Daemon will be automatically STOPPED while running, any ongoing events will be CANCELED.

Authorization: ADMIN
Optional arguments
Clear Paste default 
keys: Chroot keys (<codename>:<arch>)

Format: List as comma-separated strings
output: Desired result format

html: Return result as HTML (popup with JS, else full HTML page)
plain: Plain result
json: Return raw json result


Format: Choice
reindex: Force repository reindex Isolate

Force repository reindex

Usually, you reindex by doing an explicit ``check`` on a Repository
instance -- however, that method would not reindex in case the
repository config is unchanged. Use this call if you feel you need it
anyway for whatever reason.

If you just upgraded from 2.2.x, it's recommended to run it once
(2.4.x reindex additionally runs ``repreprop flood``, which may make
some arch=all packages available for (subsequently) added
architectures).

This is a MAINTENANCE call: Daemon will be automatically STOPPED while running, any ongoing events will be CANCELED.

Authorization: ADMIN
Optional arguments
Clear Paste default 
repositories: Repository identities (like 'test', the default sandbox repo identity)

Format: List as comma-separated strings
output: Desired result format

html: Return result as HTML (popup with JS, else full HTML page)
plain: Plain result
json: Return raw json result


Format: Choice
start: Start Daemon (accept incoming) Isolate

Start Daemon (accept incoming)

Does nothing if already started; will fail if Daemon instance is not activated.

Authorization: ADMIN
stop: Stop Daemon (stop accepting incoming) Isolate

Stop Daemon (stop accepting incoming)

Does nothing if already stopped. Any ongoing events will be CANCELED.

This state is *not persisted*. Please *deactivate* the Daemon instance via :mbdpage:`setup` to persist over *mini-buildd service* restarts.

Authorization: ADMIN
handshake: Check if signed message matches a remote, reply our signed message on success Isolate

Check if signed message matches a remote, reply our signed message on success

This is for internal use only.

Authorization: NONE
signed_message: Undocumented

Format: Multiline string
cronjob: Run a cron job now (out of schedule) Isolate

Run a cron job now (out of schedule)

Authorization: ADMIN
Clear 
id: Undocumented

Format: Plain string
uploaders: Get upload permissions for repositories Isolate

Get upload permissions for repositories

Authorization: ADMIN
Optional arguments
Clear Paste default 
repositories: Repository identities (like 'test', the default sandbox repo identity)

Format: List as comma-separated strings
output: Desired result format

html: Return result as HTML (popup with JS, else full HTML page)
plain: Plain result
json: Return raw json result


Format: Choice
snapshot_create: Create a repository snapshot Isolate

Create a repository snapshot

Authorization: ADMIN
Clear 
distribution: Distribution name (<codename>-<id>-<suite>[-rollback<n>])

Format: Plain string
Clear 
name: Snapshot name

Format: Plain string
snapshot_delete: Delete a repository snapshot Isolate

Delete a repository snapshot

Authorization: ADMIN
Clear 
distribution: Distribution name (<codename>-<id>-<suite>[-rollback<n>])

Format: Plain string
Clear 
name: Snapshot name

Format: Plain string
debmirror: Make local partial repository mirror via :debpkg:`debmirror` Isolate

Make local partial repository mirror via :debpkg:`debmirror`

This may be useful if you plan on publishing a stripped-down (f.e., only certain repos,
only ``stable``, omit rollbacks) variant of your repo somewhere remote.

Authorization: ADMIN
Optional arguments
Clear Paste default 
suites: Suite names (like 'stable', 'unstable')

Format: List as comma-separated strings
Clear Paste default 
rollbacks: Select (maximal) <n> rollback sources (``0``: no rollbacks, ``< 0``: all rollbacks)

Format: Integer number
Clear Paste default 
repositories: Repository identities (like 'test', the default sandbox repo identity)

Format: List as comma-separated strings
Clear Paste default 
codenames: Codenames (like 'buster', 'bullseye')

Format: List as comma-separated strings
Clear Paste default 
architectures: Architectures to mirror (``--arch`` in debmirror)

Usually, you just want all, so the default already lists all currently supported Debian/Ubuntu architectures (but will only mirror the architectures actually found)

Format: Plain string
Clear Paste default 
components: Components to mirror (``--section`` in debmirror)

Usually, you just want all, so the default already lists all known Debian/Ubuntu components (but will only mirror the components actually found)

Format: Plain string
Clear Paste default 
destination: Mirror destination dir (``mirrordir`` in debmirror)

* ``{}`` will be replaced by repository identity
* Directory must be accessible by user ``mini-buildd``

*BE CAREFUL* with this value -- anything in this directory will be *HAPPILY REPLACED* by the mirror only


Format: Plain string
output: Desired result format

html: Return result as HTML (popup with JS, else full HTML page)
plain: Plain result
json: Return raw json result


Format: Choice
keyring_packages: Build keyring packages Isolate

Build keyring packages

Authorization: ADMIN
Optional arguments
Clear 
distributions: Distribution names

Format: List as comma-separated strings
without_migration: Don't migrate packages

Format: Checkbox
output: Desired result format

html: Return result as HTML (popup with JS, else full HTML page)
plain: Plain result
json: Return raw json result


Format: Choice
test_packages: Build test packages Isolate

Build test packages

Authorization: ADMIN
Optional arguments
Clear Paste default 
sources: Test source packages to use

Format: List as comma-separated strings
Clear 
distributions: Distribution names

Format: List as comma-separated strings
Clear 
auto_ports: Distribution names

Format: List as comma-separated strings
with_check: Check for correct packager results

Format: Checkbox
output: Desired result format

html: Return result as HTML (popup with JS, else full HTML page)
plain: Plain result
json: Return raw json result


Format: Choice
setup: Create, update or inspect your setup Isolate

Create, update or inspect your setup

This is a MAINTENANCE call: Daemon will be automatically STOPPED while running, any ongoing events will be CANCELED.

Authorization: ADMIN
Optional arguments
Run Options Clear 
update: Update existing instances; 'all' to update all, empty string to never update, <hash_id>,.. (see a previous run) to update selected instances

Format: Plain string
Clear 
pca: Prepare, check and create instances; 'all' to pca all, empty string to never pca, <hash_id>,.. (see a previous run) to pca selected instances

Format: Plain string
Daemon Clear Paste default 
identity: Instance identity (for keyring package names, dput config, ...)

Format: Plain string
Clear Paste default 
ftp_endpoint: FTP (incoming) network endpoint

Format: Plain string
Generic Clear 
from_origins: Set list of origins (a.k.a. vendors) (as per ``distro-info``, ``di``): <origin>[:lts|all],...

This will be used by ``--foo-from-origins`` options.

Per-origin modifiers:

n/a: No modifier (default): 'di-supported' codenames
lts: 'di-supported' plus 'di-lts' codenames (Note: adds 'lts', 'elts' for Debian and 'esm' for Ubuntu)
all: All codenames with a working setup from these origins (i.e., includes very old ones)

Format: List as comma-separated strings
Archives Clear 
archives: Add arbitrary archives

Format: List as comma-separated strings
archives_from_origins: Add original (internet) archives from ``--from-origins``

Format: Checkbox
archives_from_apt_sources: Add archives guessed from your local sources.list

Format: Checkbox
archives_from_proxy: Add archives guessed from a locally running apt-cacher-ng

Format: Checkbox
Sources Clear 
sources: Manually select codenames to setup sources for

Format: List as comma-separated strings
sources_from_origins: Add sources from ``--from-origins``

Format: Checkbox
Distributions Clear 
distributions: Distributions to setup ``<codename>:<arch0>[+<arch1>..]``
For architectures, you may use the special key word 'native' for this host's natively supported architectures.
Please see tool ``arch-test`` for a decisive list of actually available architectures, including emulated ones.
Example: sid:native+arm64,bullseye:native


Format: List as comma-separated strings
distributions_from_sources: Auto-add distributions for all given ``sources`` codenames with native architectures

Format: Checkbox
Repositories Clear 
repositories: Repositories to setup ``<id>:<layout>:<codename>[+<codename>..]``
Setup layouts available: Default|Default (no rollbacks)|Debian Developer
Example: test:Default:sid+bullseye,test2:Default:sid
Note that repository IDs 'test' and 'debdev' are special names with hardcoded taintings:
* ``test`` repo will be uploadable w/o authentication
* `debdev`` repo will be uploadable for Debian Developers (per installed ``debian-keyring``), and Layout 'Debian Developer' by default (``sid`` uploadable as ``unstable``)


Format: List as comma-separated strings
Clear 
repositories_from_distributions: AutoSetup these repositories with all setup sources: '<id>[:<layout>]'

Format: List as comma-separated strings
Chroots Clear 
chroots: Chroots to setup (uses same syntax as ``--distributions``).

Format: List as comma-separated strings
chroots_from_sources: Auto-add chroots for all given ``sources`` codenames with native architectures

Format: Checkbox
chroots_backend: Chroot backend to use

Format: Choice
Remotes Clear 
remotes: Remotes to add. Twisted-style Network Client Endpoint

See: https://twistedmatrix.com/documents/current/core/howto/endpoints.html#clients

Notation Examples::

  'tcp:host=localhost:port=8066': Connect to localhost, unencrypted.
  'tls:host=localhost:port=8066': Connect to localhost, encrypted.
  'http://localhost:8066'       : Extra URL-style syntax (prefer twisted-style in saved configs, though).
  'localhost:8066'              : Compatibility host:port syntax (don't use -- might eventually go away).

Format: List as comma-separated strings
output: Desired result format

html: Return result as HTML (popup with JS, else full HTML page)
plain: Plain result
json: Return raw json result


Format: Choice