Create an Environment

1 min

POST

https://api.optimizely.com/v2/environments

Create an Environment in a provided Project

Body Parameters

bodyEnvironmentrequired
Description
A string in JSON format that includes all the fields to create an Environment
- archivedboolean
  Description
  Boolean representing whether the Environment is archived.
- datafileDatafile
  - idinteger
    Description
    ID of Datafile.
  - latest_file_sizeinteger
    Description
    The current size in bytes of the Datafile.
  - other_urlsstring[]
    Description
    List of other URLs where this Datafile is also available.
  - revisioninteger
    Description
    Current revision number.
  - sdk_keystring
    Description
    Unique key to identify this specific Environment and Datafile programmatically in our SDKs.
  - urlstring<url>
    Description
    URL where this Datafile is available.
    Format
    url
- descriptionstring
  Example
  For testing purposes before deploying to Production
  Description
  A short description of the Environment.
- has_restricted_permissionsboolean
  Description
  Boolean representing whether starting experiments should be restricted to publishers and above in this Environment.
  Default
  false
- keystringrequired
  Description
  Unique string identifier for this Environment within the Project.
  Max Length
  64
  Pattern
  ^[a-zA-Z0-9_\-]+$
- namestringrequired
  Example
  Staging
  Description
  Name of the Environment.
- priorityinteger
  Example
  3
  Description
  Integer representing the priority of the Environment. This is used for ordering in the UI.
- project_idintegerrequired
  Description
  ID of the project of the Environment.

Responses

201Return the created Environment

Environment
- archivedboolean
  Description
  Boolean representing whether the Environment is archived.
- createdstring
  Description
  Created time.
- datafileDatafile
  - idinteger
    Description
    ID of Datafile.
  - latest_file_sizeinteger
    Description
    The current size in bytes of the Datafile.
  - other_urlsstring[]
    Description
    List of other URLs where this Datafile is also available.
  - revisioninteger
    Description
    Current revision number.
  - sdk_keystring
    Description
    Unique key to identify this specific Environment and Datafile programmatically in our SDKs.
  - urlstring<url>
    Description
    URL where this Datafile is available.
    Format
    url
- descriptionstring
  Example
  For testing purposes before deploying to Production
  Description
  A short description of the Environment.
- has_restricted_permissionsboolean
  Description
  Boolean representing whether starting experiments should be restricted to publishers and above in this Environment.
  Default
  false
- idinteger
  Description
  ID of this Environment.
- is_primaryboolean
  Description
  Boolean representing if this is the primary (default) Environment.
- keystringrequired
  Description
  Unique string identifier for this Environment within the Project.
  Max Length
  64
  Pattern
  ^[a-zA-Z0-9_\-]+$
- last_modifiedstring
  Description
  Last modification time.
- namestringrequired
  Example
  Staging
  Description
  Name of the Environment.
- priorityinteger
  Example
  3
  Description
  Integer representing the priority of the Environment. This is used for ordering in the UI.
- project_idintegerrequired
  Description
  ID of the project of the Environment.

400Invalid request body supplied

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

401Invalid credentials

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

403You do not have permission to create an Environment in the specified Project

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

defaultUnexpected error

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

curl

curl --request POST \
     --url https://api.optimizely.com/v2/environments \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "key": "",
     "name": "Staging",
     "project_id": ""
     }'

javascript

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

var raw = JSON.stringify({
   "key": "",
   "name": "Staging",
   "project_id": ""
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.optimizely.com/v2/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/v2/environments")

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

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "key": "",
   "name": "Staging",
   "project_id": ""
})

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

python

import requests
import json

url = "https://api.optimizely.com/v2/environments"

payload = json.dumps({
   "key": "",
   "name": "Staging",
   "project_id": ""
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

201

// Return the created Environment
{
  "archived": false,
  "created": "",
  "datafile": {
    "id": 0,
    "latest_file_size": 0,
    "other_urls": [
      ""
    ],
    "revision": 0,
    "sdk_key": "",
    "url": ""
  },
  "description": "For testing purposes before deploying to Production",
  "has_restricted_permissions": false,
  "id": 0,
  "is_primary": false,
  "key": "",
  "last_modified": "",
  "name": "Staging",
  "priority": 3,
  "project_id": 0
}

400

// Invalid request body supplied
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

401

// Invalid credentials
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

403

// You do not have permission to create an Environment in the specified Project
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

default

// Unexpected error
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}