Network Health (GET)
  • 30 Jan 2024
  • 1 Minute to read
  • Contributors

    Network Health (GET)


      Article Summary

      GET /v1/networks/{id}

      Get the health status of a specific Harmony SASE network.

      Parameters:

      PropertyData TypeDescription
      id*StringID of network.

      Request Body: None

      Request Example:

      curl – X 'GET' 'https://api.perimeter81.com/api/rest/v1/networks/<NETWORK_ID>/health' -H 'Content-Type: application/json' -H 'Authorization: Bearer <ACCESS_TOKEN>'

      Response:

      Status CodeMessage/Response BodyDescription
      200NetworkHealthThe overall health of the network.
      401
      Unauthorized request
      404
      Network not found

      Response Example:

      {
         "data":[
            {
               "type":"gateway",
               "meta":{
                  "networkId":"<NETWORK_ID>",
                  "instanceId":"<GATEWAY_ID>"
               },
               "status":"passing"
            },
            {
               "type":"tunnel",
               "meta":{
                  "networkId":"<NETWORK_ID>",
                  "instanceId":"<TUNNEL_ID>",
                  "tunnelName":"<TUNNEL_NAME>"
               },
               "status":"passing"
            },
            {
                  ...
            }
         ]
      }




      Was this article helpful?

      What's Next