All Insomnia Documentation

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

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 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.

Import existing Insomnia content from a Git repository.

This page is an introduction to API testing in Insomnia.

This page is an introduction to mock servers 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.

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.

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 single sign-on (SSO) with Okta.

Find additional resources that explain how Insomnia prioritizes data protection through encryption, product and application security, and organizational measures.

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.

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

Learn how to manage your Insomnia account and organization

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

Configure environment variables to reuse values across multiple requests.

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

Set up Git Sync for your Insomnia workspace.

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.