Home
API reference
Platform API reference
Platform API
Environments
Get environments

Get environments

get/v1/organizations/{organizationId}/environments
Page View

Environment endpoints allow you to manage environments in your Redox organization.

Currently, you can retrieve details for any environment(s) you're a member of.

Get environments

Retrieve a list of environments that you're a member of. You can use this query to find environment IDs.

The response contains the details for each configured environment.

Request parameters

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/organizations/{organizationId}/environments' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json'

Path Parameters

  • organizationId
    required, string

    Identifies the Redox organization that you're operating in or on behalf of.

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "environments": [
7
      {
8
        "id": "string",
9
        "name": "string",
10
        "environmentFlag": "Staging",
11
        "organization": {
12
          "id": 122
13
        }
14
      }
15
    ]
16
  }
17
}
  • meta
    object
    • version
      string

      Lists the major and minor version number for the format of the returned payload. The payload format or shape may change between minor versions, like including additional or extended fields in later versions. We include the version data in each response so that you have the option to handle the signaled differences.

  • payload
    object

    Contains the payload with details about the requested environment(s).

    • environments
      Array of object

      Contains an array of environments.

      • id
        string

        Identifies the specific environment that you're operating in or on behalf of.

      • name
        string

        Displays the human readable name of the environment.

      • environmentFlag
        string

        Indicates whether the environment is used for development, staging, or production.

        Possible Values: Production, Staging, Development
      • organization
        object

        Contains metadata about the Redox organization.

        • id
          number

          Contains the unique identifier of the Redox organization.