Hookbase Tunnels API

The Tunnels API from Hookbase — 4 operation(s) for tunnels.

Operations 7

POST /api/tunnels Create Tunnel #
GET /api/tunnels List Tunnels #
GET /api/tunnels/{tunnelId} Get Tunnel #
PATCH /api/tunnels/{tunnelId} Update Tunnel #
DELETE /api/tunnels/{tunnelId} Delete Tunnel #
GET /api/tunnels/{tunnelId}/status Get Tunnel Status #
POST /api/tunnels/{tunnelId}/regenerate-token Regenerate Tunnel Token #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/hookbase:hookbase-tunnels-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

hookbase-tunnels-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Hookbase Tunnels API
  version: 1.0.0
  description: Official OpenAPI 3.0 specification for the Hookbase webhook relay platform. Generated from the maintained Postman collection. Authenticate with an API key (whr_ prefix) as a Bearer token.
  contact:
    name: Hookbase
    url: https://www.hookbase.app
servers:
- url: https://api.hookbase.app
  description: Production
security:
- bearerAuth: []
tags:
- name: Tunnels
paths:
  /api/tunnels:
    post:
      tags:
      - Tunnels
      summary: Create Tunnel
      operationId: tunnels_create_tunnel
      responses:
        '200':
          description: Successful response
      description: Create a tunnel for forwarding webhooks to a local/dev environment.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Required. Tunnel name.
                direction:
                  type: string
                  description: Optional. inbound | bidirectional (default inbound).
                allowedHosts:
                  type: array
                  items:
                    type: string
                  description: Optional. Allowed forward hosts (max 20).
                subdomain:
                  type: string
                  description: Optional. Requested subdomain (auto-generated if omitted).
              required:
              - name
            example:
              name: Local dev
              direction: inbound
              allowedHosts:
              - localhost:3000
              subdomain: acme-dev
    get:
      tags:
      - Tunnels
      summary: List Tunnels
      operationId: tunnels_list_tunnels
      responses:
        '200':
          description: Successful response
      description: List tunnels for the org.
  /api/tunnels/{tunnelId}:
    get:
      tags:
      - Tunnels
      summary: Get Tunnel
      operationId: tunnels_get_tunnel
      parameters:
      - name: tunnelId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Fetch a single tunnel.
    patch:
      tags:
      - Tunnels
      summary: Update Tunnel
      operationId: tunnels_update_tunnel
      parameters:
      - name: tunnelId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Update a tunnel. All fields optional.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Optional. Tunnel name.
                direction:
                  type: string
                  description: Optional. inbound | bidirectional.
                allowedHosts:
                  type: array
                  items:
                    type: string
                  description: Optional. Allowed forward hosts (max 20).
            example:
              name: Local dev
              direction: inbound
              allowedHosts:
              - localhost:3000
    delete:
      tags:
      - Tunnels
      summary: Delete Tunnel
      operationId: tunnels_delete_tunnel
      parameters:
      - name: tunnelId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Delete a tunnel by id.
  /api/tunnels/{tunnelId}/status:
    get:
      tags:
      - Tunnels
      summary: Get Tunnel Status
      operationId: tunnels_get_tunnel_status
      parameters:
      - name: tunnelId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Return the tunnel's live connection status.
  /api/tunnels/{tunnelId}/regenerate-token:
    post:
      tags:
      - Tunnels
      summary: Regenerate Tunnel Token
      operationId: tunnels_regenerate_tunnel_token
      parameters:
      - name: tunnelId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      description: Issue a new connection token for the tunnel (invalidates the old one).
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Hookbase API key with the whr_ prefix.