Skip to content
SignalSitterDocs

Test a beat

POST/v1/monitors/{monitorId}/test-beat

Try a beat against a monitor without recording it. Use it to check your request and measurements before going live.

Authentication
SignalSitter API credential or Clerk session JWT · REST guide
Operation ID
testMonitorBeat

Parameters

Section titled “Parameters”

Path

monitorIdMonitorIdRequired

Immutable public monitor identifier, normally sufficient within the verified organization.

  • Minimum length 1
  • Maximum length 128
  • Pattern ^[A-Za-z0-9][A-Za-z0-9_-]*$

Query

jurisdictionMonitorJurisdiction

Optional disambiguator used only when this organization owns the same monitor ID in more than one jurisdiction.

One of
  • "unrestricted"
  • "eu"
  • "us"
  • "fedramp"

Headers

X-Correlation-IDCorrelationId

Optional caller correlation identifier propagated to the response.

  • Minimum length 1
  • Maximum length 128
  • Pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]*$

Request body

Section titled “Request body”

Required

application/jsonMonitorTestBeatRequest
  • Historical rule preview is bounded to ten recent observations, accepts no callback mutation, and requires configuration-management plus observation-read authorization in the shared application service.
observationany of
Option 1
Option 2
Any keyany of
Option 1
Option 2

Any of

Option 1
Option 2
Option 3
  • Maximum length 256
  • Pattern ^[^\u0000-\u001F\u007F]*$
Keysstring
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[^\u0000-\u001F\u007F]*$
ruleHistoryPreviewobject
2 properties
historyLimitinteger
  • Minimum 1
  • Maximum 10
  • Default 10
patchobjectRequired
7 properties
graceSecondsinteger

Seconds of lateness tolerated after the interval. Values below 60 are raised to 60.

  • Minimum 0
  • Maximum 604800
heartbeatExpectationone of
state: "enabled"
graceSecondsinteger

Seconds of lateness tolerated after the interval. Values below 60 are raised to 60.

  • Minimum 0
  • Maximum 604800
  • Default 60
intervalSecondsintegerRequired
  • Minimum 60
  • Maximum 31536000
statestringRequired
Value
  • "enabled"
versionnumberRequired
Value
  • 1
state: "disabled"
statestringRequired
Value
  • "disabled"
versionnumberRequired
Value
  • 1
state: "automatic"
graceSecondsinteger

Seconds of lateness tolerated after the interval. Values below 60 are raised to 60.

  • Minimum 0
  • Maximum 604800
statestringRequired
Value
  • "automatic"
versionnumberRequired
Value
  • 1
incidentPolicyobject
2 properties
notificationCooldownSecondsinteger
  • Minimum 0
  • Maximum 604800
recoveryConfirmationBeatsinteger
  • Minimum 1
  • Maximum 10
intervalSecondsinteger
  • Minimum 60
  • Maximum 31536000
measurementsobject
Any keyobject
14 properties
disabledRulesarray of string
  • Maximum items 8

Each item

One of
  • "minimum"
  • "maximum"
  • "zero"
  • "nonzero"
  • "absolute_delta"
  • "percentage_delta"
  • "ratio_minimum"
  • "ratio_maximum"
maximumnumber | null
maximumAbsoluteDeltanumber | null
  • Minimum 0
maximumPercentageDeltanumber | null
  • Minimum 0
metricTypestring
One of
  • "gauge"
  • "count"
  • "rate"
  • "duration"
  • "counter"
  • "size"
minimumnumber | null
missingPolicystring
One of
  • "skip"
  • "zero"
  • "reject"
modestring
One of
  • "heartbeat"
  • "shadow"
  • "active"
ratioobject
3 properties
denominatorstring
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
maximumnumber | null
minimumnumber | null
ruleActionobject
2 properties
modestringRequired
One of
  • "inactive"
  • "active"
versionnumberRequired
Value
  • 1
rulePolicyany of
Option 1
consecutiveObservationsinteger
  • Minimum 1
  • Maximum 10
