> For the complete documentation index, see [llms.txt](https://developers.oxylabs.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.oxylabs.io/dashboard/product-instances.md).

# Product Instances

Learn how to create, configure, and manage product instances in the Oxylabs Dashboard.

A product instance is a specific configuration of a service (e.g., Residential Proxies, Web API) that includes a unique name, authentication credentials, and an optional spending limit.

## Creating a product instance

{% stepper %}
{% step %}

### Start the instance creation

Click **+ Add product instance** from the Overview page. New products can be activated instantly – no account manager or waiting required.

New users are prompted to create their product instance on their first visit:

<img src="https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2FvYj084BtK5Fv5iZFW1Rl%2Funknown.png?alt=media&amp;token=92da1c3e-849f-4090-9bb9-1935781ac7e3" alt="" height="315" width="582">

Existing users can find the instance creation option as shown below:

<img src="https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2F1sUwP5Gxm9XOTNrhb5mP%2Funknown.png?alt=media&amp;token=0890503c-a2cf-4f7e-a999-28d595cb7d05" alt="" height="251" width="610">
{% endstep %}

{% step %}

### Select a product

Choose a product from the list. Products are grouped into categories:

* **Data Collection** (Web API)
* **Proxies & Advanced Proxy Solutions** (Residential, Mobile, Datacenter, ISP Proxies, Web Unblocker)
* **Browsers** (Agent Browser)

<img src="https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2F1wgtNla3jsDbd68Qh43w%2Funknown.png?alt=media&amp;token=c281d677-ca76-4c0d-813d-82ca8f18725d" alt="" height="287" width="610">
{% endstep %}

{% step %}

### Set instance name and credentials

**Instance name**: Choose a descriptive name.

**Authentication settings:**&#x20;

* **Username & password** (auto-generated, the password can be edited later)
* **Whitelisted IPs** (a list of trusted IPs to authenticate with)

<img src="https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2FNx6nKfC3LCCar43ykuhn%2Funknown.png?alt=media&amp;token=4b1886b9-1d4d-4d3f-adbe-7350ea3f1738" alt="" height="413" width="610">
{% endstep %}

{% step %}

### Configure limits & notifications (optional)

To cap usage on the new instance, set up a limit with:

**Limit type**:

* `USD/EUR` (Monetary)
* `Results`
* `GB` (Traffic)

**Period**: `Daily`, `Weekly`, `Monthly`, or `Lifetime`

{% hint style="info" %}
**Limit type** choice differs by product.
{% endhint %}

Then choose an **Action for exceeded limit**:

* **Disable instance** when the limit is reached.
* **Send email** alerts without disabling the instance.

<img src="https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2F7eH6ntyBgTpEcc0o3KFf%2Funknown.png?alt=media&amp;token=821dc630-ef49-4ab2-b92d-abf8599ae691" alt="" height="256" width="610">

{% hint style="info" %}
Instance limits control spending on that specific instance only. They're separate from your overall account credit balance – see [Credit-Based Billing](/dashboard/credit-based-billing.md) for how the shared balance works.
{% endhint %}
{% endstep %}

{% step %}

### Finish instance setup

Click **Create instance** to complete the setup.
{% endstep %}
{% endstepper %}

## Managing instances

Click any instance to open its detail page. From there, you can:

* Edit the instance name
* Enable, disable, or delete the instance
* Adjust limits
* View or edit passwords
* Access integration examples
* View usage statistics and the spending limit progress bar

<img src="https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2FmT6Evm1WmGyePNkbZxBg%2Funknown.png?alt=media&amp;token=7143d06f-e0c4-44a7-b23c-798acd521df2" alt="" height="525" width="624">

## Granular alerts

Team owner can set spending alerts at the `50%`, `80%`, or `100%` level so you're notified before a product instance or your overall account hits its limit.

{% hint style="info" %}
By default, alerts are set at `80%` and `100%` of your plan limit.
{% endhint %}

Team owner can manage who receives these alerts (recipient email addresses) from the Email notifications settings – see [Team & Account Settings](/dashboard/team-and-account-settings.md).

## Monitoring spending and usage

### Real-time spending

The top bar on the Overview page shows real-time spending for the current billing cycle.

<img src="https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2FWSOjB8OPsD9ZC4cNzKuZ%2Funknown.png?alt=media&amp;token=a93773cb-3360-40ae-8ded-6f016e9f3811" alt="" height="88" width="624">

### Historical data

In the **Spending** tab, view historical data by **Products**, **Instances**, or **Targets**. Switch between `Hourly`, `Daily`, `Weekly`, or `Monthly` views for different granularities.

<img src="https://content.gitbook.com/content/zrXw45naRpCZ0Ku9AjY1/blobs/S27WuoQfnJ0ILEceFUvD/unknown.png" alt="" height="329" width="624">

### Usage

The **Usage** tab displays success rates, response time, and other metrics per time interval or target, depending on the chosen product.

<img src="https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2FZUfLxeMtJY5vWU1PUC2w%2Funknown.png?alt=media&amp;token=fb5a2bf1-a33f-466e-be2f-8afb928729cf" alt="" height="411" width="624">

You can also compare daily usage breakdowns:

<img src="https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2FkzAnKryz6vG7MxweXNss%2Funknown.png?alt=media&amp;token=6de36fb6-658f-4e28-af95-8d3984d1ef16" alt="" height="151" width="624">

{% hint style="info" %}
To pull usage statistics programmatically instead of viewing them in the dashboard, see the [Dashboard API](/dashboard/dashboard-api.md).
{% endhint %}


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developers.oxylabs.io/dashboard/product-instances.md?ask=<question>&goal=<user_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 `build a script that syncs our docs to a CMS` 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.
