This reference is organized by endpoint so you can quickly map each request to its purpose, supported HTTP method, required parameters, and expected response shape. Use the endpoint cards to scan capabilities fast, then review the response examples section for concrete request and response patterns you can implement or validate.
API Probe Endpoint Reference
Technical reference for probe endpoints, HTTP methods, request parameters, payloads, response formats, and usage examples.
View setup guideReference overview
Probe endpoints
Create probe
Creates a new probe resource for a target endpoint. Supports POST with fields such as target URL, probe name, method override, and optional headers or body payload. Example: POST to create a probe for a JSON API target.
List probes
Returns a collection of configured probes for review and test selection. Supports GET with optional query parameters for paging, filtering by status, or searching by name. Example: GET to retrieve all probes in a workspace.
Get probe
Fetches the details for a single probe by identifier. Supports GET with a probe ID path parameter to return configuration, method, target, and recent run data. Example: GET for one probe before running a validation check.
Update probe
Updates an existing probe definition with revised request settings. Supports PUT or PATCH depending on the resource behavior, with payload fields for target, headers, method, and request body. Example: PATCH to adjust a probe’s header set.
Delete probe
Removes a probe from the reference set when it is no longer needed. Supports DELETE with a probe ID path parameter and returns a confirmation response. Example: DELETE to retire a legacy probe.
Run probe
Executes a probe against its target and returns the live test result. Supports POST with a probe ID and optional run parameters such as timeout or override inputs. Example: POST to trigger an on-demand request and inspect the response.
Response formats and examples
Most endpoints return JSON with a resource object or a list of objects, plus metadata for IDs, timestamps, and execution state where relevant. Read collection responses as arrays of probe records, and single-resource responses as structured objects containing endpoint settings, request fields, and latest result details. Typical request patterns include POST with a JSON payload to create or run a probe, GET with a path ID to retrieve one record, and DELETE with a path ID to remove it; typical response patterns include a created object, a fetched object, or a confirmation object with the affected resource ID. Use the same field names in your integration payloads that appear in the response schema to keep request and validation logic aligned.
Common questions
Which methods are covered in this reference?
The reference covers the HTTP methods used by the probe endpoints, including GET for retrieval, POST for creation and execution, PUT or PATCH for updates, and DELETE for removal.
What request fields should I expect?
Expect fields related to probe identity, target URL, HTTP method, headers, request body content, and optional run parameters where an execution endpoint is involved.
What does the response usually include?
Responses typically include the probe resource data, identifiers, timestamps, and any execution summary or status details returned by the endpoint.
How should I use this page during implementation?
Use it as a mapping guide between endpoint purpose, request shape, and response structure so you can build, inspect, and validate probe-related API calls consistently.