ServerDeployment

Manage the lifecycle of server deployments tied to a specific instance.

ServerDeployment object

Attributes

object

Object

id

String

The unique identifier of the server deployment

status

Enum

The current status of the server deployment

name

String

The name of the server deployment

description

String

An optional description of the server deployment

metadata

Object

Additional arbitrary metadata related to the server deployment

secret_id

String

Identifier for associated secrets related to this deployment

server

Object

config

Object

server_implementation

Object

created_at

Date

Timestamp when the server deployment was created

updated_at

Date

Timestamp when the server deployment was last updated

{
  "object": "server.server_deployment",
  "id": "example_id",
  "status": "active",
  "name": "example_name",
  "description": "example_description",
  "metadata": {},
  "secret_id": "example_secret_id",
  "server": {
    "object": "server#preview",
    "id": "example_id",
    "name": "example_name",
    "description": "example_description",
    "type": "public",
    "created_at": "2025-07-20T12:25:38.894Z",
    "updated_at": "2025-07-20T12:25:38.894Z"
  },
  "config": {
    "object": "server.server_deployment.config",
    "id": "example_id",
    "status": "active",
    "secret_id": "example_secret_id",
    "created_at": "2025-07-20T12:25:38.894Z"
  },
  "server_implementation": {
    "object": "server.server_implementation",
    "id": "example_id",
    "status": "active",
    "name": "example_name",
    "description": "example_description",
    "metadata": {},
    "get_launch_params": "example_get_launch_params",
    "server_variant": {
      "object": "server.server_variant#preview",
      "id": "example_id",
      "identifier": "example_identifier",
      "server_id": "example_server_id",
      "source": {
        "type": "docker",
        "docker": {}
      },
      "created_at": "2025-07-20T12:25:38.894Z"
    },
    "server": {
      "object": "server#preview",
      "id": "example_id",
      "name": "example_name",
      "description": "example_description",
      "type": "public",
      "created_at": "2025-07-20T12:25:38.894Z",
      "updated_at": "2025-07-20T12:25:38.894Z"
    },
    "created_at": "2025-07-20T12:25:38.894Z",
    "updated_at": "2025-07-20T12:25:38.894Z"
  },
  "created_at": "2025-07-20T12:25:38.894Z",
  "updated_at": "2025-07-20T12:25:38.894Z"
}

List server deployments

Retrieve a list of server deployments within the instance. Supports filtering by status, server, variant, and session.

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

Get server deployment

Fetch detailed information about a specific server deployment.

URL Parameters

serverDeploymentId

String

The unique identifier for the serverDeployment

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

Create server deployment

Create a new server deployment using an existing or newly defined server implementation.

POSThttp://api.metorial.com/server-deployments
curl -X POST "https://api.metorial.com/server-deployments" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..."

Update server deployment

Update metadata, configuration, or other properties of a server deployment.

URL Parameters

serverDeploymentId

String

The unique identifier for the serverDeployment

Request Body

name

StringOptional

description

StringOptional

metadata

ObjectOptional

config

ObjectOptional
PATCHhttp://api.metorial.com/server-deployments/:serverDeploymentId
curl -X PATCH "https://api.metorial.com/server-deployments/ser_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "metadata": {},
  "config": {}
}'

Delete server deployment

Delete a server deployment from the instance.

URL Parameters

serverDeploymentId

String

The unique identifier for the serverDeployment

DELETEhttp://api.metorial.com/server-deployments/:serverDeploymentId
curl -X DELETE "https://api.metorial.com/server-deployments/ser_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..."