Skip to main content
API docs by Redocly

OpenFeature Remote Evaluation Protocol (OFREP) (0.2.0)

Download OpenAPI specification:Download

URL: https://github.com/open-feature/protocol License: Apache-2.0

OFREP define the protocol for remote flag evaluations

OFREP Core

Required: Core APIs to implement to support OFREP.
This is the minimum set of APIs required for a flag management system to be OFREP compatible.

OFREP single flag evaluation contract

OFREP single flag evaluation request. The endpoint is called by the server providers to perform single flag evaluation.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
key
required
string
Request Body schema: application/json
object (context)

Context information for flag evaluation

targetingKey
string

A string logically identifying the subject of evaluation (end-user, service, etc).

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "context": {
    }
}

Response samples

Content type
application/json
{
  • "key": "my-flag",
  • "reason": "STATIC",
  • "variant": "string",
  • "metadata": {
    }
}

OFREP bulk flag evaluation contract

OFREP bulk evaluation request. The endpoint is called by the client providers to evaluate all flags at once.

Authorizations:
ApiKeyAuthBearerAuth
header Parameters
If-None-Match
string

The request will be processed only if ETag doesn't match any of the values listed.

Request Body schema: application/json
object (context)

Context information for flag evaluation

targetingKey
string

A string logically identifying the subject of evaluation (end-user, service, etc).

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "context": {
    }
}

Response samples

Content type
application/json
{
  • "flags": [
    ],
  • "metadata": {
    }
}