Skip to main content
POST
/
v1
/
connection-environments
Create connection environments
curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/connection-environments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "baseConnectionId": "123e4567-e89b-12d3-a456-426614174000",
  "environmentConnectionIds": "223e4567-e89b-12d3-a456-426614174001,323e4567-e89b-12d3-a456-426614174002"
}
'
{
  "success": true,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "environmentConnectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Use either an Organization API Key or Personal Access Token (PAT). Include in the Authorization header as: Bearer YOUR_TOKEN

Body

application/json
​
baseConnectionId
string<uuid>
required

The UUID of the base connection to associate environment connections with

​
environmentConnectionIds
string
required

A comma-separated list of connection UUIDs to use as environment connections. All connection IDs must be valid UUIDs that:

  • Exist in your organization
  • Have the same dialect as the base connection
  • Aren't already used as environment connections for the base connection
  • Aren't the same as the base connection

Response

Connection environment(s) created successfully

​
success
boolean
​
data
object[]