severitystring
One of
  • "info"
  • "warning"
  • "critical"
Option 2
sustainedConsequencestring
One of
  • "none"
  • "info"
  • "warning"
  • "critical"
sustainedCriterionone of
kind: "observations"
kindstringRequired
Value
  • "observations"
observationsintegerRequired
  • Minimum 1
  • Maximum 10
kind: "elapsed_time"
kindstringRequired
Value
  • "elapsed_time"
secondsintegerRequired
  • Minimum 1
  • Maximum 604800
transientConsequencestring
One of
  • "none"
  • "info"
  • "warning"
  • "critical"
versionnumberRequired
Value
  • 1
transformstring
One of
  • "none"
  • "log1p"
unitstring
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[^\u0000-\u001F\u007F]*$
zeroExpectationstring | null
One of
  • "zero"
  • "nonzero"
Keysstring
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
namestring
  • Minimum length 1
  • Maximum length 120
  • Pattern ^[^\u0000-\u001F\u007F]*$
timeZonestring
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[^\u0000-\u001F\u007F]*$

Responses

Section titled “Responses”
200Successful response
application/jsonMonitorTestBeatResult
  • Nested adaptive numeric-baseline evidence keeps readiness, finite prediction groups, original-scale bounds, update disposition, and actionable policy input mutually consistent.
  • Nested explicit numeric-rule evidence consistently identifies evaluated values, skipped reasons, breach phase, count-or-time progress, effective consequence, ratio denominators, and actionable incident-policy inputs.
  • A historical rule preview reports the persisted base and hypothetical next configuration versions and never represents a production effect.
deadlinePreviewstring
  • Format date-time
  • Pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
incidentPolicyDecisionobject
13 properties
configurationVersionintegerRequired
  • Minimum 0
  • Maximum 9007199254740991
confirmationobjectRequired
4 properties
confirmedbooleanRequired
observedInWindowintegerRequired
  • Minimum 0
  • Maximum 6
requiredintegerRequired
  • Minimum 1
  • Maximum 6
windowintegerRequired
  • Minimum 1
  • Maximum 6
contributionsarray of objectRequired
  • Maximum items 80

Each item

8 properties
breachobject
7 properties
consequencestringRequired
One of
  • "none"
  • "info"
  • "warning"
  • "critical"
justBecameSustainedbooleanRequired
phasestringRequired
One of
  • "clear"
  • "transient"
  • "sustained"
progressobjectRequired
4 properties
elapsedSecondsintegerRequired
  • Minimum 0
  • Maximum 604800
qualifyingObservationsintegerRequired
  • Minimum 0
  • Maximum 10
remainingintegerRequired
  • Minimum 0
  • Maximum 604800
startedAtstring
  • Format date-time
  • Pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
sustainedConsequencestringRequired
One of
  • "none"
  • "info"
  • "warning"
  • "critical"
sustainedCriterionone ofRequired
kind: "observations"
kindstringRequired
Value
  • "observations"
observationsintegerRequired
  • Minimum 1
  • Maximum 10
kind: "elapsed_time"
kindstringRequired
Value
  • "elapsed_time"
secondsintegerRequired
  • Minimum 1
  • Maximum 604800
transientConsequencestringRequired
One of
  • "none"
  • "info"
  • "warning"
  • "critical"
detectorstringRequired
One of
  • "explicit_rule"
  • "adaptive_baseline"
  • "seasonal_baseline"
  • "persistent_shift"
durationSamplesinteger
  • Minimum 0
  • Maximum 1000000
measurementKeystringRequired
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
residualScorenumber
  • Minimum 0
ruleIdstring
  • Minimum length 3
  • Maximum length 160
  • Pattern ^[a-z][a-z0-9_]*(?:\.[a-z][a-z0-9_]*)+$
severitystringRequired
One of
  • "info"
  • "warning"
  • "critical"
triggerstring
One of
  • "explicit_rule"
  • "extreme_deviation"
  • "moderate_confirmation"
  • "persistent_shift"
engineVersionnumberRequired
Value
  • 1
