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

object

String

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

StringNullable

An optional description of the server deployment

oauth_connection

ObjectNullable

callback

ObjectNullable

result

Object

The result status of the server deployment, indicating success, pending actions, or failure details

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

access

ObjectNullable

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",
  "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"
      ]
    }
  },
  "callback": {
    "object": "callback",
    "type": "webhook_managed",
    "schedule": {
      "object": "callback.schedule"
    }
  },
  "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"
    }
  },
  "access": {
    "ip_allowlist": {
      "status": "enabled"
    }
  }
}

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

search

StringOptional
GEThttp://api.metorial.com/server-deployments
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 -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

ObjectOptional

A key-value map

oauth_config

ObjectOptional

access

ObjectOptional

server_deployment_template_id

StringOptional
Provide exactly one of the following:
These 2 fields are mutually exclusive - include only one in your request

config

Object

A key-value map

server_config_vault_id

String
Provide exactly one of the following:
These 4 fields are mutually exclusive - include only one in your request

server_implementation

Object

server_implementation_id

String

server_variant_id

String

server_id

String
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_..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "metadata": {},
  "oauth_config": {
    "client_id": "example_client_id",
    "client_secret": "example_client_secret"
  },
  "access": {
    "ip_allowlist": {
      "ip_whitelist": [
        "example_item"
      ],
      "ip_blacklist": [
        "example_item"
      ]
    }
  },
  "server_deployment_template_id": "example_server_deployment_template_id",
  "config": {},
  "server_implementation": {
    "name": "example_name",
    "description": "example_description",
    "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

ObjectOptional

A key-value map

config

ObjectOptional

A key-value map

access

ObjectOptional
PATCHhttp://api.metorial.com/server-deployments/:server_deployment_id
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": {},
  "access": {
    "ip_allowlist": {
      "ip_whitelist": [
        "example_item"
      ],
      "ip_blacklist": [
        "example_item"
      ]
    }
  }
}'

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 -X DELETE "https://api.metorial.com/server-deployments/ser_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."