Skip to content
SignalSitterDocs

Update draft

POST/v1/monitors/{monitorId}/rule-workbench/drafts/update

Change the limits in a draft.

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

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._:/-]*$
Idempotency-KeystringRequired

Opaque retry key retained for the public idempotency window.

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

Request body

Section titled “Request body”

Required

application/jsonRestRuleWorkbenchDraftUpdateRequest
  • The nested measurement patch applies the shared coupled-field and breach-policy refinements.
draftIdstringRequired
  • Minimum length 1
  • Maximum length 128
  • Pattern ^[A-Za-z0-9][A-Za-z0-9_-]*$
expectedDraftVersionintegerRequired
  • Greater than 0
  • Maximum 9007199254740991
proposalobjectRequired
2 properties
definitionobjectRequired
13 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"
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"
measurementKeystringRequired
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$

Responses

Section titled “Responses”
200Successful response
application/jsonRuleWorkbenchDraft
  • Draft lifecycle timestamps and applied configuration version agree with draft status.
appliedConfigurationVersioninteger
  • Minimum 0
  • Maximum 9007199254740991
baseConfigurationVersionintegerRequired
  • Minimum 0
  • Maximum 9007199254740991
closedAtstring
  • 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)))$
createdAtstringRequired
  • 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)))$
historyobjectRequired
4 properties
fromSequenceinteger
  • Minimum 1
  • Maximum 9007199254740991
frozenAtstringRequired
  • 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)))$
observationCountintegerRequired
  • Minimum 0
  • Maximum 200
throughSequenceinteger
  • Minimum 1
  • Maximum 9007199254740991
idstringRequired
  • Minimum length 1
  • Maximum length 128
  • Pattern ^[A-Za-z0-9][A-Za-z0-9_-]*$
jurisdictionstringRequired
One of
  • "unrestricted"
  • "eu"
  • "us"
  • "fedramp"
monitorKeystringRequired

Deprecated V1 response spelling for the canonical monitorId; paths, request inputs, and SDK method parameters use monitorId.

  • Minimum length 1
  • Maximum length 128
  • Pattern ^[A-Za-z0-9][A-Za-z0-9_-]*$
proposalobjectRequired
2 properties
definitionobjectRequired
13 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"
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"
measurementKeystringRequired
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
statusany ofRequired
Option 1
One of
  • "open"
  • "applied"
  • "canceled"
Option 2
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[a-z][a-z0-9_]*$
updatedAtstringRequired
  • 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)))$
versionintegerRequired
  • Greater than 0
  • Maximum 9007199254740991
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
  • 409Idempotency key conflict
  • 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 updateMonitorRuleWorkbenchDraft
{
  "operationId": "updateMonitorRuleWorkbenchDraft",
  "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"
      }
    },
    {
      "description": "Opaque retry key retained for the public idempotency window.",
      "in": "header",
      "name": "Idempotency-Key",
      "required": true,
      "schema": {
        "maxLength": 255,
        "minLength": 1,
        "pattern": "^[A-Za-z0-9][A-Za-z0-9._~:/+-]*$",
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/RestRuleWorkbenchDraftUpdateRequest"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/RuleWorkbenchDraft"
          }
        }
      },
      "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"
          }
        }
      }
    },
    "409": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Idempotency key conflict",
      "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": "Update a rule proposal only when the draft version still matches",
  "tags": [
    "Monitors"
  ]
}
SignalSitter documentation