All Insomnia Documentation

Introduction to Insomnia, the open source desktop application that simplifies designing, debugging, and testing APIs.

Learn how to manage Insomnia accounts, organizations, users, and security.

Learn more about the features available in the Insomnia Enterprise plan.

This page is an introduction to request collections in Insomnia

This page is an introduction to design documents in Insomnia.

API specifications explain how an API behaves and how it interacts with other APIs.

Learn how to configure external vault integrations in Insomnia using AWS, GCP, Azure, and HashiCorp vault providers.

Insomnia offers various storage options to cater to different user needs and preferences.

This page defines terminology and concepts related to Insomnia.

Introduction to API design in Insomnia.

Create a design document in the Insomnia app by going to Create > Design document.

Learn how to add custom linting rules to your APIs in Insomnia.

Import an API specification into Insomnia from a file, URL, or your clipboard.

Learn how to generate a request collection from an existing design document.

This page is an introduction to API testing in Insomnia.

This page is an introduction to mock servers in Insomnia.

Learn how to write pre-request and after-response scripts in Insomnia.

Learn how to write content type tests in Insomnia.

Learn how to write data type tests in Insomnia.

Learn how to write header tests in Insomnia.

Learn how to write HTTP status code tests in Insomnia.

Create a cloud-hosted mock server in your Insomnia project by choosing the Cloud Mock option.

Automate tests written in Insomnia using the Inso CLI.

Insomnia allows you to configure and send different types of requests.

Write a pre-request script to dynamically set a variable in a request.

Reuse content from a response in another request through Insomnia.

Use the Collection Runner to run multiple requests in a specific order.

Learn how to write, send, and debug GraphQL queries in Insomnia using the built-in query editor, variable section, and schema introspection.

Send a request, then create an after-response script to get the value you want to use and set it as an environment variable.

Insomnia allows you to configure and send different types of requests.

This page is an introduction to Insomnia plugins.

Create a NodeJS module in the Insomnia plugins directory and add it to Insomnia.

Learn about Insomnia's plugin context that allow plugins to interact with requests, responses, the app UI, and stored data.

Context methods provide helpers for plugins to communicate, interact, and integrate with Insomnia.

Hooks and actions allow you to add additional functionality to your custom plugins through requests, responses, and UI interactions.

Secure Insomnia with native or external authentication and authorization.

Insomnia allows admins to scope user access with Role-Based Access Control.

Learn what request authentication is and how to authenticate requests in Insomnia.

Configure SSO with SAML 2.0 and Azure in Insomnia.

Learn how to secure Insomnia by setting up OIDC single sign-on (SSO) with Okta.

Learn how to secure Insomnia by setting up SAML single sign-on (SSO) with Okta.

Learn how to set up SCIM to manage Insomnia users and teams with Azure.

Learn how to set up SCIM to manage Insomnia users and teams with Okta.

Learn how to manage your Insomnia Enterprise account.

Learn how to manage your Insomnia Enterprise users and licenses.

Learn how to configure SSO for your Enterprise account.

Learn how to configure SCIM provisioning for your Enterprise account.

Learn how E2EE works in Insomnia.

Learn the options that Insomnia offers to encrypt and store encrypted data.

Insomnia collects usage analytics data to help improve the application.

We monitor the security of our products and applications through various ongoing activities, including logs.

Use the Insomnia 1Password plugin to retrieve secrets from a 1Password vault and use them in your requests.

This page is an introduction to Inso CLI, a command line tool for Insomnia.

Inso CLI can be configured with a configuration file, allowing you to specify options and scripts.

Inso CLI is designed to run in a Continuous Integration (CI) environment.

Inso CLI is available as a Docker image.

Kong provides a software bill of materials (SBOM) for Inso CLI.

Kong produces build provenance for Inso CLI binary artifacts, which can be verified.

Kong produces build provenance for Inso CLI Docker images artifacts, which can be verified.

Inso CLI Docker container images are signed using cosign with signatures published to a Docker Hub repository.

Learn how to manage your Insomnia account.

A reference of domains to allowlist to ensure Insomnia is operating correctly within your organization.

Define variables dynamically using scripts and iteration data.

Configure environment variables to reuse values across multiple requests.

Kong provides a software bill of materials (SBOM) for Insomnia

Learn how to manage your Insomnia organizations.

Create a new Insomnia project and enable Git Sync.

Kong produces build provenance for Insomnia application binary artifacts, which can be verified.

Insomnia allows you to manage versions of collections, mock servers, design documents, and global environments in Insomnia, both with cloud sync and git sync.