Sign in

v4

latestOpenAPI 3.0.02026-08-04109113304.5 KB
Environments

Get Environments by Project

Get all of the Environments that have been created in a given Project

get/environments

Query parameters

per_pageinteger

Optional pagination argument that specifies the maximum number of objects to return per request

pageinteger

Optional pagination argument that specifies the page to return. If you have 140 objects and you choose to return 100 objects per page you will be able to access the last 40 objects on page 2. The default value is 1.

project_idinteger required

The ID of the project for which you would like to get Environments

Response

Return all Environments in a specified Project

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
  }
]