Server Variant

Server variants define different instances of a server, each with its own configuration and capabilities. By default, Metorial picks the best variant automatically, but you can specify a variant if needed.

Server Variant object

Attributes

object

Object

id

String

The unique identifier for this server variant

identifier

String

A unique string identifier for the server variant

server

Object

current_version

Object

source

Object

The source type and configuration for this server variant

created_at

Date

Timestamp when the server variant was created

{
  "object": "server.server_variant",
  "id": "example_id",
  "identifier": "example_identifier",
  "server": {
    "object": "server#preview",
    "id": "example_id",
    "name": "example_name",
    "description": "example_description",
    "type": "public",
    "created_at": "2025-08-01T08:26:25.865Z",
    "updated_at": "2025-08-01T08:26:25.865Z"
  },
  "current_version": {
    "object": "server.server_version",
    "id": "example_id",
    "identifier": "example_identifier",
    "server_id": "example_server_id",
    "server_variant_id": "example_server_variant_id",
    "get_launch_params": "example_get_launch_params",
    "source": {
      "type": "docker",
      "docker": {}
    },
    "schema": {
      "id": "example_id",
      "fingerprint": "example_fingerprint",
      "schema": {},
      "server_id": "example_server_id",
      "server_variant_id": "example_server_variant_id",
      "server_version_id": "example_server_version_id",
      "created_at": "2025-08-01T08:26:25.865Z"
    },
    "server": {
      "object": "server#preview",
      "id": "example_id",
      "name": "example_name",
      "description": "example_description",
      "type": "public",
      "created_at": "2025-08-01T08:26:25.865Z",
      "updated_at": "2025-08-01T08:26:25.865Z"
    },
    "created_at": "2025-08-01T08:26:25.865Z"
  },
  "source": {
    "type": "docker",
    "docker": {}
  },
  "created_at": "2025-08-01T08:26:25.865Z"
}

List server variants

Retrieve all variants for a given server

URL Parameters

serverId

String

The unique identifier for the server

GEThttp://api.metorial.com/servers/:serverId/variants
curl -X GET "https://api.metorial.com/servers/ser_Rm4Mnheq2bfEPhBhP7SY/variants" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..."

Get server variant

Retrieve details for a specific server variant

URL Parameters

serverId

String

The unique identifier for the server

serverVariantId

String

The unique identifier for the serverVariant

GEThttp://api.metorial.com/servers/:serverId/variants/:serverVariantId
curl -X GET "https://api.metorial.com/servers/ser_Rm4Mnheq2bfEPhBhP7SY/variants/ser_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..."