Sign in

v4

latestOpenAPI 3.0.02026-08-04109113304.5 KB
Environments

Read an Environment

Get all the properties of a single Environment

get/environments/{environment_id}

Path parameters

environment_idinteger required

The unique identifier for the Environment

Response

Successfully retrieved the Environment

archivedboolean

Boolean representing whether the Environment is archived.

createdstring

Created time.

descriptionstring

A short description of the Environment.

has_restricted_permissionsboolean

Boolean representing whether starting experiments should be restricted to publishers and above in this Environment.

idinteger

ID of this Environment.

is_primaryboolean

Boolean representing if this is the primary (default) Environment.

keystring required

Unique string identifier for this Environment within the Project.

last_modifiedstring

Last modification time.

namestring required

Name of the Environment.

priorityinteger

Integer representing the priority of the Environment. This is used for ordering in the UI.

project_idinteger required

ID of the project of the Environment.

Example response

{
  "description": "For testing purposes before deploying to Production",
  "name": "Staging",
  "priority": 3
}