Entitlements module
/
Feature Flags
/
Delete feature flag

Entitlements Overview

The Entitlements Engine is powered by the isEntitledTo query and is designed to manage and control user access within your application. It enables you to grant users specific roles, permissions, feature access, and more, providing a flexible framework for access management.

Below is an overview of API endpoints relevant to managing features, plans, feature flags, and API access control within your application. All endpoints are classified as Management Endpoints, requiring environment-level authorization and offering comprehensive control over entitlement resources.

Download OpenAPI description
Users, Auth and Security
Single Sign-On
SCIM Provisioning
Entitlements
Entitlements Agent
Accounts (Tenants)
Languages
Servers
EU Region

https://api.frontegg.com/entitlements/

US Region

https://api.us.frontegg.com/entitlements/

CA Region

https://api.ca.frontegg.com/entitlements/

AU Region

https://api.au.frontegg.com/entitlements/

Frontegg sub-domain for use with user tokens

https://{domain}.frontegg.com/entitlements/

Features

Operations

Plans

Operations

Entitlements

Operations

Feature Flags

Operations

Update feature flag

Request

Update an existing feature flag's configuration, including its on/off state, treatments, targeting rules, and metadata.

Path
idstringrequired
Bodyapplication/jsonrequired
namestring

String that represent the feature flag name

Example: "Test Feature Flag"
onboolean

Boolean indicating whether the feature flag is on

Example: true
offTreatmentstring

Enum that represents the treatment in case feature flag is off

Enum"true""false"
Example: "false"
defaultTreatmentstring

Enum that represents the default treatment

Enum"true""false"
Example: "true"
featureIdstring

UUID string that represents the related feature ID

Example: "26f1b6b8-0317-452c-becd-68a5f782417d "
descriptionstring

String the represents the feature flag description

Example: "This is a test feature flag"
metadatastring

JSON String that represents additional custom metadata to the feature flag entity

Example: "{}"
rulesArray of objects(RuleDto)

Array of rules that represents the set of conditions targeting the feature

curl -i -X PATCH \
  'https://api.frontegg.com/entitlements/resources/feature-flags/v1/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Test Feature Flag",
    "on": true,
    "offTreatment": "false",
    "defaultTreatment": "true",
    "featureId": "26f1b6b8-0317-452c-becd-68a5f782417d ",
    "description": "This is a test feature flag",
    "metadata": "{}",
    "rules": [
      {
        "description": "This is the first rule",
        "conditionLogic": "and",
        "conditions": [
          {
            "attribute": "myCustomAttribute",
            "attributeType": "custom",
            "negate": false,
            "op": "in_list",
            "value": {
              "list": [
                "valueA",
                "valueB"
              ]
            }
          }
        ],
        "treatment": "true"
      }
    ]
  }'

Responses

Bodyapplication/json
idstring

UUID string that represents the feature flag ID

Example: "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3"
namestring

String that represent the feature flag name

Example: "Test Feature Flag"
onboolean

Boolean indicating whether the feature flag is on

Example: true
offTreatmentstring

Enum that represents the treatment in case feature flag is off

Enum"true""false"
Example: "false"
defaultTreatmentstring

Enum that represents the default treatment

Enum"true""false"
Example: "true"
featureobject

Object that represents the related feature

descriptionstring

String the represents the feature flag description

Example: "This is a test feature flag"
metadatastring

JSON String that represents additional custom metadata to the feature flag entity

Example: "{}"
rulesArray of objects(RuleDto)

Array of rules that represents the set of conditions targeting the feature

updatedAtstring(date-time)

Date when feature flag was created

Example: "2022-01-01T00:00:00"
createdAtstring(date-time)

Date when feature flag was last updated

Example: "2022-01-01T00:00:00"
Response
application/json
{
  "id": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
  "name": "Test Feature Flag",
  "on": true,
  "offTreatment": "false",
  "defaultTreatment": "true",
  "feature": {
    "id": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
    "key": "test-feature",
    "name": "Test Feature"
  },
  "description": "This is a test feature flag",
  "metadata": "{}",
  "rules": [
    { … }
  ],
  "updatedAt": "2022-01-01T00:00:00",
  "createdAt": "2022-01-01T00:00:00"
}

Delete feature flag

Request

Delete a specific feature flag by its unique ID, permanently removing the feature flag and its associated configuration.

Path
idstringrequired
curl -i -X DELETE \
  'https://api.frontegg.com/entitlements/resources/feature-flags/v1/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

API Access Control

Operations