Skip to main content
API docs by Redocly

Edge API (1)

Download OpenAPI specification:Download

Get flags

Retrieve the flags for an environment.

Authorizations:
EnvironmentKeyAuth

Responses

Response samples

Content type
application/json
{
  • "flags": {
    • "enabled": true,
    • "feature_state_value": "a-remote-config-value",
    • "feature": {
      • "id": 42,
      • "name": "show_hero_banner",
      • "type": "STANDARD"
      }
    }
}

Get identity flags and traits

Retrieve the flags and traits for an identity. Note: identity will be lazily created if it does not already exist.

Authorizations:
EnvironmentKeyAuth
query Parameters
identifier
required
string

Identity Key

Responses

Response samples

Content type
application/json
[
  • {
    • "flags": {
      • "flags": {
        • "enabled": true,
        • "feature_state_value": "a-remote-config-value",
        • "feature": {
          }
        }
      },
    • "traits": [
      • {
        • "trait_key": "Name",
        • "trait_value": "B.A. Baracus"
        }
      ]
    }
]

Identify user

Identify a user and retrieve their flags and traits in response.

Authorizations:
EnvironmentKeyAuth
Request Body schema: application/json
Array of objects (Trait)
identifier
string

Responses

Request samples

Content type
application/json
{
  • "traits": [
    • {
      • "trait_key": "Name",
      • "trait_value": "B.A. Baracus"
      }
    ],
  • "identifier": "string"
}

Response samples

Content type
application/json
[
  • {
    • "identifier": "ba@hotmail.com",
    • "flags": {
      • "flags": {
        • "enabled": true,
        • "feature_state_value": "a-remote-config-value",
        • "feature": {
          }
        }
      },
    • "traits": [
      • {
        • "trait_key": "Name",
        • "trait_value": "B.A. Baracus"
        }
      ]
    }
]

Bulk insert identities (overwrite)

Bulk uploading identities and traits. If there is an existing identity, using POST will overwrite the existing identity with the data from the request.

It has a limit of 100 identities per request.

Authorizations:
EnvironmentKeyAuth
Request Body schema: application/json
Array of objects (IdentitiesRequestData)

Responses

Request samples

Content type
application/json
{
  • "data": [
    • {
      • "traits": [
        • {
          }
        ],
      • "identifier": "string"
      }
    ]
}

Bulk insert identities (update)

Bulk uploading identities and traits. If there is an existing identity, using PUT will update the existing identity with the data from the request.

It has a limit of 100 identities per request.

Authorizations:
EnvironmentKeyAuth
Request Body schema: application/json
Array of objects (IdentitiesRequestData)

Responses

Request samples

Content type
application/json
{
  • "data": [
    • {
      • "traits": [
        • {
          }
        ],
      • "identifier": "string"
      }
    ]
}