evaluationobject
3 properties
evaluatedMeasurementKeysarray of stringRequired
  • Maximum items 32

Each item

  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
policyActivebooleanRequired
publishedMeasurementKeysarray of stringRequired
  • Maximum items 32

Each item

  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
explanationstringRequired
  • Minimum length 1
  • Maximum length 512
  • Pattern ^[^\u0000-\u001F\u007F]*$
notifiablebooleanRequired
outcomestringRequired
One of
  • "none"
  • "recorded"
  • "confirming"
  • "incident_opened"
  • "incident_sustained"
  • "recovery_pending"
  • "recovery_confirmed"
profileone ofRequired
confirmationRequired: 4
configurednumberRequired
  • Minimum 0
  • Maximum 1
confirmationRequirednumberRequired
Value
  • 4
confirmationWindownumberRequired
Value
  • 6
extremeResidualMultiplenumberRequired
Value
  • 4
namestringRequired
Value
  • "low"
recoveryConfirmationObservationsnumberRequired
Value
  • 4
confirmationRequired: 3
configurednumberRequired
  • Minimum 0
  • Maximum 1
confirmationRequirednumberRequired
Value
  • 3
confirmationWindownumberRequired
Value
  • 5
extremeResidualMultiplenumberRequired
Value
  • 3
namestringRequired
Value
  • "medium"
recoveryConfirmationObservationsnumberRequired
Value
  • 3
confirmationRequired: 2
configurednumberRequired
  • Minimum 0
  • Maximum 1
confirmationRequirednumberRequired
Value
  • 2
confirmationWindownumberRequired
Value
  • 4
extremeResidualMultiplenumberRequired
Value
  • 2.5
namestringRequired
Value
  • "high"
recoveryConfirmationObservationsnumberRequired
Value
  • 3
recoveryobjectRequired
2 properties
confirmedObservationsintegerRequired
  • Minimum 0
  • Maximum 10
requiredObservationsintegerRequired
  • Minimum 1
  • Maximum 10
severitystringRequired
One of
  • "info"
  • "warning"
  • "critical"
suppressionstring
One of
  • "detector_unconfirmed"
  • "detector_warming"
  • "detector_shadow_mode"
  • "open_incident"
triggersarray of stringRequired
  • Maximum items 4

Each item

One of
  • "explicit_rule"
  • "extreme_deviation"
  • "moderate_confirmation"
  • "persistent_shift"
modestringRequired
Value
  • "test"
outcomestringRequired
Value
  • "validated"
productionEffectsbooleanRequired
Value
  • false
ruleEvaluationsarray of object
  • Maximum items 32

Each item

20 properties
breachobject
7 properties
consequencestringRequired
One of
  • "none"
  • "info"
  • "warning"
  • "critical"
justBecameSustainedbooleanRequired
phasestringRequired
One of
  • "clear"
  • "transient"
  • "sustained"
progressobjectRequired
4 properties
elapsedSecondsintegerRequired
  • Minimum 0
  • Maximum 604800
qualifyingObservationsintegerRequired
  • Minimum 0
  • Maximum 10
remainingintegerRequired
  • Minimum 0
  • Maximum 604800
startedAtstring
  • Format date-time
  • Pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
sustainedConsequencestringRequired
One of
  • "none"
  • "info"
  • "warning"
  • "critical"
sustainedCriterionone ofRequired
kind: "observations"
kindstringRequired
Value
  • "observations"
observationsintegerRequired
  • Minimum 1
  • Maximum 10
kind: "elapsed_time"
kindstringRequired
Value
  • "elapsed_time"
secondsintegerRequired
  • Minimum 1
  • Maximum 604800
transientConsequencestringRequired
One of
  • "none"
  • "info"
  • "warning"
  • "critical"
comparisonstringRequired
One of
  • "at_least"
  • "at_most"
  • "equal"
  • "not_equal"
computedValuenumber
configurationVersionintegerRequired
  • Minimum 0
  • Maximum 9007199254740991
