GET /api/v3/envs

Get a list of visible Environments

Request Path

GET /api/v3/envs?criteria=allowned&brief=true

Request Payload

None.

Parameters

criteria Values are allowned, allvisible. Optional, defaults to allvisible.
brief Specify whether to get brief (less information) response, or not. Optional, defaults to true.
ownerEmail Filter results by the Environment owner’s email address. Optional.
classId Filter results by the Environment’s class. Optional.

Response examples

Brief example:

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

Non brief example:

[
    {
        "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
    }
]