Canary rollout gate API

Deterministically decides whether a sticky subject is inside a percentage rollout/canary cohort for a feature by hashing subject+feature into a stable bucket. Answers 'Is this user in the X% rollout?', 'Should I enable the canary for this tenant?'.

Price$0.02per request

MethodPOST

Route/v1/workflow/rollout-gate

StatusLive

MIME typeapplication/json

Rate limit120/minute

Cache0s public

rolloutcanarypercentagegategradualreleasestickyworkflow

API URLhttps://x402.hexl.dev/v1/workflow/rollout-gate

Integration docs

Example request

{
  "subjectId": "tenant-7",
  "feature": "beta",
  "percentage": 25
}

Example response

{
  "enabled": false,
  "bucket": 90.0722,
  "threshold": 25,
  "sticky": true,
  "interpretation": "Subject 'tenant-7' is OUT of the 25% rollout for 'beta' (bucket 90.07)."
}

Input schema

{
  "type": "object",
  "required": [
    "subjectId",
    "feature",
    "percentage"
  ],
  "properties": {
    "subjectId": {
      "type": "string",
      "examples": [
        "tenant-7"
      ]
    },
    "feature": {
      "type": "string",
      "examples": [
        "beta"
      ]
    },
    "percentage": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "examples": [
        25
      ]
    }
  }
}

Output schema

{
  "type": "object",
  "additionalProperties": true
}