Provider Deployments

A deployment is a running instance of a provider, pinned to a specific version. Deployments support custom configuration values and user authentication.

Provider Deployments object

Attributes

object

String

String representing the object's type

id

String

Unique deployment identifier

name

StringNullable

Display name

description

StringNullable

Description

metadata

ObjectNullable

Custom key-value pairs for storing additional information

provider_id

String

Provider ID

provider

ObjectNullable

locked_version

ObjectNullable

default_config

ObjectNullable

created_at

Date

Timestamp when created

updated_at

Date

Timestamp when last updated

{
  "object": "provider.deployment",
  "id": "pde_1aBcDeFgHjKlMnPq",
  "name": "Production",
  "description": "Production deployment",
  "metadata": {
    "notes": "Main deployment"
  },
  "provider_id": "pro_5gHjKlMnPqRsTuVw",
  "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"
  },
  "locked_version": {
    "object": "provider.version",
    "id": "prv_4dEfGhJkLmNpQrSt",
    "version": "1.0.0",
    "status": "released",
    "created_at": "2025-09-15T10:30:00.000Z",
    "updated_at": "2026-01-10T14:45:00.000Z"
  },
  "default_config": {
    "id": "pcf_7dEfGhJkLmNpQrSt",
    "name": "Default Config",
    "description": "Default configuration settings",
    "metadata": {
      "notes": "Primary config"
    },
    "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"
}

List provider deployments

Returns a paginated list of provider deployments.

Query Parameters

limit

NumberOptional

Maximum number of items to return (1-100)

after

StringOptional

Return items after this ID

before

StringOptional

Return items before this ID

cursor

StringOptional

Pagination cursor from a previous response

order

EnumOptional

Sort order for results

search

StringOptional

Search by name

provider_id

UnionOptional

Filter by provider ID(s)

provider_version_id

UnionOptional

Filter by version ID(s)

status

StringOptional

Filter by deployment status

GEThttp://api.metorial.com/provider-deployments
curl -X GET "https://api.metorial.com/provider-deployments" \
  -H "Authorization: Bearer metorial_sk_..."

Get provider deployment

Retrieves a specific provider deployment by ID.

URL Parameters

provider_deployment_id

String

The unique identifier for the provider_deployment

GEThttp://api.metorial.com/provider-deployments/:provider_deployment_id
curl -X GET "https://api.metorial.com/provider-deployments/pro_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."

Create provider deployment

Creates a new provider deployment.

Request Body

name

String

description

StringOptional

metadata

ObjectOptional

Custom key-value pairs for storing additional information

provider_id

String

The provider to deploy

locked_provider_version_id

StringOptional

Pin this deployment to a specific provider version

config

ObjectOptional

Deployment configuration. If omitted, defaults to no configuration.

POSThttp://api.metorial.com/provider-deployments
curl -X POST "https://api.metorial.com/provider-deployments" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "metadata": {},
  "provider_id": "example_provider_id",
  "locked_provider_version_id": "example_locked_provider_version_id",
  "config": {
    "type": "example_type",
    "provider_config_id": "example_provider_config_id"
  }
}'

Update provider deployment

Updates a specific provider deployment.

URL Parameters

provider_deployment_id

String

The unique identifier for the provider_deployment

Request Body

name

StringOptional

description

StringOptional

metadata

ObjectOptional

Custom key-value pairs for storing additional information

PATCHhttp://api.metorial.com/provider-deployments/:provider_deployment_id
curl -X PATCH "https://api.metorial.com/provider-deployments/pro_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "metadata": {}
}'

Delete provider deployment

Permanently deletes a provider deployment.

URL Parameters

provider_deployment_id

String

The unique identifier for the provider_deployment

DELETEhttp://api.metorial.com/provider-deployments/:provider_deployment_id
curl -X DELETE "https://api.metorial.com/provider-deployments/pro_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."