confirmationobjectRequired
3 properties
confirmedbooleanRequired
consecutiveViolationsintegerRequired
  • Minimum 0
  • Maximum 10
requiredintegerRequired
  • Minimum 1
  • Maximum 10
denominatorMeasurementKeystring
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
engineVersionany ofRequired
1
Value
  • 1
2
Value
  • 2
explanationstringRequired
  • Minimum length 1
  • Maximum length 512
  • Pattern ^[^\u0000-\u001F\u007F]*$
kindstringRequired
One of
  • "minimum"
  • "maximum"
  • "zero"
  • "nonzero"
  • "absolute_delta"
  • "percentage_delta"
  • "ratio_minimum"
  • "ratio_maximum"
measurementKeystringRequired
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
normalizationStatusstringRequired
One of
  • "value"
  • "counter_baseline"
  • "counter_reset"
  • "missing_skipped"
  • "missing_zero"
notEvaluatedReasonstring
One of
  • "measurement_missing"
  • "counter_baseline"
  • "counter_reset"
  • "previous_value_missing"
  • "previous_value_zero"
  • "ratio_denominator_missing"
  • "ratio_denominator_zero"
  • "numeric_overflow"
observedValuenumber
policyInputobjectRequired
3 properties
actionablebooleanRequired
modestringRequired
One of
  • "heartbeat"
  • "shadow"
  • "active"
severitystringRequired
One of
  • "info"
  • "warning"
  • "critical"
referenceValuenumber
ruleIdstringRequired
  • Minimum length 3
  • Maximum length 160
  • Pattern ^[a-z][a-z0-9_]*(?:\.[a-z][a-z0-9_]*)+$
severitystringRequired
One of
  • "info"
  • "warning"
  • "critical"
statusstringRequired
One of
  • "passed"
  • "violated"
  • "not_evaluated"
thresholdnumberRequired
transformstringRequired
One of
  • "none"
  • "log1p"
ruleHistoryPreviewobject
6 properties
baseConfigurationVersionintegerRequired
  • Minimum 0
  • Maximum 9007199254740991
evaluatedObservationsintegerRequired
  • Minimum 0
  • Maximum 10
fromSequenceinteger
  • Greater than 0
  • Maximum 9007199254740991
proposedConfigurationVersionintegerRequired
  • Minimum 0
  • Maximum 9007199254740991
ruleEvaluationsarray of objectRequired
  • Maximum items 32

Each item

20 properties
breachobject
7 properties
consequencestringRequired
One of
  • "none"
  • "info"
  • "warning"
  • "critical"
justBecameSustainedbooleanRequired
phasestringRequired
One of
  • "clear"
  • "transient"
  • "sustained"
progressobjectRequired
4 properties
elapsedSecondsintegerRequired
  • Minimum 0
  • Maximum 604800
qualifyingObservationsintegerRequired
  • Minimum 0
  • Maximum 10
remainingintegerRequired
  • Minimum 0
  • Maximum 604800
startedAtstring
  • Format date-time
  • Pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
sustainedConsequencestringRequired
One of
  • "none"
  • "info"
  • "warning"
  • "critical"
sustainedCriterionone ofRequired
kind: "observations"
kindstringRequired
Value
  • "observations"
observationsintegerRequired
  • Minimum 1
  • Maximum 10
kind: "elapsed_time"
kindstringRequired
Value
  • "elapsed_time"
secondsintegerRequired
  • Minimum 1
  • Maximum 604800
transientConsequencestringRequired
One of
  • "none"
  • "info"
  • "warning"
  • "critical"
comparisonstringRequired
One of
  • "at_least"
  • "at_most"
  • "equal"
  • "not_equal"
computedValuenumber
configurationVersionintegerRequired
  • Minimum 0
  • Maximum 9007199254740991
confirmationobjectRequired
3 properties
confirmedbooleanRequired
consecutiveViolationsintegerRequired
  • Minimum 0
  • Maximum 10
requiredintegerRequired
  • Minimum 1
  • Maximum 10
denominatorMeasurementKeystring
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
engineVersionany ofRequired
1
Value
  • 1
