MetorialDocs

Integration Instance Providers

Integration instance providers resolve the effective per-instance provider materialization for an integration.

The Integration Instance Provider object

integration_instance_provider.json
{
  "object": "integration.instance.provider",
  "id": "example_id",
  "status": "active",
  "name": "example_name",
  "description": "example_description",
  "metadata": {},
  "integration_id": "example_integration_id",
  "integration_instance_id": "example_integration_instance_id",
  "tool_filter": {
    "type": "allow_all",
    "ignore_parent_filters": false
  },
  "is_override_tool_filter": false,
  "provider": {
    "object": "provider#preview",
    "id": "pro_5gHjKlMnPqRsTuVw",
    "name": "GitHub",
    "description": "Connect to GitHub repositories, issues, and pull requests",
    "slug": "github",
    "created_at": "2025-09-15T10:30:00.000Z",
    "updated_at": "2026-01-10T14:45:00.000Z"
  },
  "integration_provider": {
    "object": "integration.provider#snapshot",
    "id": "example_id",
    "provider_version": {
      "object": "integration.provider.version",
      "id": "example_id",
      "index": 0
    },
    "status": "active",
    "name": "example_name",
    "description": "example_description",
    "metadata": {},
    "tool_filter": {
      "type": "allow_all",
      "ignore_parent_filters": false
    },
    "provider_id": "example_provider_id",
    "deployment_id": "example_deployment_id",
    "auth_method_id": "example_auth_method_id",
    "auth_credentials_id": "example_auth_credentials_id",
    "config": {
      "object": "provider.config#preview",
      "id": "pcf_7dEfGhJkLmNpQrSt",
      "is_default": false,
      "name": "Production Config",
      "description": "Configuration for production environment",
      "metadata": {},
      "provider_id": "pro_5gHjKlMnPqRsTuVw",
      "created_at": "2025-09-15T10:30:00.000Z",
      "updated_at": "2026-01-10T14:45:00.000Z"
    },
    "created_at": "2026-09-11T20:30:32.757Z",
    "updated_at": "2026-09-11T20:30:32.757Z",
    "archived_at": "2026-09-11T20:30:32.757Z"
  },
  "config": {
    "object": "provider.config#preview",
    "id": "pcf_7dEfGhJkLmNpQrSt",
    "is_default": false,
    "name": "Production Config",
    "description": "Configuration for production environment",
    "metadata": {},
    "provider_id": "pro_5gHjKlMnPqRsTuVw",
    "created_at": "2025-09-15T10:30:00.000Z",
    "updated_at": "2026-01-10T14:45:00.000Z"
  },
  "auth_config": {
    "object": "provider.auth_config#preview",
    "id": "pcf_7dEfGhJkLmNpQrSt",
    "is_default": false,
    "name": "Production Config",
    "description": "Configuration for production environment",
    "metadata": {},
    "provider_id": "pro_5gHjKlMnPqRsTuVw",
    "created_at": "2025-09-15T10:30:00.000Z",
    "updated_at": "2026-01-10T14:45:00.000Z"
  },
  "callback_instance_id": "cbi_5gHjKlMnPqRsTuVw",
  "created_at": "2026-09-11T20:30:32.757Z",
  "updated_at": "2026-09-11T20:30:32.757Z",
  "archived_at": "2026-09-11T20:30:32.757Z"
}
object"integration.instance.provider"required
idstringrequired
status"active" | "archived" | "deleted"required
namestringrequired
descriptionstringrequirednullable
metadataRecord<string, any>requirednullable
integration_idstringrequired
integration_instance_idstringrequired
is_override_tool_filterbooleanrequired
callback_instance_idstringrequirednullable
created_atdaterequired
updated_atdaterequired
archived_atdaterequirednullable

Endpoints

List integration instance providers

GET/integration-instance-providers

Returns a paginated list of integration instance providers.

Query parameters

searchstringoptional
status"active" | "archived" | "deleted" or "active" | "archived" | "deleted"[]optional
idstring or string[]optional
integration_idstring or string[]optional
integration_instance_idstring or string[]optional
provider_idstring or string[]optional
integration_provider_idstring or string[]optional
provider_deployment_idstring or string[]optional
provider_config_idstring or string[]optional
provider_auth_config_idstring or string[]optional
session_template_idstring or string[]optional

Example request

curl -X GET "https://api.metorial.com/integration-instance-providers" \
  -H "Authorization: Bearer metorial_sk_io2h4..."

Get integration instance provider

GET/integration-instance-providers/:integration_instance_provider_id

Retrieves a specific integration instance provider.

Path parameters

integration_instance_provider_idstringrequired

The unique identifier for the integration_instance_provider

Example request

curl -X GET "https://api.metorial.com/integration-instance-providers/int_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_io2h4..."

Set integration instance provider

PUT/integration-instances/:integration_instance_id/providers/:provider_id

Creates or updates the effective integration instance provider materialization.

Path parameters

integration_instance_idstringrequired

The unique identifier for the integration_instance

provider_idstringrequired

The unique identifier for the provider

Request body

provider_deployment_idstringoptional
provider_config_idstringoptionalnullable
provider_auth_config_idstringoptionalnullable
is_override_tool_filterbooleanoptional

Example request

curl -X PUT "https://api.metorial.com/integration-instances/int_Rm4Mnheq2bfEPhBhP7SY/providers/pro_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_io2h4..." \
  -d '{
  "provider_deployment_id": "example_provider_deployment_id",
  "provider_config_id": "example_provider_config_id",
  "provider_auth_config_id": "example_provider_auth_config_id",
  "tool_filters": {
    "type": "tool_keys",
    "keys": [
      "example_keys"
    ]
  },
  "is_override_tool_filter": false
}'