Skip to main content
POST
Preview remote config

Restrictions

Usage

  • Runs the same rule matcher the SDK config endpoint uses and publishes nothing.
  • Omit config to preview the live configuration; a supplied config is validated like an update and invalid drafts return InvalidParameter.
  • Rule conditions compare exact strings; a rule that tests env, app_version or sdk never matches when that field is omitted from the request.
  • If the configuration is disabled (enabled: false) or has never been published, values is empty and hit_rule_index is -1.

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

Preview request. Omit config to preview the currently live configuration.

application_id
string
required

RUM application ID. Get application IDs via POST /rum/application/list.

app_version
string

App version the simulated client reports, compared exactly with rules' match.app_version (no range or prefix matching). Omitted = not reported.

config
object

Draft configuration to evaluate, validated like POST /rum/application/remote-config/update. Omit to evaluate the live configuration.

env
string

Environment the simulated client reports, compared exactly with rules' match.env. Omitted = not reported, so rules that test env cannot match.

sdk
string

SDK identifier the simulated client reports, e.g. web@2.4.1, compared exactly with rules' match.sdk. Omitted = not reported.

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

Values the simulated client would receive.