/api/v1/tenants/{tenantId}/servers (POST)

POST

/api/v1/tenants/{tenantId}/servers

curl --request POST \
  --url https://example.com/api/v1/tenants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/servers \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "templateId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "nodeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "image": "example", "variables": "example", "memoryMb": 0, "cpuPercent": 0, "diskMb": 0, "steamAccountId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "updateOnStart": false, "portForwarding": true, "count": 1, "extraPorts": [ { "role": "example", "protocol": "tcp" } ], "startAfterInstall": false, "files": "install", "archiveBackupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Parameters

Path Parameters

tenantId

required

string format: uuid

Request Body^required

Media typeapplication/json

object

name

required

string

templateId

required

string format: uuid

nodeId

required

string format: uuid

image

required

null | string

variables

required

null | object

memoryMb

integer | string format: int32

0 /^-?(?:0|[1-9]\d*)$/

cpuPercent

integer | string format: int32

0 /^-?(?:0|[1-9]\d*)$/

diskMb

integer | string format: int32

0 /^-?(?:0|[1-9]\d*)$/

steamAccountId

null | string format: uuid

updateOnStart

boolean

portForwarding

boolean

default: true

count

integer | string format: int32

default: 1 /^-?(?:0|[1-9]\d*)$/

extraPorts

Array<object> | null

object

role

required

string

protocol

required

default: both

Allowed values: tcp udp both

startAfterInstall

boolean

files

default: install

Allowed values: install installThenArchive archive

archiveBackupId

null | string format: uuid

Responses

200

OK