{ "openapi": "3.0.4", "info": { "title": "Serverside.com API", "version": "1.0", "description": "Public operations of the Serverside.com API. Admin, internal, callback, session and health routes are excluded.", "x-source": "https://api.dev.cloud.internal.serverside.com/swagger/v1/swagger.json", "x-source-sha256": "b30dadd5f34347a0d8635e182d6fb9dfef1402a0c76474fe98722823271f05c4", "x-synced-at": "2026-09-23" }, "servers": [ { "url": "https://api.serverside.com", "description": "Production" } ], "security": [ { "ApiKeyAuth": [] } ], "paths": { "/v1/services/baremetal": { "get": { "tags": [ "Baremetal" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } }, { "name": "datacenter_id", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaremetalServiceListedViewModelIEnumerableServiceResponse" } } } } } }, "post": { "tags": [ "Baremetal" ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "schema": { "maxLength": 200, "minLength": 0, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateHourlyBaremetalRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaremetalServiceDetailedViewModelServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}": { "get": { "tags": [ "Baremetal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaremetalServiceDetailedViewModelServiceResponse" } } } } } }, "put": { "tags": [ "Baremetal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientUpdateBaremetalServiceDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaremetalServiceDetailedViewModelServiceResponse" } } } } } }, "delete": { "tags": [ "Baremetal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/services/baremetal/{id}/status": { "get": { "tags": [ "Baremetal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaremetalServiceStatusViewServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/lock": { "put": { "tags": [ "Baremetal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/services/baremetal/{id}/unlock": { "put": { "tags": [ "Baremetal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/services/baremetal/{id}/spns": { "get": { "tags": [ "Baremetal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpnAttachmentViewListServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/activity": { "get": { "tags": [ "BaremetalActivity" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditLogEntryViewListServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/bandwidth/usage": { "get": { "tags": [ "BaremetalBandwidth" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaremetalBandwidthUsageViewServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/bandwidth/stats": { "get": { "tags": [ "BaremetalBandwidth" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "start", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "end", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "step_seconds", "in": "query", "schema": { "maximum": 2147483647, "minimum": 60, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaremetalBandwidthStatsViewServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/ipxe": { "get": { "tags": [ "BaremetalBoot" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpxeScriptResponseServiceResponse" } } } } } }, "put": { "tags": [ "BaremetalBoot" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateIpxeScriptRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpxeScriptResponseServiceResponse" } } } } } }, "delete": { "tags": [ "BaremetalBoot" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/boot-mode": { "put": { "tags": [ "BaremetalBoot" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBootModeRequest" } } } }, "responses": { "202": { "description": "Accepted" }, "204": { "description": "No Content" } } } }, "/v1/services/baremetal/{id}/iso": { "get": { "tags": [ "BaremetalIso" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaremetalIsoFileViewIEnumerableServiceResponse" } } } } } } }, "/v1/services/baremetal/iso/upload": { "post": { "tags": [ "BaremetalIso" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIsoFileRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIsoFileResponseServiceResponse" } } } } }, "deprecated": true } }, "/v1/services/baremetal/iso/upload/{id}/complete": { "post": { "tags": [ "BaremetalIso" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanServiceResponse" } } } } }, "deprecated": true } }, "/v1/services/baremetal/iso/{id}": { "delete": { "tags": [ "BaremetalIso" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } } }, "deprecated": true } }, "/v1/services/baremetal/{id}/networking/logical-interface": { "post": { "tags": [ "BaremetalNetworking" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBaremetalSegmentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/networking/logical-interface/{logicalInterfaceId}": { "delete": { "tags": [ "BaremetalNetworking" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "logicalInterfaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/networking/capabilities": { "get": { "tags": [ "BaremetalNetworking" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaremetalNetworkCapabilityViewServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/networking/security-scan": { "get": { "tags": [ "BaremetalNetworking" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringSecurityScanClientViewDictionaryServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/operations": { "get": { "tags": [ "BaremetalOperations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaremetalOperationHistoryViewIEnumerableServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/operations/{operationId}": { "get": { "tags": [ "BaremetalOperations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "operationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaremetalOperationDetailViewServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/operations/deploy/os": { "get": { "tags": [ "BaremetalOperations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaremetalImageDtoIReadOnlyListServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/operations/deploy/apps": { "get": { "tags": [ "BaremetalOperations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoftwareApplicationDtoIReadOnlyListServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/operations/deploy": { "post": { "tags": [ "BaremetalOperations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaremetalServiceDeployRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaremetalOperationViewServiceResponse" } } } } } }, "delete": { "tags": [ "BaremetalOperations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/operations/test": { "post": { "tags": [ "BaremetalOperations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaremetalServiceTestRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaremetalOperationViewServiceResponse" } } } } } }, "delete": { "tags": [ "BaremetalOperations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } } } } }, "/v1/services/baremetal/plans": { "get": { "tags": [ "BaremetalPlans" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaremetalOfferingWithAvailabilityDtoIEnumerableServiceResponse" } } } } } } }, "/v1/services/baremetal/plans/{id}": { "get": { "tags": [ "BaremetalPlans" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaremetalOfferingWithAvailabilityDtoServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/power": { "get": { "tags": [ "BaremetalPower" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BmcPowerStateServiceResponse" } } } } } }, "post": { "tags": [ "BaremetalPower" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PowerCommandRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/bmc/reset": { "post": { "tags": [ "BaremetalPower" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/power/psu/health": { "get": { "tags": [ "BaremetalPower" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedfishPowerSupplyIReadOnlyListServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/thermals": { "get": { "tags": [ "BaremetalPower" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedfishThermalServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/power/metrics": { "get": { "tags": [ "BaremetalPower" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PowerControlServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/ikvm": { "post": { "tags": [ "BaremetalRemoteAccess" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientKvmSessionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientKvmSessionDetailsServiceResponse" } } } } } }, "delete": { "tags": [ "BaremetalRemoteAccess" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "forward_id", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/ikvm/list": { "get": { "tags": [ "BaremetalRemoteAccess" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KvmSessionListServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/virtual-media/mount": { "post": { "tags": [ "BaremetalRemoteAccess" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MountVirtualMediaRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaremetalIsoFileViewServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/virtual-media/eject/{index}": { "post": { "tags": [ "BaremetalRemoteAccess" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/virtual-media/mounts": { "get": { "tags": [ "BaremetalRemoteAccess" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaremetalVmMountIEnumerableServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/stats/bandwidth": { "get": { "tags": [ "BaremetalStats" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "range_seconds", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaremetalBandwidthHistoryListServiceResponse" } } } } } } }, "/v1/services/baremetal/{id}/stats/daily-bandwidth": { "get": { "tags": [ "BaremetalStats" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "days", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaremetalBandwidthHistoryListServiceResponse" } } } } } } }, "/v1/networking/spn/{id}/prefixes/v4/{childPrefixId}": { "get": { "tags": [ "ClientIpv4Management" ], "parameters": [ { "name": "childPrefixId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpChildPrefixWithAddressUsageViewServiceResponse" } } } } } } }, "/v1/networking/spn/{id}/prefixes/v4/{childPrefixId}/reserve/addresses": { "post": { "tags": [ "ClientIpv4Management" ], "parameters": [ { "name": "childPrefixId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReserveV4AddressRequest" } } } }, "responses": { "204": { "description": "No Content" } } } }, "/v1/networking/spn/{id}/prefixes/v4/{childPrefixId}/addresses/assign/service": { "post": { "tags": [ "ClientIpv4Management" ], "parameters": [ { "name": "childPrefixId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignV4AddressToServiceRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIpAssignmentDtoServiceResponse" } } } } } } }, "/v1/networking/spn/{id}/prefixes/v4/{childPrefixId}/addresses/{address}/release": { "delete": { "tags": [ "ClientIpv4Management" ], "parameters": [ { "name": "childPrefixId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "address", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/networking/spn/{id}/prefixes/v4/{childPrefixId}/addresses/{address}/rdns": { "post": { "tags": [ "ClientIpv4Management" ], "parameters": [ { "name": "childPrefixId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "address", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V4PtrRequest" } } } }, "responses": { "204": { "description": "No Content" } } }, "delete": { "tags": [ "ClientIpv4Management" ], "parameters": [ { "name": "childPrefixId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "address", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/networking/spn/{id}/prefixes/v6/{childPrefixId}": { "get": { "tags": [ "ClientIpv6Management" ], "parameters": [ { "name": "childPrefixId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpChildPrefixWithAddressUsageViewServiceResponse" } } } } } } }, "/v1/networking/spn/{id}/prefixes/v6/{childPrefixId}/reserve": { "post": { "tags": [ "ClientIpv6Management" ], "parameters": [ { "name": "childPrefixId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReserveV6AddressRequest" } } } }, "responses": { "204": { "description": "No Content" } } } }, "/v1/networking/spn/{id}/prefixes/v6/{childPrefixId}/assign/service": { "post": { "tags": [ "ClientIpv6Management" ], "parameters": [ { "name": "childPrefixId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignV6AddressToServiceRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIpAssignmentDtoServiceResponse" } } } } } } }, "/v1/networking/spn/{id}/prefixes/v6/{childPrefixId}/addresses/{address}/release": { "delete": { "tags": [ "ClientIpv6Management" ], "parameters": [ { "name": "childPrefixId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "address", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/meta/countries": { "get": { "tags": [ "Countries" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountryDtoIReadOnlyListServiceResponse" } } } } } } }, "/v1/meta/countries/{countryCode}/address-format": { "get": { "tags": [ "Countries" ], "parameters": [ { "name": "countryCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressFormatMetadataServiceResponse" } } } } } } }, "/v1/billing/credit": { "get": { "tags": [ "Credit" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountCreditSummaryServiceResponse" } } } } } } }, "/v1/billing/credit/{id}": { "get": { "tags": [ "Credit" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountCreditEntryViewServiceResponse" } } } } } } }, "/v1/billing/credit/purchase": { "post": { "tags": [ "Credit" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditPurchaseRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceClientViewServiceResponse" } } } } } } }, "/v1/billing/currencies": { "get": { "tags": [ "Currencies" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrencyClientViewIEnumerableServiceResponse" } } } } } } }, "/v1/networking/firewall/groups": { "get": { "tags": [ "Firewall" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirewallGroupDtoListServiceResponse" } } } } } }, "post": { "tags": [ "Firewall" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientCreateFirewallGroupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirewallGroupDtoServiceResponse" } } } } } } }, "/v1/networking/firewall/groups/{id}": { "get": { "tags": [ "Firewall" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirewallGroupDetailDtoServiceResponse" } } } } } }, "delete": { "tags": [ "Firewall" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } }, "patch": { "tags": [ "Firewall" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientUpdateFirewallGroupRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirewallGroupDtoServiceResponse" } } } } } } }, "/v1/networking/firewall/groups/{id}/rules": { "get": { "tags": [ "Firewall" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirewallRuleDtoListServiceResponse" } } } } } }, "post": { "tags": [ "Firewall" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateFirewallRuleRequest" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirewallRuleDtoListServiceResponse" } } } } } } }, "/v1/networking/firewall/groups/{id}/rules/{ruleId}": { "get": { "tags": [ "Firewall" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirewallRuleDtoServiceResponse" } } } } } }, "delete": { "tags": [ "Firewall" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } }, "patch": { "tags": [ "Firewall" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFirewallRuleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirewallRuleDtoServiceResponse" } } } } } } }, "/v1/networking/firewall/groups/{id}/assignments": { "post": { "tags": [ "Firewall" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignFirewallGroupRequest" } } } }, "responses": { "204": { "description": "No Content" } } } }, "/v1/networking/firewall/groups/{id}/assignments/{ipAddressEntityId}": { "delete": { "tags": [ "Firewall" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ipAddressEntityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/billing/invoices": { "get": { "tags": [ "Invoices" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } }, { "name": "unpaid_only", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceClientViewIEnumerableServiceResponse" } } } } } } }, "/v1/billing/invoices/{id}": { "get": { "tags": [ "Invoices" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceClientViewServiceResponse" } } } } } } }, "/v1/billing/invoices/{id}/pay": { "post": { "tags": [ "Invoices" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "method_id", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "provider_type", "in": "query", "schema": { "$ref": "#/components/schemas/EPaymentProviderType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentResultServiceResponse" } } } } } } }, "/v1/billing/invoices/{id}/pay/confirm": { "post": { "tags": [ "Invoices" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "provider_transaction_id", "in": "query", "schema": { "type": "string" } }, { "name": "provider_type", "in": "query", "schema": { "$ref": "#/components/schemas/EPaymentProviderType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentResultServiceResponse" } } } } } } }, "/v1/billing/invoices/{id}/pdf": { "get": { "tags": [ "Invoices" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/services/ip-blocks/plans": { "get": { "tags": [ "IpBlockPlans" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } }, { "name": "datacenter_id", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpBlockOfferingWithAvailabilityDtoIEnumerableServiceResponse" } } } } } } }, "/v1/services/ip-blocks/plans/{id}": { "get": { "tags": [ "IpBlockPlans" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "datacenter_id", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpBlockOfferingWithAvailabilityDtoServiceResponse" } } } } } } }, "/v1/networking/ip-blocks": { "post": { "tags": [ "IpBlocks" ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "schema": { "maxLength": 200, "minLength": 0, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateHourlyIpBlockRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIpBlockResponseServiceResponse" } } } } } } }, "/v1/networking/ip-blocks/{id}": { "delete": { "tags": [ "IpBlocks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/assets/iso": { "get": { "tags": [ "Iso" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IsoFileDtoIEnumerableServiceResponse" } } } } } } }, "/v1/assets/iso/upload": { "post": { "tags": [ "Iso" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIsoFileRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIsoFileResponseServiceResponse" } } } } } } }, "/v1/assets/iso/upload/{id}/complete": { "post": { "tags": [ "Iso" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanServiceResponse" } } } } } } }, "/v1/assets/iso/{id}": { "delete": { "tags": [ "Iso" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } } } } }, "/v1/notifications": { "get": { "tags": [ "Notification" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserNotificationViewIEnumerableServiceResponse" } } } } } } }, "/v1/notifications/{id}": { "get": { "tags": [ "Notification" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserNotificationViewServiceResponse" } } } } } }, "delete": { "tags": [ "Notification" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/notifications/read/{id}": { "post": { "tags": [ "Notification" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserNotificationViewServiceResponse" } } } } } } }, "/v1/billing/orders": { "get": { "tags": [ "Orders" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderIEnumerableServiceResponse" } } } } } }, "post": { "tags": [ "Orders" ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "schema": { "maxLength": 200, "minLength": 0, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrderResponseServiceResponse" } } } } } } }, "/v1/billing/orders/{id}": { "get": { "tags": [ "Orders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderServiceResponse" } } } } } } }, "/v1/organization/activity": { "get": { "tags": [ "OrgActivity" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } }, { "name": "action_prefix", "in": "query", "schema": { "type": "string" } }, { "name": "actor_id", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "actor_type", "in": "query", "schema": { "$ref": "#/components/schemas/AuditActorType" } }, { "name": "severity", "in": "query", "schema": { "$ref": "#/components/schemas/AuditSeverity" } }, { "name": "target_entity_type", "in": "query", "schema": { "$ref": "#/components/schemas/AuditTargetType" } }, { "name": "target_entity_id", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditLogEntryViewListServiceResponse" } } } } } } }, "/v1/organization/memberships": { "get": { "tags": [ "Organization" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationMembershipDtoIEnumerableServiceResponse" } } } } } } }, "/v1/organization": { "get": { "tags": [ "Organization" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDtoServiceResponse" } } } } } }, "post": { "tags": [ "Organization" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientCreateOrganizationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDtoServiceResponse" } } } } } }, "patch": { "tags": [ "Organization" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientUpdateOrganizationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDtoServiceResponse" } } } } } } }, "/v1/organization/meta": { "get": { "tags": [ "Organization" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationMetaDtoServiceResponse" } } } } } } }, "/v1/organization/ownership-transfer": { "post": { "tags": [ "Organization" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientSendOwnershipTransferRequest" } } } }, "responses": { "204": { "description": "No Content" } } } }, "/v1/organization/{orgId}/accept-ownership": { "post": { "tags": [ "Organization" ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientAcceptOwnershipTransferRequest" } } } }, "responses": { "204": { "description": "No Content" } } } }, "/v1/organization/api-keys": { "get": { "tags": [ "OrganizationApiKey" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationApiKeyDtoIEnumerableServiceResponse" } } } } } }, "post": { "tags": [ "OrganizationApiKey" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationApiKeyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" } } } } } } }, "/v1/organization/api-keys/{id}": { "delete": { "tags": [ "OrganizationApiKey" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/organization/api-keys/{id}/enable": { "post": { "tags": [ "OrganizationApiKey" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationApiKeyDtoServiceResponse" } } } } } } }, "/v1/organization/api-keys/{id}/disable": { "post": { "tags": [ "OrganizationApiKey" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationApiKeyDtoServiceResponse" } } } } } } }, "/v1/organization/api-keys/{id}/allowed-ips": { "post": { "tags": [ "OrganizationApiKey" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddAllowedIpRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationApiKeyDtoServiceResponse" } } } } } } }, "/v1/organization/api-keys/{id}/allowed-ips/{ipAddress}": { "delete": { "tags": [ "OrganizationApiKey" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ipAddress", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/organization/entitlements": { "get": { "tags": [ "OrganizationEntitlements" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringObjectIReadOnlyDictionaryServiceResponse" } } } } } } }, "/v1/organization/membership/invite": { "post": { "tags": [ "OrganizationInvite" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientOrgInviteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } } } } }, "/v1/organization/{organizationId}/membership/invites/{inviteCode}/validate": { "get": { "tags": [ "OrganizationInvite" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "inviteCode", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationInviteValidationResponseServiceResponse" } } } } } } }, "/v1/organization/{organizationId}/membership/invites/{inviteCode}/accept": { "post": { "tags": [ "OrganizationInvite" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "inviteCode", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } } } } }, "/v1/organization/membership/invites/cancel": { "post": { "tags": [ "OrganizationInvite" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientOrgCancelInviteRequest" } } } }, "responses": { "204": { "description": "No Content" } } } }, "/v1/organization/membership/invites": { "get": { "tags": [ "OrganizationInvite" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationInviteDtoListServiceResponse" } } } } } } }, "/v1/organization/membership": { "get": { "tags": [ "OrganizationMembership" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationMemberOnlyDtoIEnumerableServiceResponse" } } } } } } }, "/v1/organization/membership/remove/{userId}": { "delete": { "tags": [ "OrganizationMembership" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } } } } }, "/v1/organization/membership/roles": { "get": { "tags": [ "OrganizationRole" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } }, { "name": "custom_roles_only", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGetOrganizationRoleDtoIEnumerableServiceResponse" } } } } } }, "post": { "tags": [ "OrganizationRole" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddOrganizationRoleDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGetOrganizationRoleDtoServiceResponse" } } } } } } }, "/v1/organization/membership/roles/{id}": { "put": { "tags": [ "OrganizationRole" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationRoleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGetOrganizationRoleDtoServiceResponse" } } } } } }, "delete": { "tags": [ "OrganizationRole" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } } } } }, "/v1/organization/membership/roles/add-member": { "post": { "tags": [ "OrganizationRole" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddOrUpdateMemberRoleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } } } } }, "/v1/organization/membership/roles/update-member": { "put": { "tags": [ "OrganizationRole" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddOrUpdateMemberRoleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } } } } }, "/v1/organization/membership/roles/hierarchy": { "get": { "tags": [ "OrganizationRole" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidIEnumerableServiceResponse" } } } } } }, "put": { "tags": [ "OrganizationRole" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetRoleHierarchyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidIEnumerableServiceResponse" } } } } } } }, "/v1/organization/ssh-keys": { "get": { "tags": [ "OrganizationSshKey" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgSshKeyDtoIEnumerableServiceResponse" } } } } } }, "post": { "tags": [ "OrganizationSshKey" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddSshKeyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgSshKeyDtoServiceResponse" } } } } } } }, "/v1/organization/ssh-keys/{id}": { "put": { "tags": [ "OrganizationSshKey" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSshKeyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgSshKeyDtoServiceResponse" } } } } } }, "delete": { "tags": [ "OrganizationSshKey" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } } } } }, "/v1/billing/payments/methods/credit-card": { "post": { "tags": [ "PaymentMethod" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" } } } } } } }, "/v1/billing/payments/methods/{id}": { "put": { "tags": [ "PaymentMethod" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePaymentMethodRequest" } } } }, "responses": { "204": { "description": "No Content" } } }, "delete": { "tags": [ "PaymentMethod" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/profile/update": { "put": { "tags": [ "Profile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientUpdateOwnUserDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientGetOwnUserDtoServiceResponse" } } } } } } }, "/v1/profile/misc/get-my-ipv4": { "get": { "tags": [ "Profile" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/v1/organization/security/overview": { "get": { "tags": [ "SecurityScan" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityOverviewDashboardViewServiceResponse" } } } } } } }, "/v1/organization/security/findings": { "get": { "tags": [ "SecurityScan" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } }, { "name": "severity", "in": "query", "schema": { "$ref": "#/components/schemas/SecuritySeverity" } }, { "name": "plugin", "in": "query", "schema": { "type": "string" } }, { "name": "ip", "in": "query", "schema": { "type": "string" } }, { "name": "service_id", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityFindingDashboardViewIReadOnlyListServiceResponse" } } } } } } }, "/v1/organization/security/findings/filters": { "get": { "tags": [ "SecurityScan" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityFindingFiltersViewServiceResponse" } } } } } } }, "/v1/organization/security/plugins": { "get": { "tags": [ "SecurityScan" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityPluginStatsViewIReadOnlyListServiceResponse" } } } } } } }, "/v1/organization/security/targets": { "get": { "tags": [ "SecurityScan" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } }, { "name": "min_severity", "in": "query", "schema": { "$ref": "#/components/schemas/SecuritySeverity" } }, { "name": "ip", "in": "query", "schema": { "type": "string" } }, { "name": "service_id", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityTargetSummaryDashboardViewIReadOnlyListServiceResponse" } } } } } } }, "/v1/organization/security/targets/{ip}/rescan": { "post": { "tags": [ "SecurityScan" ], "parameters": [ { "name": "ip", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityTargetSummaryDashboardViewServiceResponse" } } } } } } }, "/v1/networking/spn": { "get": { "tags": [ "Spn" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } }, { "name": "type", "in": "query", "schema": { "$ref": "#/components/schemas/SpnType" } }, { "name": "include_managed", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpnWithPrefixCountDtoIEnumerableServiceResponse" } } } } } }, "post": { "tags": [ "Spn" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientCreateSpnRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpnClientViewServiceResponse" } } } } } } }, "/v1/networking/spn/{id}": { "get": { "tags": [ "Spn" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpnWithPrefixesSummaryViewServiceResponse" } } } } } }, "put": { "tags": [ "Spn" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientUpdateSpnRequest" } } } }, "responses": { "204": { "description": "No Content" } } }, "delete": { "tags": [ "Spn" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/networking/spn/available-datacenters": { "get": { "tags": [ "Spn" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatacenterMinimalDtoIEnumerableServiceResponse" } } } } } } }, "/v1/networking/spn/vlan-availability": { "get": { "tags": [ "Spn" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanAvailabilityViewServiceResponse" } } } } } } }, "/v1/networking/spn/{id}/services/assign": { "post": { "tags": [ "Spn" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "schema": { "maxLength": 200, "minLength": 0, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignServiceToSpnRequest" } } } }, "responses": { "202": { "description": "Accepted" }, "204": { "description": "No Content" } } } }, "/v1/networking/spn/{id}/services/unassign": { "put": { "tags": [ "Spn" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "schema": { "maxLength": 200, "minLength": 0, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnassignServiceFromSpnRequest" } } } }, "responses": { "202": { "description": "Accepted" } } } }, "/v1/networking/spn/{id}/services": { "get": { "tags": [ "Spn" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpnServiceViewListServiceResponse" } } } } } } }, "/v1/billing/subscriptions": { "get": { "tags": [ "Subscriptions" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "style": "deepObject", "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "name": "page", "in": "query", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sort_column", "in": "query", "schema": { "type": "string" } }, { "name": "ascending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionClientViewIEnumerableServiceResponse" } } } } } } }, "/v1/billing/subscriptions/{id}": { "get": { "tags": [ "Subscriptions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionClientViewServiceResponse" } } } } } } }, "/v1/billing/subscriptions/from-provisioned/{id}": { "get": { "tags": [ "Subscriptions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionClientViewServiceResponse" } } } } } } }, "/v1/billing/subscriptions/{id}/request-cancellation": { "post": { "tags": [ "Subscriptions" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/supportticket/submit": { "post": { "tags": [ "SupportTicket" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientSubmitSupportTicket" } } } }, "responses": { "204": { "description": "No Content" } } } }, "/v1/billing/usage": { "get": { "tags": [ "Usage" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageSummaryServiceResponse" } } } } } } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-KEY", "description": "Organization API key. Create one in the cloud console at https://cloud.serverside.com; the key is shown once, when it is created." } }, "schemas": { "AccountCreditEntryView": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "amount": { "type": "integer", "format": "int64" }, "currency": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "invoiceId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "AccountCreditEntryViewServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/AccountCreditEntryView" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "AccountCreditSummary": { "type": "object", "properties": { "creditBalance": { "type": "integer", "format": "int64" }, "currency": { "type": "string" }, "minPurchaseAmount": { "type": "integer", "format": "int64" }, "maxPurchaseAmount": { "type": "integer", "format": "int64" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/AccountCreditEntryView" } } }, "additionalProperties": false }, "AccountCreditSummaryServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/AccountCreditSummary" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "AddAllowedIpRequest": { "required": [ "network" ], "type": "object", "properties": { "network": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "AddOrUpdateMemberRoleRequest": { "type": "object", "properties": { "roleId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "AddOrganizationRoleDto": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "hierarchy": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "AddSshKeyRequest": { "type": "object", "properties": { "name": { "type": "string" }, "publicKey": { "type": "string" } }, "additionalProperties": false }, "AddressFamily": { "enum": [ "UNSPECIFIED", "UNIX", "INTER_NETWORK", "IMP_LINK", "PUP", "CHAOS", "NS", "ISO", "ECMA", "DATA_KIT", "CCITT", "SNA", "DEC_NET", "DATA_LINK", "LAT", "HYPER_CHANNEL", "APPLE_TALK", "NET_BIOS", "VOICE_VIEW", "FIRE_FOX", "BANYAN", "ATM", "INTER_NETWORK_V6", "CLUSTER", "IEEE12844", "IRDA", "NETWORK_DESIGNERS", "MAX", "PACKET", "CONTROLLER_AREA_NETWORK", "UNKNOWN" ], "type": "string" }, "AddressFormatMetadata": { "required": [ "country" ], "type": "object", "properties": { "country": { "type": "string" }, "regionLabel": { "type": "string", "nullable": true }, "regionRequired": { "type": "boolean" }, "regions": { "type": "array", "items": { "$ref": "#/components/schemas/AddressRegion" }, "nullable": true }, "postalCodeRegex": { "type": "string", "nullable": true }, "postalCodeExamples": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "AddressFormatMetadataServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/AddressFormatMetadata" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "AddressRegion": { "required": [ "code", "name" ], "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false }, "AppUser": { "required": [ "firstName", "lastName" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "userName": { "type": "string", "nullable": true }, "normalizedUserName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "normalizedEmail": { "type": "string", "nullable": true }, "emailConfirmed": { "type": "boolean" }, "passwordHash": { "type": "string", "nullable": true }, "securityStamp": { "type": "string", "nullable": true }, "concurrencyStamp": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "phoneNumberConfirmed": { "type": "boolean" }, "lockoutEnd": { "type": "string", "format": "date-time", "nullable": true }, "lockoutEnabled": { "type": "boolean" }, "accessFailedCount": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "firstName": { "minLength": 1, "type": "string" }, "lastName": { "minLength": 1, "type": "string" }, "lastLoginIP": { "type": "string" }, "lastLoginDate": { "type": "string", "format": "date-time" }, "passwordLastChangedAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "twoFactorEnabledAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "orgMemberships": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationMember" }, "nullable": true }, "userRoles": { "type": "array", "items": { "$ref": "#/components/schemas/AppUserRole" }, "nullable": true }, "roleInfo": { "$ref": "#/components/schemas/UserRoleInfo" }, "twoFactorEnabled": { "type": "boolean" } }, "additionalProperties": false }, "AppUserRole": { "required": [ "role", "user" ], "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "roleId": { "type": "string", "format": "uuid" }, "user": { "$ref": "#/components/schemas/AppUser" }, "role": { "$ref": "#/components/schemas/GuidIdentityRole" } }, "additionalProperties": false }, "AssignFirewallGroupRequest": { "type": "object", "properties": { "ipAddressEntityId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "AssignServiceToSpnRequest": { "type": "object", "properties": { "serviceId": { "type": "string", "format": "uuid" }, "segmentId": { "type": "string", "format": "uuid" }, "isNative": { "type": "boolean" } }, "additionalProperties": false }, "AssignV4AddressToServiceRequest": { "type": "object", "properties": { "requestedAddress": { "type": "string", "nullable": true }, "serviceId": { "type": "string", "format": "uuid" }, "segmentId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "AssignV6AddressToServiceRequest": { "type": "object", "properties": { "requestedAddress": { "type": "string", "nullable": true }, "serviceId": { "type": "string", "format": "uuid" }, "segmentId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "AttachedServiceSummary": { "required": [ "createdAt", "id", "locked", "name", "region", "suspended" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "locked": { "type": "boolean" }, "suspended": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "primaryIpv4": { "type": "string", "nullable": true }, "primaryIpv6": { "type": "string", "nullable": true }, "region": { "$ref": "#/components/schemas/RegionView" }, "operatingSystem": { "$ref": "#/components/schemas/OperatingSystemView" } }, "additionalProperties": false }, "AuditActorType": { "enum": [ "SYSTEM", "USER", "API_KEY", "ADMIN" ], "type": "string" }, "AuditLogEntryView": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "actorId": { "type": "string", "format": "uuid", "nullable": true }, "actorType": { "$ref": "#/components/schemas/AuditActorType" }, "actorName": { "type": "string", "nullable": true }, "ipAddress": { "type": "string", "nullable": true }, "action": { "type": "string" }, "severity": { "$ref": "#/components/schemas/AuditSeverity" }, "targetEntityType": { "$ref": "#/components/schemas/AuditTargetType" }, "targetEntityId": { "type": "string", "format": "uuid", "nullable": true }, "organizationId": { "type": "string", "format": "uuid", "nullable": true }, "metadata": { "type": "string", "nullable": true }, "occurredAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "AuditLogEntryViewListServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AuditLogEntryView" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "AuditSeverity": { "enum": [ "INFO", "WARNING", "CRITICAL" ], "type": "string" }, "AuditTargetType": { "enum": [ "NONE", "BAREMETAL_SERVICE", "BAREMETAL_NODE", "INVOICE", "ORDER", "SUBSCRIPTION", "ORGANIZATION", "USER", "SPN", "IP_BLOCK", "ISO_FILE", "API_KEY", "SSH_KEY", "ROLE", "PAYMENT_METHOD" ], "type": "string" }, "AvailableBaremetalBondTopology": { "type": "object", "properties": { "bondGroupIndex": { "type": "integer", "format": "int32" }, "interfaces": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "maxBondSize": { "type": "integer", "format": "int32" }, "isConfigured": { "type": "boolean" } }, "additionalProperties": false }, "AvailableBaremetalInterfaceTopology": { "required": [ "interfaceName", "macAddress" ], "type": "object", "properties": { "interfaceId": { "type": "string", "format": "uuid" }, "interfaceName": { "type": "string" }, "macAddress": { "type": "string" }, "isConfigured": { "type": "boolean" }, "segmentId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "BaremetalBandwidthDailyUsageView": { "required": [ "date", "egressBytes", "ingressBytes" ], "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "egressBytes": { "type": "integer", "format": "int64", "nullable": true }, "ingressBytes": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "BaremetalBandwidthHistory": { "required": [ "egressTraffic", "ingressTraffic", "interfaceName" ], "type": "object", "properties": { "ingressTraffic": { "type": "object", "additionalProperties": { "type": "number", "format": "double" } }, "egressTraffic": { "type": "object", "additionalProperties": { "type": "number", "format": "double" } }, "interfaceName": { "type": "string" } }, "additionalProperties": false }, "BaremetalBandwidthHistoryListServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BaremetalBandwidthHistory" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "BaremetalBandwidthInterfaceStatsView": { "required": [ "interfaceId", "interfaceName", "points" ], "type": "object", "properties": { "interfaceId": { "type": "string", "format": "uuid" }, "interfaceName": { "type": "string" }, "points": { "type": "array", "items": { "$ref": "#/components/schemas/BaremetalBandwidthPointView" } } }, "additionalProperties": false }, "BaremetalBandwidthPointView": { "required": [ "egressBps", "ingressBps", "timestamp" ], "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "ingressBps": { "type": "integer", "format": "int64", "nullable": true }, "egressBps": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "BaremetalBandwidthStatsView": { "required": [ "end", "interfaces", "start", "stepSeconds", "total" ], "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "stepSeconds": { "type": "integer", "format": "int32" }, "total": { "$ref": "#/components/schemas/BaremetalBandwidthTotalStatsView" }, "interfaces": { "type": "array", "items": { "$ref": "#/components/schemas/BaremetalBandwidthInterfaceStatsView" } } }, "additionalProperties": false }, "BaremetalBandwidthStatsViewServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/BaremetalBandwidthStatsView" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "BaremetalBandwidthTotalStatsView": { "required": [ "points" ], "type": "object", "properties": { "points": { "type": "array", "items": { "$ref": "#/components/schemas/BaremetalBandwidthPointView" } } }, "additionalProperties": false }, "BaremetalBandwidthUsageView": { "required": [ "allowanceBytes", "daily", "egressBytes", "ingressBytes", "periodEnd", "periodStart" ], "type": "object", "properties": { "periodStart": { "type": "string", "format": "date-time" }, "periodEnd": { "type": "string", "format": "date-time" }, "egressBytes": { "type": "integer", "format": "int64", "nullable": true }, "ingressBytes": { "type": "integer", "format": "int64", "nullable": true }, "allowanceBytes": { "type": "integer", "format": "int64", "nullable": true }, "daily": { "type": "array", "items": { "$ref": "#/components/schemas/BaremetalBandwidthDailyUsageView" } } }, "additionalProperties": false }, "BaremetalBandwidthUsageViewServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/BaremetalBandwidthUsageView" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "BaremetalBandwidthView": { "type": "object", "properties": { "monthlyAllowanceGb": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BaremetalDrive": { "required": [ "serial" ], "type": "object", "properties": { "model": { "type": "string", "nullable": true }, "sizeBytes": { "type": "integer", "format": "int64" }, "serial": { "type": "string" }, "type": { "$ref": "#/components/schemas/DiskType" } }, "additionalProperties": false }, "BaremetalHardwareCapability": { "enum": [ "KVM", "VIRTUAL_MEDIA" ], "type": "string" }, "BaremetalHardwareView": { "type": "object", "properties": { "assetId": { "type": "string", "nullable": true }, "cpuManufacturer": { "$ref": "#/components/schemas/BaremetalManufacturer" }, "cpuModel": { "type": "string", "nullable": true }, "cpuCores": { "type": "integer", "format": "int32" }, "cpuClockSpeed": { "type": "number", "format": "float" }, "memoryGb": { "type": "integer", "format": "int32" }, "drives": { "type": "array", "items": { "$ref": "#/components/schemas/BaremetalDrive" } }, "capabilities": { "type": "array", "items": { "$ref": "#/components/schemas/BaremetalHardwareCapability" } } }, "additionalProperties": false }, "BaremetalImageDto": { "required": [ "compatibilityLayer", "defaultUser", "iconReference", "imageUrl", "name", "operatingSystemSlug", "platform" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "imageUrl": { "type": "string" }, "operatingSystemSlug": { "type": "string" }, "platform": { "$ref": "#/components/schemas/BaremetalImagePlatform" }, "compatibilityLayer": { "type": "string" }, "iconReference": { "type": "string" }, "defaultUser": { "type": "string" }, "raidVariants": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "BaremetalImageDtoIReadOnlyListServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BaremetalImageDto" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "BaremetalImagePlatform": { "enum": [ "LINUX", "WINDOWS" ], "type": "string" }, "BaremetalIsoFileView": { "required": [ "displayName", "fileName" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "fileName": { "type": "string" }, "displayName": { "type": "string" }, "sizeBytes": { "type": "integer", "format": "int64" }, "ready": { "type": "boolean" }, "uploadDate": { "type": "string", "format": "date-time", "nullable": true }, "mounted": { "type": "boolean", "readOnly": true }, "mountExpiry": { "type": "string", "format": "date-time", "nullable": true }, "deviceIndex": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "BaremetalIsoFileViewIEnumerableServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BaremetalIsoFileView" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "BaremetalIsoFileViewServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/BaremetalIsoFileView" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "BaremetalManufacturer": { "enum": [ "INTEL", "AMD" ], "type": "string" }, "BaremetalNetworkCapabilityView": { "type": "object", "properties": { "serviceId": { "type": "string", "format": "uuid" }, "availableInterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/AvailableBaremetalInterfaceTopology" } }, "availableBondingGroups": { "type": "array", "items": { "$ref": "#/components/schemas/AvailableBaremetalBondTopology" } } }, "additionalProperties": false }, "BaremetalNetworkCapabilityViewServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/BaremetalNetworkCapabilityView" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "BaremetalNodeInterfaceOnlyDto": { "required": [ "macAddress", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "macAddress": { "type": "string" }, "interfaceSpeed": { "type": "integer", "format": "int32" }, "segmentId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "BaremetalNodeLogicalInterfaceView": { "type": "object", "properties": { "logicalInterfaceId": { "type": "string", "format": "uuid" }, "physicalInterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/BaremetalNodeInterfaceOnlyDto" } }, "virtualNetworks": { "type": "array", "items": { "$ref": "#/components/schemas/SpnAssignmentWithAddressesByPrefixView" }, "nullable": true } }, "additionalProperties": false }, "BaremetalOfferingDriveDto": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/DiskType" }, "sizeBytes": { "type": "integer", "format": "int64" }, "sizeGb": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "BaremetalOfferingInterfaceDto": { "type": "object", "properties": { "interfaceSpeed": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BaremetalOfferingWithAvailabilityDto": { "required": [ "name", "pricing", "specs" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "specs": { "$ref": "#/components/schemas/BaremetalSpecsDto" }, "pricing": { "$ref": "#/components/schemas/PricingDto" }, "availability": { "type": "array", "items": { "$ref": "#/components/schemas/OfferingLocationAvailability" } } }, "additionalProperties": false }, "BaremetalOfferingWithAvailabilityDtoIEnumerableServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BaremetalOfferingWithAvailabilityDto" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "BaremetalOfferingWithAvailabilityDtoServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/BaremetalOfferingWithAvailabilityDto" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "BaremetalOperationDetailView": { "required": [ "state", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "$ref": "#/components/schemas/BaremetalOperationType" }, "progress": { "type": "integer", "format": "int32" }, "startedAt": { "type": "string", "format": "date-time" }, "lastProgressAt": { "type": "string", "format": "date-time" }, "lastProgressMessage": { "type": "string", "nullable": true }, "state": { "$ref": "#/components/schemas/BaremetalOperationState" }, "endedAt": { "type": "string", "format": "date-time", "nullable": true }, "failureCategory": { "type": "string", "nullable": true }, "updates": { "type": "array", "items": { "$ref": "#/components/schemas/BaremetalOperationUpdateView" } }, "details": { "$ref": "#/components/schemas/BaremetalOperationDetails" } }, "additionalProperties": false }, "BaremetalOperationDetailViewServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/BaremetalOperationDetailView" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "BaremetalOperationDetails": { "type": "object", "additionalProperties": false }, "BaremetalOperationHistoryView": { "required": [ "state", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "$ref": "#/components/schemas/BaremetalOperationType" }, "progress": { "type": "integer", "format": "int32" }, "startedAt": { "type": "string", "format": "date-time" }, "lastProgressAt": { "type": "string", "format": "date-time" }, "lastProgressMessage": { "type": "string", "nullable": true }, "state": { "$ref": "#/components/schemas/BaremetalOperationState" }, "endedAt": { "type": "string", "format": "date-time", "nullable": true }, "failureCategory": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BaremetalOperationHistoryViewIEnumerableServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BaremetalOperationHistoryView" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "BaremetalOperationState": { "enum": [ "CREATED", "PRECONFIGURATION", "WAITING_FOR_PXE_BOOT", "CHECKED_IN", "IN_PROGRESS", "REBOOTING", "COMPLETED", "FAILED", "CANCELLED" ], "type": "string" }, "BaremetalOperationType": { "enum": [ "DEPLOYMENT", "WIPE", "TEST" ], "type": "string" }, "BaremetalOperationUpdateView": { "required": [ "at", "id", "message", "progress" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "at": { "type": "string", "format": "date-time" }, "progress": { "type": "integer", "format": "int32" }, "message": { "type": "string" } }, "additionalProperties": false }, "BaremetalOperationView": { "required": [ "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "$ref": "#/components/schemas/BaremetalOperationType" }, "progress": { "type": "integer", "format": "int32" }, "startedAt": { "type": "string", "format": "date-time" }, "lastProgressAt": { "type": "string", "format": "date-time" }, "lastProgressMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BaremetalOperationViewServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/BaremetalOperationView" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "BaremetalServiceDeployRequest": { "type": "object", "properties": { "operatingSystemId": { "type": "string", "format": "uuid", "nullable": true }, "username": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "sshKeyIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "raidVariant": { "$ref": "#/components/schemas/RaidVariant" }, "applicationId": { "type": "string", "format": "uuid", "nullable": true }, "applicationMetadata": { "type": "string", "nullable": true }, "cloudInit": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BaremetalServiceDetailedViewModel": { "required": [ "bandwidth", "hardware", "region" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "locked": { "type": "boolean" }, "suspended": { "type": "boolean" }, "state": { "$ref": "#/components/schemas/ServiceState" }, "primaryIpv4": { "type": "string", "nullable": true }, "primaryIpv6": { "type": "string", "nullable": true }, "bandwidth": { "$ref": "#/components/schemas/BaremetalBandwidthView" }, "region": { "$ref": "#/components/schemas/RegionView" }, "hardware": { "$ref": "#/components/schemas/BaremetalHardwareView" }, "interfaces": { "type": "array", "items": { "$ref": "#/components/schemas/BaremetalNodeLogicalInterfaceView" } }, "operatingSystem": { "$ref": "#/components/schemas/OperatingSystemView" }, "operation": { "$ref": "#/components/schemas/BaremetalOperationView" }, "bootMode": { "$ref": "#/components/schemas/BootMode" }, "lastOperation": { "$ref": "#/components/schemas/BaremetalOperationHistoryView" } }, "additionalProperties": false }, "BaremetalServiceDetailedViewModelServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/BaremetalServiceDetailedViewModel" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "BaremetalServiceListedViewModel": { "required": [ "bandwidth", "hardware", "region" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "locked": { "type": "boolean" }, "suspended": { "type": "boolean" }, "primaryIpv4": { "type": "string", "nullable": true }, "primaryIpv6": { "type": "string", "nullable": true }, "bandwidth": { "$ref": "#/components/schemas/BaremetalBandwidthView" }, "region": { "$ref": "#/components/schemas/RegionView" }, "hardware": { "$ref": "#/components/schemas/BaremetalHardwareView" }, "operatingSystem": { "$ref": "#/components/schemas/OperatingSystemView" }, "bootMode": { "$ref": "#/components/schemas/BootMode" } }, "additionalProperties": false }, "BaremetalServiceListedViewModelIEnumerableServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BaremetalServiceListedViewModel" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "BaremetalServiceStatusView": { "type": "object", "properties": { "state": { "$ref": "#/components/schemas/ServiceState" }, "powerState": { "$ref": "#/components/schemas/BmcPowerState" }, "operation": { "$ref": "#/components/schemas/BaremetalOperationView" }, "lastOperation": { "$ref": "#/components/schemas/BaremetalOperationHistoryView" }, "networkChange": { "$ref": "#/components/schemas/NetworkChangeStatusView" } }, "additionalProperties": false }, "BaremetalServiceStatusViewServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/BaremetalServiceStatusView" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "BaremetalServiceTestRequest": { "required": [ "runCpu", "runDisk", "runMemory", "runSmart" ], "type": "object", "properties": { "runCpu": { "type": "boolean" }, "runMemory": { "type": "boolean" }, "runDisk": { "type": "boolean" }, "runSmart": { "type": "boolean" }, "cpuDurationSec": { "type": "integer", "format": "int32", "nullable": true }, "memoryDurationSec": { "type": "integer", "format": "int32", "nullable": true }, "diskDurationSec": { "type": "integer", "format": "int32", "nullable": true }, "cpuWorkers": { "type": "integer", "format": "int32", "nullable": true }, "memoryPercent": { "type": "integer", "format": "int32", "nullable": true }, "diskBlockSize": { "type": "string", "nullable": true }, "diskIoDepth": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "BaremetalSpecsDto": { "type": "object", "properties": { "cpu": { "type": "string" }, "cpuManufacturer": { "$ref": "#/components/schemas/BaremetalManufacturer" }, "cpuSockets": { "type": "integer", "format": "int32" }, "cpuCores": { "type": "integer", "format": "int32" }, "cpuBaseClockMhz": { "type": "integer", "format": "int32" }, "cpuBoostClockMhz": { "type": "integer", "format": "int32" }, "memory": { "type": "integer", "format": "int32" }, "memoryType": { "$ref": "#/components/schemas/MemoryType" }, "drives": { "type": "array", "items": { "$ref": "#/components/schemas/BaremetalOfferingDriveDto" } }, "interfaces": { "type": "array", "items": { "$ref": "#/components/schemas/BaremetalOfferingInterfaceDto" } }, "egressGb": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BaremetalVmMount": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "nodeId": { "type": "string", "format": "uuid" }, "deviceIndex": { "type": "integer", "format": "int32" }, "isoFileId": { "type": "string", "format": "uuid" }, "shareId": { "type": "string", "format": "uuid" }, "expiry": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "BaremetalVmMountIEnumerableServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BaremetalVmMount" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "BillingAddress": { "required": [ "address1", "city", "countryCode", "postalCode", "region" ], "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string", "nullable": true }, "city": { "type": "string" }, "region": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string", "format": "ISO3166-1 alpha-2" } }, "additionalProperties": false }, "BillingAddressUpdateRequest": { "required": [ "address1", "city", "countryCode", "postalCode", "region" ], "type": "object", "properties": { "address1": { "minLength": 1, "type": "string" }, "address2": { "type": "string", "nullable": true }, "city": { "minLength": 1, "type": "string" }, "region": { "minLength": 1, "type": "string" }, "postalCode": { "minLength": 1, "type": "string" }, "countryCode": { "minLength": 1, "type": "string", "format": "ISO3166-1 alpha-2" } }, "additionalProperties": false }, "BillingContact": { "type": "object", "properties": { "emailAddress": { "type": "string", "format": "email", "nullable": true }, "phoneNumber": { "type": "string", "format": "tel", "nullable": true } }, "additionalProperties": false }, "BillingContactUpdateRequest": { "type": "object", "properties": { "emailAddress": { "type": "string", "format": "email", "nullable": true }, "phoneNumber": { "type": "string", "format": "tel", "nullable": true } }, "additionalProperties": false }, "BillingCycle": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/EBillingCycle" }, "isUsageBased": { "type": "boolean", "readOnly": true }, "isReservationBased": { "type": "boolean", "readOnly": true }, "months": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "BmcPowerCommand": { "enum": [ "ON", "FORCE_OFF", "GRACEFUL_SHUTDOWN", "FORCE_RESTART", "GRACEFUL_RESTART" ], "type": "string" }, "BmcPowerState": { "enum": [ "ON", "OFF", "UNKNOWN", "PENDING", "BMC_RESETTING" ], "type": "string" }, "BmcPowerStateServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/BmcPowerState" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "BooleanServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "boolean" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "BootMode": { "enum": [ "LOCAL_DISK", "PXE" ], "type": "string" }, "Category": { "enum": [ "OTHER", "GENERAL", "BILLING", "TECHNICAL", "SALES", "FEATURE_REQUEST" ], "type": "string" }, "Cents": { "type": "object", "properties": { "value": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ClientAcceptOwnershipTransferRequest": { "required": [ "transferCode" ], "type": "object", "properties": { "transferCode": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ClientCreateFirewallGroupRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 50, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "ClientCreateOrganizationRequest": { "required": [ "billingAddress", "currency", "name" ], "type": "object", "properties": { "name": { "maxLength": 50, "minLength": 2, "type": "string" }, "currency": { "type": "string", "format": "ISO-4217" }, "billingAddress": { "$ref": "#/components/schemas/BillingAddress" } }, "additionalProperties": false }, "ClientCreateSpnRequest": { "required": [ "name" ], "type": "object", "properties": { "localVlanId": { "maximum": 4094, "minimum": 11, "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/SpnType" }, "name": { "type": "string" } }, "additionalProperties": false }, "ClientGetOwnUserDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phoneNumber": { "type": "string", "nullable": true }, "isAdmin": { "type": "boolean" }, "twoFactorEnabled": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "lastLoginIP": { "type": "string", "nullable": true }, "lastLoginDate": { "type": "string", "format": "date-time", "nullable": true }, "passwordLastChangedAt": { "type": "string", "format": "date-time", "nullable": true }, "twoFactorEnabledAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ClientGetOwnUserDtoServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/ClientGetOwnUserDto" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "ClientGetUserOnlyDto": { "type": "object", "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "twoFactorEnabled": { "type": "boolean" } }, "additionalProperties": false }, "ClientGetUserWithNameOnly": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" } }, "additionalProperties": false }, "ClientKvmSessionDetails": { "required": [ "url" ], "type": "object", "properties": { "url": { "type": "string" }, "ipmiUsername": { "type": "string", "nullable": true }, "ipmiPassword": { "type": "string", "nullable": true }, "forwardId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "ClientKvmSessionDetailsServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/ClientKvmSessionDetails" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "ClientKvmSessionRequest": { "required": [ "clientIpAddress", "timeoutHours" ], "type": "object", "properties": { "clientIpAddress": { "type": "string" }, "timeoutHours": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ClientOrgCancelInviteRequest": { "required": [ "emailAddress" ], "type": "object", "properties": { "emailAddress": { "type": "string", "format": "email" } }, "additionalProperties": false }, "ClientOrgInviteRequest": { "required": [ "emailAddress" ], "type": "object", "properties": { "emailAddress": { "type": "string", "format": "email" }, "roleId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ClientSendOwnershipTransferRequest": { "required": [ "emailAddress" ], "type": "object", "properties": { "emailAddress": { "type": "string", "format": "email" } }, "additionalProperties": false }, "ClientSubmitSupportTicket": { "required": [ "body", "category", "priority", "subject" ], "type": "object", "properties": { "subject": { "type": "string" }, "body": { "type": "string" }, "priority": { "$ref": "#/components/schemas/Priority" }, "category": { "$ref": "#/components/schemas/Category" }, "serviceId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "ClientUpdateBaremetalServiceDto": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 64, "minLength": 2, "type": "string" } }, "additionalProperties": false }, "ClientUpdateFirewallGroupRequest": { "type": "object", "properties": { "name": { "maxLength": 50, "type": "string", "nullable": true }, "ruleOrder": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "ClientUpdateOrganizationRequest": { "type": "object", "properties": { "name": { "maxLength": 50, "minLength": 2, "type": "string", "nullable": true }, "vatNumber": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/BillingAddressUpdateRequest" }, "contact": { "$ref": "#/components/schemas/BillingContactUpdateRequest" } }, "additionalProperties": false }, "ClientUpdateOwnUserDto": { "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string", "format": "email", "nullable": true }, "phoneNumber": { "type": "string", "format": "tel", "nullable": true } }, "additionalProperties": false }, "ClientUpdateSpnRequest": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": false }, "ConvergenceHealthView": { "required": [ "consecutiveFailures" ], "type": "object", "properties": { "consecutiveFailures": { "type": "integer", "format": "int32" }, "failureCategory": { "type": "string", "nullable": true }, "nextAttemptAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "CountryDto": { "required": [ "code", "name" ], "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false }, "CountryDtoIReadOnlyListServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CountryDto" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "CreateBaremetalSegmentRequest": { "type": "object", "properties": { "interfaceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false }, "CreateFirewallRuleRequest": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/FirewallRuleType" }, "direction": { "$ref": "#/components/schemas/FirewallRuleDirection" }, "protocol": { "$ref": "#/components/schemas/FirewallProtocol" }, "sourcePortStart": { "maximum": 65535, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "sourcePortEnd": { "maximum": 65535, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "sourceAddress": { "type": "string", "nullable": true }, "destPortStart": { "maximum": 65535, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "destPortEnd": { "maximum": 65535, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "rateLimitPps": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "packetCriteria": { "$ref": "#/components/schemas/FirewallPacketCriteriaDto" }, "description": { "maxLength": 100, "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateHourlyBaremetalRequest": { "required": [ "datacenterId", "offeringId" ], "type": "object", "properties": { "offeringId": { "type": "string", "format": "uuid" }, "datacenterId": { "type": "string", "format": "uuid" }, "ipv4PrefixLength": { "maximum": 30, "minimum": 24, "type": "integer", "format": "int32", "nullable": true }, "ipv6PrefixLength": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CreateHourlyIpBlockRequest": { "required": [ "datacenterId", "offeringId", "publicNetworkId" ], "type": "object", "properties": { "offeringId": { "type": "string", "format": "uuid" }, "datacenterId": { "type": "string", "format": "uuid" }, "publicNetworkId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "CreateIpBlockResponse": { "type": "object", "properties": { "prefixId": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CreateIpBlockResponseServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/CreateIpBlockResponse" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "CreateIsoFileRequest": { "required": [ "displayName", "sizeBytes" ], "type": "object", "properties": { "displayName": { "maxLength": 64, "minLength": 3, "type": "string" }, "sizeBytes": { "maximum": 21474836480, "minimum": 1, "type": "integer", "format": "int64" } }, "additionalProperties": false }, "CreateIsoFileResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "displayName": { "type": "string" }, "sizeBytes": { "type": "integer", "format": "int64" }, "totalParts": { "type": "integer", "format": "int32" }, "uploadUrls": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "CreateIsoFileResponseServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/CreateIsoFileResponse" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "CreateOrderResponse": { "required": [ "order" ], "type": "object", "properties": { "order": { "$ref": "#/components/schemas/Order" }, "invoiceId": { "type": "string", "format": "uuid", "nullable": true }, "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } }, "provisionedItems": { "type": "array", "items": { "$ref": "#/components/schemas/ProvisionedItemInfo" }, "nullable": true }, "replayed": { "type": "boolean" } }, "additionalProperties": false }, "CreateOrderResponseServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/CreateOrderResponse" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "CreateOrganizationApiKeyRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "networks": { "type": "array", "items": { "type": "string" }, "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "CreditCardMeta": { "required": [ "brand", "last4" ], "type": "object", "properties": { "last4": { "type": "string" }, "brand": { "type": "string" }, "expMonth": { "type": "integer", "format": "int64" }, "expYear": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "CreditPurchaseRequest": { "type": "object", "properties": { "amount": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Currency": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "format": "ISO-4217" }, "conversionRate": { "type": "number", "format": "double", "readOnly": true } }, "additionalProperties": false }, "CurrencyClientView": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "conversionRate": { "type": "number", "format": "double" } }, "additionalProperties": false }, "CurrencyClientViewIEnumerableServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyClientView" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "DatacenterMinimalDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "country": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "facility": { "type": "string" } }, "additionalProperties": false }, "DatacenterMinimalDtoIEnumerableServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DatacenterMinimalDto" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "DiskType": { "enum": [ "UNKNOWN", "NVME", "SSD", "HDD" ], "type": "string" }, "EBillingCycle": { "enum": [ "HOURLY", "MONTHLY", "QUARTERLY", "SEMI_ANNUALLY", "ANNUALLY" ], "type": "string" }, "EInvoiceType": { "enum": [ "STANDARD", "CREDIT_PURCHASE" ], "type": "string" }, "EOrderItemStatus": { "enum": [ "PENDING", "PROVISIONING", "COMPLETED", "FAILED", "CANCELLED" ], "type": "string" }, "EOrderItemType": { "enum": [ "BAREMETAL", "CLOUD", "IP_BLOCK" ], "type": "string" }, "EPaymentMethodKind": { "enum": [ "CARD", "WALLET" ], "type": "string" }, "EPaymentProviderType": { "enum": [ "STRIPE", "MANUAL", "ACCOUNT_CREDIT" ], "type": "string" }, "ESubscriptionItemType": { "enum": [ "BAREMETAL", "CLOUD", "IP_BLOCK" ], "type": "string" }, "ESubscriptionStatus": { "enum": [ "ACTIVE", "CANCELLATION_REQUESTED", "CANCELED" ], "type": "string" }, "ETransactionStatus": { "enum": [ "PENDING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" }, "Fan": { "type": "object", "properties": { "memberId": { "type": "string", "nullable": true }, "fanName": { "type": "string", "nullable": true }, "physicalContext": { "type": "string", "nullable": true }, "reading": { "type": "integer", "format": "int32", "nullable": true }, "readingUnits": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/Status" } }, "additionalProperties": false }, "FirewallGroupDetailDto": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "organizationId": { "type": "string", "format": "uuid" }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/FirewallRuleDto" } }, "assignedIpAddressIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false }, "FirewallGroupDetailDtoServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/FirewallGroupDetailDto" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "FirewallGroupDto": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "organizationId": { "type": "string", "format": "uuid" }, "ruleCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FirewallGroupDtoListServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FirewallGroupDto" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "FirewallGroupDtoServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/FirewallGroupDto" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "FirewallPacketCriteriaDto": { "type": "object", "properties": { "maxPacketLength": { "maximum": 9000, "minimum": 64, "type": "integer", "format": "int32", "nullable": true }, "minPacketLength": { "maximum": 9000, "minimum": 64, "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "FirewallProtocol": { "enum": [ "ANY", "TCP", "UDP", "ICMP", "ICMP_V6", "GRE" ], "type": "string" }, "FirewallRuleDirection": { "enum": [ "INBOUND", "OUTBOUND" ], "type": "string" }, "FirewallRuleDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "firewallGroupId": { "type": "string", "format": "uuid" }, "priority": { "type": "integer", "format": "int32" }, "isEnabled": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/FirewallRuleType" }, "direction": { "$ref": "#/components/schemas/FirewallRuleDirection" }, "protocol": { "$ref": "#/components/schemas/FirewallProtocol" }, "sourcePortStart": { "type": "integer", "format": "int32", "nullable": true }, "sourcePortEnd": { "type": "integer", "format": "int32", "nullable": true }, "sourceAddress": { "type": "string", "nullable": true }, "destPortStart": { "type": "integer", "format": "int32", "nullable": true }, "destPortEnd": { "type": "integer", "format": "int32", "nullable": true }, "rateLimitPps": { "type": "integer", "format": "int32", "nullable": true }, "packetCriteria": { "$ref": "#/components/schemas/FirewallPacketCriteriaDto" }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FirewallRuleDtoListServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FirewallRuleDto" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "FirewallRuleDtoServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/FirewallRuleDto" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "FirewallRuleType": { "enum": [ "ALLOW", "BLOCK", "RATE_LIMIT" ], "type": "string" }, "GetIpAssignmentDto": { "type": "object", "properties": { "spnAssignmentId": { "type": "string", "format": "uuid" }, "ipAddressEntityId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "GetIpAssignmentDtoServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/GetIpAssignmentDto" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "GuidIEnumerableServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "GuidIdentityRole": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "normalizedName": { "type": "string", "nullable": true }, "concurrencyStamp": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IOrderItemDetails": { "type": "object", "additionalProperties": false }, "IPAddress": { "type": "object", "properties": { "addressFamily": { "$ref": "#/components/schemas/AddressFamily" }, "scopeId": { "type": "integer", "format": "int64" }, "isIPv6Multicast": { "type": "boolean", "readOnly": true }, "isIPv6LinkLocal": { "type": "boolean", "readOnly": true }, "isIPv6SiteLocal": { "type": "boolean", "readOnly": true }, "isIPv6Teredo": { "type": "boolean", "readOnly": true }, "isIPv6UniqueLocal": { "type": "boolean", "readOnly": true }, "isIPv4MappedToIPv6": { "type": "boolean", "readOnly": true }, "address": { "type": "integer", "format": "int64", "deprecated": true } }, "additionalProperties": false }, "IPAddressBaseWithServiceMetaDto": { "required": [ "address" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "address": { "$ref": "#/components/schemas/IPAddress" }, "rDNS": { "type": "string", "nullable": true }, "state": { "$ref": "#/components/schemas/IpAddressState" }, "serviceAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceBaseMetaView" } } }, "additionalProperties": false }, "IPNetwork": { "type": "object", "properties": { "baseAddress": { "$ref": "#/components/schemas/IPAddress" }, "prefixLength": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "IPv4AddressEntityDto": { "required": [ "address" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "address": { "$ref": "#/components/schemas/IPAddress" }, "state": { "$ref": "#/components/schemas/IpAddressState" } }, "additionalProperties": false }, "IPv4ChildPrefixDto": { "required": [ "datacenter" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "datacenter": { "$ref": "#/components/schemas/DatacenterMinimalDto" }, "network": { "$ref": "#/components/schemas/IPNetwork" }, "createdAt": { "type": "string", "format": "date-time" }, "gatewayId": { "type": "string", "format": "uuid", "nullable": true }, "gateway": { "$ref": "#/components/schemas/IPv4AddressEntityDto" }, "spnId": { "type": "string", "format": "uuid", "nullable": true }, "spn": { "$ref": "#/components/schemas/SpnMetaOnlyDto" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/IPv4AddressEntityDto" } }, "availableAddressCount": { "type": "integer", "format": "int32", "nullable": true }, "availableAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "IPv6AddressEntityDto": { "required": [ "address" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "address": { "$ref": "#/components/schemas/IPAddress" }, "state": { "$ref": "#/components/schemas/IpAddressState" } }, "additionalProperties": false }, "IPv6ChildPrefixDto": { "required": [ "datacenter" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "datacenter": { "$ref": "#/components/schemas/DatacenterMinimalDto" }, "network": { "$ref": "#/components/schemas/IPNetwork" }, "createdAt": { "type": "string", "format": "date-time" }, "gatewayId": { "type": "string", "format": "uuid", "nullable": true }, "gateway": { "$ref": "#/components/schemas/IPv6AddressEntityDto" }, "spnId": { "type": "string", "format": "uuid", "nullable": true }, "spn": { "$ref": "#/components/schemas/SpnMetaOnlyDto" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/IPv6AddressEntityDto" } } }, "additionalProperties": false }, "ISubscriptionItemDetails": { "type": "object", "additionalProperties": false }, "InvoiceBilledFrom": { "required": [ "address1", "city", "companyName", "countryCode", "postalCode", "region" ], "type": "object", "properties": { "companyName": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string", "nullable": true }, "city": { "type": "string" }, "region": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "vatNumber": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InvoiceBilledTo": { "required": [ "address1", "city", "countryCode", "organizationName", "postalCode", "region" ], "type": "object", "properties": { "organizationName": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string", "nullable": true }, "city": { "type": "string" }, "region": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "vatNumber": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InvoiceClientView": { "required": [ "billedFrom", "billedTo" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "status": { "$ref": "#/components/schemas/InvoiceStatus" }, "type": { "$ref": "#/components/schemas/EInvoiceType" }, "currency": { "type": "string" }, "invoiceNumber": { "type": "integer", "format": "int32" }, "orderId": { "type": "string", "format": "uuid", "nullable": true }, "billedFrom": { "$ref": "#/components/schemas/InvoiceBilledFrom" }, "billedTo": { "$ref": "#/components/schemas/InvoiceBilledTo" }, "taxBreakdown": { "type": "array", "items": { "$ref": "#/components/schemas/TaxBreakdownView" } }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceItemClientView" } }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceTransactionClientView" } }, "subtotal": { "type": "integer", "format": "int64" }, "discount": { "type": "integer", "format": "int64" }, "taxes": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" }, "amountDue": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "InvoiceClientViewIEnumerableServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceClientView" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "InvoiceClientViewServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/InvoiceClientView" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "InvoiceItemClientView": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "subscriptionId": { "type": "string", "format": "uuid", "nullable": true }, "startTime": { "type": "string", "format": "date-time", "nullable": true }, "endTime": { "type": "string", "format": "date-time", "nullable": true }, "subtotal": { "type": "integer", "format": "int64" }, "discount": { "type": "integer", "format": "int64" }, "taxTreatment": { "$ref": "#/components/schemas/TaxTreatment" }, "taxRate": { "type": "number", "format": "double" }, "taxAmount": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "InvoiceStatus": { "enum": [ "UNPAID", "PARTIAL", "PAID", "OVERDUE", "COLLECTIONS", "CANCELLED", "REFUNDED" ], "type": "string" }, "InvoiceTransactionClientView": { "required": [ "currency", "paymentProvider", "status", "transactionReference" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "transactionReference": { "type": "string" }, "amount": { "type": "integer", "format": "int64" }, "currency": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "paymentProvider": { "type": "string" }, "status": { "type": "string" } }, "additionalProperties": false }, "IpAddressState": { "enum": [ "FREE", "RESERVED", "GATEWAY", "ASSIGNED" ], "type": "string" }, "IpBlockOfferingWithAvailabilityDto": { "required": [ "name", "pricing", "specs" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "specs": { "$ref": "#/components/schemas/IpBlockSpecsDto" }, "pricing": { "$ref": "#/components/schemas/PricingDto" }, "availability": { "type": "array", "items": { "$ref": "#/components/schemas/OfferingLocationAvailability" } } }, "additionalProperties": false }, "IpBlockOfferingWithAvailabilityDtoIEnumerableServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/IpBlockOfferingWithAvailabilityDto" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "IpBlockOfferingWithAvailabilityDtoServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/IpBlockOfferingWithAvailabilityDto" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "IpBlockSpecsDto": { "type": "object", "properties": { "ipVersion": { "$ref": "#/components/schemas/IpVersion" }, "prefixLength": { "type": "integer", "format": "int32" }, "usableAddresses": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "IpChildPrefixSummaryView": { "required": [ "datacenter", "network", "subnetMask" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "datacenter": { "$ref": "#/components/schemas/DatacenterMinimalDto" }, "network": { "type": "string" }, "subnetMask": { "type": "string" }, "gateway": { "type": "string", "nullable": true }, "prefixLength": { "type": "integer", "format": "int32" }, "usedAddressCount": { "type": "integer", "format": "int32" }, "availableAddressCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "IpChildPrefixWithAddressUsageView": { "required": [ "datacenter" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "gatewayId": { "type": "string", "format": "uuid", "nullable": true }, "datacenter": { "$ref": "#/components/schemas/DatacenterMinimalDto" }, "network": { "type": "string" }, "gateway": { "type": "string", "nullable": true }, "subnetMask": { "type": "string" }, "prefixLength": { "type": "integer", "format": "int32" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/IPAddressBaseWithServiceMetaDto" } }, "availableAddressCount": { "type": "integer", "format": "int32", "nullable": true }, "availableAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "IpChildPrefixWithAddressUsageViewServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/IpChildPrefixWithAddressUsageView" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "IpChildPrefixWithAddressesView": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "network": { "type": "string" }, "gateway": { "type": "string", "nullable": true }, "subnetMask": { "type": "string", "nullable": true }, "prefixLength": { "type": "integer", "format": "int32" }, "addresses": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "IpVersion": { "enum": [ "V4", "V6" ], "type": "string" }, "IpxeScriptResponse": { "type": "object", "properties": { "script": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IpxeScriptResponseServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/IpxeScriptResponse" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "IsoFileDto": { "required": [ "displayName", "fileName" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "fileName": { "type": "string" }, "displayName": { "type": "string" }, "sizeBytes": { "type": "integer", "format": "int64" }, "ready": { "type": "boolean" }, "uploadDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "IsoFileDtoIEnumerableServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/IsoFileDto" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "KvmSession": { "required": [ "clientIpAddress", "sessionUrl" ], "type": "object", "properties": { "nodeId": { "type": "string", "format": "uuid" }, "forwardId": { "type": "string", "format": "uuid" }, "clientIpAddress": { "type": "string" }, "sessionUrl": { "type": "string" }, "startTime": { "type": "string", "format": "date-time" }, "timeoutHours": { "type": "integer", "format": "int32" }, "userId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "KvmSessionListServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/KvmSession" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "MemoryType": { "enum": [ "DDR3", "DDR4", "DDR5" ], "type": "string" }, "Millicents": { "type": "object", "properties": { "value": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "MountVirtualMediaRequest": { "type": "object", "properties": { "fileId": { "type": "string", "format": "uuid" }, "expirySeconds": { "type": "integer", "format": "int32" }, "bootOnce": { "type": "boolean" } }, "additionalProperties": false }, "NetworkChangeStatusView": { "required": [ "since", "status" ], "type": "object", "properties": { "status": { "$ref": "#/components/schemas/NetworkChangeViewStatus" }, "since": { "type": "string", "format": "date-time" }, "failureCategory": { "type": "string", "nullable": true }, "degraded": { "$ref": "#/components/schemas/ConvergenceHealthView" } }, "additionalProperties": false }, "NetworkChangeViewStatus": { "enum": [ "APPLYING", "FAILED" ], "type": "string" }, "NotificationContentCategory": { "enum": [ "ACCOUNT", "ORGANIZATION", "SERVICE", "BILLING", "SECURITY", "SUPPORT" ], "type": "string" }, "OfferingLocationAvailability": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "OfferingPriceDto": { "type": "object", "properties": { "priceMillicents": { "type": "integer", "format": "int64" }, "effectiveMonthlyMillicents": { "type": "integer", "format": "int64" }, "termDiscount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "OperatingSystemView": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "slug": { "type": "string", "nullable": true }, "name": { "type": "string" }, "deployedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Order": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "organization": { "$ref": "#/components/schemas/Organization" }, "status": { "$ref": "#/components/schemas/OrderStatus" }, "promoCode": { "type": "string", "nullable": true }, "datePlaced": { "type": "string", "format": "date-time" }, "cycle": { "$ref": "#/components/schemas/BillingCycle" }, "idempotencyKey": { "type": "string", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItemBase" }, "readOnly": true }, "subtotal": { "$ref": "#/components/schemas/Millicents" }, "totalDiscount": { "$ref": "#/components/schemas/Millicents" }, "totalTax": { "$ref": "#/components/schemas/Millicents" }, "total": { "$ref": "#/components/schemas/Millicents" }, "amountDue": { "$ref": "#/components/schemas/Millicents" } }, "additionalProperties": false }, "OrderIEnumerableServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Order" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "OrderItemBase": { "required": [ "title" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "orderId": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "status": { "$ref": "#/components/schemas/EOrderItemStatus" }, "type": { "$ref": "#/components/schemas/EOrderItemType" }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "offeringId": { "type": "string", "format": "uuid" }, "provisionedId": { "type": "string", "format": "uuid", "nullable": true }, "baseRate": { "$ref": "#/components/schemas/Millicents" }, "taxRate": { "type": "number", "format": "double" }, "discountRate": { "type": "number", "format": "double" }, "details": { "$ref": "#/components/schemas/IOrderItemDetails" } }, "additionalProperties": false }, "OrderRequest": { "required": [ "services" ], "type": "object", "properties": { "services": { "type": "array", "items": { "$ref": "#/components/schemas/OrderRequestItemBase" } }, "cycle": { "$ref": "#/components/schemas/EBillingCycle" }, "promoCode": { "type": "string" } }, "additionalProperties": false }, "OrderRequestItemBase": { "type": "object", "properties": { "offeringId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "OrderServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/Order" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "OrderStatus": { "enum": [ "UNPAID", "PENDING", "PROCESSING", "COMPLETE", "CANCELLED" ], "type": "string" }, "OrgSshKeyDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "publicKey": { "type": "string" }, "keyType": { "$ref": "#/components/schemas/SshKeyType" }, "createdAt": { "type": "string", "format": "date-time" }, "owner": { "$ref": "#/components/schemas/ClientGetUserWithNameOnly" }, "ownerId": { "type": "string" }, "organizationId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "OrgSshKeyDtoIEnumerableServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrgSshKeyDto" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "OrgSshKeyDtoServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/OrgSshKeyDto" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "Organization": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "billedByEntity": { "type": "string", "format": "uuid" }, "currency": { "$ref": "#/components/schemas/Currency" }, "currencyId": { "type": "string", "format": "uuid" }, "vatNumber": { "type": "string", "nullable": true }, "creditBalance": { "$ref": "#/components/schemas/Cents" }, "billingAddress": { "$ref": "#/components/schemas/BillingAddress" }, "billingContact": { "$ref": "#/components/schemas/BillingContact" }, "paymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationPaymentMethod" }, "nullable": true }, "stripeCustomerId": { "type": "string", "nullable": true }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationMember" } }, "invites": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationInvite" } }, "customRoles": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationRole" }, "nullable": true }, "ownershipTransfer": { "$ref": "#/components/schemas/OwnershipTransfer" }, "roleHierarchy": { "$ref": "#/components/schemas/OrganizationRoleHierarchy" } }, "additionalProperties": false }, "OrganizationApiKeyDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "allowedIpAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "keyPrefix": { "type": "string" }, "lastUsedAt": { "type": "string", "format": "date-time", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "OrganizationApiKeyDtoIEnumerableServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationApiKeyDto" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "OrganizationApiKeyDtoServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/OrganizationApiKeyDto" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "OrganizationDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationMemberOnlyDto" }, "nullable": true }, "currency": { "type": "string", "nullable": true }, "vatNumber": { "type": "string", "nullable": true }, "billingAddress": { "$ref": "#/components/schemas/BillingAddress" }, "billingContact": { "$ref": "#/components/schemas/BillingContact" }, "paymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationPaymentMethodClientDto" } } }, "additionalProperties": false }, "OrganizationDtoServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/OrganizationDto" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "OrganizationInvite": { "required": [ "invitedEmail" ], "type": "object", "properties": { "invitationTime": { "type": "string", "format": "date-time" }, "invitedEmail": { "type": "string" }, "invitedRoleId": { "type": "string", "format": "uuid" }, "inviteCode": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "OrganizationInviteDto": { "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "invitationTime": { "type": "string", "format": "date-time" }, "invitedEmail": { "type": "string" }, "invitedRoleId": { "type": "string", "format": "uuid", "nullable": true }, "invitedRole": { "$ref": "#/components/schemas/OrganizationRoleMetaDto" }, "inviteCode": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "OrganizationInviteDtoListServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationInviteDto" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "OrganizationInviteValidationResponse": { "type": "object", "properties": { "orgName": { "type": "string" }, "emailAddress": { "type": "string" }, "inviteExpiry": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "OrganizationInviteValidationResponseServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/OrganizationInviteValidationResponse" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "OrganizationMember": { "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "joinedAt": { "type": "string", "format": "date-time" }, "roleId": { "type": "string", "format": "uuid" }, "organization": { "$ref": "#/components/schemas/Organization" }, "user": { "$ref": "#/components/schemas/AppUser" }, "role": { "$ref": "#/components/schemas/OrganizationRole" } }, "additionalProperties": false }, "OrganizationMemberOnlyDto": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "joinedAt": { "type": "string", "format": "date-time" }, "user": { "$ref": "#/components/schemas/ClientGetUserOnlyDto" }, "role": { "$ref": "#/components/schemas/OrganizationRoleMetaDto" }, "roleId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "OrganizationMemberOnlyDtoIEnumerableServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationMemberOnlyDto" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "OrganizationMembershipDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "joinedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "OrganizationMembershipDtoIEnumerableServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationMembershipDto" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "OrganizationMetaDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "currency": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "joinedAt": { "type": "string", "format": "date-time" }, "ownPermissions": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "OrganizationMetaDtoServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/OrganizationMetaDto" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "OrganizationMetaOnlyDto": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false }, "OrganizationPaymentMethod": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "provider": { "$ref": "#/components/schemas/EPaymentProviderType" }, "kind": { "$ref": "#/components/schemas/EPaymentMethodKind" }, "paymentMethodId": { "type": "string", "nullable": true }, "priority": { "type": "integer", "format": "int32" }, "creditCardMeta": { "$ref": "#/components/schemas/CreditCardMeta" }, "walletMeta": { "$ref": "#/components/schemas/WalletMeta" } }, "additionalProperties": false }, "OrganizationPaymentMethodClientDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "provider": { "$ref": "#/components/schemas/EPaymentProviderType" }, "kind": { "$ref": "#/components/schemas/EPaymentMethodKind" }, "creditCardMeta": { "$ref": "#/components/schemas/CreditCardMeta" }, "walletMeta": { "$ref": "#/components/schemas/WalletMeta" }, "primary": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "OrganizationRole": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "maxLength": 50, "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } }, "organizationId": { "type": "string", "format": "uuid", "nullable": true }, "organization": { "$ref": "#/components/schemas/Organization" }, "isExclusive": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "OrganizationRoleHierarchy": { "type": "object", "properties": { "roleIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false }, "OrganizationRoleMetaDto": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": false }, "OwnershipTransfer": { "required": [ "code", "expirationDate", "transferToEmail" ], "type": "object", "properties": { "code": { "type": "string", "format": "uuid" }, "expirationDate": { "type": "string", "format": "date-time" }, "transferToEmail": { "type": "string" } }, "additionalProperties": false }, "PaginationMetadata": { "type": "object", "properties": { "totalRecords": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PaymentResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "transactionReferenceId": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/ETransactionStatus" }, "providerErrorCode": { "type": "string", "nullable": true }, "isPermanentDecline": { "type": "boolean" }, "isImmediateSuccess": { "type": "boolean", "readOnly": true }, "isPending": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaymentResultServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/PaymentResult" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "PowerCommandRequest": { "type": "object", "properties": { "command": { "$ref": "#/components/schemas/BmcPowerCommand" } }, "additionalProperties": false }, "PowerControl": { "type": "object", "properties": { "powerConsumedWatts": { "type": "integer", "format": "int32", "nullable": true }, "powerMetrics": { "$ref": "#/components/schemas/PowerMetrics" } }, "additionalProperties": false }, "PowerControlServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/PowerControl" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "PowerMetrics": { "type": "object", "properties": { "intervalInMin": { "type": "integer", "format": "int32", "nullable": true }, "minConsumedWatts": { "type": "integer", "format": "int32", "nullable": true }, "maxConsumedWatts": { "type": "integer", "format": "int32", "nullable": true }, "averageConsumedWatts": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "PricingDto": { "type": "object", "properties": { "currency": { "type": "string" }, "rates": { "type": "object", "properties": { "HOURLY": { "$ref": "#/components/schemas/OfferingPriceDto" }, "MONTHLY": { "$ref": "#/components/schemas/OfferingPriceDto" }, "QUARTERLY": { "$ref": "#/components/schemas/OfferingPriceDto" }, "SEMI_ANNUALLY": { "$ref": "#/components/schemas/OfferingPriceDto" }, "ANNUALLY": { "$ref": "#/components/schemas/OfferingPriceDto" } }, "additionalProperties": false } }, "additionalProperties": false }, "Priority": { "enum": [ "LOW", "MEDIUM", "HIGH" ], "type": "string" }, "ProvisionedItemInfo": { "type": "object", "properties": { "orderItemId": { "type": "string", "format": "uuid" }, "provisionedId": { "type": "string", "format": "uuid" }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RaidVariant": { "enum": [ "NONE", "RAID0", "RAID1", "RAID5", "RAID6", "RAID10" ], "type": "string" }, "RedfishPowerSupply": { "type": "object", "properties": { "memberId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/Status" }, "lineInputVoltage": { "type": "number", "format": "double", "nullable": true }, "powerInputWatts": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "RedfishPowerSupplyIReadOnlyListServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RedfishPowerSupply" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "RedfishThermal": { "required": [ "temperatures" ], "type": "object", "properties": { "temperatures": { "type": "array", "items": { "$ref": "#/components/schemas/Temperature" } }, "fans": { "type": "array", "items": { "$ref": "#/components/schemas/Fan" }, "nullable": true } }, "additionalProperties": false }, "RedfishThermalServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/RedfishThermal" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "RegionView": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "facility": { "type": "string" }, "rack": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReserveV4AddressRequest": { "type": "object", "properties": { "requestedAddress": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReserveV6AddressRequest": { "type": "object", "properties": { "requestedAddress": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SecurityFindingClientView": { "type": "object", "properties": { "port": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "description": { "type": "string" }, "severity": { "$ref": "#/components/schemas/SecuritySeverity" } }, "additionalProperties": false }, "SecurityFindingDashboardView": { "type": "object", "properties": { "ipAddress": { "type": "string" }, "hostname": { "type": "string", "nullable": true }, "port": { "type": "integer", "format": "int32" }, "plugin": { "type": "string" }, "pluginDescription": { "type": "string" }, "severity": { "$ref": "#/components/schemas/SecuritySeverity" }, "title": { "type": "string" }, "description": { "type": "string" }, "evidence": { "type": "string", "nullable": true }, "remediation": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "serviceId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "SecurityFindingDashboardViewIReadOnlyListServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityFindingDashboardView" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "SecurityFindingFiltersView": { "type": "object", "properties": { "ipAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityIpFilterOption" } }, "serviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "plugins": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "SecurityFindingFiltersViewServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/SecurityFindingFiltersView" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "SecurityIpFilterOption": { "type": "object", "properties": { "ipAddress": { "type": "string" }, "hostname": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SecurityOverviewDashboardView": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/SecurityScanStatus" }, "metadata": { "$ref": "#/components/schemas/SecurityScanMetadata" }, "summary": { "$ref": "#/components/schemas/SecurityScanSummary" }, "targetCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SecurityOverviewDashboardViewServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/SecurityOverviewDashboardView" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "SecurityPluginStatsView": { "type": "object", "properties": { "plugin": { "type": "string" }, "description": { "type": "string" }, "critical": { "type": "integer", "format": "int32" }, "high": { "type": "integer", "format": "int32" }, "medium": { "type": "integer", "format": "int32" }, "low": { "type": "integer", "format": "int32" }, "info": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SecurityPluginStatsViewIReadOnlyListServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityPluginStatsView" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "SecurityScanClientView": { "type": "object", "properties": { "ipAddress": { "type": "string" }, "hostname": { "type": "string", "nullable": true }, "openPorts": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "findings": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityFindingClientView" } }, "summary": { "$ref": "#/components/schemas/SecurityScanSummaryClientView" } }, "additionalProperties": false }, "SecurityScanMetadata": { "type": "object", "properties": { "scanStarted": { "type": "string", "format": "date-time" }, "scanFinished": { "type": "string", "format": "date-time" }, "durationSeconds": { "type": "number", "format": "double" }, "totalTargets": { "type": "integer", "format": "int32" }, "totalPlugins": { "type": "integer", "format": "int32" }, "totalScans": { "type": "integer", "format": "int64" }, "version": { "type": "string" } }, "additionalProperties": false }, "SecurityScanStatus": { "type": "object", "properties": { "status": { "type": "string" }, "version": { "type": "string" }, "lastScan": { "type": "string", "format": "date-time" }, "nextScan": { "type": "string", "format": "date-time" }, "scanRunning": { "type": "boolean" }, "interval": { "type": "string" } }, "additionalProperties": false }, "SecurityScanSummary": { "type": "object", "properties": { "targetsWithFindings": { "type": "integer", "format": "int32" }, "totalFindings": { "type": "integer", "format": "int32" }, "openPorts": { "type": "integer", "format": "int32" }, "vulnerable": { "type": "integer", "format": "int32" }, "critical": { "type": "integer", "format": "int32" }, "high": { "type": "integer", "format": "int32" }, "medium": { "type": "integer", "format": "int32" }, "low": { "type": "integer", "format": "int32" }, "info": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SecurityScanSummaryClientView": { "type": "object", "properties": { "critical": { "type": "integer", "format": "int32" }, "high": { "type": "integer", "format": "int32" }, "medium": { "type": "integer", "format": "int32" }, "low": { "type": "integer", "format": "int32" }, "info": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SecuritySeverity": { "enum": [ "UNKNOWN", "INFO", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "type": "string" }, "SecuritySeverityCounts": { "type": "object", "properties": { "critical": { "type": "integer", "format": "int32" }, "high": { "type": "integer", "format": "int32" }, "medium": { "type": "integer", "format": "int32" }, "low": { "type": "integer", "format": "int32" }, "info": { "type": "integer", "format": "int32" }, "unknown": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SecurityTargetSummaryDashboardView": { "type": "object", "properties": { "ipAddress": { "type": "string" }, "hostname": { "type": "string", "nullable": true }, "summary": { "$ref": "#/components/schemas/SecuritySeverityCounts" }, "serviceId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "SecurityTargetSummaryDashboardViewIReadOnlyListServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityTargetSummaryDashboardView" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "SecurityTargetSummaryDashboardViewServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/SecurityTargetSummaryDashboardView" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "ServiceBaseMetaView": { "type": "object", "properties": { "serviceId": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false }, "ServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ServiceState": { "enum": [ "PENDING_SETUP", "ACTIVE", "SUSPENDED", "OPERATION_IN_PROGRESS" ], "type": "string" }, "SetRoleHierarchyRequest": { "type": "object", "properties": { "roleId": { "type": "string", "format": "uuid" }, "index": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SoftwareApplicationDto": { "required": [ "description", "name", "slug" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "slug": { "type": "string" }, "name": { "type": "string" }, "iconUrl": { "type": "string", "nullable": true }, "description": { "type": "string" }, "metadataSchema": { "enum": [ null ], "nullable": true } }, "additionalProperties": false }, "SoftwareApplicationDtoIReadOnlyListServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SoftwareApplicationDto" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "SpnAssignmentWithAddressesByPrefixView": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/SpnType" }, "prefixes": { "type": "array", "items": { "$ref": "#/components/schemas/IpChildPrefixWithAddressesView" } }, "localVlanId": { "type": "integer", "format": "int32", "nullable": true }, "isNative": { "type": "boolean" }, "provisioningVlanId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SpnAttachmentStatus": { "enum": [ "ATTACHED", "ATTACHING", "ATTACH_FAILED", "DETACHING", "DETACH_FAILED" ], "type": "string" }, "SpnAttachmentView": { "required": [ "createdAt", "id", "localVlanId", "managedBy", "name", "segmentId", "status", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/SpnType" }, "managedBy": { "$ref": "#/components/schemas/SpnManagedBy" }, "localVlanId": { "type": "integer", "format": "int32", "nullable": true }, "ipv4ChildPrefixes": { "type": "array", "items": { "$ref": "#/components/schemas/IPv4ChildPrefixDto" } }, "ipv6ChildPrefixes": { "type": "array", "items": { "$ref": "#/components/schemas/IPv6ChildPrefixDto" } }, "segmentId": { "type": "string", "format": "uuid" }, "status": { "$ref": "#/components/schemas/SpnAttachmentStatus" } }, "additionalProperties": false }, "SpnAttachmentViewListServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpnAttachmentView" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "SpnClientView": { "required": [ "createdAt", "id", "localVlanId", "managedBy", "name", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/SpnType" }, "managedBy": { "$ref": "#/components/schemas/SpnManagedBy" }, "localVlanId": { "type": "integer", "format": "int32", "nullable": true }, "ipv4ChildPrefixes": { "type": "array", "items": { "$ref": "#/components/schemas/IPv4ChildPrefixDto" } }, "ipv6ChildPrefixes": { "type": "array", "items": { "$ref": "#/components/schemas/IPv6ChildPrefixDto" } } }, "additionalProperties": false }, "SpnClientViewServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/SpnClientView" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "SpnManagedBy": { "enum": [ "CUSTOMER", "SYSTEM" ], "type": "string" }, "SpnMetaOnlyDto": { "required": [ "organization" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "organization": { "$ref": "#/components/schemas/OrganizationMetaOnlyDto" }, "type": { "$ref": "#/components/schemas/SpnType" } }, "additionalProperties": false }, "SpnServiceAttachmentView": { "required": [ "isNative", "segmentId", "status" ], "type": "object", "properties": { "segmentId": { "type": "string", "format": "uuid" }, "isNative": { "type": "boolean", "nullable": true }, "status": { "$ref": "#/components/schemas/SpnAttachmentStatus" }, "ipv4Addresses": { "type": "array", "items": { "type": "string" } }, "ipv6Addresses": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "SpnServiceView": { "required": [ "service" ], "type": "object", "properties": { "service": { "$ref": "#/components/schemas/AttachedServiceSummary" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/SpnServiceAttachmentView" } } }, "additionalProperties": false }, "SpnServiceViewListServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpnServiceView" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "SpnType": { "enum": [ "PRIVATE", "PUBLIC" ], "type": "string" }, "SpnWithPrefixCountDto": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/SpnType" }, "managedBy": { "$ref": "#/components/schemas/SpnManagedBy" }, "localVlanId": { "type": "integer", "format": "int32", "nullable": true }, "ipv4ChildPrefixCount": { "type": "integer", "format": "int32" }, "ipv6ChildPrefixCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SpnWithPrefixCountDtoIEnumerableServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpnWithPrefixCountDto" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "SpnWithPrefixesSummaryView": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "localVlanId": { "type": "integer", "format": "int32", "nullable": true }, "type": { "$ref": "#/components/schemas/SpnType" }, "managedBy": { "$ref": "#/components/schemas/SpnManagedBy" }, "ipv4ChildPrefixes": { "type": "array", "items": { "$ref": "#/components/schemas/IpChildPrefixSummaryView" } }, "ipv6ChildPrefixes": { "type": "array", "items": { "$ref": "#/components/schemas/IpChildPrefixSummaryView" } } }, "additionalProperties": false }, "SpnWithPrefixesSummaryViewServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/SpnWithPrefixesSummaryView" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "SshKeyType": { "enum": [ "RSA", "ED25519", "ECDSA" ], "type": "string" }, "Status": { "type": "object", "properties": { "health": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StringObjectIReadOnlyDictionaryServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "object", "additionalProperties": { "enum": [ null ], "nullable": true }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "StringSecurityScanClientViewDictionaryServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SecurityScanClientView" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "StringServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "string", "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "Subscription": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "organization": { "$ref": "#/components/schemas/Organization" }, "lastRenewal": { "type": "string", "format": "date-time", "nullable": true }, "nextRenewal": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "terminatedAt": { "type": "string", "format": "date-time", "nullable": true }, "cycle": { "$ref": "#/components/schemas/BillingCycle" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionItem" } }, "status": { "$ref": "#/components/schemas/ESubscriptionStatus" }, "activeItems": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionItem" }, "readOnly": true } }, "additionalProperties": false }, "SubscriptionClientView": { "required": [ "activeItems", "currency", "items" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "lastRenewal": { "type": "string", "format": "date-time", "nullable": true }, "nextRenewal": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "terminatedAt": { "type": "string", "format": "date-time", "nullable": true }, "cycle": { "$ref": "#/components/schemas/EBillingCycle" }, "status": { "$ref": "#/components/schemas/ESubscriptionStatus" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionItemClientView" } }, "activeItems": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionItemClientView" } }, "currency": { "type": "string" } }, "additionalProperties": false }, "SubscriptionClientViewIEnumerableServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionClientView" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "SubscriptionClientViewServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/SubscriptionClientView" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "SubscriptionItem": { "required": [ "details", "discountRate", "provisionedId", "subtotal", "title", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "orderItemId": { "type": "string", "format": "uuid", "nullable": true }, "provisionedId": { "type": "string", "format": "uuid" }, "type": { "$ref": "#/components/schemas/ESubscriptionItemType" }, "details": { "$ref": "#/components/schemas/ISubscriptionItemDetails" }, "title": { "type": "string" }, "subtotal": { "$ref": "#/components/schemas/Millicents" }, "discountRate": { "type": "number", "format": "double" }, "terminatedAt": { "type": "string", "format": "date-time", "nullable": true }, "isTerminated": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "SubscriptionItemClientView": { "required": [ "currency", "details", "title" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "orderItemId": { "type": "string", "format": "uuid", "nullable": true }, "provisionedId": { "type": "string", "format": "uuid" }, "type": { "$ref": "#/components/schemas/ESubscriptionItemType" }, "details": { "$ref": "#/components/schemas/ISubscriptionItemDetails" }, "title": { "type": "string" }, "subtotal": { "type": "integer", "format": "int64" }, "discountRate": { "type": "number", "format": "double" }, "terminatedAt": { "type": "string", "format": "date-time", "nullable": true }, "isTerminated": { "type": "boolean" }, "currency": { "type": "string" } }, "additionalProperties": false }, "TaxBreakdownView": { "type": "object", "properties": { "name": { "type": "string" }, "rate": { "type": "number", "format": "double" }, "amount": { "type": "integer", "format": "int64" }, "taxId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TaxTreatment": { "enum": [ "STANDARD", "REVERSE_CHARGE_VALID_VAT" ], "type": "string" }, "Temperature": { "type": "object", "properties": { "memberId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "readingCelsius": { "type": "number", "format": "double", "nullable": true }, "lowerThresholdCritical": { "type": "number", "format": "double", "nullable": true }, "upperThresholdCritical": { "type": "number", "format": "double", "nullable": true }, "status": { "$ref": "#/components/schemas/Status" }, "physicalContext": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UnassignServiceFromSpnRequest": { "type": "object", "properties": { "serviceId": { "type": "string", "format": "uuid" }, "segmentId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "UpdateBootModeRequest": { "required": [ "bootMode" ], "type": "object", "properties": { "bootMode": { "$ref": "#/components/schemas/BootMode" } }, "additionalProperties": false }, "UpdateFirewallRuleRequest": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/FirewallRuleType" }, "direction": { "$ref": "#/components/schemas/FirewallRuleDirection" }, "protocol": { "$ref": "#/components/schemas/FirewallProtocol" }, "sourcePortStart": { "maximum": 65535, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "sourcePortEnd": { "maximum": 65535, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "sourceAddress": { "type": "string", "nullable": true }, "destPortStart": { "maximum": 65535, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "destPortEnd": { "maximum": 65535, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "isEnabled": { "type": "boolean", "nullable": true }, "rateLimitPps": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "packetCriteria": { "$ref": "#/components/schemas/FirewallPacketCriteriaDto" }, "description": { "maxLength": 100, "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateIpxeScriptRequest": { "required": [ "script" ], "type": "object", "properties": { "script": { "maxLength": 65536, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "UpdateOrganizationRoleRequest": { "type": "object", "properties": { "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "UpdatePaymentMethodRequest": { "type": "object", "properties": { "default": { "type": "boolean" } }, "additionalProperties": false }, "UpdateSshKeyRequest": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": false }, "UsageSummary": { "type": "object", "properties": { "currency": { "type": "string" }, "billingCycleDay": { "type": "integer", "format": "int32" }, "billingPeriodStart": { "type": "string", "format": "date-time" }, "billingPeriodEnd": { "type": "string", "format": "date-time" }, "totalAccruedCharges": { "type": "integer", "format": "int64" }, "estimatedPeriodEndCharges": { "type": "integer", "format": "int64" }, "activeServiceCount": { "type": "integer", "format": "int32" }, "terminatedServiceCount": { "type": "integer", "format": "int32" }, "isPartial": { "type": "boolean" } }, "additionalProperties": false }, "UsageSummaryServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/UsageSummary" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "UserGetOrganizationRoleDto": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "UserGetOrganizationRoleDtoIEnumerableServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserGetOrganizationRoleDto" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "UserGetOrganizationRoleDtoServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/UserGetOrganizationRoleDto" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "UserNotificationView": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "message": { "type": "string" }, "bodyMarkdown": { "type": "string" }, "category": { "$ref": "#/components/schemas/NotificationContentCategory" }, "actionUrl": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time" }, "read": { "type": "boolean" }, "userId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "UserNotificationViewIEnumerableServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserNotificationView" }, "nullable": true }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "UserNotificationViewServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/UserNotificationView" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "UserRoleInfo": { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" } }, "isAdmin": { "type": "boolean", "readOnly": true }, "isSuperAdmin": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "V4PtrRequest": { "required": [ "record" ], "type": "object", "properties": { "record": { "type": "string" } }, "additionalProperties": false }, "VlanAvailabilityView": { "required": [ "maxVlanId", "minVlanId", "nextFreeVlanId", "usedVlanIds" ], "type": "object", "properties": { "nextFreeVlanId": { "type": "integer", "format": "int32", "nullable": true }, "usedVlanIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "minVlanId": { "type": "integer", "format": "int32" }, "maxVlanId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "VlanAvailabilityViewServiceResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "exception": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "traceId": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/VlanAvailabilityView" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } }, "additionalProperties": false }, "WalletMeta": { "required": [ "brand", "identifier" ], "type": "object", "properties": { "brand": { "type": "string" }, "identifier": { "type": "string" } }, "additionalProperties": false } } } }