Requests
Build Restish requests with generic HTTP verbs, generated API commands, headers, query params, bodies, and profiles.
Guides
Task-oriented guides for the main Restish workflows.
Guides help you make choices across several commands. Use recipes when you need one narrow command; use reference when you need exact syntax.
If you are new, start with the Tour of Restish so the examples here have familiar pieces: generic requests, generated commands, profiles, filtering, and auto output. Then choose the guide that matches the kind of work you are doing.
Start Here
- Requests for generic URLs, generated commands, headers, query params, and debugging.
- Authentication for basic auth, bearer tokens, API keys, and external tools.
- OAuth for client credentials, browser sign-in, device code, token cache, and provider-specific setup.
- Input and Shorthand for request bodies, stdin, forms, and uploads.
- Output for auto output, JSON, NDJSON, tables, raw bytes, and files.
- Troubleshooting when behavior is surprising.
Common Workflows
- Pagination and Links and Links and Hypermedia
- Filtering and Streaming
- Retries and Caching, Command Behavior, and Scripting and Automation
- API Setup and Discovery and OpenAPI Reference
- OAuth, TLS, Shell Setup, Output, Edit Workflow, and Doctor
Guides often link inline to reference pages when exact flags or config fields matter. Treat those links as lookup, not required reading before you can try the workflow.
Related Pages
API Setup and Discovery
Register APIs, discover OpenAPI specs, manage generated command sources, and sync changes.
Authentication
Configure Restish auth with profiles, generated API setup, safe auth fixtures, OAuth, and external tools.
OAuth
Choose and configure OAuth client credentials, authorization code, and device code auth in Restish.
Input and Shorthand
Build structured request bodies with shorthand, stdin, forms, multipart uploads, and files.
Output
Understand how Restish decodes, normalizes, filters, and renders responses.
Filtering
Select headers, links, and body fields with shorthand queries or jq filters.
Pagination and Links
Follow collection pages, inspect links, and choose streaming or collection behavior.
Links and Hypermedia
Inspect normalized links from headers and response bodies.
Edit Workflow
Fetch a resource, edit it locally, review the diff, and send it back safely.
Retries and Caching
Control retries, timeouts, HTTP cache behavior, and conditional request examples.
Command Behavior
Understand exit codes, redirects, diagnostics, stdout, stderr, and script-friendly behavior.
Scripting and Automation
Write scripts around Restish using stable stdout, stderr, exit-code, format, retry, timeout, and pagination behavior.
Streaming
Work with SSE and NDJSON streams while keeping output incremental and script-friendly.
TLS
Configure custom trust, mTLS certificates, TLS signer plugins, and certificate inspection.
Troubleshooting
Diagnose common Restish setup, request, auth, output, pagination, spec, TLS, and plugin problems.