GET /api/v3/envs

Retrieves environments

Request Path

GET /api/v3/envs?criteria={criteria_value}&brief={brief_value}&ownerEmail={ownerEmail}&classID={classID}

Request Payload

None

Parameters

criteria Optional. Array. {criteria_value} can be:

  • allowned. Returns only environments owned by the user.
  • allvisible (default). Returns all environments visible to the user.
brief Optional. Boolean. Whether to return a less detailed or more detailed response. {brief_value} can be:

  • true (default). Returns less detail.
  • false. Returns more detail.
ownerEmail Optional. Filters results by the environment owner's email address, where {ownerEmail} is the environment owner's email address.
classId Optional. Filters results to include only environments created for a specified class, including instructor and student environments, where {classId} is the ID of the class.

Response Examples

brief=true

[
    {
        "name": "John's stuff",
        "id": "EN0di66meJWtV_RdHQGcG_Dw2"
    },
    {
        "name": "Web app",
        "id": "EN5YTkVIYcD6kL9flyAAYyzg2"
    },
    {
        "name": "John Doe Environment No. 5",
        "id": "ENTpOuRlNpoZge7NmnR6K6QA2"
    }
]

brief=false

[
    {
        "projectId": "PRjTcEu83MXmpDAHTf47b-QQ2",
        "policyId": "PO3wqlqS-eGepYySJV6GN3jw2",
        "blueprintId": "BPDELXAJbOn12jPeqgME9Ed12",
        "description": null,
        "ownerEmail": "johndoe@cloudshare.com",
        "regionId": "REKolD1-ab84YIxODeMGob9A2",
        "name": "John's stuff",
        "id": "EN0di66meJWtV_RdHQGcG_Dw2",
        "status":"Ready",
        "teamId":null
    },
    {
        "projectId": "PRjTcEu83MXmpDAHTf47b-QQ2",
        "policyId": "POA_LXAJbOnUyjPZGgMK9Kdw2",
        "blueprintId": "BPDELXAJbOn12jPeqgME9Ed12",
        "description": "An awesome web app",
        "ownerEmail": "johndoe@cloudshare.com",
        "regionId": "REKolD1-ab84YIxODeMGob9A2",
        "name": "Web app",
        "id": "EN5YTkVIYcD6kL9flyAAYyzg2",
        "status":"Ready",
        "teamId":null
    },
    {
        "projectId": "PRjTcEu83MXmpDAHTf47b-QQ2",
        "policyId": "POO2IC9GqXpX-hw58ph1Wwcg2",
        "blueprintId": "BPDELXAJbOn12jPeqgME9Ed12",
        "description": "Jump up and down",
        "ownerEmail": "johndoe@cloudshare.com",
        "regionId": "REKolD1-ab84YIxODeMGob9A2",
        "name": "John Doe Environment No. 5",
        "id": "ENTpOuRlNpoZge7NmnR6K6QA2",
        "status":"Ready",
        "teamId":null
    }
]