MEmendix
apps

Get app dashboard include all environments

Get app dashboard include all environments created in both Standalone and Connected mode

get/apps/{appId}/dashboards

Request

  • Base URL
    https://pmp-demo.privateplatform.mendix.com/deployservice/v1
  • Auth
    • HTTP basic
    • or API key in header Authorization

Path parameters

appIdstring required

App Id

Response

App environment dashboard

environmentIdstring

Environment id

clusterNamestring

Name of the cluster for the environment created

namespacestring

Cluster namespace for the environment created

storagePlanNamestring

Name of the storage plan for the environment

databasePlanNamestring

Name of the database plan for the environment

deploymentPurpose'Development' | 'Test' | 'Acceptance' | 'Production'

Purpose of the deployment

dtapModestring

DTAP mode of the environment can be Development or Production

appIdstring

Id of the application

appNamestring

Name of the application

appUrlstring

URL of the application

status'Init' | 'Waiting' | 'Building' | 'Processing' | 'Success' | 'Ready' | 'Failed' | 'Unknown'

Status of the environment

readyReplicasinteger

Number of ready replicas for the environment

replicasinteger

Total number of replicas for the environment

buildStatusstring

Status of the build process

runtimeStatusstring

Status of the runtime environment

networkStatusstring

Status of the network configuration

databaseStatusstring

Status of the database connection

storageStatusstring

Status of the storage configuration

licenseStatusstring

Status of the license

creationStatusstring

Status of the creation process

resourceStatusstring

Status of the resources

runtimeVersionstring

Version of the runtime environment

deployedBystring

Timestamp of the last start time

uptimestring

Timestamp of the last start time

uptimeChangedstring

Timestamp of the last start time

createdDatestring

Timestamp of the last start time

buildExplanationstring

Explanation for the build process

storageExplanationstring

Explanation for the storage configuration

runtimeExplanationstring

Explanation for the runtime environment

Example response

[
  {
    "environmentId": "eynu0q2x",
    "clusterName": "test-cluster",
    "namespace": "test-namespace",
    "storagePlanName": "test-storage-plan",
    "databasePlanName": "test-database-plan",
    "deploymentPurpose": "Development",
    "dtapMode": "Development",
    "appId": "0521a37c-77f3-4607-94e9-e64a32311833",
    "appName": "MyApp",
    "appUrl": "https://myapp.example.com",
    "status": "Success",
    "readyReplicas": 2,
    "replicas": 3,
    "buildStatus": "Processing",
    "runtimeStatus": "Ready",
    "networkStatus": "Ready",
    "databaseStatus": "Ready",
    "storageStatus": "Ready",
    "licenseStatus": "Licensed",
    "creationStatus": "Completed",
    "resourceStatus": "Allocated",
    "runtimeVersion": "1.0.0",
    "deployedBy": "Peter",
    "uptime": "0 min",
    "uptimeChanged": "2023-10-01T12:00:00Z",
    "createdDate": "2023-10-01T12:00:00Z",
    "buildExplanation": "Build completed successfully",
    "storageExplanation": "Storage is available and properly configured",
    "runtimeExplanation": "Runtime environment is running correctly"
  }
]

Changes

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