ZAP-Hosting API v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

ZAP-Hosting API

Base URLs:

Email: Support

Authentication

oAuth2 authentication.
- Flow: clientCredentials
- Token URL = https://api.zap-srv.com/v1/token

txAdmin

Create server

Code samples

# You can also use wget
curl -X PUT http://localhost:3001/txadmin \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT /txadmin

Body parameter

{
  "locationId": 1,
  "slots": 16,
  "ramBoost": 2,
  "cpuOption": "premium",
  "ownIpAddress": false,
  "billingType": "prepaid",
  "billingInterval": "30",
}

Parameters

Name	In	Type	Required	Description
body	body	createTxAdminServer	true	none

Example responses

200 Response

{
  "orderId": 1337,
}

Responses

Status	Meaning	Description	Schema
200	OK	The placed order	Order
400	Bad request	Bad request	None
401	Unauthorized	Bearer token is invalid or missing	None

Get order status

Code samples

# You can also use wget
curl -X PUT http://localhost:3001/txadmin/order/{id}/status \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /txadmin/order/{id}/status

Body parameter

{
  "locationId": 1,
  "slots": 16,
  "ramBoost": 2,
  "cpuOption": "premium",
  "ownIpAddress": false,
  "billingType": "prepaid",
  "billingInterval": "30",
}

Parameters

Name	In	Type	Required	Description
orderId	path	txAdminOrderStatus	true	The order id to check the status on

Example responses

200 Response

{
  "status": "active",
}

Responses

Status	Meaning	Description	Schema
200	OK	The order status (active, pending, cancelled)	Order
400	Bad request	Bad request	None
401	Unauthorized	Bearer token is invalid or missing	None

Get service for order

Code samples

# You can also use wget
curl -X PUT http://localhost:3001/txadmin/order/{id}/service \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /txadmin/order/{id}/service

Body parameter

{
  "orderId": 1337,
}

Parameters

Name	In	Type	Required	Description
orderId	path	txAdminOrderService	true	The service id to the corresponding order

Example responses

200 Response

{
  "serviceId": 1338,
}

Responses

Status	Meaning	Description	Schema
200	OK	The service linked to the order in question	Service
400	Bad request	Bad request	None
401	Unauthorized	Bearer token is invalid or missing	None

Support

Create a new Ticket

Code samples

# You can also use wget
curl -X PUT http://localhost:3001/ticket \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT /ticket

Body parameter

{
  "customerId": null,
  "title": "string",
  "message": "string",
  "service": {
    "type": "gameserver",
    "id": 10320
  }
}

Parameters

Name	In	Type	Required	Description
body	body	PutTicket	true	none

Example responses

200 Response

