hmLoadTopic({
hmKeywords:"",
hmTitle:"Health",
hmDescription:"The purpose of these endpoints is to provide a quick mechanism for determining whether the service is listening.",
hmPrevLink:"lk_scopes-list.html",
hmNextLink:"lk_user-operations.html",
hmParentLink:"lk_admin-operations.html",
hmBreadCrumbs:"<a href=\"lk_linkarws-operations.html\">LinkarWS Operations<\/a> &gt; <a href=\"lk_admin-operations.html\">Admin Operations<\/a>",
hmTitlePath:"LinkarWS Operations > Admin Operations > Health",
hmHeader:"<h1 class=\"p_Heading1\" style=\"page-break-after: avoid;\"><span class=\"f_Heading1\">Health<\/span><\/h1>\n\r",
hmBody:"<p class=\"p_Normal\">The purpose of these endpoints is to provide a quick mechanism for determining whether the service is listening.<\/p>\n\r<p class=\"p_Normal\">The endpoint returns the string “UP” if the connection is correct.<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\"><span style=\"font-weight: bold;\">GET<\/span>: api\/v1\/health\/{entrypointName}\/{svr_timeout}<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\">Examples:  &nbsp; &nbsp; &nbsp; &nbsp;api\/v1\/health<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 5.6875rem;\"><span style=\"width:0.3125rem;display:inline-block\">&nbsp;<\/span><\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 5.6875rem;\"> api\/v1\/health\/MYENTRYPOINT\/3<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 5.6875rem;\">&nbsp;<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 5.6875rem;\"><span style=\"width:0.3125rem;display:inline-block\">&nbsp;<\/span>api\/v1\/health?entrypointName=MYENTRYPOINT&amp;svr_timeout=3<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\"><span style=\"font-size: 1.09rem; font-weight: bold;\">Parameters or headers (as you prefer)<\/span><\/p>\n\r<p class=\"p_Normal\" style=\"text-indent: 0; padding-left: 3.2500rem; margin-left: 0;\"><span class=\"f_Normal\" style=\"font-family: Arial,\'Lucida Sans Unicode\',\'Lucida Grande\',\'Lucida Sans\';display:inline-block;width:0.8125rem;margin-left:-0.8125rem\">&#8226;<\/span>entrypointName<\/p><p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 3.2500rem;\">If a valid value is given to this parameter, an operation is launched against that EntryPoint and the availability of that EntryPoint is evaluated.<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 3.2500rem;\">If any free lines are found, or lines on demand that have not been opened, the EntryPoint is considered “live” and a response with code 200 and text UP is returned.<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 3.2500rem;\">If the EntryPoint is off, or there are no free lines, the EntryPoint is considered “dead” and a response with code 400 is returned.<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 3.2500rem;\">&nbsp;<\/p>\n\r<p class=\"p_Normal\" style=\"text-indent: 0; padding-left: 3.2500rem; margin-left: 0;\"><span class=\"f_Normal\" style=\"font-family: Arial,\'Lucida Sans Unicode\',\'Lucida Grande\',\'Lucida Sans\';display:inline-block;width:0.8125rem;margin-left:-0.8125rem\">&#8226;<\/span>svr_timeout<\/p><p class=\"p_Normal\" style=\"margin: 0 0 0 3.2500rem;\">This is the maximum wait time (in seconds) for the EntryPoint status query operation to complete.<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 3.2500rem;\">If no response is received within this time period, the EntryPoint is considered “dead” and a response with code 400 is returned.<\/p>\n\r<p class=\"p_Normal\" style=\"margin: 0 0 0 3.2500rem;\">The default value for this parameter is set to 3 seconds.<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\"><span style=\"font-size: 1.09rem; font-weight: bold;\">Request Body<\/span><\/p>\n\r<p class=\"p_Normal\">None<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\"><span style=\"font-size: 1.09rem; font-weight: bold;\">Responses<\/span><\/p>\n\r<p class=\"p_Normal\">Error message or string “UP” if the service or Entrypoint is available.<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r"
})
