MetorialDocs

Provider Config Vaults

A config vault is a saved, reusable set of configuration values. Use vaults to store credentials once and apply them to multiple deployments without re-entering.

The Provider Config Vault object

provider_config_vault.json
{
  "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"
}
object"provider.config_vault"required
idstringrequired
status"active" | "archived" | "deleted"required
namestringrequired
descriptionstringrequirednullable
metadataRecord<string, any>requirednullable
provider_idstringrequired
created_atdaterequired
updated_atdaterequired

Endpoints

List provider config vaults

GET/provider-config-vaults

Returns a paginated list of provider config vaults.

Query parameters

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

Filter by status (active, archived)

idstring or string[]optional

Filter by config vault ID(s)

provider_idstring or string[]optional

Filter by provider ID(s)

provider_deployment_idstring or string[]optional

Filter by provider deployment ID(s)

provider_config_idstring or string[]optional

Filter by provider config ID(s)

provider_config_vault_idstring or string[]optional

Filter by config vault ID(s)

searchstringoptional

Search by name or description

Example request

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

Get provider config vault

GET/provider-config-vaults/:provider_config_vault_id

Retrieves a specific provider config vault by ID.

Path parameters

provider_config_vault_idstringrequired

The unique identifier for the provider_config_vault

Example request

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

Create provider config vault

POST/provider-config-vaults

Creates a new provider config vault.

Request body

provider_idstringrequired

Provider ID

provider_deployment_idstringoptional

Provider deployment ID

namestringrequired
descriptionstringoptional
metadataRecord<string, any>optional

Custom key-value pairs for storing additional information

valueRecord<string, any>required

Secure configuration values to store in the vault

Example request

curl -X POST "https://api.metorial.com/provider-config-vaults" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_io2h4..." \
  -d '{
  "provider_id": "pro_5gHjKlMnPqRsTuVw",
  "provider_deployment_id": "pdp_4dEfGhJkLmNpQrSt",
  "name": "Production Secrets",
  "description": "Secure storage for production credentials",
  "metadata": {},
  "value": {}
}'

Update provider config vault

PATCH/provider-config-vaults/:provider_config_vault_id

Updates a specific provider config vault.

Path parameters

provider_config_vault_idstringrequired

The unique identifier for the provider_config_vault

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-config-vaults/pro_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_io2h4..." \
  -d '{
  "name": "Updated Vault Name",
  "description": "Updated vault description",
  "metadata": {}
}'

Delete provider config vault

DELETE/provider-config-vaults/:provider_config_vault_id

Permanently deletes a provider config vault.

Path parameters

provider_config_vault_idstringrequired

The unique identifier for the provider_config_vault

Example request

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