Skip to main content
GET
/
environments
Get all environments
curl --request GET \
  --url https://api.gputrader.io/v1/environments \
  --header 'X-API-Key: <api-key>'
[
  {
    "name": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "orgId": "<string>",
    "userId": "<string>",
    "envId": "<string>",
    "pEnvId": 123,
    "pEdgeKey": "<string>",
    "systemData": {},
    "isCompliant": true,
    "failedComplianceReason": "<string>",
    "initState": {},
    "hold": {},
    "listing": {},
    "apiKey": "<string>",
    "heartbeat": {},
    "isSeed": true
  }
]

Authorizations

​
X-API-Key
string
header
required

Response

Successfully retrieved environments

​
name
string

Environment name

​
createdAt
string<date-time>

Creation timestamp

​
updatedAt
string<date-time>

Last update timestamp

​
orgId
string

Organization ID

​
userId
string

User ID

​
envId
string

Environment ID

​
pEnvId
number

Provider environment ID

​
pEdgeKey
string

Provider edge key

​
systemData
object

System-specific data

​
isCompliant
boolean

Compliance status

​
failedComplianceReason
string

Reason for compliance failure

​
initState
object

Initialization state

​
hold
object

Hold information

​
listing
object

Environment listing details

​
apiKey
string

API key for the environment

​
heartbeat
object

Heartbeat status information

​
isSeed
boolean

Indicates if this is a seed environment