Skip to main content

Platform / Workspace management API

  • Per-key normal budget: 60 requests per database minute. Authorized responses carry X-RateLimit-Limit and X-RateLimit-Remaining.
  • Pairing additionally shares five attempts per workspace minute across keys; invalid codes consume the budget too.
  • The ingress also has a shared bounded four-request/second admission budget and four concurrent management requests. Public documentation has its own budget.
  • Rate-limited API responses can use Retry-After: 60; ingress uses Retry-After: 1. Respect the actual header, apply jitter and preserve the original mutation Idempotency-Key.
  • JSON bodies are at most 64 KiB. Upload file bytes to the URL returned by the upload instructions, not inside the JSON request.
  • Stop polling on terminal operation/upload failure, cancellation or expiry. Disabled offline export is an operator/configuration condition, not a reason for endless retry.
See Platform API security and retries.

Queue API

  • Default shared credential limit: 60 requests per one-minute bucket.
  • A rejected over-limit request returns HTTP 429 with RATE_LIMITED.
  • Use exponential backoff with jitter and wait at least until the next minute bucket.
  • Do not retry a ticket mutation with a new Idempotency Key after an unknown network result; retry the same logical operation with the same key.

Replay records

Mutation nonces are retained for ten minutes. Request timestamps must be within five minutes.

Structured Widget Push API

  • Default limit: 120 Push attempts per Widget in a rolling one-minute window.
  • A rejected over-limit request returns HTTP 429 RATE_LIMITED with retryAfterSeconds: 60.
  • The request body is limited to 1 MiB.
  • Use exponential backoff with jitter.
  • Retry the same logical snapshot with the same Idempotency Key and byte-identical body.

Prayer schedule Push API

  • Source-specific Push limits apply.
  • The request body is limited to 512 KB.
  • Preserve the Idempotency Key when retrying one logical month.

Device PINs

Screen unlock, Screen release, and Kiosk unlock use five attempts per five minutes per device token. Successful verification clears the counter.