MetorialDocs

Provider Configs

A config holds settings for a deployment, like API endpoints or feature flags. Create configs with values directly, or from a saved config vault with pre-saved values.

The Provider Config object

provider_config.json
{
  "object": "provider.config",
  "id": "pcf_7dEfGhJkLmNpQrSt",
  "status": "active",
  "is_default": false,
  "name": "Production Config",
  "description": "Configuration for production environment",
  "metadata": {},
  "tool_filter": {
    "type": "allow_all",
    "ignore_parent_filters": false
  },
  "provider_id": "pro_5gHjKlMnPqRsTuVw",
  "specification_id": "psp_9gHjKlMnPqRsTuVw",
  "deployment": {
    "object": "provider.deployment#preview",
    "id": "pde_1aBcDeFgHjKlMnPq",
    "is_default": false,
    "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"
  },
  "from_vault": {
    "object": "provider.config_vault",
    "id": "pcvt_3bCdEfGhJkLmNpQr",
    "status": "active",
    "name": "Production Secrets",
    "description": "Secure storage for production credentials",
    "metadata": {},
    "provider_id": "pro_5gHjKlMnPqRsTuVw",
    "deployment": {
      "object": "provider.deployment#preview",
      "id": "pde_1aBcDeFgHjKlMnPq",
      "is_default": false,
      "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"
    },
    "created_at": "2025-09-15T10:30:00.000Z",
    "updated_at": "2026-01-10T14:45:00.000Z"
  },
  "created_at": "2025-09-15T10:30:00.000Z",
  "updated_at": "2026-01-10T14:45:00.000Z"
}
object"provider.config"required
idstringrequired
status"active" | "archived" | "deleted"required
is_defaultbooleanrequired
namestringrequirednullable
descriptionstringrequirednullable
metadataRecord<string, any>requirednullable
provider_idstringrequired
specification_idstringrequired
created_atdaterequired
updated_atdaterequired

Endpoints

List provider configs

GET/provider-configs

Returns a paginated list of provider configs.

Query parameters

status"active" | "archived" or "active" | "archived"[]optional

Filter by status (active, archived)

idstring or string[]optional

Filter by config ID(s)

provider_idstring or string[]optional

Filter by provider ID(s)

provider_specification_idstring or string[]optional

Filter by provider specification ID(s)

provider_deployment_idstring or string[]optional

Filter by provider deployment ID(s)

available_for_usebooleanoptional

Only return configs that are not owned by another integration instance provider.

available_for_provider_deployment_idstringoptional

Only return configs that are not locked to a different provider deployment.

provider_config_vault_idstring or string[]optional

Filter by config vault ID(s)

actor_idstring or string[]optional

Filter by actor ID(s)

consumer_idstring or string[]optional

Filter by consumer ID(s)

identity_idstring or string[]optional

Filter by identity ID(s)

identity_credential_idstring or string[]optional

Filter by identity credential ID(s)

searchstringoptional

Search by name or description

Example request

curl -X GET "https://api.metorial.com/provider-configs" \
  -H "Authorization: Bearer metorial_sk_io2h4..."

Get provider config

GET/provider-configs/:provider_config_id

Retrieves a specific provider config by ID.

Path parameters

provider_config_idstringrequired

The unique identifier for the provider_config

Example request

curl -X GET "https://api.metorial.com/provider-configs/pro_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_io2h4..."

Create provider config

POST/provider-configs

Creates a new provider config.

Request body

provider_idstringrequired

Provider ID

provider_deployment_idstringoptional

Optional provider deployment ID

namestringoptional
descriptionstringoptional
metadataRecord<string, any>optional

Custom key-value pairs for storing additional information

valueRecord<string, any>required

Provider-specific configuration values

provider_config_vault_idstringrequired

Config vault ID to use as template

Example request

curl -X POST "https://api.metorial.com/provider-configs" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_io2h4..." \
  -d '{
  "provider_id": "example_provider_id",
  "provider_deployment_id": "example_provider_deployment_id",
  "name": "example_name",
  "description": "example_description",
  "metadata": {},
  "tool_filters": {
    "type": "tool_keys",
    "keys": [
      "example_keys"
    ]
  },
  "value": {}
}'

Update provider config

PATCH/provider-configs/:provider_config_id

Updates a specific provider config.

Path parameters

provider_config_idstringrequired

The unique identifier for the provider_config

Request body

namestringoptional
descriptionstringoptional
metadataRecord<string, any>optional

Custom key-value pairs for storing additional information

Example request

curl -X PATCH "https://api.metorial.com/provider-configs/pro_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_io2h4..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "metadata": {},
  "tool_filters": {
    "type": "tool_keys",
    "keys": [
      "example_keys"
    ]
  }
}'

Delete provider config

DELETE/provider-configs/:provider_config_id

Permanently deletes a provider config.

Path parameters

provider_config_idstringrequired

The unique identifier for the provider_config

Example request

curl -X DELETE "https://api.metorial.com/provider-configs/pro_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_io2h4..."

Get config schema

GET/provider-config-schema

Retrieves the JSON Schema for configuration of this provider deployment.

Query parameters

provider_idstringoptional
provider_config_idstringoptional
provider_version_idstringoptional
provider_deployment_idstringoptional

Example request

curl -X GET "https://api.metorial.com/provider-config-schema" \
  -H "Authorization: Bearer metorial_sk_io2h4..."