PHphala
CVMs

Get CVM network info

Changed on

Returns gateway status (internal IP, handshake time, public URLs) and the three network layers: gateway ingress from the compose (ingress), direct port mappings (port_mappings, as GET /ports) and the KMS/gateway URLs updates send (endpoints).

get/api/v1/cvms/{cvm_id}/network

Request

Path parameters

cvm_idstring required

Response

Network info (may have error if offline)

is_onlineboolean required
is_publicboolean
errorstring nullable
internal_ipstring nullable
latest_handshakestring date-time nullable

Example response

{
  "port_mappings": [
    {
      "id": "pm_0123abcd"
    }
  ]
}

Changes

  • c71a8dc90391Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status