Integration Instance Providers

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

Integration Instance Providers object

Attributes

object

String

id

String

status

Enum

name

String

description

StringNullable

metadata

ObjectNullable

A key-value map

integration_id

String

integration_instance_id

String

tool_filter

ObjectNullable

Tool filter configuration

is_override_tool_filter

Boolean

provider

Object

integration_provider

Object

config

ObjectNullable

auth_config

ObjectNullable

created_at

Date

updated_at

Date

archived_at

DateNullable
{
  "object": "integration.instance.provider",
  "status": "active",
  "metadata": {},
  "tool_filter": {
    "type": "allow_all"
  },
  "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",
    "provider_version": {
      "object": "integration.provider.version"
    },
    "status": "active",
    "metadata": {},
    "tool_filter": {
      "type": "allow_all"
    },
    "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"
    },
    "deployment": {
      "object": "provider.deployment#preview",
      "id": "pde_1aBcDeFgHjKlMnPq",
      "name": "Production",
      "description": "Production deployment",
      "metadata": {},
      "provider_id": "pro_5gHjKlMnPqRsTuVw",
      "created_at": "2025-09-15T10:30:00.000Z",
      "updated_at": "2026-01-10T14:45:00.000Z"
    },
    "auth_method": {
      "object": "provider.capabilities.auth_method",
      "id": "pam_2mNpQrStUvWxYzAb",
      "type": "oauth",
      "key": "oauth2",
      "name": "OAuth 2.0",
      "description": "Authenticate using OAuth 2.0",
      "capabilities": {},
      "input_schema": {
        "type": "json_schema",
        "schema": {}
      },
      "output_schema": {
        "type": "json_schema",
        "schema": {}
      },
      "scopes": [
        {
          "object": "provider.capabilities.auth_method.scope",
          "id": "pams_8tUvWxYzAbCdEfGh",
          "scope": "repo",
          "name": "Repository Access",
          "description": "Full control of private repositories"
        },
        {
          "object": "provider.capabilities.auth_method.scope",
          "id": "pams_8tUvWxYzAbCdEfGh",
          "scope": "repo",
          "name": "Repository Access",
          "description": "Full control of private repositories"
        }
      ],
      "provider_id": "pro_5gHjKlMnPqRsTuVw",
      "provider_specification_id": "psp_9gHjKlMnPqRsTuVw",
      "created_at": "2025-09-15T10:30:00.000Z",
      "updated_at": "2026-01-10T14:45:00.000Z"
    },
    "auth_credentials": {
      "object": "provider.auth_credentials",
      "id": "par_4sTuVwXyZaBcDeFg",
      "type": "oauth",
      "status": "active",
      "is_default": true,
      "is_managed": true,
      "name": "GitHub OAuth",
      "description": "OAuth credentials for GitHub API",
      "metadata": {},
      "provider_id": "pro_5gHjKlMnPqRsTuVw",
      "created_at": "2025-09-15T10:30:00.000Z",
      "updated_at": "2026-01-10T14:45:00.000Z"
    },
    "config": {
      "object": "provider.config#preview",
      "id": "pcf_7dEfGhJkLmNpQrSt",
      "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"
    }
  },
  "config": {
    "object": "provider.config#preview",
    "id": "pcf_7dEfGhJkLmNpQrSt",
    "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",
    "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"
  }
}

List integration instance providers

Returns a paginated list of integration instance providers.

Query Parameters

limit

NumberOptional

after

StringOptional

before

StringOptional

cursor

StringOptional

order

EnumOptional

search

StringOptional

status

UnionOptional

id

UnionOptional

integration_id

UnionOptional

integration_instance_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 provider creation time by date range

updated_at

ObjectOptional

Filter integration instance provider last update time by date range

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

Get integration instance provider

Retrieves a specific integration instance provider.

URL Parameters

integration_instance_provider_id

String

The unique identifier for the integration_instance_provider

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

Set integration instance provider

Creates or updates the effective integration instance provider materialization.

URL Parameters

integration_instance_id

String

The unique identifier for the integration_instance

provider_id

String

The unique identifier for the provider

Request Body

provider_deployment_id

StringOptional

provider_config_id

StringOptionalNullable

provider_auth_config_id

StringOptionalNullable

tool_filters

UnionOptionalNullable

is_override_tool_filter

BooleanOptional
PUThttp://api.metorial.com/integration-instances/:integration_instance_id/providers/:provider_id
curl -X PUT "https://api.metorial.com/integration-instances/int_Rm4Mnheq2bfEPhBhP7SY/providers/pro_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -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": "example_type",
    "keys": [
      "example_item"
    ]
  },
  "is_override_tool_filter": false
}'