> For the complete documentation index, see [llms.txt](https://docs.i3d.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.i3d.net/game-hosting/overview/apiv3-authentication.md).
# 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.
## 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.
## 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
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.i3d.net/game-hosting/overview/apiv3-authentication.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
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.
