POST /probes

Endpoint

POST /api/v1/probes

Description

Creates a probe for an existing project. The target project is provided in the request body.

Request Body

Field	Type	Required	Description
project	string	Yes	Existing project name
url	string	Yes	Target URL
method	string	No	GET, POST, PUT, PATCH, DELETE, HEAD, or OPTIONS
headers	object	No	Key-value request headers
body	mixed	No	Optional request body
latency	integer	No	Maximum expected latency in milliseconds

Example Request

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

Example Response

{
  "data": {
    "project": "status-page",
    "url": "https://example.com/health",
    "probe_id": "5be5db4b8f0d98f0c4b2c6f24395d5f7f8d4fe10"
  },
  "meta": {
    "created": true
  }
}

Status Codes

• 201 Probe created
• 200 Probe already existed for that URL and was written again
• 401 Missing or invalid API key
• 404 Project not found
• 422 Validation failed