Session Templates

Create session template

Creates a new session template.

post/session-templates

Request

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

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 required
descriptionstring
metadataobject

Custom key-value pairs for storing additional information

Example request

{
  "name": "Production Template",
  "description": "Template for production sessions"
}

Response

Successful response

object'session.template' required

String representing the object's type

idstring required

Unique session template identifier

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

Status of the session template

namestring required

Template name

descriptionstring nullable required

Template description

metadataobject nullable required

Custom key-value pairs

integration_instance_idstring nullable required
integration_instance_group_idstring nullable required
identity_actor_idstring nullable required
identity_idstring nullable required
created_atstring date-time required

Timestamp when created

updated_atstring date-time required

Timestamp when last updated

Example response

{
  "id": "stm_2bCdEfGhJkLmNpQr",
  "name": "Production Template",
  "description": "Template for production sessions",
  "providers": [
    {
      "id": "stp_3cDeFgHjKlMnPqRs",
      "provider_id": "pro_5gHjKlMnPqRsTuVw",
      "session_template_id": "stm_2bCdEfGhJkLmNpQr",
      "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"
    }
  ],
  "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.