Servers

Endpoint for retrieving information about a specific server within an instance.

Servers object

Attributes

object

Object

id

String

The unique identifier for the server

type

Enum

The visibility type of the server; currently only "public" is supported

name

String

The display name of the server

description

String

An optional description providing more details about the server

imported_server_id

String

ID of the server this one was imported from, if applicable

variants

Array of Objects

A list of available variants for this server

metadata

Object

Arbitrary key-value metadata associated with the server

created_at

Date

Timestamp when the server was created

updated_at

Date

Timestamp when the server was last updated

{
  "object": "server",
  "id": "example_id",
  "type": "public",
  "name": "example_name",
  "description": "example_description",
  "imported_server_id": "example_imported_server_id",
  "variants": [
    {
      "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-07-20T12:25:38.710Z",
        "updated_at": "2025-07-20T12:25:38.710Z"
      },
      "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-07-20T12:25:38.710Z"
        },
        "server": {
          "object": "server#preview",
          "id": "example_id",
          "name": "example_name",
          "description": "example_description",
          "type": "public",
          "created_at": "2025-07-20T12:25:38.710Z",
          "updated_at": "2025-07-20T12:25:38.710Z"
        },
        "created_at": "2025-07-20T12:25:38.710Z"
      },
      "source": {
        "type": "docker",
        "docker": {}
      },
      "created_at": "2025-07-20T12:25:38.710Z"
    },
    {
      "object": "server.server_variant",
      "server": {
        "object": "server#preview",
        "type": "public"
      },
      "current_version": {
        "object": "server.server_version",
        "source": {
          "type": "docker",
          "docker": {}
        },
        "schema": {
          "schema": {}
        },
        "server": {
          "object": "server#preview",
          "type": "public"
        }
      },
      "source": {
        "type": "docker",
        "docker": {}
      }
    }
  ],
  "metadata": {},
  "created_at": "2025-07-20T12:25:38.710Z",
  "updated_at": "2025-07-20T12:25:38.710Z"
}

Get server by ID

Retrieves detailed information for a server identified by its ID.

URL Parameters

serverId

String

The unique identifier for the server

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