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

200

Successful response

application/json

400

Client error

application/json

401

Unauthorized error

application/json

500

Server error

application/json

get

GET /api/entities/{entityId}/featureFlags/{flagName} HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
Accept: */*

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

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

200

Successful response

text/event-stream

Responsestring

400

Client error

application/json

401

Unauthorized error

application/json

500

Server error

application/json

get

GET /api/entities/{entityId}/featureFlags/stream HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
Accept: */*

text

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

200

Successful response

application/json

400

Client error

application/json

401

Unauthorized error

application/json

500

Server error

application/json

post

POST /api/entities/{entityId}/featureaFlags/{flagName}/toggle HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Accept: */*

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

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

200

Successful response

application/json

400

Client error

application/json

401

Unauthorized error

application/json

500

Server error

application/json

get

GET /api/entities/{entityId}/featureFlags/{flagName}/terminate HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Accept: */*

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

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

200

Successful response

application/json

400

Client error

application/json

401

Unauthorized error

application/json

500

Server error

application/json

post

POST /api/entities/{entityId}/forEntityId/{forEntityId}/featureFlags HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Accept: */*

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

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

200

Successful response

application/json

400

Client error

application/json

401

Unauthorized error

application/json

500

Server error

application/json

get

GET /api/entities/{entityId}/featureFlags HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
Accept: */*

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

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

Responses

200

Successful response

application/json

400

Client error

application/json

401

Unauthorized error

application/json

500

Server error

application/json

post

POST /api/entities/{entityId}/featureFlags HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 94

{
  "description": "text",
  "flagName": "text",
  "isEnabled": true,
  "metadata": {
    "forEntityIds": [
      "text"
    ]
  }
}

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

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

Responses

200

Successful response

application/json

400

Client error

application/json

401

Unauthorized error

application/json

500

Server error

application/json

post

POST /api/entities/{entityId}/featureFlags/{flagName}/update HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "description": "text",
  "metadata": {
    "forEntityIds": [
      "text"
    ]
  }
}

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