2
Value
  • 2
explanationstringRequired
  • Minimum length 1
  • Maximum length 512
  • Pattern ^[^\u0000-\u001F\u007F]*$
kindstringRequired
One of
  • "minimum"
  • "maximum"
  • "zero"
  • "nonzero"
  • "absolute_delta"
  • "percentage_delta"
  • "ratio_minimum"
  • "ratio_maximum"
measurementKeystringRequired
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
normalizationStatusstringRequired
One of
  • "value"
  • "counter_baseline"
  • "counter_reset"
  • "missing_skipped"
  • "missing_zero"
notEvaluatedReasonstring
One of
  • "measurement_missing"
  • "counter_baseline"
  • "counter_reset"
  • "previous_value_missing"
  • "previous_value_zero"
  • "ratio_denominator_missing"
  • "ratio_denominator_zero"
  • "numeric_overflow"
observedValuenumber
policyInputobjectRequired
3 properties
actionablebooleanRequired
modestringRequired
One of
  • "heartbeat"
  • "shadow"
  • "active"
severitystringRequired
One of
  • "info"
  • "warning"
  • "critical"
referenceValuenumber
ruleIdstringRequired
  • Minimum length 3
  • Maximum length 160
  • Pattern ^[a-z][a-z0-9_]*(?:\.[a-z][a-z0-9_]*)+$
severitystringRequired
One of
  • "info"
  • "warning"
  • "critical"
statusstringRequired
One of
  • "passed"
  • "violated"
  • "not_evaluated"
thresholdnumberRequired
transformstringRequired
One of
  • "none"
  • "log1p"
throughSequenceinteger
  • Greater than 0
  • Maximum 9007199254740991
testedAtstringRequired
  • Format date-time
  • Pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
2 response headers
X-Correlation-IDCorrelationIdRequired

Correlation identifier shared by related operations.

  • Minimum length 1
  • Maximum length 128
  • Pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]*$
X-Request-IDRequestIdRequired

Request identifier for this response.

  • Minimum length 1
  • Maximum length 128
  • Pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]*$
Errors
  • 400Invalid request
  • 401Authentication required
  • 403Permission denied
  • 404Resource not found
  • 413Request payload too large
  • 415Unsupported request media type
  • 429Authentication rate limited
  • 500Internal server error
  • 503Service temporarily unavailable
Error bodyProblemDetails
application/problem+jsonProblemDetails
  • URI references must pass full URI-reference parsing, including percent escapes, authority brackets, and scheme syntax.
  • Documentation links must parse as credential-free HTTPS URLs or root-relative paths.
  • retryAfterSeconds is allowed only when retryable is true.
codestringRequired
  • Minimum length 1
  • Maximum length 128
  • Pattern ^signalsitter\.[a-z][a-z0-9]*(?:[._][a-z0-9]+)*$
correlationIdstringRequired
  • Minimum length 1
  • Maximum length 128
  • Pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]*$
detailstringRequired
  • Minimum length 1
  • Maximum length 1024
  • Pattern ^[^\u0000-\u001F\u007F]*$
fieldErrorsarray of object
  • Maximum items 32

Each item

3 properties
codestringRequired
  • Minimum length 1
  • Maximum length 128
  • Pattern ^[a-z][a-z0-9_]*$
messagestringRequired
  • Minimum length 1
  • Maximum length 512
  • Pattern ^[^\u0000-\u001F\u007F]*$
pathstringRequired
  • Maximum length 256

All of

Part 1
  • Pattern ^[^\u0000-\u001F\u007F]*$
Part 2
  • Pattern ^(?:|(?:\/(?:[^~]|~[01])*)+)$
instancestring
  • Minimum length 1
  • Maximum length 512
  • Pattern ^[^\s\u0000-\u001F\u007F]+$
limitobject
7 properties
attemptedinteger
  • Minimum 0
  • Maximum 9007199254740991
currentinteger
  • Minimum 0
  • Maximum 9007199254740991
