Get supported engines

The GET/api/engine/list endpoint returns the list of supported engines.

Click to show example commands to get the list of registered engines

HTTP REST APISDK

projectId="<replacewithprojectid>"
openapikey="<replacewithopenapikey>"

# get list of registered engines
curl -L -X GET "https://api.mike-cloud-test.com/api/compute/engine/list" \
  -H 'api-version: 2' \
  -H 'dhi-service-id: engine' \
  -H "dhi-project-id: $projectId" \
  -H "dhi-open-api-key: $openapikey"

var response = await computeClient.GetEngineDefinitionsAsync(projectId);

Sample reponse:

[
  {
       "name": "FemEngineHD",
        "description": "MIKE 21 Flow Model engine",
        "allowedRunParameters": [
            "SubdomainsPerNode",
            "ThreadsPerSubdomain"
        ],
        "versions": [
            "2019.1",
            "2020.0",
            "2020.1",
            "2021.0",
            "2021.1",
            "2022.0",
            "2022.1",
            "2023.0"
        ]
    },
  {
    ...
  }
]

Get engine information

The GET/api/engine/{engineName} endpoint returns the engine information.

Click to show example commands to get the engine information

HTTP REST APISDK

projectId="<replacewithprojectid>"
openapikey="<replacewithopenapikey>"
engineName="FemEngineSW" # see /api/engine/list for supported engines

# get engine information
curl -L -X GET "https://api.mike-cloud-test.com/api/compute/engine/$engineName" \
  -H 'api-version: 2' \
  -H 'dhi-service-id: engine' \
  -H "dhi-project-id: $projectId" \
  -H "dhi-open-api-key: $openapikey"

var response = await computeClient.GetEngineDefinitionAsync(projectId, "FemEngineSW");

Sample reponse:

{
    "name": "FemEngineSW",
    "description": "MIKE 21 Spectral wave engine",
    "allowedRunParameters": [
        "SubdomainsPerNode",
        "ThreadsPerSubdomain"
    ],
    "versions": [
        "2019.1",
        "2020.0",
        "2020.1",
        "2021.0",
        "2021.1",
        "2022.0",
        "2022.1",
        "2023.0"
    ]
}