environments

Get Manifests of Multiple Environments

Retrieves the manifests of all environments of an application.

get/apps/{appId}/environments

Request

  • Base URL
    https://privatecloud.mendixcloud.com/api/v4
  • Auth
    API key in header Authorization

Query parameters

offsetinteger

Used with paging and defines the offset. The default value is 0.

limitinteger

Used with paging and defines the maximum amount of objects to return. The default value is 20.

Response

The environments manifests response returned by a get-environments-manifests request.

Example response

{
  "environments": [
    {
      "manifestVersion": "2.0.0",
      "environment": {
        "id": "e9m3vf7f",
        "properties": {
          "name": "my-environment",
          "environmentPurpose": "Test"
        },
        "deployment": {
          "appUrl": "https://test.app.url",
          "packageId": "045b8cf4-c9cd-41b4-b241-414b87a7f219",
          "constants": [
            {
              "name": "MyFirstModule.Constant_Name",
              "value": "2022-03-10T13:15:00"
            }
          ],
          "scheduledEvents": [
            {
              "name": "MyFirstModule.Scheduled_event1"
            }
          ],
          "appLogLevels": [
            {
              "name": "MY_LOG_LEVEL",
              "level": "DEBUG"
            }
          ]
        },
        "container": {
          "state": "Ready",
          "instances": 3,
          "lastRunningInstanceCount": 3,
          "coreResources": {
            "limits": {
              "cpu": "1",
              "memory": "0.512",
              "ephemeralStorage": "1"
            },
            "requests": {
              "cpu": "1",
              "memory": "0.512",
              "ephemeralStorage": "1"
            }
          }
        },
        "network": {
          "outgoingConnectionCertificate": [
            {
              "password": "base64 encoded string, e.g.  dGVzdA==",
              "certificateType": "Client",
              "key": "long base64 encoded .pfx file"
            }
          ]
        },
        "runtime": {
          "runtimeVersion": "9.24.2",
          "environmentVariables": [
            {
              "name": "custom-env-variable1",
              "value": "custom-env-variable1-value"
            }
          ],
          "customRuntimeSettings": [
            {
              "name": "HashAlgorithm",
              "value": "BCRYPT"
            }
          ]
        },
        "provider": {
          "clusterId": "a712d8f4-a77c-4189-a211-e0ea1dfde03c",
          "namespace": "my-namespace",
          "namespaceId": "db6ed4d3-8b6d-4c2b-ad2b-2a69d0f7afe0"
        },
        "annotations": [
          {
            "key": "prometheus.io/port",
            "value": "8900",
            "annotationType": "Pod"
          }
        ],
        "services": [
          {
            "name": "ephemeral_db",
            "plan": "OnDemand",
            "config": "{type: \\\"database\\\"}"
          }
        ],
        "runtimeMetricsConfiguration": {
          "mode": "native",
          "interval": "https://docs.mendix.com/refguide/custom-settings/#11-durationinterval-settings",
          "mxAgentConfig": "https://docs.mendix.com/developerportal/deploy/private-cloud-monitor/#configuring-mxagent",
          "mxAgentInstrumentationConfig": "https://docs.mendix.com/developerportal/deploy/private-cloud-monitor/#configuring-mxagent"
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.