Authentication

API Keys

The Infrahub API uses API keys for authentication, offering an alternative authentication method independent of your account username and password. If you're new to using the Infrahub API, you'll need to generate an API key. Follow the instructions below to effortlessly generate an API key with just a few clicks using the Hyperstack platform.

Base URL for Infrahub API

https://infrahub-api.nexgencloud.com/v1

Generate an API key using the Hyperstack platform

Before getting started

1. Register for a Hyperstack account at: https://console.hyperstack.cloud.

2. Sign in to your Hyperstack account using your login credentials.

Generate your first API key

1. In the "MANAGE" section at the bottom-left of the Hyperstack platform click on "API Keys".

2. On the "API Keys" page click on "Generate New API Key".

3. Copy your new API key to clipboard.

4. To authenticate API requests, include an api_key header with your API key, as follows:

-H "api_key: PASTE YOUR API KEY HERE"

Now that you can authenticate API requests, let's move on to creating your first resource environment.

Rate limits

The rate limit for the Infrahub API is 500 requests per minute, per IP address.

If you exceed this limit, all API calls for the next minute will be blocked, resulting in a HTTP 429 response.

Back to top