{"_id":"5963a7b1bccb96001bd60929","project":"54aa7f773b56130b0056c86e","version":{"_id":"55781fe25129590d003ff4f7","project":"54aa7f773b56130b0056c86e","forked_from":"54aa7f773b56130b0056c871","__v":6,"createdAt":"2015-06-10T11:30:42.700Z","releaseDate":"2015-06-10T11:30:42.700Z","categories":["55781fe35129590d003ff4f8","55781fe35129590d003ff4f9","55781fe35129590d003ff4fa","55781fe35129590d003ff4fb","55781fe35129590d003ff4fc","55781fe35129590d003ff4fd","55781fe35129590d003ff4fe","564bbc7e8841060d00abb2ee","565b66c446118c0d00dcb0bb","56898269f8dc340d00308c13","582318b23b961a0f009516a1","594a848c9f4771001a43c959"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Developers","version_clean":"2.0.0","version":"2.0"},"category":{"_id":"564bbc7e8841060d00abb2ee","__v":10,"pages":["564bbf454bf5c80d0020901e","564bc1b08b1c5521002bb914","564c387b9baa330d00faa622","564c3a7b61008d17006ffa3a","564c3e4083b72c2b00b36fb6","564c431b61008d17006ffa46","564c4bc9b9cdb41700a0eae7","564c4e955f9d102b00fc3b4a","564c5f32c241881700d85981","564c68a93eb8f81700838a25"],"project":"54aa7f773b56130b0056c86e","version":"55781fe25129590d003ff4f7","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-11-17T23:47:10.058Z","from_sync":false,"order":1,"slug":"pulsate-cms-api","title":"Pulsate CMS API"},"user":"54aa7f3f9bb00c0b00cb899b","githubsync":"","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-10T16:13:37.242Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"OK","language":"json","status":200},{"name":"","code":"INTERNAL SERVER ERROR","language":"json","status":500}]},"settings":"564bbbf80cbcc91700b8171c","examples":{"codes":[{"code":"   curl https://control.pulsatehq.com/api/v1/health_check","language":"shell"}]},"method":"get","auth":"never","params":[],"url":"/health_check"},"isReference":true,"order":28,"body":"This endpoints provides a way of checking Admin API availability. A successful response is characterised 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 Admin API is operating without errors. An unsuccessful response indicates an internal error, which can negatively affect platform's availability to serve requests.","excerpt":"","slug":"health-check","type":"endpoint","title":"CMS API Health Check"}

getCMS API Health Check


Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format


Documentation

This endpoints provides a way of checking Admin API availability. A successful response is characterised 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. A successful response means the Admin API is operating without errors. An unsuccessful response indicates an internal error, which can negatively affect platform's availability to serve requests.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}