MEmetorial
Provider Deployments

Update provider deployment

Updates a specific provider deployment.

patch/provider-deployments/{provider_deployment_id}

Request

  • Base URL
    https://api.metorial.com
  • Auth
    HTTP bearer

Path parameters

provider_deployment_idstring required

Unique identifier of the provider deployment.

Headers

Metorial-Versionstring
Example:2025-01-01

Pin the dated API version for this request, e.g. 2025-01-01. Defaults to the version configured for the environment.

Request body

namestring
descriptionstring
metadataobject

Custom key-value pairs for storing additional information

locked_provider_version_idstring nullable

Pin this deployment to a specific provider version, or null to follow latest

Example request

{
  "name": "Updated Deployment Name",
  "description": "Updated description for this deployment",
  "locked_provider_version_id": "prv_4dEfGhJkLmNpQrSt"
}

Response

Successful response

object'provider.deployment' required

String representing the object's type

idstring required

Unique deployment identifier

status'active' | 'archived' | 'deleted' required

Deployment status

is_defaultboolean required

Whether this is the default deployment

namestring nullable required

Display name

descriptionstring nullable required

Description

metadataobject nullable required

Custom key-value pairs for storing additional information

provider_idstring required

Provider ID

created_atstring date-time required

Timestamp when created

updated_atstring date-time required

Timestamp when last updated

Example response

{
  "id": "pde_1aBcDeFgHjKlMnPq",
  "name": "Production",
  "description": "Production deployment",
  "provider_id": "pro_5gHjKlMnPqRsTuVw",
  "locked_version": {
    "id": "prv_4dEfGhJkLmNpQrSt",
    "version": "1.0.0",
    "provider_id": "pro_5gHjKlMnPqRsTuVw",
    "name": "Version 1.0.0",
    "specification_id": "psp_9gHjKlMnPqRsTuVw",
    "created_at": "2025-09-15T10:30:00.000Z",
    "updated_at": "2026-01-10T14:45:00.000Z"
  },
  "default_config": {
    "id": "pcf_7dEfGhJkLmNpQrSt",
    "name": "Production Config",
    "description": "Configuration for production environment",
    "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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.