• Get Review Board
  • What's New
  • Products
  • Review Board Code review, image review, and document review
  • Documentation
  • Release Notes
  • Power Pack Enterprise integrations, reports, and enhanced document review
  • Try for 60 Days
  • Purchase
  • RBCommons Review Board as a Service, hosted by us
  • Pricing
  • RBTools Command line tools and Python API for Review Board
  • Documentation
  • Release Notes
  • Review Bot Automated code review, connecting tools you already use
  • Documentation
  • Release Notes
  • RB Gateway Manage Git and Mercurial repositories in your network
  • Documentation
  • Release Notes
  • Learn and Explore
  • What is Code Review?
  • Documentation
  • Frequently Asked Questions
  • Support Options
  • Third-Party Integrations
  • Demo
  • Review Board RBTools Power Pack Review Bot Djblets RB Gateway
    1. RBTools 0.6
    2. Version 5.x
    3. Version 4.x
    4. Version 3.x
    5. Version 2.0
    6. Version 1.0
    7. Version 0.7
    8. Version 0.6
    9. Version 0.5
    10. rbt Commands
    11. api-get
  • Home
  • Configuration
  • rbt Commands
  • api-get
  • attach
  • close
  • diff
  • list-repo-types
  • patch
  • post
  • publish
  • setup-repo
  • status
  • Overview of the Python API Client
  • Tutorial
  • Resource-Specific Functionality
  • General Index
  • Release Notes
  • This documentation covers RBTools 0.6. You can select a version above or view the latest documentation.

    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 appears after -- on the command line and 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> ...]]
    

    Default Options¶

    A number of options to rbt api-get can be set by default in .reviewboardrc. These can go either in the repository’s or the user’s .reviewboardrc.

    The options include:

    • DEBUG (-d)
    • API_GET_PRETTY_PRINT (--pretty)

    Options¶

    -d, –debug¶

    Display debug output.

    The default can be set in DEBUG in .reviewboardrc.

    –pretty¶

    Pretty print output.

    The default can be set in API_GET_PRETTY_PRINT in .reviewboardrc.

    Keep up with the latest Review Board releases, security updates, and helpful information.

    About
    News
    Demo
    RBCommons Hosting
    Integrations
    Happy Users
    Support Options
    Documentation
    FAQ
    User Manual
    RBTools
    Administration Guide
    Power Pack
    Release Notes
    Downloads
    Review Board
    RBTools
    Djblets
    Power Pack
    Package Store
    PGP Signatures
    Contributing
    Bug Tracker
    Submit Patches
    Development Setup
    Wiki
    Follow Us
    Mailing Lists
    Reddit
    Twitter
    Mastodon
    Facebook
    YouTube

    Copyright © 2006-2025 Beanbag, Inc. All rights reserved.

    Terms of Service — Privacy Policy — AI Ethics Policy — Branding

    On this page

    • [Top]
    • Default Options
    • Options