Fetch the Ruleset for a Flag in an Environment

1 min

GET

https://api.optimizely.com/flags/v1//projects/{project_id}/flags/{flag_key}/environments/{environment_key}/ruleset

Fetch a Ruleset for a Flag in a specific Environment of a project. The Ruleset contains the set of all Rules that apply to the Flag for that Environment.

Path Parameters

project_idintegerrequired
Example
12345
Description
The project identifier
flag_keystringrequired
Example
recurring_deposit
Description
The Flag identifier
environment_keystringrequired
Example
production
Description
The Environment identifier

Responses

200

Successful retrieval or update of a Ruleset.

The response includes RESTful JSON (https://restfuljson.org/) styled links. If a link is not present in the response, it indicates a user is not authorized to access the related resource.

Ruleset
Description
Rules configuration specific to an environment.
- archivedboolean
  Description
  Whether this Ruleset is archived or not. The ruleset is archived if the Flag was archived.
- default_variation_keystring
  Example
  high_discount
  Description
  User-facing Unique identifier of the Variation.
- default_variation_namestring
  Example
  High Discount
  Description
  User friendly identifer of the Variation.
- disable_urlobject
  - UrlValue
- enable_urlobject
  - UrlValue
- enabledboolean
  Description
  Indicates if the rule is enabled or not in an environment.
  Default
  false
- environment_idnumber
  Description
  Environment id.
- environment_keystringrequired
  Example
  production
  Description
  User-facing Environment identifier.
- environment_namestring
  Example
  Production
  Description
  Environment name.
- fetch_default_variation_urlstring
  Description
  A url to the variation that will be executed if no rule audience is served.
- fetch_flag_urlobject
  Description
  A url to fetch the Flag used by this Ruleset.
  - UrlValue
- flag_keystringrequired
  Example
  recurring_deposit
  Description
  User-facing Unique identifier of the Flag.
- idinteger
  Example
  23456746
- revisioninteger
  Description
  Revision number for tracking changes
- rolestring
  Example
  admin
  Description
  Granular permission role
- rule_prioritiesstring[]required
  Example
```
[
  "new_users",
  "paid_users",
  "trial_users"
]
```
  Description
  Ordered array of rule keys for the set.
- rulesobject
  - RuleMap
- statusstring<draft | running | paused>
  Description
  status of ruleset.
  Allowed
  draftrunningpaused
- update_urlobject
  - UrlValue
- updated_timestring<date-time>
  Example
  2019-05-08T00:00:00.000Z
  Description
  Timestamp when the Ruleset was last updated
  Format
  date-time
- urlobjectrequired
  Description
  Link to self
  - UrlValue
- urnstringrequired
  Example
  ruleset.flag.optimizely.com::a308d9ae-89ba-11ea-bc55-0242ac130003
  Description
  The URN for the Ruleset

400Malformed requests and invalid parameter names and types

401Invalid credentials

403Do not have permission to perform the operation

404Not found. No content

curl

curl --request GET \
     --url https://api.optimizely.com/flags/v1//projects/{project_id}/flags/{flag_key}/environments/{environment_key}/ruleset \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.optimizely.com/flags/v1//projects/{project_id}/flags/{flag_key}/environments/{environment_key}/ruleset", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.optimizely.com/flags/v1//projects/{project_id}/flags/{flag_key}/environments/{environment_key}/ruleset")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.optimizely.com/flags/v1//projects/{project_id}/flags/{flag_key}/environments/{environment_key}/ruleset"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Successful retrieval or update of a Ruleset.
The response includes RESTful JSON (https://restfuljson.org/) styled links. If a
link is not present in the response, it indicates a user is not authorized to access
the related resource.
{
  "archived": false,
  "default_variation_key": "high_discount",
  "default_variation_name": "High Discount",
  "disable_url": {},
  "enable_url": {},
  "enabled": false,
  "environment_id": 0,
  "environment_key": "production",
  "environment_name": "Production",
  "fetch_default_variation_url": "",
  "fetch_flag_url": {},
  "flag_key": "recurring_deposit",
  "id": 23456746,
  "revision": 0,
  "role": "admin",
  "rule_priorities": [
    ""
  ],
  "rules": {},
  "status": "",
  "update_url": {},
  "updated_time": "2019-05-08T00:00:00.000Z",
  "url": {},
  "urn": "ruleset.flag.optimizely.com::a308d9ae-89ba-11ea-bc55-0242ac130003"
}

400

// Malformed requests and invalid parameter names and types

401

// Invalid credentials

403

// Do not have permission to perform the operation

404

// Not found. No content