Run in Insomnia

Uses: Insomnia

Overview

Use the https://app.insomnia.rest/run URL scheme to deep-link into the Insomnia desktop app and open a pre-imported request. You can embed this URL as a button or link in documentation, readme.md, or API references.

URL parameters

Parameter

Description

specUrl A full URL to an OpenAPI specification in raw JSON or YAML format
endpoint A {method},{specPath} pair (e.g. GET,/api/v1/users/{userId})
operationId An operation ID from an OpenAPI specification (e.g. get-flight-by-number)
curl A url-encoded cURL command to be imported as a single request
mcp A full URL to an MCP server endpoint (e.g. https://mcp.slack.com/mcp)

Example

https://app.insomnia.rest/run?endpoint=GET,/flights/{flightNumber}&specUrl=https://raw.githubusercontent.com/Kong/KongAir/refs/heads/main/flight-data/flights/openapi.yaml

Embedding the URL

<a href="https://app.insomnia.rest/run?endpoint=GET,/flights/{flightNumber}&specUrl=https://raw.githubusercontent.com/Kong/KongAir/refs/heads/main/flight-data/flights/openapi.yaml">Run in Insomnia</a>
[Run in Insomnia](https://app.insomnia.rest/run?endpoint=GET,/flights/{flightNumber}&specUrl=https://raw.githubusercontent.com/Kong/KongAir/refs/heads/main/flight-data/flights/openapi.yaml)

Markdown image button

[![Run in Insomnia](https://insomnia.rest/images/run.svg)](https://app.insomnia.rest/run?endpoint=GET,/flights/{flightNumber}&specUrl=https://raw.githubusercontent.com/Kong/KongAir/refs/heads/main/flight-data/flights/openapi.yaml)

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!