API Documentation

Get feature flag definition in environment

get https://api.split.io/internal/api/v2/splits/ws///environments/

Retrieves a feature flag definition given the name and the environment.

Access requirements

The Authorization Bearer (Admin API Key authorizing the request) must have one of the following roles and scopes:

Admin API Key roles accepted

  • API_ALL_GRANTED
  • API_FEATURE_FLAG_VIEWER
  • API_FEATURE_FLAG_EDITOR

Admin API Key scopes accepted

  • GLOBAL
  • WORKSPACE
  • ENVIRONMENT

To learn more about Admin API Key roles and scopes, see API keys overview.

JSON Received

{
    "name": String,
    "environment": URN, // Containing id and name of the environment
    "killed": Boolean,
    "treatments": [ Treatment ],
    "defaultTreatment": String,
    "trafficAllocation": Number, // Between 0 and 100
    "rules": [ Rule ],
    "creationTime": Number, // Milliseconds since epoch
    "lastUpdateTime": Number, // Milliseconds since epoch
    "lastTrafficReceivedAt": Number, //Milliseconds since epoch
    "flagSets": [FlagSetAssociation] // Containing type and id
}

Detailed information of the payload structure can be found on Split Grammar.

Language