{ "openapi": "3.0.0", "info": { "title": "ApiDoc", "description": "\n\n# Api Keys and Auth\nDirect access to the API is recommended via the provided API Key.\nThe API Key can be passed as token query parameter (?token=) or as Authorization header (Authorization: Bearer ). If both are present, the query parameter is used.\n\nAPI Keys can be created as read-only. A read-only key can only perform GET requests, any other request method is rejected with HTTP 403.\n\nAPI Keys can also be created as Hostrivo API keys (hostrivo=1 at creation). Such a key only authenticates when the request comes from the Hostrivo platform, any other source is rejected with HTTP 403 (error code apikeyhostrivoip); the noVNC and live data websockets accept such a key as well. Hostrivo API keys are exempt from the rate limits.\n\n# Orders and Tax\nAll order and credit top-up endpoints require a known billing country on the account. If neither a valid tax parameter is sent nor a billing country is stored (invoice data), the request is rejected with HTTP 406 (error tag notaxcountry). The billing country can be set via the invoice data endpoint.\n\n# Limits\nThere is a global rate limit of 240 requests per minute per IP or Token.\nIf an endpoint specifies a additional limit, it is noted in the documentation.\nHostrivo API keys (see above) are exempt from all rate limits.\n\n# Reporting errors\nEach response contains a Request ID (Header X-Request-Id) with this Request ID you can report the problem to us.\n", "version": "0.1.1" }, "servers": [ { "url": "https://backend.datalix.de/v1/" } ], "paths": { "/dedicated/line/{line}": { "get": { "tags": [ "dedicated" ], "description": "\n## Ratelimit\n120 requests every 30 seconds", "parameters": [ { "name": "line", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "ge" } } ], "responses": { "200": { "$ref": "#/components/responses/DedicatedLineResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } }, "/dedicated/packet/{packetid}": { "get": { "tags": [ "dedicated" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "packetid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/DedicatedPacketInfoResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } }, "/dedicated/packet/{packetid}/os": { "get": { "tags": [ "dedicated" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "packetid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/DedicatedOsPacketResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } }, "/dedicated/sale/custom": { "get": { "tags": [ "dedicated" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "responses": { "200": { "$ref": "#/components/responses/DedicatedSaleResponse" }, "429": { "$ref": "#/components/responses/429" } } } }, "/dedicated/sale/custom/{saleid}": { "get": { "tags": [ "dedicated" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "saleid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/DedicatedSaleCustomResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } }, "/dedicated/sale/custom/{saleid}/os": { "get": { "tags": [ "dedicated" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "saleid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/DedicatedSaleCustomOsResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } }, "/dedicated/{serviceid}/os": { "get": { "tags": [ "dedicated" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/DedicatedOsInfoResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } }, "/dedicated/{serviceid}": { "get": { "tags": [ "dedicated" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/DedicatedSaleInfoResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } }, "/donation/link/{linkId}/start": { "post": { "tags": [ "donation" ], "description": "\n## Ratelimit\n20 requests every 120 seconds", "parameters": [ { "name": "linkId", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "format": "string", "minimum": 1, "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "message": { "type": "string", "example": "Nice donation message" }, "amount": { "type": "integer", "example": "1" }, "paymentmethod": { "type": "string", "example": "psc/sofort/giropay" } }, "type": "object", "example": { "message": "Nice donation message", "amount": "1", "paymentmethod": "psc" } } } } }, "responses": { "200": { "$ref": "#/components/responses/DonationPaymentLinkStart" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } }, "/donation/{donationId}/status": { "post": { "tags": [ "donation" ], "description": "\n## Ratelimit\n20 requests every 120 seconds", "parameters": [ { "name": "donationId", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "format": "string", "minimum": 1, "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": {} } } }, "responses": { "200": { "$ref": "#/components/responses/DonationPaymentStatus" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } }, "/reseller/order/kvm/{kvmPacketId}": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n2 requests every 30 seconds\n## Externalid\nOptional. Gets stored with the order. If an order with the same externalid already exists, no new order is placed: the serviceid of the existing order is returned, or the request fails if that order has no service yet.\n## Hostname\nOptional. The full hostname the server is installed with, instead of v{id}.datalix.de. 8 to 64 characters, letters, numbers, dots and dashes, it must not contain datalix. Can be changed later via /service/{id}/hostname.\n## Errors\nErrors are returned as JSON object with an error key (message localized to the language of the user) and an error_code key that identifies the exact error independent of the language.\n400 | mainMissingVariable => Missing variable {variable}\n400 | mainEmptyVariable => Empty variable {variable}\n404 | kvmPacketNotFound => The requested KVM packet does not exist.\n404 | kvmOsNotFound => The requested operating system does not exist.\n406 | orderInvalidRuntime => The runtime must be between 30 and 360 days.\n406 | hardsoldoutnoipsleft => No more IP addresses available. Try again later.\n406 | packetsoldout => This package is sold out at the moment, try again later.\n406 | kvmInvalidIpCount => The IP count must be between the packet default and 20.\n406 | kvmInvalidTraffic => The traffic must not be over 100 TB.\n406 | creditlimitreached => You have reached your limit. (the order can not be paid with the available credit or credit limit)\n406 | orderExternalIdNoService => An order with this external ID already exists, but no service was created for it.\n406 | hostnameMax64Chars => Hostname can be maximum 64 characters long.\n406 | hostnameMin8Chars => Hostname must be at least 8 characters long.\n406 | hostnameInvalid => Hostname must consist of letters, numbers, dots and dashes only.\n406 | hostnameInvalidName => This name is not allowed.", "parameters": [ { "name": "kvmPacketId", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "format": "string", "minimum": 1, "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "os": { "type": "string", "example": "0ebd6527-57c9-48b5-b5b5-ce4b97fba670" }, "ipcount": { "type": "integer", "example": "1" }, "trafficcount": { "type": "integer", "example": "1" }, "days": { "type": "integer", "example": "30" }, "externalid": { "type": "string", "example": "my-shop-order-123" }, "hostname": { "type": "string", "example": "srv-1a2b3c4d.example.com" } }, "type": "object", "example": { "os": "0ebd6527-57c9-48b5-b5b5-ce4b97fba670", "ipcount": "1", "trafficcount": "1", "days": "30", "externalid": "my-shop-order-123", "hostname": "srv-1a2b3c4d.example.com" } } } } }, "responses": { "200": { "$ref": "#/components/responses/ResellerOrderKVMReseponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "406": { "$ref": "#/components/responses/406" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/order/gameserver/{gameId}": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n2 requests every 30 seconds\n## Externalid\nOptional. Gets stored with the order. If an order with the same externalid already exists, no new order is placed: the serviceid of the existing order is returned, or the request fails if that order has no service yet.\n## Errors\nErrors are returned as JSON object with an error key (message localized to the language of the user) and an error_code key that identifies the exact error independent of the language.\n400 | mainMissingVariable => Missing variable {variable}\n400 | mainEmptyVariable => Empty variable {variable}\n404 | gameserverGameNotFound => The requested game does not exist.\n404 | gameserverVersionNotFound => The requested game version does not exist.\n404 | gameserverPackageNotFound => The requested gameserver package does not exist.\n406 | gameserverVersionNotMatchingGame => The selected version does not belong to the selected game.\n406 | orderInvalidRuntime => The runtime must be between 30 and 360 days.\n406 | creditlimitreached => You have reached your limit. (the order can not be paid with the available credit or credit limit)\n406 | orderExternalIdNoService => An order with this external ID already exists, but no service was created for it.", "parameters": [ { "name": "gameId", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "format": "string", "minimum": 1, "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "package": { "type": "string", "example": "0ebd6527-57c9-48b5-b5b5-ce4b97fba670" }, "version": { "type": "string", "example": "0ebd6527-57c9-48b5-b5b5-ce4b97fba670" }, "days": { "type": "integer", "example": "30" }, "externalid": { "type": "string", "example": "my-shop-order-123" } }, "type": "object", "example": { "package": "0ebd6527-57c9-48b5-b5b5-ce4b97fba670", "version": "0ebd6527-57c9-48b5-b5b5-ce4b97fba670", "days": "30", "externalid": "my-shop-order-123" } } } } }, "responses": { "200": { "$ref": "#/components/responses/ResellerOrderGameserverReseponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "406": { "$ref": "#/components/responses/406" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/order/s3/{objectStorageId}": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n2 requests every 30 seconds\n## Externalid\nOptional. Gets stored with the order. If an order with the same externalid already exists, no new order is placed: the serviceid of the existing order is returned, or the request fails if that order has no service yet.\n## Errors\nErrors are returned as JSON object with an error key (message localized to the language of the user) and an error_code key that identifies the exact error independent of the language.\n400 | mainMissingVariable => Missing variable {variable}\n400 | mainEmptyVariable => Empty variable {variable}\n404 | s3PlanNotFound => The requested object storage plan does not exist.\n406 | orderInvalidRuntime => The runtime must be between 30 and 360 days.\n406 | packetsoldout => This package is sold out at the moment, try again later.\n406 | s3InvalidTbCount => The storage amount must be between the plan minimum and the plan maximum.\n406 | creditlimitreached => You have reached your limit. (the order can not be paid with the available credit or credit limit)\n406 | orderExternalIdNoService => An order with this external ID already exists, but no service was created for it.", "parameters": [ { "name": "objectStorageId", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "format": "string", "minimum": 1, "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "tbcount": { "type": "integer", "example": "1" }, "days": { "type": "integer", "example": "30" }, "externalid": { "type": "string", "example": "my-shop-order-123" } }, "type": "object", "example": { "tbcount": "1", "days": "30", "externalid": "my-shop-order-123" } } } } }, "responses": { "200": { "$ref": "#/components/responses/ResellerOrderS3Reseponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "406": { "$ref": "#/components/responses/406" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/order/nextcloud/{nextcloudId}": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n2 requests every 30 seconds\n## Externalid\nOptional. Gets stored with the order. If an order with the same externalid already exists, no new order is placed: the serviceid of the existing order is returned, or the request fails if that order has no service yet.\n## Domain\nThe domain the Nextcloud will run on. It must already have an A record pointing to 5.253.247.2, otherwise the order fails.\n## Errors\nErrors are returned as JSON object with an error key (message localized to the language of the user) and an error_code key that identifies the exact error independent of the language.\n400 | mainMissingVariable => Missing variable {variable}\n400 | mainEmptyVariable => Empty variable {variable}\n404 | nextcloudPackageNotFound => The requested Nextcloud package does not exist.\n406 | orderInvalidRuntime => The runtime must be between 30 and 360 days.\n406 | packetsoldout => This package is sold out at the moment, try again later.\n406 | noemptyspacesallowed => No empty spaces allowed.\n406 | invaliddomain => Please enter a valid domain.\n406 | invaliddnsrecord => The domain must have an A record pointing to 5.253.247.2.\n406 | domainallreadyinuse => This domain is already in use.\n406 | creditlimitreached => You have reached your limit. (the order can not be paid with the available credit or credit limit)\n406 | orderExternalIdNoService => An order with this external ID already exists, but no service was created for it.", "parameters": [ { "name": "nextcloudId", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "format": "string", "minimum": 1, "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "domain": { "type": "string", "example": "cloud.example.com" }, "days": { "type": "integer", "example": "30" }, "externalid": { "type": "string", "example": "my-shop-order-123" } }, "type": "object", "example": { "domain": "cloud.example.com", "days": "30", "externalid": "my-shop-order-123" } } } } }, "responses": { "200": { "$ref": "#/components/responses/ResellerOrderNextcloudReseponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "406": { "$ref": "#/components/responses/406" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/order/dedicated/sale/{dedicatedId}": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n2 requests every 30 seconds\n## Externalid\nOptional. Gets stored with the order. If an order with the same externalid already exists, no new order is placed: the serviceid of the existing order is returned, or the request fails if that order has no service yet.\n## Bandwidth\nOptional. Defaults to the standard uplink. Allowed custom values: 1, 1.5 or 10 (Gbit/s).\n## Errors\nErrors are returned as JSON object with an error key (message localized to the language of the user) and an error_code key that identifies the exact error independent of the language.\n400 | mainMissingVariable => Missing variable {variable}\n400 | mainEmptyVariable => Empty variable {variable}\n404 | dedicatedServerNotFound => The requested dedicated server does not exist.\n404 | dedicatedOsNotFound => The requested operating system does not exist.\n406 | orderInvalidRuntime => The runtime must be between 30 and 360 days.\n406 | dedicatedNotForSale => This Dedicated Server is not for sale.\n406 | dedicatedInvalidTraffic => The traffic must not be below the server default.\n406 | dedicatedInvalidBandwidth => The bandwidth must be default, 1, 1.5 or 10.\n406 | dedicatedInvalidIpCount => The IP count must be between the server default and 64.\n406 | hardsoldoutnoipsleft => No more IP addresses available. Try again later.\n406 | creditlimitreached => You have reached your limit. (the order can not be paid with the available credit or credit limit)\n406 | orderExternalIdNoService => An order with this external ID already exists, but no service was created for it.", "parameters": [ { "name": "dedicatedId", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "format": "string", "minimum": 1, "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "os": { "type": "string", "example": "0ebd6527-57c9-48b5-b5b5-ce4b97fba670" }, "ipcount": { "type": "integer", "example": "1" }, "trafficcount": { "type": "integer", "example": "1" }, "bandwidth": { "type": "string", "example": "default" }, "days": { "type": "integer", "example": "30" }, "externalid": { "type": "string", "example": "my-shop-order-123" } }, "type": "object", "example": { "os": "0ebd6527-57c9-48b5-b5b5-ce4b97fba670", "ipcount": "1", "trafficcount": "1", "bandwidth": "default", "days": "30", "externalid": "my-shop-order-123" } } } } }, "responses": { "200": { "$ref": "#/components/responses/ResellerOrderDedicatedReseponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "406": { "$ref": "#/components/responses/406" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/order/dedicated/{packetId}": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n2 requests every 30 seconds\n## Externalid\nOptional. Gets stored with the order. If an order with the same externalid already exists, no new order is placed: the serviceid of the existing order is returned, or the request fails if that order has no service yet.\n## Configuration\nram is the id of a ram configuration of the packet, disk is a comma separated list of disk configuration ids of the packet (it can also be sent as a form array via disk[]). The order price includes the packet setup fee. Packet servers are built to order, the usual deploy time is up to 3 working days.\n## Hostname\nOptional. The full hostname the server is installed with (also on later reinstalls), instead of {servername}.datalix.de. 8 to 64 characters, letters, numbers, dots and dashes, it must not contain datalix.\n## Errors\nErrors are returned as JSON object with an error key (message localized to the language of the user) and an error_code key that identifies the exact error independent of the language.\n400 | mainMissingVariable => Missing variable {variable}\n400 | mainEmptyVariable => Empty variable {variable}\n404 | dedicatedPacketNotFound => The requested dedicated packet does not exist.\n404 | dedicatedOsNotFound => The requested operating system does not exist.\n404 | dedicatedRamNotFound => The requested RAM configuration does not exist.\n404 | dedicatedDiskNotFound => The requested disk configuration does not exist.\n406 | orderInvalidRuntime => The runtime must be between 30 and 360 days.\n406 | notinstock => This packet is not in stock at the moment, try again later.\n406 | hardsoldoutnoipsleft => No more IP addresses available. Try again later. (the IPv6 pool of the packet can not hand out a /64 any more)\n406 | dedicatedInvalidIpCount => The IP count must be between the server default and 64.\n406 | dedicatedInvalidTraffic => The traffic must not be below the server default.\n406 | dedicatedRamNotMatchingPacket => The selected RAM configuration does not belong to the selected packet.\n406 | dedicatedDiskNotMatchingPacket => The selected disk configuration does not belong to the selected packet.\n406 | dedicatedDiskInvalid => No valid disk configuration given.\n406 | creditlimitreached => You have reached your limit. (the order can not be paid with the available credit or credit limit)\n406 | orderExternalIdNoService => An order with this external ID already exists, but no service was created for it.\n406 | hostnameMax64Chars => Hostname can be maximum 64 characters long.\n406 | hostnameMin8Chars => Hostname must be at least 8 characters long.\n406 | hostnameInvalid => Hostname must consist of letters, numbers, dots and dashes only.\n406 | hostnameInvalidName => This name is not allowed.", "parameters": [ { "name": "packetId", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "format": "string", "minimum": 1, "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "os": { "type": "string", "example": "0ebd6527-57c9-48b5-b5b5-ce4b97fba670" }, "ipcount": { "type": "integer", "example": "1" }, "trafficcount": { "type": "integer", "example": "333" }, "ram": { "type": "string", "example": "0ebd6527-57c9-48b5-b5b5-ce4b97fba670" }, "disk": { "type": "string", "example": "0ebd6527-57c9-48b5-b5b5-ce4b97fba670,0ebd6527-57c9-48b5-b5b5-ce4b97fba671" }, "days": { "type": "integer", "example": "30" }, "externalid": { "type": "string", "example": "my-shop-order-123" }, "hostname": { "type": "string", "example": "srv-1a2b3c4d.example.com" } }, "type": "object", "example": { "os": "0ebd6527-57c9-48b5-b5b5-ce4b97fba670", "ipcount": "1", "trafficcount": "333", "ram": "0ebd6527-57c9-48b5-b5b5-ce4b97fba670", "disk": "0ebd6527-57c9-48b5-b5b5-ce4b97fba670,0ebd6527-57c9-48b5-b5b5-ce4b97fba671", "days": "30", "externalid": "my-shop-order-123", "hostname": "srv-1a2b3c4d.example.com" } } } } }, "responses": { "200": { "$ref": "#/components/responses/ResellerOrderDedicatedReseponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "406": { "$ref": "#/components/responses/406" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/gameserver": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "responses": { "200": { "$ref": "#/components/responses/ResellerGameServerResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/gameserver/packages/{gameId}": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "gameId", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerGameServerVersionResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/extend/service/{serviceId}": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n20 requests every 120 seconds", "parameters": [ { "name": "serviceId", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "format": "string", "minimum": 1, "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "days": { "type": "integer" } }, "type": "object", "example": { "days": "15" } } } } }, "responses": { "200": { "$ref": "#/components/responses/ResellerExtendServiceReseponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/user/list": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "format": "string", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/InterfaceUserResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/user/{userid}/service/list": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/InterfaceServiceResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/user/{userid}": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "email": { "type": "string", "example": "email" }, "username": { "type": "string", "example": "username" } }, "type": "object", "example": { "email": "email", "username": "username" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "delete": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/user/{userid}/service/{assingid}": { "delete": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "assingid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/user": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n20 requests every 120 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "format": "string", "minimum": 1 } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "email": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" } }, "type": "object", "example": { "email": "test@test.de", "username": "test", "0": "password", "1": "test" } } } } }, "responses": { "200": { "$ref": "#/components/responses/ResellerUserCreateResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/user/assing": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n20 requests every 120 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "format": "string", "minimum": 1 } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "service": { "type": "string" }, "userid": { "type": "string" } }, "type": "object", "example": { "service": "e53490af-aa1a-4c01-8617-b5f77e7fd773", "userid": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/kvmserver/line/{kvmline}": { "get": { "tags": [ "kvmserver" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "kvmline", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "format": "string", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/KVMLineResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } }, "/kvmserver/packet/{packetid}": { "get": { "tags": [ "kvmserver" ], "description": "\n ## Ratelimit\n 30 requests every 60 seconds", "parameters": [ { "name": "packetid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "format": "4", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/KVMPacketResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } }, "/kvmserver/packet/{packetid}/os": { "get": { "tags": [ "kvmserver" ], "description": "\n ## Ratelimit\n 30 requests every 60 seconds", "parameters": [ { "name": "packetid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "format": "4", "minimum": 1 } } ], "responses": { "200": { "$ref": "#/components/responses/KVMPacketOsResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } }, "/order/kvmserver/{kvmPacketId}": { "post": { "tags": [ "order" ], "description": "\n ## Ratelimit\n 20 requests every 120 seconds", "parameters": [ { "name": "kvmPacketId", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "format": "string", "minimum": 1, "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "paymentMethod": { "type": "string", "example": "paypal" }, "os": { "type": "string", "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" }, "ipcount": { "type": "integer", "example": "1" }, "credit": { "type": "integer", "example": "1" } }, "type": "object", "example": { "paymentMethod": "1", "os": "ipcount", "1": "credit" } } } } }, "responses": { "200": { "$ref": "#/components/responses/OrderKVMResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/order/{orderId}/pay": { "post": { "tags": [ "order" ], "description": "\n ## Ratelimit\n 20 requests every 120 seconds", "parameters": [ { "name": "orderId", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "format": "string", "minimum": 1, "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "paymentMethod": { "type": "string", "example": "paypal" } }, "type": "object", "example": { "paymentMethod": "paypal" } } } } }, "responses": { "200": { "$ref": "#/components/responses/OrderPayResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/list": { "get": { "tags": [ "service" ], "description": "\nActive services are returned in the custom display order (see POST /user/{userid}/servicelistorder). Services without a stored position are listed last, ordered by favorite first, then oldest first.\nEvery entry carries maintenance: the earliest announced maintenance that covers the service ({phase, starts_on, ends_on}), null without one.\n ## Ratelimit\n 30 requests every 60 seconds\n## Supported Services\nAll service types", "responses": { "200": { "$ref": "#/components/responses/ServiceListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}": { "get": { "tags": [ "service" ], "description": "\n ## Ratelimit\n 30 requests every 60 seconds\n## Maintenance\nmaintenance lists the announced maintenances that cover the service, planned or running, with window, subject and text in the language of the account (subject and text are null for customers of a reseller interface). A KVM Server additionally names the one its status shows in product.maintenanceid.\n## Supported Services\nAll service types", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceInfoResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/status": { "get": { "tags": [ "service" ], "description": "\n ## Ratelimit\n 30 requests every 60 seconds\n ## Status List\n stopping => Service is stopping\n shutdown => Service is stopping (via shutdown)\n starting => Service is starting\n running => Service is online\n stopped => Service is offline\n installing => Service is installing\n preorder => Service is waiting to be deployed\n createbackup => Service is creating a backup\n restorebackup => Service is restoring a backup\n backupplanned => Service has a backup planned\n restoreplanned => Service has a restore planned\n migrating => Service is being moved to another host\n maintenance => Service is in a maintenance (KVM and dedicated servers)\n error => Service has an error\n## Supported Services\nAll service types", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceStatusResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/os": { "get": { "tags": [ "service" ], "description": "\n ## Ratelimit\n 30 requests every 60 seconds\n## Supported Services\nDedicated Server, KVM Server", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceOsResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/ip": { "get": { "tags": [ "service" ], "description": "\n ## Ratelimit\n 30 requests every 60 seconds\n## Supported Services\nAll service types", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceIpResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/ip/{ip}/rdns": { "post": { "tags": [ "service" ], "description": "\n ## Ratelimit\n 30 requests every 900 seconds\n## Supported Services\nAll service types", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "ip", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "1.1.1.1" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "rdns": { "type": "string", "example": "mail.test.de" } }, "type": "object", "example": { "rdns": "mail.test.de" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/stop": { "post": { "tags": [ "service" ], "description": "\n ## Ratelimit\n 30 requests every 60 seconds\n## Supported Services\nDedicated Server, KVM Server, Gameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/start": { "post": { "tags": [ "service" ], "description": "\n ## Ratelimit\n 30 requests every 60 seconds\n## Supported Services\nDedicated Server, KVM Server, Gameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/shutdown": { "post": { "tags": [ "service" ], "description": "\n ## Ratelimit\n 30 requests every 60 seconds\n## Supported Services\nDedicated Server, KVM Server, Gameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/restart": { "post": { "tags": [ "service" ], "description": "\n ## Ratelimit\n 30 requests every 60 seconds\n## Supported Services\nKVM Server, Gameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/reinstall": { "post": { "tags": [ "service" ], "description": "\n ## Ratelimit\n 30 requests every 900 seconds\n## Supported Services\nDedicated Server, KVM Server, Gameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "os": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, "type": "object", "example": { "os": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/backup": { "get": { "tags": [ "service" ], "description": "\n ## Ratelimit\n 30 requests every 60 seconds\n## Supported Services\nKVM Server, Gameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceBackupResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "service" ], "description": "\n ## Ratelimit\n 10 requests every 900 seconds\n## Supported Services\nKVM Server, Gameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/cron": { "get": { "tags": [ "service" ], "description": "\n ## Ratelimit\n 30 requests every 60 seconds\n## Supported Services\nKVM Server, Gameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceCronResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "service" ], "description": "\n ## Ratelimit\n 30 requests every 900 seconds\n## Supported Services\nKVM Server, Gameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "name": { "type": "string", "example": "name" }, "action": { "type": "string", "example": "start" }, "expression": { "type": "string", "example": "* * * * *" } }, "type": "object", "example": { "name": "name", "action": "start", "expression": "* * * * *" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/cron/{cronid}": { "post": { "tags": [ "service" ], "description": "\n ## Ratelimit\n 30 requests every 900 seconds\n## Supported Services\nKVM Server, Gameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "cronid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "name": { "type": "string", "example": "name" }, "action": { "type": "string", "example": "start" }, "expression": { "type": "string", "example": "* * * * *" } }, "type": "object", "example": { "name": "name", "action": "start", "expression": "* * * * *" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/cron/{cronid}/delete": { "delete": { "tags": [ "service" ], "description": "\n ## Ratelimit\n 30 requests every 60 seconds\n## Supported Services\nKVM Server, Gameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "cronid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/backup/delete": { "post": { "tags": [ "service" ], "description": "\n ## Ratelimit\n 30 requests every 900 seconds\n## Supported Services\nKVM Server, Gameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "backup": { "type": "string", "example": "name" } }, "type": "object", "example": { "backup": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/backup/restore": { "post": { "tags": [ "service" ], "description": "\n ## Ratelimit\n 30 requests every 900 seconds\n## Supported Services\nKVM Server, Gameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "backup": { "type": "string", "example": "name" } }, "type": "object", "example": { "backup": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/extend": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nAll service types", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "days": { "type": "integer", "example": "name" }, "credit": { "type": "integer", "example": "0" } }, "type": "object", "example": { "days": "15", "credit": "0" } } } } }, "responses": { "200": { "$ref": "#/components/responses/ServiceExtendResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/hide": { "post": { "tags": [ "service" ], "description": "\n# Ratelimit\n requests every 60 seconds\n## Supported Services\nAll service types", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceHideResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/gameserver/all": { "get": { "tags": [ "gameserver" ], "description": "\n## Ratelimit\n120 requests every 60 seconds", "responses": { "200": { "$ref": "#/components/responses/GameserverAllResponse" }, "429": { "$ref": "#/components/responses/429" } } } }, "/gameserver/line/{line}": { "get": { "tags": [ "gameserver" ], "description": "\n## Ratelimit\n120 requests every 30 seconds", "parameters": [ { "name": "line", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "ge" } } ], "responses": { "200": { "$ref": "#/components/responses/GameserverLineResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } }, "/gameserver/game/{gameid}": { "get": { "tags": [ "gameserver" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "gameid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/GameserverGameInfoResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } }, "/kvmserver/os": { "get": { "tags": [ "kvmserver" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "responses": { "200": { "$ref": "#/components/responses/KvmserverOsResponse" }, "429": { "$ref": "#/components/responses/429" } } } }, "/kvmserver/hostsystem/{type}": { "get": { "tags": [ "kvmserver" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Hostsystem\nReturns the host system hardware (CPU model, base/turbo frequency and network uplink) for a KVM node type.\n## Type\nThe cluster value of a KVM packet (answered with the host system of that cluster, the most precise answer) or a host system type (xeon, xeongold, epyc, ryzengen4, ryzen), e.g. as returned by /kvmserver/line/{kvmline} or /kvmserver/packet/{packetid}. Cluster names can change, read them from the packet each time.\n## Errors\n404 | kvmHostsystemNotFound => The requested host system does not exist.", "parameters": [ { "name": "type", "in": "path", "description": "Cluster of a KVM packet (kvmserver_packet.cluster) or a host system type", "required": true, "schema": { "type": "string", "example": "epyc" } } ], "responses": { "200": { "$ref": "#/components/responses/KvmserverHostsystemResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } }, "/nextcloud/line/{line}": { "get": { "tags": [ "nextcloud" ], "description": "\n## Ratelimit\n120 requests every 30 seconds", "parameters": [ { "name": "line", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "ge" } } ], "responses": { "200": { "$ref": "#/components/responses/NextcloudLineResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } }, "/nextcloud/validatedomain": { "post": { "tags": [ "nextcloud" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "domain": { "type": "string", "example": "domain" } }, "type": "object", "example": { "domain": "domain" } } } } }, "responses": { "200": { "$ref": "#/components/responses/NextcloudValidateDomainResponse" }, "429": { "$ref": "#/components/responses/429" } } } }, "/nextcloud/packet/{packetid}": { "get": { "tags": [ "nextcloud" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "packetid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/NextcloudPacketInfoResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } }, "/reseller/interface/list": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n20 requests every 120 seconds", "responses": { "200": { "$ref": "#/components/responses/ResellerInterfaceListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/packet/list": { "get": { "tags": [ "reseller" ], "description": "Every packet the reseller can order, told apart by type: kvmpackage (default packets plus packets assigned to the account), nextcloudpackage, dedicatedpackage and objectstoragepackage.\nkvmpackage entries also carry locationname (readable data center name), country and backupslots (backup slots a new service of the packet gets).\nkvmpackage and dedicatedpackage entries carry countrycode (ISO 3166-1 alpha-2, upper case, e.g. DE) and city (e.g. Frankfurt am Main) for a location line the shop can translate; country stays the German display name.\n\n## Ratelimit\n20 requests every 120 seconds", "responses": { "200": { "$ref": "#/components/responses/ResellerPacketListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/domain": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n120 requests every 10 seconds", "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "domain": { "type": "string", "example": "domain" } }, "type": "object", "example": { "domain": "domain" } } } } }, "responses": { "200": { "$ref": "#/components/responses/ResellerCheckDomainResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface": { "post": { "tags": [ "reseller" ], "description": "Disabled: legacy reseller interfaces can no longer be created via this endpoint. New interfaces are created on Hostrivo (panel.hostrivo.com). Every call returns 406.\n\n## Ratelimit\n20 requests every 120 seconds\n\n## Errors\n406 | resellerInterfaceCreationDisabled => Reseller interfaces can no longer be created here. Please create new interfaces on our new reselling platform Hostrivo at panel.hostrivo.com.", "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "domain": { "type": "string", "example": "domain" }, "displayname": { "type": "string", "example": "displayname" }, "logourl": { "type": "string", "example": "logourl" } }, "type": "object", "example": { "domain": "domain", "displayname": "displayname", "logourl": "logourl" } } } } }, "responses": { "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "406": { "$ref": "#/components/responses/406" }, "429": { "$ref": "#/components/responses/429" } }, "deprecated": true, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/ip/list": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n20 requests every 120 seconds", "responses": { "200": { "$ref": "#/components/responses/ResellerIpListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerInterfaceInfoResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "defaultlang": { "type": "string", "example": "example" }, "defaultstyle": { "type": "string", "example": "example" }, "logourl": { "type": "string", "example": "example" }, "displayname": { "type": "string", "example": "example" }, "faviconurl": { "type": "string", "example": "example" }, "supporturl": { "type": "string", "example": "example" }, "ordernewprodurl": { "type": "string", "example": "example" }, "imprinturl": { "type": "string", "example": "example" }, "tosurl": { "type": "string", "example": "example" }, "privacyurl": { "type": "string", "example": "example" }, "supportlink": { "type": "string", "example": "example" }, "color": { "type": "string", "example": "example" }, "secondarycolor": { "type": "string", "example": "example" }, "thirdcolor": { "type": "string", "example": "example" }, "hostdomain": { "type": "string", "example": "example" }, "discordembedcolor": { "type": "string", "example": "example" }, "discordembedtitle": { "type": "string", "example": "example" }, "discordembeddesc": { "type": "string", "example": "example" }, "discordembedlogo": { "type": "string", "example": "example" }, "registeractive": { "type": "string", "example": "example" }, "langchanger": { "type": "string", "example": "example" }, "disabledashboardoverview": { "type": "string", "example": "example" }, "disablenodecpu": { "type": "string", "example": "example" }, "disablestylechanger": { "type": "string", "example": "example" }, "disabletosdisplay": { "type": "string", "example": "example" }, "disablecustomerarea": { "type": "string", "example": "example" }, "disablenovnc": { "type": "string", "example": "example" }, "displaygamechanger": { "type": "string", "example": "example" }, "enableapikeys": { "type": "string", "example": "example" }, "externalapidoc": { "type": "string", "example": "example" }, "enableapidocs": { "type": "string", "example": "example" }, "payment_enabled": { "type": "string", "example": "example" }, "payment_mollie_apikey": { "type": "string", "example": "example" }, "payment_paypal_clientid": { "type": "string", "example": "example" }, "payment_paypal_clientsecret": { "type": "string", "example": "example" }, "payment_paypal_mode": { "type": "string", "example": "example" }, "subreseller": { "type": "string", "example": "example" }, "script": { "type": "string", "example": "example" }, "css": { "type": "string", "example": "example" }, "themecolor": { "type": "string", "example": "example" }, "slidercolor": { "type": "string", "example": "example" }, "kvmconfiguratoricon": { "type": "string", "example": "example" }, "kvmextraipv4price": { "type": "integer", "example": "10" }, "kvmextratrafficprice": { "type": "integer", "example": "10" }, "dediextraipv4price": { "type": "integer", "example": "10" }, "dediextratrafficprice": { "type": "integer", "example": "10" }, "taxamount": { "type": "integer", "example": "10" }, "invoice_notes": { "type": "string", "example": "example" }, "invoice_address": { "type": "string", "example": "example" }, "invoice_color": { "type": "string", "example": "example" }, "setting_setinvoicedata": { "type": "string", "example": "example" }, "setting_password_reset": { "type": "string", "example": "example" }, "supportticketsystem": { "type": "string", "example": "example" }, "invoice_logo": { "type": "string", "example": "example" }, "payment_stripe_apikey": { "type": "string", "example": "example" }, "payment_stripe_webhook_secret": { "type": "string", "example": "example" }, "payment_stripe_apikey_public": { "type": "string", "example": "example" }, "mailserver_server": { "type": "string", "example": "example" }, "mailserver_port": { "type": "integer", "example": "10" }, "mailserver_user": { "type": "string", "example": "example" }, "mailserver_password": { "type": "string", "example": "example" }, "mailserver_replyto": { "type": "string", "example": "example" }, "mailserver_loginname": { "type": "string", "example": "example" }, "mailserver_displayname": { "type": "string", "example": "example" }, "coinpayments_private_key": { "type": "string", "example": "example" }, "coinpayments_public_key": { "type": "string", "example": "example" }, "coinpayments_merchant_id": { "type": "string", "example": "example" }, "coingate_auth_token": { "type": "string", "example": "example" }, "coingate_environment": { "description": "live or sandbox, defaults to live", "type": "string", "example": "live" }, "supportdisplayname": { "type": "string", "example": "example" }, "graph_color_1": { "type": "string", "example": "example" }, "graph_color_2": { "type": "string", "example": "example" }, "orderswithoutpaying": { "type": "string", "example": "example" }, "accessmanager": { "type": "string", "example": "example" }, "ordernewproductpage": { "type": "string", "example": "example" }, "supportsignature": { "type": "string", "example": "example" }, "oauth_discord_secret": { "type": "string", "example": "example" }, "oauth_discord_id": { "type": "string", "example": "example" }, "oauth_github_id": { "type": "string", "example": "example" }, "oauth_github_secret": { "type": "string", "example": "example" }, "loginconfirm": { "type": "string", "example": "example" }, "enable_eu_tax": { "type": "string", "example": "example" }, "announcement": { "type": "string", "example": "example" } }, "type": "object", "example": { "defaultlang": "example", "defaultstyle": "example", "logourl": "example", "displayname": "example", "faviconurl": "example", "supporturl": "example", "ordernewprodurl": "example", "imprinturl": "example", "tosurl": "example", "privacyurl": "example", "supportlink": "example", "color": "example", "secondarycolor": "example", "thirdcolor": "example", "hostdomain": "example", "discordembedcolor": "example", "discordembedtitle": "example", "discordembeddesc": "example", "discordembedlogo": "example", "registeractive": "example", "langchanger": "example", "disabledashboardoverview": "example", "disablenodecpu": "example", "disablestylechanger": "example", "disabletosdisplay": "example", "disablecustomerarea": "example", "disablenovnc": "example", "displaygamechanger": "example", "enableapikeys": "example", "externalapidoc": "example", "enableapidocs": "example", "payment_enabled": "example", "payment_mollie_apikey": "example", "payment_paypal_clientid": "example", "payment_paypal_clientsecret": "example", "payment_paypal_mode": "example", "subreseller": "example", "script": "example", "css": "example", "themecolor": "example", "slidercolor": "example", "kvmconfiguratoricon": "example", "kvmextraipv4price": "10", "kvmextratrafficprice": "10", "dediextraipv4price": "10", "dediextratrafficprice": "10", "taxamount": "10", "invoice_notes": "example", "invoice_address": "example", "invoice_color": "example", "setting_setinvoicedata": "example", "setting_password_reset": "example", "supportticketsystem": "example", "invoice_logo": "example", "payment_stripe_apikey": "example", "payment_stripe_webhook_secret": "example", "payment_stripe_apikey_public": "example", "mailserver_server": "example", "mailserver_port": "10", "mailserver_user": "example", "mailserver_password": "example", "mailserver_replyto": "example", "mailserver_loginname": "example", "mailserver_displayname": "example", "coinpayments_private_key": "example", "coinpayments_public_key": "example", "coinpayments_merchant_id": "example", "coingate_auth_token": "example", "coingate_environment": "live", "supportdisplayname": "example", "graph_color_1": "example", "graph_color_2": "example", "orderswithoutpaying": "example", "accessmanager": "example", "ordernewproductpage": "example", "supportsignature": "example", "oauth_discord_secret": "example", "oauth_discord_id": "example", "oauth_github_id": "example", "oauth_github_secret": "example", "loginconfirm": "example", "enable_eu_tax": "example", "announcement": "example" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/stats": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerInterfaceStatsResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/orders": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "start", "in": "query", "description": " ", "required": false, "schema": { "type": "string", "example": "0" } }, { "name": "search", "in": "query", "description": " ", "required": false, "schema": { "type": "string", "example": "test" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerOrderListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/orders/export/csv": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerOrderExportCsvResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/orders/{orderid}/forcefinish": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "orderid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/orders/{orderid}/finishorder": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "orderid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/subresellers": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerSubResellersResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/payments/list": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerPaymentListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/payments/add": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "method": { "type": "string", "example": "method" }, "displayname": { "type": "string", "example": "displayname" }, "fee": { "type": "integer", "example": "10" } }, "type": "object", "example": { "method": "method", "displayname": "displayname", "fee": "10" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/payments/{paymentid}": { "delete": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "paymentid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/payments/available": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerAvailablePaymentsResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/product/{productid}": { "delete": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "productid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/kvm/package": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerKvmPackagesResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "package": { "type": "string", "example": "package" }, "displayname": { "type": "string", "example": "displayname" }, "price": { "type": "integer", "example": "price" }, "ordernewproductpage": { "type": "string", "example": "ordernewproductpage" }, "oslist": { "type": "string", "example": "oslist" } }, "type": "object", "example": { "package": "package", "displayname": "displayname", "price": "price", "ordernewproductpage": "ordernewproductpage", "oslist": "oslist" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/kvm/oslist": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerOsListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "displayname": { "type": "string", "example": "displayname" }, "oslist": { "type": "string", "example": "oslist" } }, "type": "object", "example": { "displayname": "displayname", "oslist": "oslist" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/kvm/oslist/default": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerOsListDefaultResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/kvm/oslist/{listid}": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "listid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "displayname": { "type": "string", "example": "displayname" }, "oslist": { "type": "string", "example": "oslist" } }, "type": "object", "example": { "displayname": "displayname", "oslist": "oslist" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "delete": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "listid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/kvm/package/{packageid}": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "packageid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "displayname": { "type": "string", "example": "displayname" }, "price": { "type": "integer", "example": "10" }, "ordernewproductpage": { "type": "string", "example": "ordernewproductpage" }, "oslist": { "type": "string", "example": "oslist" } }, "type": "object", "example": { "displayname": "displayname", "price": "10", "ordernewproductpage": "ordernewproductpage", "oslist": "oslist" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/nextcloud/package": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerNextcloudPackagesResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "package": { "type": "string", "example": "package" }, "displayname": { "type": "string", "example": "displayname" }, "price": { "type": "integer", "example": "10" }, "ordernewproductpage": { "type": "integer", "example": "10" } }, "type": "object", "example": { "package": "package", "displayname": "displayname", "price": "10", "ordernewproductpage": "10" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/nextcloud/package/{packageid}": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "packageid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "displayname": { "type": "string", "example": "displayname" }, "price": { "type": "integer", "example": "10" }, "ordernewproductpage": { "type": "string", "example": "ordernewproductpage" } }, "type": "object", "example": { "displayname": "displayname", "price": "10", "ordernewproductpage": "ordernewproductpage" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/objectstorage/package": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerObjectstoragePackagesResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "package": { "type": "string", "example": "package" }, "displayname": { "type": "string", "example": "displayname" }, "price": { "type": "integer", "example": "price" }, "ordernewproductpage": { "type": "string", "example": "ordernewproductpage" } }, "type": "object", "example": { "package": "package", "displayname": "displayname", "price": "price", "ordernewproductpage": "ordernewproductpage" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/objectstorage/package/{packageid}": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "packageid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "displayname": { "type": "string", "example": "displayname" }, "price": { "type": "integer", "example": "10" }, "ordernewproductpage": { "type": "string", "example": "ordernewproductpage" } }, "type": "object", "example": { "displayname": "displayname", "price": "10", "ordernewproductpage": "ordernewproductpage" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/dedicated/package": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerDedicatedPackagesResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "package": { "type": "string", "example": "package" }, "displayname": { "type": "string", "example": "displayname" }, "price": { "type": "integer", "example": "10" }, "setup": { "type": "integer", "example": "10" }, "ordernewproductpage": { "type": "string", "example": "ordernewproductpage" } }, "type": "object", "example": { "package": "package", "displayname": "displayname", "price": "10", "setup": "10", "ordernewproductpage": "ordernewproductpage" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/dedicated/package/{packageid}": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "packageid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "displayname": { "type": "string", "example": "displayname" }, "price": { "type": "integer", "example": "price" }, "setup": { "type": "integer", "example": "setup" }, "ordernewproductpage": { "type": "string", "example": "ordernewproductpage" } }, "type": "object", "example": { "displayname": "displayname", "price": "price", "setup": "setup", "ordernewproductpage": "ordernewproductpage" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/dedicated/package/upgrades/{packageid}": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "packageid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerDedicatedPackageUpgradesResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "packageid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "package": { "type": "string", "example": "package" }, "price": { "type": "integer", "example": "price" } }, "type": "object", "example": { "package": "package", "price": "price" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "delete": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "packageid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/dedicated/package/upgrades/{packageid}/available": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "packageid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerDedicatedPackageUpgradesListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/invoice/{orderid}": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "orderid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerSingleInvoiceResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/email/templates": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerEmailTemplatesResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/email/template/{templateid}": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "templateid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "title": { "type": "string", "example": "title" }, "html": { "type": "string", "example": "html" }, "status": { "type": "string", "example": "status" } }, "type": "object", "example": { "title": "title", "html": "html", "status": "status" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/email/template/{templateid}/sendtestmail": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "templateid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/email/testconnection": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/language": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerLanguagesResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "displayname": { "type": "string", "example": "displayname" }, "baselang": { "type": "string", "example": "baselang" } }, "type": "object", "example": { "displayname": "displayname", "baselang": "baselang" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/language/{languageid}": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "languageid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerLanguageResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "languageid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "displayname": { "type": "string", "example": "displayname" }, "baselang": { "type": "string", "example": "baselang" } }, "type": "object", "example": { "displayname": "displayname", "baselang": "baselang" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/language/{languageid}/string": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "languageid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "key": { "type": "string", "example": "key" }, "value": { "type": "string", "example": "value" } }, "type": "object", "example": { "key": "key", "value": "value" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/language/{languageid}/export": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "languageid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerLanguageExportResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/language/{languageid}/import": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "languageid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "data": { "type": "string", "example": "data" } }, "type": "object", "example": { "data": "data" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/service/{serviceid}/unblockmailports": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/service/{serviceid}/lock": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "reason": { "type": "string", "example": "reason" } }, "type": "object", "example": { "reason": "reason" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/service/{serviceid}/unlock": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/service/{serviceid}/changerenewprice": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "price": { "type": "integer", "example": "10" } }, "type": "object", "example": { "price": "10" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/user/{userid}/lock": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/user/{userid}/unlock": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/user/{userid}/loginasuser": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/user/{userid}/credit": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "credit": { "type": "integer", "example": "10" } }, "type": "object", "example": { "credit": "10" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/user/{userid}/gdpr": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/user/{userid}/permissions": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerUserPermissionsResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "permissions": { "type": "string", "example": "permissions" } }, "type": "object", "example": { "permissions": "permissions" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/user/{userid}/password": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "password": { "type": "string", "example": "password" } }, "type": "object", "example": { "password": "password" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/support": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "status", "in": "query", "description": " ", "required": false, "schema": { "type": "string", "example": "status" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerTicketListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/support/statuslist": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerTicketStatusListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/support/templatelist": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerTicketTemplateListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "title": { "type": "string", "example": "title" }, "text": { "type": "string", "example": "text" }, "lang": { "type": "string", "example": "lang" } }, "type": "object", "example": { "title": "title", "text": "text", "lang": "lang" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/support/templatelist/{templateid}": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "templateid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "title": { "type": "string", "example": "title" }, "text": { "type": "string", "example": "text" }, "lang": { "type": "string", "example": "lang" } }, "type": "object", "example": { "title": "title", "text": "text", "lang": "lang" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "delete": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "templateid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/support/{ticketid}": { "get": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "ticketid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ResellerTicketDetailsResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/support/{ticketid}/changestatus": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "ticketid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "status": { "type": "string", "example": "status" } }, "type": "object", "example": { "status": "status" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/reseller/interface/{interfaceid}/support/{ticketid}/answer": { "post": { "tags": [ "reseller" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "interfaceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "ticketid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "text": { "type": "string", "example": "text" } }, "type": "object", "example": { "text": "text" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/resetpassword": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nKVM Server, Webspace", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/hostname": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n5 requests every 900 seconds\n## Supported Services\nKVM Server", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "hostname": { "type": "string", "example": "server.example.com" }, "reset": { "type": "integer", "example": 0 } }, "type": "object", "example": { "hostname": "server.example.com", "reset": 0 } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/access": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n10 requests every 900 seconds\n## Supported Services\nAll service types", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "key": { "type": "string", "example": "DO00EXAMPLEKEY123" }, "permissions": { "type": "string", "example": "read" }, "name": { "type": "string", "example": "my-bucket" } }, "type": "object", "example": { "key": "DO00EXAMPLEKEY123", "permissions": "read", "name": "my-bucket" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/plesklogin": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nWebspace", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServicePleskLoginResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/note/ip": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n5 requests every 900 seconds\n## Supported Services\nAll service types", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "ip": { "type": "string", "example": "192.0.2.1" }, "note": { "type": "string", "example": "webserver" } }, "type": "object", "example": { "ip": "192.0.2.1", "note": "webserver" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/note/ipv6": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n5 requests every 900 seconds\n## Supported Services\nAll service types", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "ip": { "type": "string", "example": "2001:db8::1" }, "note": { "type": "string", "example": "My note" } }, "type": "object", "example": { "ip": "2001:db8::1", "note": "My note" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/tpm/add": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n5 requests every 900 seconds\n## Supported Services\nKVM Server", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/tpm/remove": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n5 requests every 900 seconds\n## Supported Services\nKVM Server", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/uefi/add": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n5 requests every 900 seconds\n## Supported Services\nKVM Server", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/uefi/remove": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n5 requests every 900 seconds\n## Supported Services\nKVM Server", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/ip/{ip}": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nAll service types", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "ip", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "2001:db8::1" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "rdns": { "type": "string", "example": "example.com" } }, "type": "object", "example": { "rdns": "example.com" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "delete": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nAll service types", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "ip", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "2001:db8::1" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/prot/status": { "post": { "tags": [ "service" ], "description": "\nSets the DDoS protection mode of one IPv4 address of the service:\n\n- `dynamic` (default): SmartMitigate only switches on once an attack is detected. Existing TCP connections to the address drop at that moment.\n- `permanent`: SmartMitigate is always on. Open TCP connections stay up during an attack. Null routes only work in this mode.\n\nA change can take a few minutes to take effect. The current mode is the `protstatus` field of every `ipv4` entry of `GET /service/{serviceid}/ip`.\n## Errors\n400 when `ip` or `status` is missing, 403 when `status` is not `dynamic` or `permanent` or when `ip` is not an IPv4 address of the service, 502 when AS203446 did not accept the change (the mode stays as it was).\n## Ratelimit\n5 requests every 900 seconds\n## Supported Services\nDedicated Server, KVM Server, Colocation, BYOIP (an IPv4 address of the prefix)", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "ip", "status" ], "properties": { "ip": { "description": "An IPv4 address of the service", "type": "string", "example": "192.0.2.1" }, "status": { "type": "string", "enum": [ "dynamic", "permanent" ], "example": "permanent" } }, "type": "object", "example": { "ip": "192.0.2.1", "status": "permanent" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/ip/{ip}/nullroute": { "post": { "tags": [ "service" ], "description": "\nSets a null route for one IPv4 address of the service: all incoming traffic to the address is dropped until the null route is removed. A change is not applied instantly. The current state is the `nullroute` object of every `ipv4` entry of `GET /service/{serviceid}/ip`.\n\nNull routes only work if the DDoS protection status of the address is `permanent` (`POST /service/{serviceid}/prot/status`).\n## Errors\n400 when the address already has a null route, 502 when the change could not be applied.\n## Ratelimit\n10 requests every 900 seconds (shared with DELETE)\n## Supported Services\nDedicated Server, KVM Server, Colocation, BYOIP (an IPv4 address of the prefix)", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "ip", "in": "path", "description": "An IPv4 address of the service", "required": true, "schema": { "type": "string", "example": "192.0.2.1" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "delete": { "tags": [ "service" ], "description": "\nRemoves the null route of one IPv4 address of the service. A null route set by our support (`nullroute.locked`) can only be removed by our support.\n## Errors\n403 when the null route was set by our support, 404 when the address has no null route, 502 when the change could not be applied.\n## Ratelimit\n10 requests every 900 seconds (shared with POST)\n## Supported Services\nDedicated Server, KVM Server, Colocation, BYOIP (an IPv4 address of the prefix)", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "ip", "in": "path", "description": "An IPv4 address of the service", "required": true, "schema": { "type": "string", "example": "192.0.2.1" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/hardware": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nDedicated Server, KVM Server, Webspace, Nextcloud, Colocation, Object Storage, ByoIP", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceHardwareResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/traffic": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nDedicated Server, KVM Server, Object Storage", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceTrafficHistoryResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/mods": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceModsResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/mod/delete": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "mod": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, "type": "object", "example": { "mod": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/mod/add": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "mod": { "type": "string", "example": "example" } }, "type": "object", "example": { "mod": "example" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/mod/list": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "query": { "type": "string", "example": "example" } }, "type": "object", "example": { "query": "example" } } } } }, "responses": { "200": { "$ref": "#/components/responses/ServiceModListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/sshkeys": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nKVM Server", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceSSHKeysResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nKVM Server", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "key": { "type": "string", "example": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ user@host" }, "displayname": { "type": "string", "example": "My Laptop" } }, "type": "object", "example": { "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ user@host", "displayname": "My Laptop" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/sshkeys/{sshkeyid}": { "delete": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nKVM Server", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "sshkeyid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/update": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nNextcloud", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/resetdata": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nNextcloud", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/version": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceVersionResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "version": { "type": "string", "example": "1.0.0" } }, "type": "object", "example": { "version": "1.0.0" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/cancelplannedbackup": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n5 requests every 900 seconds\n## Supported Services\nKVM Server", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/traffic/notify": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nKVM Server", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "status": { "type": "integer", "example": 1 } }, "type": "object", "example": { "status": 1 } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/attack/notify": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nAll service types", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "status": { "type": "integer", "example": 1 } }, "type": "object", "example": { "status": 1 } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/rescue": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nDedicated Server, KVM Server", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/forcestop": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/incidents": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nAll service types", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "start", "in": "query", "description": " ", "required": false, "schema": { "type": "integer", "example": 0 } }, { "name": "search", "in": "query", "description": " ", "required": false, "schema": { "type": "string", "example": "example" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceIncidentsResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/iso": { "delete": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nKVM Server", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/iso/custom/list": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nKVM Server", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceCustomIsoListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/iso/custom": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n20 requests every 900 seconds\n## Supported Services\nKVM Server", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "url": { "type": "string", "example": "https://example.com/custom.iso" } }, "type": "object", "example": { "url": "https://example.com/custom.iso" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/iso/custom/{isoid}/mount": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n100 requests every 900 seconds\n## Supported Services\nKVM Server", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "isoid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/iso/custom/{isoid}": { "delete": { "tags": [ "service" ], "description": "\n## Ratelimit\n100 requests every 900 seconds\n## Supported Services\nKVM Server", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "isoid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/livedata": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nKVM Server", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceLiveDataResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/websockettoken": { "get": { "tags": [ "service" ], "description": "\nReturns a wings websocket token plus socket url for the gameserver console. The token grants interactive console access including command execution and power control for its lifetime, regardless of the HTTP method used to obtain it. Because of that this endpoint counts as a write: read-only API keys are rejected with HTTP 403 (error code apikeyreadonlyconsole), and assigning this route to a scoped API key grants the key full console control on the service, even without the start/stop/restart scopes. The cansendcommand flag in the response is informational for UIs and does not restrict the token itself.\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver\n## Errors\n400 | notsupported => This function is not supported.\n403 | apikeyreadonlyconsole => This API key is read-only and can not request console access, because the console allows command execution", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceWebsocketTokenResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/novncdata": { "get": { "tags": [ "service" ], "description": "\nReturns the connection data (short lived Proxmox VNC ticket, port, node and password) for the noVNC console of the KVM server. The ticket grants interactive graphical console access for its lifetime, regardless of the HTTP method used to obtain it. Because of that this endpoint counts as a write: read-only API keys are rejected with HTTP 403 (error code apikeyreadonlyconsole), and assigning this route to a scoped API key grants the key console access on the service.\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nKVM Server\n## Errors\n400 | notsupported => This function is not supported.\n403 | apikeyreadonlyconsole => This API key is read-only and can not request console access, because the console allows command execution", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceNovncDataResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/gamechanger": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceGameListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nGameserver\n## Errors\n400 | notsupported => This function is not supported.\n400 | lowpackage => The current package is too small for the selected game.\n500 | gameservercreatefailed => The game panel could not create the new server.", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "game": { "type": "string", "example": "minecraft" }, "version": { "type": "string", "example": "1.20.1" } }, "type": "object", "example": { "game": "minecraft", "version": "1.20.1" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/logs": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceLogFilesResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/logs/file": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "file", "in": "query", "description": " ", "required": true, "schema": { "type": "string", "example": "latest.log" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceLogFileResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/buckets": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nObject Storage", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceBucketListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n20 requests every 900 seconds\n## Supported Services\nObject Storage", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "name": { "type": "string", "example": "my-bucket" } }, "type": "object", "example": { "name": "my-bucket" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/buckets/{name}": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nObject Storage", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "name", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "my-bucket" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceBucketDetailsResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "delete": { "tags": [ "service" ], "description": "\n## Ratelimit\n20 requests every 900 seconds\n## Supported Services\nObject Storage", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "name", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "my-bucket" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/buckets/{name}/requests": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nObject Storage", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "name", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "my-bucket" } }, { "name": "start", "in": "query", "description": " ", "required": false, "schema": { "type": "integer", "example": "0" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceBucketRequestsResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/buckets/{name}/traffic": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nObject Storage", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "name", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "my-bucket" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceBucketTrafficResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/buckets/{name}/requeststatistics": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nObject Storage", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "name", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "my-bucket" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceBucketRequestStatisticsResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/buckets/{name}/files": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nObject Storage", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "name", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "my-bucket" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/keys": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nObject Storage", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nObject Storage", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/keys/{key}": { "delete": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nObject Storage", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "key", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "DO00EXAMPLEKEY123" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/actionlogs": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nAll service types", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceActionLogsResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/fav": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nAll service types", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "delete": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nAll service types", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/settings/game": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceGameSettingsResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "key": { "type": "string", "example": "slots" }, "value": { "type": "string", "example": "16" } }, "type": "object", "example": { "key": "slots", "value": "16" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/settings/variable": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nNextcloud", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "variable": { "type": "string", "example": "hostname" }, "value": { "type": "string", "example": "my-server" } }, "type": "object", "example": { "variable": "hostname", "value": "my-server" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/configs": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceGameConfigsResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/configs/config": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "file", "in": "query", "description": " ", "required": true, "schema": { "type": "string", "example": "server.properties" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceGameConfigResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "file": { "type": "string", "example": "server.properties" }, "data": { "type": "string", "example": "max-players=20" } }, "type": "object", "example": { "file": "server.properties", "data": "max-players=20" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/files": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "directory": { "type": "string", "example": "/home/user" } }, "type": "object", "example": { "directory": "/home/user" } } } } }, "responses": { "200": { "$ref": "#/components/responses/ServiceFilesResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/file": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "filepath", "in": "query", "description": " ", "required": true, "schema": { "type": "string", "example": "/home/user/file.txt" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceFileContentResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "file": { "type": "string", "example": "/home/container/server.properties" }, "data": { "type": "string", "example": "max-players=20" } }, "type": "object", "example": { "file": "/home/container/server.properties", "data": "max-players=20" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/file/download": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "filepath", "in": "query", "description": " ", "required": true, "schema": { "type": "string", "example": "/home/user/file.txt" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceFileDownloadResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/file/unzip": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "file", "in": "query", "description": " ", "required": true, "schema": { "type": "string", "example": "archive.zip" } }, { "name": "path", "in": "query", "description": " ", "required": true, "schema": { "type": "string", "example": "/home/user" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/file/getuploadlink": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/activitylogs": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceActivityLogsResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/networkdata": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceNetworkDataResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/extraport": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver\n## Errors\n400 | notsupported => This function is not supported.\n400 | portextralimit5reached => This service already has the maximum number of extra ports.\n400 | extraportfailed => The game panel could not assign another port to this server.", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/file/delete": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "filepath": { "type": "string", "example": "/home/user/file.txt" } }, "type": "object", "example": { "filepath": "/home/user/file.txt" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/sftp/reset": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n6 requests every 120 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/db/reset": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n6 requests every 120 seconds\n## Supported Services\nGameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/cputype": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nKVM Server", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "cputype": { "type": "string", "example": "host" } }, "type": "object", "example": { "cputype": "host" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/uplink": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nKVM Server", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "uplink": { "type": "integer", "example": 1000 } }, "type": "object", "example": { "uplink": 1000 } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/name": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nAll service types", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "name": { "type": "string", "example": "my-service" } }, "type": "object", "example": { "name": "my-service" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/unlockports": { "post": { "tags": [ "service" ], "description": "Requests the unlock of the outgoing email port 25 (SMTP). The request opens a support ticket in the name of the account, containing the given email server, hostname and project, and answers 200 with the id of the created ticket in the field ticketid. The ports stay blocked until the request is reviewed and accepted; while the request is open, no further request can be created for the service. When the request is denied, a new request can be created.\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nKVM Server\n## Errors\n400 | notsupported => This function is not supported.\n403 | portUnlockNotAllowed => Your account is not allowed to request an email port unlock.\n406 | portsNotBlocked => The email ports of this service are not blocked.\n406 | portUnlockRequestPending => There is already an open email port unlock request for this service.\n406 | portUnlockDataToLong => The provided data is too long.", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "emailserver", "emailhostname", "project" ], "properties": { "emailserver": { "description": "The email server software that will be run (max 200 characters)", "type": "string", "example": "Postfix" }, "emailhostname": { "description": "The hostname the email server will send under (max 255 characters)", "type": "string", "example": "mail.example.com" }, "project": { "description": "The project the server is used for (max 2000 characters)", "type": "string", "example": "Transactional emails of my web shop example.com" } }, "type": "object", "example": { "emailserver": "Postfix", "emailhostname": "mail.example.com", "project": "Transactional emails of my web shop example.com" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "406": { "$ref": "#/components/responses/406" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/upgrade": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nKVM Server, Webspace, Gameserver, Nextcloud, Object Storage", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceUpgradeInfoResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nKVM Server, Webspace, Gameserver, Nextcloud, Object Storage", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "package": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" }, "credit": { "type": "integer", "example": "100" } }, "type": "object", "example": { "package": "e53490af-aa1a-4c01-8617-b5f77e7fd773", "credit": "100" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/downgrade": { "get": { "tags": [ "service" ], "description": "\nLists the packets of the same line the service can be downgraded to. The prorated remaining value of the current packet is converted into additional runtime (`extradays`). When `reinstall` is 1 the target packet has a smaller disk than currently provisioned, so applying the downgrade requires a full reinstallation of the server and deletes all of its backups.\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nKVM Server\n## Errors\n400 | notsupported => This function is not supported.", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceDowngradeInfoResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "service" ], "description": "\nDowngrades the service to a smaller packet of the same line. The downgrade is applied instantly and free of charge: the prorated remaining value of the current packet is converted into additional runtime at the new monthly price. When the target packet requires a reinstallation (see GET, `reinstall` = 1) the server name (`v` + proxmoxid) must be sent as `confirmname` together with `confirmdelete` = 1 and the server is recreated from its current image - all data is deleted. All backups of the server are deleted as well (locked ones included), because they hold the bigger disk and no longer fit the downgraded server. A downgrade without reinstallation keeps the data and the backups.\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nKVM Server\n## Errors\n400 | notsupported => This function is not supported.\n400 | mainMissingVariable => A needed variable is missing.\n406 | downgradeServiceCancelled => A cancelled service cannot be downgraded.\n406 | downgradePacketNotAvailable => The selected package is not available for a downgrade.\n406 | downgradeConfirmServerName => Please confirm the server name to start the downgrade with reinstallation.\n406 | downgradeConfirmDataDelete => Please confirm that all data and all backups of the server will be deleted to start the downgrade with reinstallation.", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "package": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" }, "confirmname": { "description": "Server name (v + proxmoxid), required when the selected packet needs a reinstallation", "type": "string", "example": "v1234" }, "confirmdelete": { "description": "1 = confirms that all data and all backups of the server are deleted, required when the selected packet needs a reinstallation", "type": "integer", "example": 1 } }, "type": "object", "example": { "package": "e53490af-aa1a-4c01-8617-b5f77e7fd773", "confirmname": "v1234", "confirmdelete": 1 } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "406": { "$ref": "#/components/responses/406" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/backup/rename": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nKVM Server", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "backup": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" }, "name": { "type": "string", "example": "my-backup" } }, "type": "object", "example": { "backup": "e53490af-aa1a-4c01-8617-b5f77e7fd773", "name": "my-backup" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/backup/{backupId}/lock": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nKVM Server, Gameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "backupId", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/backup/{backupId}/unlock": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nKVM Server, Gameserver", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "backupId", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/addons": { "get": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nDedicated Server, KVM Server, Gameserver, Object Storage", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceAddonsResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/addons/{addonid}/delete": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n10 requests every 900 seconds\n## Supported Services\nDedicated Server, KVM Server, Gameserver, Object Storage", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "addonid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/addons/list": { "get": { "tags": [ "service" ], "description": "\nLists the addons the service can book right now. For a KVM server the trafficreset entry is left out when the node the server runs on has the traffic reset addon switched off (kvmserver_node.trafficresetdisabled = 1).\n## Ratelimit\n30 requests every 60 seconds\n## Supported Services\nDedicated Server, KVM Server, Gameserver, Object Storage", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/ServiceAddonListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/addon/order": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nDedicated Server, KVM Server, Gameserver, Object Storage\n## Errors\n406 | trafficResetDisabled => The traffic reset addon is not available for this server. (KVM server on a node with kvmserver_node.trafficresetdisabled = 1)\n406 | hardsoldoutnoipsleft => No more IP addresses available. Try again later. (ipv4 addon on a KVM server: checked against the IP pool of the cluster the server runs in)", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "addon": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" }, "amount": { "type": "integer", "example": 1 }, "credit": { "type": "integer", "example": 1 }, "paymentmethod": { "type": "string", "example": "paypal" } }, "type": "object", "example": { "addon": "e53490af-aa1a-4c01-8617-b5f77e7fd773", "amount": 1, "credit": 1, "paymentmethod": "paypal" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "406": { "$ref": "#/components/responses/406" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/autorenew/credit": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nAll service types", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "delete": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nAll service types", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/service/{serviceid}/autorenew/payment": { "post": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nAll service types", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "paymentmethod": { "type": "string", "example": "paypal" } }, "type": "object", "example": { "paymentmethod": "paypal" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "delete": { "tags": [ "service" ], "description": "\n## Ratelimit\n30 requests every 900 seconds\n## Supported Services\nAll service types", "parameters": [ { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/tax": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n120 requests every 120 seconds", "responses": { "200": { "$ref": "#/components/responses/UserTaxCountriesResponse" }, "429": { "$ref": "#/components/responses/429" } } } }, "/user/session/{sessionid}": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n60 requests every 60 seconds", "parameters": [ { "name": "sessionid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserSessionInfoResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/session/{sessionid}/access/perms/{serviceid}": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n60 requests every 60 seconds", "parameters": [ { "name": "sessionid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "serviceid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserSessionAccessPermsResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/apikey/{apikeyid}": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n60 requests every 60 seconds", "parameters": [ { "name": "apikeyid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserApiKeyInfoResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/access/info": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n60 requests every 60 seconds", "responses": { "200": { "$ref": "#/components/responses/UserAccessInfoResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "lang": { "type": "string", "example": "lang" }, "ipcheck": { "type": "string", "example": "ipcheck" }, "permsessions": { "type": "string", "example": "permsessions" } }, "type": "object", "example": { "lang": "lang", "ipcheck": "ipcheck", "permsessions": "permsessions" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/style": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "style": { "type": "string", "example": "style" } }, "type": "object", "example": { "style": "style" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/servicelistorder": { "post": { "tags": [ "user" ], "description": "\nStores the custom display order of the service list (drag and drop order). Pass the service ids as array in the desired order. Only own active services are repositioned, unknown ids and shared services are skipped. The stored order is applied to GET /service/list, services without a stored position are listed last. Maximum 500 ids per request.\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "order[]": { "type": "array", "items": { "type": "string" }, "example": [ "baa7d0b3-0b56-4926-abce-c83ebb0d0677", "e53490af-aa1a-4c01-8617-b5f77e7fd773" ] } }, "type": "object", "example": { "order[]": [ "baa7d0b3-0b56-4926-abce-c83ebb0d0677", "e53490af-aa1a-4c01-8617-b5f77e7fd773" ] } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "406": { "$ref": "#/components/responses/406" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/twofa/init": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 900 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserTwoFaInitResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/twofa/finish": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 900 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "code": { "type": "string", "example": "code" } }, "type": "object", "example": { "code": "code" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/twofa/remove": { "post": { "tags": [ "user" ], "description": "Removes the 2FA of the account. Requires a current code from the authenticator app or one of the backup codes (a backup code is used up), a wrong or missing code leaves 2FA active. The remaining backup codes are deleted.\n## Ratelimit\n30 requests every 900 seconds\n## Errors\n403 | invalidtwofa => The 2FA code is not correct\n429 | twofalocked => Too many wrong 2FA codes. Please try again in 15 minutes. (5 wrong codes in a row lock all 2FA checks of the account: login, 2FA removal and passkey changes)", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "code": { "description": "Current code from the authenticator app or an unused backup code (required)", "type": "string", "example": "123456" } }, "type": "object", "example": { "code": "123456" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/changepassword": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Errors\n406 | changepasswordinvalidoldpassword => Your old password is not correct.\n406 | passwordRequirementLength => The password must be between 8 and 128 characters long.\n406 | passwordRequirementUpperCase => The password must contain at least one uppercase letter.\n406 | passwordRequirementLowerCase => The password must contain at least one lowercase letter.\n406 | passwordRequirementNumber => The password must contain at least one number.", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "oldpassword": { "type": "string", "example": "oldpassword" }, "newpassword": { "type": "string", "example": "newpassword" } }, "type": "object", "example": { "oldpassword": "oldpassword", "newpassword": "newpassword" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/credit/log": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserCreditLogResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/countrys": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserCountryListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/email/log": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserEmailLogResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/email/verify": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Errors\n400 | emailAlreadyVerified => Email address already verified.\n400 | emailVerifyBlocked => This email address can not be verified.\n400 | anotherEmailVerifyPending => Another email verification is already pending. Please check your email and click the verification link.", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/email/{emailid}": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "emailid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserEmailResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/credit/paybyinvoice/info": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserPayByInvoiceInfoResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/credit/paybyinvoice/list": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserPayByInvoiceListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/credit/paybyinvoice/{invoiceid}": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "invoiceid", "in": "path", "description": " ", "required": true, "schema": { "type": "integer", "example": "1042" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "name": { "type": "string", "example": "name" } }, "type": "object", "example": { "name": "name" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/credit/paybyinvoice/{invoiceid}/pay": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "invoiceid", "in": "path", "description": " ", "required": true, "schema": { "type": "integer", "example": "1042" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "paymentmethod": { "type": "string", "example": "paymentmethod" } }, "type": "object", "example": { "paymentmethod": "paymentmethod" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/credit/paybyinvoice/default/pay": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "paymentmethod": { "type": "string", "example": "paymentmethod" } }, "type": "object", "example": { "paymentmethod": "paymentmethod" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/credit/paybyinvoice": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "name": { "type": "string", "example": "name" } }, "type": "object", "example": { "name": "name" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/credit/paybyinvoice/transaction": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "invoice": { "type": "string", "example": "invoice" }, "transaction": { "type": "string", "example": "transaction" } }, "type": "object", "example": { "invoice": "invoice", "transaction": "transaction" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/credit/log/unpaid": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserCreditLogUnpaidResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/credit/donation/info": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserDonationInfoResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/credit/donation/link": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n10 requests every 900 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "link": { "type": "string", "example": "link" } }, "type": "object", "example": { "link": "link" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/credit/donation/list": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserLastDonationsResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/credit/add": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n10 requests every 900 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "amount": { "type": "integer", "example": "amount" } }, "type": "object", "example": { "amount": "amount" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/credit/donation/link/{donationlinkid}": { "delete": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "donationlinkid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/credit/donation/link/list": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserDonationLinkListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/orders": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "start", "in": "query", "description": " ", "required": false, "schema": { "type": "string", "example": "0" } } ], "responses": { "200": { "$ref": "#/components/responses/UserOrderListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/orders/{externalid}": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds\n## Externalid\nReturns the order that was created with the given externalid. Responds with an empty error and status 404 if no order with this externalid exists.", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "externalid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "my-shop-order-123" } } ], "responses": { "200": { "$ref": "#/components/responses/UserOrderExternalIdResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/invoice/{orderid}": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "orderid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserInvoiceResellerResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/dashboard": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserDashboardResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/notification/settings": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserNotificationSettingsResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/notification/settings/{type}": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "type", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "newsletter" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "email": { "type": "string", "example": "email" }, "discord": { "type": "string", "example": "discord" }, "webhook": { "type": "string", "example": "webhook" } }, "type": "object", "example": { "email": "email", "discord": "discord", "webhook": "webhook" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/stocknotify": { "get": { "tags": [ "user" ], "description": "Lists the active stock notification subscriptions of the user. Each entry references a KVM server packet; once the packet is back in stock, the notification is sent through the channels configured for the kvm_stock_notify notification type and the subscription is removed automatically.\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserStockNotifySubscriptionResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/stocknotify/{packetid}": { "post": { "tags": [ "user" ], "description": "Subscribes the user to a back-in-stock notification for the given KVM server packet. Subscribing to a packet twice is a no-op. The notification channels (email, discord, webhook) are taken from the kvm_stock_notify notification type settings.\n## Ratelimit\n30 requests every 60 seconds\n## Errors\n404 | stocknotifypacketnotfound => The requested packet does not exist.\n406 | stocknotifylimitreached => You have reached the maximum number of stock notifications.", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "packetid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "406": { "$ref": "#/components/responses/406" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "delete": { "tags": [ "user" ], "description": "Removes the back-in-stock notification subscription for the given KVM server packet. Removing a subscription that does not exist is a no-op.\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "packetid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/redeem": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n10 requests every 900 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "code": { "type": "string", "example": "code" } }, "type": "object", "example": { "code": "code" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/supportpin/new": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n10 requests every 900 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/invoicedata": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserInvoiceDataResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n10 requests every 3600 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "firstname": { "type": "string", "example": "firstname" }, "lastname": { "type": "string", "example": "lastname" }, "street": { "type": "string", "example": "street" }, "zip": { "type": "string", "example": "zip" }, "city": { "type": "string", "example": "city" }, "country": { "type": "string", "example": "country" }, "company": { "type": "string", "example": "company" } }, "type": "object", "example": { "firstname": "firstname", "lastname": "lastname", "street": "street", "zip": "zip", "city": "city", "country": "country", "company": "company" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/invoice/list": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserInvoiceListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/invoice/{invoiceid}": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "invoiceid", "in": "path", "description": " ", "required": true, "schema": { "type": "integer", "example": "1042" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/invoice/{invoiceid}/pay": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "invoiceid", "in": "path", "description": " ", "required": true, "schema": { "type": "integer", "example": "1042" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/api/info": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 900 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserApiInfoResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/api/key": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserApiKeysResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "user" ], "description": "\nCreates a new API key. With readonly=1 the key is created as read-only: it can only perform GET requests, any other request method is rejected with HTTP 403.\n\nWith the optional scopes parameter the key is created as a scoped key: it can only access the listed routes, every other request is rejected with HTTP 403 (error code apikeyscope). Each scope is an object with endpoint (a normalized route pattern exactly as returned by GET /user/{userid}/api/scoperoutes) and method (GET, POST, PUT or DELETE). Only routes from the scope route catalog can be assigned; in particular the API key, session, password, 2FA and email endpoints can never be assigned to a scoped key, so a scoped key can not extend its own permissions. An omitted or empty scopes parameter creates an unrestricted key.\n\nWith hostrivo=1 the key is created as a Hostrivo API key: it only authenticates when the request comes from the Hostrivo platform, any other source is rejected with HTTP 403 (error code apikeyhostrivoip), and it is exempt from the rate limits. The flag is set at creation and can not be changed afterwards. readonly and scopes apply to a Hostrivo API key like to any other key.\n## Ratelimit\n5 requests every 900 seconds\n## Errors\n406 | apikeyscopeinvalid => Invalid scopes format. Please provide a list of endpoint/method objects.\n406 | apikeyscopenotallowed => At least one scope references a route that can not be assigned to an API key.", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "required": false, "content": { "multipart/form-data": { "schema": { "properties": { "readonly": { "description": "1 = create the key as read-only (GET requests only), 0 or omitted = full access", "type": "integer", "example": "0" }, "scopes": { "description": "JSON array of scope objects ({\"endpoint\": ..., \"method\": ...}); when set and non-empty the key can only access these routes", "type": "string", "example": "[{\"endpoint\": \"/service/{id}/status\", \"method\": \"GET\"}]" }, "hostrivo": { "description": "1 = create the key as Hostrivo API key (usable from the Hostrivo platform only, not rate limited), 0 or omitted = normal key", "type": "integer", "example": "0" } }, "type": "object", "example": { "readonly": "0", "scopes": "[{\"endpoint\": \"/service/{id}/status\", \"method\": \"GET\"}]", "hostrivo": "0" } } } } }, "responses": { "200": { "$ref": "#/components/responses/UserApiKeyCreateResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/api/key/{apikey}": { "post": { "tags": [ "user" ], "description": "\nEdits an API key. All parameters are optional and an omitted parameter leaves the corresponding setting unchanged. With the description parameter the key description is replaced; an empty description removes it. With the optional scopes parameter the assigned scopes are replaced: a non-empty list makes the key scoped (only the listed routes are accessible), an empty list removes the scoping so the key is unrestricted again. Each scope is an object with endpoint (a normalized route pattern exactly as returned by GET /user/{userid}/api/scoperoutes) and method. Routes outside the scope route catalog (API key, session, password, 2FA and email endpoints) can never be assigned.\n## Ratelimit\n30 requests every 900 seconds\n## Errors\n406 | apikeydescriptiontoolong => The API key description is too long. Please enter a maximum of 100 characters.\n406 | apikeyscopeinvalid => Invalid scopes format. Please provide a list of endpoint/method objects.\n406 | apikeyscopenotallowed => At least one scope references a route that can not be assigned to an API key.", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "apikey", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "description": { "description": "new key description (max 100 characters), empty = remove the description, omitted = unchanged", "type": "string", "example": "description" }, "readonly": { "description": "1 = make the key read-only (GET requests only), 0 = full access, omitted = unchanged", "type": "integer", "example": "0" }, "scopes": { "description": "JSON array of scope objects ({\"endpoint\": ..., \"method\": ...}); non-empty = replace the assigned scopes, empty array = remove the scoping, omitted = unchanged", "type": "string", "example": "[{\"endpoint\": \"/service/{id}/status\", \"method\": \"GET\"}]" } }, "type": "object", "example": { "description": "description", "readonly": "0" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "delete": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 900 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "apikey", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/api/scoperoutes": { "get": { "tags": [ "user" ], "description": "\nLists every route that can be assigned to a scoped API key, as endpoint (normalized route pattern) plus HTTP method. The list is derived from the registered routes: only customer facing, authenticated endpoints are included. Admin, public and internal endpoints are excluded, and so is every route a scoped key could use to escalate its permissions (API key management, session, password, 2FA and email endpoints). Use the entries exactly as returned here as the scopes parameter when creating or editing an API key.\n\nNote: the console endpoints (/service/{id}/websockettoken and /service/{id}/novncdata) mint credentials that allow interactive console access including command execution. Assigning them grants the key full console control on the service even though their HTTP method is GET; read-only keys are always rejected on them.\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserApiScopeRoutesResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/affiliate": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserAffiliateLinkListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n5 requests every 900 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "name": { "type": "string", "example": "name" } }, "type": "object", "example": { "name": "name" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/affiliate/{affiliatelink}": { "delete": { "tags": [ "user" ], "description": "\n## Ratelimit\n5 requests every 900 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "affiliatelink", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/affiliate/info": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserAffiliateInfoResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/affiliate/list": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserAffiliateListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/sessions": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserSessionsResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "delete": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/sessions/{session}": { "delete": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "session", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/sshkeys": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserSSHKeysResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "displayname": { "type": "string", "example": "displayname" }, "key": { "type": "string", "example": "key" } }, "type": "object", "example": { "displayname": "displayname", "key": "key" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/sshkeys/{sshkey}": { "delete": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "sshkey", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/passkeys": { "get": { "tags": [ "user" ], "description": "Lists the passkeys (WebAuthn credentials) of the account. Public keys and credential ids are never returned.\n## Ratelimit\n30 requests every 60 seconds\n## Errors\n406 | passkeyNotAvailable => Passkeys are only available for Datalix accounts.", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserPasskeysResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "406": { "$ref": "#/components/responses/406" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] }, "post": { "tags": [ "user" ], "description": "Step 2 of adding a passkey: the browser's registration response. id, clientdatajson and attestationobject are the base64url encoded PublicKeyCredential.id, response.clientDataJSON and response.attestationObject. transports is the optional json list from response.getTransports(). Only ES256 (P-256) and RS256 credentials with user verification are accepted, attestation statements are not verified. Not available to api keys (session only).\n## Ratelimit\n30 requests every 900 seconds\n## Errors\n406 | passkeyNotAvailable => Passkeys are only available for Datalix accounts.\n406 | passkeyNameTooLong => The passkey name is too long (maximum 25 characters).\n406 | passkeyNameTooShort => The passkey name is too short (minimum 3 characters).\n406 | passkeyChallengeExpired => The passkey request has expired, please try again.\n406 | passkeyInvalidData => The passkey data could not be verified.\n406 | passkeyInvalidOrigin => The passkey was created for a different website.\n406 | passkeyUserVerificationRequired => The passkey must be protected by a PIN, fingerprint or face unlock.\n406 | passkeyUnsupportedKey => This passkey type is not supported (only ES256 and RS256 keys).\n406 | passkeyAlreadyRegistered => This passkey is already registered.\n406 | passkeyMaxReached => You have reached the maximum number of passkeys (10).", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "challengeid": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" }, "displayname": { "type": "string", "example": "MacBook Touch ID" }, "id": { "type": "string", "example": "base64url credential id" }, "clientdatajson": { "type": "string", "example": "base64url clientDataJSON" }, "attestationobject": { "type": "string", "example": "base64url attestationObject" }, "transports": { "type": "string", "example": "json list of transports, e.g. internal and hybrid" } }, "type": "object", "example": { "challengeid": "e53490af-aa1a-4c01-8617-b5f77e7fd773", "displayname": "MacBook Touch ID", "id": "base64url credential id", "clientdatajson": "base64url clientDataJSON", "attestationobject": "base64url attestationObject", "transports": "json list of transports" } } } } }, "responses": { "200": { "$ref": "#/components/responses/UserPasskeyRegisterResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "406": { "$ref": "#/components/responses/406" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] } }, "/user/{userid}/passkeys/options": { "post": { "tags": [ "user" ], "description": "Step 1 of adding a passkey: returns the PublicKeyCredentialCreationOptions for navigator.credentials.create(). The challenge is valid for 5 minutes and single use. With active 2FA a current code from the authenticator app is required (backup codes are not accepted), no challenge is created without it. Not available to api keys (session only).\n## Ratelimit\n30 requests every 900 seconds\n## Errors\n406 | passkeyNotAvailable => Passkeys are only available for Datalix accounts.\n406 | passkeyMaxReached => You have reached the maximum number of passkeys (10).\n403 | passkeyTwoFaRequired => Please enter your 2FA code to add or delete a passkey.\n403 | invalidtwofa => The 2FA code is not correct\n429 | twofalocked => Too many wrong 2FA codes. Please try again in 15 minutes.", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "code": { "description": "Current code from the authenticator app (required with active 2FA)", "type": "string", "example": "123456" } }, "type": "object", "example": { "code": "123456" } } } } }, "responses": { "200": { "$ref": "#/components/responses/UserPasskeyRegisterOptionsResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "406": { "$ref": "#/components/responses/406" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] } }, "/user/{userid}/passkeys/{passkey}": { "delete": { "tags": [ "user" ], "description": "Deletes a passkey. Logins with it are refused afterwards (passkeyUnknownCredential). With active 2FA a current code from the authenticator app is required (backup codes are not accepted), sent as form encoded request body. Not available to api keys (session only).\n## Ratelimit\n30 requests every 900 seconds\n## Errors\n404 | passkeyNotFound => Passkey not found.\n403 | passkeyTwoFaRequired => Please enter your 2FA code to add or delete a passkey.\n403 | invalidtwofa => The 2FA code is not correct\n429 | twofalocked => Too many wrong 2FA codes. Please try again in 15 minutes.", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "passkey", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "code": { "description": "Current code from the authenticator app (required with active 2FA)", "type": "string", "example": "123456" } }, "type": "object", "example": { "code": "123456" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] } }, "/user/passkey/login/options": { "post": { "tags": [ "user" ], "description": "Step 1 of a passkey login (no authentication): returns the PublicKeyCredentialRequestOptions for navigator.credentials.get(). allowCredentials is empty, the browser offers the discoverable credentials stored for the rp id. The challenge is valid for 5 minutes and single use.\n## Ratelimit\n60 requests every 3600 seconds", "responses": { "200": { "$ref": "#/components/responses/UserPasskeyLoginOptionsResponse" }, "429": { "$ref": "#/components/responses/429" } } } }, "/user/passkey/login": { "post": { "tags": [ "user" ], "description": "Step 2 of a passkey login (no authentication): the browser's assertion. id, clientdatajson, authenticatordata, signature and userhandle are the base64url encoded PublicKeyCredential.id and response fields. On success a session is created like after a password login (login activity + login mail), 2fa is not asked because the passkey itself requires user verification.\n## Ratelimit\n30 requests every 3600 seconds\n## Errors\n406 | passkeyChallengeExpired => The passkey request has expired, please try again.\n406 | passkeyInvalidData => The passkey data could not be verified.\n406 | passkeyInvalidOrigin => The passkey was created for a different website.\n406 | passkeyUserVerificationRequired => The passkey must be protected by a PIN, fingerprint or face unlock.\n403 | passkeyUnknownCredential => This passkey is not registered (it may have been deleted). Please log in with your password.\n403 | passkeyInvalidSignature => The passkey signature is invalid.\n403 | passkeyCounterMismatch => The passkey signature counter is invalid, the passkey may have been cloned. Please delete it and register a new one.\n403 | passkeyLoginNotPossible => This account can not log in with a passkey.", "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "challengeid": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" }, "id": { "type": "string", "example": "base64url credential id" }, "clientdatajson": { "type": "string", "example": "base64url clientDataJSON" }, "authenticatordata": { "type": "string", "example": "base64url authenticatorData" }, "signature": { "type": "string", "example": "base64url signature" }, "userhandle": { "type": "string", "example": "base64url userHandle (optional)" } }, "type": "object", "example": { "challengeid": "e53490af-aa1a-4c01-8617-b5f77e7fd773", "id": "base64url credential id", "clientdatajson": "base64url clientDataJSON", "authenticatordata": "base64url authenticatorData", "signature": "base64url signature", "userhandle": "base64url userHandle" } } } } }, "responses": { "200": { "$ref": "#/components/responses/UserPasskeyLoginResponse" }, "403": { "$ref": "#/components/responses/403" }, "406": { "$ref": "#/components/responses/406" }, "429": { "$ref": "#/components/responses/429" } } } }, "/user/{userid}/access/list": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserAccessListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/access/list/request": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserRequestAccessListResponse" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/access/{accessid}": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "accessid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "permissions": { "type": "string", "example": "permissions" }, "name": { "type": "string", "example": "name" } }, "type": "object", "example": { "permissions": "permissions", "name": "name" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] }, "delete": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "accessid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/access/{accessid}/accept": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "accessid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/{userid}/access/{accessid}/deny": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "userid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } }, { "name": "accessid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "api_key": [] }, { "bearer_auth": [] } ] } }, "/user/donation/link/{link}": { "get": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 900 seconds", "parameters": [ { "name": "link", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "a1b2c3d4" } } ], "responses": { "200": { "$ref": "#/components/responses/UserDonationLinkInfoResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } }, "/user/donation/link/{link}/start": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n2 requests every 900 seconds", "parameters": [ { "name": "link", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "a1b2c3d4" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "message": { "type": "string", "example": "message" }, "amount": { "type": "integer", "example": "amount" }, "paymentmethod": { "type": "string", "example": "paymentmethod" } }, "type": "object", "example": { "message": "message", "amount": "amount", "paymentmethod": "paymentmethod" } } } } }, "responses": { "200": { "$ref": "#/components/responses/UserDonationStartResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } }, "/user/donation/{donationid}/finish": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n10 requests every 900 seconds", "parameters": [ { "name": "donationid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/200" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } }, "/user/donation/{donationid}/status": { "post": { "tags": [ "user" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "donationid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/UserDonationStatusResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } }, "/version": { "get": { "tags": [ "version" ], "description": "\nReturns the current server time and build information of the deployed backend (build time, git commit, branch and CI pipeline). No authentication required.\n\n## Ratelimit\n60 requests every 60 seconds", "responses": { "200": { "$ref": "#/components/responses/VersionResponse" }, "429": { "$ref": "#/components/responses/429" } } } }, "/webspace/line/{line}": { "get": { "tags": [ "webspace" ], "description": "\n## Ratelimit\n120 requests every 30 seconds", "parameters": [ { "name": "line", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "ge" } } ], "responses": { "200": { "$ref": "#/components/responses/WebspaceLineResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } }, "/webspace/packet/{packetid}": { "get": { "tags": [ "webspace" ], "description": "\n## Ratelimit\n30 requests every 60 seconds", "parameters": [ { "name": "packetid", "in": "path", "description": " ", "required": true, "schema": { "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" } } ], "responses": { "200": { "$ref": "#/components/responses/WebspacePacketInfoResponse" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } } } } }, "components": { "schemas": { "DedicatedLineResponse": { "properties": { "id": { "description": "Packet UUID (primary key)", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "line": { "description": "Dedicated line identifier this packet belongs to", "type": "string", "example": "epyc" }, "displayname": { "description": "Display name of the packet", "type": "string", "example": "AMD EPYC 7282" }, "cpu": { "description": "CPU description", "type": "string", "example": "AMD EPYC 7282" }, "cores": { "description": "Number of CPU cores", "type": "string", "example": "16" }, "threads": { "description": "Number of CPU threads", "type": "string", "example": "32" }, "ghzbase": { "description": "Base clock speed in GHz", "type": "string", "example": "2.8" }, "ghzturbo": { "description": "Turbo clock speed in GHz", "type": "string", "example": "3.2" }, "rambase": { "description": "Base RAM", "type": "string", "example": "64" }, "rammax": { "description": "Maximum RAM", "type": "string", "example": "256" }, "diskbase": { "description": "Base disk size", "type": "string", "example": "480" }, "diskmax": { "description": "Maximum disk size", "type": "string", "example": "4000" }, "uplink": { "description": "Network uplink description", "type": "string", "example": "1 Gbit" }, "traffic": { "description": "Included traffic", "type": "string", "example": "unlimited" }, "location": { "description": "Name of the data center: the location of the package's ip pool (interface.location.name); null without a pool", "type": "string", "example": "NorthC FR3" }, "country": { "description": "Country of that location (interface.location.country)", "type": "string", "example": "Deutschland" }, "locationname": { "description": "Name of the data center, same as location (interface.location.name); null without a pool", "type": "string", "example": "NorthC FR3", "nullable": true }, "mitigation": { "description": "DDoS mitigation of that location (interface.location.mitigation)", "type": "string", "example": "AS203446 SmartMitigate", "nullable": true }, "price": { "description": "Monthly price (numeric)", "type": "number", "format": "float", "example": "49.99" }, "stock": { "description": "1 when the packet can be ordered, 0 when it is sold out", "type": "integer", "example": "1" }, "cpubench": { "description": "CPU benchmark score", "type": "integer", "example": "25000" }, "mainboard": { "description": "Mainboard UUID (nullable)", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440111" }, "setup": { "description": "Setup fee (numeric, nullable)", "type": "number", "format": "float", "example": "0" }, "cpuid": { "description": "CPU UUID (nullable)", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440222" }, "uplinkid": { "description": "Uplink UUID (nullable)", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440333" }, "locationstring": { "description": "Code of that location (interface.location.code); null without a pool", "type": "string", "example": "northc" }, "countrycode": { "description": "Country of the data center as ISO 3166-1 alpha-2 code, upper case (interface.location.countrycode)", "type": "string", "example": "DE" }, "city": { "description": "City of the data center as a proper name (interface.location.city)", "type": "string", "example": "Frankfurt am Main" }, "cpucount": { "description": "Number of CPUs (default 1)", "type": "integer", "example": "1" }, "deploytime": { "description": "Deploy time in days (default 7)", "type": "integer", "example": "7" } }, "type": "object" }, "DedicatedOsInfoResponse": { "properties": { "id": { "description": "UUID primary key of the OS entry (dedi_os.id)", "type": "string", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "active": { "description": "Whether the OS is active/selectable (int4); query always filters active=1", "type": "integer", "example": "1" }, "displayname": { "description": "Human-readable OS display name", "type": "string", "example": "Debian 12" }, "osystem": { "description": "Operating system name", "type": "string", "example": "Debian" }, "distro": { "description": "Distribution identifier (nullable)", "type": "string", "example": "debian-12" }, "easydcimid": { "description": "EasyDCIM OS template id (int4, nullable)", "type": "integer", "example": "42" }, "type": { "description": "OS type; non-windows servers exclude type=windows (nullable)", "type": "string", "example": "linux" }, "tenantos": { "description": "TenantOS OS identifier (nullable)", "type": "string", "example": "deb12" }, "sort": { "description": "Sort order; results ordered by sort ASC (int4, nullable)", "type": "integer", "example": "10" } }, "type": "object" }, "DedicatedOsPacketResponse": { "properties": { "id": { "description": "UUID primary key of the OS entry (dedi_os.id).", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "active": { "description": "Active flag (int4). The list is filtered to active=1.", "type": "integer", "example": "1" }, "displayname": { "description": "Human-readable OS name.", "type": "string", "example": "Ubuntu 22.04" }, "osystem": { "description": "Operating system identifier.", "type": "string", "example": "ubuntu" }, "distro": { "description": "Distribution identifier (nullable).", "type": "string", "example": "ubuntu-22.04" }, "easydcimid": { "description": "EasyDCIM OS template id (int4, nullable).", "type": "integer", "example": "42" }, "type": { "description": "OS type (nullable).", "type": "string", "example": "linux" }, "tenantos": { "description": "TenantOS template identifier (nullable).", "type": "string", "example": "tmpl-ubuntu" }, "sort": { "description": "Sort order (int4, nullable); list ordered by sort ASC.", "type": "integer", "example": "10" } }, "type": "object" }, "DedicatedPacketInfoResponse": { "properties": { "data": { "description": "The dedi_packet table row via getData(). Columns from interface.dedi_packet MINUS excluded created_on, sort, stockmode and poolid; location, country, countrycode, city, locationstring (location code), locationname and mitigation come from the location of the package's ip pool. Members: id(string,uuid), line(string), displayname(string), cpu(string), cores(string), threads(string), ghzbase(string), ghzturbo(string), rambase(string), rammax(string), diskbase(string), diskmax(string), uplink(string), traffic(string), location(string), country(string), price(number/numeric, nullable), stock(integer, 1 when the packet can be ordered, 0 when it is sold out), cpubench(integer, nullable), mainboard(string,uuid, nullable), setup(number/numeric, nullable), cpuid(string,uuid, nullable), uplinkid(string,uuid, nullable), locationstring(string, nullable), cpucount(integer, default 1), deploytime(integer, default 7), countrycode(string, ISO 3166-1 alpha-2 upper case, default DE), city(string, default Frankfurt am Main). convertTimeToUnix is a no-op (empty field list).", "type": "object" }, "optionsram": { "description": "Array built from explicit literals in getRamData() over DedicatedPacketRam rows. Each item: display(string), price(number, from dedi_packet_ram.price), total(integer = count * ram.gb), id(string,uuid).", "type": "array", "items": { "type": "object" } }, "optionsdiskmaxdisk": { "description": "Mainboard slot counts: SATA(integer, sataslots), M2(integer, m2slots), 'M.2'(integer, m2slots), U2(integer, u2slots).", "type": "object" }, "optionsdiskdefault": { "description": "Default disks (DedicatedPacketDisk rows with default=1), explicit literals. Each item: display(string), price(number, from disk->getPrice()), type(string), count(integer), id(string,uuid).", "type": "array", "items": { "type": "object" } }, "optionsdiskextra": { "description": "Extra disks (default!=1), grouped by disktype then flattened. Each item: display(string), type(string), disktype(string), price(number, disk->getPrice()), id(string,uuid).", "type": "array", "items": { "type": "object" } }, "optionsusbmax": { "description": "Mainboard usbslots count.", "type": "integer", "example": "2" }, "optionsusblist": { "description": "USB options (DedicatedPacketUsb rows), explicit literals. Each item: display(string), type(string), price(number, from dedi_packet_usb.price), id(string,uuid).", "type": "array", "items": { "type": "object" } } }, "type": "object" }, "DedicatedSaleCustomOsResponse": { "properties": { "id": { "description": "UUID primary key of the OS entry (dedi_os.id).", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "active": { "description": "Whether the OS is active (filtered to 1 in the query).", "type": "integer", "example": "1" }, "displayname": { "description": "Human-readable display name of the operating system.", "type": "string", "example": "Ubuntu 22.04 LTS" }, "osystem": { "description": "Operating system identifier.", "type": "string", "example": "ubuntu" }, "distro": { "description": "Distribution identifier (nullable).", "type": "string", "example": "ubuntu-2204" }, "easydcimid": { "description": "EasyDCIM template id (nullable).", "type": "integer", "example": "42" }, "type": { "description": "OS type, e.g. 'linux' or 'windows' (nullable). Windows entries only included when the dedicated server allows windows.", "type": "string", "example": "linux" }, "tenantos": { "description": "TenantOS template identifier (nullable).", "type": "string", "example": "ubuntu_22_04" }, "sort": { "description": "Sort order; results ordered by this ascending (nullable).", "type": "integer", "example": "10" } }, "type": "object" }, "DedicatedSaleCustomResponse": { "properties": { "id": { "description": "dedi_main.id (uuid). The dedicated server id.", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "mainboard": { "description": "getMainboardInfo(): array of mainboard rows, each = DedicatedMainboard->getMainboardData() (dedi_mainboard columns).", "type": "array", "items": { "type": "object" } }, "location": { "description": "dedi_main.location (varchar).", "type": "string", "example": "Equinix - Frankfurt am Main - Germany" }, "cpu": { "description": "getCpuInfo(): object keyed by CPU slotid, each value = DedicatedCpu->getCpuData() (dedi_cpu columns; includes cores, threads, ghzbase, ghzturbo, displayname).", "type": "object" }, "ram": { "description": "getRamInfo(): object keyed by RAM slotid, each value = DedicatedMem->getMemData() (dedi_mem columns; includes gb, displayname).", "type": "object" }, "disk": { "description": "getDiskInfo(): object keyed by disk slotid, each value = DedicatedDisk->getDiskData() (dedi_disk columns; includes gb, displayname, disktype, producertype).", "type": "object" }, "uplink": { "description": "getUplinkInfo(): object keyed by uplink slotid, each value = DedicatedUplink->getUplinkData() (dedi_uplink columns; includes gbit).", "type": "object" }, "usb": { "description": "getUsbInfo(): object keyed by usb slotid, each value = DedicatedUsb->getUsbData() (dedi_usb columns).", "type": "object" }, "addoncard": { "description": "getAddonCardInfo(): object keyed by addoncard slotid, each value = DedicatedAddoncard->getAddoncardData() (dedi_addoncard columns).", "type": "object" }, "price": { "description": "dedi_main.price (numeric).", "type": "number", "format": "float", "example": "49.99" }, "traffic": { "description": "dedi_main.traffic (int4).", "type": "integer", "example": "100" }, "display": { "description": "getDisplayInfo(): aggregated summary object with sub-keys cpu{displayname,cores,threads,ghzbase,ghzturbo}, ram{totalram,displayname}, disks{displayname,type,totalstorage,ssdtype}, uplink{current,gbit}. When no CPU is present all leaf values are empty strings.", "type": "object" }, "sale": { "description": "dedi_main.sale (int4).", "type": "integer", "example": "0" }, "ipv4count": { "description": "dedi_main.ipv4count (int4).", "type": "integer", "example": "1" }, "hostname": { "description": "dedi_main.hostname (varchar).", "type": "string", "example": "srv01.example.com" } }, "type": "object" }, "DedicatedSaleInfoResponse": { "properties": { "id": { "description": "dedi_main.id (uuid). From Dedicated->getValue('id').", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "mainboard": { "description": "Array of mainboard objects, each = DedicatedMainboard->getMainboardData() (joined hardware_mainboard row getData() = table columns minus created_on/id). Inner keys come from the hardware_mainboard table (not fully enumerated here).", "type": "array", "items": { "type": "object" } }, "location": { "description": "dedi_main.location (varchar).", "type": "string", "example": "Equinix - Frankfurt am Main - Germany" }, "cpu": { "description": "Map keyed by slotid; each value = DedicatedCpu->getCpuData() (joined CPU hardware row getData()). Inner keys (e.g. cores, threads, ghzbase, ghzturbo, displayname) come from the CPU hardware table.", "type": "object" }, "ram": { "description": "Map keyed by slotid; each value = DedicatedMem->getMemData() (joined RAM hardware row getData()). Inner keys (e.g. gb, displayname) from the RAM hardware table.", "type": "object" }, "disk": { "description": "Map keyed by slotid; each value = DedicatedDisk->getDiskData() (joined disk hardware row getData()). Inner keys (e.g. gb, displayname, disktype, producertype) from the disk hardware table.", "type": "object" }, "uplink": { "description": "Map keyed by slotid; each value = DedicatedUplink->getUplinkData() (joined uplink hardware row getData()). Inner keys (e.g. gbit) from the uplink hardware table.", "type": "object" }, "usb": { "description": "Map keyed by slotid; each value = DedicatedUsb->getUsbData() (joined USB hardware row getData()).", "type": "object" }, "addoncard": { "description": "Map keyed by slotid; each value = DedicatedAddoncard->getAddoncardData() (joined addoncard hardware row getData()).", "type": "object" }, "price": { "description": "dedi_main.price (numeric).", "type": "number", "format": "float", "example": "49.99" }, "traffic": { "description": "dedi_main.traffic (int4).", "type": "integer", "example": "1" }, "display": { "description": "Locally-built literal aggregate from getDisplayInfo(). Always has keys cpu{displayname,cores,threads,ghzbase,ghzturbo}, ram{totalram,displayname}, disks{displayname,type,totalstorage,ssdtype}, uplink{current,gbit}. When no CPU present, all leaf values are empty strings. Leaf values for displayname/type/ssdtype/ghzbase etc. derive from hardware tables; numeric aggregates (cores/threads/totalram/totalstorage/current) computed locally.", "type": "object" }, "sale": { "description": "dedi_main.sale (int4).", "type": "integer", "example": "0" }, "ipv4count": { "description": "dedi_main.ipv4count (int4).", "type": "integer", "example": "1" }, "hostname": { "description": "dedi_main.hostname (varchar).", "type": "string", "example": "server01.example.com" } }, "type": "object" }, "DedicatedSaleResponse": { "properties": { "id": { "description": "dedi_main.id (uuid). Dedicated server sale entry id.", "type": "string", "example": "a1b2c3d4-0000-0000-0000-000000000000" }, "mainboard": { "description": "Array of hardware_mainboard rows (Dedicated::getMainboardInfo -> DedicatedMainboard::getMainboardData -> HardwareMainboard::getData). Each item = hardware_mainboard columns minus id/created_on: displayname(string), cpumax(int), ramslots(int), addoncardslots(int), sataslots(int), m2slots(int), u2slots(int), usbslots(int), networkslots1g(int), networkslots10g(int).", "type": "array", "items": { "type": "object" } }, "location": { "description": "dedi_main.location (varchar).", "type": "string", "example": "Equinix - Frankfurt am Main - Germany" }, "cpu": { "description": "Map keyed by dedi_cpu.slotid. Each value = hardware_cpu row (DedicatedCpu::getCpuData -> HardwareCpu::getData) minus id/created_on: displayname(string), ghzbase(string), ghzturbo(string), rammax(int), ramslots(int), cores(int), threads(int), maxcount(int).", "type": "object" }, "ram": { "description": "Map keyed by dedi_ram.slotid. Each value = hardware_ram row (DedicatedMem::getMemData -> HardwareMem::getData) minus id/created_on: displayname(string), mhz(string), gb(int).", "type": "object" }, "disk": { "description": "Map keyed by dedi_disk.slotid. Each value = hardware_disk row (DedicatedDisk::getDiskData -> HardwareDisk::getData) minus id/created_on: displayname(string), type(string), producertype(string), gb(int), disktype(string), defaultprice(number).", "type": "object" }, "uplink": { "description": "Map keyed by dedi_uplink.slotid. Each value = hardware_uplink row (DedicatedUplink::getUplinkData -> HardwareUplink::getData) minus id/created_on: displayname(string), gbit(int).", "type": "object" }, "usb": { "description": "Map keyed by dedi_usb.slotid. Each value = hardware_usb row (DedicatedUsb::getUsbData -> HardwareUsb::getData) minus id/created_on: displayname(string), type(string), gb(int).", "type": "object" }, "addoncard": { "description": "Map keyed by dedi_addoncard.slotid. Each value = hardware_addoncard row (DedicatedAddonCard::getAddoncardData -> HardwareAddonCard::getData) minus id/created_on: displayname(string).", "type": "object" }, "price": { "description": "dedi_main.price (numeric).", "type": "number", "format": "float", "example": "49.99" }, "traffic": { "description": "dedi_main.traffic (int4).", "type": "integer", "example": "1" }, "display": { "description": "Explicit-literal summary object built in Dedicated::getDisplayInfo. cpu:{displayname(string),cores(int),threads(int),ghzbase(string),ghzturbo(string)}, ram:{totalram(int),displayname(string)}, disks:{displayname(string, HTML with
),type(string),totalstorage(int),ssdtype(string)}, uplink:{current(int),gbit(int)}. When no CPU present, all leaf values are empty strings.", "type": "object" }, "sale": { "description": "dedi_main.sale (int4).", "type": "integer", "example": "1" }, "ipv4count": { "description": "dedi_main.ipv4count (int4).", "type": "integer", "example": "1" }, "hostname": { "description": "dedi_main.hostname (varchar, nullable).", "type": "string", "example": "server01.example.com" } }, "type": "object" }, "DisplayResponse": { "properties": { "backup": { "description": "Value", "type": "number", "format": "float", "example": "true" }, "cron": { "description": "Value", "type": "number", "format": "float", "example": "true" }, "hardware": { "description": "Value", "type": "number", "format": "float", "example": "true" }, "ip": { "description": "Value", "type": "number", "format": "float", "example": "true" }, "livedata": { "description": "Value", "type": "number", "format": "float", "example": "true" }, "novnc": { "description": "Value", "type": "number", "format": "float", "example": "true" }, "traffic": { "description": "Value", "type": "number", "format": "float", "example": "true" } }, "type": "object" }, "DonationPaymentLinkStart": { "properties": { "url": { "description": "Value", "type": "string", "example": "https://paymentprovider.com" } }, "type": "object" }, "DonationPaymentStatus": { "properties": { "done": { "description": "Value", "type": "string", "example": "true" } }, "type": "object" }, "Forbidden": { "properties": { "error": { "description": "This request is not authenticated", "type": "string" } }, "type": "object" }, "GameserverAllResponse": { "properties": { "id": { "description": "gameserver_game.id (uuid)", "type": "string", "example": "5f2b0c1e-1a2b-4c3d-8e9f-0123456789ab" }, "displayname": { "description": "gameserver_game.displayname (varchar)", "type": "string", "example": "Minecraft" }, "productinterfaceimage": { "description": "gameserver_game.productinterfaceimage (varchar)", "type": "string", "example": "minecraft.png" }, "created_on": { "description": "gameserver_game.created_on (timestamp). Note: getData() returns full $this->fields with no exclusion list, so created_on and id are included.", "type": "string", "example": "2024-01-15 12:00:00" }, "versionstring": { "description": "gameserver_game.versionstring (varchar, nullable)", "type": "string", "example": "1.20.4" }, "steamid": { "description": "gameserver_game.steamid (int4, nullable)", "type": "integer", "example": "730" }, "steamconnectstring": { "description": "gameserver_game.steamconnectstring (varchar, nullable)", "type": "string", "example": "connect 1.2.3.4:27015" }, "easyname": { "description": "gameserver_game.easyname (varchar, nullable)", "type": "string", "example": "minecraft" }, "status": { "description": "Overridden in factory: 1 if gameserver stock available, otherwise 0 (gameserver_game.status column is replaced).", "type": "integer", "example": "1" }, "portstart": { "description": "gameserver_game.portstart (int4, nullable)", "type": "integer", "example": "25565" }, "portend": { "description": "gameserver_game.portend (int4, nullable)", "type": "integer", "example": "25600" }, "extraports": { "description": "gameserver_game.extraports (int4, default 0)", "type": "integer", "example": "0" }, "icon": { "description": "gameserver_game.icon (varchar, nullable)", "type": "string", "example": "fa-cube" }, "sort": { "description": "gameserver_game.sort (int4, nullable)", "type": "integer", "example": "10" }, "type": { "description": "gameserver_game.type (varchar, nullable)", "type": "string", "example": "slots" }, "minvalue": { "description": "gameserver_game.minvalue (varchar, nullable)", "type": "string", "example": "2" }, "maxvalue": { "description": "gameserver_game.maxvalue (varchar, nullable)", "type": "string", "example": "64" }, "slotstring": { "description": "gameserver_game.slotstring (varchar, nullable)", "type": "string", "example": "Slots" }, "minstorage": { "description": "gameserver_game.minstorage (int4, nullable)", "type": "integer", "example": "10" }, "minmemory": { "description": "gameserver_game.minmemory (int4, default 0)", "type": "integer", "example": "0" }, "versionsort": { "description": "gameserver_game.versionsort (varchar, nullable)", "type": "string", "example": "default" }, "modmanager": { "description": "gameserver_game.modmanager (int4, default 0)", "type": "integer", "example": "0" }, "versionchange": { "description": "gameserver_game.versionchange (int4, default 1)", "type": "integer", "example": "1" }, "versions": { "description": "From getData()->getVersions(): raw gameserver_version rows (getAll json=true). Each item columns: id(string),game(string),version(string),egg(string),dockerimage(string),created_on(string),sort(integer),startup(string),type(string),downloadurl(string).", "type": "array", "items": { "type": "object" } }, "configurations": { "description": "From getConfigurations(): raw gameserver_game_package rows (getAll json=true). Each item columns: id(string),slots(integer),memory(integer),package_memory(integer),package_cpu(integer),package_disk(integer),package_io(integer),priceperunit(number),created_on(string).", "type": "array", "items": { "type": "object" } } }, "type": "object" }, "GameserverGameInfoResponse": { "properties": { "id": { "description": "gameserver_game.id (uuid)", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "displayname": { "description": "gameserver_game.displayname (varchar)", "type": "string", "example": "Minecraft" }, "productinterfaceimage": { "description": "gameserver_game.productinterfaceimage (varchar)", "type": "string", "example": "minecraft.png" }, "created_on": { "description": "gameserver_game.created_on (timestamp)", "type": "string", "example": "2024-01-15 12:00:00" }, "versionstring": { "description": "gameserver_game.versionstring (varchar, nullable)", "type": "string", "example": "1.20.4" }, "steamid": { "description": "gameserver_game.steamid (int4, nullable)", "type": "integer", "example": "730" }, "steamconnectstring": { "description": "gameserver_game.steamconnectstring (varchar, nullable)", "type": "string", "example": "connect 1.2.3.4:27015" }, "easyname": { "description": "gameserver_game.easyname (varchar, nullable)", "type": "string", "example": "minecraft" }, "status": { "description": "gameserver_game.status (int4); explicitly overwritten by factory to 1 if stock available, else 0", "type": "integer", "example": "1" }, "portstart": { "description": "gameserver_game.portstart (int4, nullable)", "type": "integer", "example": "25565" }, "portend": { "description": "gameserver_game.portend (int4, nullable)", "type": "integer", "example": "25665" }, "extraports": { "description": "gameserver_game.extraports (int4, default 0)", "type": "integer", "example": "0" }, "icon": { "description": "gameserver_game.icon (varchar, nullable)", "type": "string", "example": "fa-cube" }, "sort": { "description": "gameserver_game.sort (int4, nullable)", "type": "integer", "example": "1" }, "type": { "description": "gameserver_game.type (varchar, nullable)", "type": "string", "example": "slots" }, "minvalue": { "description": "gameserver_game.minvalue (varchar, nullable)", "type": "string", "example": "2" }, "maxvalue": { "description": "gameserver_game.maxvalue (varchar, nullable)", "type": "string", "example": "128" }, "slotstring": { "description": "gameserver_game.slotstring (varchar, nullable)", "type": "string", "example": "Slots" }, "minstorage": { "description": "gameserver_game.minstorage (int4, nullable)", "type": "integer", "example": "10" }, "minmemory": { "description": "gameserver_game.minmemory (int4, default 0)", "type": "integer", "example": "0" }, "versionsort": { "description": "gameserver_game.versionsort (varchar, nullable)", "type": "string", "example": "default" }, "modmanager": { "description": "gameserver_game.modmanager (int4, default 0)", "type": "integer", "example": "0" }, "versionchange": { "description": "gameserver_game.versionchange (int4, default 1)", "type": "integer", "example": "1" }, "versions": { "description": "Added by GameserverGame::getData() via getVersions(): raw SELECT * rows from gameserver_version filtered by game id. Item columns: id(string uuid), game(string uuid), version(string), egg(string), dockerimage(string), created_on(string timestamp), sort(integer), type(string), downloadurl(string)", "type": "array", "items": { "type": "object" } }, "configurations": { "description": "Set by factory via game->getConfigurations(): raw SELECT * rows from gameserver_game_package filtered by slots/memory range. Item columns: id(string uuid), slots(integer), memory(integer), package_memory(integer), package_cpu(integer), package_disk(integer), package_io(integer), priceperunit(number numeric), created_on(string timestamp)", "type": "array", "items": { "type": "object" } }, "discount": { "description": "Hardcoded literal array of 10 objects. Item fields: days(integer), discount(number)", "type": "array", "items": { "type": "object" } } }, "type": "object" }, "GameserverLineResponse": { "properties": { "id": { "description": "UUID primary key of the plesk plan / packet", "type": "string", "example": "3f2504e0-4f89-11d3-9a0c-0305e82c3301" }, "name": { "description": "Display name of the packet", "type": "string", "example": "Webspace Starter" }, "pleskid": { "description": "Plesk service plan id reference", "type": "string", "example": "15" }, "storage": { "description": "Storage quota (string value)", "type": "string", "example": "10240" }, "traffic": { "description": "Traffic / bandwidth limit", "type": "string", "example": "unlimited" }, "domains": { "description": "Number of allowed domains", "type": "string", "example": "5" }, "subdomains": { "description": "Number of allowed subdomains", "type": "string", "example": "10" }, "mailboxes": { "description": "Number of allowed mailboxes", "type": "string", "example": "25" }, "ftpaccounts": { "description": "Number of allowed FTP accounts", "type": "string", "example": "5" }, "databases": { "description": "Number of allowed databases", "type": "string", "example": "10" }, "price": { "description": "Price of the packet (numeric)", "type": "number", "format": "float", "example": "4.99" }, "line": { "description": "Product line identifier this packet belongs to", "type": "string", "example": "webspace" }, "active": { "description": "Active flag (1 = active)", "type": "integer", "example": "1" }, "memorylimit": { "description": "PHP/memory limit for the plan", "type": "string", "example": "512M" }, "pleskname": { "description": "Plan name within Plesk", "type": "string", "example": "Starter Plan" }, "pleskuuid": { "description": "Plesk plan UUID reference", "type": "string", "example": "a1b2c3d4-0000-0000-0000-000000000000" } }, "type": "object" }, "IPv4Response": { "properties": { "gw": { "description": "Value", "type": "string", "example": "37.114.37.1" }, "ip": { "description": "Value", "type": "string", "example": "37.114.37.1" }, "netmask": { "description": "Value", "type": "string", "example": "255.255.255.0" }, "rdns": { "description": "Value", "type": "string", "example": "1.37.114.37.in-addr.arpa." }, "subnetid": { "description": "Value", "type": "integer", "example": "97" }, "protstatus": { "description": "DDoS protection mode of the address: dynamic (default) or permanent, changed with POST /service/{serviceid}/prot/status. A BYOIP address shows active when its mode could not be read.", "type": "string", "example": "dynamic" }, "nullroute": { "description": "Null route of the address: active, since (unix time, null when not active), locked (set by our support, only the support can remove it)", "type": "object", "example": { "active": true, "since": 1762100000, "locked": false } } }, "type": "object" }, "IPv6Response": { "properties": { "firstip": { "description": "Value", "type": "string", "example": "2a0c:520:1:30::2" }, "gw": { "description": "Value", "type": "string", "example": "2a0c:520:1:30::1" }, "netmask": { "description": "Value", "type": "string", "example": "2a0c:520:1:30:0:0:0:0" }, "subnet": { "description": "Value", "type": "string", "example": "2a0c:520:1:30:0:0:0:0/64" }, "subnetid": { "description": "Value", "type": "integer", "example": "49" } }, "type": "object" }, "InterfaceServiceResponse": { "properties": { "id": { "description": "Value", "type": "string", "example": "9cc373b9-bc3d-4482-8e62-08c9ad7872fd" }, "serviceid": { "description": "Value", "type": "string", "example": "9cc373b9-bc3d-4482-8e62-08c9ad7872fd" } }, "type": "object" }, "InterfaceUserResponse": { "properties": { "userid": { "description": "Value", "type": "string", "example": "9cc373b9-bc3d-4482-8e62-08c9ad7872fd" }, "email": { "description": "Value", "type": "string", "example": "test@test.de" }, "username": { "description": "Value", "type": "string", "example": "test" }, "supportpin": { "description": "Value", "type": "integer", "example": "3026ss3040" } }, "type": "object" }, "KVMLineOsResponse": { "properties": { "id": { "description": "Value", "type": "string", "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" }, "displayname": { "description": "Value", "type": "string", "example": "Ubuntu 20.04" }, "proxmoxid": { "description": "Value", "type": "integer", "example": "500" }, "type": { "description": "Value", "type": "string", "example": "linux" } }, "type": "object" }, "KVMLineResponse": { "properties": { "id": { "description": "Value", "type": "string", "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" }, "line": { "description": "Value", "type": "string", "example": "intelxeon" }, "cores": { "description": "Value", "type": "integer", "example": "4" }, "memory": { "description": "Value", "type": "integer", "example": "8192" }, "disk": { "description": "Value", "type": "integer", "example": "51200" }, "uplink": { "description": "Value", "type": "integer", "example": "1000" }, "ipv4": { "description": "Value", "type": "integer", "example": "1" }, "ipv6": { "description": "Value", "type": "integer", "example": "1" }, "active": { "description": "Value", "type": "integer", "example": "1" }, "price": { "description": "Value", "type": "number", "format": "float", "example": "5.99" }, "displayname": { "description": "Value", "type": "string", "example": "KVM Server S" }, "ghzbase": { "description": "Value", "type": "string", "example": "2,80" }, "ghzturbo": { "description": "Value", "type": "string", "example": "3,60" }, "traffic": { "description": "Value", "type": "integer", "example": "1" }, "discount": { "description": "Value", "type": "integer", "example": "0" }, "firstpayment": { "description": "Value", "type": "integer", "example": "0" }, "discountedprice": { "description": "Value", "type": "number", "format": "float", "example": "0.00" }, "location": { "description": "Data center code (cgt, itp, egc, eq7)", "type": "string", "example": "eq7" }, "locationname": { "description": "Readable data center name for the location code, null for an unknown code", "type": "string", "example": "Equinix FRA-7", "nullable": true }, "country": { "description": "Country of the data center, null for an unknown location code", "type": "string", "example": "Deutschland", "nullable": true }, "countrycode": { "description": "Country of the data center as ISO 3166-1 alpha-2 code, upper case, null for an unknown location code", "type": "string", "example": "DE", "nullable": true }, "city": { "description": "City of the data center as a proper name, null for an unknown location code", "type": "string", "example": "Frankfurt am Main", "nullable": true }, "backupslots": { "description": "Backup slots a new service of this packet gets", "type": "integer", "example": "4" } }, "type": "object" }, "KvmserverHostsystemResponse": { "properties": { "type": { "description": "Requested node type, matches kvmserver_packet.cputype", "type": "string", "example": "epyc" }, "cpu": { "description": "CPU model of the host system", "type": "string", "example": "AMD EPYC™ 7763" }, "ghzbase": { "description": "CPU base frequency in GHz", "type": "string", "example": "2.45" }, "ghzturbo": { "description": "CPU turbo frequency in GHz", "type": "string", "example": "3.50" }, "network": { "description": "Network uplink of the host system", "type": "string", "example": "2x 10Gbit LACP" } }, "type": "object" }, "KvmserverOsResponse": { "properties": { "id": { "description": "UUID primary key of the OS entry (kvmserver_os.id)", "type": "string", "example": "3f8c1e2a-9b7d-4e6f-8a1c-2d3e4f5a6b7c" }, "displayname": { "description": "Human-readable OS name", "type": "string", "example": "Ubuntu 22.04" }, "proxmoxid": { "description": "Proxmox template/VM id for the OS", "type": "integer", "example": "105" }, "type": { "description": "OS type (e.g. linux/windows)", "type": "string", "example": "linux" }, "sort": { "description": "Sort order used for ORDER BY sort", "type": "integer", "example": "10" }, "user": { "description": "Default user for the OS", "type": "string", "example": "root" }, "cputype": { "description": "CPU type configuration", "type": "string", "example": "host" }, "path": { "description": "Path to the OS template/image", "type": "string", "example": "/var/lib/vz/template/iso/ubuntu.iso" }, "pathxeon": { "description": "Path variant for Xeon nodes", "type": "string", "example": "/path/xeon" }, "pathxeoneq7": { "description": "Path variant for Xeon EQ7 nodes", "type": "string", "example": "/path/xeon/eq7" }, "rescuenet": { "description": "Rescue network configuration value", "type": "string", "example": "static" }, "defaultselected": { "description": "1 = this OS is preselected in the OS dropdowns (0 otherwise)", "type": "integer", "example": "0" } }, "type": "object" }, "NextcloudLineResponse": { "properties": { "id": { "description": "UUID primary key of the Nextcloud package", "type": "string", "example": "6f1c2a44-9b3e-4d21-8a77-0c9f1e2b3a45" }, "price": { "description": "Package price (numeric, default 0)", "type": "number", "format": "float", "example": "4.99" }, "storage": { "description": "Storage allowance (int4)", "type": "integer", "example": "100" }, "created_on": { "description": "Creation timestamp", "type": "string", "example": "2026-06-23 12:34:56" }, "traffic": { "description": "Traffic allowance (int4, nullable)", "type": "integer", "example": "1000" }, "displayname": { "description": "Display name of the package (nullable)", "type": "string", "example": "Nextcloud 100GB" }, "sort": { "description": "Sort order value (varchar, nullable)", "type": "string", "example": "1" }, "status": { "description": "Status flag (int4, default 1; filtered to 0 or 1 in query)", "type": "integer", "example": "1" } }, "type": "object" }, "NextcloudPacketInfoResponse": { "properties": { "id": { "description": "UUID primary key of the Nextcloud package (uuid column)", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "price": { "description": "Package price (numeric column)", "type": "number", "format": "float", "example": "4.99" }, "storage": { "description": "Storage amount (int4 column, NOT NULL)", "type": "integer", "example": "100" }, "created_on": { "description": "Creation timestamp (timestamp column, default CURRENT_TIMESTAMP)", "type": "string", "example": "2024-01-15 12:34:56" }, "traffic": { "description": "Traffic allowance (int4 column, nullable)", "type": "integer", "example": "1000" }, "displayname": { "description": "Display name of the package (varchar, nullable)", "type": "string", "example": "Nextcloud Pro" }, "sort": { "description": "Sort order value (varchar, nullable)", "type": "string", "example": "1" }, "status": { "description": "Status flag (int4, default 1)", "type": "integer", "example": "1" } }, "type": "object" }, "NextcloudValidateDomainResponse": { "properties": { "result": { "description": "Domain validation status code. 1 = domain contains a space; 2 = domain does not resolve to an A record or does not point to the expected IP (5.253.247.2); 3 = domain already in use by an existing non-deleted Nextcloud service; 4 = domain is valid/available.", "type": "integer", "example": "4" } }, "type": "object" }, "NotFound": { "properties": { "error": { "description": "This resource could not be found", "type": "string" }, "error_code": { "description": "Stable code identifying the exact error, independent of the user language. Only present on endpoints that document their error codes.", "type": "string", "example": "gameserverGameNotFound" } }, "type": "object" }, "OrderKVMResponse": { "properties": { "id": { "description": "Value", "type": "string", "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" } }, "type": "object" }, "OrderPayResponse": { "properties": { "link": { "description": "Value", "type": "string", "example": "https://link.de" } }, "type": "object" }, "ProductReponse": { "properties": { "additionaltraffic": { "description": "Value", "type": "integer", "example": "0" }, "cores": { "description": "Value", "type": "integer", "example": "4" }, "created_on": { "description": "Value", "type": "string", "example": "2022-04-26 15:12:14.782654" }, "disk": { "description": "Value", "type": "integer", "example": "51200" }, "hostname": { "description": "Value", "type": "string", "example": "#1082" }, "customhostname": { "description": "Dedicated only: the full os hostname set with a reseller api order, null otherwise", "type": "string", "example": "srv-1a2b3c4d.example.com" }, "id": { "description": "Value", "type": "string", "example": "#c4e3f65f-3e77-4c8a-9eb7-8bdb63c43620" }, "mac": { "description": "Value", "type": "string", "example": "4A:63:06:6D:02:04" }, "memory": { "description": "Value", "type": "integer", "example": "8192" }, "nodeid": { "description": "Value", "type": "string", "example": "861759cd-7a11-4a6a-bd04-764f88f644b8" }, "os": { "description": "Value", "type": "string", "example": "861759cd-7a11-4a6a-bd04-764f88f644b8" }, "packet": { "description": "Value", "type": "string", "example": "861759cd-7a11-4a6a-bd04-764f88f644b8" }, "proxmoxid": { "description": "Value", "type": "integer", "example": "1082" }, "password": { "description": "Value", "type": "string", "example": "passwort12312414" }, "serviceid": { "description": "Value", "type": "string", "example": "861759cd-7a11-4a6a-bd04-764f88f644b8" }, "status": { "description": "Value", "type": "string", "example": "running" }, "migration": { "description": "KVM Server with status migrating only: phase (shutdown, disk, memory, copy or starting), percent (0..100 with one decimal, null without one), bytes (copied so far, null without) and rate (bytes per second, null without) of the move to another host, null before the move started", "type": "object", "example": { "phase": "disk", "percent": null, "bytes": 8214745088, "rate": 146492621 }, "nullable": true }, "maintenanceid": { "description": "KVM Server only: id of the announced maintenance (see maintenance) the status shows, absent without one. During an active maintenance that marks the service the status is \"maintenance\", otherwise plannedmaintenance is 1 and statusreason names the maintenance", "type": "string", "example": "0b6f3c4e-2f43-4c35-9d0e-7a1c2b9f6e11" }, "uplink": { "description": "Value", "type": "integer", "example": "1000" }, "user": { "description": "Value", "type": "string", "example": "root" } }, "type": "object" }, "RequestFailed": { "properties": { "error": { "description": "The request could not be processed", "type": "string" }, "error_code": { "description": "Stable code identifying the exact error, independent of the user language. Only present on endpoints that document their error codes.", "type": "string", "example": "orderInvalidRuntime" } }, "type": "object" }, "ResellerAvailablePaymentsResponse": { "properties": { "method": { "description": "Payment method identifier. Fixed literal for credit/paypal/stripe/coingate/coinpayments entries; for Mollie it is the external Mollie method id ($method->id), for Coinpayments it is the lowercased currency key.", "type": "string", "example": "credit" }, "provider": { "description": "Payment provider name. One of: credit, mollie, paypal, stripe, coingate, coinpayments.", "type": "string", "example": "stripe" }, "id": { "description": "Composite identifier in the form provider_method (e.g. credit_credit, mollie_, paypal_paypal, stripe_card, coingate_coingate, coinpayments_).", "type": "string", "example": "stripe_card" }, "display": { "description": "Human-readable label. Static for most providers; for Mollie includes the external $method->description; for Coinpayments includes the lowercased currency key.", "type": "string", "example": "CreditCard(card) - Stripe" }, "data": { "description": "Present ONLY on Coinpayments entries. Raw value from the external Coinpayments API GetRates() result ($data['result'][$key]); its inner shape is external and not determinable from the repo. Absent on all other entries.", "type": "object" } }, "type": "object" }, "ResellerCheckDomainResponse": { "properties": { "main": { "description": "DNS A-record check for the apex domain. status=true when the A record resolves to 194.15.36.245, else false. ip is the resolved IP or the literal string 'none' when not matched/unresolved.", "type": "object" }, "mainstatus": { "description": "true if the apex domain's A record points to 194.15.36.245.", "type": "boolean", "example": "false" }, "mainip": { "description": "Resolved IPv4 address from dns_get_record, or the literal 'none' if not matched.", "type": "string", "example": "none" }, "backend": { "description": "DNS A-record check for backend.. Same shape as main.", "type": "object" }, "backendstatus": { "description": "true if backend. A record is 194.15.36.245.", "type": "boolean", "example": "false" }, "backendip": { "description": "Resolved IPv4 or literal 'none'.", "type": "string", "example": "none" }, "livedata": { "description": "DNS A-record check for livedata.. Same shape as main.", "type": "object" }, "livedatastatus": { "description": "true if livedata. A record is 194.15.36.245.", "type": "boolean", "example": "false" }, "livedataip": { "description": "Resolved IPv4 or literal 'none'.", "type": "string", "example": "none" }, "cdn": { "description": "DNS A-record check for cdn.. Same shape as main.", "type": "object" }, "cdnstatus": { "description": "true if cdn. A record is 194.15.36.245.", "type": "boolean", "example": "false" }, "cdnip": { "description": "Resolved IPv4 or literal 'none'.", "type": "string", "example": "none" }, "novnc": { "description": "DNS A-record check for novnc.. Same shape as main.", "type": "object" }, "novncstatus": { "description": "true if novnc. A record is 194.15.36.245.", "type": "boolean", "example": "false" }, "novncip": { "description": "Resolved IPv4 or literal 'none'.", "type": "string", "example": "none" } }, "type": "object" }, "ResellerDedicatedPackageUpgradesListResponse": { "properties": { "display": { "description": "Human-readable label for the upgrade option. For memory entries it is composed of total GB and module count/name; for disk entries it is the disk displayname + producer type + disk type.", "type": "string", "example": "32GB (2x 16GB DDR4)" }, "price": { "description": "Monthly price of the upgrade option. For memory it comes from the RAM row's price; for disk it comes from the disk's getPrice().", "type": "number", "format": "float", "example": "9.99" }, "id": { "description": "ID of the underlying RAM (DedicatedPacketRam) or disk (DedicatedPacketDisk) row for this upgrade option.", "type": "integer", "example": "42" }, "type": { "description": "Literal category of the upgrade option: 'memory' for RAM upgrades, 'disk' for disk upgrades.", "type": "string", "example": "memory" } }, "type": "object" }, "ResellerDedicatedPackageUpgradesResponse": { "properties": { "display": { "description": "Human-readable upgrade description, constructed from RAM (count x displayname, total GB) or disk (displayname + disktype) data.", "type": "string", "example": "32 GB (2x 16GB DDR4)" }, "price": { "description": "Upgrade price from reseller_interface_dedicated_packages_upgrades.price (SQL numeric).", "type": "number", "format": "float", "example": "9.99" }, "id": { "description": "Upgrade UUID from reseller_interface_dedicated_packages_upgrades.id.", "type": "string", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "default": { "description": "Default flag from reseller_interface_dedicated_packages_upgrades.default (SQL int4).", "type": "integer", "example": "0" }, "type": { "description": "Upgrade type literal, either 'memory' or 'disk'.", "type": "string", "example": "memory" } }, "type": "object" }, "ResellerDedicatedPackagesResponse": { "properties": { "id": { "description": "UUID of the reseller dedicated package row (reseller_interface_dedicated_packages.id).", "type": "string", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "packetid": { "description": "UUID of the underlying dedicated packet (dedi_packet) this package is based on.", "type": "string", "example": "f0e1d2c3-b4a5-6978-8c7d-6e5f4a3b2c1d" }, "displayname": { "description": "Display name configured for the reseller package (nullable varchar).", "type": "string", "example": "Dedicated Power Package" }, "price": { "description": "Recurring price (numeric).", "type": "number", "format": "float", "example": "99.99" }, "setup": { "description": "Setup fee (numeric).", "type": "number", "format": "float", "example": "49" }, "ordernewproductpage": { "description": "Flag/int controlling whether shown on the order-new-product page (int4).", "type": "integer", "example": "0" }, "packetinfo": { "description": "Display name of the matching base packet from getPacketList(); empty string if no match found. Locally derived from getPacketList() displayname.", "type": "string", "example": "Intel Xeon E-2388G" } }, "type": "object" }, "ResellerEmailTemplatesResponse": { "properties": { "id": { "description": "UUID primary key of the email template (column id of reseller_interface_email_templates).", "type": "string", "example": "3f1c8e2a-9b4d-4f6e-8a12-7c3d5e9b0a11" }, "resellerinterfaceid": { "description": "UUID of the reseller interface this template belongs to.", "type": "string", "example": "a2b7c9d1-4e8f-4a6b-9c2d-1f3e5a7b8c90" }, "templatename": { "description": "Internal name/key of the template (varchar).", "type": "string", "example": "order_confirmation" }, "html": { "description": "HTML body of the email template (text column, nullable).", "type": "string", "example": "

Hello {{name}}

" }, "title": { "description": "Subject/title of the email template (varchar, nullable).", "type": "string", "example": "Your order is confirmed" }, "created_on": { "description": "Creation timestamp as returned by the DB (timestamp column, not unix-converted here).", "type": "string", "example": "2026-06-23 14:05:00" }, "status": { "description": "Status flag of the template (int4, defaults to 0).", "type": "integer", "example": "1" }, "variables": { "description": "Array of available template variables, each built locally as {variable:string, description:string}. variable is the raw variable token; description is a language-translated string resolved via lang->getString().", "type": "array", "items": { "type": "object" } } }, "type": "object" }, "ResellerExtendServiceReseponse": { "properties": { "id": { "description": "Serviceid", "type": "string", "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" } }, "type": "object" }, "ResellerGameServerResponse": { "properties": { "id": { "description": "Serviceid", "type": "string", "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" } }, "type": "object" }, "ResellerGameServerVersionResponse": { "properties": { "id": { "description": "Serviceid", "type": "string", "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" }, "slots": { "description": "Serviceid", "type": "integer", "example": "1" }, "memory": { "description": "Serviceid", "type": "string", "example": "1024" }, "priceperunit": { "description": "Serviceid", "example": "0.99" } }, "type": "object" }, "ResellerInterfaceInfoResponse": { "properties": { "id": { "description": "UUID primary key of the reseller interface", "type": "string", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "displayname": { "description": "Display name of the reseller interface", "type": "string", "example": "My Hosting Panel" }, "domain": { "description": "Primary domain of the interface (unique)", "type": "string", "example": "panel.example.com" }, "backendurl": { "description": "Backend API URL", "type": "string", "example": "https://api.example.com" }, "defaultlang": { "description": "Default language code", "type": "string", "example": "de" }, "logourl": { "description": "Logo image URL", "type": "string", "example": "https://cdn.example.com/logo.png" }, "cdnurl": { "description": "CDN base URL", "type": "string", "example": "https://cdn.example.com" }, "color": { "description": "Primary brand color", "type": "string", "example": "#1a73e8" }, "registeractive": { "description": "Whether registration is active (0/1)", "type": "integer", "example": "1" }, "status": { "description": "Interface status flag", "type": "integer", "example": "0" }, "secondarycolor": { "description": "Secondary brand color", "type": "string", "example": "#ff5722" }, "defaultstyle": { "description": "Default UI style/theme", "type": "string", "example": "dark" }, "langchanger": { "description": "Whether the language changer is enabled (0/1)", "type": "integer", "example": "1" }, "thirdcolor": { "description": "Third brand color", "type": "string", "example": "#00bcd4" }, "logoheight": { "description": "Logo height in pixels", "type": "integer", "example": "40" }, "ordernewprodurl": { "description": "URL for ordering new products", "type": "string", "example": "https://example.com/order" }, "supporturl": { "description": "Support URL", "type": "string", "example": "https://support.example.com" }, "novncurl": { "description": "noVNC console URL", "type": "string", "example": "https://novnc.example.com" }, "livedataurl": { "description": "Live data endpoint URL", "type": "string", "example": "https://live.example.com" }, "faviconurl": { "description": "Favicon URL", "type": "string", "example": "https://cdn.example.com/favicon.ico" }, "disabledashboardoverview": { "description": "Disable dashboard overview flag (0/1)", "type": "integer", "example": "0" }, "disablenodecpu": { "description": "Disable node CPU display flag (0/1)", "type": "integer", "example": "0" }, "disablestylechanger": { "description": "Disable style changer flag (0/1)", "type": "integer", "example": "0" }, "imprinturl": { "description": "Imprint/legal notice URL", "type": "string", "example": "https://example.com/imprint" }, "tosurl": { "description": "Terms of service URL", "type": "string", "example": "https://example.com/tos" }, "privacyurl": { "description": "Privacy policy URL", "type": "string", "example": "https://example.com/privacy" }, "disabletosdisplay": { "description": "Disable TOS display flag (0/1)", "type": "integer", "example": "0" }, "disablecustomerarea": { "description": "Disable customer area flag (0/1)", "type": "integer", "example": "0" }, "disablenovnc": { "description": "Disable noVNC flag (0/1)", "type": "integer", "example": "0" }, "hostdomain": { "description": "Host domain", "type": "string", "example": "example.com" }, "script": { "description": "Custom script injected into the interface", "type": "string", "example": "" }, "subreseller": { "description": "Whether this is a sub-reseller (0/1)", "type": "integer", "example": "0" }, "primaryinterfaceid": { "description": "UUID of the primary interface (for sub-resellers)", "type": "string", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "supportlink": { "description": "Support link", "type": "string", "example": "https://support.example.com" }, "displaygamechanger": { "description": "Display game changer flag (0/1)", "type": "integer", "example": "1" }, "discordembedcolor": { "description": "Discord embed color", "type": "string", "example": "#5865F2" }, "discordembedtitle": { "description": "Discord embed title", "type": "string", "example": "New Order" }, "discordembeddesc": { "description": "Discord embed description", "type": "string", "example": "An order was placed" }, "discordembedlogo": { "description": "Discord embed logo URL", "type": "string", "example": "https://cdn.example.com/logo.png" }, "enableapikeys": { "description": "Enable API keys flag (0/1)", "type": "integer", "example": "0" }, "externalapidoc": { "description": "External API documentation URL", "type": "string", "example": "https://docs.example.com" }, "enableapidocs": { "description": "Enable API docs flag (0/1)", "type": "integer", "example": "0" }, "delete_reason": { "description": "Reason for deletion", "type": "string", "example": "customer request" }, "payment_enabled": { "description": "Whether payments are enabled (0/1)", "type": "integer", "example": "0" }, "payment_mollie_apikey": { "description": "Mollie payment API key", "type": "string", "example": "test_xxx" }, "canunblockmail": { "description": "Whether mail unblocking is allowed (0/1)", "type": "integer", "example": "0" }, "payments": { "description": "Payments flag", "type": "integer", "example": "0" }, "payment_paypal_clientid": { "description": "PayPal client ID", "type": "string", "example": "AbC123" }, "payment_paypal_clientsecret": { "description": "PayPal client secret", "type": "string", "example": "secret" }, "payment_paypal_mode": { "description": "PayPal mode (live/sandbox)", "type": "string", "example": "live" }, "css": { "description": "Custom CSS", "type": "string", "example": ".btn { color: red; }" }, "themecolor": { "description": "Theme color", "type": "string", "example": "#1a73e8" }, "slidercolor": { "description": "Slider color", "type": "string", "example": "#ff5722" }, "kvmconfiguratoricon": { "description": "KVM configurator icon URL", "type": "string", "example": "https://cdn.example.com/icon.png" }, "kvmextraipv4price": { "description": "Extra IPv4 price for KVM", "type": "number", "format": "float", "example": "1.49" }, "kvmextratrafficprice": { "description": "Extra traffic price for KVM", "type": "number", "format": "float", "example": "3.95" }, "taxamount": { "description": "Tax amount/percentage", "type": "integer", "example": "19" }, "invoice_notes": { "description": "Invoice notes", "type": "string", "example": "Thank you for your order" }, "invoice_address": { "description": "Invoice address", "type": "string", "example": "123 Main St" }, "invoice_color": { "description": "Invoice color", "type": "string", "example": "#1a73e8" }, "setting_setinvoicedata": { "description": "Whether invoice data setting is enabled (0/1)", "type": "integer", "example": "0" }, "invoice_logo": { "description": "Invoice logo URL", "type": "string", "example": "https://cdn.example.com/invoice-logo.png" }, "dediextraipv4price": { "description": "Extra IPv4 price for dedicated servers", "type": "number", "format": "float", "example": "0.99" }, "dediextratrafficprice": { "description": "Extra traffic price for dedicated servers", "type": "number", "format": "float", "example": "3.95" }, "payment_stripe_apikey": { "description": "Stripe secret API key", "type": "string", "example": "sk_test_xxx" }, "payment_stripe_webhook_secret": { "description": "Stripe webhook secret", "type": "string", "example": "whsec_xxx" }, "payment_stripe_apikey_public": { "description": "Stripe public API key", "type": "string", "example": "pk_test_xxx" }, "mailserver_server": { "description": "Mail server host", "type": "string", "example": "smtp.example.com" }, "mailserver_port": { "description": "Mail server port", "type": "string", "example": "587" }, "mailserver_user": { "description": "Mail server user", "type": "string", "example": "noreply@example.com" }, "mailserver_password": { "description": "Mail server password", "type": "string", "example": "secret" }, "mailserver_replyto": { "description": "Mail reply-to address", "type": "string", "example": "support@example.com" }, "setting_password_reset": { "description": "Password reset setting flag (0/1)", "type": "integer", "example": "0" }, "coinpayments_private_key": { "description": "CoinPayments private key", "type": "string", "example": "priv_xxx" }, "coinpayments_public_key": { "description": "CoinPayments public key", "type": "string", "example": "pub_xxx" }, "coinpayments_merchant_id": { "description": "CoinPayments merchant ID", "type": "string", "example": "merchant_xxx" }, "coingate_auth_token": { "description": "CoinGate API auth token", "type": "string", "example": "token_xxx" }, "coingate_environment": { "description": "CoinGate environment (live or sandbox)", "type": "string", "example": "live" }, "supportticketsystem": { "description": "Support ticket system flag (0/1)", "type": "integer", "example": "0" }, "supportdisplayname": { "description": "Support display name", "type": "string", "example": "Support Team" }, "mailserver_loginname": { "description": "Mail server login name", "type": "string", "example": "noreply" }, "mailserver_displayname": { "description": "Mail server display name", "type": "string", "example": "Example Support" }, "graph_color_1": { "description": "Graph color 1", "type": "string", "example": "#1a73e8" }, "graph_color_2": { "description": "Graph color 2", "type": "string", "example": "#ff5722" }, "orderswithoutpaying": { "description": "Allow orders without paying flag (0/1)", "type": "integer", "example": "0" }, "accessmanager": { "description": "Access manager flag (0/1)", "type": "integer", "example": "0" }, "ordernewproductpage": { "description": "Order new product page flag (0/1)", "type": "integer", "example": "0" }, "supportsignature": { "description": "Support email signature", "type": "string", "example": "Best regards, Support" }, "oauth_discord_id": { "description": "Discord OAuth client ID", "type": "string", "example": "123456789" }, "oauth_discord_secret": { "description": "Discord OAuth client secret", "type": "string", "example": "secret" }, "oauth_github_id": { "description": "GitHub OAuth client ID", "type": "string", "example": "Iv1.abc123" }, "oauth_github_secret": { "description": "GitHub OAuth client secret", "type": "string", "example": "secret" }, "loginconfirm": { "description": "Login confirmation flag (0/1)", "type": "integer", "example": "0" }, "enable_eu_tax": { "description": "Enable EU tax flag (0/1)", "type": "integer", "example": "0" }, "allowuserstopermunlockemailports": { "description": "Allow users to permanently unlock email ports flag (0/1)", "type": "integer", "example": "0" }, "announcement": { "description": "Announcement text", "type": "string", "example": "Maintenance scheduled" }, "delete_at": { "description": "Scheduled deletion timestamp (not converted to unix; empty convert list)", "type": "string", "example": "2026-07-01 00:00:00" }, "languages": { "description": "Map of language code/id to display name; always includes de and en (localized strings), plus any custom ResellerLanguage entries keyed by their UUID id", "type": "object" } }, "type": "object" }, "ResellerInterfaceListResponse": { "properties": { "id": { "description": "uuid primary key", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "displayname": { "type": "string", "example": "My Reseller Panel" }, "domain": { "type": "string", "example": "panel.example.com" }, "backendurl": { "type": "string", "example": "https://api.example.com" }, "defaultlang": { "type": "string", "example": "de" }, "logourl": { "type": "string", "example": "https://cdn.example.com/logo.png" }, "cdnurl": { "type": "string", "example": "https://cdn.example.com" }, "color": { "type": "string", "example": "#1a73e8" }, "registeractive": { "type": "integer", "example": "1" }, "status": { "type": "integer", "example": "1" }, "secondarycolor": { "type": "string", "example": "#ff9800" }, "defaultstyle": { "type": "string", "example": "dark" }, "langchanger": { "type": "integer", "example": "1" }, "thirdcolor": { "type": "string", "example": "#34a853" }, "logoheight": { "type": "integer", "example": "40" }, "ordernewprodurl": { "type": "string", "example": "https://example.com/order" }, "supporturl": { "type": "string", "example": "https://support.example.com" }, "novncurl": { "type": "string", "example": "https://novnc.example.com" }, "livedataurl": { "type": "string", "example": "https://live.example.com" }, "faviconurl": { "type": "string", "example": "https://cdn.example.com/favicon.ico" }, "disabledashboardoverview": { "type": "integer", "example": "0" }, "disablenodecpu": { "type": "integer", "example": "0" }, "disablestylechanger": { "type": "integer", "example": "0" }, "imprinturl": { "type": "string", "example": "https://example.com/imprint" }, "tosurl": { "type": "string", "example": "https://example.com/tos" }, "privacyurl": { "type": "string", "example": "https://example.com/privacy" }, "disabletosdisplay": { "type": "integer", "example": "0" }, "disablecustomerarea": { "type": "integer", "example": "0" }, "disablenovnc": { "type": "integer", "example": "0" }, "hostdomain": { "type": "string", "example": "example.com" }, "script": { "type": "string", "example": "" }, "subreseller": { "type": "integer", "example": "0" }, "primaryinterfaceid": { "description": "uuid, nullable", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "supportlink": { "type": "string", "example": "https://support.example.com" }, "displaygamechanger": { "type": "integer", "example": "1" }, "discordembedcolor": { "type": "string", "example": "#5865F2" }, "discordembedtitle": { "type": "string", "example": "New Order" }, "discordembeddesc": { "type": "string", "example": "A new order was placed" }, "discordembedlogo": { "type": "string", "example": "https://cdn.example.com/discord.png" }, "enableapikeys": { "type": "integer", "example": "0" }, "externalapidoc": { "type": "string", "example": "https://docs.example.com" }, "enableapidocs": { "type": "integer", "example": "0" }, "delete_reason": { "type": "string", "example": "requested by user" }, "payment_enabled": { "type": "integer", "example": "0" }, "payment_mollie_apikey": { "type": "string", "example": "test_xxx" }, "canunblockmail": { "type": "integer", "example": "0" }, "payments": { "type": "integer", "example": "0" }, "payment_paypal_clientid": { "type": "string", "example": "Afg...xyz" }, "payment_paypal_clientsecret": { "type": "string", "example": "ELx...abc" }, "payment_paypal_mode": { "type": "string", "example": "live" }, "css": { "type": "string", "example": "body { color: #000; }" }, "themecolor": { "type": "string", "example": "#1a73e8" }, "slidercolor": { "type": "string", "example": "#ff9800" }, "kvmconfiguratoricon": { "type": "string", "example": "https://cdn.example.com/icon.svg" }, "kvmextraipv4price": { "type": "number", "format": "float", "example": "1.49" }, "kvmextratrafficprice": { "type": "number", "format": "float", "example": "3.95" }, "taxamount": { "type": "integer", "example": "19" }, "invoice_notes": { "type": "string", "example": "Thank you for your business" }, "invoice_address": { "type": "string", "example": "Example GmbH, Street 1, City" }, "invoice_color": { "type": "string", "example": "#1a73e8" }, "setting_setinvoicedata": { "type": "integer", "example": "0" }, "invoice_logo": { "type": "string", "example": "https://cdn.example.com/invoice-logo.png" }, "dediextraipv4price": { "type": "number", "format": "float", "example": "0.99" }, "dediextratrafficprice": { "type": "number", "format": "float", "example": "3.95" }, "payment_stripe_apikey": { "type": "string", "example": "sk_test_xxx" }, "payment_stripe_webhook_secret": { "type": "string", "example": "whsec_xxx" }, "payment_stripe_apikey_public": { "type": "string", "example": "pk_test_xxx" }, "mailserver_server": { "type": "string", "example": "mail.example.com" }, "mailserver_port": { "type": "string", "example": "587" }, "mailserver_user": { "type": "string", "example": "noreply@example.com" }, "mailserver_password": { "type": "string", "example": "secret" }, "mailserver_replyto": { "type": "string", "example": "support@example.com" }, "setting_password_reset": { "type": "integer", "example": "0" }, "coinpayments_private_key": { "type": "string", "example": "priv_xxx" }, "coinpayments_public_key": { "type": "string", "example": "pub_xxx" }, "coinpayments_merchant_id": { "type": "string", "example": "merchant_xxx" }, "coingate_auth_token": { "type": "string", "example": "token_xxx" }, "coingate_environment": { "type": "string", "example": "live" }, "supportticketsystem": { "type": "integer", "example": "0" }, "supportdisplayname": { "type": "string", "example": "Support Team" }, "mailserver_loginname": { "type": "string", "example": "noreply@example.com" }, "mailserver_displayname": { "type": "string", "example": "Example Support" }, "graph_color_1": { "type": "string", "example": "#1a73e8" }, "graph_color_2": { "type": "string", "example": "#ff9800" }, "orderswithoutpaying": { "type": "integer", "example": "0" }, "accessmanager": { "type": "integer", "example": "0" }, "ordernewproductpage": { "type": "integer", "example": "0" }, "supportsignature": { "type": "string", "example": "Best regards, Support" }, "oauth_discord_id": { "type": "string", "example": "123456789" }, "oauth_discord_secret": { "type": "string", "example": "discord_secret_xxx" }, "oauth_github_id": { "type": "string", "example": "Iv1.xxx" }, "oauth_github_secret": { "type": "string", "example": "github_secret_xxx" }, "loginconfirm": { "type": "integer", "example": "0" }, "enable_eu_tax": { "type": "integer", "example": "0" }, "allowuserstopermunlockemailports": { "type": "integer", "example": "0" }, "announcement": { "type": "string", "example": "Maintenance scheduled for Sunday" }, "delete_at": { "description": "timestamp string; NOT converted to unix because the convert list passed is empty", "type": "string", "example": "2026-07-01 12:00:00" } }, "type": "object" }, "ResellerInterfaceStatsResponse": { "properties": { "statKey": { "description": "Top-level object key is dynamic: the `key` column (varchar) from interface.reseller_interface_stats_storage (one property per distinct stat name found in the last 30 days). The set of keys is data-dependent and cannot be enumerated statically. Each value is an array of data-point tuples, one per stored row, ordered by created_on ASC.", "type": "array", "items": { "type": "object" } }, "statKey0": { "description": "First tuple element: the `value` column (varchar) from reseller_interface_stats_storage. Stored as a string even when numeric.", "type": "string", "example": "42" }, "statKey1": { "description": "Second tuple element: the row's created_on timestamp formatted as 'Y-m-d' (e.g. 2026-06-01).", "type": "string", "example": "2026-06-01" } }, "type": "object" }, "ResellerIpListResponse": { "properties": { "serviceid": { "description": "UUID of the service the IP is assigned to; nullable (NULL when unassigned).", "type": "string", "example": "3f9c1e2a-7b4d-4c2e-9a1f-2d6e8b0a4c11" }, "ip": { "description": "The IPv4 address.", "type": "string", "example": "185.107.96.42" }, "type": { "description": "Old type code (protection) of the address's ip pool (ip_pool.legacytype), kept for compatibility; null without a pool.", "type": "string", "example": "combahton" }, "assing_time": { "description": "Timestamp the IP was assigned (raw PostgreSQL timestamp string; not unix-converted).", "type": "string", "example": "2026-06-23 14:05:11" }, "location": { "description": "Old location code of the address's ip pool (ip_pool.legacylocation), kept for compatibility; null without a pool.", "type": "string", "example": "itp" }, "locationname": { "description": "Name of the data center: the location of the address's ip pool (interface.location.name); null without a pool.", "type": "string", "example": "Equinix FR7", "nullable": true }, "note": { "description": "Free-text note; nullable.", "type": "string", "example": "reserved for customer" }, "protectionstatus": { "description": "DDoS protection status; defaults to 'dynamic'.", "type": "string", "example": "dynamic" }, "inactive": { "description": "Whether the IP is inactive (0/1); defaults to 0.", "type": "integer", "example": "0" }, "owner": { "description": "Owner of the IP; defaults to 'us'.", "type": "string", "example": "us" } }, "type": "object" }, "ResellerKvmPackagesResponse": { "properties": { "id": { "description": "UUID of the reseller KVM package row (reseller_interface_kvm_packages.id)", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "packetid": { "description": "UUID referencing the underlying KVM server packet (kvmserver_packet.id)", "type": "string", "example": "7c9e6679-7425-40de-944b-e07fc1f90ae7" }, "displayname": { "description": "Display name configured for the reseller package (nullable varchar)", "type": "string", "example": "Starter VPS" }, "price": { "description": "Package price (numeric column)", "type": "number", "format": "float", "example": "9.99" }, "oslist": { "description": "OS list identifier/value (varchar, defaults to 'default')", "type": "string", "example": "default" }, "ordernewproductpage": { "description": "Flag whether to order on a new product page (int4, defaults to 0)", "type": "integer", "example": "0" }, "packetinfo": { "description": "Display name of the matching base packet looked up locally from getPacketList(); empty string if no match", "type": "string", "example": "KVM Medium" }, "salestats": { "description": "Locally computed sales statistics object with integer keys salestotal, saleslast30days, activeservices (derived by counting KvmServer rows / active services)", "type": "object" } }, "type": "object" }, "ResellerLanguageExportResponse": { "properties": { "data": { "description": "A JSON-encoded string (JSON_PRETTY_PRINT) of the reseller language's key/value translation pairs. Built locally in ResellerLanguageFactory::exportLanguage() by iterating $data['langstrings'] and mapping each entry's 'key' to its 'value', then json_encode'd into this string. The response value is a string, not a nested object.", "type": "string", "example": "{ 'loginTitle': 'Login', 'dashboardWelcome': 'Welcome' }" } }, "type": "object" }, "ResellerLanguageResponse": { "properties": { "id": { "description": "UUID primary key of the reseller interface language (reseller_interface_language.id)", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "resellerinterfaceid": { "description": "UUID of the parent reseller interface (FK reseller_interface_language.resellerinterfaceid)", "type": "string", "example": "3f2504e0-4f89-11d3-9a0c-0305e82c3301" }, "displayname": { "description": "Display name of the language (reseller_interface_language.displayname, varchar)", "type": "string", "example": "Deutsch" }, "baselang": { "description": "Base language code, e.g. 'en' or 'de' (reseller_interface_language.baselang, varchar)", "type": "string", "example": "de" }, "created_on": { "description": "Creation timestamp (reseller_interface_language.created_on, timestamp). Note: getFields() returns the raw row with no column exclusions.", "type": "string", "example": "2026-06-23 12:00:00" }, "langstrings": { "description": "Array of translation string objects built locally in ResellerLanguage::getLangStrings(). Each item is an object with: key (string, e.g. 'frontend___' or 'backend___'), basetranslation (string, default value from src/frontendlang/.php and src/lang/.php), value (string, the stored override from reseller_interface_language_strings or falling back to basetranslation).", "type": "array", "items": { "type": "object" } } }, "type": "object" }, "ResellerLanguagesResponse": { "properties": { "id": { "description": "UUID primary key of the reseller interface language (column id).", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "resellerinterfaceid": { "description": "UUID foreign key referencing the reseller interface (column resellerinterfaceid).", "type": "string", "example": "7c9e6679-7425-40de-944b-e07fc1f90ae7" }, "displayname": { "description": "Display name of the language (varchar column displayname).", "type": "string", "example": "English" }, "baselang": { "description": "Base language code used as the translation source (varchar column baselang).", "type": "string", "example": "en" }, "created_on": { "description": "Creation timestamp (timestamp column created_on).", "type": "string", "example": "2026-06-23 12:34:56" } }, "type": "object" }, "ResellerNextcloudPackagesResponse": { "properties": { "id": { "description": "UUID of the reseller nextcloud package row (reseller_interface_nextcloud_packages.id)", "type": "string", "example": "9f8b1c2d-3e4f-5a6b-7c8d-9e0f1a2b3c4d" }, "packetid": { "description": "UUID referencing the underlying nextcloud package (reseller_interface_nextcloud_packages.packetid)", "type": "string", "example": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d" }, "displayname": { "description": "Reseller-configured display name (reseller_interface_nextcloud_packages.displayname, varchar, may be null)", "type": "string", "example": "Nextcloud Starter" }, "price": { "description": "Package price (reseller_interface_nextcloud_packages.price, numeric)", "type": "number", "format": "float", "example": "4.99" }, "ordernewproductpage": { "description": "Flag/int for order-new-product page (reseller_interface_nextcloud_packages.ordernewproductpage, int4, default 0)", "type": "integer", "example": "0" }, "packetinfo": { "description": "Display name of the matching base packet from getPacketList(); locally computed, empty string if no matching packet found", "type": "string", "example": "Nextcloud 100GB" } }, "type": "object" }, "ResellerObjectstoragePackagesResponse": { "properties": { "id": { "description": "UUID of the reseller objectstorage package row (reseller_interface_objectstorage_packages.id)", "type": "string", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "packetid": { "description": "UUID referencing the underlying s3_line package (reseller_interface_objectstorage_packages.packetid)", "type": "string", "example": "f0e9d8c7-b6a5-4321-9876-543210fedcba" }, "displayname": { "description": "Reseller-defined display name for the package (column displayname, varchar)", "type": "string", "example": "My Object Storage S" }, "price": { "description": "Reseller package price (column price, numeric)", "type": "number", "format": "float", "example": "4.99" }, "ordernewproductpage": { "description": "Flag/order value controlling display on the order new product page (column ordernewproductpage, int4)", "type": "integer", "example": "1" }, "packetinfo": { "description": "Display name of the matched base packet from getPacketList(); empty string if no matching packet id is found", "type": "string", "example": "Object Storage 100GB" } }, "type": "object" }, "ResellerOrderDedicatedReseponse": { "properties": { "id": { "description": "Serviceid", "type": "string", "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" }, "productid": { "description": "Product id of the created service (1 = dedicated server)", "type": "integer", "example": "1" } }, "type": "object" }, "ResellerOrderExportCsvResponse": { "properties": { "data": { "description": "A CSV-formatted string (header row plus one row per paid ResellerOrder) produced by Functions::array2csv($orderList). The CSV columns are the keys of each ResellerOrder row, but the value is a single serialized CSV string, so the internal columns are not separable JSON fields.", "type": "string", "example": "'id','resellerinterfaceid','paid' '1','42','1'" } }, "type": "object" }, "ResellerOrderGameserverReseponse": { "properties": { "id": { "description": "Serviceid", "type": "string", "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" } }, "type": "object" }, "ResellerOrderKVMReseponse": { "properties": { "id": { "description": "Serviceid", "type": "string", "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" } }, "type": "object" }, "ResellerOrderListResponse": { "properties": { "id": { "description": "Order UUID (reseller_interface_order.id)", "type": "string", "example": "5f8a0c1e-1234-4abc-89de-0123456789ab" }, "resellerinterfaceid": { "description": "Reseller interface UUID", "type": "string", "example": "a1b2c3d4-5678-4abc-89de-0123456789ab" }, "userid": { "description": "End-user UUID", "type": "string", "example": "b2c3d4e5-6789-4abc-89de-0123456789ab" }, "price": { "description": "Order price (numeric column)", "type": "number", "format": "float", "example": "9.99" }, "type": { "description": "Order type identifier", "type": "string", "example": "kvmServerPacket" }, "status": { "description": "Order status (int4)", "type": "integer", "example": "0" }, "paid": { "description": "Paid flag/state (int4)", "type": "integer", "example": "1" }, "paid_on": { "description": "Timestamp string; NOT unix-converted (convert list is empty)", "type": "string", "example": "2026-06-23 10:15:00" }, "created_on": { "description": "Overwritten by Functions::niceDate(); formatted 'H:i:s d.m.Y'", "type": "string", "example": "10:15:00 23.06.2026" }, "serviceid": { "description": "Service UUID (nullable)", "type": "string", "example": "c3d4e5f6-7890-4abc-89de-0123456789ab" }, "priceforreseller": { "description": "Reseller price (numeric, nullable)", "type": "number", "format": "float", "example": "7.50" }, "resellerorderid": { "description": "Linked reseller order UUID (nullable)", "type": "string", "example": "d4e5f6a7-8901-4abc-89de-0123456789ab" }, "tax": { "description": "Tax amount (numeric)", "type": "number", "format": "float", "example": "1.90" }, "tax_country": { "description": "Tax country code (varchar, nullable)", "type": "string", "example": "DE" }, "orderInfo": { "description": "Locally built HTML summary string from getOrderInfo(); content varies by order type, language-dependent labels", "type": "string", "example": "Price: 9.99 €
Service ID: ...
" }, "paymentmethod": { "description": "Payment method displayname resolved from ResellerPaymentMethods, or 'Unknown'", "type": "string", "example": "PayPal" } }, "type": "object" }, "ResellerOrderNextcloudReseponse": { "properties": { "id": { "description": "Serviceid", "type": "string", "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" }, "productid": { "description": "Product id of the created service (5 = Nextcloud)", "type": "integer", "example": "5" } }, "type": "object" }, "ResellerOrderS3Reseponse": { "properties": { "id": { "description": "Serviceid", "type": "string", "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" }, "productid": { "description": "Product id of the created service (7 = object storage)", "type": "integer", "example": "7" } }, "type": "object" }, "ResellerOsListDefaultResponse": { "properties": { "id": { "description": "UUID primary key of the OS entry", "type": "string", "example": "3f9a1c2e-5b7d-4e8a-9c1f-2a3b4c5d6e7f" }, "displayname": { "description": "Human-readable name of the operating system", "type": "string", "example": "Ubuntu 22.04" }, "proxmoxid": { "description": "Proxmox template/VM id for this OS", "type": "integer", "example": "104" }, "type": { "description": "OS type (e.g. linux, windows); nullable", "type": "string", "example": "linux" }, "sort": { "description": "Sort order; nullable", "type": "integer", "example": "10" }, "user": { "description": "Default login user; nullable", "type": "string", "example": "root" }, "cputype": { "description": "CPU type for the VM; nullable", "type": "string", "example": "host" }, "path": { "description": "Image path; nullable", "type": "string", "example": "/var/lib/vz/template/iso/ubuntu.img" }, "pathxeon": { "description": "Image path for Xeon nodes; nullable", "type": "string", "example": "/path/xeon/ubuntu.img" }, "pathxeoneq7": { "description": "Image path for Xeon EQ7 nodes; nullable", "type": "string", "example": "/path/xeoneq7/ubuntu.img" }, "rescuenet": { "description": "Rescue network config; nullable", "type": "string", "example": "dhcp" }, "defaultselected": { "description": "1 = this OS is preselected in the OS dropdowns (0 otherwise)", "type": "integer", "example": "0" } }, "type": "object" }, "ResellerOsListResponse": { "properties": { "id": { "description": "UUID of the OS list (reseller_interface_kvm_packages_os_list.id)", "type": "string", "example": "3f2504e0-4f89-11d3-9a0c-0305e82c3301" }, "resellerinterfaceid": { "description": "UUID of the owning reseller interface", "type": "string", "example": "a1b2c3d4-1111-2222-3333-444455556666" }, "displayname": { "description": "Display name of the OS list", "type": "string", "example": "Linux Distributions" }, "created_on": { "description": "Creation timestamp", "type": "string", "example": "2026-06-23 14:05:00" }, "oslist": { "description": "Array of OS entries assigned to this list. Each element is a full kvmserver_os row (id:string, displayname:string, proxmoxid:integer, active:integer, created_on:string, type:string, sort:integer, user:string, cputype:string, path:string, pathxeon:string, pathxeoneq7:string, rescuenet:string, defaultselected:integer) plus an 'oslistdata' object holding the reseller_interface_kvm_packages_os_entries row (id:string, oslist:string, osid:string, created_on:string). Built via ResellerOsList::getOSList().", "type": "array", "items": { "type": "object" } } }, "type": "object" }, "ResellerPacketListResponse": { "properties": { "type": { "description": "Discriminator added in the factory. One of: 'kvmpackage' (from kvmserver_packet), 'nextcloudpackage' (from nextcloud_package), 'dedicatedpackage' (from dedi_packet), 'objectstoragepackage' (from s3_line). The response is a heterogeneous array; the fields below are the union across these four packet variants. Only the fields of the matching variant are present on a given item.", "type": "string", "example": "kvmpackage" }, "id": { "description": "uuid primary key. Present on ALL variants.", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "displayname": { "description": "varchar. Present on all variants (kvmserver_packet, nextcloud_package, dedi_packet, s3_line).", "type": "string", "example": "Premium VPS" }, "price": { "description": "numeric. Present on kvmpackage, nextcloudpackage and dedicatedpackage variants.", "type": "number", "format": "float", "example": "9.99" }, "traffic": { "description": "kvmpackage: numeric. nextcloudpackage: int4 (integer). Present on kvm/nextcloud variants.", "type": "number", "format": "float", "example": "5000" }, "stock": { "description": "int4. Present on dedicatedpackage (dedi_packet) and objectstoragepackage (s3_line) variants.", "type": "integer", "example": "1" }, "sort": { "description": "nextcloudpackage only: sort column is varchar (string) in nextcloud_package and is NOT excluded by getData(). Note: kvm and dedi variants EXCLUDE sort.", "type": "string", "example": "1" }, "created_on": { "description": "timestamp string. Present ONLY on nextcloudpackage and objectstoragepackage variants (they return full fields). kvm/dedi variants EXCLUDE created_on.", "type": "string", "example": "2024-01-15 12:00:00" }, "line": { "description": "kvmpackage and dedicatedpackage: varchar.", "type": "string", "example": "amdgen3" }, "cores": { "description": "kvmpackage: int4 (integer). dedicatedpackage: varchar (string). Differs by variant.", "type": "integer", "example": "4" }, "memory": { "description": "kvmpackage only: int4.", "type": "integer", "example": "8192" }, "disk": { "description": "kvmpackage only: int4.", "type": "integer", "example": "100" }, "uplink": { "description": "kvmpackage: int4 (integer). dedicatedpackage: varchar (string).", "type": "integer", "example": "1000" }, "ipv4": { "description": "kvmpackage only: int4.", "type": "integer", "example": "1" }, "ipv6": { "description": "kvmpackage only: int4.", "type": "integer", "example": "1" }, "active": { "description": "kvmpackage only: int4. When dynamicstock==1, getData() overwrites this with getDynamicStock() (still an integer count).", "type": "integer", "example": "1" }, "ghzbase": { "description": "varchar. kvmpackage and dedicatedpackage.", "type": "string", "example": "2.4" }, "ghzturbo": { "description": "varchar. kvmpackage and dedicatedpackage.", "type": "string", "example": "3.6" }, "discount": { "description": "kvmpackage only: int4.", "type": "integer", "example": "0" }, "firstpayment": { "description": "kvmpackage only: int4.", "type": "integer", "example": "0" }, "discountedprice": { "description": "kvmpackage only: numeric.", "type": "number", "format": "float", "example": "7.99" }, "nodetype": { "description": "kvmpackage only: varchar.", "type": "string", "example": "epyc" }, "mindays": { "description": "kvmpackage only: int4.", "type": "integer", "example": "30" }, "sale": { "description": "kvmpackage only: int4.", "type": "integer", "example": "0" }, "cluster": { "description": "kvmpackage only: varchar.", "type": "string", "example": "cluster1" }, "extradisk": { "description": "kvmpackage only: int4.", "type": "integer", "example": "0" }, "upgrade": { "description": "kvmpackage only: int4.", "type": "integer", "example": "0" }, "protection": { "description": "kvmpackage only: the old ip pool code (combahton, voxility, cgt) of the packet's cluster pool (ip_pool.legacytype), kept for compatibility; the DDoS mitigation customers see is in mitigation.", "type": "string", "example": "combahton" }, "resellerdiscount": { "description": "kvmpackage only: int4.", "type": "integer", "example": "0" }, "location": { "description": "kvmpackage and dedicatedpackage. kvmpackage: the old location code (cgt, itp, eq7) of the packet's cluster pool (ip_pool.legacylocation), kept for compatibility, the readable name is in locationname. dedicatedpackage: the name of the location of the package's ip pool.", "type": "string", "example": "eq7" }, "locationname": { "description": "kvmpackage and dedicatedpackage: name of the data center (interface.location.name, e.g. \"Equinix FR7\", \"Equinix FR5\", \"Cogent DC\", \"NorthC FR3\"). kvmpackage: the location of the packet's cluster (its ip pool's). dedicatedpackage: the location of the package's ip pool. null when no pool / location is known.", "type": "string", "example": "Equinix FR7", "nullable": true }, "mitigation": { "description": "kvmpackage and dedicatedpackage: DDoS mitigation of that data center (interface.location.mitigation, e.g. \"AS203446 SmartMitigate\"). null when no pool / location is known.", "type": "string", "example": "AS203446 SmartMitigate", "nullable": true }, "backupslots": { "description": "kvmpackage only: int. Backup slots a new service of this packet gets (kvmserver_packet.backupslots, default 4). Copied into the service on order; additional slots can be booked as an addon later.", "type": "integer", "example": "4" }, "default": { "description": "kvmpackage only: int4.", "type": "integer", "example": "1" }, "memorytype": { "description": "kvmpackage only: varchar.", "type": "string", "example": "ddr4" }, "cputype": { "description": "kvmpackage only: varchar.", "type": "string", "example": "AMD EPYC" }, "dynamicstock": { "description": "kvmpackage only: int4.", "type": "integer", "example": "0" }, "cpu": { "description": "dedicatedpackage only: varchar.", "type": "string", "example": "Intel Xeon Gold" }, "threads": { "description": "dedicatedpackage only: varchar (string).", "type": "string", "example": "8" }, "rambase": { "description": "dedicatedpackage only: varchar.", "type": "string", "example": "32GB" }, "rammax": { "description": "dedicatedpackage only: varchar.", "type": "string", "example": "128GB" }, "diskbase": { "description": "dedicatedpackage only: varchar.", "type": "string", "example": "1TB" }, "diskmax": { "description": "dedicatedpackage only: varchar.", "type": "string", "example": "4TB" }, "country": { "description": "kvmpackage and dedicatedpackage: country of the data center, same wording for both (e.g. \"Deutschland\"). dedicatedpackage: from the location of the package's ip pool. kvmpackage: from the location of the packet's cluster. null when none is known.", "type": "string", "example": "Deutschland", "nullable": true }, "countrycode": { "description": "kvmpackage and dedicatedpackage: country of the data center as ISO 3166-1 alpha-2 code, upper case, so a shop can show the country in its own language. dedicatedpackage: from the location of the package's ip pool. kvmpackage: from the location of the packet's cluster. null when none is known.", "type": "string", "example": "DE", "nullable": true }, "city": { "description": "kvmpackage and dedicatedpackage: city of the data center as a proper name. dedicatedpackage: from the location of the package's ip pool. kvmpackage: from the location of the packet's cluster. null when none is known.", "type": "string", "example": "Frankfurt am Main", "nullable": true }, "cpubench": { "description": "dedicatedpackage only: int4.", "type": "integer", "example": "25000" }, "mainboard": { "description": "dedicatedpackage only: uuid.", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440099" }, "setup": { "description": "dedicatedpackage only: numeric.", "type": "number", "format": "float", "example": "49.00" }, "cpuid": { "description": "dedicatedpackage only: uuid.", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440088" }, "uplinkid": { "description": "dedicatedpackage only: uuid.", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440077" }, "locationstring": { "description": "dedicatedpackage only: code of the location of the package's ip pool (interface.location.code), null without a pool.", "type": "string", "example": "northc", "nullable": true }, "cpucount": { "description": "dedicatedpackage only: int4.", "type": "integer", "example": "1" }, "deploytime": { "description": "dedicatedpackage only: int4.", "type": "integer", "example": "7" }, "storage": { "description": "nextcloudpackage only: int4.", "type": "integer", "example": "100" }, "status": { "description": "nextcloudpackage only: int4.", "type": "integer", "example": "1" }, "pricepertb": { "description": "objectstoragepackage only: numeric.", "type": "number", "format": "float", "example": "5.00" }, "maxbooking": { "description": "objectstoragepackage only: numeric.", "type": "number", "format": "float", "example": "100" }, "maxbucketsize": { "description": "objectstoragepackage only: numeric.", "type": "number", "format": "float", "example": "50" }, "maxbucketfilecount": { "description": "objectstoragepackage only: numeric.", "type": "number", "format": "float", "example": "1000000" }, "maxbuckets": { "description": "objectstoragepackage only: numeric.", "type": "number", "format": "float", "example": "10" }, "mintb": { "description": "objectstoragepackage only: numeric.", "type": "number", "format": "float", "example": "1" }, "trafficpertb": { "description": "objectstoragepackage only: int4.", "type": "integer", "example": "1000" } }, "type": "object" }, "ResellerPaymentListResponse": { "properties": { "id": { "description": "UUID primary key of the payment method row", "type": "string", "example": "3f8a1c2e-1b2d-4c3e-9a7f-0d1e2f3a4b5c" }, "resellerinterfaceid": { "description": "UUID of the reseller interface this payment method belongs to (foreign key)", "type": "string", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "provider": { "description": "Payment provider identifier", "type": "string", "example": "mollie" }, "displayname": { "description": "Human-readable display name of the payment method", "type": "string", "example": "Credit Card" }, "created_on": { "description": "Timestamp when the row was created", "type": "string", "example": "2026-06-23 12:34:56" }, "name": { "description": "Internal name of the payment method (nullable)", "type": "string", "example": "card" }, "fee": { "description": "Fee associated with the payment method (int, default 0, nullable)", "type": "integer", "example": "0" } }, "type": "object" }, "ResellerSingleInvoiceResponse": { "properties": { "data": { "description": "Base64-encoded PDF document of the reseller order invoice. Built by ResellerOrder::getInvoice() via base64_encode($invoicr->returnPDF($color)); the underlying PDF binary is generated by the Invoicr library (src/includes/invlib/invoicr.php) so its raw byte content is not determinable from source — only the field key and that it is a base64 string are known.", "type": "string", "example": "JVBERi0xLjcKJeLjz9MKMyAwIG9iago8PC9..." } }, "type": "object" }, "ResellerSubResellersResponse": { "properties": { "id": { "description": "Sub-reseller interface UUID (reseller_interfaces.id)", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "displayname": { "description": "Display name of the sub-reseller interface", "type": "string", "example": "My Sub Reseller" }, "domain": { "description": "Domain of the sub-reseller interface", "type": "string", "example": "panel.example.com" }, "userid": { "description": "Owning user UUID (reseller_interfaces.userid)", "type": "string", "example": "7c9e6679-7425-40de-944b-e07fc1f90ae7" }, "status": { "description": "Status flag (int4, default 0)", "type": "integer", "example": "1" }, "primaryinterfaceid": { "description": "Parent/primary reseller interface UUID", "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "type": "object" }, "ResellerTicketDetailsResponse": { "properties": { "id": { "description": "Ticket UUID (reseller_interface_support_main.id)", "type": "string", "example": "8f3c2b1a-1234-4cde-9876-abcdef012345" }, "userid": { "description": "Owning user UUID", "type": "string", "example": "1a2b3c4d-5678-4abc-9012-3456789abcde" }, "title": { "description": "Ticket title (varchar)", "type": "string", "example": "Server not reachable" }, "answers": { "description": "Array of answer objects from ResellerTicketAnswer::getData. Each item: content (string; n replaced by
), created_on (integer unix timestamp from strtotime), internal (integer, int4), admin (integer, int4), author (object with username string; for admin answers prefixed with support label / reseller support display name)", "type": "array", "items": { "type": "object" } }, "created_on": { "description": "Ticket creation time as unix timestamp (strtotime of timestamp column)", "type": "integer", "example": "1719000000" }, "last_update": { "description": "Ticket last update time as unix timestamp (strtotime of timestamp column)", "type": "integer", "example": "1719100000" }, "service": { "description": "Only present when ticket.service != 'none'. Object with id (string, the service id), productid (string, Service model's productid column value, null when the service row was already purged by the service cleanup) and deleted (integer, 1 when the service is deleted or purged, else 0)", "type": "object" }, "userinfo": { "description": "Present because controller calls getData with admin=1. Object with id (string, the ticket userid)", "type": "object" }, "defaultconent": { "description": "Present because admin=1. Greeting/signature text built from lang strings and the ResellerInterface supportsignature / supportdisplayname values (sic: key is spelled 'defaultconent')", "type": "string", "example": "Hallo, Mit freundlichen Grüßen, Supportname" }, "status": { "description": "Status object from ResellerTicketStatus::getData: bgcolor (string), textcolor (string), status (string), text (string, resolved lang string for langtag)", "type": "object" } }, "type": "object" }, "ResellerTicketListResponse": { "properties": { "id": { "description": "Ticket UUID (id column, varchar/uuid).", "type": "string", "example": "9b2e1c4a-5f3d-4a8b-9c1e-7d2f6a0b3c5e" }, "userid": { "description": "Owning user's UUID (userid column).", "type": "string", "example": "1a2b3c4d-5e6f-4071-8a9b-0c1d2e3f4a5b" }, "userinfo": { "description": "Nested object built from the User model: id (string UUID, = userid), email (string), username (string).", "type": "object" }, "title": { "description": "Ticket title (title column, varchar).", "type": "string", "example": "Cannot access my server" }, "created_on": { "description": "Creation time as Unix timestamp via strtotime(created_on timestamp column).", "type": "integer", "example": "1718000000" }, "last_update": { "description": "Last update time as Unix timestamp via strtotime(last_update timestamp column).", "type": "integer", "example": "1718100000" }, "status": { "description": "Nested object from ResellerTicketStatus::getData(): bgcolor (string), textcolor (string), status (string), text (string, translated lang string from langtag).", "type": "object" } }, "type": "object" }, "ResellerTicketStatusListResponse": { "properties": { "bgcolor": { "description": "Background color for the status badge (varchar column 'bgcolor').", "type": "string", "example": "#FF0000" }, "textcolor": { "description": "Text color for the status badge (varchar column 'textcolor').", "type": "string", "example": "#FFFFFF" }, "status": { "description": "Status identifier/value (varchar column 'status').", "type": "string", "example": "open" }, "text": { "description": "Localized display label resolved from the row's 'langtag' column via the language/translation system.", "type": "string", "example": "Open" } }, "type": "object" }, "ResellerTicketTemplateListResponse": { "properties": { "id": { "description": "UUID primary key of the ticket template (uuid column).", "type": "string", "example": "a3f1c2e4-5b6d-7e8f-9a0b-1c2d3e4f5a6b" }, "resellerinterfaceid": { "description": "UUID of the reseller interface this template belongs to (uuid column, FK to reseller_interfaces.id).", "type": "string", "example": "b4e2d3f5-6c7e-8f9a-0b1c-2d3e4f5a6b7c" }, "title": { "description": "Template title (text column).", "type": "string", "example": "Welcome Reply" }, "template": { "description": "Template body text (text column named 'template').", "type": "string", "example": "Hello, thank you for contacting support..." }, "lang": { "description": "Language code of the template (varchar column).", "type": "string", "example": "de" }, "created_on": { "description": "Creation timestamp (timestamp column, CURRENT_TIMESTAMP default).", "type": "string", "example": "2026-06-23 14:32:10" } }, "type": "object" }, "ResellerUserCreateResponse": { "properties": { "id": { "description": "Userid", "type": "string", "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" } }, "type": "object" }, "ResellerUserPermissionsResponse": { "properties": { "key": { "description": "Permission group key (from the literal $this->permissions array).", "type": "string", "example": "creditcodes" }, "name": { "description": "Localized display name resolved via Lang::getString() from the language key (e.g. 'permissionCreditCodes').", "type": "string", "example": "Credit Codes" }, "description": { "description": "Localized description resolved via Lang::getString(); the group literal has no 'description' key so this is looked up from an undefined value, but still returns a string.", "type": "string", "example": "" }, "active": { "description": "Whether the group permission is active for the user: 1 if a matching ResellerPermission row exists, else 0.", "type": "integer", "example": "0" }, "permissions": { "description": "Array of sub-permission items. Each item has: key (string, e.g. 'create'/'delete'/'edit'), name (string, localized via Lang), description (string, localized via Lang), active (integer 0 or 1 indicating whether the user has the sub-permission).", "type": "array", "items": { "type": "object" } } }, "type": "object" }, "ServiceActionLogsResponse": { "properties": { "log": { "description": "Localized human-readable log message. Built by Lang::getStringWithData(langtag, json_decode(data)) — the translation template for the row's langtag with {{placeholders}} replaced from the stored JSON data. Falls back to the raw langtag string if no translation exists.", "type": "string", "example": "Server was started" }, "time": { "description": "Timestamp of the log entry, formatted via Functions::niceDate(created_on) as PHP date('H:i:s d.m.Y'). Always a formatted string, not a unix timestamp.", "type": "string", "example": "14:32:05 23.06.2026" } }, "type": "object" }, "ServiceActivityLogsResponse": { "properties": { "event": { "description": "The Calagopus activity event key (e.g. server:power.action, server:console.command). Value originates from the external Calagopus panel activities.data[].event, but the field is always present and is a string.", "type": "string", "example": "server:console.command" }, "timestamp": { "description": "ISO-8601 datetime string of when the activity occurred, taken verbatim from the external Calagopus activities.data[].created (no unix conversion applied).", "type": "string", "example": "2026-06-23T10:15:42+00:00" } }, "type": "object" }, "ServiceAddonListResponse": { "properties": { "type": { "description": "Addon type identifier (e.g. ipv4, trafficreset, backupslot, traffic, core, memory, disk).", "type": "string", "example": "ipv4" }, "once": { "description": "Flag (0/1) whether the addon is a one-time charge (1) or recurring (0).", "type": "integer", "example": "0" }, "max": { "description": "Maximum bookable quantity of this addon. For KvmServer (productid 2) and Gameserver (productid 4) it is computed as a remaining-capacity value (limit minus already-booked count) and can therefore be lower; for ObjectStorage (productid 7) the traffic limit is 10x the booked storage TB minus already-booked addons; otherwise it is a fixed literal.", "type": "integer", "example": "128" }, "price": { "description": "Unit price of the addon. Fixed literal for most products; for KvmServer/Gameserver core/memory/disk it is overridden with a per-unit price (e.g. 1, 0.50, 0.40, 0.30).", "type": "number", "format": "float", "example": "0.99" }, "name": { "description": "Localized display name resolved via the language service (getLang()->getString(...)); exact text depends on the active language file.", "type": "string", "example": "Additional IPv4 Address" } }, "type": "object" }, "ServiceAddonsResponse": { "properties": { "id": { "description": "UUID primary key of the service_addon row (service_addon.id).", "type": "string", "example": "a1b2c3d4-e5f6-4789-abcd-1234567890ab" }, "serviceid": { "description": "UUID of the owning service (service_addon.serviceid).", "type": "string", "example": "0f8e7d6c-5b4a-4321-9876-abcdef012345" }, "type": { "description": "Addon type, e.g. ipv4, trafficreset, backupslot, traffic, core, memory, disk (service_addon.type).", "type": "string", "example": "core" }, "price": { "description": "Monthly price of the addon (service_addon.price, numeric).", "type": "number", "format": "float", "example": "3.95" }, "created_on": { "description": "Creation timestamp (service_addon.created_on). Returned as a raw SQL timestamp string; getData() returns $this->fields directly without convertTimeToUnix.", "type": "string", "example": "2026-01-15 12:34:56" }, "name": { "description": "Human-readable, localized display name resolved from ServiceAddon::getAddonInfo() by matching on type. Only injected when the addon's type matches a known entry; the text is a language string so the literal value is locale-dependent.", "type": "string", "example": "CPU Core" }, "deletable": { "description": "Computed in ServiceFactory::getAddonsList(): true if type is traffic/backupslot/core/memory, or if the service productid is 4 (Gameserver); otherwise false.", "type": "boolean", "example": "true" } }, "type": "object" }, "ServiceBackupResponse": { "properties": { "backupname": { "description": "Value", "type": "string", "example": "vm/1082/2022-04-29T18:26:57Z" }, "created_on": { "description": "Value", "type": "string", "example": "2022-04-29 18:26:56.675968" }, "displayname": { "description": "Value", "type": "string", "example": "name" }, "id": { "description": "Value", "type": "string", "example": "8629051f-ddd0-4953-9b01-faa9a4220df1" }, "proxmoxid": { "description": "Value", "type": "string", "example": "1082" } }, "type": "object" }, "ServiceBucketDetailsResponse": { "properties": { "name": { "description": "Bucket name (from external RGW bucket list, key $bucket['bucket']).", "type": "string", "example": "my-backup-bucket" }, "size": { "description": "Total size of the bucket in bytes (usage.rgw.main.size from RGW; defaults to 0 when missing).", "type": "integer", "example": "104857600" }, "objects": { "description": "Number of objects in the bucket (usage.rgw.main.num_objects from RGW; defaults to 0 when missing).", "type": "integer", "example": "42" }, "created": { "description": "Bucket creation timestamp (creation_time from RGW), passed through as a string.", "type": "string", "example": "2026-05-14T09:31:22.000000Z" }, "traffic": { "description": "Traffic totals for the bucket since the later of creation date or month start. Object with two integer keys: 'in' (intval of bytes_in sum from S3BucketTrafficProcessed) and 'out' (intval of bytes_out sum). Both default to 0 when no rows.", "type": "object" } }, "type": "object" }, "ServiceBucketListResponse": { "properties": { "name": { "description": "Bucket name (from external RGW field 'bucket').", "type": "string", "example": "my-bucket" }, "size": { "description": "Bucket size in bytes (from usage.rgw.main.size; defaults to 0 when missing/null).", "type": "integer", "example": "1048576" }, "objects": { "description": "Number of objects in the bucket (from usage.rgw.main.num_objects; defaults to 0 when missing/null).", "type": "integer", "example": "42" }, "created": { "description": "Bucket creation timestamp (from external RGW field 'creation_time').", "type": "string", "example": "2024-05-01T12:34:56.000000Z" } }, "type": "object" }, "ServiceBucketRequestStatisticsResponse": { "properties": { "date": { "description": "The day the requests were grouped by, from ClickHouse toDate(time). Date string in YYYY-MM-DD format.", "type": "string", "example": "2026-06-23" }, "method": { "description": "The HTTP request method the row aggregates (e.g. GET, PUT, DELETE, HEAD), from the s3_access_logs.method column.", "type": "string", "example": "GET" }, "requests": { "description": "Number of requests for that date+method combination (ClickHouse count()). Note: ClickHouse JSON typically encodes count() as a numeric string.", "type": "integer", "example": "1432" } }, "type": "object" }, "ServiceBucketRequestsResponse": { "properties": { "data": { "description": "Raw rows from a ClickHouse 'SELECT * FROM s3_access_logs WHERE bucket = :bucket AND time > :starttime ORDER BY time DESC LIMIT :start, 50' query ($data->rawData()['data']). The per-row columns come from the external ClickHouse table s3_access_logs (not defined in this repo's interface struct.sql), so the item shape cannot be determined here. Each item is an access-log entry object.", "type": "array", "items": { "type": "object" } }, "pageInfo": { "description": "Pagination metadata, built locally. Contains: stepsize (integer, hardcoded 50 = page size / LIMIT count), last (integer, the 'start' offset from $_GET['start'], defaults to 0), total (integer, intval of COUNT(*) of matching s3_access_logs rows).", "type": "object" } }, "type": "object" }, "ServiceBucketTrafficResponse": { "properties": { "history": { "description": "Container object holding two traffic time-series. 'last30days' is an array of daily-aggregated entries for the last 30 days; 'months' is an array of monthly-aggregated entries since bucket creation. Each entry is an object {date:string ('Y-m-d H:i:s'), in:number (inbound MB), out:number (outbound MB)}. Built from the s3bucket_traffic_processed rows (bytes_in/bytes_out divided by 1,000,000) via explicit array literals, not raw row passthrough. When no traffic exists, each list contains a single zeroed placeholder entry.", "type": "object" } }, "type": "object" }, "ServiceCronResponse": { "properties": { "action": { "description": "Value", "type": "string", "example": "start" }, "created_on": { "description": "Value", "type": "string", "example": "2022-04-29 18:26:56.675968" }, "displayname": { "description": "Value", "type": "string", "example": "name" }, "expression": { "description": "Value", "type": "string", "example": "* * * * *" }, "id": { "description": "Value", "type": "string", "example": "8629051f-ddd0-4953-9b01-faa9a4220df1" }, "kvmid": { "description": "Value", "type": "string", "example": "c4e3f65f-3e77-4c8a-9eb7-8bdb63c43620" }, "nextexecute": { "description": "Value", "type": "string", "example": "2022-04-29 20:31:00" }, "status": { "description": "Value", "type": "integer", "example": "1" } }, "type": "object" }, "ServiceCustomIsoListResponse": { "properties": { "id": { "description": "UUID primary key of the custom ISO (kvmserver_custom_iso.id).", "type": "string", "example": "b3c1f2a4-5d6e-4f70-8a9b-0c1d2e3f4a5b" }, "userid": { "description": "UUID of the owning user (kvmserver_custom_iso.userid).", "type": "string", "example": "a1b2c3d4-e5f6-4789-9abc-def012345678" }, "isolink": { "description": "Source URL the ISO was/will be downloaded from (kvmserver_custom_iso.isolink).", "type": "string", "example": "https://example.com/debian-12.iso" }, "name": { "description": "Display name of the custom ISO (kvmserver_custom_iso.name).", "type": "string", "example": "Debian 12 netinst" }, "created_on": { "description": "Creation timestamp (kvmserver_custom_iso.created_on). Included unchanged because getFields() applies no exclusions.", "type": "string", "example": "2026-06-23 10:15:00" }, "status": { "description": "ISO status: 0=downloading, 1=active/download done, 2=error, 3=mounted. Stored column value, but overwritten to 3 at runtime if the ISO is currently mounted on the VM (determined via Proxmox config).", "type": "integer", "example": "1" }, "proxmoxid": { "description": "Proxmox task id used to track the download (kvmserver_custom_iso.proxmoxid). Nullable.", "type": "string", "example": "UPID:node1:0000ABCD:...:download:" }, "kvmserver": { "description": "UUID of the associated KVM server (kvmserver_custom_iso.kvmserver). Nullable.", "type": "string", "example": "c4d5e6f7-8a9b-4c0d-1e2f-3a4b5c6d7e8f" }, "locationid": { "description": "The data center whose customiso storage holds the ISO: the location of the server's cluster pool (kvmserver_custom_iso.locationid, a uuid of interface.location).", "type": "string", "example": "0b5e8c1a-6a1f-4c2e-9d8e-3f1a2b4c5d6e", "nullable": true }, "percentage": { "description": "Download progress percent. Only present when status==0 (download in progress). Value is parsed from the external Proxmox task log, so its exact value is not determinable from this repo; the key itself is added locally.", "type": "string", "example": "42" } }, "type": "object" }, "ServiceDowngradeInfoResponse": { "properties": { "extradays": { "description": "Runtime added to the service when downgrading to this packet, in days. The prorated remaining value of the current packet ((currentPacketPrice - newPacketPrice)/30 * remainingDays) is converted into runtime at the new monthly price, rounded to 2 decimals.", "type": "number", "format": "float", "example": "8.53" }, "price": { "description": "Base monthly price of the target downgrade packet (kvmserver_packet.price).", "type": "number", "format": "float", "example": "4.99" }, "monthlyprice": { "description": "New effective monthly price of the service after downgrade: currentServicePrice - currentPacketPrice + newPacketPrice, rounded to 2 decimals.", "type": "number", "format": "float", "example": "6.99" }, "displayname": { "description": "Display name of the target downgrade packet (kvmserver_packet.displayname).", "type": "string", "example": "VPS Premium S" }, "id": { "description": "UUID of the target downgrade packet (kvmserver_packet.id).", "type": "string", "example": "3f8c1a2e-4b7d-4c9a-8e21-9d5f6a7b1c0e" }, "cores": { "description": "CPU cores of the target packet (kvmserver_packet.cores).", "type": "integer", "example": "2" }, "memory": { "description": "Memory of the target packet in MB (kvmserver_packet.memory).", "type": "integer", "example": "4096" }, "disk": { "description": "Disk of the target packet in MB (kvmserver_packet.disk).", "type": "integer", "example": "81920" }, "reinstall": { "description": "1 when the target packet's disk (including disk addons) is smaller than the currently provisioned disk, so the downgrade requires a full reinstallation (all data and all backups of the server are deleted, POST needs `confirmname` and `confirmdelete`). 0 when the downgrade is applied as a config change only, data and backups are kept.", "type": "integer", "example": "1" } }, "type": "object" }, "ServiceExtendResponse": { "properties": { "id": { "description": "Value", "type": "string", "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" } }, "type": "object" }, "ServiceFileContentResponse": { "properties": { "data": { "description": "Raw contents of the requested file as a plain string. Returned verbatim from the external Calagopus game panel (GET client/servers/{id}/files/contents?file=...) with rawresponse=true, so the panel response body is passed through unparsed. The actual text depends entirely on the file requested and cannot be determined from this repository.", "type": "string", "example": "# server.properties max-players=20 motd=A Minecraft Server level-name=world" } }, "type": "object" }, "ServiceFileDownloadResponse": { "properties": { "link": { "description": "Signed one-time download URL for the requested file. Built locally as the single response key, but its value is returned verbatim from the Calagopus game-panel HTTP API (GET servers/{id}/files/download?root=...&files=... -> url) and therefore cannot be determined from this repo. If the panel returns no url, this value is an empty array ([]) instead of a string.", "type": "string", "example": "https://node01.panel.example.com/download/file?token=eyJ..." } }, "type": "object" }, "ServiceFilesResponse": { "properties": { "sizedisplay": { "description": "Human-readable file size, computed locally via Functions::humanFileSize() from the external attributes['size'] byte count. This is the only field added by this codebase.", "type": "string", "example": "1.2 MB" }, "size": { "description": "File size in bytes. Comes from the external Calagopus panel response (entry `size`); always present because Gameserver::convertFileEntry defaults it to 0 and the code reads it to compute sizedisplay.", "type": "integer", "example": "1258291" } }, "type": "object" }, "ServiceGameConfigResponse": { "properties": { "data": { "description": "Raw textual content of the requested game config file. Fetched verbatim from the external Calagopus game-panel HTTP API (GET client/servers/{id}/files/contents?file=...) and returned as an opaque raw response string. Only validated text/plain, application/json or text/xml files are allowed. The internal structure/keys of this string are NOT determinable from this repo since they depend on the specific game/config file.", "type": "string", "example": "server-name=My Server max-players=20 difficulty=hard pvp=true" } }, "type": "object" }, "ServiceGameConfigsResponse": { "properties": { "sizedisplay": { "description": "Human-readable file size, computed locally via Functions::humanFileSize($pteroFile['size']).", "type": "string", "example": "1.2 KB" }, "dir": { "description": "Directory the config file lives in, taken locally from the GameserverGameConfigs row ($file->getValue('dir')).", "type": "string", "example": "/config" } }, "type": "object" }, "ServiceGameListResponse": { "properties": { "id": { "description": "UUID primary key of the gameserver_game row.", "type": "string", "example": "3f1c2e9a-1b2c-4d5e-8a9b-0c1d2e3f4a5b" }, "displayname": { "description": "Display name of the game.", "type": "string", "example": "Minecraft" }, "productinterfaceimage": { "description": "Product interface image filename/path.", "type": "string", "example": "minecraft.png" }, "created_on": { "description": "Creation timestamp (not excluded by getData(); returned as-is).", "type": "string", "example": "2024-01-15 12:30:00" }, "versionstring": { "description": "Version string label.", "type": "string", "example": "1.20.4" }, "steamid": { "description": "Steam app id (nullable).", "type": "integer", "example": "730" }, "steamconnectstring": { "description": "Steam connect string (nullable).", "type": "string", "example": "+connect" }, "easyname": { "description": "Machine-friendly short name (nullable).", "type": "string", "example": "minecraft" }, "status": { "description": "Status flag; list is filtered to status=1, so always 1.", "type": "integer", "example": "1" }, "portstart": { "description": "Start of port range (nullable).", "type": "integer", "example": "25565" }, "portend": { "description": "End of port range (nullable).", "type": "integer", "example": "25575" }, "extraports": { "description": "Number of extra ports (default 0).", "type": "integer", "example": "0" }, "icon": { "description": "Icon filename/path (nullable).", "type": "string", "example": "mc-icon.svg" }, "sort": { "description": "Sort order (list ordered by sort ASC).", "type": "integer", "example": "10" }, "type": { "description": "Configuration type, e.g. 'slots' or memory-based (nullable).", "type": "string", "example": "slots" }, "minvalue": { "description": "Minimum slots/memory value (varchar, nullable).", "type": "string", "example": "2" }, "maxvalue": { "description": "Maximum slots/memory value (varchar, nullable).", "type": "string", "example": "64" }, "slotstring": { "description": "Label for slot unit (nullable).", "type": "string", "example": "Slots" }, "minstorage": { "description": "Minimum storage in GB (nullable).", "type": "integer", "example": "5" }, "minmemory": { "description": "Minimum memory (default 0).", "type": "integer", "example": "1024" }, "versionsort": { "description": "How versions are ordered ('default' or 'created_on'); drives the versions list ordering.", "type": "string", "example": "default" }, "modmanager": { "description": "Whether a mod manager is available (default 0).", "type": "integer", "example": "0" }, "versionchange": { "description": "Whether version change is allowed (default 1).", "type": "integer", "example": "1" }, "versions": { "description": "Added by getData(): array of raw gameserver_version rows for this game (getAll(..., json=true) returns DB rows directly). Each item has columns: id (string/uuid), game (string/uuid), version (string), egg (string), dockerimage (string), created_on (string/timestamp), sort (integer), startup (string/text, nullable), type (string, nullable), downloadurl (string, nullable). Ordered by sort ASC or created_on DESC depending on the parent's versionsort.", "type": "array", "items": { "type": "object" } } }, "type": "object" }, "ServiceGameSettingsResponse": { "properties": { "value": { "description": "Current value of the setting. Always coerced to a string here, but its concrete content is read from external sources (the server's config file via getFileContent, the Calagopus panel variable value, or the current docker image name), so the actual value cannot be determined from this repo.", "type": "string", "example": "true" }, "default": { "description": "Default value of the setting, from the gameserver_game_settings.default varchar column (or the literal 'true'/'false' for booleans, or a converted Java version name for the docker-image custom setting).", "type": "string", "example": "false" }, "key": { "description": "The setting variable name, from the gameserver_game_settings.variable varchar column.", "type": "string", "example": "difficulty" }, "sort": { "description": "Sort order, from the gameserver_game_settings.sort int4 column. Used to order the list via usort. (Absent on the custom docker-image entry path? No - it is included in all branches.)", "type": "integer", "example": "10" }, "type": { "description": "Input/control type, from the gameserver_game_settings.type varchar column (e.g. select, bool, text).", "type": "string", "example": "select" }, "typedata": { "description": "json_decode of the gameserver_game_settings.typedata varchar (arbitrary JSON, typically an array of allowed values or an options object). For the custom docker-image setting it is a hardcoded array of Java version names.", "type": "object" }, "header": { "description": "Localized display label, resolved from the language file via getString(easyname__header). Comes from a local lang file but is keyed dynamically.", "type": "string", "example": "Difficulty" }, "desc": { "description": "Localized description, resolved from the language file via getString(easyname__desc). Local lang file, keyed dynamically; empty string for the custom docker-image setting.", "type": "string", "example": "Sets the world difficulty." } }, "type": "object" }, "ServiceHardwareResponse": { "properties": { "cores": { "description": "Number of vCPU cores (kvmserver_main.cores, int4).", "type": "integer", "example": "4" }, "memory": { "description": "RAM in MB (kvmserver_main.memory, int4).", "type": "integer", "example": "8192" }, "disk": { "description": "Disk size (kvmserver_main.disk, int4).", "type": "integer", "example": "120" }, "uplink": { "description": "Network uplink in Mbit/s (kvmserver_main.uplink, int4).", "type": "integer", "example": "1000" }, "cputype": { "description": "CPU type (kvmserver_main.cputype, varchar; e.g. 'host' or 'IvyBridge').", "type": "string", "example": "IvyBridge" }, "hostname": { "description": "Server hostname; either the stored kvmserver_main.hostname or a generated 'v.' value.", "type": "string", "example": "v1234.datalix.de" }, "editcputype": { "description": "Flag 0/1 whether the CPU type may be edited (1 unless the node default cputype is 'host').", "type": "integer", "example": "1" }, "storagetype": { "description": "Localized storage type label (lang string 'localraid1nvme').", "type": "string", "example": "Local RAID1 NVMe" }, "traffic": { "description": "Included traffic in TB (packet traffic capped at 1, plus additionaltraffic).", "type": "integer", "example": "1" }, "extradisk": { "description": "Extra disk from packet (packet extradisk if >1, else 0).", "type": "integer", "example": "0" }, "tpm": { "description": "Flag 0/1 whether a TPM state device exists (derived locally from isset(kvmConfig.data.tpmstate0)).", "type": "integer", "example": "0" }, "uefi": { "description": "Flag 0/1 whether a UEFI/EFI disk exists (derived locally from isset(kvmConfig.data.efidisk0)).", "type": "integer", "example": "0" }, "ddosprotection": { "description": "Static DDoS protection label.", "type": "string", "example": "AS203446 SmartMitigate" } }, "type": "object" }, "ServiceIPResponse": { "properties": { "ipv4": { "description": "Value", "type": "array", "items": { "$ref": "#/components/schemas/IPv4Response" } }, "ipv6": { "description": "Value", "type": "array", "items": { "$ref": "#/components/schemas/IPv6Response" } } }, "type": "object" }, "ServiceIncidentsResponse": { "properties": { "data": { "description": "List of DDoS incident objects for the service's IPs. Each item comes from IpDdosIncident::getData() (table interface.ip_ddos_incidents). Per item: ip (string) source/target IP; mbps (integer) always 0 for non-admin; method (string) attack method, 'Other' when null; mode (string) mitigation mode; pps (integer) always 0 for non-admin; created_on (integer) unix timestamp; processed (integer); display (integer); id (string) freshly generated UUID for non-admin (not the DB id). Columns id, cluster, sample_count are removed by getData().", "type": "array", "items": { "type": "object" } }, "pageInfo": { "description": "Pagination metadata: total (integer) total matching incident count; stepsize (integer) fixed page size 10; last (integer) echoes the requested 'start' offset.", "type": "object" } }, "type": "object" }, "ServiceInfoResponse": { "properties": { "display": { "$ref": "#/components/schemas/DisplayResponse" }, "product": { "$ref": "#/components/schemas/ProductReponse" }, "service": { "$ref": "#/components/schemas/ServiceResponse" }, "maintenance": { "description": "The announced maintenances that cover the service (every product), planned or running, earliest start first; empty without one", "type": "array", "items": { "$ref": "#/components/schemas/ServiceMaintenanceResponse" } } }, "type": "object" }, "ServiceLiveDataResponse": { "properties": { "cpu": { "description": "Current CPU usage of the VM as a fraction (0-1). Value is passed through verbatim from the Proxmox API qemu status/current response field 'cpu'.", "type": "number", "format": "float", "example": "0.0234" }, "mem": { "description": "Current memory usage of the VM in bytes. Value passed through from the Proxmox API status/current field 'mem'.", "type": "integer", "example": "1073741824" }, "netin": { "description": "Cumulative inbound network traffic in bytes. Value passed through from the Proxmox API status/current field 'netin'.", "type": "integer", "example": "52428800" }, "netout": { "description": "Cumulative outbound network traffic in bytes. Value passed through from the Proxmox API status/current field 'netout'.", "type": "integer", "example": "10485760" } }, "type": "object" }, "ServiceLogFileResponse": { "properties": { "data": { "description": "HTML-formatted log file contents. Built locally in Gameserver::getLogFile() by exploding the (optionally gzip-decoded) file on newlines and joining the htmlspecialchars-escaped lines, each prefixed with '
'. The underlying raw file text comes from an external Calagopus getFileContent() call, but the wrapped value is always a single string.", "type": "string", "example": "
[00:00:01] Server starting...
[00:00:02] Done loading" } }, "type": "object" }, "ServiceLogFilesResponse": { "properties": { "sizedisplay": { "description": "Human-readable file size, locally computed via Functions::humanFileSize() from the external file's size attribute.", "type": "string", "example": "1.2 MB" }, "dir": { "description": "Directory of the log file, taken locally from the GameserverGameLogs model's 'dir' column value.", "type": "string", "example": "/logs" } }, "type": "object" }, "ServiceMaintenanceResponse": { "properties": { "id": { "description": "Id of the maintenance", "type": "string", "example": "0b6f3c4e-2f43-4c35-9d0e-7a1c2b9f6e11" }, "phase": { "description": "planned (before the window) or active (during the window)", "type": "string", "enum": [ "planned", "active" ], "example": "planned" }, "starts_on": { "description": "Start of the maintenance window, unix seconds", "type": "integer", "example": 1794009600 }, "ends_on": { "description": "End of the maintenance window, unix seconds", "type": "integer", "example": 1794016800 }, "window": { "description": "The window as text in the language of the account (German for the account language de, English otherwise)", "type": "string", "example": "Sat, 7 Nov 2026, 01:00 - 03:00 (CET)" }, "markmaintenance": { "description": "1 when the service shows status \"maintenance\" while the window runs (KVM and dedicated servers)", "type": "integer", "example": 1 }, "subject": { "description": "Subject of the announcement in the language of the account, null for customers of a reseller interface", "type": "string", "example": "Scheduled maintenance on 7 Nov 2026: host system restart", "nullable": true }, "text": { "description": "Text of the announcement as HTML (escaped text in inline styled p, ul, li, br, strong and a elements), safe to insert; null for customers of a reseller interface", "type": "string", "example": "

We will carry out scheduled maintenance on the host system your services run on.

", "nullable": true } }, "type": "object" }, "ServiceModListResponse": { "properties": { "thumbnail": { "description": "Thumbnail URL. Built locally: when the external mod info contains a 'thumbnail' path it is prefixed with 'https://mods-data.factorio.com'; otherwise set to empty string ''. This is the only key the local code guarantees/overrides.", "type": "string", "example": "https://mods-data.factorio.com/assets/abc123.thumb.png" } }, "type": "object" }, "ServiceModsResponse": { "properties": { "filename": { "description": "The raw mod zip filename from the gameserver's /mods/ directory listing (from $mod['attributes']['name']). Locally built.", "type": "string", "example": "stdlib_1.4.6.zip" }, "name": { "description": "Mod name derived locally by stripping the trailing version segment from the filename (split on '_'). Locally built.", "type": "string", "example": "stdlib" }, "thumbnail": { "description": "Thumbnail URL. The key is always set locally by prefixing 'https://mods-data.factorio.com/' to the thumbnail path, but the path portion comes from the external Factorio mods API.", "type": "string", "example": "https://mods-data.factorio.com/assets/abc123.thumb.png" } }, "type": "object" }, "ServiceNetworkDataResponse": { "properties": { "ip": { "description": "The IP address of the allocation. Value comes from the external Calagopus game panel (allocation entry `ip`), but the key and string type are fixed locally.", "type": "string", "example": "203.0.113.10" }, "port": { "description": "The port number of the allocation. Value comes from the external Calagopus game panel (allocation entry `port`), but the key and integer type are fixed locally.", "type": "integer", "example": "27015" }, "default": { "description": "Computed locally: 1 if this is a default allocation, 0 if it is a non-default/extra port (port present in the gameserver's non-default extra ports list).", "type": "integer", "example": "1" } }, "type": "object" }, "ServiceNovncDataResponse": { "properties": { "port": { "description": "Proxmox vnc port for the vncproxy session", "type": "string", "example": "5900" }, "ticket": { "description": "Short lived proxmox vnc ticket; grants interactive graphical console access to the vm for its lifetime", "type": "string", "example": "PVEVNC:AAAAAAAA::base64data..." }, "ip": { "description": "IP of the proxmox node", "type": "string", "example": "192.0.2.10" }, "password": { "description": "VNC password (first 15 characters of the ticket)", "type": "string", "example": "PVEVNC:AAAAAAA" }, "nodehostname": { "description": "Hostname of the proxmox node", "type": "string", "example": "node01.example.com" }, "node": { "description": "Proxmox node name", "type": "string", "example": "node01" }, "proxmoxid": { "description": "Proxmox vm id", "type": "string", "example": "1234" }, "cluster": { "description": "Cluster key of the node (can be renamed)", "type": "string", "example": "cluster1" }, "nodeid": { "description": "Id of the proxmox node", "type": "string", "example": "3f2c9a7e-1b4d-4c8a-9e21-6d5f0a7b8c90" } }, "type": "object" }, "ServicePleskLoginResponse": { "properties": { "url": { "description": "Plesk single-sign-on login URL. Locally assembled as 'https://' + PleskHost host + '/enterprise/rsession_init.php?PLESKSESSID=' + sessionid. The host comes from the plesk host DB record and the session id from the external Plesk getPleskLogin() API call, but the field is always present and is a single string.", "type": "string", "example": "https://plesk-host01.example.com/enterprise/rsession_init.php?PLESKSESSID=abc123def456" } }, "type": "object" }, "ServiceResponse": { "properties": { "id": { "description": "Value", "type": "string", "example": "baa7d0b3-0b56-4926-abce-c83ebb0d0677" }, "created_on": { "description": "Value", "type": "integer", "example": "1650978734" }, "delete_at": { "description": "Value", "type": "integer", "example": "0" }, "deletedone": { "description": "Value", "type": "integer", "example": "0" }, "expire_at": { "description": "Value", "type": "integer", "example": "1654701134" }, "name": { "description": "Value", "type": "string", "example": "null" }, "preorder": { "description": "Value", "type": "integer", "example": "0" }, "price": { "description": "Value", "type": "number", "format": "float", "example": "5.99" }, "productdisplay": { "description": "Value", "type": "string", "example": "KVM Server" }, "sortorder": { "description": "Custom display position from the drag and drop ordering (POST /user/{userid}/servicelistorder); 999999 = not positioned yet, listed last", "type": "integer", "example": "999999" }, "maintenance": { "description": "GET /service/list only: the earliest announced maintenance that covers the service, phase planned (before the window) or active (during the window), start and end as unix seconds; null without one", "type": "object", "example": { "phase": "planned", "starts_on": 1794009600, "ends_on": 1794016800 }, "nullable": true } }, "type": "object" }, "ServiceSSHKeysResponse": { "properties": { "id": { "description": "UUID primary key of the SSH key row (kvmserver_sshkeys.id).", "type": "string", "example": "7f3c1a2e-4b5d-4c6e-8f9a-0b1c2d3e4f5a" }, "kvmid": { "description": "UUID of the owning KVM server (kvmserver_sshkeys.kvmid; FK to kvmserver_main.id).", "type": "string", "example": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d" }, "displayname": { "description": "User-supplied display name for the SSH key.", "type": "string", "example": "My Laptop Key" }, "key": { "description": "The public SSH key material.", "type": "string", "example": "ssh-rsa AAAAB3NzaC1yc2EAAA... user@host" }, "created_on": { "description": "Timestamp when the key was created (CURRENT_TIMESTAMP default).", "type": "string", "example": "2026-06-23 14:05:11" } }, "type": "object" }, "ServiceStatusResponse": { "properties": { "status": { "description": "Value", "type": "string", "example": "running" }, "migration": { "description": "KVM Server with status migrating only: phase (shutdown, disk, memory, copy or starting), percent (0..100 with one decimal, null without one), bytes (copied so far, null without) and rate (bytes per second, null without) of the move to another host, null before the move started", "type": "object", "example": { "phase": "disk", "percent": null, "bytes": 8214745088, "rate": 146492621 }, "nullable": true } }, "type": "object" }, "ServiceTrafficHistoryResponse": { "properties": { "history": { "description": "Container object with two parallel lists of traffic data points. history.last30days = array of daily points from the last 30 days; history.months = array of monthly aggregate points. Each point is an object {date: string ('Y-m-d H:i:s', shifted +2 hours), in: number (input MB = raw bytes/1000000), out: number (output MB)}. Both lists are built locally from the kvm_traffic table rows.", "type": "object" }, "max": { "description": "Maximum included traffic in TB for the server: packet traffic (capped at 1) plus additionaltraffic. Sourced from getHardwareInfo()['traffic'], computed from the KvmServer packet + additionaltraffic DB values.", "type": "integer", "example": "1" }, "current": { "description": "Current month's used traffic (in+out) formatted via number_format with 2 decimals and locale-dependent separators (e.g. '0.12' for en, '0,12' for de). String because of number_format.", "type": "string", "example": "0.12" }, "percentage": { "description": "Used traffic as a percentage of max, formatted via number_format with 2 decimals and locale-dependent separators. String.", "type": "string", "example": "0.50" }, "normalpercentage": { "description": "Raw (unformatted) used-traffic percentage as a float, before number_format was applied.", "type": "number", "format": "float", "example": "0.5" } }, "type": "object" }, "ServiceTrafficResponse": { "properties": { "year": { "description": "Value", "type": "string", "example": "2022" } }, "type": "object" }, "ServiceUpgradeInfoResponse": { "properties": { "onetimepayment": { "description": "Prorated one-time payment for the upgrade for the remaining service period. Computed locally as (newPacketPrice - currentPacketPrice)/30 * remainingDays, rounded to 2 decimals.", "type": "number", "format": "float", "example": "12.45" }, "price": { "description": "Base monthly price of the target upgrade packet (kvmserver_packet.price).", "type": "number", "format": "float", "example": "19.99" }, "monthlyprice": { "description": "New effective monthly price of the service after upgrade: currentServicePrice - currentPacketPrice + newPacketPrice, rounded to 2 decimals.", "type": "number", "format": "float", "example": "21.99" }, "displayname": { "description": "Display name of the target upgrade packet (kvmserver_packet.displayname).", "type": "string", "example": "VPS Premium L" }, "id": { "description": "UUID of the target upgrade packet (kvmserver_packet.id).", "type": "string", "example": "3f8c1a2e-4b7d-4c9a-8e21-9d5f6a7b1c0e" }, "cores": { "description": "CPU cores of the target packet (kvmserver_packet.cores).", "type": "integer", "example": "4" }, "memory": { "description": "Memory of the target packet in MB (kvmserver_packet.memory).", "type": "integer", "example": "8192" }, "disk": { "description": "Disk of the target packet (kvmserver_packet.disk).", "type": "integer", "example": "160" } }, "type": "object" }, "ServiceVersionResponse": { "properties": { "id": { "description": "UUID of the game version (interface.gameserver_version.id).", "type": "string", "example": "b1e7c2a4-9f3d-4c8a-8e21-7d6f0a1b2c3d" }, "version": { "description": "Display name of the version (gameserver_version.version). For the version that matches the service's currently configured version, the localized ' (currently selected)' suffix is appended.", "type": "string", "example": "1.20.4 (currently selected)" } }, "type": "object" }, "ServiceWebsocketTokenResponse": { "properties": { "websockettoken": { "description": "Wings websocket auth token (jwt). Grants interactive console access on the gameserver including command execution and power control for its lifetime.", "type": "string", "example": "eyJhbGciOiJIUzI1NiJ9.eyJzZXJ2ZXJfdXVpZCI6Ii4uLiJ9.signature" }, "websocketurl": { "description": "Wings websocket url to connect to with the token", "type": "string", "example": "wss://node.example.com:8080/api/servers/uuid/ws" }, "cansendcommand": { "description": "Whether the requesting user may send console commands (false only for shared access users without the sendConsoleCommand permission); informational flag for UIs", "type": "boolean", "example": "true" } }, "type": "object" }, "TooManyRequests": { "properties": { "error": { "description": "This function was used too often", "type": "string" } }, "type": "object" }, "Unauthorized": { "properties": { "error": { "description": "This resource does not belong to you", "type": "string" } }, "type": "object" }, "UserAccessInfoResponse": { "properties": { "service_type_id": { "description": "Top-level keys are service-type id strings ('1','2','3','4', ...). Each value is an array of permission items. '3' maps to an empty array. Each item is an object with the fields below (name, header, optional sub).", "type": "array", "items": { "type": "object" } }, "name": { "description": "Permission identifier of a single access item (e.g. start, restart, stop, shutdown, reinstall, showLoginData, displayBackups). Present on every item, including nested sub items.", "type": "string", "example": "start" }, "header": { "description": "Localized display label resolved via Lang::getString(...) (e.g. accessStart). Returned as a translated string.", "type": "string", "example": "Start server" }, "sub": { "description": "Optional. Present only on some items. Array of child permission items, each with the same {name, header} shape (and possibly further sub).", "type": "array", "items": { "type": "object" } } }, "type": "object" }, "UserAccessListResponse": { "properties": { "id": { "description": "UUID primary key of the access entry (main_user_access.id).", "type": "string", "example": "3f1c8a2e-7b9d-4e1a-9c3f-2a1b4c5d6e7f" }, "serviceid": { "description": "UUID of the related service (main_user_access.serviceid).", "type": "string", "example": "a2b3c4d5-6e7f-4a8b-9c0d-1e2f3a4b5c6d" }, "status": { "description": "Status flag of the access entry (main_user_access.status, int4).", "type": "integer", "example": "1" }, "created_on": { "description": "Creation timestamp of the access entry (main_user_access.created_on). Not converted to unix (convert list empty).", "type": "string", "example": "2026-06-23 12:34:56" }, "name": { "description": "Name label of the access entry (main_user_access.name, varchar, nullable).", "type": "string", "example": "My access grant" }, "entrys": { "description": "Array of access-right rows (AccessRight::getData() = full main_user_access_rights row). Each item has: id (string uuid), accessid (string uuid), perm (string varchar), created_on (string timestamp).", "type": "array", "items": { "type": "object" } }, "productid": { "description": "Product id of the related service (service_main.productid, int4), fetched via Service::getValue('productid').", "type": "integer", "example": "42" } }, "type": "object" }, "UserAffiliateInfoResponse": { "properties": { "linkcount": { "description": "Number of active affiliate links for the user (count of AffiliateLink rows with status=1).", "type": "integer", "example": "3" }, "totalmoney": { "description": "Sum of amounts from paid affiliate usages (paid=1), rounded to 2 decimals via round(floatval(...),2).", "type": "number", "format": "float", "example": "42.5" }, "moneyhold": { "description": "Sum of amounts from unpaid affiliate usages (paid=0, on hold), rounded to 2 decimals via round(floatval(...),2).", "type": "number", "format": "float", "example": "12.75" } }, "type": "object" }, "UserAffiliateLinkListResponse": { "properties": { "id": { "description": "Affiliate link UUID (main_affiliate_link.id).", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "name": { "description": "Affiliate link name (main_affiliate_link.name, varchar, nullable).", "type": "string", "example": "Summer Campaign" }, "created_on": { "description": "Creation timestamp (main_affiliate_link.created_on). Not converted to unix (convertTimeToUnix called with empty conversion list), so remains the timestamp string.", "type": "string", "example": "2026-06-23 12:00:00" }, "percent": { "description": "Commission percentage (main_affiliate_link.percent, int4, default 10).", "type": "integer", "example": "10" }, "servicecount": { "description": "Count of non-deleted services attached to this affiliate link, or 0 if none. Added by the factory.", "type": "integer", "example": "3" }, "servicerevenue": { "description": "Sum of attached service prices * 0.1, formatted via number_format to 2 decimals (string like '12.34'); the integer 0 when no services. Added by the factory.", "type": "string", "example": "12.34" } }, "type": "object" }, "UserAffiliateListResponse": { "properties": { "link": { "description": "Name of the affiliate link (main_affiliate_link.name, varchar). Looked up from the AffiliateLink whose id matches the usage's affiliatelink.", "type": "string", "example": "My Affiliate Link" }, "amount": { "description": "Commission amount (main_affiliate_usages.amount, numeric).", "type": "number", "format": "float", "example": "4.50" }, "status": { "description": "Payout status (main_affiliate_usages.paid, int4). 0 = not paid out, 1 = paid out.", "type": "integer", "example": "0" }, "created_on": { "description": "Unix timestamp of the usage record, produced by strtotime(main_affiliate_usages.created_on).", "type": "integer", "example": "1718000000" } }, "type": "object" }, "UserApiInfoResponse": { "properties": { "apikeys": { "description": "Count of the user's active API keys (status=0).", "type": "integer", "example": "3" }, "requests": { "description": "Sum of requests200 across all of the user's active API keys.", "type": "integer", "example": "1500" }, "requestsother": { "description": "Sum of requestsother across all of the user's active API keys.", "type": "integer", "example": "42" } }, "type": "object" }, "UserApiKeyCreateResponse": { "properties": { "id": { "description": "The UUID of the newly created API key, generated via Functions::gen_uuid().", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "scoped": { "description": "1 when the key was created with scopes and only the assigned routes are accessible, 0 for an unrestricted key", "type": "integer", "example": "0" }, "hostrivo": { "description": "1 when the key was created as Hostrivo API key (usable from the Hostrivo platform only, not rate limited), 0 for a normal key", "type": "integer", "example": "0" } }, "type": "object" }, "UserApiKeyInfoResponse": { "properties": { "id": { "description": "API key id (uuid) from main_user_api_keys.id", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "created_on": { "description": "Timestamp string; ApiKey.getData() calls convertTimeToUnix with an empty convert list so created_on is NOT converted and stays a timestamp string", "type": "string", "example": "2026-06-23 14:05:11" }, "note": { "description": "main_user_api_keys.note (varchar, nullable)", "type": "string", "example": "My CI token" }, "requests": { "description": "main_user_api_keys.requests (int4); also re-set from getRequestCount()", "type": "integer", "example": "1542" }, "requests200": { "description": "main_user_api_keys.requests200 (int4)", "type": "integer", "example": "1400" }, "requestsother": { "description": "main_user_api_keys.requestsother (int4)", "type": "integer", "example": "142" }, "readonly": { "description": "main_user_api_keys.readonly (int4, 0/1 flag); 1 = key can only perform GET requests", "type": "integer", "example": "0" }, "scoped": { "description": "main_user_api_keys.scoped (int4 normalized to 0/1); 1 = the key can only access the routes listed in scopes", "type": "integer", "example": "0" }, "hostrivo": { "description": "Hostrivo flag (column hostrivo, int4 normalized to 0/1); 1 = the key only authenticates from the Hostrivo platform (any other source is rejected with 403, error code apikeyhostrivoip) and is exempt from the rate limits", "type": "integer", "example": "0" }, "scopes": { "description": "Assigned scopes from main_user_api_key_scope (normalized route pattern + HTTP method); empty array when the key is not scoped", "type": "array", "items": { "$ref": "#/components/schemas/UserApiScopeRoutesResponse" } }, "userInfo": { "description": "User.getData() from table main_user, excluding sevdeskid/password/twofasecret, with created_on converted to a unix timestamp integer, plus added keys nicedate (string) and email (htmlspecialchars'd string). Object keys: id(string/uuid), username(string), email(string), status(integer), credit(number/numeric), supportpin(string), lang(string), created_on(integer/unix), invoicedataset(integer), payinvoice(integer), creditlimit(integer), loginemail(integer), reseller(integer), resellerdiscount(number/numeric), twofastatus(integer), interfaceid(string/uuid), admin(integer), discordid(string), hostname(string), ipcheck(integer), canorder(integer), serviceexpireemail(integer), expirewebhook(string), accesskey(string), style(string), supportdisplayname(string), creditlimit_usage_notification(integer), taxcountry(string), permsessions(integer), paywithoutvat(integer), github(string), discord(string), code(string), supportlevel(integer), mollie(string), locked(integer), permemailportunlock(integer), permemailportunlockreseller(integer), canunlockports(integer), donotforcepaypaladdress(integer), emailconfirmed(integer), nicedate(string)", "type": "object" } }, "type": "object" }, "UserApiKeysResponse": { "properties": { "id": { "description": "UUID primary key of the API key (column id)", "type": "string", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "created_on": { "description": "Creation timestamp (column created_on; timestamp string, not converted since convert list is empty)", "type": "string", "example": "2026-06-23 14:05:00" }, "note": { "description": "Optional description/note for the key (column note, varchar, nullable)", "type": "string", "example": "My CI server key" }, "requests": { "description": "Total request count; overwritten in getData() via getRequestCount() which returns the requests column value (int4)", "type": "integer", "example": "42" }, "requests200": { "description": "Count of requests with HTTP 200 (column requests200, int4)", "type": "integer", "example": "40" }, "requestsother": { "description": "Count of requests with non-200 status (column requestsother, int4)", "type": "integer", "example": "2" }, "readonly": { "description": "Read-only flag (column readonly, int4, 0/1); 1 = key can only perform GET requests, other methods are rejected with 403", "type": "integer", "example": "0" }, "scoped": { "description": "Scoped flag (column scoped, int4 normalized to 0/1); 1 = the key can only access the routes listed in scopes, every other route is rejected with 403 (error code apikeyscope)", "type": "integer", "example": "0" }, "hostrivo": { "description": "Hostrivo flag (column hostrivo, int4 normalized to 0/1); 1 = the key only authenticates from the Hostrivo platform (any other source is rejected with 403, error code apikeyhostrivoip) and is exempt from the rate limits", "type": "integer", "example": "0" }, "scopes": { "description": "Assigned scopes from main_user_api_key_scope (normalized route pattern + HTTP method); empty array when the key is not scoped", "type": "array", "items": { "$ref": "#/components/schemas/UserApiScopeRoutesResponse" } } }, "type": "object" }, "UserApiScopeRoutesResponse": { "properties": { "endpoint": { "description": "Normalized route pattern (Slim pattern with the placeholder regex constraints stripped); exactly this string has to be sent back as a scope when creating/editing an API key", "type": "string", "example": "/service/{id}/status" }, "method": { "description": "HTTP method of the route (GET, POST, PUT or DELETE)", "type": "string", "example": "GET" } }, "type": "object" }, "UserCountryListResponse": { "properties": { "id": { "description": "Country UUID primary key (column id, uuid).", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "displayname": { "description": "Localized country name: column 'displayname' when user lang is 'de', otherwise column 'displaynameen' (varchar).", "type": "string", "example": "Deutschland" }, "vatamount": { "description": "VAT amount/rate for the country (column vatamount, varchar).", "type": "string", "example": "19" } }, "type": "object" }, "UserCreditLogResponse": { "properties": { "change": { "description": "Credit change amount, round(value, 2) from the credit_log row's 'change' column.", "type": "number", "format": "float", "example": "12.5" }, "type": { "description": "Sign derived from the row 'type' column: '+' for 1, '-' for 2, '' otherwise.", "type": "string", "example": "+" }, "display": { "description": "Localized text resolved via lang->getStringWithData(langtag, data).", "type": "string", "example": "Payment received" }, "created_on": { "description": "Unix timestamp from strtotime() of the row 'created_on' column.", "type": "integer", "example": "1700000000" }, "additionalData": { "description": "Always empty string for this endpoint (unpaid=false branch never sets it).", "type": "string", "example": "" }, "id": { "description": "Credit log row id.", "type": "integer", "example": "42" }, "invoice": { "description": "Always 'default' for this endpoint (paid=1, unpaid=false takes the else branch).", "type": "string", "example": "default" }, "invoicedisplayname": { "description": "Always 'default' for this endpoint (else branch).", "type": "string", "example": "default" } }, "type": "object" }, "UserCreditLogUnpaidResponse": { "properties": { "change": { "description": "round($creditEntry->getValue('change'),2) - amount of the credit change, rounded to 2 decimals", "type": "number", "format": "float", "example": "12.5" }, "type": { "description": "Mapped from numeric 'type': 1 => '+', 2 => '-', otherwise '' (empty string)", "type": "string", "example": "+" }, "display": { "description": "Localized display text built from the entry's langtag and json-decoded 'data' via getStringWithData()", "type": "string", "example": "Order #1234 charge" }, "created_on": { "description": "strtotime() of the entry's created_on timestamp (Unix epoch seconds)", "type": "integer", "example": "1718000000" }, "additionalData": { "description": "Empty string by default; when the credit data has an 'orderid', set to localized 'serviceid' label plus the order's serviceid", "type": "string", "example": "Service ID: 5678" }, "id": { "description": "credit_log row id ($creditEntry->getValue('id'))", "type": "integer", "example": "42" }, "invoice": { "description": "The entry's 'invoice' value when set (and unpaid), otherwise the literal string 'default'", "type": "string", "example": "INV-2026-001" }, "invoicedisplayname": { "description": "Name of the matching UserInvoices entry; literal 'default' when no invoice; only present in the invoice branch when a matching invoice exists, else may be omitted", "type": "string", "example": "Invoice June 2026" } }, "type": "object" }, "UserDashboardResponse": { "properties": { "credit": { "description": "User's credit balance. From main_user.credit (numeric).", "type": "number", "format": "float", "example": "25.5" }, "supportpin": { "description": "Support PIN. From main_user.supportpin (varchar(20)); generated as a 6-digit numeric string if empty.", "type": "string", "example": "'483920'" }, "orderCount": { "description": "Count of paid orders for the user (count() of Order/ResellerOrder rows).", "type": "integer", "example": "3" }, "productCount": { "description": "Count of active (non-deleted) products/services for the user (count()).", "type": "integer", "example": "5" }, "invoiceData": { "description": "Whether invoice data is set. From main_user.invoicedataset (int4, 0/1 flag).", "type": "integer", "example": "1" }, "emailverified": { "description": "Whether email is confirmed. From main_user.emailconfirmed (int4, 0/1 flag).", "type": "integer", "example": "1" }, "activity": { "description": "Up to 10 most-recent activity log entries (getActivityLog(10)). Each item is an object {icon: string (from user_activity.icon), text: string (localized translation of langtag with data substituted), time: string (relative time like 'x minutes ago')}.", "type": "array", "items": { "type": "object" } } }, "type": "object" }, "UserDonationInfoResponse": { "properties": { "linkcount": { "description": "Number of the user's donation links with status == 1 (active).", "type": "integer", "example": "3" }, "totalmoney": { "description": "Sum of 'amount' over the user's donations with status == 2, rounded to 2 decimals via round(floatval(...), 2).", "type": "number", "format": "float", "example": "142.5" } }, "type": "object" }, "UserDonationLinkInfoResponse": { "properties": { "id": { "description": "UUID of the donation link (table main_user_donation_link.id)", "type": "string", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "name": { "description": "The donation link name/slug (varchar)", "type": "string", "example": "mydonationlink" }, "created_on": { "description": "Creation time as a Unix timestamp (timestamptz column converted via strtotime() in DonationLink::getData())", "type": "integer", "example": "1640995200" } }, "type": "object" }, "UserDonationLinkListResponse": { "properties": { "id": { "description": "UUID primary key of the donation link (column id from main_user_donation_link).", "type": "string", "example": "3f9a1c2e-7b4d-4a1e-9c3f-2b6d8e1f0a55" }, "name": { "description": "Donation link name (column name, varchar).", "type": "string", "example": "my-donation-link" }, "created_on": { "description": "Creation timestamp converted to a Unix timestamp via strtotime() in DonationLink::getData() (column created_on, timestamptz).", "type": "integer", "example": "1718064000" } }, "type": "object" }, "UserDonationStartResponse": { "properties": { "url": { "description": "Payment provider redirect URL returned by Payment::createDonationPayment(); points the donor to the checkout/status page for the chosen payment method (PayPal, paysafecard, cryptocurrency, alipay, etc.).", "type": "string", "example": "https://pay.example.com/redirect/abc123/status" } }, "type": "object" }, "UserDonationStatusResponse": { "properties": { "done": { "description": "Always true when the donation order is fully paid (status==2 and paid==1). Returned by UserFactory::statusDonation(). Note: certain edge-case branches (cancelled/failed/expired/unpaid payment) instead set fail data or return an empty array [], so under those conditions this field is absent.", "type": "boolean", "example": "true" } }, "type": "object" }, "UserEmailLogResponse": { "properties": { "id": { "description": "UUID of the mail_list row (PK).", "type": "string", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "templateid": { "description": "UUID FK to mail_template.", "type": "string", "example": "11111111-2222-3333-4444-555555555555" }, "userid": { "description": "UUID FK to main_user (the recipient).", "type": "string", "example": "99999999-8888-7777-6666-555555555555" }, "created_on": { "description": "Unix timestamp; converted from the timestamptz column via strtotime() in getEmailLog().", "type": "integer", "example": "1718000000" }, "display": { "description": "int4 flag (filtered to 1 by the query).", "type": "integer", "example": "1" }, "send": { "description": "int4 flag indicating whether the mail was sent.", "type": "integer", "example": "1" }, "template": { "description": "Localized template title; added in MailList::getData() via lang->getString(mailTemplate titlelangtag).", "type": "string", "example": "Welcome to your account" }, "header": { "description": "Template header string with {{placeholders}} replaced by per-mail template data; built by Mail::convertHeader().", "type": "string", "example": "Order #1234 confirmed" } }, "type": "object" }, "UserEmailResponse": { "properties": { "mail": { "description": "Base64-encoded email content retrieved via Mail::getMail(). Always a base64 string; the decoded payload (raw email/MIME body) comes from the mail subsystem and is opaque, but the response field itself is always a base64-encoded string.", "type": "string", "example": "UmVjZWl2ZWQ6IGZyb20gbWFpbC5leGFtcGxlLmNvbQ0K..." } }, "type": "object" }, "UserInvoiceDataResponse": { "properties": { "city": { "description": "City, empty string when none on file", "type": "string", "example": "Berlin" }, "zip": { "description": "Postal code, empty string when none", "type": "string", "example": "10115" }, "street": { "description": "Street, empty string when none", "type": "string", "example": "Hauptstrasse 1" }, "name": { "description": "Same as company (legacy key of the old sevdesk address name)", "type": "string", "example": "Datalix GmbH" }, "country": { "description": "Country uuid (main_sevdesk_countrys.id), empty string when unknown", "type": "string", "example": "180c248c-8fa9-41a1-9d72-89a3aeaab1ff" }, "countrydisplayname": { "description": "German display name of the country, empty string when unknown", "type": "string", "example": "Germany" }, "firstname": { "description": "First name, empty string when none", "type": "string", "example": "Max" }, "lastname": { "description": "Last name, empty string when none", "type": "string", "example": "Mustermann" }, "company": { "description": "Company, empty string when none", "type": "string", "example": "Datalix GmbH" }, "vatid": { "description": "EU VAT ID (reverse charge), empty string when none. Only our support can set it, every payment checks it against the EU VIES service", "type": "string", "example": "ATU12345678" }, "locked": { "description": "true while a VAT ID is stored: the invoice data can then only be changed by our support (POST answers 403 invoiceDataLocked)", "type": "boolean", "example": false } }, "type": "object" }, "UserInvoiceListResponse": { "properties": { "id": { "description": "Sevdesk invoice id (passed through from external Sevdesk API response).", "type": "string", "example": "12345" }, "invoiceNumber": { "description": "Invoice number from Sevdesk.", "type": "string", "example": "RE-1001" }, "header": { "description": "Invoice header/title from Sevdesk.", "type": "string", "example": "Rechnung RE-1001" }, "sum": { "description": "Gross sum (mapped from Sevdesk 'sumGross').", "type": "number", "format": "float", "example": "19.99" }, "status": { "description": "Locally computed status: 0 = paid/status 200, 1 = otherwise, 2 = cancelled.", "type": "integer", "example": "0" }, "create": { "description": "Creation date formatted via Functions::niceDate().", "type": "string", "example": "23.06.2026" } }, "type": "object" }, "UserInvoiceResellerResponse": { "properties": { "data": { "description": "Base64-encoded PDF of the reseller order invoice, produced by the Invoicr PDF library (base64_encode($invoicr->returnPDF(...))). The string is determinable as a base64 PDF blob, but its binary contents are opaque/not statically determinable.", "type": "string", "example": "JVBERi0xLjcKJ..." } }, "type": "object" }, "UserLastDonationsResponse": { "properties": { "donationlink": { "description": "UUID of the donation link (main_user_donation.donationlink column).", "type": "string", "example": "6f1a2b3c-4d5e-6f70-8a9b-0c1d2e3f4a5b" }, "amount": { "description": "Donation amount (numeric column main_user_donation.amount).", "type": "number", "format": "float", "example": "25.00" }, "reason": { "description": "Optional donation reason/message (varchar column main_user_donation.reason); may be null.", "type": "string", "example": "Thanks for the stream" }, "created_on": { "description": "Creation time converted to a Unix timestamp via strtotime() in Donation::getData().", "type": "integer", "example": "1718000000" }, "link": { "description": "Name of the associated DonationLink (main_user_donation_link.name), added in Donation::getData().", "type": "string", "example": "mydonationlink" } }, "type": "object" }, "UserNotificationSettingsResponse": { "properties": { "type": { "description": "Notification type key, varchar column 'type' from main_user_notification.", "type": "string", "example": "server" }, "displayname": { "description": "Localized label built from lang string 'notification_' . type.", "type": "string", "example": "Server Notifications" }, "email": { "description": "Email notification flag (int4 column, default 1).", "type": "integer", "example": "1" }, "discord": { "description": "Discord webhook URL, varchar, htmlspecialchars-escaped.", "type": "string", "example": "https://discord.com/api/webhooks/..." }, "discord_last_call": { "description": "Timestamp of last Discord call (nullable timestamp column).", "type": "string", "example": "2026-06-23 10:00:00" }, "webhook": { "description": "Webhook URL, varchar nullable column.", "type": "string", "example": "https://example.com/hook" }, "webhook_last_call": { "description": "Timestamp of last webhook call (nullable timestamp column).", "type": "string", "example": "2026-06-23 10:00:00" }, "created_on": { "description": "Creation time converted to a unix timestamp via convertTimeToUnix/strtotime (0 if null).", "type": "integer", "example": "1750671600" } }, "type": "object" }, "UserOrderListResponse": { "properties": { "id": { "description": "order_main.id (uuid)", "type": "string", "example": "a1b2c3d4-0000-0000-0000-000000000000" }, "userid": { "description": "order_main.userid (uuid)", "type": "string", "example": "f0e1d2c3-0000-0000-0000-000000000000" }, "price": { "description": "order_main.price (numeric)", "type": "number", "format": "float", "example": "12.99" }, "type": { "description": "order_main.type (varchar) - e.g. kvmServerPacket, webspacePacket, invoice, topupcredit, etc.", "type": "string", "example": "kvmServerPacket" }, "status": { "description": "order_main.status (int4)", "type": "integer", "example": "0" }, "paid": { "description": "order_main.paid (int4)", "type": "integer", "example": "1" }, "paid_on": { "description": "order_main.paid_on (timestamptz) - passed through as DB string; NOT converted to unix here", "type": "string", "example": "2026-06-23 14:05:00+00" }, "created_on": { "description": "order_main.created_on - overwritten in factory via strtotime() to a unix timestamp (integer)", "type": "integer", "example": "1750684800" }, "serviceid": { "description": "order_main.serviceid (uuid, nullable)", "type": "string", "example": "9a8b7c6d-0000-0000-0000-000000000000" }, "vat": { "description": "order_main.vat (numeric, nullable)", "type": "number", "format": "float", "example": "19" }, "externalid": { "description": "order_main.externalid (varchar, nullable)", "type": "number", "format": "float", "example": "yourexternalid" }, "displayforclient": { "description": "order_main.displayforclient (varchar, nullable)", "type": "string", "example": "VPS Order #123" }, "invoicenumber": { "description": "order_main.invoicenumber (varchar, nullable): number of the invoice of this order, null while none is written yet", "type": "string", "example": "RE-23123" }, "vatfree": { "description": "order_main.vatfree: 1 when the payment was charged VAT free (reverse charge, VAT ID confirmed by the EU VIES service at payment)", "type": "integer", "example": "0" }, "netprice": { "description": "order_main.netprice (numeric, nullable): the amount charged for a reverse charge order, price stays the gross price", "type": "number", "format": "float", "example": "10.91" }, "vatid": { "description": "order_main.vatid (varchar, nullable): the VAT ID checked for this payment", "type": "string", "example": "ATU12345678" }, "viesrequestid": { "description": "order_main.viesrequestid (varchar, nullable): request identifier of the VIES check, the proof of the check", "type": "string", "example": "WAPIAAAAZfN1BqXU" }, "vieschecked_on": { "description": "order_main.vieschecked_on (timestamptz, nullable): when the VIES check of the payment was made", "type": "string", "example": "2026-10-26 14:05:00+00" }, "orderInfo": { "description": "Localized HTML summary string built by Order::getOrderInfo(); content varies by order type and language. Locally built but value depends on language strings/related order data.", "type": "string", "example": "Price: 12.99 €
Period: 30 days
..." } }, "type": "object" }, "UserPasskeyLoginOptionsResponse": { "properties": { "challengeid": { "description": "Id of the pending challenge, must be sent back with the assertion", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "publicKey": { "description": "PublicKeyCredentialRequestOptions: challenge (base64url, 32 bytes), rpId, timeout (60000), userVerification (required), allowCredentials (always empty, the browser picks a discoverable credential)", "type": "object", "example": { "challenge": "b0Zl3M7v...", "rpId": "datalix.de", "timeout": 60000, "userVerification": "required", "allowCredentials": [] } } }, "type": "object" }, "UserPasskeyLoginResponse": { "properties": { "id": { "description": "Session id, used as bearer token", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "lang": { "description": "Account language (de/en)", "type": "string", "example": "de" } }, "type": "object" }, "UserPasskeyRegisterOptionsResponse": { "properties": { "challengeid": { "description": "Id of the pending challenge, must be sent back with the registration", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "publicKey": { "description": "PublicKeyCredentialCreationOptions: challenge (base64url, 32 bytes), rp {name, id}, user {id (base64url), name (email), displayName (username)}, pubKeyCredParams [{type: public-key, alg: -7}, {type: public-key, alg: -257}], timeout (60000), attestation (none), authenticatorSelection {residentKey: required, requireResidentKey: true, userVerification: required}, excludeCredentials [{type: public-key, id (base64url), transports?}]", "type": "object", "example": { "challenge": "b0Zl3M7v...", "rp": { "name": "Datalix", "id": "datalix.de" }, "user": { "id": "ZTUzNDkwYWYt...", "name": "user@example.com", "displayName": "username" }, "pubKeyCredParams": [ { "type": "public-key", "alg": -7 }, { "type": "public-key", "alg": -257 } ], "timeout": 60000, "attestation": "none", "authenticatorSelection": { "residentKey": "required", "requireResidentKey": true, "userVerification": "required" }, "excludeCredentials": [] } } }, "type": "object" }, "UserPasskeyRegisterResponse": { "properties": { "id": { "description": "UUID of the new passkey record", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" } }, "type": "object" }, "UserPasskeysResponse": { "properties": { "id": { "description": "UUID of the passkey record", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "displayname": { "description": "User chosen name (html escaped)", "type": "string", "example": "MacBook Touch ID" }, "aaguid": { "description": "Authenticator model id (AAGUID) reported at registration, null when the authenticator sent all zeros", "type": "string", "example": "adce0002-35bc-c60a-648b-0b25f1f05503", "nullable": true }, "transports": { "description": "Transport hints reported by the browser at registration (usb, nfc, ble, internal, hybrid, smart-card)", "type": "array", "items": { "type": "string" }, "example": [ "internal", "hybrid" ] }, "created_on": { "description": "Registration timestamp", "type": "string", "example": "2026-09-22 14:32:11" }, "lastused": { "description": "Timestamp of the last successful login with this passkey, null when never used", "type": "string", "example": "2026-09-23 08:05:41", "nullable": true } }, "type": "object" }, "UserPayByInvoiceInfoResponse": { "properties": { "limit": { "description": "User's credit limit, from user.creditlimit (int4 column).", "type": "integer", "example": "500" }, "used": { "description": "Sum of credit-log 'change' amounts (each rounded to 2 decimals) for the user's open positions; computed in getCreditLimitUsage().", "type": "number", "format": "float", "example": "123.45" }, "status": { "description": "Pay-by-invoice status flag, from user.payinvoice (int4 column).", "type": "integer", "example": "1" } }, "type": "object" }, "UserPayByInvoiceListResponse": { "properties": { "id": { "description": "Invoice UUID (id column of main_user_invoices). For the synthetic open-positions entry this is the literal string 'default'.", "type": "string", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "name": { "description": "Invoice name (name column of main_user_invoices). For the synthetic entry this is the literal string 'default'.", "type": "string", "example": "Invoice 2026-001" }, "created_on": { "description": "Creation timestamp (created_on column). Present only on real invoice rows from main_user_invoices, not on the synthetic 'default' entry.", "type": "string", "example": "2026-06-01 12:34:56" }, "userid": { "description": "Owning user UUID (userid column). Present only on real invoice rows, not on the synthetic 'default' entry.", "type": "string", "example": "11111111-2222-3333-4444-555555555555" }, "total": { "description": "Sum of open credit-log 'change' amounts attributed to this invoice, or 0 if none. Added to every item.", "type": "number", "format": "float", "example": "12.5" } }, "type": "object" }, "UserRequestAccessListResponse": { "properties": { "id": { "description": "Access record UUID (main_user_access.id)", "type": "string", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "serviceid": { "description": "UUID of the service the access is granted on (main_user_access.serviceid)", "type": "string", "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901" }, "status": { "description": "Access status flag (main_user_access.status); list is filtered to status=1", "type": "integer", "example": "1" }, "created_on": { "description": "Creation timestamp converted to unix epoch by convertTimeToUnix", "type": "integer", "example": "1750636800" }, "name": { "description": "Access label (main_user_access.name), nullable", "type": "string", "example": "Team access" }, "entrys": { "description": "Array of AccessRight rows from main_user_access_rights (AccessRight::getData()=getFields()). Each item: id (string uuid), accessid (string uuid), perm (string), created_on (string timestamp, NOT unix-converted here)", "type": "array", "items": { "type": "object" } }, "productid": { "description": "Product id pulled from the linked Service (service_main.productid, int4)", "type": "integer", "example": "42" } }, "type": "object" }, "UserSSHKeysResponse": { "properties": { "id": { "description": "UUID primary key of the SSH key record (uuid column)", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "userid": { "description": "UUID of the owning user (uuid column, FK to main_user.id)", "type": "string", "example": "7c9e6679-7425-40de-944b-e07fc1f90ae7" }, "displayname": { "description": "Display name / header of the SSH key (varchar)", "type": "string", "example": "My Laptop Key" }, "key": { "description": "The SSH public key string (text)", "type": "string", "example": "ssh-rsa AAAAB3NzaC1yc2E... user@host" }, "created_on": { "description": "Timestamp when the key was created (timestamp, default CURRENT_TIMESTAMP, may be null)", "type": "string", "example": "2026-06-23 14:32:11" } }, "type": "object" }, "UserSessionAccessPermsResponse": { "properties": { "perm": { "description": "A permission string. The top-level response is a flat JSON array of these values; each element is the 'perm' column (varchar NOT NULL) of a row in interface.main_user_access_rights, collected by iterating the access rights tied to the caller's access record for the given serviceid.", "type": "string", "example": "manageServers" } }, "type": "object" }, "UserSessionInfoResponse": { "properties": { "id": { "description": "Session id (uuid) from main_user_session.", "type": "string", "example": "e2b9c3a4-1f2d-4a6b-8c0e-1234567890ab" }, "userid": { "description": "Owning user id (uuid).", "type": "string", "example": "9b144236-99e4-49a5-961c-580c8edd266a" }, "ip": { "description": "IP address the session was created from.", "type": "string", "example": "203.0.113.5" }, "expire_at": { "description": "Session expiry timestamp (string; not unix-converted here).", "type": "string", "example": "2026-06-30 12:00:00" }, "created_on": { "description": "Session creation timestamp (string; convertTimeToUnix conversion list was empty).", "type": "string", "example": "2026-06-23 09:15:42" }, "userInfo": { "description": "From User::getData() (main_user table minus sevdeskid/password/twofasecret). Object fields below.", "type": "object" }, "permissions": { "description": "Empty array [] when user is on the main interface (interfaceid=='interfaceid'); otherwise a map of permission keys (e.g. 'someKey' or 'someKey.subKey') each set to integer 1. Keys are dynamic/reseller-defined and not statically determinable.", "type": "object" } }, "type": "object" }, "UserSessionsResponse": { "properties": { "id": { "description": "Session UUID (primary key)", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "userid": { "description": "UUID of the user owning the session (FK to main_user.id)", "type": "string", "example": "6f9619ff-8b86-d011-b42d-00cf4fc964ff" }, "ip": { "description": "IP address from which the session was created", "type": "string", "example": "203.0.113.42" }, "expire_at": { "description": "Timestamp when the session expires (raw timestamp string; not unix-converted)", "type": "string", "example": "2026-06-24 12:34:56" }, "created_on": { "description": "Timestamp when the session was created (raw timestamp string; not unix-converted)", "type": "string", "example": "2026-06-23 12:34:56" } }, "type": "object" }, "UserStockNotifySubscriptionResponse": { "properties": { "packetid": { "description": "kvmserver_packet uuid the user subscribed to.", "type": "string", "example": "e53490af-aa1a-4c01-8617-b5f77e7fd773" }, "displayname": { "description": "Display name of the packet, varchar column kvmserver_packet.displayname.", "type": "string", "example": "KVM Root L" }, "line": { "description": "Packet line key, varchar column kvmserver_packet.line.", "type": "string", "example": "ryzen" }, "price": { "description": "Monthly price of the packet, numeric column kvmserver_packet.price.", "type": "number", "example": "9.99" }, "instock": { "description": "Current effective stock of the packet: 1 when orderable, 0 when sold\nout. For dynamic stock packets this is computed live from the free\nnode memory of the cluster.", "type": "integer", "example": "0" }, "created_on": { "description": "Creation time of the subscription as unix timestamp (strtotime).", "type": "integer", "example": "1750671600" } }, "type": "object" }, "UserTaxCountriesResponse": { "properties": { "id": { "description": "UUID primary key of the sevdesk country row (uuid column).", "type": "string", "example": "3f9a1c2e-5b6d-4e7f-8a90-1b2c3d4e5f60" }, "sevdeskid": { "description": "Sevdesk country id (int4).", "type": "integer", "example": "1" }, "displayname": { "description": "Display name. Note: SELECT * returns the DB column 'displayname', but the factory overwrites it with the value of 'displaynameen' before returning.", "type": "string", "example": "Germany" }, "displaynameen": { "description": "English display name (varchar).", "type": "string", "example": "Germany" }, "created_on": { "description": "Creation timestamp (timestamp). Included because getAll($json=true) returns the raw SELECT * row without exclusions.", "type": "string", "example": "2022-05-10 12:34:56" }, "vatnumber": { "description": "VAT number (varchar, nullable).", "type": "string", "example": "DE123456789" }, "vatamount": { "description": "VAT percentage/amount (varchar, nullable).", "type": "string", "example": "19" }, "taxset": { "description": "Tax set flag (int4, default 1, nullable).", "type": "integer", "example": "1" } }, "type": "object" }, "UserTwoFaInitResponse": { "properties": { "qrcode": { "description": "QR code image for the 2FA secret rendered as a data URI (TwoFactorAuth::getQRCodeImageAsDataUri).", "type": "string", "example": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..." }, "secret": { "description": "The newly generated TwoFactorAuth secret (createSecret(160)).", "type": "string", "example": "JBSWY3DPEHPK3PXP" }, "backupcodes": { "description": "List of 10 backup codes, each a random 10-character string (Functions::randomString(10)) generated by generateBackupCodes().", "type": "array", "items": { "type": "string" } } }, "type": "object" }, "VersionResponse": { "properties": { "time": { "description": "Current server time (ISO 8601, Europe/Berlin)", "type": "string", "example": "2026-07-26T14:30:00+02:00" }, "timestamp": { "description": "Current server time as unix timestamp", "type": "integer", "example": 1784982600 }, "buildtime": { "description": "Time the deployed image was built (ISO 8601, UTC), \"unknown\" if not built via CI", "type": "string", "example": "2026-07-25T18:04:12Z" }, "buildtimestamp": { "description": "Build time as unix timestamp, 0 if not built via CI", "type": "integer", "example": 1784909052 }, "commit": { "description": "Git commit SHA of the deployed build, \"unknown\" if not built via CI", "type": "string", "example": "ba915ec2f4c8a1d9e37b52a60c1d8f4e9a2b7c31" }, "commitshort": { "description": "Short git commit SHA of the deployed build, \"unknown\" if not built via CI", "type": "string", "example": "ba915ec2" }, "branch": { "description": "Git branch the build was created from, \"unknown\" if not built via CI", "type": "string", "example": "main" }, "pipeline": { "description": "GitLab CI pipeline id that built the image, \"unknown\" if not built via CI", "type": "string", "example": "12345" } }, "type": "object" }, "WebspaceLineResponse": { "properties": { "id": { "description": "UUID primary key of the plesk plan", "type": "string", "example": "3f8b1c2a-1d4e-4a9b-8c7d-9e0f1a2b3c4d" }, "name": { "description": "Plan display name", "type": "string", "example": "Webspace Starter" }, "pleskid": { "description": "Plan identifier in Plesk", "type": "string", "example": "42" }, "storage": { "description": "Storage quota", "type": "string", "example": "10240" }, "traffic": { "description": "Traffic quota", "type": "string", "example": "unlimited" }, "domains": { "description": "Allowed number of domains", "type": "string", "example": "5" }, "subdomains": { "description": "Allowed number of subdomains", "type": "string", "example": "25" }, "mailboxes": { "description": "Allowed number of mailboxes", "type": "string", "example": "50" }, "ftpaccounts": { "description": "Allowed number of FTP accounts", "type": "string", "example": "10" }, "databases": { "description": "Allowed number of databases", "type": "string", "example": "20" }, "price": { "description": "Plan price (numeric column)", "type": "number", "format": "float", "example": "4.99" }, "line": { "description": "Product line the plan belongs to", "type": "string", "example": "starter" }, "active": { "description": "Active flag (int4, default 1)", "type": "integer", "example": "1" }, "memorylimit": { "description": "PHP memory limit", "type": "string", "example": "512M" }, "pleskname": { "description": "Plan name in Plesk", "type": "string", "example": "starter_plan" }, "pleskuuid": { "description": "Plan UUID in Plesk", "type": "string", "example": "d2c3b4a5-6789-4012-abcd-ef0123456789" } }, "type": "object" }, "WebspacePacketInfoResponse": { "properties": { "id": { "description": "UUID primary key of the plesk_plan row", "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" }, "name": { "description": "Plan name", "type": "string", "example": "Webspace Basic" }, "pleskid": { "description": "Plesk-side plan identifier", "type": "string", "example": "12" }, "storage": { "description": "Storage allotment (stored as varchar)", "type": "string", "example": "10240" }, "traffic": { "description": "Traffic allotment (stored as varchar)", "type": "string", "example": "unlimited" }, "domains": { "description": "Number of allowed domains (stored as varchar)", "type": "string", "example": "5" }, "subdomains": { "description": "Number of allowed subdomains (stored as varchar)", "type": "string", "example": "10" }, "mailboxes": { "description": "Number of allowed mailboxes (stored as varchar)", "type": "string", "example": "20" }, "ftpaccounts": { "description": "Number of allowed FTP accounts (stored as varchar)", "type": "string", "example": "5" }, "databases": { "description": "Number of allowed databases (stored as varchar)", "type": "string", "example": "10" }, "price": { "description": "Plan price (numeric)", "type": "number", "format": "float", "example": "4.99" }, "line": { "description": "Plan line/grouping (nullable varchar)", "type": "string", "example": "premium" }, "active": { "description": "Active flag (int4, nullable, default 1)", "type": "integer", "example": "1" }, "memorylimit": { "description": "Memory limit (nullable varchar)", "type": "string", "example": "256M" }, "pleskname": { "description": "Plesk-side plan name (nullable varchar)", "type": "string", "example": "basic_plan" }, "pleskuuid": { "description": "Plesk-side plan UUID (nullable varchar)", "type": "string", "example": "a1b2c3d4-..." } }, "type": "object" } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "No authorization to manage this resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "This resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "406": { "description": "The request could not be processed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestFailed" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": {} } } } }, "DonationPaymentLinkStart": { "description": "PaymentLink", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DonationPaymentLinkStart" } } } }, "DonationPaymentStatus": { "description": "PaymentStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DonationPaymentStatus" } } } }, "KVMLineResponse": { "description": "List of KVM Server Offers.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KVMLineResponse" } } } } }, "KVMPacketResponse": { "description": "KVM Server Offer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KVMLineResponse" } } } }, "KVMPacketOsResponse": { "description": "KVM Server Offer Os List", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KVMLineOsResponse" } } } } }, "KvmserverHostsystemResponse": { "description": "KVM host system hardware", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KvmserverHostsystemResponse" } } } }, "OrderKVMResponse": { "description": "Order KVM Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderKVMResponse" } } } }, "OrderPayResponse": { "description": "Pay Order", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderPayResponse" } } } }, "WebspaceLineResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebspaceLineResponse" } } } } }, "WebspacePacketInfoResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebspacePacketInfoResponse" } } } }, "NextcloudLineResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NextcloudLineResponse" } } } } }, "NextcloudValidateDomainResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NextcloudValidateDomainResponse" } } } }, "NextcloudPacketInfoResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NextcloudPacketInfoResponse" } } } }, "GameserverAllResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GameserverAllResponse" } } } } }, "GameserverLineResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GameserverLineResponse" } } } } }, "GameserverGameInfoResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GameserverGameInfoResponse" } } } }, "KvmserverOsResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KvmserverOsResponse" } } } } }, "DedicatedLineResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DedicatedLineResponse" } } } } }, "DedicatedPacketInfoResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DedicatedPacketInfoResponse" } } } }, "DedicatedOsPacketResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DedicatedOsPacketResponse" } } } } }, "DedicatedSaleResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DedicatedSaleResponse" } } } } }, "DedicatedSaleCustomResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DedicatedSaleCustomResponse" } } } }, "DedicatedSaleCustomOsResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DedicatedSaleCustomOsResponse" } } } } }, "DedicatedOsInfoResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DedicatedOsInfoResponse" } } } } }, "DedicatedSaleInfoResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DedicatedSaleInfoResponse" } } } }, "ResellerInterfaceListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerInterfaceListResponse" } } } } }, "ResellerPacketListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerPacketListResponse" } } } } }, "ResellerCheckDomainResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResellerCheckDomainResponse" } } } }, "ResellerIpListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerIpListResponse" } } } } }, "ResellerInterfaceInfoResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResellerInterfaceInfoResponse" } } } }, "ResellerInterfaceStatsResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResellerInterfaceStatsResponse" } } } }, "ResellerOrderListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerOrderListResponse" } } } } }, "ResellerOrderExportCsvResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResellerOrderExportCsvResponse" } } } }, "ResellerSubResellersResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerSubResellersResponse" } } } } }, "ResellerPaymentListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerPaymentListResponse" } } } } }, "ResellerAvailablePaymentsResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerAvailablePaymentsResponse" } } } } }, "ResellerOsListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerOsListResponse" } } } } }, "ResellerOsListDefaultResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerOsListDefaultResponse" } } } } }, "ResellerKvmPackagesResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerKvmPackagesResponse" } } } } }, "ResellerNextcloudPackagesResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerNextcloudPackagesResponse" } } } } }, "ResellerObjectstoragePackagesResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerObjectstoragePackagesResponse" } } } } }, "ResellerDedicatedPackagesResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerDedicatedPackagesResponse" } } } } }, "ResellerDedicatedPackageUpgradesResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerDedicatedPackageUpgradesResponse" } } } } }, "ResellerDedicatedPackageUpgradesListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerDedicatedPackageUpgradesListResponse" } } } } }, "ResellerSingleInvoiceResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResellerSingleInvoiceResponse" } } } }, "ResellerEmailTemplatesResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerEmailTemplatesResponse" } } } } }, "ResellerLanguagesResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerLanguagesResponse" } } } } }, "ResellerLanguageResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResellerLanguageResponse" } } } }, "ResellerLanguageExportResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResellerLanguageExportResponse" } } } }, "ResellerUserPermissionsResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerUserPermissionsResponse" } } } } }, "ResellerTicketListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerTicketListResponse" } } } } }, "ResellerTicketStatusListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerTicketStatusListResponse" } } } } }, "ResellerTicketTemplateListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerTicketTemplateListResponse" } } } } }, "ResellerTicketDetailsResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResellerTicketDetailsResponse" } } } }, "ResellerOrderKVMReseponse": { "description": "Order KVM Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResellerOrderKVMReseponse" } } } }, "ResellerOrderGameserverReseponse": { "description": "Order Gameserver Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResellerOrderGameserverReseponse" } } } }, "ResellerOrderS3Reseponse": { "description": "Order S3 Object Storage", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResellerOrderS3Reseponse" } } } }, "ResellerOrderNextcloudReseponse": { "description": "Order Nextcloud", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResellerOrderNextcloudReseponse" } } } }, "ResellerOrderDedicatedReseponse": { "description": "Order Dedicated Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResellerOrderDedicatedReseponse" } } } }, "ResellerGameServerVersionResponse": { "description": "Get Gameserver Version", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerGameServerVersionResponse" } } } } }, "ResellerGameServerResponse": { "description": "Get Gameserver List", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerGameServerResponse" } } } } }, "ResellerExtendServiceReseponse": { "description": "Extend Service", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResellerExtendServiceReseponse" } } } }, "InterfaceUserResponse": { "description": "User Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterfaceUserResponse" } } } }, "ResellerUserCreateResponse": { "description": "User ID", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResellerUserCreateResponse" } } } } }, "InterfaceServiceResponse": { "description": "User ID", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InterfaceServiceResponse" } } } } }, "ServiceListResponse": { "description": "Service List", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponse" } } } } }, "ServiceStatusResponse": { "description": "Service List", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceStatusResponse" } } } }, "ServiceOsResponse": { "description": "Service List", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KVMLineOsResponse" } } } } }, "ServiceHideResponse": { "description": "Service List", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "ServiceIpResponse": { "description": "Service List", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceIPResponse" } } } }, "ServiceTrafficResponse": { "description": "Service List", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTrafficResponse" } } } }, "ServiceInfoResponse": { "description": "Service List", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceInfoResponse" } } } }, "ServiceBackupResponse": { "description": "Service List", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceBackupResponse" } } } } }, "ServiceCronResponse": { "description": "Service List", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCronResponse" } } } } }, "ServiceExtendResponse": { "description": "Order KVM Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceExtendResponse" } } } }, "ServicePleskLoginResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServicePleskLoginResponse" } } } }, "ServiceHardwareResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceHardwareResponse" } } } }, "ServiceTrafficHistoryResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTrafficHistoryResponse" } } } }, "ServiceModListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceModListResponse" } } } } }, "ServiceSSHKeysResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceSSHKeysResponse" } } } } }, "ServiceVersionResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceVersionResponse" } } } } }, "ServiceLiveDataResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceLiveDataResponse" } } } }, "ServiceWebsocketTokenResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceWebsocketTokenResponse" } } } }, "ServiceNovncDataResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceNovncDataResponse" } } } }, "ServiceGameListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceGameListResponse" } } } } }, "ServiceLogFilesResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceLogFilesResponse" } } } } }, "ServiceLogFileResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceLogFileResponse" } } } }, "ServiceBucketListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceBucketListResponse" } } } } }, "ServiceModsResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceModsResponse" } } } } }, "ServiceIncidentsResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceIncidentsResponse" } } } }, "ServiceCustomIsoListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceCustomIsoListResponse" } } } } }, "ServiceBucketDetailsResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceBucketDetailsResponse" } } } }, "ServiceBucketRequestsResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceBucketRequestsResponse" } } } }, "ServiceBucketTrafficResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceBucketTrafficResponse" } } } }, "ServiceBucketRequestStatisticsResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceBucketRequestStatisticsResponse" } } } } }, "ServiceActionLogsResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceActionLogsResponse" } } } } }, "ServiceGameSettingsResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceGameSettingsResponse" } } } } }, "ServiceGameConfigsResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceGameConfigsResponse" } } } } }, "ServiceGameConfigResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceGameConfigResponse" } } } }, "ServiceFilesResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceFilesResponse" } } } } }, "ServiceFileContentResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFileContentResponse" } } } }, "ServiceFileDownloadResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceFileDownloadResponse" } } } }, "ServiceActivityLogsResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceActivityLogsResponse" } } } } }, "ServiceNetworkDataResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceNetworkDataResponse" } } } } }, "ServiceUpgradeInfoResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceUpgradeInfoResponse" } } } } }, "ServiceDowngradeInfoResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceDowngradeInfoResponse" } } } } }, "ServiceAddonsResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceAddonsResponse" } } } } }, "ServiceAddonListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceAddonListResponse" } } } } }, "UserTaxCountriesResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserTaxCountriesResponse" } } } } }, "UserSessionInfoResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSessionInfoResponse" } } } }, "UserSessionAccessPermsResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserSessionAccessPermsResponse" } } } } }, "UserApiKeyInfoResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserApiKeyInfoResponse" } } } }, "UserAccessInfoResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAccessInfoResponse" } } } }, "UserTwoFaInitResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserTwoFaInitResponse" } } } }, "UserCreditLogResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserCreditLogResponse" } } } } }, "UserCountryListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserCountryListResponse" } } } } }, "UserEmailLogResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserEmailLogResponse" } } } } }, "UserEmailResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserEmailResponse" } } } }, "UserPayByInvoiceInfoResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPayByInvoiceInfoResponse" } } } }, "UserPayByInvoiceListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserPayByInvoiceListResponse" } } } } }, "UserCreditLogUnpaidResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserCreditLogUnpaidResponse" } } } } }, "UserDonationInfoResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDonationInfoResponse" } } } }, "UserLastDonationsResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserLastDonationsResponse" } } } } }, "UserDonationLinkListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserDonationLinkListResponse" } } } } }, "UserOrderListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserOrderListResponse" } } } } }, "UserOrderExternalIdResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserOrderListResponse" } } } }, "UserInvoiceResellerResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserInvoiceResellerResponse" } } } }, "UserDashboardResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDashboardResponse" } } } }, "UserNotificationSettingsResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserNotificationSettingsResponse" } } } } }, "UserStockNotifySubscriptionResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserStockNotifySubscriptionResponse" } } } } }, "UserInvoiceDataResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserInvoiceDataResponse" } } } }, "UserInvoiceListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserInvoiceListResponse" } } } } }, "UserApiInfoResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserApiInfoResponse" } } } }, "UserApiKeysResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserApiKeysResponse" } } } } }, "UserApiKeyCreateResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserApiKeyCreateResponse" } } } }, "UserApiScopeRoutesResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserApiScopeRoutesResponse" } } } } }, "UserAffiliateLinkListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserAffiliateLinkListResponse" } } } } }, "UserAffiliateInfoResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAffiliateInfoResponse" } } } }, "UserAffiliateListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserAffiliateListResponse" } } } } }, "UserSessionsResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserSessionsResponse" } } } } }, "UserSSHKeysResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserSSHKeysResponse" } } } } }, "UserPasskeysResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserPasskeysResponse" } } } } }, "UserPasskeyRegisterOptionsResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPasskeyRegisterOptionsResponse" } } } }, "UserPasskeyRegisterResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPasskeyRegisterResponse" } } } }, "UserPasskeyLoginOptionsResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPasskeyLoginOptionsResponse" } } } }, "UserPasskeyLoginResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPasskeyLoginResponse" } } } }, "UserAccessListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserAccessListResponse" } } } } }, "UserRequestAccessListResponse": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserRequestAccessListResponse" } } } } }, "UserDonationLinkInfoResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDonationLinkInfoResponse" } } } }, "UserDonationStartResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDonationStartResponse" } } } }, "UserDonationStatusResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDonationStatusResponse" } } } }, "VersionResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionResponse" } } } } }, "securitySchemes": { "api_key": { "type": "apiKey", "name": "token", "in": "query" }, "bearer_auth": { "type": "http", "scheme": "bearer" } } }, "tags": [ { "name": "user", "description": "Access to user endpoints" }, { "name": "reseller", "description": "Access to reseller endpoints" }, { "name": "webspace", "description": "Access to webspace endpoints" }, { "name": "nextcloud", "description": "Access to nextcloud endpoints" }, { "name": "gameserver", "description": "Access to gameserver endpoints" }, { "name": "kvmserver", "description": "Access to kvmserver endpoints" }, { "name": "dedicated", "description": "Access to dedicated endpoints" }, { "name": "order", "description": "Access to order endpoints" }, { "name": "service", "description": "Access to service endpoints" }, { "name": "version", "description": "Access to version endpoints" } ] }