---
title: "Create provider deployment"
method: POST
path: "/provider-deployments"
tags: ["Provider Deployments"]
---

# Create provider deployment

`POST /provider-deployments`

## Request

- Base URL: `https://api.metorial.com`
- URL: `https://api.metorial.com/provider-deployments`
- Auth: HTTP bearer

Creates a new provider deployment.

## Headers

- `Metorial-Version` string

## Request body

- BodyRequest42
  - `name` string
  - `description` string
  - `metadata` object: Custom key-value pairs for storing additional information
  - `tool_filters` union
    - object
      - `type` 'tool_keys', required
      - `keys` string[], required
    - object
      - `type` 'tool_categories', required
      - `keys` string[], required
    - object
      - `type` 'tool_regex', required
      - `pattern` string, required
    - object
      - `type` 'resource_regex', required
      - `pattern` string, required
    - object
      - `type` 'resource_uris', required
      - `uris` string[], required
    - object
      - `type` 'prompt_keys', required
      - `keys` string[], required
    - object
      - `type` 'prompt_regex', required
      - `pattern` string, required
    - union[]
      - union
        - object
          - `type` 'tool_keys', required
          - `keys` string[], required
        - object
          - `type` 'tool_categories', required
          - `keys` string[], required
        - object
          - `type` 'tool_regex', required
          - `pattern` string, required
        - object
          - `type` 'resource_regex', required
          - `pattern` string, required
        - object
          - `type` 'resource_uris', required
          - `uris` string[], required
        - object
          - `type` 'prompt_keys', required
          - `keys` string[], required
        - object
          - `type` 'prompt_regex', required
          - `pattern` string, required
  - `provider_id` string, required: The provider to deploy
  - `locked_provider_version_id` string: Pin this deployment to a specific provider version
  - `provider_config_id` string: Existing provider config ID
  - `provider_config` union
    - object
      - `name` string
      - `value` object, required: Provider-specific configuration values
    - ProviderConfig
      - `name` string
      - `provider_config_vault_id` string, required: Provider config vault ID
      - `provider_id` string: Explicitly specify provider ID to associate with this auth config

## Response `200`

Successful response

- Deployment
  - `object` 'provider.deployment', required: String representing the object's type
  - `id` string, required: Unique deployment identifier
  - `status` 'active' | 'archived' | 'deleted', required: Deployment status
  - `is_default` boolean, required: Whether this is the default deployment
  - `name` string, nullable, required: Display name
  - `description` string, nullable, required: Description
  - `metadata` object, nullable, required: Custom key-value pairs for storing additional information
  - `tool_filter` union, required: Tool filter configuration
    - object
      - `type` 'allow_all', required
      - `ignore_parent_filters` boolean, required
    - ToolFilter
      - `type` 'filter', required
      - `filters` union[], required
        - union
          - object
            - `type` 'tool_keys', required
            - `keys` string[], required
          - object
            - `type` 'tool_categories', required
            - `keys` string[], required
          - object
            - `type` 'tool_regex', required
            - `pattern` string, required
          - object
            - `type` 'resource_regex', required
            - `pattern` string, required
          - object
            - `type` 'resource_uris', required
            - `uris` string[], required
          - object
            - `type` 'prompt_keys', required
            - `keys` string[], required
          - object
            - `type` 'prompt_regex', required
            - `pattern` string, required
      - `ignore_parent_filters` boolean, required
  - `provider_id` string, required: Provider ID
  - `locked_version` object, nullable, required
    - `object` 'provider.version', required: String representing the object's type
    - `id` string, required: Unique version identifier
    - `version` string, required: Version identifier string
    - `provider_id` string, required: Provider ID
    - `is_current` boolean, required: Whether this is the current version
    - `name` string, required: Version name
    - `description` string, nullable, required: Version description
    - `metadata` object, nullable, required: Custom key-value pairs for storing additional information
    - `specification_id` string, nullable, required: Specification ID
    - `created_at` string, date-time, required: Timestamp when created
    - `updated_at` string, date-time, required: Timestamp when last updated
  - `default_config` object, nullable, required
    - `object` 'provider.config#preview', required: String representing the object's type
    - `id` string, required: Config ID
    - `is_default` boolean, required: Whether this is the default config
    - `name` string, nullable, required: Config name
    - `description` string, nullable, required: Description
    - `metadata` object, nullable, required: Custom key-value pairs for storing additional information
    - `provider_id` string, required: Provider ID
    - `created_at` string, date-time, required: Timestamp when created
    - `updated_at` string, date-time, required: Timestamp when last updated
  - `created_at` string, date-time, required: Timestamp when created
  - `updated_at` string, date-time, required: Timestamp when last updated

## Other responses

- `400`: Invalid parameters or action
- `401`: Missing or invalid API key
- `403`: The key lacks permission for this resource
- `404`: No such resource
- `422`: Validation failed
- `429`: Rate limit exceeded
- `500`: Unexpected server error

---

[API](https://skmtc.dev/metorial/apis/metorial-api.md) - [All operations](https://skmtc.dev/metorial/apis/metorial-api/llms.txt) - [OpenAPI document](https://skmtc.dev/metorial/apis/metorial-api/revisions/10ccc89f3eac?raw)