# API v3 authentication

Nearly all endpoints in the API v3 require authentication as an i3D.net customer.

Authentication occurs in the form of an API key that can be [generated and configured on the control panel](https://one.i3d.net/Account/API-Keys).

## API key

By clicking on the `Generate API key` button on the aforementioned control panel page, you create a new API key.

By default it has no IP whitelisting and no expiration date.

## IP Whitelisting

If you want to lock down usage of the API key to one or more IP addresses, or a range of IP addresses then you can fill in a start IP and end IP address for the API key.

<figure><img src="/files/i1U48Eol0mP2Vj56l0OJ" alt=""><figcaption></figcaption></figure>

## Expiration

API keys can be set to expire at a certain date. To set this up, enter or select a date by clicking on the `API Key expidation date` field. The API key will expire when the indicated date has been reached.

<figure><img src="/files/rqWO7oSPrgID0OOT6Mho" alt=""><figcaption></figcaption></figure>

## API key usage

Authenticating your requests is done by adding a `PRIVATE-TOKEN` HTTP header containing your API key as the value:

| HTTP Header Name | HTTP Header Value |
| ---------------- | ----------------- |
| PRIVATE-TOKEN    | YOUR\_API\_KEY    |

Table 1: API v3 authentication header


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.i3d.net/game-hosting/overview/apiv3-authentication.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.