{
  "id": null,
  "customerId": null,
  "createdAt": null,
  "title": "string",
  "firstMessage": "string",
  "status": "string",
  "service": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The created Ticket	Ticket
401	Unauthorized	Bearer token is invalid or missing	None

Get Ticket Messages

Code samples

# You can also use wget
curl -X GET http://localhost:3001/ticket/{id}/message \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /ticket/{id}/message

Parameters

Name	In	Type	Required	Description
ticketId	path	integer	true	The Ticket ID to retrieve messages from

Example responses

200 Response

{
  "messages": [
    {
      "id": null,
      "adminName": null,
      "createdAt": "string",
      "type": "string",
      "message": "string",
      "data": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	A list of messages	TicketMessageList
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Customer

Get All Customers

Code samples

# You can also use wget
curl -X GET http://localhost:3001/customer \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /customer

Example responses

200 Response

{
  "customers": [
    {
      "id": 65083,
      "firstname": "Marvin",
      "lastname": "Kluck",
      "emailAddress": "m.kluck@zap-hosting.com",
      "user": {
        "name": "derniklas",
        "password": null
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	A list of Customers associated with the current user.	CustomerList
401	Unauthorized	Bearer token is invalid or missing	None

Create a Customer

Code samples

# You can also use wget
curl -X PUT http://localhost:3001/customer \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT /customer

Body parameter

{
  "firstname": "string",
  "lastname": "string",
  "emailAddress": "string",
  "user": {
    "name": "string",
    "password": "string"
  }
}

Parameters

Name	In	Type	Required	Description
body	body	PutCustomer	true	none

Example responses

200 Response

{
  "id": 65083,
  "firstname": "Marvin",
  "lastname": "Kluck",
  "emailAddress": "m.kluck@zap-hosting.com",
  "user": {
    "name": "derniklas",
    "password": null
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Customer created	Customer
400	Bad Request	Bad Request	#/components/responses/BadRequest
401	Unauthorized	Bearer token is invalid or missing	None

Get a Customer

Code samples

# You can also use wget
curl -X GET http://localhost:3001/customer/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /customer/{id}

Example responses

200 Response

{
  "id": 65083,
  "firstname": "Marvin",
  "lastname": "Kluck",
  "emailAddress": "m.kluck@zap-hosting.com",
  "user": {
    "name": "derniklas",
    "password": null
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	A Customer	Customer
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Get Customer Tickets

Code samples

# You can also use wget
curl -X GET http://localhost:3001/customer/{id}/ticket \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /customer/{id}/ticket

Parameters

Name	In	Type	Required	Description
id	path	integer	true	The ID of the Customer
page	query	integer	false	Page number
perPage	query	integer	false	Entries to retrieve per page

Example responses

200 Response

{
  "tickets": [
    {
      "id": null,
      "customerId": null,
      "createdAt": null,
      "title": "string",
      "firstMessage": "string",
      "status": "string",
      "service": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	A list of Tickets for the Customer	TicketList
401	Unauthorized	Bearer token is invalid or missing	None

Get Customer Packages

Code samples

# You can also use wget
curl -X GET http://localhost:3001/customer/{id}/package \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /customer/{id}/package

Parameters

Name	In	Type	Required	Description
id	path	integer	true	The ID of the Customer
page	query	integer	false	Page number
perPage	query	integer	false	Entries to retrieve per page

Example responses

200 Response

{
  "packages": [
    {
      "id": null,
      "customerId": null,
      "orderId": null,
      "contractId": null,
      "prepaidId": null,
      "createdAt": null,
      "status": "string",
      "runtime": null,
      "services": [
        {
          "id": null,
          "type": null
        }
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	A list of Packages	PackageList
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Get Customer Invoices

Code samples

# You can also use wget
curl -X GET http://localhost:3001/customer/{id}/invoice \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /customer/{id}/invoice

Parameters

Name	In	Type	Required	Description
id	path	integer	true	The ID of the Customer
unpaid	query	integer	false	Show unpaid Invoices only
paid	query	integer	false	Show paid Invoices only
page	query	integer	false	Page number
perPage	query	integer	false	Entries to retrieve per page

Enumerated Values

Parameter	Value
unpaid	0
unpaid	1
paid	0
paid	1

Example responses

200 Response

{
  "invoices": [
    {
      "id": null,
      "invoiceNo": null,
      "createdAt": "string",
      "status": null,
      "total": null,
      "payableBy": null
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	A list of Invoices	InvoiceList
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Service

Get a Service

Code samples

# You can also use wget
curl -X GET http://localhost:3001/service/{type}/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /service/{type}/{id}

Parameters

Name	In	Type	Required	Description
type	path	ServiceType	true	The Type of Service
id	path	integer	true	The ID of the Service

Enumerated Values

Parameter	Value
type	gameserver

Example responses

200 Response

{
  "id": null,
  "customerId": null,
  "games": [
    {
      "id": null,
      "name": "string",
      "isActive": null
    }
  ],
  "onlineStatus": null
}

Responses

Status	Meaning	Description	Schema
200	OK	A list of Invoices	Inline
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	int	true	none	none
» customerId	int	true	none	none
» games	[object]	true	none	none
»» id	int	true	none	none
»» name	string	true	none	none
»» isActive	bool	true	none	none
» onlineStatus	bool	true	none	none

Get Service Config

Code samples

# You can also use wget
curl -X GET http://localhost:3001/service/{type}/{id}/config \
  -H 'Authorization: Bearer {access-token}'

GET /service/{type}/{id}/config

Parameters

Name	In	Type	Required	Description
type	path	ServiceType	true	The Type of Service
id	path	integer	true	The ID of the Service

Enumerated Values

Parameter	Value
type	gameserver

Responses

Status	Meaning	Description	Schema
200	OK	Service Config	None

Update Service Config

Code samples

# You can also use wget
curl -X POST http://localhost:3001/service/{type}/{id}/config \
  -H 'Authorization: Bearer {access-token}'

POST /service/{type}/{id}/config

Parameters

Name	In	Type	Required	Description
type	path	ServiceType	true	The Type of Service
id	path	integer	true	The ID of the Service

Enumerated Values

Parameter	Value
type	gameserver

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Get Gameserver Databases

Code samples

# You can also use wget
curl -X GET http://localhost:3001/service/gameserver/{id}/database \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /service/gameserver/{id}/database

Parameters

Name	In	Type	Required	Description
id	path	integer	true	The ID of the Service

Example responses

200 Response

{
  "databases": [
    {
      "id": 1015730,
      "serviceId": 491851,
      "hostname": "database-host",
      "databaseName": "zap65083-1",
      "user": "zap65083-1",
      "password": "WnRwWqoWHI14Vros"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	List of Databases associated with the Gameserver	DatabaseList
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Add Gameserver Database

Code samples

# You can also use wget
curl -X PUT http://localhost:3001/service/gameserver/{id}/database \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT /service/gameserver/{id}/database

Parameters

Name	In	Type	Required	Description
id	path	integer	true	The ID of the Service

Example responses

200 Response

{
  "id": 1015730,
  "serviceId": 491851,
  "hostname": "database-host",
  "databaseName": "zap65083-1",
  "user": "zap65083-1",
  "password": "WnRwWqoWHI14Vros"
}

Responses

Status	Meaning	Description	Schema
200	OK	The added Database	Database
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Remove Gameserver Database

Code samples

# You can also use wget
curl -X DELETE http://localhost:3001/service/gameserver/{id}/database/{databaseId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

DELETE /service/gameserver/{id}/database/{databaseId}

Parameters

Name	In	Type	Required	Description
id	path	integer	true	The ID of the Service
databaseId	path	integer	true	The ID of the Database to be deleted

Example responses

200 Response

{
  "id": 1015730,
  "serviceId": 491851,
  "hostname": "database-host",
  "databaseName": "zap65083-1",
  "user": "zap65083-1",
  "password": "WnRwWqoWHI14Vros"
}

Responses

Status	Meaning	Description	Schema
200	OK	The deleted Database	Database
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Install Gameserver Plugin

Code samples

# You can also use wget
curl -X DELETE http://localhost:3001/service/gameserver/{id}/plugin/{pluginId}/install \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

DELETE /service/gameserver/{id}/plugin/{pluginId}/install

Parameters

Name	In	Type	Required	Description
id	path	integer	true	The ID of the Gameserver
pluginId	path	integer	true	The ID of the currently installed Plugin to be removed

Example responses

200 Response

{
  "status": null,
  "error": {}
}

Responses

Status	Meaning	Description	Schema
200	OK	Installation Result	ServiceActionResult
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Remove Gameserver Plugin

Code samples

# You can also use wget
curl -X DELETE http://localhost:3001/service/gameserver/{id}/plugin/{pluginId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

DELETE /service/gameserver/{id}/plugin/{pluginId}

Parameters

Name	In	Type	Required	Description
id	path	integer	true	The ID of the Gameserver
pluginId	path	integer	true	The ID of the currently installed Plugin to be removed

Example responses

200 Response

{
  "status": null,
  "error": {}
}

Responses

Status	Meaning	Description	Schema
200	OK	Removal Result	ServiceActionResult
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Get Backup Schedule

Code samples

# You can also use wget
curl -X GET http://localhost:3001/service/gameserver/{id}/backup \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /service/gameserver/{id}/backup

Parameters

Name	In	Type	Required	Description
type	path	ServiceType	true	The Type of Service
id	path	integer	true	The ID of the Service

Enumerated Values

Parameter	Value
type	gameserver

Example responses

200 Response

{
  "isEnabled": false,
  "rota": "weekly",
  "dayOfWeek": 1,
  "startTime": "05:30",
  "stopServer": false,
  "deleteBackupsAfterDays": 0,
  "createDatabaseBackup": false,
  "freeUpOldBackups": false,
  "freeUpOldDatabaseBackups": false
}

Responses

Status	Meaning	Description	Schema
200	OK	Backup Plan for the Service	BackupPlan
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Update Backup Schedule

Code samples

# You can also use wget
curl -X POST http://localhost:3001/service/gameserver/{id}/backup \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /service/gameserver/{id}/backup

Body parameter

{
  "isEnabled": null,
  "rota": "weekly",
  "dayOfWeek": null,
  "startTime": "string",
  "stopServer": null,
  "deleteBackupsAfterDays": null,
  "createDatabaseBackup": null,
  "freeUpOldBackups": null,
  "freeUpOldDatabaseBackups": null
}

Parameters

Name	In	Type	Required	Description
type	path	ServiceType	true	The Type of Service
id	path	integer	true	The ID of the Service
body	body	PostBackupPlan	true	none

Enumerated Values

Parameter	Value
type	gameserver

Example responses

200 Response

{
  "isEnabled": false,
  "rota": "weekly",
  "dayOfWeek": 1,
  "startTime": "05:30",
  "stopServer": false,
  "deleteBackupsAfterDays": 0,
  "createDatabaseBackup": false,
  "freeUpOldBackups": false,
  "freeUpOldDatabaseBackups": false
}

Responses

Status	Meaning	Description	Schema
200	OK	Updated Backup Plan for the Gameserver	BackupPlan
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Get DDoS Status

Code samples

# You can also use wget
curl -X GET http://localhost:3001/service/{type}/{id}/ddos \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /service/{type}/{id}/ddos

Parameters

Name	In	Type	Required	Description
type	path	ServiceType	true	The Type of Service
id	path	integer	true	The ID of the Service

Enumerated Values

Parameter	Value
type	gameserver

Example responses

200 Response

{
  "layer4Mode": "string",
  "ongoingAttack": {
    "layer4Mode": null,
    "manager": "string",
    "startedAt": "string",
    "duration": "string",
    "description": "string",
    "timezone": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Updated Backup Plan for the Gameserver	DdosManagerStatus
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Get Service Logs

Code samples

# You can also use wget
curl -X GET http://localhost:3001/service/{type}/{id}/log \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /service/{type}/{id}/log

Parameters

Name	In	Type	Required	Description
type	path	ServiceType	true	The Type of Service
id	path	integer	true	The ID of the Service

Enumerated Values

Parameter	Value
type	gameserver

Example responses

200 Response

{
  "logs": [
    {
      "id": null,
      "action": "string",
      "userId": null,
      "createdAt": "string",
      "metadata": "string",
      "errored": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	A list of Log Entries for the Service	LogEntryList
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Get Service Logfiles

Code samples

# You can also use wget
curl -X GET http://localhost:3001/service/{type}/{id}/logfile \
  -H 'Authorization: Bearer {access-token}'

GET /service/{type}/{id}/logfile

Parameters

Name	In	Type	Required	Description
type	path	ServiceType	true	The Type of Service
id	path	integer	true	The ID of the Service

Enumerated Values

Parameter	Value
type	gameserver

Responses

Status	Meaning	Description	Schema
200	OK	Service Logfiles	None

Read Service Logfile

Code samples

# You can also use wget
curl -X GET http://localhost:3001/service/{type}/{id}/logfile/{name} \
  -H 'Authorization: Bearer {access-token}'

GET /service/{type}/{id}/logfile/{name}

Parameters

Name	In	Type	Required	Description
type	path	ServiceType	true	The Type of Service
id	path	integer	true	The ID of the Service

Enumerated Values

Parameter	Value
type	gameserver

Responses

Status	Meaning	Description	Schema
200	OK	Logfile Contents	None

Get Service Plugins

Code samples

# You can also use wget
curl -X GET http://localhost:3001/service/gameserver/{id}/plugin \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /service/gameserver/{id}/plugin

Parameters

Name	In	Type	Required	Description
type	path	ServiceType	true	The Type of Service
id	path	integer	true	The ID of the Service

Enumerated Values

Parameter	Value
type	gameserver

Example responses

200 Response

{
  "plugins": [
    {
      "id": null,
      "name": null,
      "isInstalled": null,
      "isAutoupdateEnabled": null
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	A list of installable or installed Plugins	PluginList
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Reset Service

Code samples

# You can also use wget
curl -X GET http://localhost:3001/service/{type}/{id}/reset \
  -H 'Authorization: Bearer {access-token}'

GET /service/{type}/{id}/reset

Parameters

Name	In	Type	Required	Description
type	path	ServiceType	true	The Type of Service
id	path	integer	true	The ID of the Service

Enumerated Values

Parameter	Value
type	gameserver

Responses

Status	Meaning	Description	Schema
200	OK	Reset successful	None
405	Method Not Allowed	Service not supported	None

Start a Service

Code samples

# You can also use wget
curl -X POST http://localhost:3001/service/{type}/{id}/start \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /service/{type}/{id}/start

Parameters

Name	In	Type	Required	Description
type	path	ServiceType	true	The Type of Service
id	path	integer	true	The ID of the Service

Enumerated Values

Parameter	Value
type	gameserver

Example responses

200 Response

{
  "status": null,
  "error": {}
}

Responses

Status	Meaning	Description	Schema
200	OK	Result of Server Start	ServiceActionResult
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Stop a Service

Code samples

# You can also use wget
curl -X POST http://localhost:3001/service/{type}/{id}/stop \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /service/{type}/{id}/stop

Parameters

Name	In	Type	Required	Description
type	path	ServiceType	true	The Type of Service
id	path	integer	true	The ID of the Service

Enumerated Values

Parameter	Value
type	gameserver

Example responses

200 Response

{
  "status": null,
  "error": {}
}

Responses

Status	Meaning	Description	Schema
200	OK	Result of Server Stop	ServiceActionResult
401	Unauthorized	Bearer token is invalid or missing	None

Restart a Service

Code samples

# You can also use wget
curl -X POST http://localhost:3001/service/{type}/{id}/restart \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /service/{type}/{id}/restart

Parameters

Name	In	Type	Required	Description
type	path	ServiceType	true	The Type of Service
id	path	integer	true	The ID of the Service

Enumerated Values

Parameter	Value
type	gameserver

Example responses

200 Response

{
  "status": null,
  "error": {}
}

Responses

Status	Meaning	Description	Schema
200	OK	Result of Server Restart	ServiceActionResult
401	Unauthorized	Bearer token is invalid or missing	None

Shop

Get Product List

Code samples

# You can also use wget
curl -X GET http://localhost:3001/shop/product \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /shop/product

Example responses

200 Response

{
  "products": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "icon_url": "string",
      "accounting_types": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	A List of Products	ProductList

Get Product Summary

Code samples

# You can also use wget
curl -X GET http://localhost:3001/shop/product/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /shop/product/{id}

Example responses

200 Response

{
  "id": 36,
  "name": "product-cloudgameserver",
  "description": "cloudgameserver-desc",
  "icon_url": null,
  "accounting_types": "BOTH",
  "fields": [
    {
      "id": 4,
      "name": "ram-boost",
      "type": "slider",
      "options": [
        {
          "id": 7,
          "name": "ram-boost-1",
          "value": "1"
        },
        {
          "id": 8,
          "name": "ram-boost-2",
          "value": "2"
        },
        {
          "id": 9,
          "name": "ram-boost-3",
          "value": "3"
        },
        {
          "id": 10,
          "name": "ram-boost-4",
          "value": "4"
        },
        {
          "id": 467,
          "name": "ram-boost-0",
          "value": "0"
        }
      ]
    },
    {
      "id": 6,
      "name": "global-runtime",
      "type": "slider",
      "options": [
        {
          "id": 11,
          "name": "7days-runtime",
          "value": "7"
        },
        {
          "id": 12,
          "name": "30days-runtime",
          "value": "30"
        }
      ]
    },
    {
      "id": 147,
      "name": "own-ip-gameserver",
      "type": "selectHighlightBox",
      "options": [
        {
          "id": 438,
          "name": "own-ip-gameserver-no",
          "value": "0"
        },
        {
          "id": 439,
          "name": "own-ip-gameserver-yes",
          "value": "1"
        }
      ]
    },
    {
      "id": 164,
      "name": "package-billing-type",
      "type": "accounting",
      "options": {}
    },
    {
      "id": 190,
      "name": "lws-modspace-field",
      "type": "slider",
      "options": [
        {
          "id": 529,
          "name": "5gb",
          "value": "5"
        },
        {
          "id": 530,
          "name": "10gb",
          "value": "10"
        }
      ]
    },
    {
      "id": 203,
      "name": "premium-cpu-gameserver",
      "type": "selectHighlightBox",
      "options": [
        {
          "id": 588,
          "name": "premium-cpu-no",
          "value": "0"
        },
        {
          "id": 590,
          "name": "premium-cpu-yes",
          "value": "1"
        },
        {
          "id": 729,
          "name": "premium-cpu-default-plus",
          "value": "2"
        }
      ]
    },
    {
      "id": 208,
      "name": "service-site-name",
      "type": "siteSelection",
      "options": {}
    },
    {
      "id": 250,
      "name": "gameserver-can-view-ddos-manager-without-own-ip",
      "type": "selectHighlightBox",
      "options": [
        {
          "id": 636,
          "name": "gameserver-can-view-ddos-manager-no",
          "value": "0"
        },
        {
          "id": 637,
          "name": "gameserver-can-view-ddos-manager-yes",
          "value": "1"
        }
      ]
    },
    {
      "id": 255,
      "name": "disk-storage-gameserver",
      "type": "slider",
      "options": [
        {
          "id": 646,
          "name": "0-percent-storage-quota",
          "value": "0"
        },
        {
          "id": 647,
          "name": "10-percent-storage-quota",
          "value": "10"
        }
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	A List of Product Fields and Options	ProductSummary

Place an Order

Code samples

# You can also use wget
curl -X PUT http://localhost:3001/shop/order \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT /shop/order

Body parameter

{
  "customerId": 65083,
  "productId": 36,
  "accounting": "contract",
  "paymentMethod": "credit_card",
  "slots": 4,
  "gameId": 3,
  "fieldList": [
    {
      "fieldId": 208,
      "option": 2
    },
    {
      "fieldId": 4,
      "option": 467
    },
    {
      "fieldId": 203,
      "option": 588
    },
    {
      "fieldId": 147,
      "option": 438
    },
    {
      "fieldId": 250,
      "option": 636
    },
    {
      "fieldId": 6,
      "option": 12
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	PutOrder	true	none

Example responses

200 Response

{
  "id": "string",
  "state": "string",
  "placedDate": "string",
  "priceGross": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The placed Order	Order
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Calculate Order Price

Code samples

# You can also use wget
curl -X POST http://localhost:3001/shop/order/compute \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /shop/order/compute

Body parameter

{
  "customerId": 65083,
  "productId": 36,
  "accounting": "contract",
  "paymentMethod": "credit_card",
  "slots": 4,
  "gameId": 3,
  "fieldList": [
    {
      "fieldId": 208,
      "option": 2
    },
    {
      "fieldId": 4,
      "option": 467
    },
    {
      "fieldId": 203,
      "option": 588
    },
    {
      "fieldId": 147,
      "option": 438
    },
    {
      "fieldId": 250,
      "option": 636
    },
    {
      "fieldId": 6,
      "option": 12
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	PutOrder	true	none

Example responses

200 Response

{
  "net": null,
  "gross": null,
  "tax": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Calculated Price for the Order	OrderPrice
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Pay for an Order

Code samples

# You can also use wget
curl -X POST http://localhost:3001/shop/order/{id}/pay \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /shop/order/{id}/pay

Example responses

200 Response

{
  "paymentLink": "string",
  "validUntil": null
}

Responses

Status	Meaning	Description	Schema
200	OK	A link to the Payment Gateway. The Order will be processed after succesful payment.	PaymentLink
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Packages

Get a Package

Code samples

# You can also use wget
curl -X GET http://localhost:3001/package/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /package/{id}

Example responses

200 Response

{
  "id": null,
  "customerId": null,
  "orderId": null,
  "contractId": null,
  "prepaidId": null,
  "createdAt": null,
  "status": "string",
  "runtime": null,
  "services": [
    {
      "id": null,
      "type": null
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	A Product Package	Package
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Update a Package

Code samples

# You can also use wget
curl -X POST http://localhost:3001/package/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /package/{id}

Body parameter

{
  "slots": "string",
  "fieldList": [
    {
      "fieldId": "string",
      "option": "string"
    }
  ],
  "paymentMethod": "credit_card"
}

Parameters

Name	In	Type	Required	Description
body	body	PostPackage	true	none

Example responses

200 Response

{
  "paymentLink": "string",
  "validUntil": null
}

Responses

Status	Meaning	Description	Schema
200	OK	A link to the Payment Gateway. The Update will be processed after succesful payment.	PaymentLink
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Terminate a Package

Code samples

# You can also use wget
curl -X DELETE http://localhost:3001/package/{id} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

DELETE /package/{id}

Example responses

200 Response

{
  "removalDate": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Package terminated. Contract packages will yield a removal date, Prepaid packages are deleted IMMEDIATELY.	Inline

Response Schema

Calculate Update Price

Code samples

# You can also use wget
curl -X POST http://localhost:3001/package/{id}/compute \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /package/{id}/compute

Body parameter

{
  "slots": "string",
  "fieldList": [
    {
      "fieldId": "string",
      "option": "string"
    }
  ],
  "paymentMethod": "credit_card"
}

Parameters

Name	In	Type	Required	Description
body	body	PostPackage	true	none

Example responses

200 Response

{
  "gross": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Package Update Price	PackageUpdatePrice
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Extend a Prepaid Package

Code samples

# You can also use wget
curl -X POST http://localhost:3001/package/{id}/extend \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /package/{id}/extend

Body parameter

{
  "optionId": "string",
  "paymentMethod": "credit_card"
}

Parameters

Name	In	Type	Required	Description
body	body	PostPackageExtend	true	none

Example responses

200 Response

{
  "paymentLink": "string",
  "validUntil": null
}

Responses

Status	Meaning	Description	Schema
200	OK	A link to the Payment Gateway. The Extension will be processed after succesful payment.	PaymentLink
401	Unauthorized	Bearer token is invalid or missing	None
404	Not Found	Participating entity not found	None

Schemas

EmptyBody

{}

Properties

None

ServiceType

"gameserver"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	gameserver

AssignedService

{
  "type": "gameserver",
  "id": 10320
}

Properties

Name	Type	Required	Restrictions	Description
type	string	true	none	none
id	int	true	none	none

BackupPlan

{
  "isEnabled": false,
  "rota": "weekly",
  "dayOfWeek": 1,
  "startTime": "05:30",
  "stopServer": false,
  "deleteBackupsAfterDays": 0,
  "createDatabaseBackup": false,
  "freeUpOldBackups": false,
  "freeUpOldDatabaseBackups": false
}

Properties

Name	Type	Required	Restrictions	Description
isEnabled	string	true	none	none
rota	string	true	none	none
dayOfWeek	string	true	none	none
startTime	string	true	none	none
stopServer	string	true	none	none
deleteBackupsAfterDays	string	true	none	none
createDatabaseBackup	string	true	none	none
freeUpOldBackups	string	true	none	none
freeUpOldDatabaseBackups	string	true	none	none

CreateTxAdminServer

{
  "locationId": 1,
  "slots": 16,
  "ramBoost": 2,
  "cpuOption": "premium",
  "ownIpAddress": false,
  "billingType": "prepaid",
  "billingInterval": 30,
}

Properties

Name	Type	Required	Restrictions	Description
locationId	int	true	1-9	none
slots	int	true	none	none
ramBoost	int	false	none	none
cpuOption	string	false	none	none
ownIpAddress	boolean	false	none	none
billingType	string	true	none	none
billingInterval	int	true	none	none

Customer

{
  "id": 65083,
  "firstname": "Marvin",
  "lastname": "Kluck",
  "emailAddress": "m.kluck@zap-hosting.com",
  "user": {
    "name": "derniklas",
    "password": null
  }
}

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	none
firstname	string	true	none	none
lastname	string	true	none	none
emailAddress	string	true	none	none
user	object	true	none	none
» name	string	true	none	none
» password	string	true	none	none

CustomerList

{
  "customers": [
    {
      "id": 65083,
      "firstname": "Marvin",
      "lastname": "Kluck",
      "emailAddress": "m.kluck@zap-hosting.com",
      "user": {
        "name": "derniklas",
        "password": null
      }
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
customers	[object]	true	none	none
» id	string	true	none	none
» firstname	string	true	none	none
» lastname	string	true	none	none
» emailAddress	string	true	none	none
» user	Customer/properties/user	true	none	none

Database

{
  "id": 1015730,
  "serviceId": 491851,
  "hostname": "database-host",
  "databaseName": "zap65083-1",
  "user": "zap65083-1",
  "password": "WnRwWqoWHI14Vros"
}

Properties

Name	Type	Required	Restrictions	Description
id	int	true	none	none
serviceId	int	true	none	none
hostname	string	true	none	none
databaseName	string	true	none	none
user	string	true	none	none
password	string	true	none	none

DatabaseList

{
  "databases": [
    {
      "id": 1015730,
      "serviceId": 491851,
      "hostname": "database-host",
      "databaseName": "zap65083-1",
      "user": "zap65083-1",
      "password": "WnRwWqoWHI14Vros"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
databases	[object]	true	none	none
» id	int	true	none	none
» serviceId	int	true	none	none
» hostname	string	true	none	none
» databaseName	string	true	none	none
» user	string	true	none	none
» password	string	true	none	none

DdosIncident

{
  "layer4Mode": null,
  "manager": "string",
  "startedAt": "string",
  "duration": "string",
  "description": "string",
  "timezone": "string"
}

Properties

Name	Type	Required	Restrictions	Description
layer4Mode	int	true	none	none
manager	string	true	none	none
startedAt	string	true	none	none
duration	string	true	none	none
description	string	true	none	none
timezone	string	true	none	none

DdosManagerStatus

{
  "layer4Mode": "string",
  "ongoingAttack": {
    "layer4Mode": null,
    "manager": "string",
    "startedAt": "string",
    "duration": "string",
    "description": "string",
    "timezone": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
layer4Mode	string	true	none	none
ongoingAttack	object	true	none	none
» layer4Mode	int	true	none	none
» manager	string	true	none	none
» startedAt	string	true	none	none
» duration	string	true	none	none
» description	string	true	none	none
» timezone	string	true	none	none

DeleteContract

{
  "removalDate": "string"
}

Properties

Name	Type	Required	Restrictions	Description
removalDate	string	true	none	none

Field

{
  "id": "string",
  "name": "string",
  "type": "string",
  "options": [
    {
      "id": "string",
      "name": "string",
      "value": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	none
name	string	true	none	none
type	string	true	none	none
options	[object]	true	none	none
» id	string	true	none	none
» name	string	true	none	none
» value	string	true	none	none

FiveMUpvote

{
  "id": "string",
  "username": "string",
  "userId": "string",
  "avatarUri": "string",
  "upvoteCount": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	none
username	string	true	none	none
userId	string	true	none	none
avatarUri	string	true	none	none
upvoteCount	string	true	none	none

Gameserver

{
  "id": null,
  "customerId": null,
  "games": [
    {
      "id": null,
      "name": "string",
      "isActive": null
    }
  ],
  "onlineStatus": null
}

Properties

Name	Type	Required	Restrictions	Description
id	int	true	none	none
customerId	int	true	none	none
games	[object]	true	none	none
» id	int	true	none	none
» name	string	true	none	none
» isActive	bool	true	none	none
onlineStatus	bool	true	none	none

GameserverConfigContent

{
  "content": "string"
}

Properties

Name	Type	Required	Restrictions	Description
content	string	true	none	none

GameserverGame

{
  "id": null,
  "name": "string",
  "isActive": null
}

Properties

Name	Type	Required	Restrictions	Description
id	int	true	none	none
name	string	true	none	none
isActive	bool	true	none	none

Invoice

{
  "id": null,
  "invoiceNo": null,
  "createdAt": "string",
  "status": null,
  "total": null,
  "payableBy": null
}

Properties

Name	Type	Required	Restrictions	Description
id	int	true	none	none
invoiceNo	int	true	none	none
createdAt	string	true	none	none
status	int	true	none	none
total	float	true	none	none
payableBy	int	true	none	none

InvoiceList

{
  "invoices": [
    {
      "id": null,
      "invoiceNo": null,
      "createdAt": "string",
      "status": null,
      "total": null,
      "payableBy": null
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
invoices	[object]	true	none	none
» id	int	true	none	none
» invoiceNo	int	true	none	none
» createdAt	string	true	none	none
» status	int	true	none	none
» total	float	true	none	none
» payableBy	int	true	none	none

LogEntry

{
  "id": null,
  "action": "string",
  "userId": null,
  "createdAt": "string",
  "metadata": "string",
  "errored": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	int	true	none	none
action	string	true	none	none
userId	int	true	none	none
createdAt	string	true	none	none
metadata	string	true	none	none
errored	string	true	none	none

LogEntryList

{
  "logs": [
    {
      "id": null,
      "action": "string",
      "userId": null,
      "createdAt": "string",
      "metadata": "string",
      "errored": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
logs	[object]	true	none	none
» id	int	true	none	none
» action	string	true	none	none
» userId	int	true	none	none
» createdAt	string	true	none	none
» metadata	string	true	none	none
» errored	string	true	none	none

Logfile

{}

Properties

None

LogfileList

{
  "logs": [
    {}
  ]
}

Properties

Name	Type	Required	Restrictions	Description
logs	[object]	true	none	none

Option

{
  "id": "string",
  "name": "string",
  "value": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	none
name	string	true	none	none
value	string	true	none	none

Order

{
  "id": "string",
  "state": "string",
  "placedDate": "string",
  "priceGross": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	none
state	string	true	none	none
placedDate	string	true	none	none
priceGross	string	true	none	none

OrderPrice

{
  "net": null,
  "gross": null,
  "tax": null
}

Properties

Name	Type	Required	Restrictions	Description
net	int	true	none	none
gross	int	true	none	none
tax	int	true	none	none

Package

{
  "id": null,
  "customerId": null,
  "orderId": null,
  "contractId": null,
  "prepaidId": null,
  "createdAt": null,
  "status": "string",
  "runtime": null,
  "services": [
    {
      "id": null,
      "type": null
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	int	true	none	none
customerId	int	true	none	none
orderId	int	true	none	none
contractId	int	true	none	none
prepaidId	int	true	none	none
createdAt	int	true	none	none
status	string	true	none	none
runtime	float	true	none	none
services	[object]	true	none	none
» id	int	true	none	none
» type	int	true	none	none

PackageList

{
  "packages": [
    {
      "id": null,
      "customerId": null,
      "orderId": null,
      "contractId": null,
      "prepaidId": null,
      "createdAt": null,
      "status": "string",
      "runtime": null,
      "services": [
        {
          "id": null,
          "type": null
        }
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
packages	[object]	true	none	none
» id	int	true	none	none
» customerId	int	true	none	none
» orderId	int	true	none	none
» contractId	int	true	none	none
» prepaidId	int	true	none	none
» createdAt	int	true	none	none
» status	string	true	none	none
» runtime	float	true	none	none
» services	[Package/properties/services/items]	true	none	none

PackageUpdatePrice

{
  "gross": null
}

Properties

Name	Type	Required	Restrictions	Description
gross	int	true	none	none

PaymentLink

{
  "paymentLink": "string",
  "validUntil": null
}

Properties

Name	Type	Required	Restrictions	Description
paymentLink	string	true	none	none
validUntil	int	true	none	none

Plugin

{
  "id": null,
  "name": null,
  "isInstalled": null,
  "isAutoupdateEnabled": null
}

Properties

Name	Type	Required	Restrictions	Description
id	int	true	none	none
name	int	true	none	none
isInstalled	int	true	none	none
isAutoupdateEnabled	int	true	none	none

PluginList

{
  "plugins": [
    {
      "id": null,
      "name": null,
      "isInstalled": null,
      "isAutoupdateEnabled": null
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
plugins	[object]	true	none	none
» id	int	true	none	none
» name	int	true	none	none
» isInstalled	int	true	none	none
» isAutoupdateEnabled	int	true	none	none

Position

{
  "id": null,
  "name": null,
  "fieldId": null,
  "optionId": null,
  "value": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	int	true	none	none
name	int	true	none	none
fieldId	int	true	none	none
optionId	int	true	none	none
value	string	true	none	none

PositionList

{
  "positions": [
    {
      "id": null,
      "name": null,
      "fieldId": null,
      "optionId": null,
      "value": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
positions	[object]	true	none	none
» id	int	true	none	none
» name	int	true	none	none
» fieldId	int	true	none	none
» optionId	int	true	none	none
» value	string	true	none	none

PostBackupPlan

{
  "isEnabled": null,
  "rota": "weekly",
  "dayOfWeek": null,
  "startTime": "string",
  "stopServer": null,
  "deleteBackupsAfterDays": null,
  "createDatabaseBackup": null,
  "freeUpOldBackups": null,
  "freeUpOldDatabaseBackups": null
}

Properties

Name	Type	Required	Restrictions	Description
isEnabled	bool	true	none	none
rota	string	true	none	none
dayOfWeek	int	true	none	none
startTime	string	true	none	none
stopServer	bool	true	none	none
deleteBackupsAfterDays	bool	true	none	none
createDatabaseBackup	bool	true	none	none
freeUpOldBackups	bool	true	none	none
freeUpOldDatabaseBackups	bool	true	none	none

Enumerated Values

Property	Value
rota	weekly
rota	daily

PostConfig

{
  "content": "string"
}

Properties

Name	Type	Required	Restrictions	Description
content	string	true	none	none

PostPackage

{
  "slots": "string",
  "fieldList": [
    {
      "fieldId": "string",
      "option": "string"
    }
  ],
  "paymentMethod": "credit_card"
}

Properties

Name	Type	Required	Restrictions	Description
slots	string	true	none	none
fieldList	[object]	true	none	none
» fieldId	string	true	none	none
» option	string	true	none	none
paymentMethod	string	true	none	none

Enumerated Values

Property	Value
paymentMethod	credit_card
paymentMethod	paypal
paymentMethod	bitcoin

PostPackageExtend

{
  "optionId": "string",
  "paymentMethod": "credit_card"
}

Properties

Name	Type	Required	Restrictions	Description
optionId	string	true	none	none
paymentMethod	string	true	none	none

Enumerated Values

Property	Value
paymentMethod	credit_card
paymentMethod	paypal
paymentMethod	bitcoin

PostPaymentOptions

{
  "useDefaultCard": null,
  "paymentMethod": "credit_card"
}

Properties

Name	Type	Required	Restrictions	Description
useDefaultCard	bool	true	none	none
paymentMethod	string	true	none	none

Enumerated Values

Property	Value
paymentMethod	credit_card
paymentMethod	paypal
paymentMethod	bitcoin

Product

{
  "id": "string",
  "name": "string",
  "description": "string",
  "icon_url": "string",
  "accounting_types": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	none
name	string	true	none	none
description	string	true	none	none
icon_url	string	true	none	none
accounting_types	string	true	none	none

ProductList

{
  "products": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "icon_url": "string",
      "accounting_types": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
products	[object]	true	none	none
» id	string	true	none	none
» name	string	true	none	none
» description	string	true	none	none
» icon_url	string	true	none	none
» accounting_types	string	true	none	none

ProductSummary

{
  "id": 36,
  "name": "product-cloudgameserver",
  "description": "cloudgameserver-desc",
  "icon_url": null,
  "accounting_types": "BOTH",
  "fields": [
    {
      "id": 4,
      "name": "ram-boost",
      "type": "slider",
      "options": [
        {
          "id": 7,
          "name": "ram-boost-1",
          "value": "1"
        },
        {
          "id": 8,
          "name": "ram-boost-2",
          "value": "2"
        },
        {
          "id": 9,
          "name": "ram-boost-3",
          "value": "3"
        },
        {
          "id": 10,
          "name": "ram-boost-4",
          "value": "4"
        },
        {
          "id": 467,
          "name": "ram-boost-0",
          "value": "0"
        }
      ]
    },
    {
      "id": 6,
      "name": "global-runtime",
      "type": "slider",
      "options": [
        {
          "id": 11,
          "name": "7days-runtime",
          "value": "7"
        },
        {
          "id": 12,
          "name": "30days-runtime",
          "value": "30"
        }
      ]
    },
    {
      "id": 147,
      "name": "own-ip-gameserver",
      "type": "selectHighlightBox",
      "options": [
        {
          "id": 438,
          "name": "own-ip-gameserver-no",
          "value": "0"
        },
        {
          "id": 439,
          "name": "own-ip-gameserver-yes",
          "value": "1"
        }
      ]
    },
    {
      "id": 164,
      "name": "package-billing-type",
      "type": "accounting",
      "options": {}
    },
    {
      "id": 190,
      "name": "lws-modspace-field",
      "type": "slider",
      "options": [
        {
          "id": 529,
          "name": "5gb",
          "value": "5"
        },
        {
          "id": 530,
          "name": "10gb",
          "value": "10"
        }
      ]
    },
    {
      "id": 203,
      "name": "premium-cpu-gameserver",
      "type": "selectHighlightBox",
      "options": [
        {
          "id": 588,
          "name": "premium-cpu-no",
          "value": "0"
        },
        {
          "id": 590,
          "name": "premium-cpu-yes",
          "value": "1"
        },
        {
          "id": 729,
          "name": "premium-cpu-default-plus",
          "value": "2"
        }
      ]
    },
    {
      "id": 208,
      "name": "service-site-name",
      "type": "siteSelection",
      "options": {}
    },
    {
      "id": 250,
      "name": "gameserver-can-view-ddos-manager-without-own-ip",
      "type": "selectHighlightBox",
      "options": [
        {
          "id": 636,
          "name": "gameserver-can-view-ddos-manager-no",
          "value": "0"
        },
        {
          "id": 637,
          "name": "gameserver-can-view-ddos-manager-yes",
          "value": "1"
        }
      ]
    },
    {
      "id": 255,
      "name": "disk-storage-gameserver",
      "type": "slider",
      "options": [
        {
          "id": 646,
          "name": "0-percent-storage-quota",
          "value": "0"
        },
        {
          "id": 647,
          "name": "10-percent-storage-quota",
          "value": "10"
        }
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	none
name	string	true	none	none
description	string	true	none	none
icon_url	string	true	none	none
accounting_types	string	true	none	none
fields	[object]	true	none	none
» id	string	true	none	none
» name	string	true	none	none
» type	string	true	none	none
» options	[Field/properties/options/items]	true	none	none

PutCustomer

{
  "firstname": "string",
  "lastname": "string",
  "emailAddress": "string",
  "user": {
    "name": "string",
    "password": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
firstname	string	true	none	none
lastname	string	true	none	none
emailAddress	string	true	none	none
user	Customer/properties/user	true	none	none

PutField

{
  "fieldId": "string",
  "option": "string"
}

Properties

Name	Type	Required	Restrictions	Description
fieldId	string	true	none	none
option	string	true	none	none

PutOrder

{
  "customerId": 65083,
  "productId": 36,
  "accounting": "contract",
  "paymentMethod": "credit_card",
  "slots": 4,
  "gameId": 3,
  "fieldList": [
    {
      "fieldId": 208,
      "option": 2
    },
    {
      "fieldId": 4,
      "option": 467
    },
    {
      "fieldId": 203,
      "option": 588
    },
    {
      "fieldId": 147,
      "option": 438
    },
    {
      "fieldId": 250,
      "option": 636
    },
    {
      "fieldId": 6,
      "option": 12
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
customerId	int	true	none	none
productId	int	true	none	none
slots	int	true	none	none
gameId	int	true	none	none
fieldList	[PostPackage/properties/fieldList/items]	true	none	none
accounting	string	true	none	none
paymentMethod	string	true	none	none

Enumerated Values

Property	Value
accounting	contract
accounting	prepaid
accounting	none
paymentMethod	credit_card
paymentMethod	paypal
paymentMethod	bitcoin

PutTicket

{
  "customerId": null,
  "title": "string",
  "message": "string",
  "service": {
    "type": "gameserver",
    "id": 10320
  }
}

Properties

Name	Type	Required	Restrictions	Description
customerId	int	true	none	none
title	string	true	none	none
message	string	true	none	none
service	object	true	none	none
» type	string	true	none	none
» id	int	true	none	none

Service

{
  "id": null,
  "type": null
}

Properties

Name	Type	Required	Restrictions	Description
id	int	true	none	none
type	int	true	none	none

ServiceActionResult

{
  "status": null,
  "error": {}
}

Properties

Name	Type	Required	Restrictions	Description
status	bool	true	none	none
error	object	true	none	none

Ticket

{
  "id": null,
  "customerId": null,
  "createdAt": null,
  "title": "string",
  "firstMessage": "string",
  "status": "string",
  "service": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	int	true	none	none
customerId	int	true	none	none
createdAt	int	true	none	none
title	string	true	none	none
firstMessage	string	true	none	none
status	string	true	none	none
service	string	true	none	none

TicketList

{
  "tickets": [
    {
      "id": null,
      "customerId": null,
      "createdAt": null,
      "title": "string",
      "firstMessage": "string",
      "status": "string",
      "service": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
tickets	[object]	true	none	none
» id	int	true	none	none
» customerId	int	true	none	none
» createdAt	int	true	none	none
» title	string	true	none	none
» firstMessage	string	true	none	none
» status	string	true	none	none
» service	string	true	none	none

TicketMessage

{
  "id": null,
  "adminName": null,
  "createdAt": "string",
  "type": "string",
  "message": "string",
  "data": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	int	true	none	none
adminName	int	true	none	none
createdAt	string	true	none	none
type	string	true	none	none
message	string	true	none	none
data	string	true	none	none

TicketMessageList

{
  "messages": [
    {
      "id": null,
      "adminName": null,
      "createdAt": "string",
      "type": "string",
      "message": "string",
      "data": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
messages	[object]	true	none	none
» id	int	true	none	none
» adminName	int	true	none	none
» createdAt	string	true	none	none
» type	string	true	none	none
» message	string	true	none	none
» data	string	true	none	none

User

{
  "name": "string",
  "password": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
password	string	true	none	none