Integration Instance Groups

Integration instance groups combine instance providers into a grouped routed configuration.

Integration Instance Groups object

Attributes

object

String

id

String

status

Enum

name

String

description

StringNullable

metadata

ObjectNullable

A key-value map

implementation

ObjectNullable

providers

Object

created_at

Date

updated_at

Date

archived_at

DateNullable
{
  "object": "integration.instance.group",
  "status": "draft",
  "metadata": {},
  "implementation": {
    "type": "magic_mcp_endpoint"
  },
  "providers": [
    {
      "object": "integration.instance.group.provider",
      "status": "active",
      "metadata": {},
      "tool_filter": {
        "type": "allow_all"
      }
    },
    {
      "object": "integration.instance.group.provider",
      "status": "active",
      "metadata": {},
      "tool_filter": {
        "type": "allow_all"
      }
    }
  ]
}

List integration instance groups

Returns a paginated list of integration instance groups.

Query Parameters

limit

NumberOptional

after

StringOptional

before

StringOptional

cursor

StringOptional

order

EnumOptional

status

UnionOptional

id

UnionOptional

integration_id

UnionOptional

integration_instance_id

UnionOptional

integration_instance_provider_id

UnionOptional

provider_id

UnionOptional

integration_provider_id

UnionOptional

provider_deployment_id

UnionOptional

provider_config_id

UnionOptional

provider_auth_config_id

UnionOptional

session_template_id

UnionOptional

created_at

ObjectOptional

Filter integration instance group creation time by date range

updated_at

ObjectOptional

Filter integration instance group last update time by date range

GEThttp://api.metorial.com/integration-instance-groups
curl -X GET "https://api.metorial.com/integration-instance-groups" \
  -H "Authorization: Bearer metorial_sk_..."

Get integration instance group

Retrieves a specific integration instance group.

URL Parameters

integration_instance_group_id

String

The unique identifier for the integration_instance_group

GEThttp://api.metorial.com/integration-instance-groups/:integration_instance_group_id
curl -X GET "https://api.metorial.com/integration-instance-groups/int_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."

Create integration instance group session template

Creates or updates the shared session template for a specific integration instance group.

URL Parameters

integration_instance_group_id

String

The unique identifier for the integration_instance_group

Request Body

name

StringOptional

description

StringOptional

metadata

ObjectOptional

A key-value map

POSThttp://api.metorial.com/integration-instance-groups/:integration_instance_group_id/session-template
curl -X POST "https://api.metorial.com/integration-instance-groups/int_Rm4Mnheq2bfEPhBhP7SY/session-template" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "metadata": {}
}'

Create integration instance group session

Creates a session from the shared session template of a specific integration instance group.

URL Parameters

integration_instance_group_id

String

The unique identifier for the integration_instance_group

Request Body

name

StringOptional

description

StringOptional

metadata

ObjectOptional

A key-value map

POSThttp://api.metorial.com/integration-instance-groups/:integration_instance_group_id/session
curl -X POST "https://api.metorial.com/integration-instance-groups/int_Rm4Mnheq2bfEPhBhP7SY/session" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "metadata": {}
}'

Create integration instance group

Creates a new integration instance group.

Request Body

name

String

description

StringOptional

metadata

ObjectOptional

A key-value map

providers

ObjectOptional
POSThttp://api.metorial.com/integration-instance-groups
curl -X POST "https://api.metorial.com/integration-instance-groups" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "metadata": {},
  "providers": {
    "integration_instance_provider_id": "example_integration_instance_provider_id",
    "tool_filters": {
      "type": "example_type",
      "keys": [
        "example_item"
      ]
    }
  }
}'

Update integration instance group

Updates a specific integration instance group.

URL Parameters

integration_instance_group_id

String

The unique identifier for the integration_instance_group

Request Body

name

StringOptional

description

StringOptionalNullable

metadata

ObjectOptionalNullable

A key-value map

providers

ObjectOptional
PATCHhttp://api.metorial.com/integration-instance-groups/:integration_instance_group_id
curl -X PATCH "https://api.metorial.com/integration-instance-groups/int_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "metadata": {},
  "providers": {
    "integration_instance_provider_id": "example_integration_instance_provider_id",
    "tool_filters": {
      "type": "example_type",
      "keys": [
        "example_item"
      ]
    }
  }
}'

Delete integration instance group

Archives a specific integration instance group.

URL Parameters

integration_instance_group_id

String

The unique identifier for the integration_instance_group

DELETEhttp://api.metorial.com/integration-instance-groups/:integration_instance_group_id
curl -X DELETE "https://api.metorial.com/integration-instance-groups/int_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."