Manage feature flags

Add, update, remove, and list feature flag overrides on an Environment using the admin API.

  • Environment (Org) admin permissions. Adding, updating, or removing a flag override requires this role. Listing the current overrides only requires standard authenticated access.
  • Your Environment ID. Find it in the Environment details section of Admin Manager.

Feature flag overrides are set on an Environment through the admin API. Adding, updating, removing, and listing overrides all use the same endpoint:

https://{controlplane_path}/api/1/rest/admin/snappack/org-dist/Environment
          ID

The examples below use HTTP Basic authentication with your SnapLogic credentials. For a JWT example, refer to Authentication. PATCH requests (add, update, remove) additionally require that the authenticated user has Environment (Org) admin permissions for the Environment; GET requests (list) don't.

Important: Feature flags are advanced settings. Review the Feature flags reference before changing a flag, and confirm the flag applies to your Snaplex version. Changing a flag can affect node stability and performance.
  1. Add or update one or more flag overrides.
    Send a PATCH request with a flags_to_add object that maps each flag's fully qualified name to its new value. If a flag already has an override, this replaces its value.
    curl -u [email protected] \
      -H 'Content-Type: application/json' -X PATCH \
      --data-binary '{
        "flags_to_add": {
          "com.snaplogic.common.SnapLogicSecurityManager.ALLOW_CONFIG_FOLDER_ACCESS": true,
          "com.snaplogic.snaps.sap.JCoNativeShim.JCO_NATIVE_PRELOAD": true
        }
      }' \
      'https://controlplane_path/api/1/rest/admin/snappack/org-dist/Environment ID'
  2. Remove one or more flag overrides.
    Send a PATCH request with a flags_to_del array that lists the fully qualified names to remove. Removing an override reverts the flag to its platform default. You can combine flags_to_add and flags_to_del in the same request.
    curl -u [email protected] \
      -H 'Content-Type: application/json' -X PATCH \
      --data-binary '{
        "flags_to_del": [
          "com.snaplogic.snaps.sap.JCoNativeShim.JCO_NATIVE_PRELOAD"
        ]
      }' \
      'https://controlplane_path/api/1/rest/admin/snappack/org-dist/Environment ID'
  3. List the current flag overrides.
    Send a GET request to the same endpoint. The response includes a flag_overrides object with every flag currently overridden on the Environment.
    curl -u [email protected] \
      -H 'Content-Type: application/json' -X GET \
      'https://controlplane_path/api/1/rest/admin/snappack/org-dist/Environment ID'
  4. Restart the affected Snaplex, if required.
    Some flags are read once when a Snaplex node starts; changes to those flags take effect only after a restart. Other flags are read on each use and apply immediately. If a flag change doesn't appear to take effect, restart the Snaplex.

See Feature flags reference for the full catalog of flags, their types, defaults, and whether each flag enables a feature or changes the behavior of one.