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

items

Object
{
  "items": {
    "0": {
      "object": "server.server_variant",
      "status": "active",
      "server": {
        "object": "server#preview",
        "type": "public"
      },
      "current_version": {
        "object": "server.server_version",
        "source": {
          "type": "docker",
          "docker": {}
        },
        "schema": {},
        "server": {
          "object": "server#preview",
          "type": "public"
        }
      },
      "source": {
        "type": "docker",
        "docker": {}
      }
    },
    "object": "example_object",
    "id": "example_id",
    "status": "",
    "identifier": "example_identifier",
    "server": {
      "object": "example_object",
      "id": "example_id",
      "name": "example_name",
      "description": "example_description",
      "type": "",
      "created_at": "2025-10-15T16:41:26.661Z",
      "updated_at": "2025-10-15T16:41:26.661Z"
    },
    "current_version": {
      "object": "example_object",
      "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": "example_type",
        "docker": {
          "image": "example_image",
          "tag": "example_tag"
        }
      },
      "schema": "example_schema",
      "server": {
        "object": "example_object",
        "id": "example_id",
        "name": "example_name",
        "description": "example_description",
        "type": "",
        "created_at": "2025-10-15T16:41:26.661Z",
        "updated_at": "2025-10-15T16:41:26.661Z"
      },
      "created_at": "2025-10-15T16:41:26.661Z"
    },
    "source": {
      "type": "example_type",
      "docker": {
        "image": "example_image"
      }
    },
    "created_at": "2025-10-15T16:41:26.661Z"
  },
  "pagination": {
    "has_more_before": false,
    "has_more_after": false
  }
}

List server variants

Retrieve all variants for a given server

URL Parameters

server_id

String

The unique identifier for the server

Query Parameters

limit

NumberOptional

after

StringOptional

before

StringOptional

cursor

StringOptional

order

EnumOptional
GEThttp://api.metorial.com/servers/:server_id/variants
curl -X GET "https://api.metorial.com/servers/ser_Rm4Mnheq2bfEPhBhP7SY/variants" \
  -H "Authorization: Bearer metorial_sk_..."

Get server variant

Retrieve details for a specific server variant

URL Parameters

server_id

String

The unique identifier for the server

server_variant_id

String

The unique identifier for the server_variant

GEThttp://api.metorial.com/servers/:server_id/variants/:server_variant_id
curl -X GET "https://api.metorial.com/servers/ser_Rm4Mnheq2bfEPhBhP7SY/variants/ser_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."