{"componentChunkName":"component---src-templates-redoc-operation-js","path":"/api/gfa/reference/overview/","result":{"data":{"contentItem":{"type":"redoc-info","link":"/api/gfa/reference/overview/","data":{"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"title\":\"Global File Accleration Telemetry API\",\"version\":\"1.0.0\"},\"servers\":[{\"url\":\"https://gfa-telemetry-us1.api.nasuni.com/v1\",\"description\":\"Production server (US1)\"},{\"url\":\"https://gfa-telemetry-us2.api.nasuni.com/v1\",\"description\":\"Staging server (US2)\"}],\"paths\":{\"/data\":{\"get\":{\"summary\":\"Get telemetry metrics from Global File Acceleration\",\"operationId\":\"getTelemetry\",\"security\":[{\"ApiTokenHeader\":[]}],\"parameters\":[{\"$ref\":\"#/components/parameters/ClientKeyHeader\"},{\"in\":\"query\",\"name\":\"filer_metrics\",\"schema\":{\"type\":\"boolean\",\"default\":true},\"description\":\"Controls whether the filer information metrics are included in the response (true, if not specified)\"},{\"in\":\"query\",\"name\":\"volume_metrics\",\"schema\":{\"type\":\"boolean\",\"default\":true},\"description\":\"Controls whether the volume information metrics are included in the response (true, if not specified)\"},{\"in\":\"query\",\"name\":\"lock_metrics\",\"schema\":{\"type\":\"boolean\",\"default\":true},\"description\":\"Controls whether the lock metrics are included in the response (true, if not specified)\"},{\"in\":\"query\",\"name\":\"propagation_metrics\",\"schema\":{\"type\":\"boolean\",\"default\":true},\"description\":\"Controls whether the propagation metrics are included in the response (true, if not specified)\"}],\"responses\":{\"200\":{\"description\":\"Get all of the telemetry metrics\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"version\",\"flags\",\"info\",\"metrics\"],\"properties\":{\"version\":{\"type\":\"integer\"},\"flags\":{\"type\":\"object\"},\"info\":{\"type\":\"object\",\"$ref\":\"#/components/schemas/info\"},\"metrics\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/metrics\"}}}}}}},\"401\":{\"$ref\":\"#/components/responses/UnauthorizedError\"},\"403\":{\"$ref\":\"#/components/responses/UnauthorizedError\"},\"406\":{\"description\":\"Failed to get account or volume information from client API token\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"error\"],\"properties\":{\"error\":{\"type\":\"string\"}}}}}},\"500\":{\"description\":\"Failed to get current bookmarks for the client\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"error\"],\"properties\":{\"error\":{\"type\":\"string\"}}}}}}}}}},\"components\":{\"securitySchemes\":{\"ApiTokenHeader\":{\"type\":\"apiKey\",\"in\":\"header\",\"name\":\"Authorization\"}},\"parameters\":{\"ClientKeyHeader\":{\"name\":\"X-Nasuni-client-key\",\"in\":\"header\",\"description\":\"String to identify the client within the API Token\",\"required\":false,\"schema\":{\"type\":\"string\",\"default\":\"swagger client\"}}},\"responses\":{\"UnauthorizedError\":{\"description\":\"Access token is missing or invalid\"}},\"schemas\":{\"volume_guid\":{\"type\":\"string\",\"format\":\"uuid\"},\"info\":{\"type\":\"object\",\"required\":[\"account\",\"last_info\",\"last_lock_event\",\"last_propagation\",\"request_time\",\"volumes\"],\"properties\":{\"account\":{\"type\":\"string\",\"format\":\"uuid\"},\"last_info\":{\"type\":\"string\",\"format\":\"date-time\"},\"last_lock_event\":{\"type\":\"string\",\"format\":\"date-time\"},\"last_propagation\":{\"type\":\"string\",\"format\":\"date-time\"},\"request_time\":{\"type\":\"string\",\"format\":\"date-time\"},\"volumes\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/volume_guid\"}}}},\"metrics\":{\"type\":\"object\",\"required\":[\"volumes\",\"filers\",\"propagation\",\"locks\"],\"properties\":{\"volumes\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/volume_metric\"}},\"filers\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/filer_metric\"}},\"propagation\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/propagation_metric\"}},\"locks\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/lock_metric\"}}}},\"volume_metric\":{\"type\":\"object\",\"required\":[\"metric_type\",\"mode\",\"profile\",\"time_to_protect\",\"timestamp\",\"version\",\"volume_guid\",\"volume_title\"],\"properties\":{\"metric_type\":{\"type\":\"string\"},\"mode\":{\"type\":\"string\"},\"profile\":{\"type\":\"string\"},\"time_to_protect\":{\"type\":\"integer\"},\"timestamp\":{\"type\":\"string\",\"format\":\"date-time\"},\"version\":{\"type\":\"integer\"},\"volume_guid\":{\"type\":\"string\",\"format\":\"uuid\"},\"volume_title\":{\"type\":\"string\"}}},\"filer_metric\":{\"type\":\"object\",\"required\":[\"filer_guid\",\"filer_title\",\"last_checkin\",\"metric_type\",\"timestamp\",\"version\"],\"properties\":{\"filer_guid\":{\"type\":\"string\",\"format\":\"uuid\"},\"filer_title\":{\"type\":\"string\"},\"last_checkin\":{\"type\":\"integer\"},\"metric_type\":{\"type\":\"string\"},\"oldest_unprotected_data\":{\"type\":\"integer\"},\"timestamp\":{\"type\":\"string\",\"format\":\"date-time\"},\"version\":{\"type\":\"integer\"},\"volume_guid\":{\"type\":\"string\",\"format\":\"uuid\"},\"volume_title\":{\"type\":\"string\"}}},\"propagation_metric\":{\"type\":\"object\",\"required\":[\"filer_guid\",\"filer_title\",\"kind\",\"metric_type\",\"prop_seconds\",\"timestamp\",\"version\",\"volume_guid\",\"volume_title\"],\"properties\":{\"filer_guid\":{\"type\":\"string\",\"format\":\"uuid\"},\"filer_title\":{\"type\":\"string\"},\"kind\":{\"type\":\"string\"},\"metric_type\":{\"type\":\"string\"},\"prop_seconds\":{\"type\":\"integer\"},\"timestamp\":{\"type\":\"string\",\"format\":\"date-time\"},\"version\":{\"type\":\"integer\"},\"volume_guid\":{\"type\":\"string\",\"format\":\"uuid\"},\"volume_title\":{\"type\":\"string\"}}},\"lock_metric\":{\"type\":\"object\",\"required\":[\"filer_guid\",\"filer_title\",\"lock_phase\",\"lock_state\",\"metric_type\",\"timestamp\",\"version\",\"volume_guid\",\"volume_title\"],\"properties\":{\"filer_guid\":{\"type\":\"string\",\"format\":\"uuid\"},\"filer_title\":{\"type\":\"string\"},\"lock_duration\":{\"type\":\"integer\"},\"lock_state\":{\"type\":\"string\"},\"lock_phase\":{\"type\":\"string\"},\"metric_type\":{\"type\":\"string\"},\"timestamp\":{\"type\":\"string\",\"format\":\"date-time\"},\"version\":{\"type\":\"integer\"},\"volume_guid\":{\"type\":\"string\",\"format\":\"uuid\"},\"volume_title\":{\"type\":\"string\"}}}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"hideDownloadButton\":false,\"hideInfoSection\":true,\"generateCodeSamples\":{\"languages\":[{\"lang\":\"Python\"},{\"lang\":\"curl\"},{\"lang\":\"JavaScript\"},{\"lang\":\"Node.js\"}]},\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","redocHasSecurityDefinitions":false,"redocInfoPageLink":"","redocItemId":"overview","redocHasInfoPage":false,"settings":{"hideDownloadButton":false,"hideInfoSection":true,"pagination":"item","generateCodeSamples":{"languages":[{"lang":"Python"},{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"}]}},"requestLogin":false,"lastModified":"2023-02-13T18:45:41.000Z"},"seo":{"title":"Global File Accleration Telemetry API"}}},"pageContext":{"id":"1ed63e81-7a88-55e6-a6a9-d6ed587d0692overview__redocly content/api/gfa/reference/overview/","seo":{"title":"Global File Accleration Telemetry API","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"api/gfa/reference.page.yaml#overview","pageBaseUrl":"/api/gfa/reference","type":"redoc-info","toc":{"enable":true,"maxDepth":4,"headings":null},"data":{},"catalogInfo":null,"link":"/api/gfa/reference/overview/","sidebarName":"","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"gfa_v100","id":"gfa_v100","title":"gfa_v100","isDefault":true,"apiId":null}],"apiVersionId":null,"isDefaultApiVersion":true}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}