{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/health_check","auth":"never","method":"get","examples":{"codes":[{"language":"shell","code":" curl https://app.pulsatehq.com/api/mobile/v2/health_check"}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"OK","name":""},{"status":500,"language":"json","code":"INTERNAL SERVER ERROR","name":""}]},"params":[]},"next":{"description":"","pages":[]},"title":"SDK API Health Check","type":"endpoint","slug":"health-check-1","excerpt":"","body":"This endpoints provides a way of checking Mobile SDK API availability. A successful response is characterized by 200 OK HTTP status code. An unsuccessful response is indicated by the 500 Internal Error status code. In rare cases unsuccessful response can have a different HTTP status from the range 500-599 indicating a specific server error.\n\nA successful response means the Mobile SDK API is operating without errors. An unsuccessful response indicates an internal error, which can negatively affect platform's availability to serve requests.","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e53cd257d0c7600451a07eb","project":"54aa7f773b56130b0056c86e","version":{"version":"2.9","version_clean":"2.9.0","codename":"SDK API","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5e53cd257d0c7600451a0771","55781fe35129590d003ff4f9","55781fe35129590d003ff4fa","5e53cd257d0c7600451a0772","5e53cd257d0c7600451a0773","5e53cd257d0c7600451a0774","5e53cd257d0c7600451a0775","5e53cd257d0c7600451a0776","565b66c446118c0d00dcb0bb","56898269f8dc340d00308c13","5e53cd257d0c7600451a0777","5e53cd257d0c7600451a0778","5c73dd27e8fdc000572a206a","5e53cd257d0c7600451a0779","5e53d06dfd1a4e015bf2f152"],"_id":"5e53cd257d0c7600451a0808","project":"54aa7f773b56130b0056c86e","forked_from":"5e4fbbbda8fb41028f1861fe","__v":1,"createdAt":"2015-06-10T11:30:42.700Z","releaseDate":"2015-06-10T11:30:42.700Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Pulsate SDK API","slug":"pulsate-sdk-api","order":1,"from_sync":false,"reference":false,"_id":"5e53cd257d0c7600451a0778","project":"54aa7f773b56130b0056c86e","version":"5e53cd257d0c7600451a0808","createdAt":"2017-06-21T14:37:00.910Z","__v":0},"user":"54aa7f3f9bb00c0b00cb899b","createdAt":"2017-07-10T16:18:31.472Z","githubsync":"","__v":0,"parentDoc":null}
getSDK API Health Check
Definition
{{ api_url }}{{ page_api_url }}