List Environments

1 min

GET

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

Get a list of Environments within a Project You can use query parameters to filter/sort the response.

Path Parameters

project_idintegerrequired
Example
12345
Description
The project identifier

Query Parameters

per_pageinteger<int64>
Description
The max number of items to include per page or results.
Format
int64
page_tokenstring
Description
Pagination page token. Implements prev, next, last, first
page_windowinteger
Description
Number of previous and next page links to supply for the request (defaults to 1).
archivedboolean
Description
Filter the Environments by archived. An Environment can be either archived (archived=true) or unarchived (archived=false)
sortstring[]
Description
Sort the Environments based on the attributes from left to right.

Responses

200

Successful retrieval of a page of Environments.

The response includes RESTful JSON (https://restfuljson.org/) styled links and pagination metadata. Objects in this API MAY include a url property for a link to itself and MAY append _url to properties for related links. If a link is not present in the response, it indicates a user is not authorized to access the related resource.

Environments
- countintegerrequired
  Example
  2
  Description
  Number of Environments on the current page.
- filter_urlobject
  Description
  Url template like '.../{?filter}'
  - UrlValue
- first_urlobjectrequired
  Description
  Link to first page of Environments in a series.
  - UrlValue
- itemsEnvironment[]required
  - account_idinteger<int64>
    Description
    The ID of the Account
    Format
    int64
  - archivedbooleanrequired
  - idinteger<int64>
    Description
    The ID of the Environment
    Format
    int64
  - keystringrequired
    Example
    production
    Description
    User-facing key to identify this Environment.
    Max Length
    64
    Pattern
    ^[a-zA-Z0-9_\-]+$
  - namestringrequired
    Example
    Production
    Description
    Name of the Environment.
  - priorityintegerrequired
    Example
    1
    Description
    Integer representing the priority of the Environment. This is used for ordering in the UI.
  - project_idinteger<int64>required
    Description
    The ID of the Project this Flag belongs to
    Format
    int64
  - revisioninteger
    Description
    Revision number for tracking changes
  - rolestring
    Example
    admin
    Description
    Granular permission role
- last_urlobjectrequired
  Description
  Link to the last page of Environments in a series.
  - UrlValue
- next_urlobject
  Description
  List of links to next pages of Environments in a series.
  
  The first element in the array is the exact next page after the current record, etc.
  - UrlList
- pageintegerrequired
  Example
  5
  Description
  Number of the current page. 1-index based.
- prev_urlobject
  Description
  List of links to previous pages of Environments in a series.
  
  The first element in the array is the exact previous page before the current record, etc.
  - UrlList
- reset_urlobject
  Description
  Link to the default pages of Environments
  - UrlValue
- total_countintegerrequired
  Example
  20
  Description
  Total number of Environments for this series.
- total_pagesintegerrequired
  Example
  10
  Description
  Total number of pages for this series.
- urlobjectrequired
  Description
  Link to self
  - UrlValue

400Malformed requests and invalid parameter names and types

401Invalid credentials

403Do not have permission to perform the operation

curl

curl --request GET \
     --url https://api.optimizely.com/flags/v1//projects/{project_id}/environments \
     --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}/environments", 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}/environments")

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}/environments"

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

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

print(response.text)

200

// Successful retrieval of a page of Environments.
The response includes RESTful JSON (https://restfuljson.org/) styled links and pagination metadata.
Objects in this API MAY include a url property for a link to itself and MAY append _url to properties for related links.
If a link is not present in the response, it indicates a user is not authorized to access the related resource.
{
  "count": 2,
  "filter_url": {},
  "first_url": {},
  "items": [
    {
      "account_id": "",
      "archived": false,
      "id": "",
      "key": "production",
      "name": "Production",
      "priority": 1,
      "project_id": "",
      "revision": 0,
      "role": "admin"
    }
  ],
  "last_url": {},
  "next_url": {},
  "page": 5,
  "prev_url": {},
  "reset_url": {},
  "total_count": 20,
  "total_pages": 10,
  "url": {}
}

400

// Malformed requests and invalid parameter names and types

401

// Invalid credentials

403

// Do not have permission to perform the operation