Skip to main content

​
Get public URL

Retrieves the current public URL configured for the Syft Space server.

​
Endpoint

GET /api/v1/settings/public-url

​
Authentication

Requires authentication via bearer token (admin API key).

​
Response

​
public_url
string | null
The public URL for the server. Returns null if no public URL is configured.

​
Example request

curl -X GET https://your-server.com/api/v1/settings/public-url \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Example response

{
  "public_url": "https://my-server.example.com"
}

​
Get proxy status

Retrieves the current status of the ngrok proxy tunnel connection.

​
Endpoint

GET /api/v1/settings/proxy

​
Authentication

Requires authentication via bearer token (admin API key).

​
Response

​
connected
boolean
required
Whether the proxy tunnel is currently connected.
​
public_url
string | null
The public URL of the tunnel if connected, otherwise null.
​
has_token
boolean
required
Whether an ngrok authentication token is configured.

​
Example request

curl -X GET https://your-server.com/api/v1/settings/proxy \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Example response

{
  "connected": true,
  "public_url": "https://abc123.ngrok.app",
  "has_token": true
}

​
Example response (disconnected)

{
  "connected": false,
  "public_url": null,
  "has_token": false
}

Build docs developers (and LLMs) love

Get started for freeTalk to us