Skip to main content
POST
Get RUM resource info

Restrictions

Usage

  • Returns ResourceNotFound when the account has no RUM resource provisioned yet, or when the resource’s status is deleted/destroyed.
  • no_cache=true bypasses the short-lived cache of the resource record itself (plan version, quotas, status). The used_cnt figures come from a separate hourly cache that this flag does not affect, so they can lag behind live usage either way.
  • The used-count fields reflect the current 30-day billing window (window_start_time to window_end_time), not lifetime totals.
  • expired_at is only populated on on-premises deployments, from the license expiry date; it is omitted entirely for SaaS accounts.
  • For version=free accounts, session_limit_reached is true once usage exceeds the combined free quota across all applications (per-app free quota × application count); it stays false while the account has no applications yet.

Authorizations

app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json

Query parameters for reading the account's RUM resource record.

no_cache
boolean
default:false

Bypass the short-lived cache of the resource record (plan version, quotas, status) and read it from source. Does not refresh the usage counts. Default false.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
required

The account's RUM resource record, including its plan window and current session usage.