Entity Feature Flag | Quest Protocol

Quest Protocol

Get specific flag info

get

Get specific flag info.

Path parameters

entityIdstringrequired

flagNamestringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/featureFlags/{flagName}?entityId=dummy-entityid' \
  --header 'apikey: test'

200

400

401

500

{
  "success": true,
  "data": {
    "entityId": "entity123",
    "flagName": "Flag Name",
    "description": "Flag description",
    "isActive": true,
    "isEnabled": true,
    "createdAt": "2023-06-27T12:45:00Z",
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

Successful response

Get all feature flags via Server-Sent Events

get

Get all feature flags via Server-Sent Events.

Path parameters

entityIdstringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

Responses

text/event-stream

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/featureFlags/stream?entityId=dummy-entityid' \
  --header 'apikey: test'

200

400

401

500

text

Successful response

Toggle feature flag of an Entity

post

Toggle feature flag of specific entity.

Path parameters

entityIdstringrequired

flagNamestringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

tablestringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/featureaFlags/{flagName}/toggle?entityId=dummy-entityid&userId=dummy-userid&table=text' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

400

401

500

{
  "success": true,
  "data": {
    "entityId": "entity123",
    "flagName": "Flag Name",
    "description": "Flag description",
    "isActive": true,
    "isEnabled": true,
    "createdAt": "2023-06-27T12:45:00Z",
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

Successful response

Terminate Feature Flag For Entity

get

Terminate Feature Flag For Entity

Path parameters

entityIdstringrequired

flagNamestringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/featureFlags/{flagName}/terminate?entityId=dummy-entityid&userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

400

401

500

{
  "success": true,
  "data": {
    "entityId": "entity123",
    "flagName": "Flag Name",
    "description": "Flag description",
    "isActive": true,
    "isEnabled": true,
    "createdAt": "2023-06-27T12:45:00Z",
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

Successful response

Get entity level flags of an Entity

post

Get entity level flags of a particular Entity

Path parameters

entityIdstringrequired

forEntityIdstringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/forEntityId/{forEntityId}/featureFlags?entityId=dummy-entityid&userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

400

401

500

{
  "success": true,
  "flags": {
    "entityId": "entity123",
    "flagName": "Flag Name",
    "description": "Flag description",
    "isActive": true,
    "isEnabled": true,
    "createdAt": "2023-06-27T12:45:00Z",
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

Successful response

Get All Feature Flags for an Entity

get

Get all Feature Flags for specific entity.

Path parameters

entityIdstringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/featureFlags?entityId=dummy-entityid' \
  --header 'apikey: test'

200

400

401

500

{
  "success": true,
  "data": {
    "entityId": "entity123",
    "flagName": "Flag Name",
    "description": "Flag description",
    "isActive": true,
    "isEnabled": true,
    "createdAt": "2023-06-27T12:45:00Z",
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

Successful response

Add new feature flag

post

Add new feature flag info of specific entity.

Path parameters

entityIdstringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

descriptionstringoptional

flagNamestringoptional

isEnabledbooleanoptional

metadataobjectoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/featureFlags?entityId=dummy-entityid&userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": "text",
    "flagName": "text",
    "isEnabled": true,
    "metadata": {
      "forEntityIds": [
        "text"
      ]
    }
  }'

200

400

401

500

{
  "success": true,
  "invalidForEntityIds": [
    [
      "entityId1",
      "entityId2"
    ]
  ]
}

Successful response

Update feature flag info

post

Update feature flag info of specific entity.

Path parameters

entityIdstringrequired

flagNamestringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

Body

descriptionstringoptional

metadataobjectoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/featureFlags/{flagName}/update?entityId=dummy-entityid' \
  --header 'apikey: test' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": "text",
    "metadata": {
      "forEntityIds": [
        "text"
      ]
    }
  }'

200

400

401

500

{
  "success": true,
  "invalidForEntityIds": [
    [
      "entityId1",
      "entityId2"
    ]
  ]
}

Successful response

Get specific flag info

Get all feature flags via Server-Sent Events

Toggle feature flag of an Entity

Terminate Feature Flag For Entity

Get entity level flags of an Entity

Get All Feature Flags for an Entity

Add new feature flag

Show child attributes

Update feature flag info

Show child attributes