api-get¶

rbt api-get will request the API resource found at the provided <path> and display it as JSON.

Paths will be appended to the root of the API to generate a URL. For example, the /review-requests/123/ path would result in a request to http://example.com/api/review-requests/123/.

The path may also be replaced by a full URL. If rbt api-get detects the path begins with http:// or https://, it will treat the path itself as the request URL.

Query arguments may also be specified for the request. Each query argument takes the form of --<query-arg>=<value>. For example:

$ # Make a request to http://example.com/api/review-requests/?counts-only=1
$ rbt api-get /review-requests/ --counts-only=1

Usage¶

$ rbt api-get [options] <path> [--<query-arg>=<value> ...]

Options¶

--pretty¶

Pretty prints the resulting API payload.

The default can be set in API_GET_PRETTY_PRINT in .reviewboardrc.

-d, --debug¶

Displays debug output.

This information can be valuable when debugging problems running the command.

The default can be set in DEBUG in .reviewboardrc.

Review Board Server Options¶

Options necessary to communicate and authenticate with a Review Board server.

--server <url>¶

Specifies the Review Board server to use.

The default can be set in REVIEWBOARD_URL in .reviewboardrc.

--username <username>¶

The user name to be supplied to the Review Board server.

The default can be set in USERNAME in .reviewboardrc.

--password <password>¶

The password to be supplied to the Review Board server.

The default can be set in PASSWORD in .reviewboardrc.

--ext-auth-cookies <ext auth cookies>¶

Use an external cookie store with pre-fetched authentication data. This is useful with servers that require extra web authentication to access Review Board, e.g. on single sign-on enabled sites.

The default can be set in EXT_AUTH_COOKIES in .reviewboardrc.

New in version 0.7.5.

--api-token <token>¶

The API token to use for authentication, instead of using a username and password.

The default can be set in API_TOKEN in .reviewboardrc.

New in version 0.7.

--disable-proxy¶

Prevents requests from going through a proxy server.

The default can be set in ENABLE_PROXY in .reviewboardrc.

--disable-ssl-verification¶

Disable SSL certificate verification. This is useful with servers that have self-signed certificates.

The default can be set in DISABLE_SSL_VERIFICATION in .reviewboardrc.

New in version 0.7.3.

--disable-cookie-storage¶

Use an in-memory cookie store instead of writing them to a file. No credentials will be saved or loaded.

The default can be set in SAVE_COOKIES in .reviewboardrc.

New in version 0.7.3.

--disable-cache¶

Disable the HTTP cache completely. This will result in slower requests.

The default can be set in DISABLE_CACHE in .reviewboardrc.

New in version 0.7.3.

--disable-cache-storage¶

Disable storing the API cache on the filesystem, instead keeping it in memory temporarily.

The default can be set in IN_MEMORY_CACHE in .reviewboardrc.

New in version 0.7.3.

--cache-location <file>¶

The file to use for the API cache database.

The default can be set in CACHE_LOCATION in .reviewboardrc.

New in version 0.7.3.

--ca-certs <file>¶

Additional TLS CA bundle.

The default can be set in CA_CERTS in .reviewboardrc.

--client-key <file>¶

Key for TLS client authentication.

The default can be set in CLIENT_KEY in .reviewboardrc.

--client-cert <file>¶

Certificate for TLS client authentication.

The default can be set in CLIENT_CERT in .reviewboardrc.