Server Deployment

A server deployment represents a specific instance of an MCP server that can be connected to. It contains configuration for the MCP server, such as API keys for the underlying MCP server.

Server Deployment object

Attributes

items

Object

{
  "items": {
    "0": {
      "object": "server.server_deployment",
      "status": "active",
      "oauth_connection": {
        "object": "provider_oauth.connection",
        "status": "active",
        "metadata": {},
        "provider": {
          "name": "GitHub",
          "url": "https://github.com",
          "image_url": "https://camo.metorial.com/igu4hi54high"
        },
        "config": {
          "type": "json",
          "config": {},
          "scopes": [
            "repo",
            "repo"
          ]
        }
      },
      "result": {
        "status": "active"
      },
      "metadata": {},
      "server": {
        "object": "server#preview",
        "type": "public"
      },
      "config": {
        "object": "server.server_deployment.config",
        "status": "active"
      },
      "server_implementation": {
        "object": "server.server_implementation",
        "status": "active",
        "metadata": {},
        "server_variant": {
          "object": "server.server_variant#preview",
          "source": {
            "type": "docker",
            "docker": {}
          }
        },
        "server": {
          "object": "server#preview",
          "type": "public"
        }
      }
    },
    "object": "example_object",
    "id": "example_id",
    "status": "",
    "name": "example_name",
    "description": "example_description",
    "oauth_connection": {
      "object": "example_object",
      "id": "example_id",
      "status": "",
      "name": "example_name",
      "description": "example_description",
      "metadata": "example_metadata",
      "provider": {
        "id": "example_id",
        "name": "example_name",
        "url": "example_url",
        "image_url": "example_image_url"
      },
      "config": {
        "type": "",
        "config": "example_config",
        "scopes": [
          "example_item"
        ]
      },
      "client_id": "example_client_id",
      "instance_id": "example_instance_id",
      "template_id": "example_template_id",
      "created_at": "2025-10-15T16:41:26.818Z",
      "updated_at": "2025-10-15T16:41:26.818Z"
    },
    "result": {
      "status": "example_status"
    },
    "metadata": "example_metadata",
    "secret_id": "example_secret_id",
    "server": {
      "object": "example_object",
      "id": "example_id",
      "name": "example_name",
      "description": "example_description",
      "type": "",
      "created_at": "2025-10-15T16:41:26.818Z",
      "updated_at": "2025-10-15T16:41:26.818Z"
    },
    "config": {
      "object": "example_object",
      "id": "example_id",
      "status": "",
      "secret_id": "example_secret_id",
      "created_at": "2025-10-15T16:41:26.818Z"
    },
    "server_implementation": {
      "object": "example_object",
      "id": "example_id",
      "status": "",
      "name": "example_name",
      "description": "example_description",
      "metadata": "example_metadata",
      "get_launch_params": "example_get_launch_params",
      "server_variant": {
        "object": "example_object",
        "id": "example_id",
        "identifier": "example_identifier",
        "server_id": "example_server_id",
        "source": {
          "type": "example_type",
          "docker": {
            "image": "example_image"
          }
        },
        "created_at": "2025-10-15T16:41:26.818Z"
      },
      "server": {
        "object": "example_object",
        "id": "example_id",
        "name": "example_name",
        "description": "example_description",
        "type": "",
        "created_at": "2025-10-15T16:41:26.818Z",
        "updated_at": "2025-10-15T16:41:26.818Z"
      },
      "created_at": "2025-10-15T16:41:26.818Z",
      "updated_at": "2025-10-15T16:41:26.818Z"
    },
    "created_at": "2025-10-15T16:41:26.818Z",
    "updated_at": "2025-10-15T16:41:26.818Z"
  },
  "pagination": {
    "has_more_before": false,
    "has_more_after": false
  }
}

cURL

List server deployments

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

Query Parameters

limit

NumberOptional

after

StringOptional

before

StringOptional

cursor

StringOptional

order

EnumOptional

status

UnionOptional

server_id

UnionOptional

server_variant_id

UnionOptional

server_implementation_id

UnionOptional

session_id

UnionOptional

StringOptional

GEThttp://api.metorial.com/server-deployments

cURL

curl -X GET "https://api.metorial.com/server-deployments" \
  -H "Authorization: Bearer metorial_sk_..."

Get server deployment

Fetch detailed information about a specific server deployment.

URL Parameters

server_deployment_id

String

The unique identifier for the server_deployment

GEThttp://api.metorial.com/server-deployments/:server_deployment_id

cURL

curl -X GET "https://api.metorial.com/server-deployments/ser_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."

Create server deployment

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

Request Body

name

StringOptional

description

StringOptional

metadata

StringOptional

config

String

oauth_config

ObjectOptional

server_implementation

Object

server_implementation_id

String

server_variant_id

String

server_id

String

POSThttp://api.metorial.com/server-deployments

cURL

curl -X POST "https://api.metorial.com/server-deployments" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "metadata": "example_metadata",
  "config": "example_config",
  "oauth_config": {
    "client_id": "example_client_id",
    "client_secret": "example_client_secret"
  },
  "server_implementation": {
    "name": "example_name",
    "description": "example_description",
    "metadata": "example_metadata",
    "get_launch_params": "example_get_launch_params"
  }
}'

Update server deployment

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

URL Parameters

server_deployment_id

String

The unique identifier for the server_deployment

Request Body

name

StringOptional

description

StringOptional

metadata

StringOptional

config

StringOptional

PATCHhttp://api.metorial.com/server-deployments/:server_deployment_id

cURL

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": "example_metadata",
  "config": "example_config"
}'

Delete server deployment

Delete a server deployment from the instance.

URL Parameters

server_deployment_id

String

The unique identifier for the server_deployment

DELETEhttp://api.metorial.com/server-deployments/:server_deployment_id

cURL

curl -X DELETE "https://api.metorial.com/server-deployments/ser_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."