Rollouts

The Rollouts Developer Hub

Welcome to the Rollouts developer hub. You'll find comprehensive guides and documentation to help you start working with Rollouts as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Manage environments

Environments allow you to organize a project into sections that correspond to your development environments, like staging and production. With environments, you can turn a feature flag or experiment on in one context, but leave it paused in another. For example, you might turn an experiment on for your team to test in staging, but leave it turned off for users in your production application.

Your account starts with a single environment (and its datafile). When you set up a new environment, Optimizely generates:

  • An environment-specific datafile: The datafile generated for each additional environment contains the current state of all experiments for that specific environment.
  • A unique SDK key: The key determines the URL of the environment's datafile and ensures that the URL won’t be easily guessed. For SDKs that provide native datafile managers, you can use the SDK key to initialize the SDK with with the corresponding environment's datafile. See the intialize SDK guide for Android or Swift.

When you create an environment, you'll also create an environment key. This key is used for programmatic access to the environment. For example, you can modify your environments using Optimizely's REST API.

Keep separate environments to reduce the risk of accidentally launching an unfinished or unverified test to the live site. You can add as many environments to a project as you need. We recommend adding a staging environment to any project to allow a space for QA.

Create an environment

  1. Navigate to Settings > Datafile.
  2. Click New Environment.
  3. Enter the environment name and key.
  4. Specify whether you'd like to limit the ability to change the active state of a feature flag to Publishers only in this environment.
  5. Click Create Environment.

The Environment Key and Datafile URL for the new environment will display on the Settings page.

  1. Implement the datafile in your application.

Learn more about accessing the datafile and best practices for datafile management.

Note

By default, feature flags are off in any new environments that you create, even if they were previously on or running in another existing environment.

Rename an environment

  1. Navigate to Settings > Datafile.
  2. Click the Actions icon (...) for the environment you want to rename.
  3. Click Settings.
  4. Enter the new name for the environment and click Save Environment.

Archive an environment

You can archive environments if they aren’t being used anymore (except the primary environment, which can't be archived). Archiving deactivates all the datafiles in an environment, replacing them with an empty file, and removes the environment as an option for features.

If feature flags are on in the environment when you archive it, they will stop because archiving empties the datafile.

To archive an environment:

  1. Navigate to Settings > Datafile.
  2. Click the Actions icon (...) for the environment you want to archive.
  3. Click Archive.

Security

Keep your production application secure by limiting the permissions of collaborators who can turn on feature flags in your production environment.

By default, only collaborators with Publisher-level permissions make changes to the production environment. You can toggle this permission setting separately in each environment.

Updated 9 months ago


What's Next

Handle user IDs

Manage environments


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.