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.
  • A negative free_cnt means the quota is unlimited.
  • 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 becomes true once investigate or replay usage reaches the per-application free quota × the number of applications (measure sessions are not counted); it stays false while the account has no applications.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

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

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