Get subscription

GET

/subscriptions/{id}

const url = 'https://app.tunnelhq.com/api/v1/subscriptions/3';
const options = {method: 'GET', headers: {'X-Project-Id': 'prj_12', 'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://app.tunnelhq.com/api/v1/subscriptions/3 \
  --header 'X-API-Key: <X-API-Key>' \
  --header 'X-Project-Id: prj_12'

Returns one subscription URL’s settings and last sync. Any role in the project can call it.

Need an API key? See Getting an API key.

Authorizations

ApiKeyHeader
BearerAuth

Parameters

Path Parameters

required

integer

The subscription’s number, such as 3. The sub_3 form that monitors show isn’t accepted here.

Example

Header Parameters

X-Project-Id

required

string

The project, as prj_12 or 12. A workspace key can only reach its own workspace’s projects.

Example

prj_12

Responses

200

The subscription.

application/json

A subscription URL’s settings and last sync. The URL itself isn’t returned. Note the camelCase field names.

object

required

integer

projectId

required

integer

name

required

string | null

syncIntervalSec

required

Seconds between syncs.

integer

timeoutSeconds

required

Seconds each server’s test may take.

integer

maxWorkers

required

Servers tested at the same time.

integer

engine

required

The engines tried on each config; both unless changed in the dashboard.

string

enabled

required

boolean

lastSyncedAt

required

In UTC, as YYYY-MM-DD HH:MM:SS. null before the first sync.

string | null

lastServerCount

required

Servers found in the last sync.

integer | null

lastSyncStatus

required

auto_disabled means TunnelHQ switched the subscription off after it kept failing.

string | null

Allowed values: pending success failed auto_disabled

syncErrorMessage

required

string | null

createdAt

required

In UTC, as YYYY-MM-DD HH:MM:SS.

string

updatedAt

required

In UTC, as YYYY-MM-DD HH:MM:SS.

string

Example

{
  "id": 3,
  "projectId": 12,
  "name": "Provider feed",
  "syncIntervalSec": 1800,
  "timeoutSeconds": 30,
  "maxWorkers": 5,
  "engine": "both",
  "enabled": true,
  "lastSyncedAt": "2026-09-25 14:00:05",
  "lastServerCount": 14,
  "lastSyncStatus": "success",
  "syncErrorMessage": null,
  "createdAt": "2026-09-01 09:12:44",
  "updatedAt": "2026-09-25 14:00:05"
}

Headers

X-RateLimit-Limit

integer

Requests the workspace’s plan allows per minute.

X-RateLimit-Remaining

integer

Requests left in the current minute.

X-RateLimit-Reset

integer

Unix time, in seconds, when the current minute ends.

400

The subscription ID isn’t a number, or the X-Project-Id header is missing or malformed.

application/json

object

error

required

boolean

code

required

The HTTP status, repeated.

integer

message

required

What went wrong.

string

details

More detail, on some errors.

retry_after

Seconds to wait, on the 429 for wrong keys.

integer

Examples

{
  "error": true,
  "code": 400,
  "message": "Invalid subscription ID"
}

{
  "error": true,
  "code": 400,
  "message": "X-Project-Id header is required (e.g. prj_1 or numeric id)"
}

401

The API key is missing, wrong, expired, switched off, or no longer valid.

application/json

object

error

required

boolean

code

required

The HTTP status, repeated.

integer

message

required

What went wrong.

string

details

More detail, on some errors.

retry_after

Seconds to wait, on the 429 for wrong keys.

integer

Examples

{
  "error": true,
  "code": 401,
  "message": "API key is required. Provide X-API-Key header or Authorization: Bearer <key>"
}

{
  "error": true,
  "code": 401,
  "message": "Invalid or expired API key"
}

{
  "error": true,
  "code": 401,
  "message": "API key has expired"
}

{
  "error": true,
  "code": 401,
  "message": "API key owner account is inactive"
}

{
  "error": true,
  "code": 401,
  "message": "This API key's workspace access has been removed"
}

403

The key can’t reach this project.

application/json

object

error

required

boolean

code

required

The HTTP status, repeated.

integer

message

required

What went wrong.

string

details

More detail, on some errors.

retry_after

Seconds to wait, on the 429 for wrong keys.

integer

Examples

{
  "error": true,
  "code": 403,
  "message": "This API key is scoped to a different organization"
}

{
  "error": true,
  "code": 403,
  "message": "You do not have access to this project"
}

404

The project has no such subscription.

application/json

object

error

required

boolean

code

required

The HTTP status, repeated.

integer

message

required

What went wrong.

string

details

More detail, on some errors.

retry_after

Seconds to wait, on the 429 for wrong keys.

integer

Example

{
  "error": true,
  "code": 404,
  "message": "Subscription not found"
}

429

A usage limit was reached, or this IP address made too many requests with a wrong key.

Usage limits are per workspace and plan: per minute (Retry-After: 60), per day (Retry-After: 3600), and per month (no Retry-After). They use their own body shape. An IP address may send 10 wrong keys a minute; one more is allowed every 6 seconds. While that allowance is used up, every request from the address is refused, even one with a valid key.

application/json

One of:

object
object

object

error

required

string

Allowed values: Rate limit exceeded Daily limit exceeded Monthly limit exceeded

message

required

string

retry_after

Seconds to wait. Absent for the monthly limit.

integer

Examples

{
  "error": "Rate limit exceeded",
  "message": "Per-minute limit of 60 requests exceeded",
  "retry_after": 60
}

{
  "error": "Daily limit exceeded",
  "message": "Daily limit of 25000 requests exceeded",
  "retry_after": 3600
}

{
  "error": "Monthly limit exceeded",
  "message": "Monthly limit of 250000 requests exceeded"
}

{
  "error": true,
  "code": 429,
  "message": "Too many failed API key attempts from this address. Wait a few seconds and try again.",
  "retry_after": 6
}

Headers

Retry-After

integer

Seconds to wait. 60 for the per-minute limit, 3600 for the daily limit, 6 after wrong keys. Absent for the monthly limit.

500

Something failed on TunnelHQ’s side.

application/json

object

error

required

boolean

code

required

The HTTP status, repeated.

integer

message

required

What went wrong.

string

details

More detail, on some errors.

retry_after

Seconds to wait, on the 429 for wrong keys.

integer

Example

{
  "error": true,
  "code": 500,
  "message": "Internal server error"
}