Grifn Tunnel Service

This service enables Grifn app servers to be accessible from the internet by creating secure tunnels from the local device to the public internet.

API Endpoints

Test API Connection

Endpoint: /api

Method: GET

Description: Simple endpoint to test if the API is working.

Validate API Key

Endpoint: /api/validate-key

Method: POST

Headers: Authorization: Bearer <api_key>

Description: Validates an API key.

Create Tunnel

Endpoint: /api/tunnels

Method: POST

Headers: Authorization: Bearer <api_key>

Body: { "localPort": 3000, "localIp": "192.168.1.100" }

Description: Creates a new tunnel.

List Tunnels

Endpoint: /api/tunnels

Method: GET

Headers: Authorization: Bearer <api_key>

Description: Lists all active tunnels.

Close Tunnel

Endpoint: /api/tunnels/:tunnelId

Method: DELETE

Headers: Authorization: Bearer <api_key>

Description: Closes a specific tunnel.