API Keys

info

This infordocumentationmation is deprecated and will be removed soon. Please delete any bookmarks or links to this page.

Server to Server

For secure communication between your backend and our API, we offer an authentication mechanism via API keys.

Multiple API keys possible

You can generate any number of API keys. This allows you to separate different concerns if required. Each key can be given a label for easy differentiation.

API keys management from the Dashboard

In the Dashboard you can easily create API keys and assign labels to them. Each API key remains valid until manually revoked.

In the Dashboard navigate to Settings tab and select the API Keys tab to view, create new or delete API key.

Using API key

The API keys are passed in via the HTTP header x-api-key.

curl --header 'X-API-Key: <SECRET>' \
  --request POST 'https://api.hellgate.io/...'

warning

The keys must be handled with care and kept secure. Never hardcode the API keys in your source code, but keep them solely on your backend systems.