PATCH /projects/{project}/probes/{probeId}

Endpoint

PATCH /api/v1/projects/{project}/probes/{probeId}

Description

Updates a probe by removing the existing definition and writing a new normalized one. If url or method changes, the generated probe_id also changes.

Path Parameters

Parameter	Type	Required	Description
project	string	Yes	Project name
probeId	string	Yes	Generated probe identifier

Request Body

Field	Type	Required	Description
url	string	No	Updated target URL
method	string	No	GET, POST, PUT, PATCH, DELETE, HEAD, or OPTIONS
headers	object	No	Updated request headers
body	mixed or null	No	Updated request body
latency	integer	No	Updated latency threshold

Example Request

curl -X PATCH http://localhost/api/v1/projects/status-page/probes/5be5db4b8f0d98f0c4b2c6f24395d5f7f8d4fe10 \
  -H "Content-Type: application/json" \
  -H "X-Uplinkr-Api-Key: replace-me-with-a-long-random-key" \
  -d '{
    "url": "https://example.com/ready",
    "method": "POST",
    "headers": {
      "Accept": "application/xml"
    },
    "body": "{\"ready\":true}"
  }'

Example Response

{
  "data": {
    "project": "status-page",
    "url": "https://example.com/ready",
    "probe_id": "a6dcf8d651d7a38e91dadd6b457fdc47dd1b6f1b"
  }
}

Status Codes

• 200 Probe updated
• 401 Missing or invalid API key
• 404 Probe not found
• 422 Validation failed