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

orgUUID*string

A valid organization Uuid

Response

200400401403404409422500

OK

Body

*/*

uuidstring

organizationUuidstring

instanceUuidstring

instanceNamestring

channelInstanceUuidstring

channelInstanceNamestring

connectorInstanceUuidstring

connectorInstanceNamestring

dnsstring

apiURLstring

namestring

removedboolean

channelApiUrlstring

connectorApiUrlstring

applicationsarray of ApplicationDTO (object)

permissionsarray of string

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/environments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

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

Retrieves all existing environments.

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

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

Response

200400401403404409422500

OK

Body

*/*

uuidstring

organizationUuidstring

instanceUuidstring

instanceNamestring

channelInstanceUuidstring

channelInstanceNamestring

connectorInstanceUuidstring

connectorInstanceNamestring

dnsstring

apiURLstring

namestring

removedboolean

channelApiUrlstring

connectorApiUrlstring

applicationsarray of ApplicationDTO (object)

permissionsarray of string

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/environments/{envUUID}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

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