Get a maintenance window

GET

/maintenance/{id}

const url = 'https://app.tunnelhq.com/api/v1/maintenance/mnt_4';
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/maintenance/mnt_4 \
  --header 'X-API-Key: <X-API-Key>' \
  --header 'X-Project-Id: prj_12'

One window. Any role in the project can call it.

Need an API key? See Getting an API key.

Authorizations

ApiKeyHeader
BearerAuth

Parameters

Path Parameters

required

string

The window’s id (mnt_4), from List maintenance windows. The bare number (4) works too.

Example

mnt_4

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 window.

application/json

object

required

string

title

required

string

description

required

The note shown with it; empty for none.

string

active

required

false while it is paused.

boolean

status

required

running now, scheduled for later, ended, or paused. A weekly window can read unknown for a moment while the server schedules it.

string

Allowed values: running scheduled ended paused

repeat

required

string

Allowed values: once weekly

start

required

YYYY-MM-DDTHH:mm for once, HH:mm for weekly, in timezone.

string

end

required

Like start.

string

days

required

The weekdays a weekly window runs; empty for once.

Array<string>

Allowed values: sun mon tue wed thu fri sat

timezone

required

string

scope

required

string

Allowed values: monitors tunnels uptime all

monitor_ids

required

The monitors and groups it covers, for scope: monitors; empty otherwise.

Array<string>

current

required

One of:

object
null

object

start

required

In UTC.

string format: date-time

end

required

In UTC.

string format: date-time

next

required

One of:

object
null

object

start

required

In UTC.

string format: date-time

end

required

In UTC.

string format: date-time

Examples

default

A one-time window

{
  "id": "mnt_4",
  "title": "Frankfurt servers upgrade",
  "description": "",
  "active": true,
  "status": "scheduled",
  "repeat": "once",
  "start": "2026-11-12T02:00",
  "end": "2026-11-12T04:00",
  "days": [],
  "timezone": "Europe/Berlin",
  "scope": "monitors",
  "monitor_ids": [
    "srv_42",
    "srv_43"
  ],
  "current": null,
  "next": {
    "start": "2026-11-12T01:00:00.000Z",
    "end": "2026-11-12T03:00:00.000Z"
  }
}

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.

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"
}

404

The project has no maintenance window with this ID.

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": "No such maintenance in this project."
}

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"
}