Skip to content

system#

Interact with Posit Connect's system API.

Usage:

system [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

system caches#

Interact with Posit Connect's system caches.

Usage:

system caches [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

system caches delete#

Delete a runtime cache on a Posit Connect server.

Usage:

system caches delete [OPTIONS]

Options:

  -n, --name TEXT        The nickname of the Posit Connect server to deploy
                         to.
  -s, --server TEXT      The URL for the Posit Connect server to deploy to.
                         (Also settable via CONNECT_SERVER environment
                         variable.)
  -k, --api-key TEXT     The API key to use to authenticate with Posit
                         Connect. (Also settable via CONNECT_API_KEY
                         environment variable.)
  -i, --insecure         Disable TLS certification/host validation. (Also
                         settable via CONNECT_INSECURE environment variable.)
  -c, --cacert FILE      The path to trusted TLS CA certificates. (Also
                         settable via CONNECT_CA_CERTIFICATE environment
                         variable.)
  -v, --verbose          Enable verbose output. Use -vv for very verbose
                         (debug) output.
  -l, --language TEXT    The language of the target cache.  [required]
  -V, --version TEXT     The version of the target cache.  [required]
  -I, --image-name TEXT  The image name of the target cache's execution
                         environment. Defaults to "Local".
  -d, --dry-run          If true, verify that deletion would occur, but do not
                         delete.
  --help                 Show this message and exit.

system caches list#

List runtime caches present on a Posit Connect server.

Usage:

system caches list [OPTIONS]

Options:

  -n, --name TEXT     The nickname of the Posit Connect server to deploy to.
  -s, --server TEXT   The URL for the Posit Connect server to deploy to. (Also
                      settable via CONNECT_SERVER environment variable.)
  -k, --api-key TEXT  The API key to use to authenticate with Posit Connect.
                      (Also settable via CONNECT_API_KEY environment
                      variable.)
  -i, --insecure      Disable TLS certification/host validation. (Also
                      settable via CONNECT_INSECURE environment variable.)
  -c, --cacert FILE   The path to trusted TLS CA certificates. (Also settable
                      via CONNECT_CA_CERTIFICATE environment variable.)
  -v, --verbose       Enable verbose output. Use -vv for very verbose (debug)
                      output.
  --help              Show this message and exit.