Custom Server

Manager custom server deployments

Custom Server object

Attributes

object

String

id

String

The custom server deployment's unique identifier

status

Enum

The current status of the custom server deployment

trigger

Enum

The trigger type for the custom server deployment

creator_actor

Object

custom_server_id

String

The ID of the custom server associated with this deployment

custom_server_version_id

StringNullable

The ID of the custom server version associated with this deployment, if applicable

created_at

Date

The timestamp when the custom server deployment was created

updated_at

Date

The timestamp when the custom server deployment was last updated

started_at

DateNullable

The timestamp when the custom server deployment started

ended_at

DateNullable

The timestamp when the custom server deployment ended

steps

Object
{
  "object": "custom_server.deployment",
  "status": "queued",
  "trigger": "manual",
  "creator_actor": {
    "object": "organization.actor",
    "type": "member",
    "image_url": "https://avatar-cdn.metorial.com/aimg_1234567890",
    "teams": [
      {},
      {}
    ]
  },
  "steps": [
    {
      "object": "custom_server.deployment.step",
      "status": "running",
      "type": "started",
      "logs": [
        {
          "type": "info"
        },
        {
          "type": "info"
        }
      ]
    },
    {
      "object": "custom_server.deployment.step",
      "status": "running",
      "type": "started",
      "logs": [
        {
          "type": "info"
        },
        {
          "type": "info"
        }
      ]
    }
  ]
}

List custom server deployments

List all custom server deployments

URL Parameters

custom_server_id

String

The unique identifier for the custom_server

Query Parameters

limit

NumberOptional

after

StringOptional

before

StringOptional

cursor

StringOptional

order

EnumOptional

version_id

UnionOptional
GEThttp://api.metorial.com/custom-servers/:custom_server_id/deployments
curl -X GET "https://api.metorial.com/custom-servers/cus_Rm4Mnheq2bfEPhBhP7SY/deployments" \
  -H "Authorization: Bearer metorial_sk_..."

Get custom server deployment

Get information for a specific custom server deployment

URL Parameters

custom_server_id

String

The unique identifier for the custom_server

custom_server_deployment_id

String

The unique identifier for the custom_server_deployment

GEThttp://api.metorial.com/custom-servers/:custom_server_id/deployments/:custom_server_deployment_id
curl -X GET "https://api.metorial.com/custom-servers/cus_Rm4Mnheq2bfEPhBhP7SY/deployments/cus_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."