Session Providers

Update session provider

Updates a provider connected to a session.

patch/session-providers/{session_provider_id}

Request

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

Path parameters

session_provider_idstring required

Unique identifier of the session provider.

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

Response

Successful response

object'session.provider' required

String representing the object's type

idstring required

Unique session provider identifier

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

Provider status

provider_idstring required

Provider ID

session_idstring required

Parent session ID

from_template_idstring nullable required

Source template ID

from_template_provider_idstring nullable required

Source template provider ID

created_atstring date-time required

Timestamp when created

updated_atstring date-time required

Timestamp when last updated

Example response

{
  "id": "spr_3cDeFgHjKlMnPqRs",
  "provider_id": "pro_5gHjKlMnPqRsTuVw",
  "session_id": "ses_4dEfGhJkLmNpQrSt",
  "from_template_id": "stm_2bCdEfGhJkLmNpQr",
  "from_template_provider_id": "stp_3cDeFgHjKlMnPqRs",
  "deployment": {
    "id": "pde_1aBcDeFgHjKlMnPq",
    "name": "Production",
    "description": "Production deployment",
    "provider_id": "pro_5gHjKlMnPqRsTuVw",
    "created_at": "2025-09-15T10:30:00.000Z",
    "updated_at": "2026-01-10T14:45:00.000Z"
  },
  "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.