/*@jsxRuntime automatic @jsxImportSource react*/ const {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0]; const {useMDXComponents: _provideComponents} = arguments[0]; const tableOfContents = [{ "title": "Required Headers", "slug": "required-headers", "depth": 2, "children": [] }]; const codeExamples = { "request": { "type": "RequestExample", "children": [{ "filename": "cURL", "html": "

curl --request GET \\\n  --url https://ingest.dashdive.com/ping \\\n  --header 'X-API-Key: <x-api-key>'\n

" }, { "filename": "Java", "html": "

HttpResponse<String> response = Unirest.get(\n    \"https://ingest.dashdive.com/ping\")\n  .header(\"X-API-Key\", \"<x-api-key>\")\n  .asString();\n

" }, { "filename": "Python", "html": "

url = \"https://ingest.dashdive.com/ping\"\nheaders = { \"X-API-Key\": \"<x-api-key>\" }\nresponse = requests.request(\"GET\", url, headers=headers)\n\nprint(response.text)\n

" }, { "filename": "JavaScript", "html": "

const options = {\n  method: \"GET\",\n  headers: { \"X-API-Key\": \"<x-api-key>\" },\n};\n\nfetch(\"https://ingest.dashdive.com/ping\", options)\n  .then((response) => response.json())\n  .then((response) => console.log(response))\n  .catch((err) => console.error(err));\n

" }, { "filename": "Go", "html": "

url := \"https://ingest.dashdive.com/ping\"\n\nreq, _ := http.NewRequest(\"GET\", url)\n\nreq.Header.Add(\"X-API-Key\", \"<x-api-key>\")\n\nres, _ := http.DefaultClient.Do(req)\n\ndefer res.Body.Close()\nbody, _ := ioutil.ReadAll(res.Body)\n\nfmt.Println(res)\nfmt.Println(string(body))\n

" }] }, "response": { "type": "ResponseExample", "children": [{ "filename": "200", "html": "

\"PONG\"\n

" }] } }; const endpoint = { "path": "/ping", "method": "get", "request": { "security": [], "parameters": { "query": {}, "header": {}, "cookie": {}, "path": {} }, "body": {} }, "response": {}, "deprecated": false }; const MDXLayout = props => { const {MDXContentController} = _provideComponents(); if (!MDXContentController) _missingMdxReference("MDXContentController", true); return _jsx(MDXContentController, Object.assign({}, props, { tableOfContents: tableOfContents, codeExamples: codeExamples, endpoint: endpoint, pageMetadata: pageMetadata, children: props.children })); }; function _createMdxContent(props) { const _components = Object.assign({ table: "table", thead: "thead", tr: "tr", th: "th", tbody: "tbody", td: "td", p: "p", ol: "ol", li: "li" }, _provideComponents(), props.components), {Heading} = _components; if (!Heading) _missingMdxReference("Heading", true); return _jsxs(_Fragment, { children: [_jsx(Heading, { level: "2", id: "required-headers", children: "Required Headers" }), "\n", _jsxs(_components.table, { children: [_jsx(_components.thead, { children: _jsxs(_components.tr, { children: [_jsx(_components.th, { children: _jsx("div", { style: { paddingRight: 128 }, children: "Header" }) }), _jsx(_components.th, { children: _jsx("div", { style: { paddingRight: 128 }, children: "Value" }) })] }) }), _jsx(_components.tbody, { children: _jsxs(_components.tr, { children: [_jsx(_components.td, { children: "X-API-Key" }), _jsx(_components.td, { children: "" })] }) })] }), "\n", _jsx(_components.p, { children: "This endpoint can be used to ensure that:" }), "\n", _jsxs(_components.ol, { role: "list", children: ["\n", _jsx(_components.li, { children: "The Dashdive backend is currently running" }), "\n", _jsx(_components.li, { children: "The Dashdive backend is reachable from the caller" }), "\n", _jsx(_components.li, { children: "The supplied API key is valid" }), "\n"] })] }); } function MDXContent(props = {}) { return _jsx(MDXLayout, Object.assign({}, props, { children: _jsx(_createMdxContent, props) })); } return { tableOfContents, codeExamples, endpoint, default: MDXContent }; function _missingMdxReference(id, component) { throw new Error("Expected " + (component ? "component" : "object") + " `" + id + "` to be defined: you likely forgot to import, pass, or provide it."); }

Overview

API Reference

​Required Headers

Required Headers