> ## Documentation Index
> Fetch the complete documentation index at: https://docs.apinizer.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Instance Management

> Define target Apinizer environments for API Promotion, monitor connection statuses, configure approval mechanisms, and set up notification recipients.

<Info>
  For detailed information about the [Environment](/en/concepts/core-concepts/what-is-environment) concept, see the core concepts page.
</Info>

## Instance List

In the instance management screen, you can view all defined target environments. The list provides the following information:

* **Name and Description**: Identifying information for the instance
* **URL**: Target environment address (Base URL)
* **Approval Status**: Whether approval is required and, if defined, approvers
* **Recipients**: Notification recipients (if any)
* **Connection Status**: Target environment accessibility status (for example Reachable / Not Reachable)

<img src="https://mintcdn.com/apinizer/1yFCZZQUbO1Sf_g6/images/promotion/promotion1.png?fit=max&auto=format&n=1yFCZZQUbO1Sf_g6&q=85&s=6afa2779c20f706b6a801e7fdcf04487" alt="Instance list" width="800" data-path="images/promotion/promotion1.png" />

## Creating a New Instance

To add a new target environment, use the **New Instance** button.

### Basic Information

| Field           | Description                                                                                                |
| --------------- | ---------------------------------------------------------------------------------------------------------- |
| **Name**        | A unique name for the instance. Only English letters and numbers are accepted, no spaces allowed           |
| **Description** | Descriptive information about the instance                                                                 |
| **Base URL**    | Address of the target Apinizer environment                                                                 |
| **API Token**   | API key used to access the target environment (retrieved from relevant settings in the target environment) |
| **Color**       | Color selection to visually distinguish the instance                                                       |

<img src="https://mintcdn.com/apinizer/1yFCZZQUbO1Sf_g6/images/promotion/promotion2.png?fit=max&auto=format&n=1yFCZZQUbO1Sf_g6&q=85&s=0cd12e43ca7d3a6efe9ba122e66470ec" alt="Create new instance" width="800" data-path="images/promotion/promotion2.png" />

### Connection Test

After saving the instance, you can run a connection test to verify access to the target environment.

* **From list screen**: **(… menu)** in the related instance row -> **Test**
* **From detail screen**: **Test** button

Connection status is updated on screen after test execution:

* **Successful**: **Reachable** is shown in the Connection Status field.
* **Failed**: **Not Reachable** is shown in the Connection Status field and, if available, an error message is displayed.

<img src="https://mintcdn.com/apinizer/1yFCZZQUbO1Sf_g6/images/promotion/promotion3.png?fit=max&auto=format&n=1yFCZZQUbO1Sf_g6&q=85&s=0fa07412769c088cf8da457b10112b4a" alt="Connection test result" width="800" data-path="images/promotion/promotion3.png" />

## Approval and Notification Settings

You can configure an approval mechanism for transfers to critical environments (especially Production), and define notification recipients.

### Approval Mechanism

When you activate **Approval required for promoting to this instance**, promotion operations to this instance wait for approval from designated approvers before execution.

| Setting               | Description                                                               |
| --------------------- | ------------------------------------------------------------------------- |
| **Approval Required** | When active, approval from designated people is required before execution |
| **Approvers**         | Users who can approve execution requests                                  |

<img src="https://mintcdn.com/apinizer/1yFCZZQUbO1Sf_g6/images/promotion/promotion4.png?fit=max&auto=format&n=1yFCZZQUbO1Sf_g6&q=85&s=2d783cb301159e770bba097bc111ba24" alt="Approval settings" width="800" data-path="images/promotion/promotion4.png" />

### Notification Recipients

You can define recipients to be notified about the status of promotion operations. Notifications are sent when:

* Execution starts
* Execution completes successfully
* Execution encounters an error

You can add connectors defined in the system (for example, an email connector) as notification recipients.

<img src="https://mintcdn.com/apinizer/1yFCZZQUbO1Sf_g6/images/promotion/promotion5.png?fit=max&auto=format&n=1yFCZZQUbO1Sf_g6&q=85&s=74354a42604f57fbafbb9955aed8d5c6" alt="Notification recipients" width="800" data-path="images/promotion/promotion5.png" />

## Instance Detail Screen

In the instance detail screen, you can view core information with connection status and trigger a connection test using the **Test** button. If the connection fails, the error message (if available) can also be viewed on this screen.

<img src="https://mintcdn.com/apinizer/1yFCZZQUbO1Sf_g6/images/promotion/promotion6.png?fit=max&auto=format&n=1yFCZZQUbO1Sf_g6&q=85&s=8713b95439260de3138b62dc38bc0e9d" alt="Instance detail screen" width="800" data-path="images/promotion/promotion6.png" />

## Deleting an Instance

When you want to delete an instance, a confirmation dialog is displayed.

<Warning>
  When an instance is deleted, mappings and execution history associated with this instance may also be affected. Check related mappings before deleting.
</Warning>
