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

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

Get Feature Flags

Request

Retrieve a paginated list of feature flags. You can search for specific feature flags or order them by field

Query

offsetnumber

Page offset of the results to return

Default 0

Example: offset=0

limitnumber

Number of results per page

Default 10

Example: limit=10

filterstring

Search input, searchable by name

Example: filter=search-text

orderBystring

Field to order results by create date (createdAt) or name (name)

Example: orderBy=name

sortTypestring

Sort type, ASC for ascending, DESC for descending

Enum"ASC""DESC"

Example: sortType=ASC

curl -i -X GET \
  https://api.frontegg.com/entitlements/resources/feature-flags/v1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

itemsArray of objects(FeatureFlagDto)

hasNextboolean

Response

application/json

{
  "items": [
    { … }
  ],
  "hasNext": true
}

Create Feature Flag

Request

Create a new feature flag

Bodyapplication/jsonrequired

namestringrequired

String that represent the feature flag name

Example: "Test Feature Flag"

onbooleanrequired

Boolean indicating whether the feature flag is on

Example: true

offTreatmentstringrequired

Enum that represents the treatment in case feature flag is off

Enum"true""false"

Example: "false"

defaultTreatmentstringrequired

Enum that represents the default treatment

Enum"true""false"

Example: "true"

featureIdstringrequired

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 POST \
  https://api.frontegg.com/entitlements/resources/feature-flags/v1 \
  -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"
}

Get Single Feature Flag

Request

Retrieve a single feature flag

Path

idstringrequired

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

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"
}

Update Feature Flag

Request

Update an existing feature flag

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 feature flag

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

Entitlements Overview

Features

Plans

Entitlements

Feature Flags

Get Feature Flags

Request

Responses

How useful was this page?

Create Feature Flag

Request

Responses

How useful was this page?

Get Single Feature Flag

Request

Responses

How useful was this page?

Update Feature Flag

Request

Responses

How useful was this page?

Delete Feature Flag

Request

Responses

How useful was this page?

API Access Control

Entitlements Overview

Features

Plans

Entitlements

Feature Flags

Get Feature Flags

Request

Responses

How useful was this page?

Create Feature Flag

RequestExpand all

Responses

How useful was this page?

Get Single Feature Flag

Request

Responses

How useful was this page?

Update Feature Flag

RequestExpand all

Responses

How useful was this page?

Delete Feature Flag

Request

Responses

How useful was this page?

API Access Control

Request

Request