api-get¶

rbt api-get is a convenient way of fetching information from the Review Board API using HTTP GET. It takes a full URL or a path relative to the API, along with optional parameters for query arguments, and outputs the API payload as JSON.

Usage¶

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

Querying the API¶

Paths will be appended to the root of the API to generate a URL. For example, if the Review Board server is located at https://example.com/, the path /review-requests/123/ path would result in an HTTP GET request to https://example.com/api/review-requests/123/.

For example:

$ rbt api-get /review-requests/
{
    ...
}

The full URL to an API endpoint can be provided instead. For example:

$ rbt api-get https://example.com/api/review-requests/
{
    ...
}

As a convenience, you query arguments can be provided as command line options. A query string in the form of ?<query-arg>=<value> can be provided as --<query-arg>=<value>. For example:

$ rbt api-get /review-requests/ --counts-only=1
{
    ...
}

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.

--json¶

Output results as JSON data instead of text.

The default can be set in JSON_OUTPUT in .reviewboardrc.

Added in version 3.0.

--open-browser¶

For commands that navigate you to a URL, this will automatically open a browser to the URL. When used with --web-login, this will open a browser to the login page.

The default can be set in OPEN_BROWSER in .reviewboardrc.

Added in version 6.0.

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.

Added 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.

Added in version 0.7.

--web-login¶

Use web-based login instead of prompting for authentication credentials directly in the terminal.

The default can be set in WEB_LOGIN in .reviewboardrc.

Added in version 6.0.

--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.

Added 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.

Added 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.

Added 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.

Added 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.

Added 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.

--proxy-authorization <proxy authorization>¶

Value of the Proxy-Authorization header to send with HTTP requests.

The default can be set in PROXY_AUTHORIZATION in .reviewboardrc.