Skip to content

Suggested searches

    Search all documentation ↑↓ to navigate Enter to open Esc to close

    prb api command reference

    Reference for 1 command under prb api, including usage, flag types and defaults, required flags, source examples, and implementation links

    Markdown

    Make an authenticated GraphQL request. This page documents 1 command under prb api.

    Flags and examples below come from the command definitions. A Required flag is explicitly marked required by Cobra; an unmarked flag can still be needed by runtime validation or a non-interactive workflow. Empty strings and empty lists are registered defaults, not sample values.

    Every command also inherits the global flags. Run prb <command> --help to check your installed version. Replace placeholder IDs and names in source examples before running them. Return to the complete CLI command reference to browse another command.

    CommandDescriptionUsageSource
    prb apiMake an authenticated GraphQL request.prb api <query>View implementation

    Make an authenticated GraphQL request.

    prb api <query>

    Accepts at most 1 positional argument.

    Send a GraphQL query or mutation to the Probo API and print the response.
    FlagTypeDefaultRequiredDescription
    --field, -fstring array[]—GraphQL variable in key=value format
    --schemastring"console"—GraphQL schema to query (console or connect)
    Terminal window
    # Run a query against the console schema (default)
    prb api 'query Viewer { viewer { id email } }'
    # Run a mutation with variables
    prb api 'mutation CreateRisk($input: CreateRiskInput!) { createRisk(input: $input) { riskEdge { node { id } } } }' \
    -f input='{"organizationId":"...","name":"Test","category":"Operational"}'
    # Query the connect schema
    prb api --schema connect 'query Viewer { viewer { id email } }'
    # Read query from stdin
    echo 'query Viewer { viewer { id } }' | prb api -

    View command implementation.