Sign in
latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

public
RuntimeInfo

Provision and check the cluster connectivity in an environment

post/orgs/{orgId}/runtime/actions/check-connectivity

Path parameters

orgIdstring required

The Organization ID

Request body

app_idstring required

The application Id to test

env_idstring required

The environment Id to test

env_typestring required

The environment type to test

Example request

{
  "app_id": "sample-app",
  "env_id": "sample-env",
  "env_type": "development"
}

Response

The cluster connectivity test returned a result

successboolean required

Whether the test completed successfully

Example response

{
  "success": true,
  "resource_summaries": [
    {
      "type": "k8s-cluster",
      "class": "default",
      "res_id": "k8s-cluster",
      "gu_res_id": "0123456789abcdef0123456789abcdef",
      "depends_on": [
        "0123456789abcdef0123456789abcdee",
        "0123456789abcdef0123456789abcded"
      ],
      "def_id": "sample-definition",
      "def_version_id": "01234567-89ab-cdef-0123-456789abcdef",
      "driver_type": "humanitec/echo"
    }
  ],
  "conditions": [
    {
      "type": "GraphCanProvision",
      "status": "True",
      "message": "A sample message."
    }
  ]
}