{"_id":"576d42354bcd290e00428957","user":"56bc6af27c91881900089bac","__v":0,"parentDoc":null,"version":{"_id":"576d42354bcd290e00428941","project":"56a526d4e7a1622b0024fae4","__v":1,"createdAt":"2016-06-24T14:22:45.076Z","releaseDate":"2016-06-24T14:22:45.076Z","categories":["576d42354bcd290e00428942","576d42354bcd290e00428943","576d42354bcd290e00428944","576d42354bcd290e00428945","576d42354bcd290e00428946","576d42354bcd290e00428947"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"project":"56a526d4e7a1622b0024fae4","category":{"_id":"576d42354bcd290e00428944","__v":0,"version":"576d42354bcd290e00428941","project":"56a526d4e7a1622b0024fae4","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-11T11:25:07.821Z","from_sync":false,"order":0,"slug":"objective-c","title":"Our API"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-11T15:40:05.836Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","settings":"","auth":"never","params":[],"url":"/ping"},"isReference":true,"order":1,"body":"[block:textarea]\n{\n  \"text\": \"## Request\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"import requests\\n\\nurl = 'https://api.chirp.io/v1/ping'\\n\\nresponse = requests.get(url)\",\n      \"language\": \"python\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n[block:textarea]\n{\n  \"text\": \"## Results\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"name\": 200,\n      \"code\": \"{\\n  \\\"pong\\\": true\\n}\",\n      \"language\": \"json\",\n      \"status\": 200\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"Query the API server's status.","slug":"api-ping","type":"endpoint","title":"/ping"}

get/ping

Query the API server's status.

Definition

{{ api_url }}{{ page_api_url }}

Documentation

[block:textarea] { "text": "## Request", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "import requests\n\nurl = 'https://api.chirp.io/v1/ping'\n\nresponse = requests.get(url)", "language": "python" } ], "sidebar": true } [/block] [block:textarea] { "text": "## Results", "sidebar": true } [/block] [block:code] { "codes": [ { "name": 200, "code": "{\n \"pong\": true\n}", "language": "json", "status": 200 } ], "sidebar": true } [/block]

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 }}