> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omni.co/llms.txt
> Use this file to discover all available pages before exploring further.
# Set up connection environments with the API
> Configure dev and prod connection environments with the API.
export const categoryIcons = {
'administration': 'lock',
'api': 'terminal',
'connections': 'database',
'dashboards': 'table-columns',
'embed': 'code',
'errors': 'exclamation',
'modeling': 'wrench',
'patterns': 'plus',
'schedules & alerts': 'envelope',
'visualizations': 'chart-column',
'workbooks': 'book'
};
export const GuideSidebar = ({category, relatedLinks, updatedDate}) => {
const [progress, setProgress] = React.useState(0);
React.useEffect(() => {
const sidebar = document.querySelector('.guide-sidebar');
if (!sidebar) return;
let container = sidebar.parentElement;
while (container && !container.querySelector('.guide-header')) {
container = container.parentElement;
}
if (container && !container.classList.contains('guide-page-layout')) {
container.classList.add('guide-page-layout');
}
}, []);
React.useEffect(() => {
const handleScroll = () => {
const scrollTop = window.scrollY;
const docHeight = document.documentElement.scrollHeight - window.innerHeight;
const scrollPercent = docHeight > 0 ? scrollTop / docHeight * 100 : 0;
setProgress(Math.min(100, Math.max(0, scrollPercent)));
};
window.addEventListener('scroll', handleScroll, {
passive: true
});
handleScroll();
return () => window.removeEventListener('scroll', handleScroll);
}, []);
const icon = category ? categoryIcons[category.toLowerCase()] || 'book' : 'book';
return ;
};
export const GuideTitle = ({title}) => {
return
{title}
;
};
Connection environments allow you to configure multiple database connections based on [user attributes](/administration/users/attributes). This is useful for scenarios where you need to provide different database access based on user roles or environments.
In this guide, we'll walk you through creating development and production connection environments.
## Requirements
To follow the steps in this guide, you'll need:
* An [Omni API key](/api/authentication)
* **Connection Admin** permissions on an existing Omni database connection
## Steps
This is the default connection that will be used when no user attribute matches an environment connection. Use the [Create a connection API](/api/connections/create-connection) to create the connection.
In this example, this would be a connection to your **development** database:
```bash title="POST /api/v1/connections" theme={null}
curl -L -X POST 'https://blobsrus.omniapp.co/api/v1/connections' \
-H 'Authorization: Bearer ' \
-H 'Content-Type: application/json' \
-d '{
"dialect": "postgres",
"name": "Postgres (Development)",
"host": "postgres-dev.my-org.com",
"port": 5432,
"database": "dev",
"username": "dbuser",
"passwordUnencrypted": "mypassword",
"includeSchemas": "public",
"queryTimeoutSeconds": 900
}'
```
Environment conditions are additional connections with the same dialect as the base connection. Use the [Create a connection API](/api/connections/create-connection) to create the connection(s).
In this example, this would be a connection to your **production** database:
```bash title="POST /api/v1/connections" theme={null}
curl -L -X POST 'https://blobsrus.omniapp.co/api/v1/connections' \
-H 'Authorization: Bearer ' \
-H 'Content-Type: application/json' \
-d '{
"dialect": "postgres",
"name": "Postgres (Production)",
"host": "postgres-prod.my-org.com",
"port": 5432,
"database": "prod",
"username": "dbuser",
"passwordUnencrypted": "mypassword",
"includeSchemas": "public",
"queryTimeoutSeconds": 900
}'
```
Use the [Create connection environments API](/api/connection-environments/create-connection-environments) to associate the base connection with the environment connections. Provide the following:
* `baseConnectionId` - The ID of the base connection. In this example, that's your **development** database.
* `environmentConnectionIds` - The ID(s) of the connection environments. In this example, that's your **production** database.
```json title="POST /api/v1/connection-environments" theme={null}
curl -L -X POST 'https://blobsrus.omniapp.co/api/v1/connection-environments' \
-H 'Authorization: Bearer ' \
-H 'Content-Type: application/json' \
-d '{
"baseConnectionId": "c0f12353-4817-4398-bcc0-d501e6dd2f64",
"environmentConnectionIds": "b31f9c9f-208d-48a2-9ae3-ff80f2c79fed"
}'
```
Use the [Update a connection API](/api/connections/update-connection) to specify which user attribute will be used to determine the connection environment.
In this example, configure the base connection to use the `environment` user attribute and set its default value to `dev`:
```json title="PATCH /api/v1/connections/:id" theme={null}
curl -L -X PATCH 'https://blobsrus.omniapp.co/api/v1/connections/c0f12353-4817-4398-bcc0-d501e6dd2f64' \
-H 'Authorization: Bearer ' \
-H 'Content-Type: application/json' \
-d '{
"userAttributeNameForConnectionEnvironments": "environment",
"userAttributeValuesForDefaultEnvironment": "dev"
}'
```
Use the [Update connection environment user attributes API](/api/connection-environments/update-connection-environment) to specify which user attribute values will trigger the use of each environment connection.
In this example, set the user attribute values for the **production** environment connection to `prod`:
```json title="PUT /api/v1/connection-environments/:id" theme={null}
curl -L -X PUT 'https://blobsrus.omniapp.co/api/v1/connection-environments/b31f9c9f-208d-48a2-9ae3-ff80f2c79fed' \
-H 'Authorization: Bearer ' \
-H 'Content-Type: application/json' \
-d '{
"userAttributeValues": "prod"
}'
```
Now, users with the `environment` attribute set to `prod` will use the production database, while users with the `environment` attribute set to `dev` (or any other value not associated with an environment connection) will use the development database.