Environment

The Environment API alows you to retrieve information about Environments within an organization.

API SUBPATH: eva-environment

Per default, the eva-environment API has it's network policy blocking external access. The following documentation has Syntphony CAI server clients as their target. If you are an eva-cloud customer, the tasks berformed below must be instead requested by submitting a ticket.

Retrieves all existing environments of an organization.

get

/org/{orgUUID}/environments

Path parameters

orgUUIDstringrequired

A valid organization Uuid

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/environments'

200

400

401

403

404

409

422

500

200

{
  "uuid": "text",
  "organizationUuid": "text",
  "instanceUuid": "text",
  "instanceName": "text",
  "channelInstanceUuid": "text",
  "channelInstanceName": "text",
  "connectorInstanceUuid": "text",
  "connectorInstanceName": "text",
  "dns": "text",
  "apiURL": "text",
  "name": "text",
  "removed": true,
  "channelApiUrl": "text",
  "connectorApiUrl": "text",
  "applications": [
    {
      "version": "text",
      "name": "text",
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "permissions": [
    "text"
  ]
}

OK

Retrieves all existing environments.

get

/org/{orgUUID}/environments/{envUUID}

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/environments/{envUUID}'

200

400

401

403

404

409

422

500

200

{
  "uuid": "text",
  "organizationUuid": "text",
  "instanceUuid": "text",
  "instanceName": "text",
  "channelInstanceUuid": "text",
  "channelInstanceName": "text",
  "connectorInstanceUuid": "text",
  "connectorInstanceName": "text",
  "dns": "text",
  "apiURL": "text",
  "name": "text",
  "removed": true,
  "channelApiUrl": "text",
  "connectorApiUrl": "text",
  "applications": [
    {
      "version": "text",
      "name": "text",
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "permissions": [
    "text"
  ]
}

OK