Update an uptime monitor (HTTP, TCP port or ping).

PUT

/http/job/{job_id}

curl --request PUT \
  --url https://api.siteqwality.com/http/job/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "check_regions": [ "example" ], "min_healthy_regions": 1, "friendly_name": "example", "follow_redirects": true, "final_uri": "example", "method": "example", "keyword_search": "example", "keyword_search_inverted": true, "keyword_search_case_sensitive": true, "keyword_search_regex": true, "timeout_ms": 1, "uri": "example", "request_body": "example", "content_type": "json", "auth_type": "basic", "auth_username": "example", "auth_password": "example", "auth_bearer_token": "example", "success_http_codes": [ 1 ], "failure_http_codes": [ 1 ], "custom_http_headers": "example", "run_interval_seconds": 1, "run_interval_thirty_seconds": true, "group_notification_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "monitor_tls": true, "monitor_dns": true, "monitor_page_speed": true, "state": "active", "tags": [ "example" ], "http_version": "auto", "confirmation_threshold": 1, "json_path": "example", "json_path_expected": "example", "tls_port": 1, "alert_on_invalid_certificate": true, "recovery_period_runs": 1, "flap_hold": true, "flap_hold_override": true, "trace_propagation": true, "service_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "check_type": "http", "tcp_send": "example", "tcp_expect": "example", "tcp_tls": true, "ping_count": 1, "ping_loss_threshold": 1, "recheck_on_failure": "off", "web_bot_auth": true }'

• Production

check_type is fixed at create; uri and the type-specific fields follow the stored type.

Authorizations

• bearer_auth

Parameters

Path Parameters

job_id

required

string format: uuid

HTTP monitor identifier

Request Body ^required

Media type application/json

object

check_regions

array | null

min_healthy_regions

integer | null format: int32

friendly_name

string | null

follow_redirects

boolean | null

final_uri

string | null

method

string | null

keyword_search

string | null

keyword_search_inverted

boolean | null

keyword_search_case_sensitive

boolean | null

keyword_search_regex

boolean | null

timeout_ms

integer | null format: int32

uri

string | null

request_body

string | null

content_type

One of:

string

Absent keeps it; null removes it.

string

Allowed values: json xml form_url_encoded text

null

null

auth_type

One of:

string

Absent keeps it; null turns authentication off.

string

Allowed values: basic digest bearer

null

null

auth_username

string | null

auth_password

string | null

auth_bearer_token

string | null

success_http_codes

array | null

failure_http_codes

array | null

custom_http_headers

Replaces the stored headers. Absent keeps them; null or {} removes them.

object | null

run_interval_seconds

integer | null format: int32

run_interval_thirty_seconds

boolean | null

group_notification_ids

array | null

monitor_tls

boolean | null

monitor_dns

boolean | null

monitor_page_speed

boolean | null

state

One of:

string

string

Allowed values: active paused

null

null

tags

array | null

http_version

One of:

string

Preferred HTTP version for the check client.

string

Allowed values: auto http1_1 http2 http2_with_fallback

null

null

confirmation_threshold

Number of consecutive failed checks (1-10) required before the monitor is considered down and notifications are sent.

integer | null format: int32

json_path

string | null

json_path_expected

string | null

tls_port

Port the TLS check connects to, 1 to 65535. Omitted keeps the stored port (443 for a new TLS check). Needs monitor_tls.

integer | null format: int32

alert_on_invalid_certificate

Alert when the certificate is one a browser would reject. Omitted keeps the stored setting (true for a new TLS check). Ignored without monitor_tls.

boolean | null

recovery_period_runs

Healthy runs in a row (1-10) before a recovery is notified.

integer | null format: int32

flap_hold

Deprecated: sets flap_hold_override when that is absent.

boolean | null

flap_hold_override

Absent leaves it unchanged; null follows the account’s notification setting.

boolean | null

trace_propagation

boolean | null

service_id

The service this monitor belongs to; null detaches it and omission keeps it.

string | null format: uuid

check_type

One of:

string

The monitor’s own check_type may be sent back; any other is a 400 (it is fixed).

string

Allowed values: http tcp ping

null

null

tcp_send

tcp only. Absent keeps it; null or "" sends nothing.

string | null

tcp_expect

tcp only. Absent keeps it; null or "" makes connecting enough.

string | null

tcp_tls

tcp only.

boolean | null

ping_count

ping only, 1 to 10.

integer | null format: int32

ping_loss_threshold

ping only, 1 to 100.

integer | null format: int32

recheck_on_failure

One of:

string

Check a failed run once more before it counts. Absent leaves it unchanged; another_cloud needs a paid plan.

string

Allowed values: off same_location another_cloud

null

null

web_bot_auth

http only. Sign check requests with Web Bot Auth. Absent leaves it unchanged.

boolean | null

Responses

200

HTTP monitor updated

400

Invalid request body

401

Missing or invalid authentication

402

Resuming needs a paid plan or a free monitor slot

403

Feature requires a paid plan

404

HTTP monitor or service not found

500

Internal server error