Get Flow SDK settings

GET

/ui-extensions/settings

Last modified:2026-10-06 20:29:08

OperationId:readUiExtensionSettings

Gets the platform-wide Flow SDK settings: disabled zones and capabilities, API resources extensions may not use, and approved bundle hosts. Requires Super User, Super User Read Only, Admin Super User, Reseller, Office Manager, Site Manager, Call Center Supervisor, Call Center Agent, or Basic User scope. Other scopes, such as Advanced User and Simple User, receive 403.

Reseller, Super User, Super User Read Only, and Admin Super User also receive the analysis settings, rule policy, ruleset fingerprint, and csp-coverage. On a server never configured, the defaults are returned, not 404.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200OK

application/json

The settings. The fields depend on your scope.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/ui-extensions/settings' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Administrator

{
    "disabled-zones": [
        "sidetray"
    ],
    "disabled-capabilities": [],
    "api-read-deny-resources": [
        "apikeys"
    ],
    "api-write-deny-resources": [
        "apikeys",
        "oauth-clients"
    ],
    "approved-cdn-origins": [
        "cdn.example.com",
        "*.apps.example.com"
    ],
    "analysis-settings": {
        "max_entry_bytes": 1000000,
        "max_total_bytes": 8000000,
        "max_chunk_count": 40,
        "max_fetch_seconds": 60,
        "obfuscation_string_array_max": 64,
        "obfuscation_string_array_share_max": 0.05,
        "obfuscation_hex_ratio_max": 0.2,
        "obfuscation_bracket_ratio_max": 0.5,
        "size_delta_flag_ratio": 2.0
    },
    "analysis-denylist": {
        "bad_packages": [
            "event-stream"
        ],
        "benign": [
            {
                "rule": "document-cookie",
                "path": "node_modules/loglevel/"
            },
            {
                "rule": "document-cookie",
                "path": "node_modules/axios/lib/helpers/cookies.js"
            }
        ]
    },
    "analysis-rule-policy": {
        "direct-ns-api": {
            "mode": "enforce",
            "severity": "reject",
            "buckets": {
                "vendored": "flag",
                "build-injected": "info"
            }
        },
        "document-cookie": {
            "mode": "enforce",
            "severity": "reject",
            "buckets": {
                "vendored": "flag",
                "build-injected": "info"
            }
        },
        "eval": {
            "mode": "enforce",
            "severity": "reject",
            "buckets": {
                "vendored": "flag",
                "build-injected": "info"
            }
        },
        "fetch-credentials": {
            "mode": "enforce",
            "severity": "reject",
            "buckets": {
                "vendored": "info",
                "build-injected": "info"
            }
        },
        "frame-escape": {
            "mode": "enforce",
            "severity": "reject",
            "buckets": {
                "vendored": "flag",
                "build-injected": "info"
            }
        },
        "known-bad-dep": {
            "mode": "enforce",
            "severity": "reject",
            "buckets": {
                "vendored": "flag",
                "build-injected": "info"
            }
        },
        "missing-source-map": {
            "mode": "enforce",
            "severity": "reject",
            "buckets": {
                "vendored": "flag",
                "build-injected": "info"
            }
        },
        "new-dependency": {
            "mode": "enforce",
            "severity": "info",
            "buckets": {
                "vendored": "flag",
                "build-injected": "info"
            }
        },
        "new-function": {
            "mode": "enforce",
            "severity": "flag",
            "buckets": {
                "vendored": "flag",
                "build-injected": "info"
            }
        },
        "new-network-destination": {
            "mode": "enforce",
            "severity": "flag",
            "buckets": {
                "vendored": "flag",
                "build-injected": "info"
            }
        },
        "new-rule-hit": {
            "mode": "enforce",
            "severity": "flag",
            "buckets": {
                "vendored": "flag",
                "build-injected": "info"
            }
        },
        "ns-storage-key": {
            "mode": "enforce",
            "severity": "reject",
            "buckets": {
                "vendored": "flag",
                "build-injected": "info"
            }
        },
        "obfuscation": {
            "mode": "enforce",
            "severity": "reject",
            "buckets": {
                "vendored": "flag",
                "build-injected": "info"
            }
        },
        "settimeout-string": {
            "mode": "enforce",
            "severity": "reject",
            "buckets": {
                "vendored": "flag",
                "build-injected": "info"
            }
        },
        "size-delta": {
            "mode": "enforce",
            "severity": "flag",
            "buckets": {
                "vendored": "flag",
                "build-injected": "info"
            }
        }
    },
    "analysis-ruleset-fingerprint": "c55ec88c872e1f05",
    "csp-coverage": {
        "status": "diverged",
        "uncovered": [
            "*.apps.example.com"
        ],
        "source": "portal"
    }
}

Modified at 2026-10-06 20:29:08

List extension versions

Update Flow SDK settings