{"_id":"59c07ea2a00f90001cd75cbc","category":{"_id":"59c07ea1a00f90001cd75cb3","version":"59c07ea1a00f90001cd75cb1","project":"56c27a9a2be66d19008d618d","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-16T01:50:19.202Z","from_sync":false,"order":1,"slug":"reference-api-documentation","title":"Reference API Documentation"},"project":"56c27a9a2be66d19008d618d","user":"56c27a665da27c17003df001","parentDoc":null,"version":{"_id":"59c07ea1a00f90001cd75cb1","project":"56c27a9a2be66d19008d618d","__v":1,"createdAt":"2017-09-19T02:19:13.858Z","releaseDate":"2017-09-19T02:19:13.858Z","categories":["59c07ea1a00f90001cd75cb2","59c07ea1a00f90001cd75cb3"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Rose","version_clean":"5.1.0","version":"5.1"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-08T07:25:36.494Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","language":"json","code":""}]},"settings":"56c2818b2be66d19008d6196","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"message\": \"Hello API Client\"\n}","name":""},{"status":400,"language":"json","code":"{\n    \"type\": \"ERROR\",\n    \"code\": 4000,\n    \"message\": \"Invalid API key\"\n}","name":""}]},"method":"get","auth":"required","params":[],"url":"/ping"},"isReference":true,"order":8,"body":"Use this simple resource to test the connectivity between your application and the Zyllem API. All it does is return a message addressed to your API client.\n[block:api-header]\n{\n  \"type\": \"basic\"\n}\n[/block]\n##:fa-life-ring:  [Ask a question](https://developer.zyllem.com/discuss)","excerpt":"Ping the API to test your integration or the service availability.","slug":"ping","type":"endpoint","title":"/ping"}

get/ping

Ping the API to test your integration or the service availability.

Definition

{{ api_url }}{{ page_api_url }}

Result Format


Documentation

Use this simple resource to test the connectivity between your application and the Zyllem API. All it does is return a message addressed to your API client. [block:api-header] { "type": "basic" } [/block] ##:fa-life-ring: [Ask a question](https://developer.zyllem.com/discuss)