NAME

       mini-buildd-api - Run API calls against a mini-buildd instance

DESCRIPTION

       usage: mini-buildd-api [-h] [--version] [-v] [-q] [-J] [--auto-confirm]

       [--auto-save-passwords]
              <call> [options] ...

       Run API calls against a mini-buildd instance

   options:
       -h, --help
              show this help message and exit

       --version
              show program's version number and exit

       -v, --verbose
              increase log level. Give twice for max logs (default: 0)

       -q, --quiet
              decrease log level. Give twice for min logs (default: 0)

       -J, --json
              use parsable json output (default: False)

       --auto-confirm
              force-bypass extra confirmation (for confirmable calls) (default: False)

       --auto-save-passwords
              don't ask before saving passwords (via python-keyring) (default: False)

   API calls (run 'mini-buildd-api <call> --help' for full single call help):
              <call> [options]

       status Get the status of an instance.

              JSON Result:

       * 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 not
              powered  on.   *  chroots      :  Active  chroots.   *  remotes      :  Active   or
              auto-reactivatable remotes.

       Authorization: NONE
              .

       pub_key
              Get (ASCII-armored) GnuPG public key (apt key).

       Authorization: NONE
              .

       dput_conf
              Get recommended dput config snippet.

              Usually, this is for integration in your personal ~/.dput.cf.

       Authorization: NONE
              .

       sources_list
              Get sources.list (apt lines).

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

       Authorization: NONE
              .

       ls     Show package.

       Authorization: NONE
              .

       find   Find package.

              Like 'ls', but call will fail on no results.

       Authorization: NONE
              .

       list   List packages (deb or src).

       Unlike 'ls', this will also look for debs. This may be a very
              expensive operation - pick <package> and <distributions> wisely.

       Authorization: LOGIN
              .

       migrate
              Migrate package.

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

       JSON Result (dict):
              __plain__: string: textual migration log.

       Authorization: STAFF
              .

       remove Remove package.

              Removes a source package along with all its binary packages.

       JSON Result (dict):
              __plain__: string: textual removal log.

       Authorization: ADMIN
              .

       port   Port internal 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.

       JSON Result (dict):
              uploaded: list of triples of all items uploaded

       Authorization: STAFF
              .

       port_ext
              Port external package.

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

       JSON Result (dict):
              uploaded: list of triples of all items uploaded

       Authorization: STAFF
              .

       retry  Retry a previously failed package.

              JSON Result:

              * changes: Changes file that has been re-uploaded.

       Authorization: STAFF
              .

       cancel Cancel a running package build.  Authorization: STAFF .

       set_user_key
              Set a user's GnuPG public key.

       Authorization: LOGIN
              .

       subscribe
              Subscribe to package (email) notifications.

       Authorization: LOGIN
              .

       unsubscribe
              Unsubscribe from package (email) notifications.

       Authorization: LOGIN
              .

       setup  Create, update or inspect your setup.

              Daemon will be stopped while running, and started when finished (i.e., even  if  it
              was not running before).

       Authorization: ADMIN
              .

       remake_chroots
              Remake chroots.

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

              Daemon will be stopped while running.

       Authorization: ADMIN
              .

       power  Power Daemon (incoming) on or off (toggles by default).

       Authorization: ADMIN
              .

       wake   Wake a remote instance.

       Authorization: ADMIN
              .

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

              This is for internal use only.

       Authorization: NONE
              .

       cronjob
              Run a cron job now (out of schedule).

       Authorization: ADMIN
              .

       uploaders
              Get upload permissions for repositories.

       Authorization: ADMIN
              .

       snapshot_ls
              Get list of repository snapshots for a distribution.

       JSON Result (dict):
              dict: <distribution>: [snasphot,...]: List of snapshots for the given distribution.

       Authorization: NONE
              .

       snapshot_create
              Create a repository snapshot.

       Authorization: ADMIN
              .

       snapshot_delete
              Delete a repository snapshot.  .

       keyring_packages
              Build keyring packages.

       JSON Result (dict):
              uploaded: list of triples of all items uploaded

       Authorization: ADMIN
              .

       test_packages
              Build test packages.

       JSON Result (dict):
              uploaded: list of triples of all items uploaded

       Authorization: ADMIN
              .

       Note: Uses 'python-keyring' to persist passwords (see '~/.local/share/python_keyring/')