dimensionstringRequired
One of
  • "active_monitors"
  • "beat_cadence"
  • "minimum_interval_seconds"
  • "measurements_per_observation"
  • "stored_observations"
  • "observation_retention_seconds"
  • "callback_endpoints"
  • "detector_feature"
  • "api_requests_per_minute"
  • "mcp_requests_per_minute"
  • "service_state"
  • "entitlement_lease"
limitinteger
  • Minimum 0
  • Maximum 9007199254740991
planobject
3 properties
idstringRequired
One of
  • "free"
  • "builder"
  • "smart"
  • "scale"
namestringRequired
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}]+$
versionintegerRequired
  • Greater than 0
  • Maximum 9007199254740991
remediationstringRequired
One of
  • "upgrade_plan"
  • "reduce_usage"
  • "increase_interval"
  • "remove_feature"
  • "retry_after_refresh"
  • "contact_support"
  • "export_data"
serviceStatestring
One of
  • "active"
  • "payment_grace"
  • "abuse_suspended"
  • "canceled"
  • "deleting"
remediationarray of object
  • Maximum items 8

Each item

3 properties
codestringRequired
  • Minimum length 1
  • Maximum length 128
  • Pattern ^[a-z][a-z0-9_]*$
documentationstring
  • Minimum length 1
  • Maximum length 512

All of

Part 1
  • Pattern ^[^\s\u0000-\u001F\u007F]+$
Part 2
  • Pattern ^(?:\/(?!\/)|[Hh][Tt][Tt][Pp][Ss]:\/\/)
messagestringRequired
  • Minimum length 1
  • Maximum length 512
  • Pattern ^[^\u0000-\u001F\u007F]*$
retryablebooleanRequired
retryAfterSecondsinteger
  • Greater than 0
  • Maximum 86400
statusintegerRequired
  • Minimum 400
  • Maximum 599
titlestringRequired
  • Minimum length 1
  • Maximum length 160
  • Pattern ^[^\u0000-\u001F\u007F]*$
typestringRequired
  • Minimum length 1
  • Maximum length 512
  • Pattern ^[^\s\u0000-\u001F\u007F]+$

Operation contract

Section titled “Operation contract”

The operation exactly as it appears in the generated contract. References resolve within the OpenAPI document.

Show raw OpenAPI for testMonitorBeat
{
  "operationId": "testMonitorBeat",
  "parameters": [
    {
      "description": "Optional caller correlation identifier propagated to the response.",
      "in": "header",
      "name": "X-Correlation-ID",
      "required": false,
      "schema": {
        "$ref": "#/components/schemas/CorrelationId"
      }
    },
    {
      "description": "Immutable public monitor identifier, normally sufficient within the verified organization.",
      "in": "path",
      "name": "monitorId",
      "required": true,
      "schema": {
        "$ref": "#/components/schemas/MonitorId"
      }
    },
    {
      "description": "Optional disambiguator used only when this organization owns the same monitor ID in more than one jurisdiction.",
      "in": "query",
      "name": "jurisdiction",
      "required": false,
      "schema": {
        "$ref": "#/components/schemas/MonitorJurisdiction"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/MonitorTestBeatRequest"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/MonitorTestBeatResult"
          }
        }
      },
      "description": "Successful response",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "400": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Invalid request",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "401": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Authentication required",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "403": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Permission denied",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "404": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Resource not found",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "413": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Request payload too large",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "415": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Unsupported request media type",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "429": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Authentication rate limited",
      "headers": {
        "Retry-After": {
          "description": "Required retry delay in seconds.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RetryAfterHeader"
          }
        },
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "500": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Internal server error",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "503": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Service temporarily unavailable",
      "headers": {
        "Retry-After": {
          "description": "Required retry delay in seconds.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RetryAfterHeader"
          }
        },
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    }
  },
  "security": [
    {
      "apiCredential": []
    },
    {
      "clerkSession": []
    }
  ],
  "summary": "Validate a test beat without creating a production event",
  "tags": [
    "Monitors"
  ]
}
SignalSitter documentation