--- title: Getting started with the Hyperglance API description: Your Hyperglance deployment hosts a REST API that you can use to interact with your data. --- [Skip to content](https://support.hyperglance.com/knowledge/getting-started-with-the-hyperglance-api#main-content) English Show submenu for translations [More support](https://support.hyperglance.com/knowledge/kb-tickets/new?hsLang=en) ![](https://support.hyperglance.com/hs-fs/hubfs/hyperglance.png?width=100&height=75&name=hyperglance.png) Open main navigation Close main navigation - English Show submenu for translations - [More support](https://support.hyperglance.com/knowledge/kb-tickets/new) - [Contact Us](https://www.hyperglance.com/contact/) [Contact Us](https://www.hyperglance.com/contact/) How can we help you? - There are no suggestions because the search field is empty. 1. [Hyperglance Support](https://support.hyperglance.com/knowledge?hsLang=en) 2. [Setup & Configuration](https://support.hyperglance.com/knowledge/setup-configuration?hsLang=en) 3. [API](https://support.hyperglance.com/knowledge/setup-configuration?hsLang=en#api) # Getting started with the Hyperglance API ## Your Hyperglance deployment hosts a REST API that you can use to interact with your data. ### REST API Reference Documentation You can find latest version of the REST API reference documentation at [api.hyperglance.com](https://api.hyperglance.com/), or you can access a version of the documentation that corresponds with the version of your local Hyperglance deployment by visiting **https://\[ReplaceWithHyperglanceIpAddress\]/hgapi/docs/** Documentation on how to authenticate with the REST API is [here](https://support.hyperglance.com/knowledge/authentication?hsLang=en). ### OpenAPI Specification & Language SDK Bindings We use V3 of the OpenAPI specifications to document the Hyperglance API. You can take [the Hyperglance specification JSON](https://api.hyperglance.com/swagger.json) and auto-generate client APIs for your preferred programming language using tools such as [Swagger](https://swagger.io/tools/swagger-codegen/) or [OpenAPIGenerator.](https://openapi-generator.tech/) You do not *have to* generate language bindings however, you can simply use any standard web requests library available in your preferred language and issue GET/PUT/POST/DELETE calls that way. ### Generating an API Key - Visit **Settings** \> **API Keys**  (or type: **https://YOUR HYPERGLANCE IP/settings/api** into the browser) - Click 'Create API Key' **![](https://support.hyperglance.com/hubfs/image-png-Dec-05-2022-06-26-47-5591-PM.png)** - Provide a unique key identifier that will act like a public-key / username. Also provide some descriptive text to document what the key is for: ![](https://support.hyperglance.com/hubfs/image-png-Dec-05-2022-06-26-59-4725-PM.png) - Click the **Create** button to generate the private API Key: ![](https://support.hyperglance.com/hubfs/image-png-Dec-05-2022-06-29-37-4737-PM.png)  - Make a note of this and keep it safe, it is **not** possible to recover this later. - Keep your API safe and do not share it - treat it like a password. - [Your API key is used to authenticate against the Hyperglance API](https://support.hyperglance.com/knowledge/authentication?hsLang=en). ### Get Started With A Simple Example If you have curl installed locally on your computer (Windows users should try using git-bash or WSL2) it is easy to test out the API. 1\) Make sure Hyperglance is running and has ingested resources. 2\) Issue the following curl command, just make sure to set your API key name and secret accordingly. ``` curl -fk https://10.0.0.1/hgapi/network \ --user my-api-user:77415974-1b16-4ee8-af98-6be979611158 ``` [Find more CURL examples on our Github repo](https://github.com/hyperglance/api-samples/tree/master/curl). ### More API Samples & Examples Check out our [Github repository of samples](https://github.com/hyperglance/api-samples). There you can find examples for CURL, Python or Postman. - [Before You Start](https://support.hyperglance.com/knowledge/before-you-start?hsLang=en#main-content) - [Kubernetes](https://support.hyperglance.com/knowledge/before-you-start?hsLang=en#kubernetes) - [GCP](https://support.hyperglance.com/knowledge/before-you-start?hsLang=en#gcp) - [AWS](https://support.hyperglance.com/knowledge/before-you-start?hsLang=en#aws) - [Azure](https://support.hyperglance.com/knowledge/before-you-start?hsLang=en#azure) - [Using Hyperglance](https://support.hyperglance.com/knowledge/using-hyperglance?hsLang=en#main-content) - [Automations](https://support.hyperglance.com/knowledge/using-hyperglance?hsLang=en#automations) - [Inventory & Diagrams](https://support.hyperglance.com/knowledge/using-hyperglance?hsLang=en#inventory-diagrams) - [Rules](https://support.hyperglance.com/knowledge/using-hyperglance?hsLang=en#rules) - [Cost Management](https://support.hyperglance.com/knowledge/using-hyperglance?hsLang=en#cost-management) - [Dashboards](https://support.hyperglance.com/knowledge/using-hyperglance?hsLang=en#dashboards) - [Security & Compliance](https://support.hyperglance.com/knowledge/using-hyperglance?hsLang=en#security-compliance) - [Setup & Configuration](https://support.hyperglance.com/knowledge/setup-configuration?hsLang=en#main-content) - [Updating & Migrating](https://support.hyperglance.com/knowledge/setup-configuration?hsLang=en#updating-migrating) - [General](https://support.hyperglance.com/knowledge/setup-configuration?hsLang=en#general) - [RBAC & Users](https://support.hyperglance.com/knowledge/setup-configuration?hsLang=en#rbac-users) - [STIGS & FIPS](https://support.hyperglance.com/knowledge/setup-configuration?hsLang=en#stigs-fips) - [AWS](https://support.hyperglance.com/knowledge/setup-configuration?hsLang=en#aws) - [Azure](https://support.hyperglance.com/knowledge/setup-configuration?hsLang=en#azure) - [Kubernetes](https://support.hyperglance.com/knowledge/setup-configuration?hsLang=en#kubernetes) - [GCP](https://support.hyperglance.com/knowledge/setup-configuration?hsLang=en#gcp) - [API](https://support.hyperglance.com/knowledge/setup-configuration?hsLang=en#api) - [Legacy Docker-based deployments](https://support.hyperglance.com/knowledge/setup-configuration?hsLang=en#legacy-docker-based-deployments) - [AI](https://support.hyperglance.com/knowledge/setup-configuration?hsLang=en#ai) [![Chill listening crop-3](https://support.hyperglance.com/hs-fs/hubfs/hyperglance.png?width=134&height=24&name=hyperglance.png "Chill listening crop-3")](https://www.hyperglance.com/) 2880 Zanker Road, Suite 203, San Jose, CA 95134 Copyright © 2025 Hyperglance. All rights reserved.