GET /api/remote/status Bearer

Get Tunnel Status

Check if a Cloudflare tunnel is currently active and retrieve its public URL. Tunnels provide HTTPS access to PocketPaw's local server for WhatsApp webhooks and remote access.

Overview

Returns the current status of the Cloudflare tunnel (used for remote access to the dashboard without port forwarding).

Response

active boolean

Whether a tunnel is currently running

url string nullable

The public tunnel URL (e.g., https://abc-xyz.trycloudflare.com)

curl -X GET "http://localhost:8000/api/remote/status" \
  -H "Authorization: Bearer <token>"

const response = await fetch("http://localhost:8000/api/remote/status", {
  headers: { "Authorization": "Bearer <token>" }
});
const data = await response.json();
console.log(data);

import requests

response = requests.get(
    "http://localhost:8000/api/remote/status",
    headers={"Authorization": "Bearer <token>"}
)
print(response.json())

{
  "active": true,
  "url": "https://steep-mountain-abc123.trycloudflare.com"
}

{
  "active": false,
  "url": null
}

Was this page helpful?

Request

curl -X GET "http://localhost:8000/api/remote/status" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>"

const response = await fetch("http://localhost:8000/api/remote/status", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
},
});

const data = await response.json();
console.log(data);

import requests

response = requests.get(
    "http://localhost:8000/api/remote/status",
    headers={'Content-Type':'application/json','Authorization':'Bearer <token>'},
)

print(response.json())

package main

import (
    "fmt"
    "net/http"
    "io"
)

func main() {
    req, _ := http.NewRequest("GET", "http://localhost:8000/api/remote/status", nil)
    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer <token>")

    client := &http.Client{}
    resp, _ := client.Do(req)
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

Response
Send a request to see the response