Skip to main content
PATCH
Update uptime monitor

Authorizations

Authorization
string
header
required

API key sent as Authorization: Bearer <key>. Personal keys (gm_pat_) act as you, limited by your role and the key's scopes; organization keys (gm_api_) act for one organization. Send X-Organization-Id with every org-scoped request.

Headers

X-Organization-Id
string
required

ID of the organization to act in. Required with API keys. A user session may omit it and acts in its active organization.

Example:

"k2p9x7w4m1n8b3v6c5z0q2r7"

Path Parameters

id
string
required

Uptime monitor ID.

Body

application/json

All fields are optional; only the ones sent are changed.

name
string

Display name.

Minimum string length: 1
Example:

"Production API"

targetUrl
string<uri>

URL to check. Must be a valid URL.

Example:

"https://api.example.com/health"

checkType
enum<string>

UPTIME checks the status code; CONTENT also looks for content in the response body.

Available options:
UPTIME,
CONTENT
expectedResponseCode
string

Expected status code or class. Default 2xx.

Example:

"2xx"

followRedirects
boolean

Follow HTTP redirects.

contentAlert
enum<string>

For CONTENT checks: alert when content is NOT_FOUND or when it is FOUND.

Available options:
NOT_FOUND,
FOUND
content
string

Text to look for in the response body (CONTENT checks).

body
string | null

Request body sent with POST/PUT/PATCH checks.

timeout
enum<string>

Request timeout. Default 30 sec.

Available options:
5 sec,
15 sec,
30 sec,
60 sec
alertSensitivity
enum<string>

Retries before a failure alerts. Default None.

Available options:
None,
1 retry,
2 retries,
3 retries
httpMethod
enum<string>

HTTP method. Default GET.

Available options:
GET,
POST,
PUT,
PATCH
headers
object[]

Extra request headers.

username
string

HTTP Basic auth username.

password
string

HTTP Basic auth password. Write-only: responses never include it. Omit to keep the saved password; send an empty string to remove it.

regions
enum<string>[]

Regions to check from. Currently us-east-1 (all plans) and sa-east-1 (Trial, Pro and Business). The number of regions is capped by your plan.

Available options:
us-east-1,
sa-east-1
Example:
isActive
boolean

Set false to pause checks, true to resume.

Response

OK

id
string
required
organizationId
string
required
userId
string
required
name
string
required
type
string
required
isActive
boolean
required
currentStatus
string
required
lastEventAt
string | null
required
checkIntervalSeconds
string | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
uptimeMonitor
object
required
monitorId
string
required
targetUrl
string
required
checkType
string
required
expectedResponseCode
string
required
followRedirects
boolean
required
contentAlert
string
required
content
string | null
required
timeout
string
required
alertSensitivity
string
required
httpMethod
string
required
body
string | null
required
headers
any[]
required
username
string | null
required
regions
string[]
required