# Requestly

> Design, build and test APIs in one place. Docs for the Requestly API Client: collections, environments, scripting, and Git-native sync.

- [Getting Started](https://docs.requestly.com/api-client/overview.md): Install the Requestly API Client, send your first request, save it to a collection, and set up environment variables.
- [Verify Your Linux Download](https://docs.requestly.com/api-client/verify-linux-download.md): Check that the Requestly AppImage you downloaded is the genuine file signed by Requestly before you run it.
- [Overview](https://docs.requestly.com/api-client/send-api-request/create-requests/overview.md): Learn how to create and send API requests in Requestly. Test APIs, configure requests, and view responses without writing code.
- [Configure Request](https://docs.requestly.com/api-client/send-api-request/create-requests/configure-request.md): Learn how to configure HTTP methods, URLs, and send API requests in Requestly.
- [Parameters and Body Data](https://docs.requestly.com/api-client/send-api-request/create-requests/parameters-and-body.md): Learn how to add query parameters, path variables, and request body data to your API requests in Requestly.
- [Request Headers](https://docs.requestly.com/api-client/send-api-request/create-requests/request-headers.md): Learn how to configure HTTP headers for authentication, content types, and custom metadata in your API requests.
- [Generate Client Code](https://docs.requestly.com/api-client/send-api-request/create-requests/generate-client-code.md): Export any API request as ready-to-run code in cURL, Python, JavaScript, Go, Java, C#, Swift, PHP, and 20+ other language/library combinations.
- [GraphQL Request](https://docs.requestly.com/api-client/send-api-request/graphql-request.md): Requestly supports GraphQL requests, allowing you to send queries, mutations, and define variables
- [gRPC Request](https://docs.requestly.com/api-client/send-api-request/grpc-request.md): Learn how to create and invoke gRPC requests in Requestly using server reflection or a proto file, with support for unary and streaming methods.
- [SOAP Requests](https://docs.requestly.com/api-client/send-api-request/send-soap.md): Learn how to create and send SOAP requests in Requestly using XML bodies, endpoints, and variables.
- [WebSocket Request](https://docs.requestly.com/api-client/send-api-request/websocket-request.md): Open a WebSocket connection from Requestly, send and receive messages on a live timeline, and save reusable WebSocket requests in your collections.
- [Socket.IO Request](https://docs.requestly.com/api-client/send-api-request/socketio-request.md): Connect to a Socket.IO server from Requestly, emit named events with typed arguments, subscribe to inbound events, and read everything on a live timeline.
- [MQTT Request](https://docs.requestly.com/api-client/send-api-request/mqtt-request.md): Connect to an MQTT broker in Requestly, publish messages, subscribe to topic filters, and read the live message timeline.
- [Authorization](https://docs.requestly.com/api-client/send-api-request/authorization.md): Learn how to set up and use every API Authorization method in Requestly, including API Key, Bearer Token, Basic Auth, Digest, JWT Bearer, NTLM, OAuth 1.0, OAuth 2.0, Hawk, and AWS Signature v4.
- [Digest Auth](https://docs.requestly.com/api-client/send-api-request/authorization/digest.md): Authenticate requests with HTTP Digest access authentication (RFC 7616).
- [JWT Bearer](https://docs.requestly.com/api-client/send-api-request/authorization/jwt-bearer.md): Sign a fresh JSON Web Token on every send and attach it to the request.
- [NTLM](https://docs.requestly.com/api-client/send-api-request/authorization/ntlm.md): Authenticate against Windows and Active Directory endpoints with NTLM.
- [OAuth 1.0](https://docs.requestly.com/api-client/send-api-request/authorization/oauth1.md): Sign API requests with OAuth 1.0 using HMAC, RSA, or Plaintext signature methods.
- [OAuth 2.0](https://docs.requestly.com/api-client/send-api-request/authorization/oauth2.md): Acquire and attach OAuth 2.0 tokens across all six standard grant types, with built-in token caching and refresh.
- [Hawk](https://docs.requestly.com/api-client/send-api-request/authorization/hawk.md): Sign requests with a Hawk message authentication code.
- [AWS Signature v4](https://docs.requestly.com/api-client/send-api-request/authorization/aws-signature-v4.md): Sign requests to AWS services with Signature Version 4, or generate a presigned URL.
- [SSL Certificates](https://docs.requestly.com/api-client/send-api-request/ssl-certificates.md): Add custom CA certificates and per-host client certificates to authenticate against internal or mTLS-protected APIs in the Requestly desktop app.
- [Cookies](https://docs.requestly.com/api-client/send-api-request/cookies.md): Manage cookies for your API requests in Requestly. Cookies captured from responses are stored in a shared cookie jar and automatically attached to matching outgoing requests.
- [Filter a JSON Response](https://docs.requestly.com/api-client/send-api-request/filter-json-response.md): Narrow a JSON response in Requestly to just the values you care about using a JSONPath expression in the Preview view.
- [API Call History](https://docs.requestly.com/api-client/send-api-request/replay-request-from-history.md): Track and manage API requests with a clear, editable history view in the API Client.
- [API Collections](https://docs.requestly.com/api-client/api-collections.md): Organise and manage APIs with Requestly’s API Collections. Learn to create, rename, delete collections, use folders, and explore collection variables.
- [Create Request & Response Examples](https://docs.requestly.com/api-client/examples.md): Save, manage, and reuse examples in Requestly. Create snapshots of your API requests with different configurations for quick reuse.
- [Overview](https://docs.requestly.com/api-client/import-export.md): Learn how to import and export API collections, environments, and requests  in Requestly.
- [Import from cURL](https://docs.requestly.com/api-client/import-export/import-from-curl.md): Paste any cURL command into Requestly and convert it into a fully editable API request in seconds.
- [Import from postman](https://docs.requestly.com/api-client/import-export/import-from-postman.md): Learn how to migrate your Postman collections and environment variables to Requestly.
- [Import from Bruno](https://docs.requestly.com/api-client/import-export/import-from-bruno.md): Move a Bruno collection into Requestly, with its requests, environments, scripts, and client certificates.
- [Import SOAP requests from WSDL](https://docs.requestly.com/api-client/import-export/import-from-wsdl.md)
- [Import / Export OpenAPI Spec](https://docs.requestly.com/api-client/import-export/import-openapi-spec.md): Learn how to import OpenAPI Specification (Swagger) files to instantly generate API collections and environments.
- [Import / Export Collections](https://docs.requestly.com/api-client/import-export/import-export-api-collections.md)
- [Import / Export Environments](https://docs.requestly.com/api-client/import-export/import-export-api-environment.md)
- [Import from HAR](https://docs.requestly.com/api-client/import-export/import-from-har.md): Turn a HAR file captured from your browser's DevTools or a proxy tool into an editable Requestly collection.
- [Variables and Environment](https://docs.requestly.com/api-client/environments-and-variables.md): Learn how to use variables and environments in Requestly to manage dynamic values like API keys, base URLs, and tokens across your API requests.
- [Environment Variables](https://docs.requestly.com/api-client/environments-and-variables/environment-variables.md)
- [Collection & SubCollection Variables](https://docs.requestly.com/api-client/environments-and-variables/collection-and-subcollection-variables.md)
- [Global Variables](https://docs.requestly.com/api-client/environments-and-variables/global-variables.md): Learn about global variables in requestly
- [Runtime Variables](https://docs.requestly.com/api-client/environments-and-variables/runtime-variables.md)
- [Dynamic Variables](https://docs.requestly.com/api-client/environments-and-variables/dynamic-variables.md)
- [Variable Precedence](https://docs.requestly.com/api-client/environments-and-variables/variable-precedence.md)
- [Using Variables in API Requests](https://docs.requestly.com/api-client/environments-and-variables/using-variables-in-api-requests.md)
- [Set a Response Value as a Variable](https://docs.requestly.com/api-client/environments-and-variables/set-response-value-as-variable.md): Capture a value straight out of a response body into an environment, collection, or global variable by right-clicking the selection, with no script to write.
- [Overview](https://docs.requestly.com/api-client/vault/vault.md): Store sensitive values locally, pull secrets from external providers like AWS Secrets Manager, and reference them in your API requests without ever exposing credentials in collections, exports, or cloud sync.
- [AWS Secrets Manager](https://docs.requestly.com/api-client/vault/aws-secrets-manager.md): Connect your AWS account to fetch centrally managed secrets into the Requestly vault and reference them in API requests with the {{vault:key}} syntax.
- [Azure Key Vault](https://docs.requestly.com/api-client/vault/azure-key-vault.md): Connect an Azure service principal to pull secrets from one or more Azure key vaults into the Requestly vault and reference them in API requests with the {{vault:key}} syntax.
- [Generate API Test Cases using the Test Authoring Agent](https://docs.requestly.com/api-client/ai-test-generator.md): Learn how to automatically author Post-response API test scripts using the Test Authoring Agent in Requestly. Use natural language instructions to create reliable, comprehensive API tests without manually writing JavaScript.
- [Pre-request & Post-response Scripts](https://docs.requestly.com/api-client/scripts.md): Learn how to use JavaScript in Requestly to customize API requests, process responses, and interact with variables, with examples.
- [Code Snippets in Scripts](https://docs.requestly.com/api-client/script-snippets.md): Use built-in code snippets to quickly insert common patterns into your pre-request and post-response scripts in Requestly.
- [Writing Tests](https://docs.requestly.com/api-client/tests.md): Learn to write and execute API tests in Requestly using JavaScript, including validations like status code checks and JSON body tests.
- [DevTools](https://docs.requestly.com/api-client/devtools.md): Inspect script logs, network activity, and cookies from your API requests in a single panel inside the Requestly API Client.
- [Import packages into your scripts](https://docs.requestly.com/api-client/import-packages-into-your-scripts.md): Learn how to import external libraries in Requestly scripts using require to extend functionality with modules like moment, lodash, and uuid.
- [Collection Runner](https://docs.requestly.com/api-client/collection-runner.md): Learn how to run collections, configure iterations, delays, and environments, reorder or skip requests, view and debug results, and export run summaries
- [Run Collections with Custom Data](https://docs.requestly.com/api-client/collection-runner-data-file.md): Learn how to use CSV or JSON data files with the Requestly Collection Runner to iterate requests with multiple input values.
- [Scheduled Runs](https://docs.requestly.com/api-client/scheduled-runs.md): Run a collection automatically on a recurring schedule in the cloud, then review run history and per-request results.
- [CLI](https://docs.requestly.com/api-client/cli.md): Run HTTP and GraphQL collections from the command line using the Requestly CLI binary.
- [Run on CI/CD](https://docs.requestly.com/api-client/run-on-cicd.md): Generate a ready-to-commit GitHub Actions, GitLab CI, Jenkins, or Azure Pipelines file that runs your collections with the Requestly CLI.
- [Overview](https://docs.requestly.com/api-client/git/overview.md): Version-control a local project with Git from inside the Requestly desktop app: stage, commit, push, and pull your collections without leaving the editor.
- [Connect a project to Git](https://docs.requestly.com/api-client/git/connect-a-project.md): Initialize a Git repository inside an existing local project, or clone a repository into a new local project, from the Requestly desktop app.
- [Stage and commit changes](https://docs.requestly.com/api-client/git/commit-changes.md): Read the Git change list in the Requestly sidebar, stage or discard files by request or by collection, and record a commit without leaving the app.
- [Push and pull](https://docs.requestly.com/api-client/git/push-and-pull.md): Use the Sync section of the Requestly Git panel to fetch from the remote, read the ahead and behind counts, and push or pull a local project's commits.
- [Providers and authentication](https://docs.requestly.com/api-client/git/providers-and-authentication.md): Connect a GitHub or GitLab account to the Requestly desktop app, sign in by OAuth or a personal access token, browse your repositories, and reconnect when a credential is rejected.
- [Switch and create branches](https://docs.requestly.com/api-client/git/branches.md): Open the branch picker from the Requestly sidebar to switch branches, create one, resolve uncommitted changes during a switch, and delete a branch you no longer need.
- [Browse history and diffs](https://docs.requestly.com/api-client/git/history-and-diffs.md): Expand the Commits section of the Requestly Git panel to read a branch's history on a commit graph, and open a read-only diff tab for a commit or a changed file.
- [Stash changes](https://docs.requestly.com/api-client/git/stashes.md): Set uncommitted work aside in the Stashes section of the Requestly Git panel, apply a stash back, open its diff, drop it, and resolve a stash that applies with conflicts.
- [Resolve merge conflicts](https://docs.requestly.com/api-client/git/resolve-conflicts.md): Work through a merge that stopped on conflicting files from inside the Requestly desktop app: read the conflicted file list, pick a side per block in the merge editor, finish the merge, or abort it.
- [Manage remotes](https://docs.requestly.com/api-client/git/remotes.md): Open the Remotes tab in the Requestly desktop app to see the repository your local project pushes to, add one, correct its URL, or remove it.
- [Overview](https://docs.requestly.com/api-client/rq-api-reference/overview.md): Overview of the Requestly scripting reference: the rq object, pre-request and post-response scripts, and the Safe and Developer sandbox modes.
- [rq.collectionVariables (Collection variables)](https://docs.requestly.com/api-client/rq-api-reference/rq-collection-variables.md): Complete reference for the rq.collectionVariables object in Requestly scripts to manage collection-scoped variables dynamically.
- [rq.environment (Environment variables)](https://docs.requestly.com/api-client/rq-api-reference/rq-environment.md): Complete reference for the rq.environment object in Requestly scripts to manage environment variables dynamically during API request execution.
- [rq.execution (Execution control)](https://docs.requestly.com/api-client/rq-api-reference/rq-execution.md): Reference for the rq.execution namespace in Requestly scripts: read where a request sits, skip it, control collection-run order, and run another saved request.
- [rq.expect (Expect object)](https://docs.requestly.com/api-client/rq-api-reference/rq-expect.md): Complete reference for the rq.expect object in Requestly scripts to write assertions for API testing using Chai.js assertion library.
- [rq.globals (Global variables)](https://docs.requestly.com/api-client/rq-api-reference/rq-globals.md): Complete reference for the rq.globals object in Requestly scripts to manage global variables accessible across all collections and environments.
- [rq.info (Execution info)](https://docs.requestly.com/api-client/rq-api-reference/rq-info.md): Access metadata about the current script execution context in Requestly API client.
- [rq.iterationData (Iteration data)](https://docs.requestly.com/api-client/rq-api-reference/rq-iteration-data.md): Access data from CSV or JSON files during collection runs in Requestly API client scripts.
- [rq.request (Request object)](https://docs.requestly.com/api-client/rq-api-reference/rq-request.md): Complete reference for the rq.request object in Requestly scripts, including properties and methods to access.
- [rq.response (Response object)](https://docs.requestly.com/api-client/rq-api-reference/rq-response.md): Complete reference for the rq.response object in Requestly scripts, including properties and methods to access and process API response data.
- [rq.sendRequest (Send a request)](https://docs.requestly.com/api-client/rq-api-reference/rq-send-request.md): Reference for rq.sendRequest in Requestly scripts: send an HTTP request from a pre-request or post-response script and read the response.
- [rq.test (Test object)](https://docs.requestly.com/api-client/rq-api-reference/rq-test.md): Complete reference for the rq.test object in Requestly scripts to write and execute tests for your API requests and responses.
- [rq.variables (All scopes)](https://docs.requestly.com/api-client/rq-api-reference/rq-variables.md): Complete reference for the rq.variables object in Requestly scripts, which reads a variable from whichever scope defines it and writes to the runtime scope.
- [rq.vault (Vault object)](https://docs.requestly.com/api-client/rq-api-reference/rq-vault.md): Complete reference for the rq.vault object in Requestly scripts to read encrypted secrets from the local vault and AWS Secrets Manager.
- [rq.visualizer (Response visualization)](https://docs.requestly.com/api-client/rq-api-reference/rq-visualizer.md): Render a custom visualization of an API response - charts, tables, or formatted HTML - from a pre-request or post-response script with rq.visualizer.set().
- [API Design](https://docs.requestly.com/api-client/api-design/overview.md): Write and edit OpenAPI specifications inside Requestly, with a project-wide library of reusable schemas, parameters, and responses.
- [Create and Edit a Specification](https://docs.requestly.com/api-client/api-design/create-and-edit-a-specification.md): Write an OpenAPI 3.x document in Requestly with key completion, an outline that tracks your cursor, $ref navigation, and a live documentation preview.
- [Component Library](https://docs.requestly.com/api-client/api-design/component-library.md): Keep schemas, parameters, responses, and other OpenAPI components in one place per project and reference them from any specification with $ref.
- [Issues & Governance](https://docs.requestly.com/api-client/api-design/issues-and-governance.md): Read the Issues panel of a specification, understand which severities block actions, and suppress a governance rule you do not want to follow.
- [Sync a Collection from a Specification](https://docs.requestly.com/api-client/api-design/sync-a-collection-from-a-specification.md): Generate a runnable API collection from an OpenAPI specification, then keep it in step with the spec using Update Collections.
- [Versions & Releases](https://docs.requestly.com/api-client/api-design/versions-and-releases.md): Release an immutable snapshot of an OpenAPI specification, where the version number comes from the spec's own info.version field.
- [Publish API Documentation](https://docs.requestly.com/api-client/api-design/publish-api-docs.md): Publish a collection's API documentation to a shareable URL with public, internal or password access, republish it after a release, and unpublish it again.
- [Introduction](https://docs.requestly.com/api-client/mock-server.md): Create a mock server in the Requestly API Client to serve sample HTTP responses from a hosted URL, with routes, multiple responses, and request-matching rules.
- [From a Collection](https://docs.requestly.com/api-client/mock-server/create-from-collection.md): Turn a collection in the Requestly API Client into a running mock server, where every HTTP request becomes a route and every saved example becomes a served response.
- [From an OpenAPI File](https://docs.requestly.com/api-client/mock-server/create-from-openapi.md): Import an OpenAPI or Swagger file in the Requestly API Client and generate a running mock server from it in the same step, keeping the imported collection either way.
- [Routes](https://docs.requestly.com/api-client/mock-server/routes.md): Match incoming requests in a Requestly mock server by method and path, capture path parameters, use wildcards, and control route ordering when two routes overlap.
- [Responses and selection modes](https://docs.requestly.com/api-client/mock-server/responses.md): Configure a Requestly mock route's responses - body, status, latency, headers, and dynamic values - and choose how the mock picks which response to serve.
- [Matching rules](https://docs.requestly.com/api-client/mock-server/rules.md): Add request-matching rules to a Requestly mock response so it is served only when the incoming request's query, header, body, cookie, or URL parameter matches.
- [Private Mocks](https://docs.requestly.com/api-client/mock-server/private-mocks.md): Require a secret token on a Requestly cloud mock so only callers sending the x-api-key header can reach it, and rotate or revoke that token at any time.
- [Request Logs](https://docs.requestly.com/api-client/mock-server/logs.md): See every call a Requestly cloud mock received, why each one matched or did not, and the full request and response behind it.
- [Introduction](https://docs.requestly.com/collaboration/workspaces.md): Learn about projects and workspaces in Requestly, how to organize your rules, mocks, and API requests and collaborate with your team.
- [Local project](https://docs.requestly.com/collaboration/local-workspace.md): Learn how to set up local projects in Requestly
- [Working with multiple projects](https://docs.requestly.com/collaboration/multiple-workspaces.md)
- [Team projects](https://docs.requestly.com/collaboration/how-to-get-started-with-shared-workspace.md): Learn how to set up a team project in Requestly
- [Managing your project](https://docs.requestly.com/collaboration/how-to-get-started-with-shared-workspace/managing-workspace.md): Learn how to manage projects in Requestly
- [User Roles and Permissions](https://docs.requestly.com/collaboration/how-to-get-started-with-shared-workspace/user-roles.md): Learn how to manage team collaboration securely in Requestly with Role-Based Access Control (RBAC) by defining roles and setting permissions.
- [Billing & Subscriptions](https://docs.requestly.com/account/billing-subscriptions.md): Learn how to manage billing teams, assign licenses, update payment info, and view billing history with Requestly's easy-to-use tools.
- [Organization resources](https://docs.requestly.com/account/organization-resources.md): Control what your organization's members can do in Requestly: which external packages scripts may import, and whether members can leave Safe mode.
- [Data residency](https://docs.requestly.com/account/data-residency.md): Why the Requestly desktop and web apps show a data-residency compliance screen for some BrowserStack organizations, and where Requestly runs.
- [AI features and your data](https://docs.requestly.com/account/ai-and-your-data.md): What Requestly sends to its AI service when you use the AI Assistant or the Test Authoring Agent, what is masked before it leaves your machine, and what you should keep out of AI features entirely.
- [Data Recovery Policy](https://docs.requestly.com/account/data-recovery.md): How Requestly retains and recovers deleted projects, collections, requests, and environments.
- [How is the Browser Extension Different from the Desktop App](https://docs.requestly.com/account/how-is-browser-extension-different-from-a-desktop-app.md)
- [Set up Microsoft Entra ID](https://docs.requestly.com/account/sso/how-to-set-up-sso-with-microsoft-entra-id.md): Set up SSO with Microsoft Entra ID
- [SAML SSO with Okta](https://docs.requestly.com/account/sso/setup-sso-with-okta.md)
- [Deploy on Windows](https://docs.requestly.com/account/enterprise-deployment/deploy-windows-msix.md): Deploy the Requestly API Client to Windows devices as an MSIX package, and control its automatic updates with a policy.
- [Changelogs](https://docs.requestly.com/changelogs.md): What's new in the Requestly API Client, grouped by desktop release.

## Optional

- [HTTP Interceptor](https://interceptor-docs.requestly.com)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.