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.
- metaobject
- versionstring
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.
- payloadobject
Contains the payload with details about the requested environment(s).
- environmentsArray of object
Contains an array of environments.
- idstring
Identifies the specific environment that you're operating in or on behalf of.
- namestring
Displays the human readable name of the environment.
- environmentFlagstring
Indicates whether the environment is used for development, staging, or production.
Possible Values:Production
,Staging
,Development
- organizationobject
Contains metadata about the Redox organization.
- idnumber
Contains the unique identifier of the Redox organization.