{ "openapi": "3.1.1", "info": { "summary": "This page lists tags used to group the API endpoints.", "title": "UpCloud API", "description": "UpCloud is a leading European cloud service provider with a global cloud platform spanning four continents. UpCloud offers Cloud Servers, Managed Kubernetes, Managed Databases, Object Storage and more. This API can be used to manage your UpCloud account and resources programmatically.\n\nThis page provides a list of tags used to group the API endpoints. The end-points are tagged by the main level path segment, e.g. all paths starting with `/1.3/server` have `server` tag.\n", "termsOfService": "https://upcloud.com/terms-of-service/", "contact": { "name": "UpCloud", "url": "https://upcloud.com", "email": "hello@upcloud.com" }, "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT.html" }, "version": "1.3" }, "servers": [ { "url": "https://api.upcloud.com" } ], "paths": { "/1.3/account": { "get": { "tags": [ "account" ], "summary": "Account details", "description": "Returns account details for the authenticated user", "operationId": "accountDetails", "responses": { "200": { "$ref": "#/components/responses/accountDetails200" }, "default": { "$ref": "#/components/responses/accountDetailsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/account/billing/summary/{year}-{month}": { "get": { "tags": [ "account" ], "summary": "Get monthly billing summary with resource details", "description": "Returns a billing summary grouped by resource, including billing detail changes during the specified month. The API user must have permission to read billing details.", "operationId": "getMonthlyDetailedBillingSummary", "parameters": [ { "$ref": "#/components/parameters/accountGetMonthlyDetailedBillingSummaryYear" }, { "$ref": "#/components/parameters/accountGetMonthlyDetailedBillingSummaryMonth" }, { "$ref": "#/components/parameters/accountGetMonthlyDetailedBillingSummaryUsername" }, { "$ref": "#/components/parameters/accountGetMonthlyDetailedBillingSummaryResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/accountGetMonthlyDetailedBillingSummary200" }, "default": { "$ref": "#/components/responses/accountGetMonthlyDetailedBillingSummaryDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/account/billing_summary/{year}-{month}": { "get": { "tags": [ "account" ], "summary": "Get monthly billing summary", "description": "Returns a billing summary for the specified month. The API user must have permission to read billing details. This endpoint is deprecated; use the monthly billing summary with resource details instead.", "operationId": "getMonthlyBillingSummary", "parameters": [ { "$ref": "#/components/parameters/accountGetMonthlyBillingSummaryYear" }, { "$ref": "#/components/parameters/accountGetMonthlyBillingSummaryMonth" } ], "responses": { "200": { "$ref": "#/components/responses/accountGetMonthlyBillingSummary200" }, "default": { "$ref": "#/components/responses/accountGetMonthlyBillingSummaryDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/account/current_network_usage": { "get": { "tags": [ "account" ], "summary": "Get current network usage", "description": "Returns the latest Network Transfer Pool usage report for the account.", "operationId": "getCurrentNetworkUsage", "responses": { "200": { "$ref": "#/components/responses/accountGetCurrentNetworkUsage200" }, "default": { "$ref": "#/components/responses/accountGetCurrentNetworkUsageDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/account/list": { "get": { "tags": [ "account" ], "summary": "List accounts", "description": "Returns the main account and its subaccounts. Account listing is available only to the main account.", "operationId": "listAccounts", "parameters": [ { "$ref": "#/components/parameters/listAccountsLabel" } ], "responses": { "200": { "$ref": "#/components/responses/listAccounts200" }, "default": { "$ref": "#/components/responses/listAccountsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/account/ms_lma": { "post": { "tags": [ "account" ], "summary": "Create Microsoft LMA signing link", "description": "Create a new Microsoft LMA signing link", "operationId": "createMSLMASigningLink", "responses": { "201": { "$ref": "#/components/responses/accountCreateMSLMASigningLink201" }, "default": { "$ref": "#/components/responses/accountCreateMSLMASigningLinkDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/account/network_top_usage": { "get": { "tags": [ "account" ], "summary": "Get top network usage", "description": "Returns the resources with the highest network usage.", "operationId": "getAccountNetworkTopUsage", "parameters": [ { "$ref": "#/components/parameters/getAccountNetworkTopUsageFrom" }, { "$ref": "#/components/parameters/getAccountNetworkTopUsageTo" }, { "$ref": "#/components/parameters/getAccountNetworkTopUsageService" }, { "$ref": "#/components/parameters/getAccountNetworkTopUsageZone" }, { "$ref": "#/components/parameters/getAccountNetworkTopUsageAccumulate" } ], "responses": { "200": { "$ref": "#/components/responses/getAccountNetworkTopUsage200" }, "default": { "$ref": "#/components/responses/getAccountNetworkTopUsageDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/account/network_usage": { "get": { "tags": [ "account" ], "summary": "Get network transfer statistics", "description": "Returns network transfer statistics. JSON responses support a maximum time window of 31 days; CSV responses have no time-window limit. Select the output format with the Accept header using application/json or text/csv.", "operationId": "getAccountNetworkUsage", "parameters": [ { "$ref": "#/components/parameters/getAccountNetworkUsageFrom" }, { "$ref": "#/components/parameters/getAccountNetworkUsageTo" }, { "$ref": "#/components/parameters/getAccountNetworkUsageAccumulate" } ], "responses": { "200": { "$ref": "#/components/responses/getAccountNetworkUsage200" }, "default": { "$ref": "#/components/responses/getAccountNetworkUsageDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/account/resource-usage": { "get": { "tags": [ "account" ], "summary": "Get resource usage", "description": "Returns current resource usage counts for the account.", "operationId": "getAccountResourceUsage", "responses": { "200": { "$ref": "#/components/responses/getAccountResourceUsage200" }, "default": { "$ref": "#/components/responses/getAccountResourceUsageDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/account/resource_billing_summary/{resource_id}/{year}-{month}": { "get": { "tags": [ "account" ], "summary": "Get monthly resource billing summary", "description": "Returns a billing summary for one resource during the specified month. The API user must have permission to read billing details.", "operationId": "getMonthlyResourceBillingSummary", "parameters": [ { "$ref": "#/components/parameters/accountGetMonthlyResourceBillingSummaryResourceId" }, { "$ref": "#/components/parameters/accountGetMonthlyResourceBillingSummaryYear" }, { "$ref": "#/components/parameters/accountGetMonthlyResourceBillingSummaryMonth" } ], "responses": { "200": { "$ref": "#/components/responses/accountGetMonthlyResourceBillingSummary200" }, "default": { "$ref": "#/components/responses/accountGetMonthlyResourceBillingSummaryDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/account/resource_network_usage": { "get": { "tags": [ "account" ], "summary": "Get resource transfer statistics", "description": "Returns network transfer statistics grouped by resource, service, and zone. JSON responses support a maximum time window of 31 days; CSV responses have no time-window limit. Select the output format with the Accept header using application/json or text/csv.", "operationId": "getAccountResourceNetworkUsage", "parameters": [ { "$ref": "#/components/parameters/getAccountResourceNetworkUsageFrom" }, { "$ref": "#/components/parameters/getAccountResourceNetworkUsageTo" }, { "$ref": "#/components/parameters/getAccountResourceNetworkUsageService" }, { "$ref": "#/components/parameters/getAccountResourceNetworkUsageResourceId" }, { "$ref": "#/components/parameters/getAccountResourceNetworkUsageZone" }, { "$ref": "#/components/parameters/getAccountResourceNetworkUsageAccumulate" } ], "responses": { "200": { "$ref": "#/components/responses/getAccountResourceNetworkUsage200" }, "default": { "$ref": "#/components/responses/getAccountResourceNetworkUsageDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/account/sub": { "post": { "tags": [ "account" ], "summary": "Create subaccount", "description": "Creates a subaccount for the authenticated main account.", "operationId": "createSubaccount", "requestBody": { "$ref": "#/components/requestBodies/createSubaccount" }, "responses": { "204": { "$ref": "#/components/responses/createSubaccount204" }, "default": { "$ref": "#/components/responses/createSubaccountDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/account/sub/{username}": { "delete": { "tags": [ "account" ], "summary": "Delete subaccount", "description": "Deletes a subaccount from the authenticated main account.", "operationId": "deleteSubaccount", "parameters": [ { "$ref": "#/components/parameters/deleteSubaccountUsername" } ], "responses": { "204": { "$ref": "#/components/responses/deleteSubaccount204" }, "default": { "$ref": "#/components/responses/deleteSubaccountDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/kubernetes": { "get": { "tags": [ "kubernetes" ], "summary": "List clusters", "description": "Returns a list of Kubernetes clusters.", "operationId": "listKubernetesClusters", "responses": { "200": { "$ref": "#/components/responses/kubernetesGetClusters" }, "400": { "$ref": "#/components/responses/kubernetesBadRequest" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } }, "post": { "tags": [ "kubernetes" ], "summary": "Create cluster", "description": "Creates a new Kubernetes cluster.", "operationId": "createKubernetesCluster", "requestBody": { "$ref": "#/components/requestBodies/kubernetesPostCluster" }, "responses": { "201": { "$ref": "#/components/responses/kubernetesPostCluster" }, "400": { "$ref": "#/components/responses/kubernetesBadRequest" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "404": { "$ref": "#/components/responses/kubernetesNotFound" }, "422": { "$ref": "#/components/responses/kubernetesUnProcessableEntity" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } } }, "/1.3/kubernetes/{uuid}": { "get": { "tags": [ "kubernetes" ], "summary": "Get cluster details", "description": "Returns Kubernetes cluster details by given `uuid`.", "operationId": "getKubernetesCluster", "responses": { "200": { "$ref": "#/components/responses/kubernetesGetCluster" }, "400": { "$ref": "#/components/responses/kubernetesBadRequest" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "404": { "$ref": "#/components/responses/kubernetesNotFound" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } }, "delete": { "tags": [ "kubernetes" ], "summary": "Delete cluster", "description": "Deletes an existing Kubernetes cluster by given `uuid`.", "operationId": "deleteKubernetesCluster", "responses": { "202": { "$ref": "#/components/responses/kubernetesDeleteCluster" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "404": { "$ref": "#/components/responses/kubernetesNotFound" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } }, "patch": { "tags": [ "kubernetes" ], "summary": "Modify cluster", "description": "Modifies an existing Kubernetes cluster by given `{uuid}`.", "operationId": "modifyKubernetesCluster", "requestBody": { "$ref": "#/components/requestBodies/kubernetesPatchCluster" }, "responses": { "200": { "$ref": "#/components/responses/kubernetesPatchCluster" }, "400": { "$ref": "#/components/responses/kubernetesBadRequest" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "404": { "$ref": "#/components/responses/kubernetesNotFound" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/kubernetesUuid" } ] }, "/1.3/kubernetes/{uuid}/kubeconfig": { "get": { "tags": [ "kubernetes" ], "summary": "Get kubeconfig", "description": "Returns kubeconfig for Kubernetes cluster by given `{uuid}`.", "operationId": "getKubernetesClusterKubeconfig", "responses": { "200": { "$ref": "#/components/responses/kubernetesGetClusterKubeconfig" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "404": { "$ref": "#/components/responses/kubernetesNotFound" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/kubernetesUuid" } ] }, "/1.3/kubernetes/{uuid}/available-upgrades": { "get": { "tags": [ "kubernetes" ], "summary": "Get available upgrades", "description": "Returns a list of available versions that can be used to upgrade the cluster.", "operationId": "getKubernetesClusterAvailableUpgrades", "responses": { "200": { "$ref": "#/components/responses/kubernetesGetAvailableUpgrades" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "404": { "$ref": "#/components/responses/kubernetesNotFound" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } }, "post": { "tags": [ "kubernetes" ], "summary": "Upgrade cluster", "description": "Upgrades an existing Kubernetes cluster to specific version.", "operationId": "upgradeKubernetesCluster", "requestBody": { "$ref": "#/components/requestBodies/kubernetesPostUpgrade" }, "responses": { "201": { "$ref": "#/components/responses/kubernetesPostUpgrade" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "404": { "$ref": "#/components/responses/kubernetesNotFound" }, "422": { "$ref": "#/components/responses/kubernetesUnProcessableEntity" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/kubernetesUuid" } ] }, "/1.3/kubernetes/{uuid}/node-groups": { "get": { "tags": [ "kubernetes" ], "summary": "List node groups", "description": "Returns a list of available node groups of an existing Kubernetes cluster. Cluster is identified by given `{uuid}`.\n\nA node group is a uniform set of worker nodes attached to a cluster.\n", "operationId": "listKubernetesClusterNodeGroups", "responses": { "200": { "$ref": "#/components/responses/kubernetesGetNodeGroups" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "404": { "$ref": "#/components/responses/kubernetesNotFound" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } }, "post": { "tags": [ "kubernetes" ], "summary": "Create node group", "description": "Creates a new node group to an existing Kubernetes cluster. Cluster is identified by given `{uuid}`.", "operationId": "createKubernetesClusterNodeGroup", "requestBody": { "$ref": "#/components/requestBodies/kubernetesPostNodeGroup" }, "responses": { "201": { "$ref": "#/components/responses/kubernetesPostNodeGroup" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "404": { "$ref": "#/components/responses/kubernetesNotFound" }, "422": { "$ref": "#/components/responses/kubernetesUnProcessableEntity" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/kubernetesUuid" } ] }, "/1.3/kubernetes/{uuid}/node-groups/{name}": { "get": { "tags": [ "kubernetes" ], "summary": "Get node group details", "description": "Returns node group details by given `{node_group_name}`. Cluster is identified by given `{uuid}`.", "operationId": "getKubernetesClusterNodeGroup", "responses": { "200": { "$ref": "#/components/responses/kubernetesGetNodeGroupDetails" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "404": { "$ref": "#/components/responses/kubernetesNotFound" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } }, "delete": { "tags": [ "kubernetes" ], "summary": "Delete node group", "description": "Deletes an existing node group by given Kubernetes cluster `{uuid}` and `{node_group_name}`.", "operationId": "deleteKubernetesClusterNodeGroup", "responses": { "202": { "$ref": "#/components/responses/kubernetesDeleteNodeGroup" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "404": { "$ref": "#/components/responses/kubernetesNotFound" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } }, "patch": { "tags": [ "kubernetes" ], "summary": "Modify node group", "description": "Modifies an existing node group of a cluster. Cluster is identified by given `{uuid}` and node group by `{node_group_name}`.", "operationId": "modifyKubernetesClusterNodeGroup", "requestBody": { "$ref": "#/components/requestBodies/kubernetesPatchNodeGroup" }, "responses": { "200": { "$ref": "#/components/responses/kubernetesPatchNodeGroup" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "404": { "$ref": "#/components/responses/kubernetesNotFound" }, "422": { "$ref": "#/components/responses/kubernetesUnProcessableEntity" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/kubernetesUuid" }, { "$ref": "#/components/parameters/kubernetesName" } ] }, "/1.3/kubernetes/{uuid}/node-groups/{name}/{node-name}": { "delete": { "tags": [ "kubernetes" ], "summary": "Delete node group node", "description": "Deletes a node group node from a cluster (experimental). Cluster is identified by given `{uuid}`, node group by `{name}`, and node by `{node-name}`.", "operationId": "deleteKubernetesClusterNodeGroupNode", "responses": { "202": { "$ref": "#/components/responses/kubernetesDeleteNodeGroupNode" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "404": { "$ref": "#/components/responses/kubernetesNotFound" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } }, "parameters": [ { "$ref": "#/components/parameters/kubernetesUuid" }, { "$ref": "#/components/parameters/kubernetesName" }, { "$ref": "#/components/parameters/kubernetesNodeName" } ] }, "/1.3/kubernetes/plans": { "get": { "tags": [ "kubernetes" ], "summary": "List plans", "description": "Returns a list of available Kubernetes cluster plans.", "operationId": "listKubernetesPlans", "responses": { "200": { "$ref": "#/components/responses/kubernetesGetPlan" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } } }, "/1.3/kubernetes/versions": { "get": { "tags": [ "kubernetes" ], "summary": "List versions", "description": "Returns a list of available Kubernetes cluster versions.", "operationId": "listKubernetesVersions", "responses": { "200": { "$ref": "#/components/responses/kubernetesGetVersion" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } } }, "/1.3/kubernetes/{uuid}/authentication": { "get": { "tags": [ "kubernetes" ], "summary": "List cluster authentication entries", "description": "Returns all OIDC authentication issuer configurations for a cluster.", "operationId": "listClusterAuthentication", "parameters": [ { "$ref": "#/components/parameters/kubernetesUuid" } ], "responses": { "200": { "$ref": "#/components/responses/kubernetesListClusterAuthentication200" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "404": { "$ref": "#/components/responses/kubernetesNotFound" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } }, "put": { "tags": [ "kubernetes" ], "summary": "Replace the full cluster authentication configuration", "description": "Replaces the entire set of OIDC authentication issuer configurations for a cluster with the supplied JSON list of issuers. The full set is validated before being applied. An empty list clears all issuers.\n", "operationId": "setClusterAuthentication", "parameters": [ { "$ref": "#/components/parameters/kubernetesUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/kubernetesSetClusterAuthentication" }, "responses": { "200": { "$ref": "#/components/responses/kubernetesSetClusterAuthentication200" }, "400": { "$ref": "#/components/responses/kubernetesBadRequest" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "404": { "$ref": "#/components/responses/kubernetesNotFound" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } }, "post": { "tags": [ "kubernetes" ], "summary": "Create a cluster authentication entry", "description": "Creates a new OIDC authentication issuer configuration. The new entry is validated together with the cluster's existing entries before being applied. Fails if an entry with the same name already exists.\n", "operationId": "createClusterAuthentication", "parameters": [ { "$ref": "#/components/parameters/kubernetesUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/kubernetesCreateClusterAuthentication" }, "responses": { "201": { "$ref": "#/components/responses/kubernetesCreateClusterAuthentication201" }, "400": { "$ref": "#/components/responses/kubernetesBadRequest" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "404": { "$ref": "#/components/responses/kubernetesNotFound" }, "409": { "$ref": "#/components/responses/kubernetesConflict" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } } }, "/1.3/kubernetes/{uuid}/authentication/import": { "put": { "tags": [ "kubernetes" ], "summary": "Import a full cluster authentication configuration", "description": "Replaces the entire set of OIDC authentication issuer configurations for a cluster with the supplied native kube-apiserver v1 AuthenticationConfiguration YAML document. Issuers are named deterministically from their issuer URL host. The top-level `anonymous` field is not supported and any configuration that would drop data is rejected.\n", "operationId": "importClusterAuthentication", "parameters": [ { "$ref": "#/components/parameters/kubernetesUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/kubernetesImportClusterAuthentication" }, "responses": { "200": { "$ref": "#/components/responses/kubernetesImportClusterAuthentication200" }, "400": { "$ref": "#/components/responses/kubernetesBadRequest" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "404": { "$ref": "#/components/responses/kubernetesNotFound" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } } }, "/1.3/kubernetes/{uuid}/authentication/{name}": { "get": { "tags": [ "kubernetes" ], "summary": "Get a cluster authentication entry", "operationId": "getClusterAuthentication", "parameters": [ { "$ref": "#/components/parameters/kubernetesUuid" }, { "$ref": "#/components/parameters/kubernetesName" } ], "responses": { "200": { "$ref": "#/components/responses/kubernetesGetClusterAuthentication200" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "404": { "$ref": "#/components/responses/kubernetesNotFound" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } }, "put": { "tags": [ "kubernetes" ], "summary": "Update a cluster authentication entry", "description": "Updates an existing OIDC authentication issuer configuration. The name in the path is authoritative. The updated entry is validated together with the cluster's other entries before being applied.\n", "operationId": "updateClusterAuthentication", "parameters": [ { "$ref": "#/components/parameters/kubernetesUuid" }, { "$ref": "#/components/parameters/kubernetesName" } ], "requestBody": { "$ref": "#/components/requestBodies/kubernetesUpdateClusterAuthentication" }, "responses": { "200": { "$ref": "#/components/responses/kubernetesUpdateClusterAuthentication200" }, "400": { "$ref": "#/components/responses/kubernetesBadRequest" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "404": { "$ref": "#/components/responses/kubernetesNotFound" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } }, "delete": { "tags": [ "kubernetes" ], "summary": "Delete a cluster authentication entry", "description": "Removes an OIDC authentication issuer configuration by name.", "operationId": "deleteClusterAuthentication", "parameters": [ { "$ref": "#/components/parameters/kubernetesUuid" }, { "$ref": "#/components/parameters/kubernetesName" } ], "responses": { "204": { "$ref": "#/components/responses/kubernetesDeleteClusterAuthentication204" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "404": { "$ref": "#/components/responses/kubernetesNotFound" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } } }, "/1.3/kubernetes/{uuid}/authentication/{name}/kubeconfig": { "get": { "tags": [ "kubernetes" ], "summary": "Get OIDC kubeconfig", "description": "Returns a kubeconfig for the cluster whose user authenticates via the kubelogin (`kubectl oidc-login`) exec credential plugin, using the cluster's configured OIDC issuer identified by the `name` path parameter. The plugin (kubelogin) must be installed on the client. No long-lived credential is embedded. The OIDC client secret and any provider-specific kubelogin flags are not injected by the server; the returned kubeconfig includes comments describing how to add them.\n", "operationId": "getKubernetesClusterOIDCKubeconfig", "parameters": [ { "$ref": "#/components/parameters/kubernetesUuid" }, { "$ref": "#/components/parameters/kubernetesName" }, { "$ref": "#/components/parameters/getKubernetesClusterOIDCKubeconfigAudience" } ], "responses": { "200": { "$ref": "#/components/responses/kubernetesGetClusterKubeconfig" }, "400": { "$ref": "#/components/responses/kubernetesBadRequest" }, "401": { "$ref": "#/components/responses/kubernetesUnAuthorized" }, "404": { "$ref": "#/components/responses/kubernetesNotFound" }, "default": { "$ref": "#/components/responses/kubernetesInternalServerError" } } } }, "/1.3/currency": { "get": { "tags": [ "currency" ], "summary": "List currencies", "description": "Retrieves a list of supported currencies and their exchange rates relative to the account credit currency.", "operationId": "listCurrencies", "responses": { "200": { "$ref": "#/components/responses/currencyListCurrencies200" }, "default": { "$ref": "#/components/responses/currencyListCurrenciesDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/device/availability": { "get": { "tags": [ "device" ], "summary": "Get available passthrough devices", "description": "Returns a list of available passthrough devices.", "operationId": "getAvailablePassthroughDevices", "parameters": [ { "$ref": "#/components/parameters/getAvailablePassthroughDevicesZone" }, { "$ref": "#/components/parameters/getAvailablePassthroughDevicesType" } ], "responses": { "200": { "$ref": "#/components/responses/getAvailablePassthroughDevices200" }, "default": { "$ref": "#/components/responses/getAvailablePassthroughDevicesDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/events/{server_uuid}/{offset},{count}": { "get": { "tags": [ "events" ], "summary": "List events", "description": "Retrieves a list of events.", "operationId": "listEvents", "parameters": [ { "$ref": "#/components/parameters/listEventsServerUuid" }, { "$ref": "#/components/parameters/listEventsOffset" }, { "$ref": "#/components/parameters/listEventsCount" } ], "responses": { "200": { "$ref": "#/components/responses/listEvents200" }, "default": { "$ref": "#/components/responses/listEventsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/ip_address": { "get": { "tags": [ "ip_address" ], "summary": "List IP addresses", "description": "Retrieves a list of IP addresses.", "operationId": "listIPAddresses", "responses": { "200": { "$ref": "#/components/responses/listIPAddresses200" }, "default": { "$ref": "#/components/responses/listIPAddressesDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "ip_address" ], "summary": "Add an IP address", "description": "Adds a new IP address.", "operationId": "addIPAddress", "requestBody": { "$ref": "#/components/requestBodies/addIPAddress" }, "responses": { "201": { "$ref": "#/components/responses/addIPAddress201" }, "default": { "$ref": "#/components/responses/addIPAddressDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/ip_address/bulk": { "patch": { "tags": [ "ip_address" ], "summary": "Bulk modify IP addresses", "description": "Modifies attributes of multiple IP addresses in a single request.", "operationId": "bulkModifyIPAddresses", "requestBody": { "$ref": "#/components/requestBodies/bulkModifyIPAddresses" }, "responses": { "204": { "$ref": "#/components/responses/bulkModifyIPAddresses204" }, "default": { "$ref": "#/components/responses/bulkModifyIPAddressesDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/ip_address/{address}": { "get": { "tags": [ "ip_address" ], "summary": "Get IP address", "description": "Retrieves details of a specific IP address.", "operationId": "getIPAddressDetails", "parameters": [ { "$ref": "#/components/parameters/getIPAddressDetailsAddress" } ], "responses": { "200": { "$ref": "#/components/responses/getIPAddressDetails200" }, "default": { "$ref": "#/components/responses/getIPAddressDetailsDefault" } }, "x-upcloud-visibility": "public" }, "put": { "tags": [ "ip_address" ], "summary": "Modify IP address", "description": "Modifies attributes of a specific IP address.", "operationId": "modifyIPAddress", "parameters": [ { "$ref": "#/components/parameters/modifyIPAddressAddress" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyIPAddress" }, "responses": { "202": { "$ref": "#/components/responses/modifyIPAddress202" }, "default": { "$ref": "#/components/responses/modifyIPAddressDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "ip_address" ], "summary": "Delete IP address", "description": "Deletes a specific IP address.", "operationId": "deleteIPAddress", "parameters": [ { "$ref": "#/components/parameters/deleteIPAddressAddress" } ], "responses": { "204": { "$ref": "#/components/responses/deleteIPAddress204" }, "default": { "$ref": "#/components/responses/deleteIPAddressDefault" } }, "x-upcloud-visibility": "public" }, "patch": { "tags": [ "ip_address" ], "summary": "Modify an IP address", "description": "Modifies attributes of a specific IP address.", "operationId": "patchModifyIPAddress", "parameters": [ { "$ref": "#/components/parameters/patchModifyIPAddressAddress" } ], "requestBody": { "$ref": "#/components/requestBodies/patchModifyIPAddress" }, "responses": { "202": { "$ref": "#/components/responses/patchModifyIPAddress202" }, "default": { "$ref": "#/components/responses/patchModifyIPAddressDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/network-peering": { "get": { "tags": [ "network-peering" ], "summary": "List peerings", "description": "Get a list of all peerings within the current account. Only peerings that refer to a network that the current\naccount has access are returned.\n\nIt is also possible to filter network peering with label URL parameters, e.g.\n`?label=env` or `?label=env%3Dprod`. The URL parameter can be given multiple\ntimes to add more filters (e.g. `?label=env%3Dprod&label=v2`), where\nonly network peering that match all labels are returned.\nLabel keys are matched case insensitively.\n", "operationId": "listNetworkPeerings", "parameters": [ { "$ref": "#/components/parameters/listNetworkPeeringsUuid" }, { "$ref": "#/components/parameters/listNetworkPeeringsNetworkUuidLocal" }, { "$ref": "#/components/parameters/listNetworkPeeringsNetworkUuidPeer" }, { "$ref": "#/components/parameters/listNetworkPeeringsLabel" } ], "responses": { "200": { "$ref": "#/components/responses/listNetworkPeerings200" }, "default": { "$ref": "#/components/responses/listNetworkPeeringsDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "network-peering" ], "summary": "Create peering", "description": "Network peerings are used to enable traffic between two networks that can be on different main accounts.\nThe peering must be established both ways before it's considered as active. Peering is only supported between networks\nof type `private`.\n\n**Note**: you should only create peering between accounts and networks you trust. There is no limits on what traffic\ncan flow. The server firewall **has no effect** for `private` type networks.\n\nIt is required that both networks have a *Router* attached to the network.\n", "operationId": "createNetworkPeering", "requestBody": { "$ref": "#/components/requestBodies/createNetworkPeering" }, "responses": { "201": { "$ref": "#/components/responses/createNetworkPeering201" }, "400": { "$ref": "#/components/responses/createNetworkPeering400" }, "404": { "$ref": "#/components/responses/createNetworkPeering404" }, "409": { "$ref": "#/components/responses/createNetworkPeering409" }, "default": { "$ref": "#/components/responses/createNetworkPeeringDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/network-peering/{peering_uuid}": { "get": { "tags": [ "network-peering" ], "summary": "Get peering", "description": "Returns the state of an existing network peering.\n\nNote that the `peer_network` field only contains the network details if the peering has been defined by both accounts.\n", "operationId": "getNetworkPeering", "parameters": [ { "$ref": "#/components/parameters/getNetworkPeeringPeeringUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getNetworkPeering200" }, "404": { "$ref": "#/components/responses/getNetworkPeering404" }, "default": { "$ref": "#/components/responses/getNetworkPeeringDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "network-peering" ], "summary": "Delete peering", "description": "Deletes a network peering. It is required that the peering is in `disabled` state before delete is possible.\n", "operationId": "deleteNetworkPeering", "parameters": [ { "$ref": "#/components/parameters/deleteNetworkPeeringPeeringUuid" } ], "responses": { "204": { "$ref": "#/components/responses/deleteNetworkPeering204" }, "404": { "$ref": "#/components/responses/deleteNetworkPeering404" }, "default": { "$ref": "#/components/responses/deleteNetworkPeeringDefault" } }, "x-upcloud-visibility": "public" }, "patch": { "tags": [ "network-peering" ], "summary": "Modify peering", "description": "Modifies attributes of an existing network peering.", "operationId": "modifyNetworkPeering", "parameters": [ { "$ref": "#/components/parameters/modifyNetworkPeeringPeeringUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyNetworkPeering" }, "responses": { "200": { "$ref": "#/components/responses/modifyNetworkPeering200" }, "400": { "$ref": "#/components/responses/modifyNetworkPeering400" }, "404": { "$ref": "#/components/responses/modifyNetworkPeering404" }, "default": { "$ref": "#/components/responses/modifyNetworkPeeringDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/network": { "get": { "tags": [ "network" ], "summary": "List networks", "description": "Get a list of all networks.\n\nIt is also possible to filter networks with label URL parameters, e.g.\n`?label=env` or `?label=env%3Dprod`. URL parameter can be given multiple\ntimes to add more filters (e.g. `?label=env%3Dprod&label=v2`), where\nonly networks that match all labels are returned.\nLabel keys are matched case insensitively.\n", "operationId": "listNetworks", "parameters": [ { "$ref": "#/components/parameters/listNetworksLabel" } ], "responses": { "200": { "$ref": "#/components/responses/listNetworks200" }, "default": { "$ref": "#/components/responses/listNetworksDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "network" ], "summary": "Create SDN network", "description": "Creates a new SDN private network that cloud servers from the same zone can be attached to.", "operationId": "createNetwork", "requestBody": { "$ref": "#/components/requestBodies/createNetwork" }, "responses": { "201": { "$ref": "#/components/responses/createNetwork201" }, "default": { "$ref": "#/components/responses/createNetworkDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/network/interface": { "get": { "tags": [ "network" ], "summary": "List interfaces", "description": "Retrieves a list of network interfaces.", "operationId": "listNetworkInterfaces", "responses": { "200": { "$ref": "#/components/responses/listNetworkInterfaces200" }, "default": { "$ref": "#/components/responses/listNetworkInterfacesDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "network" ], "summary": "Create interface", "description": "Creates a new network interface.", "operationId": "createNetworkInterface", "requestBody": { "$ref": "#/components/requestBodies/createNetworkInterface" }, "responses": { "201": { "$ref": "#/components/responses/createNetworkInterface201" }, "default": { "$ref": "#/components/responses/createNetworkInterfaceDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/network/interface/{uuid}": { "get": { "tags": [ "network" ], "summary": "Get interface", "description": "Retrieves details of a specific network interface.", "operationId": "getNetworkInterfaceDetails", "parameters": [ { "$ref": "#/components/parameters/getNetworkInterfaceDetailsUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getNetworkInterfaceDetails200" }, "default": { "$ref": "#/components/responses/getNetworkInterfaceDetailsDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "network" ], "summary": "Delete interface", "description": "Deletes a specific network interface.", "operationId": "deleteNetworkInterface", "parameters": [ { "$ref": "#/components/parameters/deleteNetworkInterfaceUuid" } ], "responses": { "204": { "$ref": "#/components/responses/deleteNetworkInterface204" }, "default": { "$ref": "#/components/responses/deleteNetworkInterfaceDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/network/{uuid}": { "get": { "tags": [ "network" ], "summary": "Get network", "description": "Retrieves details of a specific network.", "operationId": "getNetworkDetails", "parameters": [ { "$ref": "#/components/parameters/getNetworkDetailsUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getNetworkDetails200" }, "default": { "$ref": "#/components/responses/getNetworkDetailsDefault" } }, "x-upcloud-visibility": "public" }, "put": { "tags": [ "network" ], "summary": "Modify network", "description": "Modifies the details of a specific SDN private network. The Utility and public networks cannot be modified.\n", "operationId": "modifyNetwork", "parameters": [ { "$ref": "#/components/parameters/modifyNetworkUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyNetwork" }, "responses": { "200": { "$ref": "#/components/responses/modifyNetwork200" }, "default": { "$ref": "#/components/responses/modifyNetworkDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "network" ], "summary": "Delete network", "description": "Deletes an SDN private network. All attached cloud servers must first be detached before SDN private networks can be deleted. Utility and public networks can only be detached from servers by [Releasing the corresponding IP addresses](https://upcloudltd.github.io/upcloud-openapi-spec/api/ip-address#delete-ip-address).\n", "operationId": "deleteNetwork", "parameters": [ { "$ref": "#/components/parameters/deleteNetworkUuid" } ], "responses": { "204": { "$ref": "#/components/responses/deleteNetwork204" }, "default": { "$ref": "#/components/responses/deleteNetworkDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/audit-logs": { "get": { "tags": [ "audit-logs" ], "summary": "List audit logs", "description": "Returns a list of audit log rows according to the query parameters. Note that this endpoint is paginated by default and the list is limited in results.\n\nPagination\nUpcloud-Total-Count header is included in the response to indicate the total number of audit logs available with the current query parameters (excluding limit and offset). The total count can be used for a number of pagination strategies. limit and offset query parameters can be used to finally paginate the results.", "operationId": "listAuditLogs", "parameters": [ { "$ref": "#/components/parameters/listAuditLogsQ" }, { "$ref": "#/components/parameters/listAuditLogsLimit" }, { "$ref": "#/components/parameters/listAuditLogsOffset" }, { "$ref": "#/components/parameters/listAuditLogsActions" }, { "$ref": "#/components/parameters/listAuditLogsOrigins" }, { "$ref": "#/components/parameters/listAuditLogsResourceTypes" }, { "$ref": "#/components/parameters/listAuditLogsCreatedAfter" }, { "$ref": "#/components/parameters/listAuditLogsCreatedBefore" } ], "responses": { "200": { "$ref": "#/components/responses/listAuditLogs200" }, "default": { "$ref": "#/components/responses/listAuditLogsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/audit-logs/export": { "get": { "tags": [ "audit-logs" ], "summary": "Export audit logs", "description": "Export all audit logs for the authenticated account as CSV or JSON (up to 180 day limit). Note: Use the format parameter to specify output format; only JSON schema is documented here.", "operationId": "exportAuditLogs", "parameters": [ { "$ref": "#/components/parameters/exportAuditLogsFormat" } ], "responses": { "200": { "$ref": "#/components/responses/exportAuditLogs200" }, "default": { "$ref": "#/components/responses/exportAuditLogsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/audit-logs/{cloudEventID}": { "get": { "tags": [ "audit-logs" ], "summary": "Get event details", "description": "Returns details of a single audit log event by its cloud event ID.", "operationId": "getAuditLog", "parameters": [ { "$ref": "#/components/parameters/auditLogsGetAuditLogCloudEventID" } ], "responses": { "200": { "$ref": "#/components/responses/auditLogsGetAuditLog200" }, "default": { "$ref": "#/components/responses/auditLogsGetAuditLogDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/audit-logs/filter-options": { "get": { "tags": [ "audit-logs" ], "summary": "Get filter options", "description": "Returns lists of available resource types, actions, and origins for filtering.", "operationId": "getFilterOptions", "responses": { "200": { "$ref": "#/components/responses/auditLogsGetFilterOptions200" }, "default": { "$ref": "#/components/responses/auditLogsGetFilterOptionsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/partner/accounts": { "get": { "tags": [ "partner" ], "summary": "Get account list", "description": "Returns list of accounts associated with the partner.", "operationId": "listPartnerAccounts", "responses": { "200": { "$ref": "#/components/responses/listPartnerAccounts200" }, "default": { "$ref": "#/components/responses/listPartnerAccountsDefault" } } }, "post": { "tags": [ "partner" ], "summary": "Create new account", "description": "Creates new UpCloud account that will be linked to partner's existing invoicing.", "operationId": "createPartnerAccount", "requestBody": { "$ref": "#/components/requestBodies/createPartnerAccount" }, "responses": { "201": { "$ref": "#/components/responses/createPartnerAccount201" }, "400": { "$ref": "#/components/responses/createPartnerAccount400" }, "403": { "$ref": "#/components/responses/createPartnerAccount403" }, "409": { "$ref": "#/components/responses/createPartnerAccount409" }, "default": { "$ref": "#/components/responses/createPartnerAccountDefault" } } } }, "/1.3/permission": { "get": { "tags": [ "permission" ], "summary": "List permissions", "description": "Retrieves a list of permissions for sub-accounts to access resources owned by the main account.", "operationId": "listPermissions", "responses": { "200": { "$ref": "#/components/responses/listPermissions200" }, "default": { "$ref": "#/components/responses/listPermissionsDefault" } }, "x-upcloud-visibility": "public" }, "put": { "tags": [ "permission" ], "summary": "Replace permissions", "description": "Replaces the entire set of permissions for sub-accounts to access resources owned by the main account.", "operationId": "replacePermissions", "requestBody": { "$ref": "#/components/requestBodies/replacePermissions" }, "responses": { "200": { "$ref": "#/components/responses/replacePermissions200" }, "default": { "$ref": "#/components/responses/replacePermissionsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/permission/grant": { "post": { "tags": [ "permission" ], "summary": "Grant permission", "description": "Grants a permission for a sub-account to access a resource owned by the main account.", "operationId": "grantPermission", "parameters": [ { "$ref": "#/components/parameters/grantPermissionSkipTargetCheck" } ], "requestBody": { "$ref": "#/components/requestBodies/grantPermission" }, "responses": { "200": { "$ref": "#/components/responses/grantPermission200" }, "default": { "$ref": "#/components/responses/grantPermissionDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/permission/revoke": { "post": { "tags": [ "permission" ], "summary": "Revoke permission", "description": "Revokes a permission for a sub-account to access a resource owned by the main account.", "operationId": "revokePermission", "requestBody": { "$ref": "#/components/requestBodies/revokePermission" }, "responses": { "204": { "$ref": "#/components/responses/revokePermission204" }, "default": { "$ref": "#/components/responses/revokePermissionDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/permission/revoke-all-from-target/{target_type}/{target_identifier}": { "post": { "tags": [ "permission" ], "summary": "Revoke all permissions by target", "description": "Revokes all permissions for sub-accounts to access a specific resource owned by the main account.", "operationId": "revokeAllPermissionsByTarget", "parameters": [ { "$ref": "#/components/parameters/revokeAllPermissionsByTargetTargetType" }, { "$ref": "#/components/parameters/revokeAllPermissionsByTargetTargetIdentifier" }, { "$ref": "#/components/parameters/revokeAllPermissionsByTargetMainAccountId" } ], "responses": { "204": { "$ref": "#/components/responses/revokeAllPermissionsByTarget204" }, "default": { "$ref": "#/components/responses/revokeAllPermissionsByTargetDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/permission/revoke-all-from-user/{user}": { "post": { "tags": [ "permission" ], "summary": "Revoke all permissions by user", "description": "Revokes all permissions for a specific sub-account to access any resources owned by the main account.", "operationId": "revokeAllPermissionsByUser", "parameters": [ { "$ref": "#/components/parameters/revokeAllPermissionsByUserUser" } ], "responses": { "204": { "$ref": "#/components/responses/revokeAllPermissionsByUser204" }, "default": { "$ref": "#/components/responses/revokeAllPermissionsByUserDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/plan": { "get": { "tags": [ "plan" ], "summary": "List available plans", "description": "Returns a list of available plans. All plans are available in all zones but pricing may differ. See _List prices_ for how to obtain current price list.\n\nIn addition to listed plans, server can be freely configured with \"custom\" plan which allows freely scalable CPU cores, memory amount and storage resources. __Note!__ Custom plans are available for new customers through contact with sales.\n", "operationId": "listPlans", "responses": { "200": { "$ref": "#/components/responses/listPlans200" }, "default": { "$ref": "#/components/responses/listPlansDefault" } } } }, "/1.3/price": { "get": { "tags": [ "price" ], "summary": "Returns a price list.", "description": "Returns a price list.", "operationId": "getPrice", "parameters": [ { "$ref": "#/components/parameters/getPriceZone" } ], "responses": { "200": { "$ref": "#/components/responses/getPrice200" }, "400": { "$ref": "#/components/responses/getPrice400" }, "default": { "$ref": "#/components/responses/getPriceDefault" } } } }, "/1.3/router": { "get": { "tags": [ "router" ], "summary": "List routers", "description": "Returns a list of all available routers associated with the current account.\n\nIt is also possible to filter routers with label URL parameters, e.g.\n`?label=env` or `?label=env%3Dprod`. URL parameter can be given multiple\ntimes to add more filters (e.g. `?label=env%3Dprod&label=v2`), where\nonly routers that match all labels are returned.\nLabel keys are matched case insensitively.\n", "operationId": "listRouters", "parameters": [ { "$ref": "#/components/parameters/listRoutersLabel" } ], "responses": { "200": { "$ref": "#/components/responses/listRouters200" }, "default": { "$ref": "#/components/responses/listRoutersDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "router" ], "summary": "Create router", "description": "Creates a new router.\nRouters can be used to connect multiple Private Networks. Cloud Servers on any attached network can communicate\ndirectly with each other.\n", "operationId": "createRouter", "requestBody": { "$ref": "#/components/requestBodies/createRouter" }, "responses": { "201": { "$ref": "#/components/responses/createRouter201" }, "400": { "$ref": "#/components/responses/createRouter400" }, "409": { "$ref": "#/components/responses/createRouter409" }, "default": { "$ref": "#/components/responses/createRouterDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/router/{router}": { "get": { "tags": [ "router" ], "summary": "Get router", "description": "Retrieves details of a specific router.", "operationId": "getRouter", "parameters": [ { "$ref": "#/components/parameters/getRouterRouter" } ], "responses": { "200": { "$ref": "#/components/responses/getRouter200" }, "404": { "$ref": "#/components/responses/getRouter404" }, "default": { "$ref": "#/components/responses/getRouterDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "router" ], "summary": "Delete router", "description": "Deletes a specific router.", "operationId": "deleteRouter", "parameters": [ { "$ref": "#/components/parameters/deleteRouterRouter" } ], "responses": { "204": { "$ref": "#/components/responses/deleteRouter204" }, "404": { "$ref": "#/components/responses/deleteRouter404" }, "409": { "$ref": "#/components/responses/deleteRouter409" }, "default": { "$ref": "#/components/responses/deleteRouterDefault" } }, "x-upcloud-visibility": "public" }, "patch": { "tags": [ "router" ], "summary": "Modify router", "description": "Modifies attributes of a specific router.\nModifications to static routes of type `service` will be ignored.\n", "operationId": "modifyRouter", "parameters": [ { "$ref": "#/components/parameters/modifyRouterRouter" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyRouter" }, "responses": { "200": { "$ref": "#/components/responses/modifyRouter200" }, "400": { "$ref": "#/components/responses/modifyRouter400" }, "404": { "$ref": "#/components/responses/modifyRouter404" }, "409": { "$ref": "#/components/responses/modifyRouter409" }, "default": { "$ref": "#/components/responses/modifyRouterDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server-group": { "get": { "tags": [ "server-group" ], "summary": "List server groups", "description": "Retrieves a list of server groups.", "operationId": "listServerGroups", "parameters": [ { "$ref": "#/components/parameters/listServerGroupsLabel" } ], "responses": { "200": { "$ref": "#/components/responses/listServerGroups200" }, "default": { "$ref": "#/components/responses/listServerGroupsDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "server-group" ], "summary": "Create server group", "description": "Creates a new server group.", "operationId": "createServerGroup", "requestBody": { "$ref": "#/components/requestBodies/createServerGroup" }, "responses": { "200": { "$ref": "#/components/responses/createServerGroup200" }, "default": { "$ref": "#/components/responses/createServerGroupDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server-group/{uuid}": { "get": { "tags": [ "server-group" ], "summary": "Get server group details", "description": "Retrieves details of a specific server group.", "operationId": "getServerGroup", "parameters": [ { "$ref": "#/components/parameters/getServerGroupUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getServerGroup200" }, "default": { "$ref": "#/components/responses/getServerGroupDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "server-group" ], "summary": "Delete server group", "description": "Deletes a specific server group.", "operationId": "deleteServerGroup", "parameters": [ { "$ref": "#/components/parameters/deleteServerGroupUuid" } ], "responses": { "204": { "$ref": "#/components/responses/deleteServerGroup204" }, "default": { "$ref": "#/components/responses/deleteServerGroupDefault" } }, "x-upcloud-visibility": "public" }, "patch": { "tags": [ "server-group" ], "summary": "Modify server group", "description": "Modifies an existing server group.", "operationId": "modifyServerGroup", "parameters": [ { "$ref": "#/components/parameters/modifyServerGroupUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyServerGroup" }, "responses": { "200": { "$ref": "#/components/responses/modifyServerGroup200" }, "default": { "$ref": "#/components/responses/modifyServerGroupDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server-group/{uuid}/servers": { "get": { "tags": [ "server-group" ], "summary": "List server group members", "description": "Retrieves a list of servers that are members of a specific server group.", "operationId": "listServerGroupMembers", "parameters": [ { "$ref": "#/components/parameters/listServerGroupMembersUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listServerGroupMembers200" }, "default": { "$ref": "#/components/responses/listServerGroupMembersDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "server-group" ], "summary": "Add server to group", "description": "Adds a server to a specific server group.", "operationId": "addServerToGroup", "parameters": [ { "$ref": "#/components/parameters/serverGroupAddServerToGroupUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/serverGroupAddServerToGroup" }, "responses": { "204": { "$ref": "#/components/responses/serverGroupAddServerToGroup204" }, "default": { "$ref": "#/components/responses/serverGroupAddServerToGroupDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server-group/{uuid}/servers/{server_uuid}": { "delete": { "tags": [ "server-group" ], "summary": "Remove server from group", "description": "Removes a server from a specific server group.", "operationId": "removeServerFromGroup", "parameters": [ { "$ref": "#/components/parameters/serverGroupRemoveServerFromGroupUuid" }, { "$ref": "#/components/parameters/serverGroupRemoveServerFromGroupServerUuid" } ], "responses": { "204": { "$ref": "#/components/responses/serverGroupRemoveServerFromGroup204" }, "default": { "$ref": "#/components/responses/serverGroupRemoveServerFromGroupDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server": { "get": { "tags": [ "server" ], "summary": "List Cloud Servers", "description": "Returns the most relevant information for Cloud Servers associated with the current account.", "operationId": "listServers", "parameters": [ { "$ref": "#/components/parameters/listServersLabel" }, { "$ref": "#/components/parameters/listServersUuid" }, { "$ref": "#/components/parameters/listServersHost" }, { "$ref": "#/components/parameters/listServersDevice" }, { "$ref": "#/components/parameters/listServersState" }, { "$ref": "#/components/parameters/listServersTag" }, { "$ref": "#/components/parameters/listServersSearch" }, { "$ref": "#/components/parameters/listServersSortBy" }, { "$ref": "#/components/parameters/listServersOrderBy" }, { "$ref": "#/components/parameters/listServersLimit" }, { "$ref": "#/components/parameters/listServersOffset" } ], "responses": { "200": { "$ref": "#/components/responses/listServers200" }, "400": { "$ref": "#/components/responses/listServers400" }, "403": { "$ref": "#/components/responses/listServers403" }, "404": { "$ref": "#/components/responses/listServers404" }, "409": { "$ref": "#/components/responses/listServers409" }, "default": { "$ref": "#/components/responses/listServersDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "server" ], "summary": "Create a new Cloud Server", "description": "Creates a new Cloud Server", "operationId": "createServer", "requestBody": { "$ref": "#/components/requestBodies/createServer" }, "responses": { "202": { "$ref": "#/components/responses/createServer202" }, "400": { "$ref": "#/components/responses/createServer400" }, "403": { "$ref": "#/components/responses/createServer403" }, "404": { "$ref": "#/components/responses/createServer404" }, "409": { "$ref": "#/components/responses/createServer409" }, "default": { "$ref": "#/components/responses/createServerDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/firewall_ruleset_relationships/private/{ruleset_uuid}": { "get": { "tags": [ "server" ], "summary": "List Cloud Servers related to a private firewall ruleset", "description": "Return Cloud Servers visible to the authenticated account that are related to a private firewall ruleset, including each Cloud Server's private ruleset relationships.", "operationId": "listFirewallRulesetRelationships", "parameters": [ { "$ref": "#/components/parameters/serverListFirewallRulesetRelationshipsRulesetUuid" } ], "responses": { "200": { "$ref": "#/components/responses/serverListFirewallRulesetRelationships200" }, "400": { "$ref": "#/components/responses/serverListFirewallRulesetRelationships400" }, "default": { "$ref": "#/components/responses/serverListFirewallRulesetRelationshipsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/labels": { "get": { "tags": [ "server" ], "summary": "List Cloud Server labels", "description": "Returns the unique label key-value pairs used by Cloud Servers accessible to the current account.", "operationId": "getLabels", "responses": { "200": { "$ref": "#/components/responses/serverGetLabels200" }, "default": { "$ref": "#/components/responses/serverGetLabelsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}": { "get": { "tags": [ "server" ], "summary": "Get Cloud Server details", "description": "Returns detailed information about a Cloud Server.", "operationId": "getServer", "parameters": [ { "$ref": "#/components/parameters/getServerUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getServer200" }, "400": { "$ref": "#/components/responses/getServer400" }, "403": { "$ref": "#/components/responses/getServer403" }, "404": { "$ref": "#/components/responses/getServer404" }, "default": { "$ref": "#/components/responses/getServerDefault" } }, "x-upcloud-visibility": "public" }, "put": { "tags": [ "server" ], "summary": "Modify an existing Cloud Server", "description": "Modifies an existing Cloud Server configuration.", "operationId": "modifyServer", "parameters": [ { "$ref": "#/components/parameters/modifyServerUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyServer" }, "responses": { "202": { "$ref": "#/components/responses/modifyServer202" }, "400": { "$ref": "#/components/responses/modifyServer400" }, "403": { "$ref": "#/components/responses/modifyServer403" }, "404": { "$ref": "#/components/responses/modifyServer404" }, "409": { "$ref": "#/components/responses/modifyServer409" }, "default": { "$ref": "#/components/responses/modifyServerDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "server" ], "summary": "Delete a Cloud Server", "description": "Deletes a stopped Cloud Server and releases its IP addresses. Deleting backups requires deleting the associated storage devices.", "operationId": "deleteServer", "parameters": [ { "$ref": "#/components/parameters/deleteServerUuid" }, { "$ref": "#/components/parameters/deleteServerStorages" }, { "$ref": "#/components/parameters/deleteServerBackups" } ], "responses": { "204": { "$ref": "#/components/responses/deleteServer204" }, "400": { "$ref": "#/components/responses/deleteServer400" }, "403": { "$ref": "#/components/responses/deleteServer403" }, "404": { "$ref": "#/components/responses/deleteServer404" }, "409": { "$ref": "#/components/responses/deleteServer409" }, "default": { "$ref": "#/components/responses/deleteServerDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/attach_firewall_ruleset/private": { "post": { "tags": [ "server" ], "summary": "Attach a private firewall ruleset", "description": "Attach a private, stateful firewall ruleset to a Cloud Server. The latest ruleset version is selected and applied to private network interfaces.", "operationId": "attachPrivateFirewallRuleset", "parameters": [ { "$ref": "#/components/parameters/serverAttachPrivateFirewallRulesetUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/serverAttachPrivateFirewallRuleset" }, "responses": { "200": { "$ref": "#/components/responses/serverAttachPrivateFirewallRuleset200" }, "400": { "$ref": "#/components/responses/serverAttachPrivateFirewallRuleset400" }, "403": { "$ref": "#/components/responses/serverAttachPrivateFirewallRuleset403" }, "404": { "$ref": "#/components/responses/serverAttachPrivateFirewallRuleset404" }, "409": { "$ref": "#/components/responses/serverAttachPrivateFirewallRuleset409" }, "default": { "$ref": "#/components/responses/serverAttachPrivateFirewallRulesetDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/cancel": { "post": { "tags": [ "server" ], "summary": "Cancel a Cloud Server operation", "description": "Cancels an operation while the Cloud Server is in maintenance state.", "operationId": "cancelServerOperation", "parameters": [ { "$ref": "#/components/parameters/cancelServerOperationUuid" } ], "responses": { "204": { "$ref": "#/components/responses/cancelServerOperation204" }, "400": { "$ref": "#/components/responses/cancelServerOperation400" }, "403": { "$ref": "#/components/responses/cancelServerOperation403" }, "404": { "$ref": "#/components/responses/cancelServerOperation404" }, "409": { "$ref": "#/components/responses/cancelServerOperation409" }, "default": { "$ref": "#/components/responses/cancelServerOperationDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/cdrom/eject": { "post": { "tags": [ "server" ], "summary": "Eject the CD-ROM image from a Cloud Server", "description": "Eject the storage from the Cloud Server's attached CD-ROM device.", "operationId": "ejectCDROM", "parameters": [ { "$ref": "#/components/parameters/serverEjectCDROMUuid" } ], "responses": { "200": { "$ref": "#/components/responses/serverEjectCDROM200" }, "400": { "$ref": "#/components/responses/serverEjectCDROM400" }, "403": { "$ref": "#/components/responses/serverEjectCDROM403" }, "404": { "$ref": "#/components/responses/serverEjectCDROM404" }, "409": { "$ref": "#/components/responses/serverEjectCDROM409" }, "511": { "$ref": "#/components/responses/serverEjectCDROM511" }, "default": { "$ref": "#/components/responses/serverEjectCDROMDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/cdrom/load": { "post": { "tags": [ "server" ], "summary": "Load a CD-ROM image into a Cloud Server", "description": "Load a storage of type normal or cdrom into the Cloud Server's attached CD-ROM device. If media is already loaded, it is ejected first.", "operationId": "loadCDROM", "parameters": [ { "$ref": "#/components/parameters/serverLoadCDROMUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/serverLoadCDROM" }, "responses": { "200": { "$ref": "#/components/responses/serverLoadCDROM200" }, "400": { "$ref": "#/components/responses/serverLoadCDROM400" }, "403": { "$ref": "#/components/responses/serverLoadCDROM403" }, "404": { "$ref": "#/components/responses/serverLoadCDROM404" }, "409": { "$ref": "#/components/responses/serverLoadCDROM409" }, "511": { "$ref": "#/components/responses/serverLoadCDROM511" }, "default": { "$ref": "#/components/responses/serverLoadCDROMDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/detach_firewall_ruleset/private": { "post": { "tags": [ "server" ], "summary": "Detach a private firewall ruleset", "description": "Detach a private firewall ruleset from a Cloud Server and reapply private-interface firewall rules.", "operationId": "detachPrivateFirewallRuleset", "parameters": [ { "$ref": "#/components/parameters/serverDetachPrivateFirewallRulesetUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/serverDetachPrivateFirewallRuleset" }, "responses": { "200": { "$ref": "#/components/responses/serverDetachPrivateFirewallRuleset200" }, "400": { "$ref": "#/components/responses/serverDetachPrivateFirewallRuleset400" }, "403": { "$ref": "#/components/responses/serverDetachPrivateFirewallRuleset403" }, "404": { "$ref": "#/components/responses/serverDetachPrivateFirewallRuleset404" }, "409": { "$ref": "#/components/responses/serverDetachPrivateFirewallRuleset409" }, "default": { "$ref": "#/components/responses/serverDetachPrivateFirewallRulesetDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/firewall_rule": { "get": { "tags": [ "server" ], "summary": "List firewall rules", "description": "Return the Cloud Server firewall rules in evaluation order. Changes to firewall rules can take 1-2 minutes to take effect.", "operationId": "listFirewallRules", "parameters": [ { "$ref": "#/components/parameters/serverListFirewallRulesUuid" } ], "responses": { "200": { "$ref": "#/components/responses/serverListFirewallRules200" }, "400": { "$ref": "#/components/responses/serverListFirewallRules400" }, "403": { "$ref": "#/components/responses/serverListFirewallRules403" }, "404": { "$ref": "#/components/responses/serverListFirewallRules404" }, "default": { "$ref": "#/components/responses/serverListFirewallRulesDefault" } }, "x-upcloud-visibility": "public" }, "put": { "tags": [ "server" ], "summary": "Replace firewall rules", "description": "Replace the Cloud Server's complete firewall rule chain. Array order determines rule positions. Changes can take 1-2 minutes to take effect.", "operationId": "updateFirewallRules", "parameters": [ { "$ref": "#/components/parameters/serverUpdateFirewallRulesUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/serverUpdateFirewallRules" }, "responses": { "204": { "$ref": "#/components/responses/serverUpdateFirewallRules204" }, "400": { "$ref": "#/components/responses/serverUpdateFirewallRules400" }, "403": { "$ref": "#/components/responses/serverUpdateFirewallRules403" }, "404": { "$ref": "#/components/responses/serverUpdateFirewallRules404" }, "409": { "$ref": "#/components/responses/serverUpdateFirewallRules409" }, "default": { "$ref": "#/components/responses/serverUpdateFirewallRulesDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "server" ], "summary": "Create a firewall rule", "description": "Create a firewall rule. Rules are evaluated in position order; if position is omitted, the rule is appended. Changes can take 1-2 minutes to take effect.", "operationId": "createFirewallRule", "parameters": [ { "$ref": "#/components/parameters/serverCreateFirewallRuleUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/serverCreateFirewallRule" }, "responses": { "201": { "$ref": "#/components/responses/serverCreateFirewallRule201" }, "400": { "$ref": "#/components/responses/serverCreateFirewallRule400" }, "403": { "$ref": "#/components/responses/serverCreateFirewallRule403" }, "404": { "$ref": "#/components/responses/serverCreateFirewallRule404" }, "409": { "$ref": "#/components/responses/serverCreateFirewallRule409" }, "default": { "$ref": "#/components/responses/serverCreateFirewallRuleDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/firewall_rule/{position}": { "get": { "tags": [ "server" ], "summary": "Get a firewall rule", "description": "Return the firewall rule at the specified one-based position in the Cloud Server rule chain.", "operationId": "getFirewallRule", "parameters": [ { "$ref": "#/components/parameters/serverGetFirewallRuleUuid" }, { "$ref": "#/components/parameters/serverGetFirewallRulePosition" } ], "responses": { "200": { "$ref": "#/components/responses/serverGetFirewallRule200" }, "400": { "$ref": "#/components/responses/serverGetFirewallRule400" }, "403": { "$ref": "#/components/responses/serverGetFirewallRule403" }, "404": { "$ref": "#/components/responses/serverGetFirewallRule404" }, "default": { "$ref": "#/components/responses/serverGetFirewallRuleDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "server" ], "summary": "Delete a firewall rule", "description": "Delete the firewall rule at the specified one-based position. Remaining rules are renumbered. Changes can take 1-2 minutes to take effect.", "operationId": "deleteFirewallRule", "parameters": [ { "$ref": "#/components/parameters/serverDeleteFirewallRuleUuid" }, { "$ref": "#/components/parameters/serverDeleteFirewallRulePosition" } ], "responses": { "204": { "$ref": "#/components/responses/serverDeleteFirewallRule204" }, "400": { "$ref": "#/components/responses/serverDeleteFirewallRule400" }, "403": { "$ref": "#/components/responses/serverDeleteFirewallRule403" }, "404": { "$ref": "#/components/responses/serverDeleteFirewallRule404" }, "409": { "$ref": "#/components/responses/serverDeleteFirewallRule409" }, "default": { "$ref": "#/components/responses/serverDeleteFirewallRuleDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/firewall_ruleset_relationships/private": { "get": { "tags": [ "server" ], "summary": "List private firewall ruleset relationships for a Cloud Server", "description": "Return all private firewall ruleset relationships configured for a Cloud Server.", "operationId": "listPrivateFirewallRulesetRelationships", "parameters": [ { "$ref": "#/components/parameters/serverListPrivateFirewallRulesetRelationshipsUuid" } ], "responses": { "200": { "$ref": "#/components/responses/serverListPrivateFirewallRulesetRelationships200" }, "400": { "$ref": "#/components/responses/serverListPrivateFirewallRulesetRelationships400" }, "403": { "$ref": "#/components/responses/serverListPrivateFirewallRulesetRelationships403" }, "404": { "$ref": "#/components/responses/serverListPrivateFirewallRulesetRelationships404" }, "default": { "$ref": "#/components/responses/serverListPrivateFirewallRulesetRelationshipsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/gpus": { "get": { "tags": [ "server" ], "summary": "List Cloud Server GPUs", "description": "Returns GPUs attached to a Cloud Server.", "operationId": "listServerGPUs", "parameters": [ { "$ref": "#/components/parameters/listServerGPUsUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listServerGPUs200" }, "400": { "$ref": "#/components/responses/listServerGPUs400" }, "403": { "$ref": "#/components/responses/listServerGPUs403" }, "404": { "$ref": "#/components/responses/listServerGPUs404" }, "default": { "$ref": "#/components/responses/listServerGPUsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/networking": { "get": { "tags": [ "server" ], "summary": "Get Cloud Server networking details", "description": "Return all network interfaces and IP addresses configured for a Cloud Server.", "operationId": "getServerNetworking", "parameters": [ { "$ref": "#/components/parameters/getServerNetworkingUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getServerNetworking200" }, "400": { "$ref": "#/components/responses/getServerNetworking400" }, "403": { "$ref": "#/components/responses/getServerNetworking403" }, "404": { "$ref": "#/components/responses/getServerNetworking404" }, "default": { "$ref": "#/components/responses/getServerNetworkingDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/networking/interface": { "post": { "tags": [ "server" ], "summary": "Add a network interface", "description": "Add a network interface to a stopped Cloud Server. A private interface must identify the SDN network to attach. The combined limit of network interfaces and storage devices is 24.", "operationId": "addServerInterface", "parameters": [ { "$ref": "#/components/parameters/addServerInterfaceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/addServerInterface" }, "responses": { "201": { "$ref": "#/components/responses/addServerInterface201" }, "400": { "$ref": "#/components/responses/addServerInterface400" }, "403": { "$ref": "#/components/responses/addServerInterface403" }, "404": { "$ref": "#/components/responses/addServerInterface404" }, "409": { "$ref": "#/components/responses/addServerInterface409" }, "default": { "$ref": "#/components/responses/addServerInterfaceDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/networking/interface/{index}": { "put": { "tags": [ "server" ], "summary": "Modify a network interface", "description": "Modify the IP addresses, source IP filtering, boot setting, or index of a network interface on a stopped Cloud Server. Changing the interface network or type is not supported.", "operationId": "modifyServerInterface", "parameters": [ { "$ref": "#/components/parameters/modifyServerInterfaceUuid" }, { "$ref": "#/components/parameters/modifyServerInterfaceIndex" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyServerInterface" }, "responses": { "200": { "$ref": "#/components/responses/modifyServerInterface200" }, "400": { "$ref": "#/components/responses/modifyServerInterface400" }, "403": { "$ref": "#/components/responses/modifyServerInterface403" }, "404": { "$ref": "#/components/responses/modifyServerInterface404" }, "409": { "$ref": "#/components/responses/modifyServerInterface409" }, "default": { "$ref": "#/components/responses/modifyServerInterfaceDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "server" ], "summary": "Delete a network interface", "description": "Delete a network interface from a stopped Cloud Server. IP addresses attached to the interface are released according to their release policies.", "operationId": "deleteServerInterface", "parameters": [ { "$ref": "#/components/parameters/deleteServerInterfaceUuid" }, { "$ref": "#/components/parameters/deleteServerInterfaceIndex" } ], "responses": { "204": { "$ref": "#/components/responses/deleteServerInterface204" }, "400": { "$ref": "#/components/responses/deleteServerInterface400" }, "403": { "$ref": "#/components/responses/deleteServerInterface403" }, "404": { "$ref": "#/components/responses/deleteServerInterface404" }, "409": { "$ref": "#/components/responses/deleteServerInterface409" }, "default": { "$ref": "#/components/responses/deleteServerInterfaceDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/networking/interface/{index}/ip_address": { "post": { "tags": [ "server" ], "summary": "Add an IP address to a network interface", "description": "Add an IPv4 or IPv6 address to a private network interface. The interface cannot contain addresses from both families and can have at most five addresses.", "operationId": "addServerInterfaceIpAddress", "parameters": [ { "$ref": "#/components/parameters/addServerInterfaceIpAddressUuid" }, { "$ref": "#/components/parameters/addServerInterfaceIpAddressIndex" }, { "$ref": "#/components/parameters/addServerInterfaceIpAddressForce" } ], "requestBody": { "$ref": "#/components/requestBodies/addServerInterfaceIpAddress" }, "responses": { "201": { "$ref": "#/components/responses/addServerInterfaceIpAddress201" }, "400": { "$ref": "#/components/responses/addServerInterfaceIpAddress400" }, "403": { "$ref": "#/components/responses/addServerInterfaceIpAddress403" }, "404": { "$ref": "#/components/responses/addServerInterfaceIpAddress404" }, "409": { "$ref": "#/components/responses/addServerInterfaceIpAddress409" }, "default": { "$ref": "#/components/responses/addServerInterfaceIpAddressDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/networking/interface/{index}/ip_address/{ip}": { "delete": { "tags": [ "server" ], "summary": "Delete an IP address from a network interface", "description": "Delete an IP address from a private network interface. At least one IP address must remain attached to the interface.", "operationId": "deleteServerInterfaceIpAddress", "parameters": [ { "$ref": "#/components/parameters/deleteServerInterfaceIpAddressUuid" }, { "$ref": "#/components/parameters/deleteServerInterfaceIpAddressIndex" }, { "$ref": "#/components/parameters/deleteServerInterfaceIpAddressIp" } ], "responses": { "204": { "$ref": "#/components/responses/deleteServerInterfaceIpAddress204" }, "400": { "$ref": "#/components/responses/deleteServerInterfaceIpAddress400" }, "403": { "$ref": "#/components/responses/deleteServerInterfaceIpAddress403" }, "404": { "$ref": "#/components/responses/deleteServerInterfaceIpAddress404" }, "409": { "$ref": "#/components/responses/deleteServerInterfaceIpAddress409" }, "default": { "$ref": "#/components/responses/deleteServerInterfaceIpAddressDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/rebuild": { "post": { "tags": [ "server" ], "summary": "Rebuild a Cloud Server", "description": "Reinstalls a stopped Cloud Server from a public template.", "operationId": "rebuildServer", "parameters": [ { "$ref": "#/components/parameters/rebuildServerUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/rebuildServer" }, "responses": { "202": { "$ref": "#/components/responses/rebuildServer202" }, "400": { "$ref": "#/components/responses/rebuildServer400" }, "403": { "$ref": "#/components/responses/rebuildServer403" }, "404": { "$ref": "#/components/responses/rebuildServer404" }, "409": { "$ref": "#/components/responses/rebuildServer409" }, "default": { "$ref": "#/components/responses/rebuildServerDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/relocate": { "post": { "tags": [ "server" ], "summary": "Relocate a Cloud Server to another zone", "description": "Relocates a stopped Cloud Server to another zone in the same physical location (datacenter).", "operationId": "relocateServer", "parameters": [ { "$ref": "#/components/parameters/relocateServerUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/relocateServer" }, "responses": { "200": { "$ref": "#/components/responses/relocateServer200" }, "400": { "$ref": "#/components/responses/relocateServer400" }, "403": { "$ref": "#/components/responses/relocateServer403" }, "404": { "$ref": "#/components/responses/relocateServer404" }, "409": { "$ref": "#/components/responses/relocateServer409" }, "default": { "$ref": "#/components/responses/relocateServerDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/remote_access_details": { "get": { "tags": [ "server" ], "summary": "Get remote access connection details", "description": "Returns remote access settings and VNC connection details for a Cloud Server.", "operationId": "getRemoteAccessDetails", "parameters": [ { "$ref": "#/components/parameters/serverGetRemoteAccessDetailsUuid" } ], "responses": { "200": { "$ref": "#/components/responses/serverGetRemoteAccessDetails200" }, "400": { "$ref": "#/components/responses/serverGetRemoteAccessDetails400" }, "403": { "$ref": "#/components/responses/serverGetRemoteAccessDetails403" }, "404": { "$ref": "#/components/responses/serverGetRemoteAccessDetails404" }, "default": { "$ref": "#/components/responses/serverGetRemoteAccessDetailsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/restart": { "post": { "tags": [ "server" ], "summary": "Restart a Cloud Server", "description": "Stops and starts a Cloud Server in started state.", "operationId": "restartServer", "parameters": [ { "$ref": "#/components/parameters/restartServerUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/restartServer" }, "responses": { "200": { "$ref": "#/components/responses/restartServer200" }, "400": { "$ref": "#/components/responses/restartServer400" }, "403": { "$ref": "#/components/responses/restartServer403" }, "404": { "$ref": "#/components/responses/restartServer404" }, "409": { "$ref": "#/components/responses/restartServer409" }, "default": { "$ref": "#/components/responses/restartServerDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/start": { "post": { "tags": [ "server" ], "summary": "Start a Cloud Server", "description": "Starts a Cloud Server in stopped state.", "operationId": "startServer", "parameters": [ { "$ref": "#/components/parameters/startServerUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/startServer" }, "responses": { "200": { "$ref": "#/components/responses/startServer200" }, "400": { "$ref": "#/components/responses/startServer400" }, "403": { "$ref": "#/components/responses/startServer403" }, "404": { "$ref": "#/components/responses/startServer404" }, "409": { "$ref": "#/components/responses/startServer409" }, "default": { "$ref": "#/components/responses/startServerDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/stats/cpu": { "get": { "tags": [ "server" ], "summary": "Get Cloud Server CPU statistics", "description": "Returns CPU usage statistics for all supported periods.", "operationId": "getCPUStats", "parameters": [ { "$ref": "#/components/parameters/serverGetCPUStatsUuid" } ], "responses": { "200": { "$ref": "#/components/responses/serverGetCPUStats200" }, "400": { "$ref": "#/components/responses/serverGetCPUStats400" }, "403": { "$ref": "#/components/responses/serverGetCPUStats403" }, "404": { "$ref": "#/components/responses/serverGetCPUStats404" }, "default": { "$ref": "#/components/responses/serverGetCPUStatsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/stats/cpu/{period}": { "get": { "tags": [ "server" ], "summary": "Get Cloud Server CPU statistics by period", "description": "Returns CPU usage statistics for the selected period.", "operationId": "getCPUStatsByPeriod", "parameters": [ { "$ref": "#/components/parameters/serverGetCPUStatsByPeriodUuid" }, { "$ref": "#/components/parameters/serverGetCPUStatsByPeriodPeriod" } ], "responses": { "200": { "$ref": "#/components/responses/serverGetCPUStatsByPeriod200" }, "400": { "$ref": "#/components/responses/serverGetCPUStatsByPeriod400" }, "403": { "$ref": "#/components/responses/serverGetCPUStatsByPeriod403" }, "404": { "$ref": "#/components/responses/serverGetCPUStatsByPeriod404" }, "default": { "$ref": "#/components/responses/serverGetCPUStatsByPeriodDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/stats/disk/{type}": { "get": { "tags": [ "server" ], "summary": "Get Cloud Server disk statistics", "description": "Returns aggregate disk read and write statistics for all supported periods.", "operationId": "getDiskStats", "parameters": [ { "$ref": "#/components/parameters/serverGetDiskStatsUuid" }, { "$ref": "#/components/parameters/serverGetDiskStatsType" } ], "responses": { "200": { "$ref": "#/components/responses/serverGetDiskStats200" }, "400": { "$ref": "#/components/responses/serverGetDiskStats400" }, "403": { "$ref": "#/components/responses/serverGetDiskStats403" }, "404": { "$ref": "#/components/responses/serverGetDiskStats404" }, "default": { "$ref": "#/components/responses/serverGetDiskStatsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/stats/disk/{type}/{period}": { "get": { "tags": [ "server" ], "summary": "Get Cloud Server disk statistics by period", "description": "Returns aggregate disk read and write statistics for the selected period.", "operationId": "getDiskStatsByPeriod", "parameters": [ { "$ref": "#/components/parameters/serverGetDiskStatsByPeriodUuid" }, { "$ref": "#/components/parameters/serverGetDiskStatsByPeriodType" }, { "$ref": "#/components/parameters/serverGetDiskStatsByPeriodPeriod" } ], "responses": { "200": { "$ref": "#/components/responses/serverGetDiskStatsByPeriod200" }, "400": { "$ref": "#/components/responses/serverGetDiskStatsByPeriod400" }, "403": { "$ref": "#/components/responses/serverGetDiskStatsByPeriod403" }, "404": { "$ref": "#/components/responses/serverGetDiskStatsByPeriod404" }, "default": { "$ref": "#/components/responses/serverGetDiskStatsByPeriodDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/stats/network/{type}": { "get": { "tags": [ "server" ], "summary": "Get Cloud Server network statistics", "description": "Returns aggregate inbound and outbound network statistics for all interfaces and periods.", "operationId": "getNetworkStats", "parameters": [ { "$ref": "#/components/parameters/serverGetNetworkStatsUuid" }, { "$ref": "#/components/parameters/serverGetNetworkStatsType" } ], "responses": { "200": { "$ref": "#/components/responses/serverGetNetworkStats200" }, "400": { "$ref": "#/components/responses/serverGetNetworkStats400" }, "403": { "$ref": "#/components/responses/serverGetNetworkStats403" }, "404": { "$ref": "#/components/responses/serverGetNetworkStats404" }, "default": { "$ref": "#/components/responses/serverGetNetworkStatsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/stats/network/{type}/{network}": { "get": { "tags": [ "server" ], "summary": "Get Cloud Server network statistics by network type", "description": "Returns inbound and outbound network statistics for the selected network type and all periods.", "operationId": "getNetworkStatsByNetwork", "parameters": [ { "$ref": "#/components/parameters/serverGetNetworkStatsByNetworkUuid" }, { "$ref": "#/components/parameters/serverGetNetworkStatsByNetworkType" }, { "$ref": "#/components/parameters/serverGetNetworkStatsByNetworkNetwork" } ], "responses": { "200": { "$ref": "#/components/responses/serverGetNetworkStatsByNetwork200" }, "400": { "$ref": "#/components/responses/serverGetNetworkStatsByNetwork400" }, "403": { "$ref": "#/components/responses/serverGetNetworkStatsByNetwork403" }, "404": { "$ref": "#/components/responses/serverGetNetworkStatsByNetwork404" }, "default": { "$ref": "#/components/responses/serverGetNetworkStatsByNetworkDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/stats/network/{type}/{network}/{period}": { "get": { "tags": [ "server" ], "summary": "Get Cloud Server network statistics by network type and period", "description": "Returns inbound and outbound network statistics for the selected network type and period.", "operationId": "getNetworkStatsByNetworkAndPeriod", "parameters": [ { "$ref": "#/components/parameters/serverGetNetworkStatsByNetworkAndPeriodUuid" }, { "$ref": "#/components/parameters/serverGetNetworkStatsByNetworkAndPeriodType" }, { "$ref": "#/components/parameters/serverGetNetworkStatsByNetworkAndPeriodNetwork" }, { "$ref": "#/components/parameters/serverGetNetworkStatsByNetworkAndPeriodPeriod" } ], "responses": { "200": { "$ref": "#/components/responses/serverGetNetworkStatsByNetworkAndPeriod200" }, "400": { "$ref": "#/components/responses/serverGetNetworkStatsByNetworkAndPeriod400" }, "403": { "$ref": "#/components/responses/serverGetNetworkStatsByNetworkAndPeriod403" }, "404": { "$ref": "#/components/responses/serverGetNetworkStatsByNetworkAndPeriod404" }, "default": { "$ref": "#/components/responses/serverGetNetworkStatsByNetworkAndPeriodDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/stop": { "post": { "tags": [ "server" ], "summary": "Stop a Cloud Server", "description": "Stops a Cloud Server in started state.", "operationId": "stopServer", "parameters": [ { "$ref": "#/components/parameters/stopServerUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/stopServer" }, "responses": { "200": { "$ref": "#/components/responses/stopServer200" }, "400": { "$ref": "#/components/responses/stopServer400" }, "403": { "$ref": "#/components/responses/stopServer403" }, "404": { "$ref": "#/components/responses/stopServer404" }, "409": { "$ref": "#/components/responses/stopServer409" }, "default": { "$ref": "#/components/responses/stopServerDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/storage/attach": { "post": { "tags": [ "server" ], "summary": "Attach a storage device to a Cloud Server", "description": "Attach a storage resource as a disk or CD-ROM device to a Cloud Server. SCSI and virtio disks can be attached while the Cloud Server is started; IDE and CD-ROM devices require a stopped Cloud Server. An empty CD-ROM device can be attached without specifying a storage resource.", "operationId": "attachStorageDevice", "parameters": [ { "$ref": "#/components/parameters/serverAttachStorageDeviceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/serverAttachStorageDevice" }, "responses": { "200": { "$ref": "#/components/responses/serverAttachStorageDevice200" }, "400": { "$ref": "#/components/responses/serverAttachStorageDevice400" }, "403": { "$ref": "#/components/responses/serverAttachStorageDevice403" }, "404": { "$ref": "#/components/responses/serverAttachStorageDevice404" }, "409": { "$ref": "#/components/responses/serverAttachStorageDevice409" }, "default": { "$ref": "#/components/responses/serverAttachStorageDeviceDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/storage/detach": { "post": { "tags": [ "server" ], "summary": "Detach a storage device from a Cloud Server", "description": "Detach a storage device identified by its device address or storage resource UUID. IDE and CD-ROM devices cannot be detached while the Cloud Server is started.", "operationId": "detachStorageDevice", "parameters": [ { "$ref": "#/components/parameters/serverDetachStorageDeviceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/serverDetachStorageDevice" }, "responses": { "200": { "$ref": "#/components/responses/serverDetachStorageDevice200" }, "400": { "$ref": "#/components/responses/serverDetachStorageDevice400" }, "403": { "$ref": "#/components/responses/serverDetachStorageDevice403" }, "404": { "$ref": "#/components/responses/serverDetachStorageDevice404" }, "409": { "$ref": "#/components/responses/serverDetachStorageDevice409" }, "511": { "$ref": "#/components/responses/serverDetachStorageDevice511" }, "default": { "$ref": "#/components/responses/serverDetachStorageDeviceDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server/{uuid}/vnc_details": { "get": { "tags": [ "server" ], "summary": "Get VNC connection details", "description": "Returns VNC connection details and remote access settings for a Cloud Server.", "operationId": "getVNCDetails", "parameters": [ { "$ref": "#/components/parameters/serverGetVNCDetailsUuid" } ], "responses": { "200": { "$ref": "#/components/responses/serverGetVNCDetails200" }, "400": { "$ref": "#/components/responses/serverGetVNCDetails400" }, "403": { "$ref": "#/components/responses/serverGetVNCDetails403" }, "404": { "$ref": "#/components/responses/serverGetVNCDetails404" }, "default": { "$ref": "#/components/responses/serverGetVNCDetailsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server_size": { "get": { "tags": [ "server_size" ], "summary": "List server sizes", "description": "Retrieves a list of available server sizes (combinations of memory and CPU cores).", "operationId": "listServerSizes", "responses": { "200": { "$ref": "#/components/responses/listServerSizes200" }, "default": { "$ref": "#/components/responses/listServerSizesDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/server_size/limits": { "get": { "tags": [ "server_size" ], "summary": "Get server size limits", "description": "Retrieves the minimum and maximum limits for server sizes, including any zone-specific limits for private zones.", "operationId": "getServerSizeLimits", "responses": { "200": { "$ref": "#/components/responses/getServerSizeLimits200" }, "default": { "$ref": "#/components/responses/getServerSizeLimitsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/storage": { "get": { "tags": [ "storage" ], "summary": "List storage resources", "description": "Returns all storage resources accessible to the account. The results can be filtered by labels or a title and UUID search, sorted, and paginated.", "operationId": "getStorageList", "parameters": [ { "$ref": "#/components/parameters/getStorageListLabel" }, { "$ref": "#/components/parameters/getStorageListSearch" }, { "$ref": "#/components/parameters/getStorageListSortBy" }, { "$ref": "#/components/parameters/getStorageListOrderBy" }, { "$ref": "#/components/parameters/getStorageListLimit" }, { "$ref": "#/components/parameters/getStorageListOffset" } ], "responses": { "200": { "$ref": "#/components/responses/getStorageList200" }, "400": { "$ref": "#/components/responses/getStorageList400" }, "default": { "$ref": "#/components/responses/getStorageListDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "storage" ], "summary": "Create Block Storage", "description": "Creates a block storage resource in a specific zone. The new block storage is not attached to a Cloud Server.", "operationId": "createStorage", "requestBody": { "$ref": "#/components/requestBodies/createStorage" }, "responses": { "201": { "$ref": "#/components/responses/createStorage201" }, "default": { "$ref": "#/components/responses/createStorageDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/storage/backup": { "get": { "tags": [ "storage" ], "summary": "List storage backups", "description": "Returns accessible storage resources whose type is `backup`.", "operationId": "getStorageListByBackup", "parameters": [ { "$ref": "#/components/parameters/getStorageListByBackupLabel" }, { "$ref": "#/components/parameters/getStorageListByBackupSearch" }, { "$ref": "#/components/parameters/getStorageListByBackupSortBy" }, { "$ref": "#/components/parameters/getStorageListByBackupOrderBy" }, { "$ref": "#/components/parameters/getStorageListByBackupLimit" }, { "$ref": "#/components/parameters/getStorageListByBackupOffset" } ], "responses": { "200": { "$ref": "#/components/responses/getStorageListByBackup200" }, "400": { "$ref": "#/components/responses/getStorageListByBackup400" }, "default": { "$ref": "#/components/responses/getStorageListByBackupDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/storage/cdrom": { "get": { "tags": [ "storage" ], "summary": "List CD-ROM images", "description": "Returns accessible storage resources whose type is `cdrom`.", "operationId": "getStorageListByCdrom", "parameters": [ { "$ref": "#/components/parameters/getStorageListByCdromLabel" }, { "$ref": "#/components/parameters/getStorageListByCdromSearch" }, { "$ref": "#/components/parameters/getStorageListByCdromSortBy" }, { "$ref": "#/components/parameters/getStorageListByCdromOrderBy" }, { "$ref": "#/components/parameters/getStorageListByCdromLimit" }, { "$ref": "#/components/parameters/getStorageListByCdromOffset" } ], "responses": { "200": { "$ref": "#/components/responses/getStorageListByCdrom200" }, "400": { "$ref": "#/components/responses/getStorageListByCdrom400" }, "default": { "$ref": "#/components/responses/getStorageListByCdromDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/storage/favorite": { "get": { "tags": [ "storage" ], "summary": "List favorite storage resources", "description": "Returns the public templates and CD-ROM images that the account has marked as favorites.", "operationId": "getFavoriteStorageList", "responses": { "200": { "$ref": "#/components/responses/getFavoriteStorageList200" }, "default": { "$ref": "#/components/responses/getFavoriteStorageListDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/storage/normal": { "get": { "tags": [ "storage" ], "summary": "List normal Block Storage", "description": "Returns accessible Block Storage resources whose type is `normal`.", "operationId": "getStorageListByNormal", "parameters": [ { "$ref": "#/components/parameters/getStorageListByNormalLabel" }, { "$ref": "#/components/parameters/getStorageListByNormalSearch" }, { "$ref": "#/components/parameters/getStorageListByNormalSortBy" }, { "$ref": "#/components/parameters/getStorageListByNormalOrderBy" }, { "$ref": "#/components/parameters/getStorageListByNormalLimit" }, { "$ref": "#/components/parameters/getStorageListByNormalOffset" } ], "responses": { "200": { "$ref": "#/components/responses/getStorageListByNormal200" }, "400": { "$ref": "#/components/responses/getStorageListByNormal400" }, "default": { "$ref": "#/components/responses/getStorageListByNormalDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/storage/private": { "get": { "tags": [ "storage" ], "summary": "List private storage resources", "description": "Returns accessible storage resources whose access type is `private`.", "operationId": "getStorageListByPrivateAccess", "parameters": [ { "$ref": "#/components/parameters/getStorageListByPrivateAccessLabel" }, { "$ref": "#/components/parameters/getStorageListByPrivateAccessSearch" }, { "$ref": "#/components/parameters/getStorageListByPrivateAccessSortBy" }, { "$ref": "#/components/parameters/getStorageListByPrivateAccessOrderBy" }, { "$ref": "#/components/parameters/getStorageListByPrivateAccessLimit" }, { "$ref": "#/components/parameters/getStorageListByPrivateAccessOffset" } ], "responses": { "200": { "$ref": "#/components/responses/getStorageListByPrivateAccess200" }, "400": { "$ref": "#/components/responses/getStorageListByPrivateAccess400" }, "default": { "$ref": "#/components/responses/getStorageListByPrivateAccessDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/storage/public": { "get": { "tags": [ "storage" ], "summary": "List public storage resources", "description": "Returns accessible storage resources whose access type is `public`.", "operationId": "getStorageListByPublicAccess", "parameters": [ { "$ref": "#/components/parameters/getStorageListByPublicAccessLabel" }, { "$ref": "#/components/parameters/getStorageListByPublicAccessSearch" }, { "$ref": "#/components/parameters/getStorageListByPublicAccessSortBy" }, { "$ref": "#/components/parameters/getStorageListByPublicAccessOrderBy" }, { "$ref": "#/components/parameters/getStorageListByPublicAccessLimit" }, { "$ref": "#/components/parameters/getStorageListByPublicAccessOffset" } ], "responses": { "200": { "$ref": "#/components/responses/getStorageListByPublicAccess200" }, "400": { "$ref": "#/components/responses/getStorageListByPublicAccess400" }, "default": { "$ref": "#/components/responses/getStorageListByPublicAccessDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/storage/template": { "get": { "tags": [ "storage" ], "summary": "List storage templates", "description": "Returns accessible storage resources whose type is `template`.", "operationId": "getStorageListByTemplate", "parameters": [ { "$ref": "#/components/parameters/getStorageListByTemplateLabel" }, { "$ref": "#/components/parameters/getStorageListByTemplateSearch" }, { "$ref": "#/components/parameters/getStorageListByTemplateSortBy" }, { "$ref": "#/components/parameters/getStorageListByTemplateOrderBy" }, { "$ref": "#/components/parameters/getStorageListByTemplateLimit" }, { "$ref": "#/components/parameters/getStorageListByTemplateOffset" } ], "responses": { "200": { "$ref": "#/components/responses/getStorageListByTemplate200" }, "400": { "$ref": "#/components/responses/getStorageListByTemplate400" }, "default": { "$ref": "#/components/responses/getStorageListByTemplateDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/storage/{type}/{access}": { "get": { "tags": [ "storage" ], "summary": "List storage resources by type and access", "description": "Returns accessible storage resources matching both the requested storage type and access type.", "operationId": "getStorageListByTypeAndAccess", "parameters": [ { "$ref": "#/components/parameters/getStorageListByTypeAndAccessType" }, { "$ref": "#/components/parameters/getStorageListByTypeAndAccessAccess" }, { "$ref": "#/components/parameters/getStorageListByTypeAndAccessLabel" }, { "$ref": "#/components/parameters/getStorageListByTypeAndAccessSearch" }, { "$ref": "#/components/parameters/getStorageListByTypeAndAccessSortBy" }, { "$ref": "#/components/parameters/getStorageListByTypeAndAccessOrderBy" }, { "$ref": "#/components/parameters/getStorageListByTypeAndAccessLimit" }, { "$ref": "#/components/parameters/getStorageListByTypeAndAccessOffset" } ], "responses": { "200": { "$ref": "#/components/responses/getStorageListByTypeAndAccess200" }, "400": { "$ref": "#/components/responses/getStorageListByTypeAndAccess400" }, "default": { "$ref": "#/components/responses/getStorageListByTypeAndAccessDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/storage/{uuid}": { "get": { "tags": [ "storage" ], "summary": "Get storage resource details", "description": "Returns detailed information about a storage resource, including its current state, attachments, labels, and backup configuration when applicable.", "operationId": "getStorageInfo", "parameters": [ { "$ref": "#/components/parameters/getStorageInfoUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getStorageInfo200" }, "404": { "$ref": "#/components/responses/getStorageInfo404" }, "default": { "$ref": "#/components/responses/getStorageInfoDefault" } }, "x-upcloud-visibility": "public" }, "put": { "tags": [ "storage" ], "summary": "Modify Block Storage", "description": "Modifies a block storage title, labels, automatic backup rule, or size. A new size must be greater than the current size. Set `filesystem_resize` to `yes` to also resize the last partition and its supported filesystem after increasing the block storage size.", "operationId": "modifyStorage", "parameters": [ { "$ref": "#/components/parameters/modifyStorageUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyStorage" }, "responses": { "200": { "$ref": "#/components/responses/modifyStorage200" }, "default": { "$ref": "#/components/responses/modifyStorageDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "storage" ], "summary": "Delete storage resource", "description": "Schedules an unattached private storage resource for deletion. Associated backups are kept by default unless another backup policy is selected.", "operationId": "deleteStorage", "parameters": [ { "$ref": "#/components/parameters/deleteStorageUuid" }, { "$ref": "#/components/parameters/deleteStorageBackups" } ], "responses": { "204": { "$ref": "#/components/responses/deleteStorage204" }, "default": { "$ref": "#/components/responses/deleteStorageDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/storage/{uuid}/attach": { "post": { "tags": [ "storage" ], "summary": "Attach storage to a Cloud Server", "description": "Attaches the storage resource to a Cloud Server in the same zone. The device defaults to a disk at the next available address. IDE and CD-ROM devices can be attached only while the Cloud Server is stopped; SCSI and VirtIO disks can also be attached while it is running.", "operationId": "attachStorageToServer", "parameters": [ { "$ref": "#/components/parameters/attachStorageToServerUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/attachStorageToServer" }, "responses": { "200": { "$ref": "#/components/responses/attachStorageToServer200" }, "default": { "$ref": "#/components/responses/attachStorageToServerDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/storage/{uuid}/backup": { "post": { "tags": [ "storage" ], "summary": "Create on-demand backup", "description": "Creates a point-in-time backup of private normal block storage. The operation is asynchronous: the source block storage is `backuping` while the backup is created, and the returned backup remains in `maintenance` until it is ready.", "operationId": "createOnDemandBackup", "parameters": [ { "$ref": "#/components/parameters/storageCreateOnDemandBackupUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/storageCreateOnDemandBackup" }, "responses": { "201": { "$ref": "#/components/responses/storageCreateOnDemandBackup201" }, "default": { "$ref": "#/components/responses/storageCreateOnDemandBackupDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/storage/{uuid}/cancel": { "post": { "tags": [ "storage" ], "summary": "Cancel Block Storage operation", "description": "Requests cancellation of an interruptible operation on block storage in the `maintenance` state. For a running clone, cancellation removes the incomplete copy and returns the source block storage to the `online` state.", "operationId": "cancelStorageOperation", "parameters": [ { "$ref": "#/components/parameters/cancelStorageOperationUuid" } ], "responses": { "204": { "$ref": "#/components/responses/cancelStorageOperation204" }, "default": { "$ref": "#/components/responses/cancelStorageOperationDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/storage/{uuid}/clone": { "post": { "tags": [ "storage" ], "summary": "Clone Block Storage", "description": "Creates a Block Storage copy of a storage resource. Cloning is asynchronous: the returned block storage remains in the `maintenance` state until the operation completes and can be monitored with the storage resource details endpoint.", "operationId": "cloneStorage", "parameters": [ { "$ref": "#/components/parameters/cloneStorageUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/cloneStorage" }, "responses": { "201": { "$ref": "#/components/responses/cloneStorage201" }, "404": { "$ref": "#/components/responses/cloneStorage404" }, "default": { "$ref": "#/components/responses/cloneStorageDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/storage/{uuid}/detach": { "post": { "tags": [ "storage" ], "summary": "Detach storage from a Cloud Server", "description": "Detaches the storage resource from its attached Cloud Server. IDE and CD-ROM devices can be detached only while the Cloud Server is stopped; SCSI and VirtIO disks can also be detached while it is running. If the storage resource is already detached, it is returned unchanged.", "operationId": "detachStorageFromServer", "parameters": [ { "$ref": "#/components/parameters/detachStorageFromServerUuid" } ], "responses": { "200": { "$ref": "#/components/responses/detachStorageFromServer200" }, "default": { "$ref": "#/components/responses/detachStorageFromServerDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/storage/{uuid}/favorite": { "post": { "tags": [ "storage" ], "summary": "Add storage resource to favorites", "description": "Adds an accessible storage resource to the account's favorites. The operation succeeds if the storage resource is already a favorite.", "operationId": "addStorageToFavorites", "parameters": [ { "$ref": "#/components/parameters/addStorageToFavoritesUuid" } ], "responses": { "204": { "$ref": "#/components/responses/addStorageToFavorites204" }, "default": { "$ref": "#/components/responses/addStorageToFavoritesDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "storage" ], "summary": "Remove storage resource from favorites", "description": "Removes an accessible storage resource from the account's favorites. The operation succeeds if the storage resource is not a favorite.", "operationId": "removeStorageFromFavorites", "parameters": [ { "$ref": "#/components/parameters/removeStorageFromFavoritesUuid" } ], "responses": { "204": { "$ref": "#/components/responses/removeStorageFromFavorites204" }, "default": { "$ref": "#/components/responses/removeStorageFromFavoritesDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/storage/{uuid}/resize": { "post": { "tags": [ "storage" ], "summary": "Resize Block Storage partition and filesystem", "description": "Resizes the last partition and its supported filesystem to use the block storage capacity already available. A backup is created before the operation and returned on success. Increase the block storage capacity first with the modify block storage endpoint.", "operationId": "resizeStorage", "parameters": [ { "$ref": "#/components/parameters/resizeStorageUuid" } ], "responses": { "200": { "$ref": "#/components/responses/resizeStorage200" }, "default": { "$ref": "#/components/responses/resizeStorageDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/storage/{uuid}/restore": { "post": { "tags": [ "storage" ], "summary": "Restore Block Storage from backup", "description": "Starts restoring the backup identified by `uuid` to its origin block storage. If the origin block storage is attached to a Cloud Server, the Cloud Server must be stopped.", "operationId": "restoreStorageFromBackup", "parameters": [ { "$ref": "#/components/parameters/restoreStorageFromBackupUuid" } ], "responses": { "204": { "$ref": "#/components/responses/restoreStorageFromBackup204" }, "default": { "$ref": "#/components/responses/restoreStorageFromBackupDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/storage/{uuid}/templatize": { "post": { "tags": [ "storage" ], "summary": "Create template from Block Storage", "description": "Creates a private template from private normal block storage. The operation is asynchronous: the returned template remains in `maintenance` until it is ready. Deployments from the template use the source block storage tier.", "operationId": "createTemplateFromStorage", "parameters": [ { "$ref": "#/components/parameters/createTemplateFromStorageUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createTemplateFromStorage" }, "responses": { "201": { "$ref": "#/components/responses/createTemplateFromStorage201" }, "default": { "$ref": "#/components/responses/createTemplateFromStorageDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/tag": { "get": { "tags": [ "tag" ], "summary": "List existing tags", "description": "Returns all existing tags with their properties and servers tagged.", "operationId": "listTags", "responses": { "200": { "$ref": "#/components/responses/listTags200" }, "default": { "$ref": "#/components/responses/listTagsDefault" } } }, "post": { "tags": [ "tag" ], "summary": "Create a new tag", "description": "Creates a new tag. Existing servers can be tagged in same request.", "operationId": "createTag", "requestBody": { "$ref": "#/components/requestBodies/createTag" }, "responses": { "200": { "$ref": "#/components/responses/createTag200" }, "400": { "$ref": "#/components/responses/createTag400" }, "403": { "$ref": "#/components/responses/createTag403" }, "409": { "$ref": "#/components/responses/createTag409" }, "default": { "$ref": "#/components/responses/createTagDefault" } } } }, "/1.3/tag/{name}": { "get": { "tags": [ "tag" ], "summary": "Get tag details", "description": "Returns details for a specific tag.", "operationId": "getTag", "parameters": [ { "$ref": "#/components/parameters/getTagName" } ], "responses": { "200": { "$ref": "#/components/responses/getTag200" }, "400": { "$ref": "#/components/responses/getTag400" }, "403": { "$ref": "#/components/responses/getTag403" }, "404": { "$ref": "#/components/responses/getTag404" }, "default": { "$ref": "#/components/responses/getTagDefault" } } }, "put": { "tags": [ "tag" ], "summary": "Modify existing tag", "description": "Changes attributes of an existing tag", "operationId": "modifyTag", "parameters": [ { "$ref": "#/components/parameters/modifyTagName" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyTag" }, "responses": { "200": { "$ref": "#/components/responses/modifyTag200" }, "400": { "$ref": "#/components/responses/modifyTag400" }, "403": { "$ref": "#/components/responses/modifyTag403" }, "404": { "$ref": "#/components/responses/modifyTag404" }, "default": { "$ref": "#/components/responses/modifyTagDefault" } } }, "delete": { "tags": [ "tag" ], "summary": "Delete a tag", "description": "Deletes a specific tag.", "operationId": "deleteTag", "parameters": [ { "$ref": "#/components/parameters/deleteTagName" } ], "responses": { "204": { "$ref": "#/components/responses/deleteTag204" }, "400": { "$ref": "#/components/responses/deleteTag400" }, "403": { "$ref": "#/components/responses/deleteTag403" }, "404": { "$ref": "#/components/responses/deleteTag404" }, "default": { "$ref": "#/components/responses/deleteTagDefault" } } } }, "/1.3/timezone": { "get": { "tags": [ "timezone" ], "summary": "List timezones", "description": "Retrieves a list of supported timezones.", "operationId": "listTimezones", "responses": { "200": { "$ref": "#/components/responses/listTimezones200" }, "default": { "$ref": "#/components/responses/listTimezonesDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/account/tokens": { "get": { "tags": [ "account-tokens" ], "summary": "List API tokens", "description": "List all tokens for the currently authorized account.\nThe tokens are returned in a paged format, with the default page size being 20.\nThe maximum page size is 100.\n", "operationId": "listTokens", "parameters": [ { "$ref": "#/components/parameters/accountTokensListTokensLimit" }, { "$ref": "#/components/parameters/accountTokensListTokensOffset" }, { "$ref": "#/components/parameters/accountTokensListTokensGui" }, { "$ref": "#/components/parameters/accountTokensListTokensSort" } ], "responses": { "200": { "$ref": "#/components/responses/accountTokensListTokens200" }, "401": { "$ref": "#/components/responses/accountTokensListTokens401" }, "default": { "$ref": "#/components/responses/accountTokensListTokensDefault" } } }, "post": { "tags": [ "account-tokens" ], "summary": "Create an API token", "description": "Create a new API token. Maximum token validity is 24*365h=8760h (~1 year).\nAttribute allowed_ip_prefixes allows defining a list of CIDR/IP addresses from where the token is accepted.\nEmpty list denies access from everywhere. If unset, the default list will be the IP filters of the account. If no IP filters are defined for the account either, the default will be [\"0.0.0.0/0\", \"::0/0\"], i.e. allow from any address.\n", "operationId": "createToken", "requestBody": { "$ref": "#/components/requestBodies/accountTokensCreateToken" }, "responses": { "201": { "$ref": "#/components/responses/accountTokensCreateToken201" }, "400": { "$ref": "#/components/responses/accountTokensCreateToken400" }, "401": { "$ref": "#/components/responses/accountTokensCreateToken401" }, "403": { "$ref": "#/components/responses/accountTokensCreateToken403" }, "409": { "$ref": "#/components/responses/accountTokensCreateToken409" }, "default": { "$ref": "#/components/responses/accountTokensCreateTokenDefault" } } } }, "/1.3/account/tokens/{token-uuid}": { "get": { "tags": [ "account-tokens" ], "summary": "Get token details", "description": "Get the details of a specific API token.", "operationId": "getToken", "parameters": [ { "$ref": "#/components/parameters/accountTokensGetTokenTokenUuid" } ], "responses": { "200": { "$ref": "#/components/responses/accountTokensGetToken200" }, "401": { "$ref": "#/components/responses/accountTokensGetToken401" }, "404": { "$ref": "#/components/responses/accountTokensGetToken404" }, "default": { "$ref": "#/components/responses/accountTokensGetTokenDefault" } } }, "delete": { "tags": [ "account-tokens" ], "summary": "Revoke a token", "description": "Revoke a specific API token.", "operationId": "revokeToken", "parameters": [ { "$ref": "#/components/parameters/accountTokensRevokeTokenTokenUuid" } ], "responses": { "204": { "$ref": "#/components/responses/accountTokensRevokeToken204" }, "401": { "$ref": "#/components/responses/accountTokensRevokeToken401" }, "404": { "$ref": "#/components/responses/accountTokensRevokeToken404" }, "default": { "$ref": "#/components/responses/accountTokensRevokeTokenDefault" } } } }, "/1.3/object-storage-2": { "get": { "tags": [ "object-storage-2" ], "summary": "List services", "description": "Returns a list of object storage services.", "operationId": "listObjectStorages", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ListObjectStoragesLimit" }, { "$ref": "#/components/parameters/objectStorage2ListObjectStoragesOffset" }, { "$ref": "#/components/parameters/objectStorage2ListObjectStoragesSort" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2ListObjectStorages200" }, "default": { "$ref": "#/components/responses/objectStorage2ListObjectStoragesDefault" } } }, "post": { "tags": [ "object-storage-2" ], "summary": "Create service", "description": "Creates a new object storage service.", "operationId": "createObjectStorage", "requestBody": { "$ref": "#/components/requestBodies/objectStorage2CreateObjectStorage" }, "responses": { "201": { "$ref": "#/components/responses/createObjectStorage201" }, "default": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageDefault" } } } }, "/1.3/object-storage-2/{service-uuid}": { "get": { "tags": [ "object-storage-2" ], "summary": "Get service details", "description": "Returns object storage service details by given {service_uuid}.", "operationId": "getObjectStorage", "parameters": [ { "$ref": "#/components/parameters/objectStorage2GetObjectStorageServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getObjectStorage200" }, "default": { "$ref": "#/components/responses/objectStorage2GetObjectStorageDefault" } } }, "put": { "tags": [ "object-storage-2" ], "summary": "Replace service", "description": "Replaces existing object storage service by given {service_uuid}.", "operationId": "replaceObjectStorage", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ReplaceObjectStorageServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2ReplaceObjectStorage" }, "responses": { "200": { "$ref": "#/components/responses/replaceObjectStorage200" }, "default": { "$ref": "#/components/responses/objectStorage2ReplaceObjectStorageDefault" } } }, "delete": { "tags": [ "object-storage-2" ], "summary": "Delete service", "description": "Deletes existing object storage service by given {service_uuid}.", "operationId": "deleteObjectStorage", "parameters": [ { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageForce" } ], "responses": { "204": { "$ref": "#/components/responses/deleteObjectStorage204" }, "default": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageDefault" } } }, "patch": { "tags": [ "object-storage-2" ], "summary": "Modify service", "description": "Modifies existing object storage service by given {service_uuid}.", "operationId": "modifyObjectStorage", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ModifyObjectStorageServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2ModifyObjectStorage" }, "responses": { "200": { "$ref": "#/components/responses/modifyObjectStorage200" }, "default": { "$ref": "#/components/responses/objectStorage2ModifyObjectStorageDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/networks": { "get": { "tags": [ "object-storage-2" ], "summary": "List networks", "description": "Returns a list of available service networks by given {service_uuid}.", "operationId": "listObjectStorageNetworks", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ListObjectStorageNetworksServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2ListObjectStorageNetworks200" }, "default": { "$ref": "#/components/responses/objectStorage2ListObjectStorageNetworksDefault" } } }, "post": { "tags": [ "object-storage-2" ], "summary": "Create network", "description": "Creates a new service network by given {service_uuid}.", "operationId": "createObjectStorageNetwork", "parameters": [ { "$ref": "#/components/parameters/objectStorage2CreateObjectStorageNetworkServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2CreateObjectStorageNetwork" }, "responses": { "201": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageNetwork201" }, "default": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageNetworkDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/networks/{network-name}": { "get": { "tags": [ "object-storage-2" ], "summary": "Get network details", "description": "Returns service network details by given {service_uuid} and {network_name}.", "operationId": "getObjectStorageNetwork", "parameters": [ { "$ref": "#/components/parameters/objectStorage2GetObjectStorageNetworkServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2GetObjectStorageNetworkNetworkName" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2GetObjectStorageNetwork200" }, "default": { "$ref": "#/components/responses/objectStorage2GetObjectStorageNetworkDefault" } } }, "delete": { "tags": [ "object-storage-2" ], "summary": "Delete network", "description": "Deletes existing network by given {service_uuid} and {network_name}.", "operationId": "deleteObjectStorageNetwork", "parameters": [ { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageNetworkServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageNetworkNetworkName" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageNetwork204" }, "default": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageNetworkDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/custom-domains": { "get": { "tags": [ "object-storage-2" ], "summary": "List custom domains", "description": "Returns a list of custom domains attached to a service by given {service_uuid}.", "operationId": "listObjectStorageCustomDomains", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ListObjectStorageCustomDomainsServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2ListObjectStorageCustomDomains200" }, "default": { "$ref": "#/components/responses/objectStorage2ListObjectStorageCustomDomainsDefault" } } }, "post": { "tags": [ "object-storage-2" ], "summary": "Attach custom domain", "description": "Attaches a new custom domain to the service identified by {service_uuid}.", "operationId": "attachObjectStorageCustomDomain", "parameters": [ { "$ref": "#/components/parameters/objectStorage2AttachObjectStorageCustomDomainServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2AttachObjectStorageCustomDomain" }, "responses": { "201": { "$ref": "#/components/responses/objectStorage2AttachObjectStorageCustomDomain201" }, "default": { "$ref": "#/components/responses/objectStorage2AttachObjectStorageCustomDomainDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/custom-domains/{custom-domain-name}": { "get": { "tags": [ "object-storage-2" ], "summary": "Get custom domain details", "description": "Returns custom domain details by given {service_uuid} and {domain_name}.", "operationId": "getObjectStorageCustomDomain", "parameters": [ { "$ref": "#/components/parameters/objectStorage2GetObjectStorageCustomDomainServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2GetObjectStorageCustomDomainCustomDomainName" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2GetObjectStorageCustomDomain200" }, "default": { "$ref": "#/components/responses/objectStorage2GetObjectStorageCustomDomainDefault" } } }, "delete": { "tags": [ "object-storage-2" ], "summary": "Delete custom domain", "description": "Deletes existing custom domain by given {service_uuid} and {domain_name}.", "operationId": "deleteObjectStorageCustomDomain", "parameters": [ { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageCustomDomainServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageCustomDomainCustomDomainName" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageCustomDomain204" }, "default": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageCustomDomainDefault" } } }, "patch": { "tags": [ "object-storage-2" ], "summary": "Modify custom domain", "description": "Modifies existing custom domain by given {service_uuid} and {domain_name}.", "operationId": "modifyObjectStorageCustomDomain", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ModifyObjectStorageCustomDomainServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2ModifyObjectStorageCustomDomainCustomDomainName" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2ModifyObjectStorageCustomDomain" }, "responses": { "200": { "$ref": "#/components/responses/objectStorage2ModifyObjectStorageCustomDomain200" }, "default": { "$ref": "#/components/responses/objectStorage2ModifyObjectStorageCustomDomainDefault" } } } }, "/1.3/object-storage-2/regions": { "get": { "tags": [ "object-storage-2" ], "summary": "List regions", "description": "Returns a list of available managed object storage regions.", "operationId": "listObjectStorageRegions", "responses": { "200": { "$ref": "#/components/responses/objectStorage2ListObjectStorageRegions200" }, "default": { "$ref": "#/components/responses/objectStorage2ListObjectStorageRegionsDefault" } } } }, "/1.3/object-storage-2/regions/{region-name}": { "get": { "tags": [ "object-storage-2" ], "summary": "Get region details", "description": "Returns object storage region details by given {name}.", "operationId": "getObjectStorageRegion", "parameters": [ { "$ref": "#/components/parameters/objectStorage2GetObjectStorageRegionRegionName" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2GetObjectStorageRegion200" }, "default": { "$ref": "#/components/responses/objectStorage2GetObjectStorageRegionDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/metrics": { "get": { "tags": [ "object-storage-2" ], "summary": "Get service metrics", "description": "Returns object storage metrics by given {service_uuid}.", "operationId": "getObjectStorageMetrics", "parameters": [ { "$ref": "#/components/parameters/objectStorage2GetObjectStorageMetricsServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2GetObjectStorageMetrics200" }, "default": { "$ref": "#/components/responses/objectStorage2GetObjectStorageMetricsDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/buckets": { "get": { "tags": [ "object-storage-2" ], "summary": "List bucket metrics", "description": "Returns metrics for buckets within a service.", "operationId": "listObjectStorageBucketMetrics", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ListObjectStorageBucketMetricsServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2ListObjectStorageBucketMetricsLimit" }, { "$ref": "#/components/parameters/objectStorage2ListObjectStorageBucketMetricsOffset" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2ListObjectStorageBucketMetrics200" }, "default": { "$ref": "#/components/responses/objectStorage2ListObjectStorageBucketMetricsDefault" } } }, "post": { "tags": [ "object-storage-2" ], "summary": "Create bucket", "description": "Creates a new service bucket by the given {service_uuid}.", "operationId": "createObjectStorageBucket", "parameters": [ { "$ref": "#/components/parameters/objectStorage2CreateObjectStorageBucketServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2CreateObjectStorageBucket" }, "responses": { "201": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageBucket201" }, "default": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageBucketDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/buckets/{bucket-name}": { "delete": { "tags": [ "object-storage-2" ], "summary": "Delete bucket", "description": "Deletes an existing bucket by given {service_uuid} and {bucket_name}. This API call will remove all objects from the bucket permanently and cannot be reversed.", "operationId": "deleteObjectStorageBucket", "parameters": [ { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageBucketServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageBucketBucketName" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageBucket204" }, "default": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageBucketDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/metrics/series": { "get": { "tags": [ "object-storage-2" ], "summary": "List service metrics series", "description": "Returns Object Storage instance metrics series by a given {service_uuid}.", "operationId": "listObjectStorageMetricsSeries", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ListObjectStorageMetricsSeriesServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2ListObjectStorageMetricsSeriesFrom" }, { "$ref": "#/components/parameters/objectStorage2ListObjectStorageMetricsSeriesTo" }, { "$ref": "#/components/parameters/objectStorage2ListObjectStorageMetricsSeriesInterval" }, { "$ref": "#/components/parameters/objectStorage2ListObjectStorageMetricsSeriesSort" }, { "$ref": "#/components/parameters/objectStorage2ListObjectStorageMetricsSeriesLimit" }, { "$ref": "#/components/parameters/objectStorage2ListObjectStorageMetricsSeriesOffset" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2ListObjectStorageMetricsSeries200" }, "default": { "$ref": "#/components/responses/objectStorage2ListObjectStorageMetricsSeriesDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/labels": { "get": { "tags": [ "object-storage-2" ], "summary": "List labels", "description": "Returns a list of available service labels by given {service_uuid}.", "operationId": "listObjectStorageLabels", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ListObjectStorageLabelsServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2ListObjectStorageLabels200" }, "default": { "$ref": "#/components/responses/objectStorage2ListObjectStorageLabelsDefault" } } }, "post": { "tags": [ "object-storage-2" ], "summary": "Create label", "description": "Creates a new label by given {service_uuid}. Labels are used for service filtering.", "operationId": "createObjectStorageLabel", "parameters": [ { "$ref": "#/components/parameters/objectStorage2CreateObjectStorageLabelServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2CreateObjectStorageLabel" }, "responses": { "201": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageLabel201" }, "default": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageLabelDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/labels/{label-key}": { "get": { "tags": [ "object-storage-2" ], "summary": "Get label details", "description": "Returns label details by given {service_uuid} and {key}.", "operationId": "getObjectStorageLabel", "parameters": [ { "$ref": "#/components/parameters/objectStorage2GetObjectStorageLabelServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2GetObjectStorageLabelLabelKey" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2GetObjectStorageLabel200" }, "default": { "$ref": "#/components/responses/objectStorage2GetObjectStorageLabelDefault" } } }, "delete": { "tags": [ "object-storage-2" ], "summary": "Delete label", "description": "Deletes existing label by given {service_uuid} and {key}.", "operationId": "deleteObjectStorageLabel", "parameters": [ { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageLabelServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageLabelLabelKey" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageLabel204" }, "default": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageLabelDefault" } } }, "patch": { "tags": [ "object-storage-2" ], "summary": "Modify label", "description": "Modifies existing label by given {service_uuid} and {key}.", "operationId": "modifyObjectStorageLabel", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ModifyObjectStorageLabelServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2ModifyObjectStorageLabelLabelKey" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2ModifyObjectStorageLabel" }, "responses": { "200": { "$ref": "#/components/responses/objectStorage2ModifyObjectStorageLabel200" }, "default": { "$ref": "#/components/responses/objectStorage2ModifyObjectStorageLabelDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/static-websites": { "get": { "tags": [ "object-storage-2" ], "summary": "List static website configurations", "description": "Returns all static website configurations for a service along with available domains.", "operationId": "listObjectStorageStaticWebsites", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ListObjectStorageStaticWebsitesServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2ListObjectStorageStaticWebsites200" }, "default": { "$ref": "#/components/responses/objectStorage2ListObjectStorageStaticWebsitesDefault" } } }, "post": { "tags": [ "object-storage-2" ], "summary": "Create static website configuration", "description": "Creates a new static website hosting configuration for a domain.", "operationId": "createObjectStorageStaticWebsite", "parameters": [ { "$ref": "#/components/parameters/objectStorage2CreateObjectStorageStaticWebsiteServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2CreateObjectStorageStaticWebsite" }, "responses": { "201": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageStaticWebsite201" }, "default": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageStaticWebsiteDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/static-websites/{custom-domain-name}": { "get": { "tags": [ "object-storage-2" ], "summary": "Get static website configuration", "description": "Returns a static website configuration for a specific domain.", "operationId": "getObjectStorageStaticWebsite", "parameters": [ { "$ref": "#/components/parameters/objectStorage2GetObjectStorageStaticWebsiteServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2GetObjectStorageStaticWebsiteCustomDomainName" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2GetObjectStorageStaticWebsite200" }, "default": { "$ref": "#/components/responses/objectStorage2GetObjectStorageStaticWebsiteDefault" } } }, "delete": { "tags": [ "object-storage-2" ], "summary": "Delete static website configuration", "description": "Deletes a static website configuration.", "operationId": "deleteObjectStorageStaticWebsite", "parameters": [ { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageStaticWebsiteServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageStaticWebsiteCustomDomainName" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageStaticWebsite204" }, "default": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageStaticWebsiteDefault" } } }, "patch": { "tags": [ "object-storage-2" ], "summary": "Modify static website configuration", "description": "Updates an existing static website configuration.", "operationId": "modifyObjectStorageStaticWebsite", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ModifyObjectStorageStaticWebsiteServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2ModifyObjectStorageStaticWebsiteCustomDomainName" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2ModifyObjectStorageStaticWebsite" }, "responses": { "200": { "$ref": "#/components/responses/objectStorage2ModifyObjectStorageStaticWebsite200" }, "default": { "$ref": "#/components/responses/objectStorage2ModifyObjectStorageStaticWebsiteDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/domains": { "get": { "tags": [ "object-storage-2" ], "summary": "List service domains", "description": "Returns all domains associated with this service (public endpoint, private endpoint, custom domains) along with their static website hosting status.", "operationId": "listObjectStorageDomains", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ListObjectStorageDomainsServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2ListObjectStorageDomains200" }, "default": { "$ref": "#/components/responses/objectStorage2ListObjectStorageDomainsDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/users": { "get": { "tags": [ "object-storage-2" ], "summary": "List users", "description": "Returns a list of available service users by given {service_uuid}.", "operationId": "listObjectStorageUsers", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ListObjectStorageUsersServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2ListObjectStorageUsers200" }, "default": { "$ref": "#/components/responses/objectStorage2ListObjectStorageUsersDefault" } } }, "post": { "tags": [ "object-storage-2" ], "summary": "Create user", "description": "Creates a new service user by given {service_uuid}.", "operationId": "createObjectStorageUser", "parameters": [ { "$ref": "#/components/parameters/objectStorage2CreateObjectStorageUserServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2CreateObjectStorageUser" }, "responses": { "201": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageUser201" }, "default": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageUserDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/users/{username}": { "get": { "tags": [ "object-storage-2" ], "summary": "Get user details", "description": "Returns service user details by given {service_uuid} and {username}.", "operationId": "getObjectStorageUser", "parameters": [ { "$ref": "#/components/parameters/objectStorage2GetObjectStorageUserServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2GetObjectStorageUserUsername" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2GetObjectStorageUser200" }, "default": { "$ref": "#/components/responses/objectStorage2GetObjectStorageUserDefault" } } }, "delete": { "tags": [ "object-storage-2" ], "summary": "Delete user", "description": "Deletes existing user by given {service_uuid} and {username}.", "operationId": "deleteObjectStorageUser", "parameters": [ { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageUserServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageUserUsername" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageUser204" }, "default": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageUserDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/users/{username}/access-keys": { "get": { "tags": [ "object-storage-2" ], "summary": "List access keys", "description": "Returns a list of available access keys for a user.", "operationId": "listObjectStorageAccessKeys", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ListObjectStorageAccessKeysServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2ListObjectStorageAccessKeysUsername" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2ListObjectStorageAccessKeys200" }, "default": { "$ref": "#/components/responses/objectStorage2ListObjectStorageAccessKeysDefault" } } }, "post": { "tags": [ "object-storage-2" ], "summary": "Create access key", "description": "Creates a new access key by given {service_uuid} and {username}.", "operationId": "createObjectStorageAccessKey", "parameters": [ { "$ref": "#/components/parameters/objectStorage2CreateObjectStorageAccessKeyServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2CreateObjectStorageAccessKeyUsername" } ], "responses": { "201": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageAccessKey201" }, "default": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageAccessKeyDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/users/{username}/access-keys/{access-key-id}": { "get": { "tags": [ "object-storage-2" ], "summary": "Get access key details", "description": "Returns access key details by given {service_uuid}, {username}, and {access-key-id}.", "operationId": "getObjectStorageAccessKeyDetails", "parameters": [ { "$ref": "#/components/parameters/objectStorage2GetObjectStorageAccessKeyDetailsServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2GetObjectStorageAccessKeyDetailsUsername" }, { "$ref": "#/components/parameters/objectStorage2GetObjectStorageAccessKeyDetailsAccessKeyId" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2GetObjectStorageAccessKeyDetails200" }, "default": { "$ref": "#/components/responses/objectStorage2GetObjectStorageAccessKeyDetailsDefault" } } }, "delete": { "tags": [ "object-storage-2" ], "summary": "Delete access key", "description": "Deletes existing access key by given {service_uuid}, {username}, and {access-key-id}.", "operationId": "deleteObjectStorageAccessKey", "parameters": [ { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageAccessKeyServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageAccessKeyUsername" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageAccessKeyAccessKeyId" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageAccessKey204" }, "default": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageAccessKeyDefault" } } }, "patch": { "tags": [ "object-storage-2" ], "summary": "Modify access key details", "description": "Modifies access key details.", "operationId": "modifyObjectStorageAccessKeyDetails", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ModifyObjectStorageAccessKeyDetailsServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2ModifyObjectStorageAccessKeyDetailsUsername" }, { "$ref": "#/components/parameters/objectStorage2ModifyObjectStorageAccessKeyDetailsAccessKeyId" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2ModifyObjectStorageAccessKeyDetails" }, "responses": { "200": { "$ref": "#/components/responses/objectStorage2ModifyObjectStorageAccessKeyDetails200" }, "default": { "$ref": "#/components/responses/objectStorage2ModifyObjectStorageAccessKeyDetailsDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/users/{username}/policies": { "get": { "tags": [ "object-storage-2" ], "summary": "List attached user policies", "description": "Returns a list of attached user policies for a user.", "operationId": "listObjectStorageAttachedUserPolicies", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ListObjectStorageAttachedUserPoliciesServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2ListObjectStorageAttachedUserPoliciesUsername" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2ListObjectStorageAttachedUserPolicies200" }, "default": { "$ref": "#/components/responses/objectStorage2ListObjectStorageAttachedUserPoliciesDefault" } } }, "post": { "tags": [ "object-storage-2" ], "summary": "Attach user policy", "description": "Attach a policy to a user.", "operationId": "attachObjectStorageUserPolicy", "parameters": [ { "$ref": "#/components/parameters/objectStorage2AttachObjectStorageUserPolicyServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2AttachObjectStorageUserPolicyUsername" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2AttachObjectStorageUserPolicy" }, "responses": { "204": { "$ref": "#/components/responses/objectStorage2AttachObjectStorageUserPolicy204" }, "default": { "$ref": "#/components/responses/objectStorage2AttachObjectStorageUserPolicyDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/users/{username}/policies/{nested-name}": { "delete": { "tags": [ "object-storage-2" ], "summary": "Detach user policy", "description": "Detach a policy from a user.", "operationId": "detachObjectStorageUserPolicy", "parameters": [ { "$ref": "#/components/parameters/objectStorage2DetachObjectStorageUserPolicyServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2DetachObjectStorageUserPolicyUsername" }, { "$ref": "#/components/parameters/objectStorage2DetachObjectStorageUserPolicyNestedName" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2DetachObjectStorageUserPolicy204" }, "default": { "$ref": "#/components/responses/objectStorage2DetachObjectStorageUserPolicyDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/users/{username}/inline-policies/{user-policy-name}": { "get": { "tags": [ "object-storage-2" ], "summary": "Get user inline policy", "description": "Get the user inline policy by the given {service_uuid}, {username} and {policy_name}.", "operationId": "getObjectStorageUserInlinePolicy", "parameters": [ { "$ref": "#/components/parameters/objectStorage2GetObjectStorageUserInlinePolicyServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2GetObjectStorageUserInlinePolicyUsername" }, { "$ref": "#/components/parameters/objectStorage2GetObjectStorageUserInlinePolicyUserPolicyName" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2GetObjectStorageUserInlinePolicy200" }, "default": { "$ref": "#/components/responses/objectStorage2GetObjectStorageUserInlinePolicyDefault" } } }, "delete": { "tags": [ "object-storage-2" ], "summary": "Delete user inline policy", "description": "Deletes the user inline policy by the given {service_uuid}, {username}, and {policy_name}.", "operationId": "deleteObjectStorageUserInlinePolicy", "parameters": [ { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageUserInlinePolicyServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageUserInlinePolicyUsername" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageUserInlinePolicyUserPolicyName" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageUserInlinePolicy204" }, "default": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageUserInlinePolicyDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/users/{username}/inline-policies": { "get": { "tags": [ "object-storage-2" ], "summary": "List user inline policies", "description": "Lists the user inline policies by the given {service_uuid}, and {username}.", "operationId": "listObjectStorageUserInlinePolicies", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ListObjectStorageUserInlinePoliciesServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2ListObjectStorageUserInlinePoliciesUsername" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2ListObjectStorageUserInlinePolicies200" }, "default": { "$ref": "#/components/responses/objectStorage2ListObjectStorageUserInlinePoliciesDefault" } } }, "post": { "tags": [ "object-storage-2" ], "summary": "Create user inline policy", "description": "Creates a user inline policy by the given {service_uuid}, and {username}.", "operationId": "createObjectStorageUserInlinePolicy", "parameters": [ { "$ref": "#/components/parameters/objectStorage2CreateObjectStorageUserInlinePolicyServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2CreateObjectStorageUserInlinePolicyUsername" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2CreateObjectStorageUserInlinePolicy" }, "responses": { "201": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageUserInlinePolicy201" }, "default": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageUserInlinePolicyDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/users/{username}/tags": { "get": { "tags": [ "object-storage-2" ], "summary": "Get user tags", "description": "Returns a user's tags by the given {service_uuid}, and {username}.", "operationId": "getObjectStorageUserTags", "parameters": [ { "$ref": "#/components/parameters/objectStorage2GetObjectStorageUserTagsServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2GetObjectStorageUserTagsUsername" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2GetObjectStorageUserTags200" }, "default": { "$ref": "#/components/responses/objectStorage2GetObjectStorageUserTagsDefault" } } }, "put": { "tags": [ "object-storage-2" ], "summary": "Replace user tags", "description": "Replaces a user's tags by the given {service_uuid}, and {username}.", "operationId": "replaceObjectStorageUserTags", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ReplaceObjectStorageUserTagsServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2ReplaceObjectStorageUserTagsUsername" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2ReplaceObjectStorageUserTags" }, "responses": { "200": { "$ref": "#/components/responses/objectStorage2ReplaceObjectStorageUserTags200" }, "default": { "$ref": "#/components/responses/objectStorage2ReplaceObjectStorageUserTagsDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/users/{username}/tags/{user-tag-key}": { "delete": { "tags": [ "object-storage-2" ], "summary": "Delete user tag", "description": "Deletes a user's tag by the given {service_uuid}, {username}, and {tag_key}.", "operationId": "deleteObjectStorageUserTag", "parameters": [ { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageUserTagServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageUserTagUsername" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageUserTagUserTagKey" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageUserTag204" }, "default": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageUserTagDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/users/{username}/permissions-boundary": { "put": { "tags": [ "object-storage-2" ], "summary": "Create user permissions boundary", "description": "Creates a user's permissions boundary by the given {service_uuid}, and {username}.", "operationId": "createObjectStorageUserPermissionsBoundary", "parameters": [ { "$ref": "#/components/parameters/objectStorage2CreateObjectStorageUserPermissionsBoundaryServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2CreateObjectStorageUserPermissionsBoundaryUsername" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2CreateObjectStorageUserPermissionsBoundary" }, "responses": { "200": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageUserPermissionsBoundary200" }, "default": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageUserPermissionsBoundaryDefault" } } }, "delete": { "tags": [ "object-storage-2" ], "summary": "Delete user permissions boundary", "description": "Deletes a user's permissions boundary by the given {service_uuid}, and {username}.", "operationId": "deleteObjectStorageUserPermissionsBoundary", "parameters": [ { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageUserPermissionsBoundaryServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageUserPermissionsBoundaryUsername" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageUserPermissionsBoundary204" }, "default": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageUserPermissionsBoundaryDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/policies/{policy-name}/versions": { "get": { "tags": [ "object-storage-2" ], "summary": "List policy versions", "description": "Lists policy versions given by {service_uuid}, and {policy_name}.", "operationId": "listObjectStoragePolicyVersions", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ListObjectStoragePolicyVersionsServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2ListObjectStoragePolicyVersionsPolicyName" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2ListObjectStoragePolicyVersions200" }, "default": { "$ref": "#/components/responses/objectStorage2ListObjectStoragePolicyVersionsDefault" } } }, "post": { "tags": [ "object-storage-2" ], "summary": "Create policy version", "description": "Creates a policy version by the given {service_uuid}, and {policy_name}.", "operationId": "createObjectStoragePolicyVersion", "parameters": [ { "$ref": "#/components/parameters/objectStorage2CreateObjectStoragePolicyVersionServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2CreateObjectStoragePolicyVersionPolicyName" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2CreateObjectStoragePolicyVersion" }, "responses": { "201": { "$ref": "#/components/responses/objectStorage2CreateObjectStoragePolicyVersion201" }, "default": { "$ref": "#/components/responses/objectStorage2CreateObjectStoragePolicyVersionDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/policies/{policy-name}/versions/{policy-version}": { "get": { "tags": [ "object-storage-2" ], "summary": "Get policy version", "description": "Get a single policy version by the given {service_uuid}, {policy_name}, and {policy_version}.", "operationId": "getObjectStoragePolicyVersion", "parameters": [ { "$ref": "#/components/parameters/objectStorage2GetObjectStoragePolicyVersionServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2GetObjectStoragePolicyVersionPolicyName" }, { "$ref": "#/components/parameters/objectStorage2GetObjectStoragePolicyVersionPolicyVersion" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2GetObjectStoragePolicyVersion200" }, "default": { "$ref": "#/components/responses/objectStorage2GetObjectStoragePolicyVersionDefault" } } }, "delete": { "tags": [ "object-storage-2" ], "summary": "Delete a policy version", "description": "Deletes a policy version by the given {service_uuid}, {policy_name}, and {policy_version}.", "operationId": "deleteObjectStoragePolicyVersion", "parameters": [ { "$ref": "#/components/parameters/objectStorage2DeleteObjectStoragePolicyVersionServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStoragePolicyVersionPolicyName" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStoragePolicyVersionPolicyVersion" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2DeleteObjectStoragePolicyVersion204" }, "default": { "$ref": "#/components/responses/objectStorage2DeleteObjectStoragePolicyVersionDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/policies/{policy-name}": { "get": { "tags": [ "object-storage-2" ], "summary": "Get policy details", "description": "Returns service policy details by given {service_uuid} and {policy_name}.", "operationId": "getObjectStoragePolicy", "parameters": [ { "$ref": "#/components/parameters/objectStorage2GetObjectStoragePolicyServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2GetObjectStoragePolicyPolicyName" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2GetObjectStoragePolicy200" }, "default": { "$ref": "#/components/responses/objectStorage2GetObjectStoragePolicyDefault" } } }, "delete": { "tags": [ "object-storage-2" ], "summary": "Delete policy", "description": "Deletes existing policy by given {service_uuid} and {policy_name}.", "operationId": "deleteObjectStoragePolicy", "parameters": [ { "$ref": "#/components/parameters/objectStorage2DeleteObjectStoragePolicyServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStoragePolicyPolicyName" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2DeleteObjectStoragePolicy204" }, "default": { "$ref": "#/components/responses/objectStorage2DeleteObjectStoragePolicyDefault" } } }, "patch": { "tags": [ "object-storage-2" ], "summary": "Set default policy version", "description": "Sets the default version for a policy. Note: This is mapped from ModifyPolicyVersion handler.", "operationId": "setObjectStorageDefaultPolicyVersion", "parameters": [ { "$ref": "#/components/parameters/objectStorage2SetObjectStorageDefaultPolicyVersionServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2SetObjectStorageDefaultPolicyVersionPolicyName" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2SetObjectStorageDefaultPolicyVersion" }, "responses": { "200": { "$ref": "#/components/responses/objectStorage2SetObjectStorageDefaultPolicyVersion200" }, "default": { "$ref": "#/components/responses/objectStorage2SetObjectStorageDefaultPolicyVersionDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/policies": { "get": { "tags": [ "object-storage-2" ], "summary": "List policies", "description": "Returns a list of available service policies by given {service_uuid}.", "operationId": "listObjectStoragePolicies", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ListObjectStoragePoliciesServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2ListObjectStoragePolicies200" }, "default": { "$ref": "#/components/responses/objectStorage2ListObjectStoragePoliciesDefault" } } }, "post": { "tags": [ "object-storage-2" ], "summary": "Create policy", "description": "Creates a new service policy by given {service_uuid}.", "operationId": "createObjectStoragePolicy", "parameters": [ { "$ref": "#/components/parameters/objectStorage2CreateObjectStoragePolicyServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2CreateObjectStoragePolicy" }, "responses": { "201": { "$ref": "#/components/responses/objectStorage2CreateObjectStoragePolicy201" }, "default": { "$ref": "#/components/responses/objectStorage2CreateObjectStoragePolicyDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/groups/{group-name}/policies": { "get": { "tags": [ "object-storage-2" ], "summary": "List IAM Group Policies", "description": "Lists IAM policies attached to a group.", "operationId": "listObjectStorageIAMGroupPolicies", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ListObjectStorageIAMGroupPoliciesServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2ListObjectStorageIAMGroupPoliciesGroupName" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2ListObjectStorageIAMGroupPolicies200" }, "default": { "$ref": "#/components/responses/objectStorage2ListObjectStorageIAMGroupPoliciesDefault" } } }, "post": { "tags": [ "object-storage-2" ], "summary": "Attach IAM Group Policy", "description": "Attaches a policy to a group.", "operationId": "attachObjectStorageIAMGroupPolicy", "parameters": [ { "$ref": "#/components/parameters/objectStorage2AttachObjectStorageIAMGroupPolicyServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2AttachObjectStorageIAMGroupPolicyGroupName" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2AttachObjectStorageIAMGroupPolicy" }, "responses": { "204": { "$ref": "#/components/responses/objectStorage2AttachObjectStorageIAMGroupPolicy204" }, "default": { "$ref": "#/components/responses/objectStorage2AttachObjectStorageIAMGroupPolicyDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/groups/{group-name}/policies/{policy-name}": { "delete": { "tags": [ "object-storage-2" ], "summary": "Detach IAM Group Policy", "description": "Detaches a policy from a group.", "operationId": "detachObjectStorageIAMGroupPolicy", "parameters": [ { "$ref": "#/components/parameters/objectStorage2DetachObjectStorageIAMGroupPolicyServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2DetachObjectStorageIAMGroupPolicyGroupName" }, { "$ref": "#/components/parameters/objectStorage2DetachObjectStorageIAMGroupPolicyPolicyName" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2DetachObjectStorageIAMGroupPolicy204" }, "default": { "$ref": "#/components/responses/objectStorage2DetachObjectStorageIAMGroupPolicyDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/groups": { "get": { "tags": [ "object-storage-2" ], "summary": "List groups", "description": "Returns a list of available service groups by given {service_uuid}.", "operationId": "listObjectStorageGroups", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ListObjectStorageGroupsServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2ListObjectStorageGroups200" }, "default": { "$ref": "#/components/responses/objectStorage2ListObjectStorageGroupsDefault" } } }, "post": { "tags": [ "object-storage-2" ], "summary": "Create group", "description": "Creates an iam group.", "operationId": "createObjectStorageGroup", "parameters": [ { "$ref": "#/components/parameters/objectStorage2CreateObjectStorageGroupServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2CreateObjectStorageGroup" }, "responses": { "201": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageGroup201" }, "default": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageGroupDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/groups/{group-name}": { "get": { "tags": [ "object-storage-2" ], "summary": "Get group", "description": "Get a single group identified by {service_uuid}, and {group_name}.", "operationId": "getObjectStorageGroup", "parameters": [ { "$ref": "#/components/parameters/objectStorage2GetObjectStorageGroupServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2GetObjectStorageGroupGroupName" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2GetObjectStorageGroup200" }, "default": { "$ref": "#/components/responses/objectStorage2GetObjectStorageGroupDefault" } } }, "delete": { "tags": [ "object-storage-2" ], "summary": "Delete group", "description": "Deletes a group identified by {group_name}.", "operationId": "deleteObjectStorageGroup", "parameters": [ { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageGroupServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageGroupGroupName" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageGroup204" }, "default": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageGroupDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/groups/{group-name}/users/{username}": { "post": { "tags": [ "object-storage-2" ], "summary": "Attach user to group", "description": "Attaches an iam user to a group identified by {group_name}, and {username}.", "operationId": "attachObjectStorageUserToGroup", "parameters": [ { "$ref": "#/components/parameters/objectStorage2AttachObjectStorageUserToGroupServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2AttachObjectStorageUserToGroupGroupName" }, { "$ref": "#/components/parameters/objectStorage2AttachObjectStorageUserToGroupUsername" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2AttachObjectStorageUserToGroup204" }, "default": { "$ref": "#/components/responses/objectStorage2AttachObjectStorageUserToGroupDefault" } } }, "delete": { "tags": [ "object-storage-2" ], "summary": "Remove user from group", "description": "Removes an iam user from the group identified by {group_name}, and {username}.", "operationId": "removeObjectStorageUserFromGroup", "parameters": [ { "$ref": "#/components/parameters/objectStorage2RemoveObjectStorageUserFromGroupServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2RemoveObjectStorageUserFromGroupGroupName" }, { "$ref": "#/components/parameters/objectStorage2RemoveObjectStorageUserFromGroupUsername" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2RemoveObjectStorageUserFromGroup204" }, "default": { "$ref": "#/components/responses/objectStorage2RemoveObjectStorageUserFromGroupDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/groups/{group-name}/inline-policies": { "get": { "tags": [ "object-storage-2" ], "summary": "List group inline policies", "description": "Lists the group inline policies by the given {service_uuid}, and {group_name}.", "operationId": "listObjectStorageGroupInlinePolicies", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ListObjectStorageGroupInlinePoliciesServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2ListObjectStorageGroupInlinePoliciesGroupName" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2ListObjectStorageGroupInlinePolicies200" }, "default": { "$ref": "#/components/responses/objectStorage2ListObjectStorageGroupInlinePoliciesDefault" } } }, "post": { "tags": [ "object-storage-2" ], "summary": "Create group inline policy", "description": "Creates a group inline policy by the given {service_uuid}, and {group_name}.", "operationId": "createObjectStorageGroupInlinePolicy", "parameters": [ { "$ref": "#/components/parameters/objectStorage2CreateObjectStorageGroupInlinePolicyServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2CreateObjectStorageGroupInlinePolicyGroupName" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2CreateObjectStorageGroupInlinePolicy" }, "responses": { "201": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageGroupInlinePolicy201" }, "default": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageGroupInlinePolicyDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/groups/{group-name}/inline-policies/{group-policy-name}": { "get": { "tags": [ "object-storage-2" ], "summary": "Get group inline policy", "description": "Get the group inline policy by the given {service_uuid}, {group_name} and {policy_name}.", "operationId": "getObjectStorageGroupInlinePolicy", "parameters": [ { "$ref": "#/components/parameters/objectStorage2GetObjectStorageGroupInlinePolicyServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2GetObjectStorageGroupInlinePolicyGroupName" }, { "$ref": "#/components/parameters/objectStorage2GetObjectStorageGroupInlinePolicyGroupPolicyName" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2GetObjectStorageGroupInlinePolicy200" }, "default": { "$ref": "#/components/responses/objectStorage2GetObjectStorageGroupInlinePolicyDefault" } } }, "delete": { "tags": [ "object-storage-2" ], "summary": "Delete group inline policy", "description": "Deletes the group inline policy by the given {service_uuid}, {group_name}, and {policy_name}.", "operationId": "deleteObjectStorageGroupInlinePolicy", "parameters": [ { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageGroupInlinePolicyServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageGroupInlinePolicyGroupName" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageGroupInlinePolicyGroupPolicyName" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageGroupInlinePolicy204" }, "default": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageGroupInlinePolicyDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/roles": { "get": { "tags": [ "object-storage-2" ], "summary": "List Roles", "description": "Lists the roles.", "operationId": "listObjectStorageRoles", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ListObjectStorageRolesServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2ListObjectStorageRoles200" }, "default": { "$ref": "#/components/responses/objectStorage2ListObjectStorageRolesDefault" } } }, "post": { "tags": [ "object-storage-2" ], "summary": "Create Role", "description": "Creates a service IAM role.", "operationId": "createObjectStorageRole", "parameters": [ { "$ref": "#/components/parameters/objectStorage2CreateObjectStorageRoleServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2CreateObjectStorageRole" }, "responses": { "201": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageRole201" }, "default": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageRoleDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/roles/{role-name}": { "get": { "tags": [ "object-storage-2" ], "summary": "Get Role", "description": "Get a single role identified by {service_uuid}, and {role_name}.", "operationId": "getObjectStorageRole", "parameters": [ { "$ref": "#/components/parameters/objectStorage2GetObjectStorageRoleServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2GetObjectStorageRoleRoleName" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2GetObjectStorageRole200" }, "default": { "$ref": "#/components/responses/objectStorage2GetObjectStorageRoleDefault" } } }, "delete": { "tags": [ "object-storage-2" ], "summary": "Delete Role", "description": "Deletes a service's IAM role.", "operationId": "deleteObjectStorageRole", "parameters": [ { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageRoleServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageRoleRoleName" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageRole204" }, "default": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageRoleDefault" } } }, "patch": { "tags": [ "object-storage-2" ], "summary": "Update Role", "description": "Updates a service's IAM role.", "operationId": "updateObjectStorageRole", "parameters": [ { "$ref": "#/components/parameters/objectStorage2UpdateObjectStorageRoleServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2UpdateObjectStorageRoleRoleName" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2UpdateObjectStorageRole" }, "responses": { "200": { "$ref": "#/components/responses/objectStorage2UpdateObjectStorageRole200" }, "default": { "$ref": "#/components/responses/objectStorage2UpdateObjectStorageRoleDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/roles/{role-name}/inline-policies": { "get": { "tags": [ "object-storage-2" ], "summary": "List Role Inline Policies", "description": "Returns a list of role inline policies by the given {service_uuid}, and {role_name}.", "operationId": "listObjectStorageRoleInlinePolicies", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ListObjectStorageRoleInlinePoliciesServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2ListObjectStorageRoleInlinePoliciesRoleName" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2ListObjectStorageRoleInlinePolicies200" }, "default": { "$ref": "#/components/responses/objectStorage2ListObjectStorageRoleInlinePoliciesDefault" } } }, "post": { "tags": [ "object-storage-2" ], "summary": "Create role inline policy", "description": "Creates a role inline policy by the given {service_uuid}, and {role_name}.", "operationId": "createObjectStorageRoleInlinePolicy", "parameters": [ { "$ref": "#/components/parameters/objectStorage2CreateObjectStorageRoleInlinePolicyServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2CreateObjectStorageRoleInlinePolicyRoleName" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2CreateObjectStorageRoleInlinePolicy" }, "responses": { "201": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageRoleInlinePolicy201" }, "default": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageRoleInlinePolicyDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/roles/{role-name}/inline-policies/{role-policy-name}": { "get": { "tags": [ "object-storage-2" ], "summary": "Get Role Inline Policy", "description": "Returns a role's inline policy by the given {service_uuid}, {role_name}, and {policy_name}.", "operationId": "getObjectStorageRoleInlinePolicy", "parameters": [ { "$ref": "#/components/parameters/objectStorage2GetObjectStorageRoleInlinePolicyServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2GetObjectStorageRoleInlinePolicyRoleName" }, { "$ref": "#/components/parameters/objectStorage2GetObjectStorageRoleInlinePolicyRolePolicyName" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2GetObjectStorageRoleInlinePolicy200" }, "default": { "$ref": "#/components/responses/objectStorage2GetObjectStorageRoleInlinePolicyDefault" } } }, "delete": { "tags": [ "object-storage-2" ], "summary": "Delete role inline policy", "description": "Delete a role inline policy by the given {service_uuid}, {role_name} and {policy_name}.", "operationId": "deleteObjectStorageRoleInlinePolicy", "parameters": [ { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageRoleInlinePolicyServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageRoleInlinePolicyRoleName" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageRoleInlinePolicyRolePolicyName" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageRoleInlinePolicy204" }, "default": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageRoleInlinePolicyDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/roles/{role-name}/permissions-boundary": { "put": { "tags": [ "object-storage-2" ], "summary": "Create role permissions boundary", "description": "Creates a role policy's permissions boundary by the given {service_uuid}, and {role_name}.", "operationId": "createObjectStorageRolePermissionsBoundary", "parameters": [ { "$ref": "#/components/parameters/objectStorage2CreateObjectStorageRolePermissionsBoundaryServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2CreateObjectStorageRolePermissionsBoundaryRoleName" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2CreateObjectStorageRolePermissionsBoundary" }, "responses": { "200": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageRolePermissionsBoundary200" }, "default": { "$ref": "#/components/responses/objectStorage2CreateObjectStorageRolePermissionsBoundaryDefault" } } }, "delete": { "tags": [ "object-storage-2" ], "summary": "Delete role permissions boundary", "description": "Deletes a role permissions boundary by the given {service_uuid}, and {role_name}.", "operationId": "deleteObjectStorageRolePermissionsBoundary", "parameters": [ { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageRolePermissionsBoundaryServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageRolePermissionsBoundaryRoleName" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageRolePermissionsBoundary204" }, "default": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageRolePermissionsBoundaryDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/roles/{role-name}/assume-role-policy": { "put": { "tags": [ "object-storage-2" ], "summary": "Assume Role Policy", "description": "Assume a role policy by the given {service_uuid}, and {role_name}.", "operationId": "assumeObjectStorageRolePolicy", "parameters": [ { "$ref": "#/components/parameters/objectStorage2AssumeObjectStorageRolePolicyServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2AssumeObjectStorageRolePolicyRoleName" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2AssumeObjectStorageRolePolicy" }, "responses": { "200": { "$ref": "#/components/responses/objectStorage2AssumeObjectStorageRolePolicy200" }, "default": { "$ref": "#/components/responses/objectStorage2AssumeObjectStorageRolePolicyDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/roles/{role-name}/policies": { "get": { "tags": [ "object-storage-2" ], "summary": "List Attached Role Policies", "description": "Lists all policies attached to a service's IAM role.", "operationId": "listObjectStorageAttachedRolePolicies", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ListObjectStorageAttachedRolePoliciesServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2ListObjectStorageAttachedRolePoliciesRoleName" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2ListObjectStorageAttachedRolePolicies200" }, "default": { "$ref": "#/components/responses/objectStorage2ListObjectStorageAttachedRolePoliciesDefault" } } }, "post": { "tags": [ "object-storage-2" ], "summary": "Attach Policy To Role", "description": "Attaches a policy to a service's IAM role.", "operationId": "attachObjectStoragePolicyToRole", "parameters": [ { "$ref": "#/components/parameters/objectStorage2AttachObjectStoragePolicyToRoleServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2AttachObjectStoragePolicyToRoleRoleName" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2AttachObjectStoragePolicyToRole" }, "responses": { "204": { "$ref": "#/components/responses/objectStorage2AttachObjectStoragePolicyToRole204" }, "default": { "$ref": "#/components/responses/objectStorage2AttachObjectStoragePolicyToRoleDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/roles/{role-name}/policies/{role-policy-name}": { "delete": { "tags": [ "object-storage-2" ], "summary": "Detach Policy From Role", "description": "Detaches a policy from a service's IAM role.", "operationId": "detachObjectStoragePolicyFromRole", "parameters": [ { "$ref": "#/components/parameters/objectStorage2DetachObjectStoragePolicyFromRoleServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2DetachObjectStoragePolicyFromRoleRoleName" }, { "$ref": "#/components/parameters/objectStorage2DetachObjectStoragePolicyFromRoleRolePolicyName" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2DetachObjectStoragePolicyFromRole204" }, "default": { "$ref": "#/components/responses/objectStorage2DetachObjectStoragePolicyFromRoleDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/roles/{role-name}/tags": { "get": { "tags": [ "object-storage-2" ], "summary": "Get role tags", "description": "Returns a role's tags by the given {service_uuid}, and {role_name}.", "operationId": "getObjectStorageRoleTags", "parameters": [ { "$ref": "#/components/parameters/objectStorage2GetObjectStorageRoleTagsServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2GetObjectStorageRoleTagsRoleName" } ], "responses": { "200": { "$ref": "#/components/responses/objectStorage2GetObjectStorageRoleTags200" }, "default": { "$ref": "#/components/responses/objectStorage2GetObjectStorageRoleTagsDefault" } } }, "put": { "tags": [ "object-storage-2" ], "summary": "Replace role tags", "description": "Replaces a role's tags by the given {service_uuid}, and {role_name}.", "operationId": "replaceObjectStorageRoleTags", "parameters": [ { "$ref": "#/components/parameters/objectStorage2ReplaceObjectStorageRoleTagsServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2ReplaceObjectStorageRoleTagsRoleName" } ], "requestBody": { "$ref": "#/components/requestBodies/objectStorage2ReplaceObjectStorageRoleTags" }, "responses": { "200": { "$ref": "#/components/responses/objectStorage2ReplaceObjectStorageRoleTags200" }, "default": { "$ref": "#/components/responses/objectStorage2ReplaceObjectStorageRoleTagsDefault" } } } }, "/1.3/object-storage-2/{service-uuid}/roles/{role-name}/tags/{role-tag-key}": { "delete": { "tags": [ "object-storage-2" ], "summary": "Delete role tag", "description": "Deletes a role's tag by the given {service_uuid}, {role_name}, and {tag_key}.", "operationId": "deleteObjectStorageRoleTag", "parameters": [ { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageRoleTagServiceUuid" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageRoleTagRoleName" }, { "$ref": "#/components/parameters/objectStorage2DeleteObjectStorageRoleTagRoleTagKey" } ], "responses": { "204": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageRoleTag204" }, "default": { "$ref": "#/components/responses/objectStorage2DeleteObjectStorageRoleTagDefault" } } } }, "/1.3/file-storage": { "get": { "tags": [ "file-storage" ], "summary": "List services", "description": "Returns a list of File Storage services.", "operationId": "listFileStorages", "parameters": [ { "$ref": "#/components/parameters/listFileStoragesLimit" }, { "$ref": "#/components/parameters/listFileStoragesOffset" }, { "$ref": "#/components/parameters/listFileStoragesSort" } ], "responses": { "200": { "$ref": "#/components/responses/listFileStorages200" }, "default": { "$ref": "#/components/responses/listFileStoragesDefault" } } }, "post": { "tags": [ "file-storage" ], "summary": "Create service", "description": "Creates a new File Storage service.", "operationId": "createFileStorage", "requestBody": { "$ref": "#/components/requestBodies/createFileStorage" }, "responses": { "201": { "$ref": "#/components/responses/createFileStorage201" }, "default": { "$ref": "#/components/responses/createFileStorageDefault" } } } }, "/1.3/file-storage/{service-uuid}": { "get": { "tags": [ "file-storage" ], "summary": "Get service details", "description": "Returns managed File Storage details by given {service_uuid}.", "operationId": "getFileStorage", "parameters": [ { "$ref": "#/components/parameters/getFileStorageServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getFileStorage200" }, "default": { "$ref": "#/components/responses/getFileStorageDefault" } } }, "put": { "tags": [ "file-storage" ], "summary": "Replace service", "description": "Replaces existing File Storage service by given {service_uuid}.", "operationId": "replaceFileStorage", "parameters": [ { "$ref": "#/components/parameters/replaceFileStorageServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/replaceFileStorage" }, "responses": { "200": { "$ref": "#/components/responses/replaceFileStorage200" }, "default": { "$ref": "#/components/responses/replaceFileStorageDefault" } } }, "delete": { "tags": [ "file-storage" ], "summary": "Delete service", "description": "Deletes existing File Storage service by given {service_uuid}.", "operationId": "deleteFileStorage", "parameters": [ { "$ref": "#/components/parameters/deleteFileStorageServiceUuid" } ], "responses": { "204": { "$ref": "#/components/responses/deleteFileStorage204" }, "default": { "$ref": "#/components/responses/deleteFileStorageDefault" } } }, "patch": { "tags": [ "file-storage" ], "summary": "Modify service", "description": "Modifies existing File Storage service by given {service_uuid}.", "operationId": "modifyFileStorage", "parameters": [ { "$ref": "#/components/parameters/modifyFileStorageServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyFileStorage" }, "responses": { "200": { "$ref": "#/components/responses/modifyFileStorage200" }, "default": { "$ref": "#/components/responses/modifyFileStorageDefault" } } } }, "/1.3/file-storage/{service-uuid}/networks": { "get": { "tags": [ "file-storage" ], "summary": "List networks", "description": "Returns a list of available service networks by given {service_uuid}.", "operationId": "listFileStorageNetworks", "parameters": [ { "$ref": "#/components/parameters/listFileStorageNetworksServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listFileStorageNetworks200" }, "default": { "$ref": "#/components/responses/listFileStorageNetworksDefault" } } }, "post": { "tags": [ "file-storage" ], "summary": "Create network", "description": "Creates a new service network by given {service_uuid}.", "operationId": "createFileStorageNetwork", "parameters": [ { "$ref": "#/components/parameters/createFileStorageNetworkServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createFileStorageNetwork" }, "responses": { "201": { "$ref": "#/components/responses/createFileStorageNetwork201" }, "default": { "$ref": "#/components/responses/createFileStorageNetworkDefault" } } } }, "/1.3/file-storage/{service-uuid}/networks/{network-name}": { "get": { "tags": [ "file-storage" ], "summary": "Get network details", "description": "Returns service network details by given {service_uuid} and {network_name}.", "operationId": "getFileStorageNetwork", "parameters": [ { "$ref": "#/components/parameters/getFileStorageNetworkServiceUuid" }, { "$ref": "#/components/parameters/getFileStorageNetworkNetworkName" } ], "responses": { "200": { "$ref": "#/components/responses/getFileStorageNetwork200" }, "default": { "$ref": "#/components/responses/getFileStorageNetworkDefault" } } }, "delete": { "tags": [ "file-storage" ], "summary": "Delete network", "description": "Deletes existing network by given {service_uuid} and {network_name}.", "operationId": "deleteFileStorageNetwork", "parameters": [ { "$ref": "#/components/parameters/deleteFileStorageNetworkServiceUuid" }, { "$ref": "#/components/parameters/deleteFileStorageNetworkNetworkName" } ], "responses": { "204": { "$ref": "#/components/responses/deleteFileStorageNetwork204" }, "default": { "$ref": "#/components/responses/deleteFileStorageNetworkDefault" } } }, "patch": { "tags": [ "file-storage" ], "summary": "Modify network", "description": "Modifies existing service network by given {service_uuid} and {network_name}.", "operationId": "modifyFileStorageNetwork", "parameters": [ { "$ref": "#/components/parameters/modifyFileStorageNetworkServiceUuid" }, { "$ref": "#/components/parameters/modifyFileStorageNetworkNetworkName" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyFileStorageNetwork" }, "responses": { "200": { "$ref": "#/components/responses/modifyFileStorageNetwork200" }, "default": { "$ref": "#/components/responses/modifyFileStorageNetworkDefault" } } } }, "/1.3/file-storage/{service-uuid}/shares": { "get": { "tags": [ "file-storage" ], "summary": "List shares", "description": "Returns a list of available service shares by given {service_uuid}.", "operationId": "listFileStorageShares", "parameters": [ { "$ref": "#/components/parameters/listFileStorageSharesServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listFileStorageShares200" }, "default": { "$ref": "#/components/responses/listFileStorageSharesDefault" } } }, "post": { "tags": [ "file-storage" ], "summary": "Create share", "description": "Creates a new service share by given {service_uuid}.", "operationId": "createFileStorageShare", "parameters": [ { "$ref": "#/components/parameters/createFileStorageShareServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createFileStorageShare" }, "responses": { "201": { "$ref": "#/components/responses/createFileStorageShare201" }, "default": { "$ref": "#/components/responses/createFileStorageShareDefault" } } } }, "/1.3/file-storage/{service-uuid}/shares/{share-name}": { "get": { "tags": [ "file-storage" ], "summary": "Get share details", "description": "Returns service share details by given {service_uuid} and {share_name}.", "operationId": "getFileStorageShare", "parameters": [ { "$ref": "#/components/parameters/getFileStorageShareServiceUuid" }, { "$ref": "#/components/parameters/getFileStorageShareShareName" } ], "responses": { "200": { "$ref": "#/components/responses/getFileStorageShare200" }, "default": { "$ref": "#/components/responses/getFileStorageShareDefault" } } }, "delete": { "tags": [ "file-storage" ], "summary": "Delete share", "description": "Deletes existing share by given {service_uuid} and {share_name}.", "operationId": "deleteFileStorageShare", "parameters": [ { "$ref": "#/components/parameters/deleteFileStorageShareServiceUuid" }, { "$ref": "#/components/parameters/deleteFileStorageShareShareName" } ], "responses": { "204": { "$ref": "#/components/responses/deleteFileStorageShare204" }, "default": { "$ref": "#/components/responses/deleteFileStorageShareDefault" } } }, "patch": { "tags": [ "file-storage" ], "summary": "Modify share", "description": "Modifies existing service share by given {service_uuid} and {share_name}.", "operationId": "modifyFileStorageShare", "parameters": [ { "$ref": "#/components/parameters/modifyFileStorageShareServiceUuid" }, { "$ref": "#/components/parameters/modifyFileStorageShareShareName" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyFileStorageShare" }, "responses": { "200": { "$ref": "#/components/responses/modifyFileStorageShare200" }, "default": { "$ref": "#/components/responses/modifyFileStorageShareDefault" } } } }, "/1.3/file-storage/{service-uuid}/shares/{share-name}/acl": { "get": { "tags": [ "file-storage" ], "summary": "List ACLs", "description": "Returns a list of available ACLs by given {service_uuid} and {share_name}.", "operationId": "listFileStorageAcls", "parameters": [ { "$ref": "#/components/parameters/listFileStorageAclsServiceUuid" }, { "$ref": "#/components/parameters/listFileStorageAclsShareName" } ], "responses": { "200": { "$ref": "#/components/responses/listFileStorageAcls200" }, "default": { "$ref": "#/components/responses/listFileStorageAclsDefault" } } }, "post": { "tags": [ "file-storage" ], "summary": "Create ACL", "description": "Creates a new share ACL by given {service_uuid} and {share_name}.", "operationId": "createFileStorageAcl", "parameters": [ { "$ref": "#/components/parameters/createFileStorageAclServiceUuid" }, { "$ref": "#/components/parameters/createFileStorageAclShareName" } ], "requestBody": { "$ref": "#/components/requestBodies/createFileStorageAcl" }, "responses": { "201": { "$ref": "#/components/responses/createFileStorageAcl201" }, "default": { "$ref": "#/components/responses/createFileStorageAclDefault" } } } }, "/1.3/file-storage/{service-uuid}/shares/{share-name}/acl/{acl-name}": { "get": { "tags": [ "file-storage" ], "summary": "Get ACL details", "description": "Returns ACL details by given {service_uuid}, {share_name} and {acl_name}.", "operationId": "getFileStorageAcl", "parameters": [ { "$ref": "#/components/parameters/getFileStorageAclServiceUuid" }, { "$ref": "#/components/parameters/getFileStorageAclShareName" }, { "$ref": "#/components/parameters/getFileStorageAclAclName" } ], "responses": { "200": { "$ref": "#/components/responses/getFileStorageAcl200" }, "default": { "$ref": "#/components/responses/getFileStorageAclDefault" } } }, "delete": { "tags": [ "file-storage" ], "summary": "Delete ACL", "description": "Deletes existing ACL by given {service_uuid}, {share_name} and {acl_name}.", "operationId": "deleteFileStorageAcl", "parameters": [ { "$ref": "#/components/parameters/deleteFileStorageAclServiceUuid" }, { "$ref": "#/components/parameters/deleteFileStorageAclShareName" }, { "$ref": "#/components/parameters/deleteFileStorageAclAclName" } ], "responses": { "204": { "$ref": "#/components/responses/deleteFileStorageAcl204" }, "default": { "$ref": "#/components/responses/deleteFileStorageAclDefault" } } }, "patch": { "tags": [ "file-storage" ], "summary": "Modify ACL", "description": "Modifies existing ACL by given {service_uuid}, {share_name} and {acl_name}.", "operationId": "modifyFileStorageAcl", "parameters": [ { "$ref": "#/components/parameters/modifyFileStorageAclServiceUuid" }, { "$ref": "#/components/parameters/modifyFileStorageAclShareName" }, { "$ref": "#/components/parameters/modifyFileStorageAclAclName" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyFileStorageAcl" }, "responses": { "200": { "$ref": "#/components/responses/modifyFileStorageAcl200" }, "default": { "$ref": "#/components/responses/modifyFileStorageAclDefault" } } } }, "/1.3/file-storage/{service-uuid}/labels": { "get": { "tags": [ "file-storage" ], "summary": "List labels", "description": "Returns a list of available service labels by given {service_uuid}.", "operationId": "listFileStorageLabels", "parameters": [ { "$ref": "#/components/parameters/listFileStorageLabelsServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listFileStorageLabels200" }, "default": { "$ref": "#/components/responses/listFileStorageLabelsDefault" } } }, "post": { "tags": [ "file-storage" ], "summary": "Create label", "description": "Creates a new label by given {service_uuid}. Labels are used for service filtering.", "operationId": "createFileStorageLabel", "parameters": [ { "$ref": "#/components/parameters/createFileStorageLabelServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createFileStorageLabel" }, "responses": { "201": { "$ref": "#/components/responses/createFileStorageLabel201" }, "default": { "$ref": "#/components/responses/createFileStorageLabelDefault" } } } }, "/1.3/file-storage/{service-uuid}/labels/{label-key}": { "get": { "tags": [ "file-storage" ], "summary": "Get label details", "description": "Returns label details by given {service_uuid} and {key}.", "operationId": "getFileStorageLabel", "parameters": [ { "$ref": "#/components/parameters/getFileStorageLabelServiceUuid" }, { "$ref": "#/components/parameters/getFileStorageLabelLabelKey" } ], "responses": { "200": { "$ref": "#/components/responses/getFileStorageLabel200" }, "default": { "$ref": "#/components/responses/getFileStorageLabelDefault" } } }, "delete": { "tags": [ "file-storage" ], "summary": "Delete label", "description": "Deletes existing label by given {service_uuid} and {key}.", "operationId": "deleteFileStorageLabel", "parameters": [ { "$ref": "#/components/parameters/deleteFileStorageLabelServiceUuid" }, { "$ref": "#/components/parameters/deleteFileStorageLabelLabelKey" } ], "responses": { "204": { "$ref": "#/components/responses/deleteFileStorageLabel204" }, "default": { "$ref": "#/components/responses/deleteFileStorageLabelDefault" } } }, "patch": { "tags": [ "file-storage" ], "summary": "Modify label", "description": "Modifies existing label by given {service_uuid} and {key}.", "operationId": "modifyFileStorageLabel", "parameters": [ { "$ref": "#/components/parameters/modifyFileStorageLabelServiceUuid" }, { "$ref": "#/components/parameters/modifyFileStorageLabelLabelKey" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyFileStorageLabel" }, "responses": { "200": { "$ref": "#/components/responses/modifyFileStorageLabel200" }, "default": { "$ref": "#/components/responses/modifyFileStorageLabelDefault" } } } }, "/1.3/file-storage/{service-uuid}/current-state": { "get": { "tags": [ "file-storage" ], "summary": "Get service current state", "description": "Returns the current state of the File Storage service by given {service_uuid}.", "operationId": "getFileStorageCurrentState", "parameters": [ { "$ref": "#/components/parameters/getFileStorageCurrentStateServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getFileStorageCurrentState200" }, "default": { "$ref": "#/components/responses/getFileStorageCurrentStateDefault" } } } }, "/1.3/database/service-types": { "get": { "tags": [ "database" ], "summary": "List database types", "description": "Returns a list of available database types. Contains available legacy plans, zones, database versions supported and the configuration properties for each database. PostgreSQL and MySQL componentised (rdb.*) plans are selected with the plan_* request fields instead of a listed plan name.", "operationId": "listDatabaseTypes", "responses": { "200": { "$ref": "#/components/responses/listDatabaseTypes200" }, "default": { "$ref": "#/components/responses/listDatabaseTypesDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/plans": { "get": { "tags": [ "database" ], "summary": "List database plans", "description": "Lists available componentised database plans", "operationId": "listDatabasePlans", "responses": { "200": { "$ref": "#/components/responses/listDatabasePlans200" }, "default": { "$ref": "#/components/responses/listDatabasePlansDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/service-types/{service-type-name}": { "get": { "tags": [ "database" ], "summary": "Get database type", "description": "Returns database type details by given {database_type}. Contains available legacy plans, zones, database versions supported and configuration properties. PostgreSQL and MySQL componentised (rdb.*) plans are selected with the plan_* request fields instead of a listed plan name.", "operationId": "getDatabaseType", "parameters": [ { "$ref": "#/components/parameters/getDatabaseTypeServiceTypeName" } ], "responses": { "200": { "$ref": "#/components/responses/getDatabaseType200" }, "default": { "$ref": "#/components/responses/getDatabaseTypeDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database": { "get": { "tags": [ "database" ], "summary": "List databases", "description": "Returns a list of all available Managed Database services. Depending on their database type, Managed Databases services will have different details.", "operationId": "listDatabases", "parameters": [ { "$ref": "#/components/parameters/listDatabasesLimit" }, { "$ref": "#/components/parameters/listDatabasesOffset" }, { "$ref": "#/components/parameters/listDatabasesSort" } ], "responses": { "200": { "$ref": "#/components/responses/listDatabases200" }, "default": { "$ref": "#/components/responses/listDatabasesDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "database" ], "summary": "Create database", "description": "Creates a new Managed Database instance. New databases are started by default. An initial backup is created automatically on startup and the API will be fully functional only after this backup has been created. The creation might take a while. Note that different databases have different properties that can be passed on creation. For PostgreSQL and MySQL, select the plan with the plan_compute, plan_node_count, plan_storage_gib and plan_backups fields; the plan name field is deprecated for these engines.", "operationId": "createDatabase", "requestBody": { "$ref": "#/components/requestBodies/createDatabase" }, "responses": { "201": { "$ref": "#/components/responses/createDatabase201" }, "default": { "$ref": "#/components/responses/createDatabaseDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}": { "get": { "tags": [ "database" ], "summary": "Get database", "description": "Returns details of a Managed Database service by its {uuid}.", "operationId": "getDatabase", "parameters": [ { "$ref": "#/components/parameters/getDatabaseUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getDatabase200" }, "default": { "$ref": "#/components/responses/getDatabaseDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "database" ], "summary": "Delete database", "description": "Deletes a specified Managed Database. All data will be erased and lost, including backups. If the service is not powered off, it will be powered off before deletion. The state of the service can be anything.", "operationId": "deleteDatabase", "parameters": [ { "$ref": "#/components/parameters/deleteDatabaseUuid" } ], "responses": { "204": { "$ref": "#/components/responses/deleteDatabase204" }, "default": { "$ref": "#/components/responses/deleteDatabaseDefault" } }, "x-upcloud-visibility": "public" }, "patch": { "tags": [ "database" ], "summary": "Modify database", "description": "Modifies Managed Database service details by its {uuid} including upgrading plans, migration to other zones and database type-specific configurations. For PostgreSQL and MySQL, change the plan with the plan_compute, plan_node_count, plan_storage_gib and plan_backups fields; the plan name field is deprecated for these engines.", "operationId": "modifyDatabase", "parameters": [ { "$ref": "#/components/parameters/modifyDatabaseUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyDatabase" }, "responses": { "200": { "$ref": "#/components/responses/modifyDatabase200" }, "default": { "$ref": "#/components/responses/modifyDatabaseDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/service-type": { "patch": { "tags": [ "database" ], "summary": "Modify database type", "description": "Update a service's type by the given {service-uuid}.", "operationId": "modifyDatabaseType", "parameters": [ { "$ref": "#/components/parameters/modifyDatabaseTypeUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyDatabaseType" }, "responses": { "200": { "$ref": "#/components/responses/modifyDatabaseType200" }, "default": { "$ref": "#/components/responses/modifyDatabaseTypeDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/clone": { "post": { "tags": [ "database" ], "summary": "Clone database", "description": "Creates a clone of a Managed Database service based on its {uuid}. It is possible to change location, plans and use the point in time feature to clone your service at a specific time using your backups. For PostgreSQL and MySQL, select the clone's plan with the plan_compute, plan_node_count, plan_storage_gib and plan_backups fields; the plan name field is deprecated for these engines.", "operationId": "cloneDatabase", "parameters": [ { "$ref": "#/components/parameters/cloneDatabaseUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/cloneDatabase" }, "responses": { "201": { "$ref": "#/components/responses/cloneDatabase201" }, "default": { "$ref": "#/components/responses/cloneDatabaseDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/networks": { "get": { "tags": [ "database" ], "summary": "List networks", "description": "Returns a list of attached SDN networks to a Managed Database service by its {uuid}.", "operationId": "listDatabaseNetworks", "parameters": [ { "$ref": "#/components/parameters/listDatabaseNetworksUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listDatabaseNetworks200" }, "default": { "$ref": "#/components/responses/listDatabaseNetworksDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "database" ], "summary": "Create network", "description": "Attaches an SDN network to a Managed Database service by its {uuid}.", "operationId": "createDatabaseNetwork", "parameters": [ { "$ref": "#/components/parameters/createDatabaseNetworkUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createDatabaseNetwork" }, "responses": { "201": { "$ref": "#/components/responses/createDatabaseNetwork201" }, "default": { "$ref": "#/components/responses/createDatabaseNetworkDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/networks/{network-name}": { "get": { "tags": [ "database" ], "summary": "Get network", "description": "Returns the attached SDN network details to service by its {uuid} and {network_name}.", "operationId": "getDatabaseNetwork", "parameters": [ { "$ref": "#/components/parameters/getDatabaseNetworkUuid" }, { "$ref": "#/components/parameters/getDatabaseNetworkNetworkName" } ], "responses": { "200": { "$ref": "#/components/responses/getDatabaseNetwork200" }, "default": { "$ref": "#/components/responses/getDatabaseNetworkDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "database" ], "summary": "Delete network", "description": "Detaches an existing SDN network from a Managed Database service by its {uuid} and {network_name}.", "operationId": "deleteDatabaseNetwork", "parameters": [ { "$ref": "#/components/parameters/deleteDatabaseNetworkUuid" }, { "$ref": "#/components/parameters/deleteDatabaseNetworkNetworkName" } ], "responses": { "204": { "$ref": "#/components/responses/deleteDatabaseNetwork204" }, "default": { "$ref": "#/components/responses/deleteDatabaseNetworkDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/upgrade": { "post": { "tags": [ "database" ], "summary": "Upgrade database", "description": "Upgrades your PostgreSQL Managed Database service database to a newer major version. Downgrades are not permitted.", "operationId": "upgradeDatabase", "parameters": [ { "$ref": "#/components/parameters/upgradeDatabaseUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/upgradeDatabase" }, "responses": { "201": { "$ref": "#/components/responses/upgradeDatabase201" }, "default": { "$ref": "#/components/responses/upgradeDatabaseDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/labels": { "get": { "tags": [ "database" ], "summary": "List labels", "description": "Returns a list of available service labels by given {service_uuid}.", "operationId": "listDatabaseLabels", "parameters": [ { "$ref": "#/components/parameters/listDatabaseLabelsUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listDatabaseLabels200" }, "default": { "$ref": "#/components/responses/listDatabaseLabelsDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "database" ], "summary": "Create label", "description": "Creates a new label by given {service_uuid}. Labels used for service filtering.", "operationId": "createDatabaseLabel", "parameters": [ { "$ref": "#/components/parameters/createDatabaseLabelUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createDatabaseLabel" }, "responses": { "201": { "$ref": "#/components/responses/createDatabaseLabel201" }, "default": { "$ref": "#/components/responses/createDatabaseLabelDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/labels/{label-key}": { "get": { "tags": [ "database" ], "summary": "Get label", "description": "Returns label details by given {service_uuid} and {key}.", "operationId": "getDatabaseLabel", "parameters": [ { "$ref": "#/components/parameters/getDatabaseLabelUuid" }, { "$ref": "#/components/parameters/getDatabaseLabelLabelKey" } ], "responses": { "200": { "$ref": "#/components/responses/getDatabaseLabel200" }, "default": { "$ref": "#/components/responses/getDatabaseLabelDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "database" ], "summary": "Delete label", "description": "Deletes existing label by given {service_uuid} and {key}.", "operationId": "deleteDatabaseLabel", "parameters": [ { "$ref": "#/components/parameters/deleteDatabaseLabelUuid" }, { "$ref": "#/components/parameters/deleteDatabaseLabelLabelKey" } ], "responses": { "204": { "$ref": "#/components/responses/deleteDatabaseLabel204" }, "default": { "$ref": "#/components/responses/deleteDatabaseLabelDefault" } }, "x-upcloud-visibility": "public" }, "patch": { "tags": [ "database" ], "summary": "Modify label", "description": "Modifies existing label by given {service_uuid} and {key}.", "operationId": "modifyDatabaseLabel", "parameters": [ { "$ref": "#/components/parameters/modifyDatabaseLabelUuid" }, { "$ref": "#/components/parameters/modifyDatabaseLabelLabelKey" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyDatabaseLabel" }, "responses": { "200": { "$ref": "#/components/responses/modifyDatabaseLabel200" }, "default": { "$ref": "#/components/responses/modifyDatabaseLabelDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/available-extensions": { "get": { "tags": [ "database" ], "summary": "Get available extensions", "description": "Returns a list of available PostgreSQL extensions for the Managed Database service by its {service-uuid}. Only supported for PostgreSQL services.", "operationId": "getDatabaseAvailableExtensions", "parameters": [ { "$ref": "#/components/parameters/getDatabaseAvailableExtensionsUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getDatabaseAvailableExtensions200" }, "default": { "$ref": "#/components/responses/getDatabaseAvailableExtensionsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/pg/available-extensions": { "get": { "tags": [ "database" ], "summary": "Get available PostgreSQL extensions", "description": "Returns a list of available PostgreSQL extensions grouped by PostgreSQL version.", "operationId": "getPGAvailableExtensions", "responses": { "200": { "$ref": "#/components/responses/databaseGetPGAvailableExtensions200" }, "default": { "$ref": "#/components/responses/databaseGetPGAvailableExtensionsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/versions": { "get": { "tags": [ "database" ], "summary": "Get database type versions", "description": "Returns a list of supported Managed Database service versions.", "operationId": "getDatabaseTypeVersions", "responses": { "200": { "$ref": "#/components/responses/getDatabaseTypeVersions200" }, "default": { "$ref": "#/components/responses/getDatabaseTypeVersionsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/access-control": { "get": { "tags": [ "database" ], "summary": "Get access controls (OpenSearch)", "description": "Return access controls settings for the OpenSearch Managed Database service {uuid}.", "operationId": "getDatabaseAccessControl", "parameters": [ { "$ref": "#/components/parameters/getDatabaseAccessControlUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getDatabaseAccessControl200" }, "default": { "$ref": "#/components/responses/getDatabaseAccessControlDefault" } }, "x-upcloud-visibility": "public" }, "patch": { "tags": [ "database" ], "summary": "Modify access controls (OpenSearch)", "description": "Modifies the user {username} access control for the Managed Database service {uuid}.", "operationId": "modifyDatabaseAccessControl", "parameters": [ { "$ref": "#/components/parameters/modifyDatabaseAccessControlUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyDatabaseAccessControl" }, "responses": { "200": { "$ref": "#/components/responses/modifyDatabaseAccessControl200" }, "default": { "$ref": "#/components/responses/modifyDatabaseAccessControlDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/security": { "get": { "tags": [ "database" ], "summary": "Get Security management status (OpenSearch)", "description": "Returns Security management status for the OpenSearch Managed Database service {uuid}.", "operationId": "getDatabaseSecurity", "parameters": [ { "$ref": "#/components/parameters/getDatabaseSecurityUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getDatabaseSecurity200" }, "default": { "$ref": "#/components/responses/getDatabaseSecurityDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/security/admin": { "put": { "tags": [ "database" ], "summary": "Modify Security management admin password (OpenSearch)", "description": "Modifies Security management admin password for the OpenSearch Managed Database service {uuid}.", "operationId": "modifyDatabaseSecurityAdmin", "parameters": [ { "$ref": "#/components/parameters/modifyDatabaseSecurityAdminUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyDatabaseSecurityAdmin" }, "responses": { "200": { "$ref": "#/components/responses/modifyDatabaseSecurityAdmin200" }, "default": { "$ref": "#/components/responses/modifyDatabaseSecurityAdminDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "database" ], "summary": "Enable Security management admin (OpenSearch)", "description": "Enables Security management admin for the OpenSearch Managed Database service {uuid}.", "operationId": "enableDatabaseSecurityAdmin", "parameters": [ { "$ref": "#/components/parameters/enableDatabaseSecurityAdminUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/enableDatabaseSecurityAdmin" }, "responses": { "201": { "$ref": "#/components/responses/enableDatabaseSecurityAdmin201" }, "default": { "$ref": "#/components/responses/enableDatabaseSecurityAdminDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/integration-endpoints": { "get": { "tags": [ "database" ], "summary": "List integration endpoints", "description": "Returns a list of available integration endpoints.", "operationId": "listDatabaseIntegrationEndpoints", "responses": { "200": { "$ref": "#/components/responses/listDatabaseIntegrationEndpoints200" }, "default": { "$ref": "#/components/responses/listDatabaseIntegrationEndpointsDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "database" ], "summary": "Create integration endpoint", "description": "Creates a new integration endpoint.", "operationId": "createDatabaseIntegrationEndpoint", "requestBody": { "$ref": "#/components/requestBodies/createDatabaseIntegrationEndpoint" }, "responses": { "201": { "$ref": "#/components/responses/createDatabaseIntegrationEndpoint201" }, "default": { "$ref": "#/components/responses/createDatabaseIntegrationEndpointDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/integration-endpoints/{integration-uuid}": { "get": { "tags": [ "database" ], "summary": "Get integration endpoint", "description": "Returns integration endpoint details by given {integration-uuid}.", "operationId": "getDatabaseIntegrationEndpoint", "parameters": [ { "$ref": "#/components/parameters/getDatabaseIntegrationEndpointIntegrationUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getDatabaseIntegrationEndpoint200" }, "default": { "$ref": "#/components/responses/getDatabaseIntegrationEndpointDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "database" ], "summary": "Delete integration endpoint", "description": "Deletes existing integration endpoint by given {integration-uuid}.", "operationId": "deleteDatabaseIntegrationEndpoint", "parameters": [ { "$ref": "#/components/parameters/deleteDatabaseIntegrationEndpointIntegrationUuid" } ], "responses": { "204": { "$ref": "#/components/responses/deleteDatabaseIntegrationEndpoint204" }, "default": { "$ref": "#/components/responses/deleteDatabaseIntegrationEndpointDefault" } }, "x-upcloud-visibility": "public" }, "patch": { "tags": [ "database" ], "summary": "Modify integration endpoint", "description": "Modifies existing integration endpoint by given {integration-uuid}.", "operationId": "modifyDatabaseIntegrationEndpoint", "parameters": [ { "$ref": "#/components/parameters/modifyDatabaseIntegrationEndpointIntegrationUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyDatabaseIntegrationEndpoint" }, "responses": { "200": { "$ref": "#/components/responses/modifyDatabaseIntegrationEndpoint200" }, "default": { "$ref": "#/components/responses/modifyDatabaseIntegrationEndpointDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/certificate": { "get": { "tags": [ "database" ], "summary": "Get account CA certificate", "description": "Returns the CA certificate. Every customer main account has a private Certificate Authority (CA) that signs certificates for internal use. Managed Database service types, such as PostgreSQL, use it for external connections. To access these services, you must download and configure the certificate on your browser or client.", "operationId": "getDatabaseAccountCA", "responses": { "200": { "$ref": "#/components/responses/getDatabaseAccountCA200" }, "default": { "$ref": "#/components/responses/getDatabaseAccountCADefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/alerts": { "get": { "tags": [ "database" ], "summary": "List all alerts", "description": "Returns all the alerts associated with your Managed Database services.", "operationId": "listDatabaseAlerts", "responses": { "200": { "$ref": "#/components/responses/listDatabaseAlerts200" }, "default": { "$ref": "#/components/responses/listDatabaseAlertsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/status": { "get": { "tags": [ "database" ], "summary": "Get database status", "description": "Get a service's status by the given {service-uuid}.", "operationId": "getDatabaseStatus", "parameters": [ { "$ref": "#/components/parameters/getDatabaseStatusUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getDatabaseStatus200" }, "default": { "$ref": "#/components/responses/getDatabaseStatusDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/versions": { "get": { "tags": [ "database" ], "summary": "Get database versions", "description": "Returns available versions of the Managed Database service by its {uuid}.", "operationId": "getDatabaseVersions", "parameters": [ { "$ref": "#/components/parameters/getDatabaseVersionsUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getDatabaseVersions200" }, "default": { "$ref": "#/components/responses/getDatabaseVersionsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/start-maintenance": { "put": { "tags": [ "database" ], "summary": "Start manual maintenance", "description": "Start maintenance updates for your Managed Database service if any updates are pending.", "operationId": "startDatabaseManualMaintenance", "parameters": [ { "$ref": "#/components/parameters/startDatabaseManualMaintenanceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/startDatabaseManualMaintenance200" }, "default": { "$ref": "#/components/responses/startDatabaseManualMaintenanceDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/enable-writes": { "post": { "tags": [ "database" ], "summary": "Enable temporary writes", "description": "Enable temporary writes by the given {service-uuid}.", "operationId": "enableDatabaseTemporaryWrites", "parameters": [ { "$ref": "#/components/parameters/enableDatabaseTemporaryWritesUuid" } ], "responses": { "201": { "$ref": "#/components/responses/enableDatabaseTemporaryWrites201" }, "default": { "$ref": "#/components/responses/enableDatabaseTemporaryWritesDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/migration-status": { "get": { "tags": [ "database" ], "summary": "Get database migration status", "description": "Returns details about the migration progress over time of a Managed database service by its {uuid}.", "operationId": "getDatabaseMigrationStatus", "parameters": [ { "$ref": "#/components/parameters/getDatabaseMigrationStatusUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getDatabaseMigrationStatus200" }, "default": { "$ref": "#/components/responses/getDatabaseMigrationStatusDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/alerts": { "get": { "tags": [ "database" ], "summary": "Get database alerts", "description": "Returns alerts for Managed Database service identified by `{uuid}`.", "operationId": "getDatabaseAlerts", "parameters": [ { "$ref": "#/components/parameters/getDatabaseAlertsUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getDatabaseAlerts200" }, "default": { "$ref": "#/components/responses/getDatabaseAlertsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/metrics": { "get": { "tags": [ "database" ], "summary": "Get database metrics", "description": "Returns metrics related to a Managed Database service by its {uuid} and query parameter {period}.", "operationId": "getDatabaseMetrics", "parameters": [ { "$ref": "#/components/parameters/getDatabaseMetricsUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getDatabaseMetrics200" }, "default": { "$ref": "#/components/responses/getDatabaseMetricsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/query-statistics": { "get": { "tags": [ "database" ], "summary": "Get query statistics (MySQL / PostgreSQL)", "description": "Returns a list of query statistics for the Managed Database service by its {uuid} and optional query parameters {limit}, {offset} and {order}. Query statistics will differ depending on the database type.", "operationId": "getDatabaseQueryStatistics", "parameters": [ { "$ref": "#/components/parameters/getDatabaseQueryStatisticsUuid" }, { "$ref": "#/components/parameters/getDatabaseQueryStatisticsLimit" }, { "$ref": "#/components/parameters/getDatabaseQueryStatisticsOffset" }, { "$ref": "#/components/parameters/getDatabaseQueryStatisticsOrder" } ], "responses": { "200": { "$ref": "#/components/responses/getDatabaseQueryStatistics200" }, "default": { "$ref": "#/components/responses/getDatabaseQueryStatisticsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/logs": { "get": { "tags": [ "database" ], "summary": "List logs", "description": "Returns Managed Database service system-level logs by its {uuid} and optional query parameters {limit}, {offset} and {order}.", "operationId": "getDatabaseLogs", "parameters": [ { "$ref": "#/components/parameters/getDatabaseLogsUuid" }, { "$ref": "#/components/parameters/getDatabaseLogsLimit" }, { "$ref": "#/components/parameters/getDatabaseLogsOffset" }, { "$ref": "#/components/parameters/getDatabaseLogsOrder" } ], "responses": { "200": { "$ref": "#/components/responses/getDatabaseLogs200" }, "default": { "$ref": "#/components/responses/getDatabaseLogsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/connection-pools": { "get": { "tags": [ "database" ], "summary": "List connection pools", "description": "Returns a list of available connection pools for a Managed Database service. Connection pools are available only for PostgreSQL database services.", "operationId": "listDatabaseConnectionPools", "parameters": [ { "$ref": "#/components/parameters/listDatabaseConnectionPoolsUuid" }, { "$ref": "#/components/parameters/listDatabaseConnectionPoolsSort" } ], "responses": { "200": { "$ref": "#/components/responses/listDatabaseConnectionPools200" }, "default": { "$ref": "#/components/responses/listDatabaseConnectionPoolsDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "database" ], "summary": "Create connection pool", "description": "Creates a connection pool for the Managed Database service {uuid}. Connection pool endpoints are for PostgreSQL Managed Databases only.", "operationId": "createDatabaseConnectionPool", "parameters": [ { "$ref": "#/components/parameters/createDatabaseConnectionPoolUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createDatabaseConnectionPool" }, "responses": { "201": { "$ref": "#/components/responses/createDatabaseConnectionPool201" }, "default": { "$ref": "#/components/responses/createDatabaseConnectionPoolDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/connection-pools/{pool-name}": { "get": { "tags": [ "database" ], "summary": "Get connection pool", "description": "Returns the connection pool {pool-name} details for the Managed Database service {uuid}.", "operationId": "getDatabaseConnectionPool", "parameters": [ { "$ref": "#/components/parameters/getDatabaseConnectionPoolUuid" }, { "$ref": "#/components/parameters/getDatabaseConnectionPoolPoolName" } ], "responses": { "200": { "$ref": "#/components/responses/getDatabaseConnectionPool200" }, "default": { "$ref": "#/components/responses/getDatabaseConnectionPoolDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "database" ], "summary": "Delete connection pool", "description": "Deletes the connection pool {pool-name} for the Managed Database service {uuid}.", "operationId": "deleteDatabaseConnectionPool", "parameters": [ { "$ref": "#/components/parameters/deleteDatabaseConnectionPoolUuid" }, { "$ref": "#/components/parameters/deleteDatabaseConnectionPoolPoolName" } ], "responses": { "204": { "$ref": "#/components/responses/deleteDatabaseConnectionPool204" }, "default": { "$ref": "#/components/responses/deleteDatabaseConnectionPoolDefault" } }, "x-upcloud-visibility": "public" }, "patch": { "tags": [ "database" ], "summary": "Modify connection pool", "description": "Modifies the connection pool {pool-name} for the Managed Database service {uuid}.", "operationId": "modifyDatabaseConnectionPool", "parameters": [ { "$ref": "#/components/parameters/modifyDatabaseConnectionPoolUuid" }, { "$ref": "#/components/parameters/modifyDatabaseConnectionPoolPoolName" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyDatabaseConnectionPool" }, "responses": { "200": { "$ref": "#/components/responses/modifyDatabaseConnectionPool200" }, "default": { "$ref": "#/components/responses/modifyDatabaseConnectionPoolDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/indices": { "get": { "tags": [ "database" ], "summary": "List indices (OpenSearch)", "description": "Returns a list of available indices for a Managed Database service {uuid}.", "operationId": "listDatabaseIndices", "parameters": [ { "$ref": "#/components/parameters/listDatabaseIndicesUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listDatabaseIndices200" }, "default": { "$ref": "#/components/responses/listDatabaseIndicesDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/indices/{index-name}": { "delete": { "tags": [ "database" ], "summary": "Delete index (OpenSearch)", "description": "Deletes the index {index_name} for the Managed Database service {uuid}.", "operationId": "deleteDatabaseIndex", "parameters": [ { "$ref": "#/components/parameters/deleteDatabaseIndexUuid" }, { "$ref": "#/components/parameters/deleteDatabaseIndexIndexName" } ], "responses": { "204": { "$ref": "#/components/responses/deleteDatabaseIndex204" }, "default": { "$ref": "#/components/responses/deleteDatabaseIndexDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/integrations": { "get": { "tags": [ "database" ], "summary": "List integrations", "description": "Returns a list of available service integrations by given {service-uuid}.", "operationId": "listDatabaseIntegrations", "parameters": [ { "$ref": "#/components/parameters/listDatabaseIntegrationsUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listDatabaseIntegrations200" }, "default": { "$ref": "#/components/responses/listDatabaseIntegrationsDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "database" ], "summary": "Create integration", "description": "Creates a new integration by given {service-uuid}.", "operationId": "createDatabaseIntegration", "parameters": [ { "$ref": "#/components/parameters/createDatabaseIntegrationUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createDatabaseIntegration" }, "responses": { "201": { "$ref": "#/components/responses/createDatabaseIntegration201" }, "default": { "$ref": "#/components/responses/createDatabaseIntegrationDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/integrations/{integration-uuid}": { "get": { "tags": [ "database" ], "summary": "Get integration", "description": "Returns integration details by given {service-uuid} and {integration-uuid}.", "operationId": "getDatabaseIntegration", "parameters": [ { "$ref": "#/components/parameters/getDatabaseIntegrationUuid" }, { "$ref": "#/components/parameters/getDatabaseIntegrationIntegrationUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getDatabaseIntegration200" }, "default": { "$ref": "#/components/responses/getDatabaseIntegrationDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "database" ], "summary": "Delete integration", "description": "Deletes existing integration by given {service-uuid} and {integration-uuid}.", "operationId": "deleteDatabaseIntegration", "parameters": [ { "$ref": "#/components/parameters/deleteDatabaseIntegrationUuid" }, { "$ref": "#/components/parameters/deleteDatabaseIntegrationIntegrationUuid" } ], "responses": { "204": { "$ref": "#/components/responses/deleteDatabaseIntegration204" }, "default": { "$ref": "#/components/responses/deleteDatabaseIntegrationDefault" } }, "x-upcloud-visibility": "public" }, "patch": { "tags": [ "database" ], "summary": "Modify integration", "description": "Modifies existing integration by given {service-uuid} and {integration-uuid}.", "operationId": "modifyDatabaseIntegration", "parameters": [ { "$ref": "#/components/parameters/modifyDatabaseIntegrationUuid" }, { "$ref": "#/components/parameters/modifyDatabaseIntegrationIntegrationUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyDatabaseIntegration" }, "responses": { "200": { "$ref": "#/components/responses/modifyDatabaseIntegration200" }, "default": { "$ref": "#/components/responses/modifyDatabaseIntegrationDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/databases": { "get": { "tags": [ "database" ], "summary": "List logical databases", "description": "Returns a list of logical databases for a Managed Database service identified by {uuid}.", "operationId": "listDatabaseLogicalDatabases", "parameters": [ { "$ref": "#/components/parameters/listDatabaseLogicalDatabasesUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listDatabaseLogicalDatabases200" }, "default": { "$ref": "#/components/responses/listDatabaseLogicalDatabasesDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "database" ], "summary": "Create logical database", "description": "Creates a new logical database for the Managed Database service {uuid}.", "operationId": "createDatabaseLogicalDatabase", "parameters": [ { "$ref": "#/components/parameters/createDatabaseLogicalDatabaseUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createDatabaseLogicalDatabase" }, "responses": { "201": { "$ref": "#/components/responses/createDatabaseLogicalDatabase201" }, "default": { "$ref": "#/components/responses/createDatabaseLogicalDatabaseDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/databases/{database-name}": { "delete": { "tags": [ "database" ], "summary": "Delete logical database", "description": "Deletes the logical database {database_name} from the Managed Database service {uuid}.", "operationId": "deleteDatabaseLogicalDatabase", "parameters": [ { "$ref": "#/components/parameters/deleteDatabaseLogicalDatabaseUuid" }, { "$ref": "#/components/parameters/deleteDatabaseLogicalDatabaseDatabaseName" } ], "responses": { "204": { "$ref": "#/components/responses/deleteDatabaseLogicalDatabase204" }, "default": { "$ref": "#/components/responses/deleteDatabaseLogicalDatabaseDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/peering-status": { "get": { "tags": [ "database" ], "summary": "Get service peerings status", "description": "Returns networks peering status for a service by its {uuid}. Only available for services using SDN private networks.", "operationId": "getDatabasePeeringsStatus", "parameters": [ { "$ref": "#/components/parameters/getDatabasePeeringsStatusUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getDatabasePeeringsStatus200" }, "default": { "$ref": "#/components/responses/getDatabasePeeringsStatusDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/sessions": { "get": { "tags": [ "database" ], "summary": "List sessions", "description": "Returns a list of current sessions details for your Managed Database service by its {uuid} and optional query parameters {limit}, {offset} and {order}.", "operationId": "getDatabaseSessions", "parameters": [ { "$ref": "#/components/parameters/getDatabaseSessionsUuid" }, { "$ref": "#/components/parameters/getDatabaseSessionsLimit" }, { "$ref": "#/components/parameters/getDatabaseSessionsOffset" }, { "$ref": "#/components/parameters/getDatabaseSessionsOrder" } ], "responses": { "200": { "$ref": "#/components/responses/getDatabaseSessions200" }, "default": { "$ref": "#/components/responses/getDatabaseSessionsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/sessions/{pid}": { "delete": { "tags": [ "database" ], "summary": "Terminate session", "description": "Terminates a sessions or kills a running query for a Managed Database service by its {uuid}, session {pid} and optional query parameter {terminate}.", "operationId": "terminateDatabaseSession", "parameters": [ { "$ref": "#/components/parameters/terminateDatabaseSessionUuid" }, { "$ref": "#/components/parameters/terminateDatabaseSessionPid" } ], "responses": { "204": { "$ref": "#/components/responses/terminateDatabaseSession204" }, "default": { "$ref": "#/components/responses/terminateDatabaseSessionDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/tasks": { "post": { "tags": [ "database" ], "summary": "Create task", "description": "Creates a task that checks for potential errors before starting a migration or upgrade for a Managed Database service by its {uuid}.", "operationId": "createDatabaseTask", "parameters": [ { "$ref": "#/components/parameters/createDatabaseTaskUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createDatabaseTask" }, "responses": { "201": { "$ref": "#/components/responses/createDatabaseTask201" }, "default": { "$ref": "#/components/responses/createDatabaseTaskDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/tasks/{task-id}": { "get": { "tags": [ "database" ], "summary": "Get task", "description": "Returns task details of a Managed Database service by its {uuid} and the task {id} obtained from Create Managed Database task.", "operationId": "getDatabaseTask", "parameters": [ { "$ref": "#/components/parameters/getDatabaseTaskUuid" }, { "$ref": "#/components/parameters/getDatabaseTaskTaskId" } ], "responses": { "200": { "$ref": "#/components/responses/getDatabaseTask200" }, "default": { "$ref": "#/components/responses/getDatabaseTaskDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/users": { "get": { "tags": [ "database" ], "summary": "List users", "description": "Returns a list of database users associated with the Managed Database service {uuid}.", "operationId": "listDatabaseUsers", "parameters": [ { "$ref": "#/components/parameters/listDatabaseUsersUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listDatabaseUsers200" }, "default": { "$ref": "#/components/responses/listDatabaseUsersDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "database" ], "summary": "Create user", "description": "Creates a new user for the Managed Database service {uuid}.", "operationId": "createDatabaseUser", "parameters": [ { "$ref": "#/components/parameters/createDatabaseUserUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createDatabaseUser" }, "responses": { "201": { "$ref": "#/components/responses/createDatabaseUser201" }, "default": { "$ref": "#/components/responses/createDatabaseUserDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/users/{username}": { "get": { "tags": [ "database" ], "summary": "Get user", "description": "Returns the user {username} details for the Managed Database service {uuid}.", "operationId": "getDatabaseUser", "parameters": [ { "$ref": "#/components/parameters/getDatabaseUserUuid" }, { "$ref": "#/components/parameters/getDatabaseUserUsername" } ], "responses": { "200": { "$ref": "#/components/responses/getDatabaseUser200" }, "default": { "$ref": "#/components/responses/getDatabaseUserDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "database" ], "summary": "Delete user", "description": "Deletes the user {username} from the Managed Database service {uuid}.", "operationId": "deleteDatabaseUser", "parameters": [ { "$ref": "#/components/parameters/deleteDatabaseUserUuid" }, { "$ref": "#/components/parameters/deleteDatabaseUserUsername" } ], "responses": { "204": { "$ref": "#/components/responses/deleteDatabaseUser204" }, "default": { "$ref": "#/components/responses/deleteDatabaseUserDefault" } }, "x-upcloud-visibility": "public" }, "patch": { "tags": [ "database" ], "summary": "Modify user", "description": "Modifies the user {username} details for the Managed Database service {uuid}.", "operationId": "modifyDatabaseUser", "parameters": [ { "$ref": "#/components/parameters/modifyDatabaseUserUuid" }, { "$ref": "#/components/parameters/modifyDatabaseUserUsername" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyDatabaseUser" }, "responses": { "200": { "$ref": "#/components/responses/modifyDatabaseUser200" }, "default": { "$ref": "#/components/responses/modifyDatabaseUserDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/database/{uuid}/users/{username}/access-control": { "patch": { "tags": [ "database" ], "summary": "Modify user access control", "description": "Return access controls settings for the OpenSearch Managed Database service {uuid}.", "operationId": "modifyDatabaseUserAccessControl", "parameters": [ { "$ref": "#/components/parameters/modifyDatabaseUserAccessControlUuid" }, { "$ref": "#/components/parameters/modifyDatabaseUserAccessControlUsername" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyDatabaseUserAccessControl" }, "responses": { "200": { "$ref": "#/components/responses/modifyDatabaseUserAccessControl200" }, "default": { "$ref": "#/components/responses/modifyDatabaseUserAccessControlDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/gateway/plans": { "get": { "tags": [ "gateway" ], "summary": "List Plans", "description": "List available plans.", "operationId": "listGatewayPlans", "parameters": [ { "$ref": "#/components/parameters/listGatewayPlansLimit" }, { "$ref": "#/components/parameters/listGatewayPlansOffset" } ], "responses": { "200": { "$ref": "#/components/responses/listGatewayPlans200" }, "default": { "$ref": "#/components/responses/listGatewayPlansDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/gateway/plans/{plan-name}": { "get": { "tags": [ "gateway" ], "summary": "Get Plan Details", "description": "Get plan details.", "operationId": "getGatewayPlan", "parameters": [ { "$ref": "#/components/parameters/getGatewayPlanPlanName" } ], "responses": { "200": { "$ref": "#/components/responses/getGatewayPlan200" }, "default": { "$ref": "#/components/responses/getGatewayPlanDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/gateway": { "get": { "tags": [ "gateway" ], "summary": "List Services", "description": "List available services.", "operationId": "listGatewayServices", "parameters": [ { "$ref": "#/components/parameters/listGatewayServicesLimit" }, { "$ref": "#/components/parameters/listGatewayServicesOffset" }, { "$ref": "#/components/parameters/listGatewayServicesSort" } ], "responses": { "200": { "$ref": "#/components/responses/listGatewayServices200" }, "default": { "$ref": "#/components/responses/listGatewayServicesDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "gateway" ], "summary": "Create Service", "description": "Create a new service.", "operationId": "createGatewayService", "requestBody": { "$ref": "#/components/requestBodies/createGatewayService" }, "responses": { "200": { "$ref": "#/components/responses/createGatewayService200" }, "default": { "$ref": "#/components/responses/createGatewayServiceDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/gateway/{service-uuid}": { "get": { "tags": [ "gateway" ], "summary": "Get Service Details", "description": "Get service details.", "operationId": "getGatewayService", "parameters": [ { "$ref": "#/components/parameters/getGatewayServiceServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getGatewayService200" }, "default": { "$ref": "#/components/responses/getGatewayServiceDefault" } }, "x-upcloud-visibility": "public" }, "put": { "tags": [ "gateway" ], "summary": "Replace Service", "description": "Replace service configuration.", "operationId": "replaceGatewayService", "parameters": [ { "$ref": "#/components/parameters/replaceGatewayServiceServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/replaceGatewayService" }, "responses": { "200": { "$ref": "#/components/responses/replaceGatewayService200" }, "default": { "$ref": "#/components/responses/replaceGatewayServiceDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "gateway" ], "summary": "Delete Service", "description": "Deletes existing service by given {service-identifier}.", "operationId": "deleteGatewayService", "parameters": [ { "$ref": "#/components/parameters/deleteGatewayServiceServiceUuid" } ], "responses": { "204": { "$ref": "#/components/responses/deleteGatewayService204" }, "default": { "$ref": "#/components/responses/deleteGatewayServiceDefault" } }, "x-upcloud-visibility": "public" }, "patch": { "tags": [ "gateway" ], "summary": "Modify Service", "description": "Modify service configuration.", "operationId": "modifyGatewayService", "parameters": [ { "$ref": "#/components/parameters/modifyGatewayServiceServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyGatewayService" }, "responses": { "200": { "$ref": "#/components/responses/modifyGatewayService200" }, "default": { "$ref": "#/components/responses/modifyGatewayServiceDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/gateway/{service-uuid}/actions/nat-flush-connections": { "patch": { "tags": [ "gateway" ], "summary": "Flush NAT", "description": "Flush NAT rules.", "operationId": "flushGatewayNat", "parameters": [ { "$ref": "#/components/parameters/flushGatewayNatServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/flushGatewayNat200" }, "default": { "$ref": "#/components/responses/flushGatewayNatDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/gateway/{service-uuid}/connections": { "get": { "tags": [ "gateway" ], "summary": "List Connections", "description": "List available connections for service.", "operationId": "listGatewayConnections", "parameters": [ { "$ref": "#/components/parameters/listGatewayConnectionsServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listGatewayConnections200" }, "default": { "$ref": "#/components/responses/listGatewayConnectionsDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "gateway" ], "summary": "Create Connection", "description": "Create a new connection.", "operationId": "createGatewayConnection", "parameters": [ { "$ref": "#/components/parameters/createGatewayConnectionServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createGatewayConnection" }, "responses": { "200": { "$ref": "#/components/responses/createGatewayConnection200" }, "default": { "$ref": "#/components/responses/createGatewayConnectionDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/gateway/{service-uuid}/connections/{connection-uuid}": { "get": { "tags": [ "gateway" ], "summary": "Get Connection Details", "description": "Get connection details.", "operationId": "getGatewayConnection", "parameters": [ { "$ref": "#/components/parameters/getGatewayConnectionServiceUuid" }, { "$ref": "#/components/parameters/getGatewayConnectionConnectionUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getGatewayConnection200" }, "default": { "$ref": "#/components/responses/getGatewayConnectionDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "gateway" ], "summary": "Delete Connection", "description": "Deletes existing connection by given {connection-identifier}.", "operationId": "deleteGatewayConnection", "parameters": [ { "$ref": "#/components/parameters/deleteGatewayConnectionServiceUuid" }, { "$ref": "#/components/parameters/deleteGatewayConnectionConnectionUuid" } ], "responses": { "204": { "$ref": "#/components/responses/deleteGatewayConnection204" }, "default": { "$ref": "#/components/responses/deleteGatewayConnectionDefault" } }, "x-upcloud-visibility": "public" }, "patch": { "tags": [ "gateway" ], "summary": "Modify Connection", "description": "Modify connection configuration.", "operationId": "modifyGatewayConnection", "parameters": [ { "$ref": "#/components/parameters/modifyGatewayConnectionServiceUuid" }, { "$ref": "#/components/parameters/modifyGatewayConnectionConnectionUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyGatewayConnection" }, "responses": { "200": { "$ref": "#/components/responses/modifyGatewayConnection200" }, "default": { "$ref": "#/components/responses/modifyGatewayConnectionDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/gateway/{service-uuid}/connections/{connection-uuid}/tunnels": { "get": { "tags": [ "gateway" ], "summary": "List Tunnels", "description": "List available tunnels for service.", "operationId": "listGatewayTunnels", "parameters": [ { "$ref": "#/components/parameters/listGatewayTunnelsServiceUuid" }, { "$ref": "#/components/parameters/listGatewayTunnelsConnectionUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listGatewayTunnels200" }, "default": { "$ref": "#/components/responses/listGatewayTunnelsDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "gateway" ], "summary": "Create Tunnel", "description": "Create a new tunnel.", "operationId": "createGatewayTunnel", "parameters": [ { "$ref": "#/components/parameters/createGatewayTunnelServiceUuid" }, { "$ref": "#/components/parameters/createGatewayTunnelConnectionUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createGatewayTunnel" }, "responses": { "200": { "$ref": "#/components/responses/createGatewayTunnel200" }, "default": { "$ref": "#/components/responses/createGatewayTunnelDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/gateway/{service-uuid}/connections/{connection-uuid}/tunnels/{tunnel-uuid}": { "get": { "tags": [ "gateway" ], "summary": "Get Tunnel Details", "description": "Get tunnel details.", "operationId": "getGatewayTunnel", "parameters": [ { "$ref": "#/components/parameters/getGatewayTunnelServiceUuid" }, { "$ref": "#/components/parameters/getGatewayTunnelConnectionUuid" }, { "$ref": "#/components/parameters/getGatewayTunnelTunnelUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getGatewayTunnel200" }, "default": { "$ref": "#/components/responses/getGatewayTunnelDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "gateway" ], "summary": "Delete Tunnel", "description": "Deletes existing tunnel by given {tunnel-identifier}.", "operationId": "deleteGatewayTunnel", "parameters": [ { "$ref": "#/components/parameters/deleteGatewayTunnelServiceUuid" }, { "$ref": "#/components/parameters/deleteGatewayTunnelConnectionUuid" }, { "$ref": "#/components/parameters/deleteGatewayTunnelTunnelUuid" } ], "responses": { "204": { "$ref": "#/components/responses/deleteGatewayTunnel204" }, "default": { "$ref": "#/components/responses/deleteGatewayTunnelDefault" } }, "x-upcloud-visibility": "public" }, "patch": { "tags": [ "gateway" ], "summary": "Modify Tunnel", "description": "Modify tunnel configuration.", "operationId": "modifyGatewayTunnel", "parameters": [ { "$ref": "#/components/parameters/modifyGatewayTunnelServiceUuid" }, { "$ref": "#/components/parameters/modifyGatewayTunnelConnectionUuid" }, { "$ref": "#/components/parameters/modifyGatewayTunnelTunnelUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyGatewayTunnel" }, "responses": { "200": { "$ref": "#/components/responses/modifyGatewayTunnel200" }, "default": { "$ref": "#/components/responses/modifyGatewayTunnelDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/gateway/{service-uuid}/labels": { "get": { "tags": [ "gateway" ], "summary": "List Service Labels", "description": "List available service labels for service.", "operationId": "listGatewayServiceLabels", "parameters": [ { "$ref": "#/components/parameters/listGatewayServiceLabelsServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listGatewayServiceLabels200" }, "default": { "$ref": "#/components/responses/listGatewayServiceLabelsDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "gateway" ], "summary": "Create Service Label", "description": "Create a new service label.", "operationId": "createGatewayServiceLabel", "parameters": [ { "$ref": "#/components/parameters/createGatewayServiceLabelServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createGatewayServiceLabel" }, "responses": { "201": { "$ref": "#/components/responses/createGatewayServiceLabel201" }, "default": { "$ref": "#/components/responses/createGatewayServiceLabelDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/gateway/{service-uuid}/labels/{label-key}": { "get": { "tags": [ "gateway" ], "summary": "Get Service Label Details", "description": "Get service label details.", "operationId": "getGatewayServiceLabel", "parameters": [ { "$ref": "#/components/parameters/getGatewayServiceLabelServiceUuid" }, { "$ref": "#/components/parameters/getGatewayServiceLabelLabelKey" } ], "responses": { "200": { "$ref": "#/components/responses/getGatewayServiceLabel200" }, "default": { "$ref": "#/components/responses/getGatewayServiceLabelDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "gateway" ], "summary": "Delete Service Label", "description": "Deletes existing service label by given {service-label-identifier}.", "operationId": "deleteGatewayServiceLabel", "parameters": [ { "$ref": "#/components/parameters/deleteGatewayServiceLabelServiceUuid" }, { "$ref": "#/components/parameters/deleteGatewayServiceLabelLabelKey" } ], "responses": { "204": { "$ref": "#/components/responses/deleteGatewayServiceLabel204" }, "default": { "$ref": "#/components/responses/deleteGatewayServiceLabelDefault" } }, "x-upcloud-visibility": "public" }, "patch": { "tags": [ "gateway" ], "summary": "Modify Service Label", "description": "Modify service label configuration.", "operationId": "modifyGatewayServiceLabel", "parameters": [ { "$ref": "#/components/parameters/modifyGatewayServiceLabelServiceUuid" }, { "$ref": "#/components/parameters/modifyGatewayServiceLabelLabelKey" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyGatewayServiceLabel" }, "responses": { "200": { "$ref": "#/components/responses/modifyGatewayServiceLabel200" }, "default": { "$ref": "#/components/responses/modifyGatewayServiceLabelDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/gateway/{service-uuid}/addresses": { "get": { "tags": [ "gateway" ], "summary": "List Service Addresses", "description": "List available service addresses for service.", "operationId": "listGatewayAddresses", "parameters": [ { "$ref": "#/components/parameters/listGatewayAddressesServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listGatewayAddresses200" }, "default": { "$ref": "#/components/responses/listGatewayAddressesDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/gateway/{service-uuid}/addresses/{address-name}": { "get": { "tags": [ "gateway" ], "summary": "Get Service Address Details", "description": "Get service address details.", "operationId": "getGatewayAddress", "parameters": [ { "$ref": "#/components/parameters/getGatewayAddressServiceUuid" }, { "$ref": "#/components/parameters/getGatewayAddressAddressName" } ], "responses": { "200": { "$ref": "#/components/responses/getGatewayAddress200" }, "default": { "$ref": "#/components/responses/getGatewayAddressDefault" } }, "x-upcloud-visibility": "public" }, "patch": { "tags": [ "gateway" ], "summary": "Modify Service Address", "description": "Modify existing service address by given {service-address-identifier}.", "operationId": "modifyGatewayAddress", "parameters": [ { "$ref": "#/components/parameters/modifyGatewayAddressServiceUuid" }, { "$ref": "#/components/parameters/modifyGatewayAddressAddressName" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyGatewayAddress" }, "responses": { "200": { "$ref": "#/components/responses/modifyGatewayAddress200" }, "default": { "$ref": "#/components/responses/modifyGatewayAddressDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/gateway/{service-uuid}/addresses/{address-name}/release": { "post": { "tags": [ "gateway" ], "summary": "Release Gateway Floating IP", "description": "Release the user-provisioned Floating IP of an existing service address by given {service-address-identifier}, reverting it to a service-provisioned address while keeping the same name.", "operationId": "releaseGatewayFloatingIp", "parameters": [ { "$ref": "#/components/parameters/releaseGatewayFloatingIpServiceUuid" }, { "$ref": "#/components/parameters/releaseGatewayFloatingIpAddressName" } ], "responses": { "202": { "$ref": "#/components/responses/releaseGatewayFloatingIp202" }, "default": { "$ref": "#/components/responses/releaseGatewayFloatingIpDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/gateway/{service-uuid}/metrics": { "get": { "tags": [ "gateway" ], "summary": "Get Service Metrics", "description": "List available service metrics for service.", "operationId": "getGatewayMetrics", "parameters": [ { "$ref": "#/components/parameters/getGatewayMetricsServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getGatewayMetrics200" }, "default": { "$ref": "#/components/responses/getGatewayMetricsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/gateway/{service-uuid}/logs": { "post": { "tags": [ "gateway" ], "summary": "Create Service Log Session", "description": "Create a new service log session.", "operationId": "createGatewayServiceLogSession", "parameters": [ { "$ref": "#/components/parameters/createGatewayServiceLogSessionServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createGatewayServiceLogSession" }, "responses": { "200": { "$ref": "#/components/responses/createGatewayServiceLogSession200" }, "default": { "$ref": "#/components/responses/createGatewayServiceLogSessionDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/load-balancer": { "get": { "tags": [ "load-balancer" ], "summary": "List load balancers", "description": "Returns a list of available load balancer services.", "operationId": "listLoadBalancers", "parameters": [ { "$ref": "#/components/parameters/listLoadBalancersLimit" }, { "$ref": "#/components/parameters/listLoadBalancersOffset" }, { "$ref": "#/components/parameters/listLoadBalancersSort" }, { "$ref": "#/components/parameters/listLoadBalancersLabel" } ], "responses": { "200": { "$ref": "#/components/responses/listLoadBalancers200" }, "default": { "$ref": "#/components/responses/listLoadBalancersDefault" } } }, "post": { "tags": [ "load-balancer" ], "summary": "Create load balancer", "description": "Creates a new load balancer service.", "operationId": "createLoadBalancer", "requestBody": { "$ref": "#/components/requestBodies/createLoadBalancer" }, "responses": { "201": { "$ref": "#/components/responses/createLoadBalancer201" }, "default": { "$ref": "#/components/responses/createLoadBalancerDefault" } } } }, "/1.3/load-balancer/{service-uuid}": { "get": { "tags": [ "load-balancer" ], "summary": "Get load balancer", "description": "Returns load balancer service details by given {service-uuid}.", "operationId": "getLoadBalancer", "parameters": [ { "$ref": "#/components/parameters/getLoadBalancerServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getLoadBalancer200" }, "default": { "$ref": "#/components/responses/getLoadBalancerDefault" } } }, "put": { "tags": [ "load-balancer" ], "summary": "Replace load balancer", "description": "Replaces existing load balancer service by given {service-uuid}.", "operationId": "replaceLoadBalancer", "parameters": [ { "$ref": "#/components/parameters/replaceLoadBalancerServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/replaceLoadBalancer" }, "responses": { "200": { "$ref": "#/components/responses/replaceLoadBalancer200" }, "default": { "$ref": "#/components/responses/replaceLoadBalancerDefault" } } }, "delete": { "tags": [ "load-balancer" ], "summary": "Delete load balancer", "description": "Deletes existing load balancer service by given {service-uuid}.", "operationId": "deleteLoadBalancer", "parameters": [ { "$ref": "#/components/parameters/deleteLoadBalancerServiceUuid" } ], "responses": { "204": { "$ref": "#/components/responses/deleteLoadBalancer204" }, "default": { "$ref": "#/components/responses/deleteLoadBalancerDefault" } } }, "patch": { "tags": [ "load-balancer" ], "summary": "Modify load balancer", "description": "Modifies existing load balancer service by given {service-uuid}.", "operationId": "modifyLoadBalancer", "parameters": [ { "$ref": "#/components/parameters/modifyLoadBalancerServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyLoadBalancer" }, "responses": { "200": { "$ref": "#/components/responses/modifyLoadBalancer200" }, "default": { "$ref": "#/components/responses/modifyLoadBalancerDefault" } } } }, "/1.3/load-balancer/{service-uuid}/frontends": { "get": { "tags": [ "load-balancer" ], "summary": "List load balancer frontends", "description": "Returns a list of available service frontends by given {service-uuid}.", "operationId": "listLoadBalancerFrontends", "parameters": [ { "$ref": "#/components/parameters/listLoadBalancerFrontendsServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listLoadBalancerFrontends200" }, "default": { "$ref": "#/components/responses/listLoadBalancerFrontendsDefault" } } }, "post": { "tags": [ "load-balancer" ], "summary": "Create load balancer frontend", "description": "Creates a new service frontend by given {service-uuid}.", "operationId": "createLoadBalancerFrontend", "parameters": [ { "$ref": "#/components/parameters/createLoadBalancerFrontendServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createLoadBalancerFrontend" }, "responses": { "201": { "$ref": "#/components/responses/createLoadBalancerFrontend201" }, "default": { "$ref": "#/components/responses/createLoadBalancerFrontendDefault" } } } }, "/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}": { "get": { "tags": [ "load-balancer" ], "summary": "Get load balancer frontend", "description": "Returns service frontend details by given {service-uuid} and {frontend-name}.", "operationId": "getLoadBalancerFrontend", "parameters": [ { "$ref": "#/components/parameters/getLoadBalancerFrontendServiceUuid" }, { "$ref": "#/components/parameters/getLoadBalancerFrontendFrontendName" } ], "responses": { "200": { "$ref": "#/components/responses/getLoadBalancerFrontend200" }, "default": { "$ref": "#/components/responses/getLoadBalancerFrontendDefault" } } }, "delete": { "tags": [ "load-balancer" ], "summary": "Delete load balancer frontend", "description": "Deletes existing frontend by given {service-uuid} and {frontend-name}.", "operationId": "deleteLoadBalancerFrontend", "parameters": [ { "$ref": "#/components/parameters/deleteLoadBalancerFrontendServiceUuid" }, { "$ref": "#/components/parameters/deleteLoadBalancerFrontendFrontendName" } ], "responses": { "204": { "$ref": "#/components/responses/deleteLoadBalancerFrontend204" }, "default": { "$ref": "#/components/responses/deleteLoadBalancerFrontendDefault" } } }, "patch": { "tags": [ "load-balancer" ], "summary": "Modify load balancer frontend", "description": "Modifies existing service frontend by given {service-uuid} and {frontend-name}.", "operationId": "modifyLoadBalancerFrontend", "parameters": [ { "$ref": "#/components/parameters/modifyLoadBalancerFrontendServiceUuid" }, { "$ref": "#/components/parameters/modifyLoadBalancerFrontendFrontendName" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyLoadBalancerFrontend" }, "responses": { "200": { "$ref": "#/components/responses/modifyLoadBalancerFrontend200" }, "default": { "$ref": "#/components/responses/modifyLoadBalancerFrontendDefault" } } } }, "/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/tls-configs": { "get": { "tags": [ "load-balancer" ], "summary": "List load balancer frontend TLS configs", "description": "Returns a list of available frontend TLS configs by given {service-uuid} and {frontend-name}.", "operationId": "listLoadBalancerFrontendTlsConfigs", "parameters": [ { "$ref": "#/components/parameters/listLoadBalancerFrontendTlsConfigsServiceUuid" }, { "$ref": "#/components/parameters/listLoadBalancerFrontendTlsConfigsFrontendName" } ], "responses": { "200": { "$ref": "#/components/responses/listLoadBalancerFrontendTlsConfigs200" }, "default": { "$ref": "#/components/responses/listLoadBalancerFrontendTlsConfigsDefault" } } }, "post": { "tags": [ "load-balancer" ], "summary": "Create load balancer frontend TLS config", "description": "Creates a new TLS config by given {service-uuid} and {frontend-name}.", "operationId": "createLoadBalancerFrontendTlsConfig", "parameters": [ { "$ref": "#/components/parameters/createLoadBalancerFrontendTlsConfigServiceUuid" }, { "$ref": "#/components/parameters/createLoadBalancerFrontendTlsConfigFrontendName" } ], "requestBody": { "$ref": "#/components/requestBodies/createLoadBalancerFrontendTlsConfig" }, "responses": { "201": { "$ref": "#/components/responses/createLoadBalancerFrontendTlsConfig201" }, "default": { "$ref": "#/components/responses/createLoadBalancerFrontendTlsConfigDefault" } } } }, "/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/tls-configs/{tls-config-name}": { "get": { "tags": [ "load-balancer" ], "summary": "Get load balancer frontend TLS config", "description": "Returns frontend TLS config details by given {service-uuid}, {frontend-name}, and {tls-config-name}.", "operationId": "getLoadBalancerFrontendTlsConfig", "parameters": [ { "$ref": "#/components/parameters/getLoadBalancerFrontendTlsConfigServiceUuid" }, { "$ref": "#/components/parameters/getLoadBalancerFrontendTlsConfigFrontendName" }, { "$ref": "#/components/parameters/getLoadBalancerFrontendTlsConfigTlsConfigName" } ], "responses": { "200": { "$ref": "#/components/responses/getLoadBalancerFrontendTlsConfig200" }, "default": { "$ref": "#/components/responses/getLoadBalancerFrontendTlsConfigDefault" } } }, "delete": { "tags": [ "load-balancer" ], "summary": "Delete load balancer frontend TLS config", "description": "Deletes existing TLS config by given {service-uuid}, {frontend-name}, and {tls-config-name}.", "operationId": "deleteLoadBalancerFrontendTlsConfig", "parameters": [ { "$ref": "#/components/parameters/deleteLoadBalancerFrontendTlsConfigServiceUuid" }, { "$ref": "#/components/parameters/deleteLoadBalancerFrontendTlsConfigFrontendName" }, { "$ref": "#/components/parameters/deleteLoadBalancerFrontendTlsConfigTlsConfigName" } ], "responses": { "204": { "$ref": "#/components/responses/deleteLoadBalancerFrontendTlsConfig204" }, "default": { "$ref": "#/components/responses/deleteLoadBalancerFrontendTlsConfigDefault" } } }, "patch": { "tags": [ "load-balancer" ], "summary": "Modify load balancer frontend TLS config", "description": "Modifies existing TLS config by given {service-uuid}, {frontend-name}, and {tls-config-name}.", "operationId": "modifyLoadBalancerFrontendTlsConfig", "parameters": [ { "$ref": "#/components/parameters/modifyLoadBalancerFrontendTlsConfigServiceUuid" }, { "$ref": "#/components/parameters/modifyLoadBalancerFrontendTlsConfigFrontendName" }, { "$ref": "#/components/parameters/modifyLoadBalancerFrontendTlsConfigTlsConfigName" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyLoadBalancerFrontendTlsConfig" }, "responses": { "200": { "$ref": "#/components/responses/modifyLoadBalancerFrontendTlsConfig200" }, "default": { "$ref": "#/components/responses/modifyLoadBalancerFrontendTlsConfigDefault" } } } }, "/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/rules": { "get": { "tags": [ "load-balancer" ], "summary": "List load balancer rules", "description": "Returns a list of available frontend rules by given {service-uuid} and {frontend-name}.", "operationId": "listLoadBalancerRules", "parameters": [ { "$ref": "#/components/parameters/listLoadBalancerRulesServiceUuid" }, { "$ref": "#/components/parameters/listLoadBalancerRulesFrontendName" } ], "responses": { "200": { "$ref": "#/components/responses/listLoadBalancerRules200" }, "default": { "$ref": "#/components/responses/listLoadBalancerRulesDefault" } } }, "post": { "tags": [ "load-balancer" ], "summary": "Create load balancer rule", "description": "Creates a new rule by given {service-uuid} and {frontend-name}.", "operationId": "createLoadBalancerRule", "parameters": [ { "$ref": "#/components/parameters/createLoadBalancerRuleServiceUuid" }, { "$ref": "#/components/parameters/createLoadBalancerRuleFrontendName" } ], "requestBody": { "$ref": "#/components/requestBodies/createLoadBalancerRule" }, "responses": { "201": { "$ref": "#/components/responses/createLoadBalancerRule201" }, "default": { "$ref": "#/components/responses/createLoadBalancerRuleDefault" } } } }, "/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/rules/{rule-name}": { "get": { "tags": [ "load-balancer" ], "summary": "Get load balancer rule", "description": "Returns frontend rule details by given {service-uuid}, {frontend-name}, and {rule-name}.", "operationId": "getLoadBalancerRule", "parameters": [ { "$ref": "#/components/parameters/getLoadBalancerRuleServiceUuid" }, { "$ref": "#/components/parameters/getLoadBalancerRuleFrontendName" }, { "$ref": "#/components/parameters/getLoadBalancerRuleRuleName" } ], "responses": { "200": { "$ref": "#/components/responses/getLoadBalancerRule200" }, "default": { "$ref": "#/components/responses/getLoadBalancerRuleDefault" } } }, "put": { "tags": [ "load-balancer" ], "summary": "Replace load balancer rule", "description": "Replaces existing rule by given {service-uuid}, {frontend-name}, and {rule-name}.", "operationId": "replaceLoadBalancerRule", "parameters": [ { "$ref": "#/components/parameters/replaceLoadBalancerRuleServiceUuid" }, { "$ref": "#/components/parameters/replaceLoadBalancerRuleFrontendName" }, { "$ref": "#/components/parameters/replaceLoadBalancerRuleRuleName" } ], "requestBody": { "$ref": "#/components/requestBodies/replaceLoadBalancerRule" }, "responses": { "200": { "$ref": "#/components/responses/replaceLoadBalancerRule200" }, "default": { "$ref": "#/components/responses/replaceLoadBalancerRuleDefault" } } }, "delete": { "tags": [ "load-balancer" ], "summary": "Delete load balancer rule", "description": "Deletes existing rule by given {service-uuid}, {frontend-name}, and {rule-name}.", "operationId": "deleteLoadBalancerRule", "parameters": [ { "$ref": "#/components/parameters/deleteLoadBalancerRuleServiceUuid" }, { "$ref": "#/components/parameters/deleteLoadBalancerRuleFrontendName" }, { "$ref": "#/components/parameters/deleteLoadBalancerRuleRuleName" } ], "responses": { "204": { "$ref": "#/components/responses/deleteLoadBalancerRule204" }, "default": { "$ref": "#/components/responses/deleteLoadBalancerRuleDefault" } } }, "patch": { "tags": [ "load-balancer" ], "summary": "Modify load balancer rule", "description": "Modifies existing rule by given {service-uuid}, {frontend-name}, and {rule-name}.", "operationId": "modifyLoadBalancerRule", "parameters": [ { "$ref": "#/components/parameters/modifyLoadBalancerRuleServiceUuid" }, { "$ref": "#/components/parameters/modifyLoadBalancerRuleFrontendName" }, { "$ref": "#/components/parameters/modifyLoadBalancerRuleRuleName" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyLoadBalancerRule" }, "responses": { "200": { "$ref": "#/components/responses/modifyLoadBalancerRule200" }, "default": { "$ref": "#/components/responses/modifyLoadBalancerRuleDefault" } } } }, "/1.3/load-balancer/{service-uuid}/backends": { "get": { "tags": [ "load-balancer" ], "summary": "List load balancer backends", "description": "Returns a list of available service backends by given {service-uuid}.", "operationId": "listLoadBalancerBackends", "parameters": [ { "$ref": "#/components/parameters/listLoadBalancerBackendsServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listLoadBalancerBackends200" }, "default": { "$ref": "#/components/responses/listLoadBalancerBackendsDefault" } } }, "post": { "tags": [ "load-balancer" ], "summary": "Create load balancer backend", "description": "Creates a new backend by given {service-uuid}.", "operationId": "createLoadBalancerBackend", "parameters": [ { "$ref": "#/components/parameters/createLoadBalancerBackendServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createLoadBalancerBackend" }, "responses": { "201": { "$ref": "#/components/responses/createLoadBalancerBackend201" }, "default": { "$ref": "#/components/responses/createLoadBalancerBackendDefault" } } } }, "/1.3/load-balancer/{service-uuid}/backends/{backend-name}": { "get": { "tags": [ "load-balancer" ], "summary": "Get load balancer backend", "description": "Returns service backend details by given {service-uuid} and {backend-name}.", "operationId": "getLoadBalancerBackend", "parameters": [ { "$ref": "#/components/parameters/getLoadBalancerBackendServiceUuid" }, { "$ref": "#/components/parameters/getLoadBalancerBackendBackendName" } ], "responses": { "200": { "$ref": "#/components/responses/getLoadBalancerBackend200" }, "default": { "$ref": "#/components/responses/getLoadBalancerBackendDefault" } } }, "delete": { "tags": [ "load-balancer" ], "summary": "Delete load balancer backend", "description": "Deletes existing backend by given {service-uuid} and {backend-name}.", "operationId": "deleteLoadBalancerBackend", "parameters": [ { "$ref": "#/components/parameters/deleteLoadBalancerBackendServiceUuid" }, { "$ref": "#/components/parameters/deleteLoadBalancerBackendBackendName" } ], "responses": { "204": { "$ref": "#/components/responses/deleteLoadBalancerBackend204" }, "default": { "$ref": "#/components/responses/deleteLoadBalancerBackendDefault" } } }, "patch": { "tags": [ "load-balancer" ], "summary": "Modify load balancer backend", "description": "Modifies existing backend by given {service-uuid} and {backend-name}.", "operationId": "modifyLoadBalancerBackend", "parameters": [ { "$ref": "#/components/parameters/modifyLoadBalancerBackendServiceUuid" }, { "$ref": "#/components/parameters/modifyLoadBalancerBackendBackendName" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyLoadBalancerBackend" }, "responses": { "200": { "$ref": "#/components/responses/modifyLoadBalancerBackend200" }, "default": { "$ref": "#/components/responses/modifyLoadBalancerBackendDefault" } } } }, "/1.3/load-balancer/{service-uuid}/backends/{backend-name}/members": { "get": { "tags": [ "load-balancer" ], "summary": "List load balancer members", "description": "Returns a list of available backend members by given {service-uuid} and {backend-name}.", "operationId": "listLoadBalancerMembers", "parameters": [ { "$ref": "#/components/parameters/listLoadBalancerMembersServiceUuid" }, { "$ref": "#/components/parameters/listLoadBalancerMembersBackendName" } ], "responses": { "200": { "$ref": "#/components/responses/listLoadBalancerMembers200" }, "default": { "$ref": "#/components/responses/listLoadBalancerMembersDefault" } } }, "post": { "tags": [ "load-balancer" ], "summary": "Create load balancer member", "description": "Creates a new member by given {service-uuid} and {backend-name}.", "operationId": "createLoadBalancerMember", "parameters": [ { "$ref": "#/components/parameters/createLoadBalancerMemberServiceUuid" }, { "$ref": "#/components/parameters/createLoadBalancerMemberBackendName" } ], "requestBody": { "$ref": "#/components/requestBodies/createLoadBalancerMember" }, "responses": { "201": { "$ref": "#/components/responses/createLoadBalancerMember201" }, "default": { "$ref": "#/components/responses/createLoadBalancerMemberDefault" } } } }, "/1.3/load-balancer/{service-uuid}/backends/{backend-name}/members/{member-name}": { "get": { "tags": [ "load-balancer" ], "summary": "Get load balancer member", "description": "Returns backend member details by given {service-uuid}, {backend-name} and {member-name}.", "operationId": "getLoadBalancerMember", "parameters": [ { "$ref": "#/components/parameters/getLoadBalancerMemberServiceUuid" }, { "$ref": "#/components/parameters/getLoadBalancerMemberBackendName" }, { "$ref": "#/components/parameters/getLoadBalancerMemberMemberName" } ], "responses": { "200": { "$ref": "#/components/responses/getLoadBalancerMember200" }, "default": { "$ref": "#/components/responses/getLoadBalancerMemberDefault" } } }, "delete": { "tags": [ "load-balancer" ], "summary": "Delete load balancer member", "description": "Deletes existing member by given {service-uuid}, {backend-name} and {member-name}.", "operationId": "deleteLoadBalancerMember", "parameters": [ { "$ref": "#/components/parameters/deleteLoadBalancerMemberServiceUuid" }, { "$ref": "#/components/parameters/deleteLoadBalancerMemberBackendName" }, { "$ref": "#/components/parameters/deleteLoadBalancerMemberMemberName" } ], "responses": { "204": { "$ref": "#/components/responses/deleteLoadBalancerMember204" }, "default": { "$ref": "#/components/responses/deleteLoadBalancerMemberDefault" } } }, "patch": { "tags": [ "load-balancer" ], "summary": "Modify load balancer member", "description": "Modifies existing member by given {service-uuid}, {backend-name} and {member-name}.", "operationId": "modifyLoadBalancerMember", "parameters": [ { "$ref": "#/components/parameters/modifyLoadBalancerMemberServiceUuid" }, { "$ref": "#/components/parameters/modifyLoadBalancerMemberBackendName" }, { "$ref": "#/components/parameters/modifyLoadBalancerMemberMemberName" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyLoadBalancerMember" }, "responses": { "200": { "$ref": "#/components/responses/modifyLoadBalancerMember200" }, "default": { "$ref": "#/components/responses/modifyLoadBalancerMemberDefault" } } } }, "/1.3/load-balancer/{service-uuid}/backends/{backend-name}/tls-configs": { "get": { "tags": [ "load-balancer" ], "summary": "List load balancer backend TLS configs", "description": "Returns a list of available backend TLS configs by given {service-uuid} and {backend-name}.", "operationId": "listLoadBalancerBackendTlsConfigs", "parameters": [ { "$ref": "#/components/parameters/listLoadBalancerBackendTlsConfigsServiceUuid" }, { "$ref": "#/components/parameters/listLoadBalancerBackendTlsConfigsBackendName" } ], "responses": { "200": { "$ref": "#/components/responses/listLoadBalancerBackendTlsConfigs200" }, "default": { "$ref": "#/components/responses/listLoadBalancerBackendTlsConfigsDefault" } } }, "post": { "tags": [ "load-balancer" ], "summary": "Create load balancer backend TLS config", "description": "Creates a new TLS config by given {service-uuid} and {backend-name}.", "operationId": "createLoadBalancerBackendTlsConfig", "parameters": [ { "$ref": "#/components/parameters/createLoadBalancerBackendTlsConfigServiceUuid" }, { "$ref": "#/components/parameters/createLoadBalancerBackendTlsConfigBackendName" } ], "requestBody": { "$ref": "#/components/requestBodies/createLoadBalancerBackendTlsConfig" }, "responses": { "201": { "$ref": "#/components/responses/createLoadBalancerBackendTlsConfig201" }, "default": { "$ref": "#/components/responses/createLoadBalancerBackendTlsConfigDefault" } } } }, "/1.3/load-balancer/{service-uuid}/backends/{backend-name}/tls-configs/{tls-config-name}": { "get": { "tags": [ "load-balancer" ], "summary": "Get load balancer backend TLS config", "description": "Returns backend TLS config details by given {service-uuid}, {backend-name}, and {tls-config-name}.", "operationId": "getLoadBalancerBackendTlsConfig", "parameters": [ { "$ref": "#/components/parameters/getLoadBalancerBackendTlsConfigServiceUuid" }, { "$ref": "#/components/parameters/getLoadBalancerBackendTlsConfigBackendName" }, { "$ref": "#/components/parameters/getLoadBalancerBackendTlsConfigTlsConfigName" } ], "responses": { "200": { "$ref": "#/components/responses/getLoadBalancerBackendTlsConfig200" }, "default": { "$ref": "#/components/responses/getLoadBalancerBackendTlsConfigDefault" } } }, "delete": { "tags": [ "load-balancer" ], "summary": "Delete load balancer backend TLS config", "description": "Deletes existing TLS config by given {service-uuid}, {backend-name}, and {tls-config-name}.", "operationId": "deleteLoadBalancerBackendTlsConfig", "parameters": [ { "$ref": "#/components/parameters/deleteLoadBalancerBackendTlsConfigServiceUuid" }, { "$ref": "#/components/parameters/deleteLoadBalancerBackendTlsConfigBackendName" }, { "$ref": "#/components/parameters/deleteLoadBalancerBackendTlsConfigTlsConfigName" } ], "responses": { "204": { "$ref": "#/components/responses/deleteLoadBalancerBackendTlsConfig204" }, "default": { "$ref": "#/components/responses/deleteLoadBalancerBackendTlsConfigDefault" } } }, "patch": { "tags": [ "load-balancer" ], "summary": "Modify load balancer backend TLS config", "description": "Modifies existing TLS config by given {service-uuid}, {backend-name}, and {tls-config-name}.", "operationId": "modifyLoadBalancerBackendTlsConfig", "parameters": [ { "$ref": "#/components/parameters/modifyLoadBalancerBackendTlsConfigServiceUuid" }, { "$ref": "#/components/parameters/modifyLoadBalancerBackendTlsConfigBackendName" }, { "$ref": "#/components/parameters/modifyLoadBalancerBackendTlsConfigTlsConfigName" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyLoadBalancerBackendTlsConfig" }, "responses": { "200": { "$ref": "#/components/responses/modifyLoadBalancerBackendTlsConfig200" }, "default": { "$ref": "#/components/responses/modifyLoadBalancerBackendTlsConfigDefault" } } } }, "/1.3/load-balancer/{service-uuid}/networks/{network-name}": { "patch": { "tags": [ "load-balancer" ], "summary": "Modify load balancer network", "description": "Modifies existing service network by given {service-uuid} and {network-name}.", "operationId": "modifyLoadBalancerNetwork", "parameters": [ { "$ref": "#/components/parameters/modifyLoadBalancerNetworkServiceUuid" }, { "$ref": "#/components/parameters/modifyLoadBalancerNetworkNetworkName" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyLoadBalancerNetwork" }, "responses": { "200": { "$ref": "#/components/responses/modifyLoadBalancerNetwork200" }, "default": { "$ref": "#/components/responses/modifyLoadBalancerNetworkDefault" } } } }, "/1.3/load-balancer/{service-uuid}/ip-addresses": { "get": { "tags": [ "load-balancer" ], "summary": "List load balancer IP addresses", "description": "Returns a list of available IP addresses by given {service-uuid}.", "operationId": "listLoadBalancerIpAddresses", "parameters": [ { "$ref": "#/components/parameters/listLoadBalancerIpAddressesServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listLoadBalancerIpAddresses200" }, "default": { "$ref": "#/components/responses/listLoadBalancerIpAddressesDefault" } } }, "post": { "tags": [ "load-balancer" ], "summary": "Create load balancer IP address", "description": "Attach a floating public IPv4 address to the service using the specified {service-uuid}. The number of attachable floating IPv4 addresses is limited to the number of nodes in the plan, and all addresses must be in the same zone as the service and detached.\n\nNote: Floating public IPv4 addresses have configurable release policies. When the service is deleted or an IP address is detached, addresses with the keep policy will be converted to detached floating IPs that remain available in your account. Addresses with the release policy will be automatically deleted. For more details, see IP Addresses.", "operationId": "createLoadBalancerIpAddress", "parameters": [ { "$ref": "#/components/parameters/createLoadBalancerIpAddressServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createLoadBalancerIpAddress" }, "responses": { "201": { "$ref": "#/components/responses/createLoadBalancerIpAddress201" }, "default": { "$ref": "#/components/responses/createLoadBalancerIpAddressDefault" } } } }, "/1.3/load-balancer/{service-uuid}/ip-addresses/{ip-address}": { "get": { "tags": [ "load-balancer" ], "summary": "Get load balancer IP address", "description": "Returns IP address details by given {service-uuid} and {ip-address}.", "operationId": "getLoadBalancerIpAddress", "parameters": [ { "$ref": "#/components/parameters/getLoadBalancerIpAddressServiceUuid" }, { "$ref": "#/components/parameters/getLoadBalancerIpAddressIpAddress" } ], "responses": { "200": { "$ref": "#/components/responses/getLoadBalancerIpAddress200" }, "default": { "$ref": "#/components/responses/getLoadBalancerIpAddressDefault" } } }, "delete": { "tags": [ "load-balancer" ], "summary": "Delete load balancer IP address", "description": "Detach a floating public IPv4 address from the service by given {service-uuid} and {address}. \n\t\t\t\tDepending on the release policy, the customer retains the floating IP if the policy is set to keep. \n\t\t\t\tIf the policy is set to release, the floating IP will be deleted.", "operationId": "deleteLoadBalancerIpAddress", "parameters": [ { "$ref": "#/components/parameters/deleteLoadBalancerIpAddressServiceUuid" }, { "$ref": "#/components/parameters/deleteLoadBalancerIpAddressIpAddress" } ], "responses": { "204": { "$ref": "#/components/responses/deleteLoadBalancerIpAddress204" }, "default": { "$ref": "#/components/responses/deleteLoadBalancerIpAddressDefault" } } } }, "/1.3/load-balancer/{service-uuid}/resolvers": { "get": { "tags": [ "load-balancer" ], "summary": "List load balancer resolvers", "description": "Returns a list of available service domain name resolvers by given {service-uuid}.", "operationId": "listLoadBalancerResolvers", "parameters": [ { "$ref": "#/components/parameters/listLoadBalancerResolversServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listLoadBalancerResolvers200" }, "default": { "$ref": "#/components/responses/listLoadBalancerResolversDefault" } } }, "post": { "tags": [ "load-balancer" ], "summary": "Create load balancer resolver", "description": "Creates a new resolver by given {service-uuid}.\n\nResolver is a DNS server usually residing in a user's private network. It's used to resolve IPs for backend members of type dynamic.", "operationId": "createLoadBalancerResolver", "parameters": [ { "$ref": "#/components/parameters/createLoadBalancerResolverServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createLoadBalancerResolver" }, "responses": { "201": { "$ref": "#/components/responses/createLoadBalancerResolver201" }, "default": { "$ref": "#/components/responses/createLoadBalancerResolverDefault" } } } }, "/1.3/load-balancer/{service-uuid}/resolvers/{resolver-name}": { "get": { "tags": [ "load-balancer" ], "summary": "Get load balancer resolver", "description": "Returns backend resolver details by given {service-uuid} and {resolver-name}.", "operationId": "getLoadBalancerResolver", "parameters": [ { "$ref": "#/components/parameters/getLoadBalancerResolverServiceUuid" }, { "$ref": "#/components/parameters/getLoadBalancerResolverResolverName" } ], "responses": { "200": { "$ref": "#/components/responses/getLoadBalancerResolver200" }, "default": { "$ref": "#/components/responses/getLoadBalancerResolverDefault" } } }, "delete": { "tags": [ "load-balancer" ], "summary": "Delete load balancer resolver", "description": "Deletes existing resolver by given {service-uuid} and {resolver-name}.", "operationId": "deleteLoadBalancerResolver", "parameters": [ { "$ref": "#/components/parameters/deleteLoadBalancerResolverServiceUuid" }, { "$ref": "#/components/parameters/deleteLoadBalancerResolverResolverName" } ], "responses": { "204": { "$ref": "#/components/responses/deleteLoadBalancerResolver204" }, "default": { "$ref": "#/components/responses/deleteLoadBalancerResolverDefault" } } }, "patch": { "tags": [ "load-balancer" ], "summary": "Modify load balancer resolver", "description": "Modifies existing resolver by given {service-uuid} and {resolver-name}.", "operationId": "modifyLoadBalancerResolver", "parameters": [ { "$ref": "#/components/parameters/modifyLoadBalancerResolverServiceUuid" }, { "$ref": "#/components/parameters/modifyLoadBalancerResolverResolverName" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyLoadBalancerResolver" }, "responses": { "200": { "$ref": "#/components/responses/modifyLoadBalancerResolver200" }, "default": { "$ref": "#/components/responses/modifyLoadBalancerResolverDefault" } } } }, "/1.3/load-balancer/{service-uuid}/labels": { "get": { "tags": [ "load-balancer" ], "summary": "List load balancer labels", "description": "Returns a list of available service labels by given {service-uuid}.", "operationId": "listLoadBalancerLabels", "parameters": [ { "$ref": "#/components/parameters/listLoadBalancerLabelsServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listLoadBalancerLabels200" }, "default": { "$ref": "#/components/responses/listLoadBalancerLabelsDefault" } } }, "post": { "tags": [ "load-balancer" ], "summary": "Create load balancer label", "description": "Creates a new label by given {service-uuid}.\n\nLabels used for service filtering.\n\nService labels usage examples\nBelow are some examples of what certain GET requests might look like.\n\nexact match: GET /1.3/load-balancer?label=env%3Dstaging\nexistence: GET /1.3/load-balancer?label=env\nmultiple: GET /1.3/load-balancer?label=env&label=foo%3Dbar\n", "operationId": "createLoadBalancerLabel", "parameters": [ { "$ref": "#/components/parameters/createLoadBalancerLabelServiceUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createLoadBalancerLabel" }, "responses": { "201": { "$ref": "#/components/responses/createLoadBalancerLabel201" }, "default": { "$ref": "#/components/responses/createLoadBalancerLabelDefault" } } } }, "/1.3/load-balancer/{service-uuid}/labels/{label-key}": { "get": { "tags": [ "load-balancer" ], "summary": "Get load balancer label", "description": "Returns label details by given {service-uuid} and {label-key}.", "operationId": "getLoadBalancerLabel", "parameters": [ { "$ref": "#/components/parameters/getLoadBalancerLabelServiceUuid" }, { "$ref": "#/components/parameters/getLoadBalancerLabelLabelKey" } ], "responses": { "200": { "$ref": "#/components/responses/getLoadBalancerLabel200" }, "default": { "$ref": "#/components/responses/getLoadBalancerLabelDefault" } } }, "delete": { "tags": [ "load-balancer" ], "summary": "Delete load balancer label", "description": "Deletes existing label by given {service-uuid} and {label-key}.", "operationId": "deleteLoadBalancerLabel", "parameters": [ { "$ref": "#/components/parameters/deleteLoadBalancerLabelServiceUuid" }, { "$ref": "#/components/parameters/deleteLoadBalancerLabelLabelKey" } ], "responses": { "204": { "$ref": "#/components/responses/deleteLoadBalancerLabel204" }, "default": { "$ref": "#/components/responses/deleteLoadBalancerLabelDefault" } } }, "patch": { "tags": [ "load-balancer" ], "summary": "Modify load balancer label", "description": "Modifies existing label by given {service-uuid} and {label-key}.", "operationId": "modifyLoadBalancerLabel", "parameters": [ { "$ref": "#/components/parameters/modifyLoadBalancerLabelServiceUuid" }, { "$ref": "#/components/parameters/modifyLoadBalancerLabelLabelKey" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyLoadBalancerLabel" }, "responses": { "200": { "$ref": "#/components/responses/modifyLoadBalancerLabel200" }, "default": { "$ref": "#/components/responses/modifyLoadBalancerLabelDefault" } } } }, "/1.3/load-balancer/{service-uuid}/metrics": { "get": { "tags": [ "load-balancer" ], "summary": "Get load balancer metrics", "description": "Returns service metrics by given {service-uuid}.", "operationId": "getLoadBalancerMetrics", "parameters": [ { "$ref": "#/components/parameters/getLoadBalancerMetricsServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getLoadBalancerMetrics200" }, "default": { "$ref": "#/components/responses/getLoadBalancerMetricsDefault" } } } }, "/1.3/load-balancer/{service-uuid}/metrics/series": { "get": { "tags": [ "load-balancer" ], "summary": "Get load balancer metrics series", "description": "Returns service metric series by given {service-uuid}.", "operationId": "getLoadBalancerMetricsSeries", "parameters": [ { "$ref": "#/components/parameters/getLoadBalancerMetricsSeriesServiceUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getLoadBalancerMetricsSeries200" }, "default": { "$ref": "#/components/responses/getLoadBalancerMetricsSeriesDefault" } } } }, "/1.3/load-balancer/{service-uuid}/metrics/series/frontends": { "get": { "tags": [ "load-balancer" ], "summary": "Get load balancer frontend combined metrics series", "description": "Returns combined frontend metric series by given {service-uuid}.", "operationId": "getLoadBalancerFrontendCombinedMetricsSeries", "parameters": [ { "$ref": "#/components/parameters/getLoadBalancerFrontendCombinedMetricsSeriesServiceUuid" }, { "$ref": "#/components/parameters/getLoadBalancerFrontendCombinedMetricsSeriesSort" } ], "responses": { "200": { "$ref": "#/components/responses/getLoadBalancerFrontendCombinedMetricsSeries200" }, "default": { "$ref": "#/components/responses/getLoadBalancerFrontendCombinedMetricsSeriesDefault" } } } }, "/1.3/load-balancer/{service-uuid}/metrics/series/frontends/{frontend-name}": { "get": { "tags": [ "load-balancer" ], "summary": "Get load balancer frontend metrics series", "description": "Returns frontend metric series by given {service-uuid} and {frontend-name}.", "operationId": "getLoadBalancerFrontendMetricsSeries", "parameters": [ { "$ref": "#/components/parameters/getLoadBalancerFrontendMetricsSeriesServiceUuid" }, { "$ref": "#/components/parameters/getLoadBalancerFrontendMetricsSeriesFrontendName" }, { "$ref": "#/components/parameters/getLoadBalancerFrontendMetricsSeriesSort" } ], "responses": { "200": { "$ref": "#/components/responses/getLoadBalancerFrontendMetricsSeries200" }, "default": { "$ref": "#/components/responses/getLoadBalancerFrontendMetricsSeriesDefault" } } } }, "/1.3/load-balancer/{service-uuid}/metrics/series/backends": { "get": { "tags": [ "load-balancer" ], "summary": "Get load balancer backend combined metrics series", "description": "Returns combined backend metric series by given {service-uuid}.", "operationId": "getLoadBalancerBackendCombinedMetricsSeries", "parameters": [ { "$ref": "#/components/parameters/getLoadBalancerBackendCombinedMetricsSeriesServiceUuid" }, { "$ref": "#/components/parameters/getLoadBalancerBackendCombinedMetricsSeriesSort" } ], "responses": { "200": { "$ref": "#/components/responses/getLoadBalancerBackendCombinedMetricsSeries200" }, "default": { "$ref": "#/components/responses/getLoadBalancerBackendCombinedMetricsSeriesDefault" } } } }, "/1.3/load-balancer/{service-uuid}/metrics/series/backends/{backend-name}": { "get": { "tags": [ "load-balancer" ], "summary": "Get load balancer backend metrics series", "description": "Returns backend metric series by given {service-uuid} and {backend-name}.", "operationId": "getLoadBalancerBackendMetricsSeries", "parameters": [ { "$ref": "#/components/parameters/getLoadBalancerBackendMetricsSeriesServiceUuid" }, { "$ref": "#/components/parameters/getLoadBalancerBackendMetricsSeriesBackendName" }, { "$ref": "#/components/parameters/getLoadBalancerBackendMetricsSeriesSort" } ], "responses": { "200": { "$ref": "#/components/responses/getLoadBalancerBackendMetricsSeries200" }, "default": { "$ref": "#/components/responses/getLoadBalancerBackendMetricsSeriesDefault" } } } }, "/1.3/load-balancer/{service-uuid}/metrics/series/backends/{backend-name}/members": { "get": { "tags": [ "load-balancer" ], "summary": "Get load balancer member combined metrics series", "description": "Returns combined backend members metric series by given {service-uuid} and {backend-name}.", "operationId": "getLoadBalancerMemberCombinedMetricsSeries", "parameters": [ { "$ref": "#/components/parameters/getLoadBalancerMemberCombinedMetricsSeriesServiceUuid" }, { "$ref": "#/components/parameters/getLoadBalancerMemberCombinedMetricsSeriesBackendName" }, { "$ref": "#/components/parameters/getLoadBalancerMemberCombinedMetricsSeriesSort" } ], "responses": { "200": { "$ref": "#/components/responses/getLoadBalancerMemberCombinedMetricsSeries200" }, "default": { "$ref": "#/components/responses/getLoadBalancerMemberCombinedMetricsSeriesDefault" } } } }, "/1.3/load-balancer/{service-uuid}/metrics/series/backends/{backend-name}/members/{member-name}": { "get": { "tags": [ "load-balancer" ], "summary": "Get load balancer member metrics series", "description": "Returns backend member metric series by given {service-uuid}, {backend-name}, and {member-name}.", "operationId": "getLoadBalancerMemberMetricsSeries", "parameters": [ { "$ref": "#/components/parameters/getLoadBalancerMemberMetricsSeriesServiceUuid" }, { "$ref": "#/components/parameters/getLoadBalancerMemberMetricsSeriesBackendName" }, { "$ref": "#/components/parameters/getLoadBalancerMemberMetricsSeriesMemberName" }, { "$ref": "#/components/parameters/getLoadBalancerMemberMetricsSeriesSort" } ], "responses": { "200": { "$ref": "#/components/responses/getLoadBalancerMemberMetricsSeries200" }, "default": { "$ref": "#/components/responses/getLoadBalancerMemberMetricsSeriesDefault" } } } }, "/1.3/load-balancer/certificate-bundles": { "get": { "tags": [ "load-balancer" ], "summary": "List load balancer certificate bundles", "description": "Returns a list of available certificate bundles.", "operationId": "listLoadBalancerCertificateBundles", "parameters": [ { "$ref": "#/components/parameters/listLoadBalancerCertificateBundlesLimit" }, { "$ref": "#/components/parameters/listLoadBalancerCertificateBundlesOffset" }, { "$ref": "#/components/parameters/listLoadBalancerCertificateBundlesLabel" } ], "responses": { "200": { "$ref": "#/components/responses/listLoadBalancerCertificateBundles200" }, "default": { "$ref": "#/components/responses/listLoadBalancerCertificateBundlesDefault" } } }, "post": { "tags": [ "load-balancer" ], "summary": "Create load balancer certificate bundle", "description": "Creates a new certificate bundle.", "operationId": "createLoadBalancerCertificateBundle", "requestBody": { "$ref": "#/components/requestBodies/createLoadBalancerCertificateBundle" }, "responses": { "201": { "$ref": "#/components/responses/createLoadBalancerCertificateBundle201" }, "default": { "$ref": "#/components/responses/createLoadBalancerCertificateBundleDefault" } } } }, "/1.3/load-balancer/certificate-bundles/{bundle-uuid}": { "get": { "tags": [ "load-balancer" ], "summary": "Get load balancer certificate bundle", "description": "Returns certificate bundle details by given {bundle-uuid}.", "operationId": "getLoadBalancerCertificateBundle", "parameters": [ { "$ref": "#/components/parameters/getLoadBalancerCertificateBundleBundleUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getLoadBalancerCertificateBundle200" }, "default": { "$ref": "#/components/responses/getLoadBalancerCertificateBundleDefault" } } }, "delete": { "tags": [ "load-balancer" ], "summary": "Delete load balancer certificate bundle", "description": "Deletes existing certificate bundle by given {bundle-uuid}.", "operationId": "deleteLoadBalancerCertificateBundle", "parameters": [ { "$ref": "#/components/parameters/deleteLoadBalancerCertificateBundleBundleUuid" } ], "responses": { "204": { "$ref": "#/components/responses/deleteLoadBalancerCertificateBundle204" }, "default": { "$ref": "#/components/responses/deleteLoadBalancerCertificateBundleDefault" } } }, "patch": { "tags": [ "load-balancer" ], "summary": "Modify load balancer certificate bundle", "description": "Modifies existing a manual, dynamic or authority certificate bundle by given {bundle-uuid}.", "operationId": "modifyLoadBalancerCertificateBundle", "parameters": [ { "$ref": "#/components/parameters/modifyLoadBalancerCertificateBundleBundleUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyLoadBalancerCertificateBundle" }, "responses": { "200": { "$ref": "#/components/responses/modifyLoadBalancerCertificateBundle200" }, "default": { "$ref": "#/components/responses/modifyLoadBalancerCertificateBundleDefault" } } } }, "/1.3/load-balancer/certificate-bundles/{bundle-uuid}/labels": { "get": { "tags": [ "load-balancer" ], "summary": "List load balancer certificate bundle labels", "description": "Returns a list of available certificate bundle labels by given {bundle-uuid}.", "operationId": "listLoadBalancerCertificateBundleLabels", "parameters": [ { "$ref": "#/components/parameters/listLoadBalancerCertificateBundleLabelsBundleUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listLoadBalancerCertificateBundleLabels200" }, "default": { "$ref": "#/components/responses/listLoadBalancerCertificateBundleLabelsDefault" } } }, "post": { "tags": [ "load-balancer" ], "summary": "Create load balancer certificate bundle label", "description": "Creates a new label by given {bundle-uuid}.\n\nLabels used for certificate bundles filtering.\n\nCertificate bundle labels usage examples\nBelow are some examples of what certain GET requests might look like.\n\nexact match: GET /1.3/load-balancer/certificate-bundles?label=env%3Dstaging\nexistence: GET /1.3/load-balancer/certificate-bundles?label=env\nmultiple: GET /1.3/load-balancer/certificate-bundles?label=env&label=foo%3Dbar", "operationId": "createLoadBalancerCertificateBundleLabel", "parameters": [ { "$ref": "#/components/parameters/createLoadBalancerCertificateBundleLabelBundleUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createLoadBalancerCertificateBundleLabel" }, "responses": { "201": { "$ref": "#/components/responses/createLoadBalancerCertificateBundleLabel201" }, "default": { "$ref": "#/components/responses/createLoadBalancerCertificateBundleLabelDefault" } } } }, "/1.3/load-balancer/certificate-bundles/{bundle-uuid}/labels/{label-key}": { "get": { "tags": [ "load-balancer" ], "summary": "Get load balancer certificate bundle label", "description": "Returns label details by given {bundle-uuid} and {label-key}.", "operationId": "getLoadBalancerCertificateBundleLabel", "parameters": [ { "$ref": "#/components/parameters/getLoadBalancerCertificateBundleLabelBundleUuid" }, { "$ref": "#/components/parameters/getLoadBalancerCertificateBundleLabelLabelKey" } ], "responses": { "200": { "$ref": "#/components/responses/getLoadBalancerCertificateBundleLabel200" }, "default": { "$ref": "#/components/responses/getLoadBalancerCertificateBundleLabelDefault" } } }, "delete": { "tags": [ "load-balancer" ], "summary": "Delete load balancer certificate bundle label", "description": "Deletes existing label by given {bundle-uuid} and {label-key}.", "operationId": "deleteLoadBalancerCertificateBundleLabel", "parameters": [ { "$ref": "#/components/parameters/deleteLoadBalancerCertificateBundleLabelBundleUuid" }, { "$ref": "#/components/parameters/deleteLoadBalancerCertificateBundleLabelLabelKey" } ], "responses": { "204": { "$ref": "#/components/responses/deleteLoadBalancerCertificateBundleLabel204" }, "default": { "$ref": "#/components/responses/deleteLoadBalancerCertificateBundleLabelDefault" } } }, "patch": { "tags": [ "load-balancer" ], "summary": "Modify load balancer certificate bundle label", "description": "Modifies existing label by given {bundle-uuid} and {label-key}.", "operationId": "modifyLoadBalancerCertificateBundleLabel", "parameters": [ { "$ref": "#/components/parameters/modifyLoadBalancerCertificateBundleLabelBundleUuid" }, { "$ref": "#/components/parameters/modifyLoadBalancerCertificateBundleLabelLabelKey" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyLoadBalancerCertificateBundleLabel" }, "responses": { "200": { "$ref": "#/components/responses/modifyLoadBalancerCertificateBundleLabel200" }, "default": { "$ref": "#/components/responses/modifyLoadBalancerCertificateBundleLabelDefault" } } } }, "/1.3/load-balancer/certificate-bundles/dns-challenge-domain": { "get": { "tags": [ "load-balancer" ], "summary": "Get load balancer DNS challenge domain", "description": "Returns DNS challenge domain.\n\nThis can be used to validate domain ownership using the ACME challenge method. To validate your domain, you need to add CNAME record to the domain provided by this API to your DNS settings. The name/host of the CNAME record should be _acme-challenge or _acme-challenge.mysubdomain if you are setting up a subdomain called mysubdomain. The target/points to of the record needs to be set to the value returned by this API.", "operationId": "getLoadBalancerDnsChallengeDomain", "responses": { "200": { "$ref": "#/components/responses/getLoadBalancerDnsChallengeDomain200" }, "default": { "$ref": "#/components/responses/getLoadBalancerDnsChallengeDomainDefault" } } } }, "/1.3/load-balancer/plans": { "get": { "tags": [ "load-balancer" ], "summary": "List load balancer plans", "description": "Returns a list of available load balancer plans.", "operationId": "listLoadBalancerPlans", "parameters": [ { "$ref": "#/components/parameters/listLoadBalancerPlansLimit" }, { "$ref": "#/components/parameters/listLoadBalancerPlansOffset" } ], "responses": { "200": { "$ref": "#/components/responses/listLoadBalancerPlans200" }, "default": { "$ref": "#/components/responses/listLoadBalancerPlansDefault" } } } }, "/1.3/load-balancer/plans/{plan-name}": { "get": { "tags": [ "load-balancer" ], "summary": "Get load balancer plan", "description": "Returns load balancer plan details by given {plan-name}.", "operationId": "getLoadBalancerPlan", "parameters": [ { "$ref": "#/components/parameters/getLoadBalancerPlanPlanName" } ], "responses": { "200": { "$ref": "#/components/responses/getLoadBalancerPlan200" }, "default": { "$ref": "#/components/responses/getLoadBalancerPlanDefault" } } } }, "/1.3/firewall-ruleset": { "get": { "tags": [ "firewall-ruleset" ], "summary": "List firewall rulesets", "description": "Returns a list of firewall rulesets.", "operationId": "listFirewallRulesets", "parameters": [ { "$ref": "#/components/parameters/listFirewallRulesetsLimit" }, { "$ref": "#/components/parameters/listFirewallRulesetsOffset" }, { "$ref": "#/components/parameters/listFirewallRulesetsSort" } ], "responses": { "200": { "$ref": "#/components/responses/listFirewallRulesets200" }, "default": { "$ref": "#/components/responses/listFirewallRulesetsDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "firewall-ruleset" ], "summary": "Create firewall ruleset", "description": "Creates a new firewall ruleset.", "operationId": "createFirewallRuleset", "requestBody": { "$ref": "#/components/requestBodies/createFirewallRuleset" }, "responses": { "201": { "$ref": "#/components/responses/createFirewallRuleset201" }, "default": { "$ref": "#/components/responses/createFirewallRulesetDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/firewall-ruleset/{ruleset-uuid}": { "get": { "tags": [ "firewall-ruleset" ], "summary": "Get firewall ruleset details", "description": "Returns firewall ruleset details by given {ruleset-uuid}.", "operationId": "getFirewallRuleset", "parameters": [ { "$ref": "#/components/parameters/getFirewallRulesetRulesetUuid" } ], "responses": { "200": { "$ref": "#/components/responses/getFirewallRuleset200" }, "default": { "$ref": "#/components/responses/getFirewallRulesetDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "firewall-ruleset" ], "summary": "Delete firewall ruleset", "description": "Deletes existing firewall ruleset by given {ruleset-uuid}.", "operationId": "deleteFirewallRuleset", "parameters": [ { "$ref": "#/components/parameters/deleteFirewallRulesetRulesetUuid" } ], "responses": { "204": { "$ref": "#/components/responses/deleteFirewallRuleset204" }, "default": { "$ref": "#/components/responses/deleteFirewallRulesetDefault" } }, "x-upcloud-visibility": "public" }, "patch": { "tags": [ "firewall-ruleset" ], "summary": "Modify firewall ruleset", "description": "Modifies existing firewall ruleset by given {ruleset-uuid}.", "operationId": "modifyFirewallRuleset", "parameters": [ { "$ref": "#/components/parameters/modifyFirewallRulesetRulesetUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyFirewallRuleset" }, "responses": { "200": { "$ref": "#/components/responses/modifyFirewallRuleset200" }, "default": { "$ref": "#/components/responses/modifyFirewallRulesetDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/firewall-ruleset/{ruleset-uuid}/restore/{ruleset-version}": { "patch": { "tags": [ "firewall-ruleset" ], "summary": "Restore firewall ruleset", "description": "Restores existing firewall ruleset by given {ruleset-uuid} and {ruleset-version}.", "operationId": "restoreFirewallRuleset", "parameters": [ { "$ref": "#/components/parameters/restoreFirewallRulesetRulesetUuid" }, { "$ref": "#/components/parameters/restoreFirewallRulesetRulesetVersion" } ], "responses": { "200": { "$ref": "#/components/responses/restoreFirewallRuleset200" }, "default": { "$ref": "#/components/responses/restoreFirewallRulesetDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/firewall-ruleset/{ruleset-uuid}/rule": { "get": { "tags": [ "firewall-ruleset" ], "summary": "List firewall ruleset rules", "description": "Returns firewall ruleset rules.", "operationId": "listFirewallRulesetRules", "parameters": [ { "$ref": "#/components/parameters/listFirewallRulesetRulesRulesetUuid" }, { "$ref": "#/components/parameters/listFirewallRulesetRulesLimit" }, { "$ref": "#/components/parameters/listFirewallRulesetRulesOffset" }, { "$ref": "#/components/parameters/listFirewallRulesetRulesSort" } ], "responses": { "200": { "$ref": "#/components/responses/listFirewallRulesetRules200" }, "default": { "$ref": "#/components/responses/listFirewallRulesetRulesDefault" } }, "x-upcloud-visibility": "public" }, "put": { "tags": [ "firewall-ruleset" ], "summary": "Create multiple firewall ruleset rules", "description": "Creates multiple firewall ruleset rules by the given {ruleset-uuid}.", "operationId": "createMultipleFirewallRulesetRule", "parameters": [ { "$ref": "#/components/parameters/createMultipleFirewallRulesetRuleRulesetUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createMultipleFirewallRulesetRule" }, "responses": { "200": { "$ref": "#/components/responses/createMultipleFirewallRulesetRule200" }, "default": { "$ref": "#/components/responses/createMultipleFirewallRulesetRuleDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "firewall-ruleset" ], "summary": "Create firewall ruleset rule", "description": "Creates a new firewall ruleset rule by the given {ruleset-uuid}.", "operationId": "createFirewallRulesetRule", "parameters": [ { "$ref": "#/components/parameters/createFirewallRulesetRuleRulesetUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createFirewallRulesetRule" }, "responses": { "201": { "$ref": "#/components/responses/createFirewallRulesetRule201" }, "default": { "$ref": "#/components/responses/createFirewallRulesetRuleDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/firewall-ruleset/{ruleset-uuid}/rule/{rule-id}": { "get": { "tags": [ "firewall-ruleset" ], "summary": "Get firewall ruleset rule details", "description": "Returns firewall ruleset rule details.", "operationId": "getFirewallRulesetRule", "parameters": [ { "$ref": "#/components/parameters/getFirewallRulesetRuleRulesetUuid" }, { "$ref": "#/components/parameters/getFirewallRulesetRuleRuleId" } ], "responses": { "200": { "$ref": "#/components/responses/getFirewallRulesetRule200" }, "default": { "$ref": "#/components/responses/getFirewallRulesetRuleDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "firewall-ruleset" ], "summary": "Delete firewall ruleset rule", "description": "Deletes an existing rule by given {ruleset-uuid} and {rule-uuid}.", "operationId": "deleteFirewallRulesetRule", "parameters": [ { "$ref": "#/components/parameters/deleteFirewallRulesetRuleRulesetUuid" }, { "$ref": "#/components/parameters/deleteFirewallRulesetRuleRuleId" } ], "responses": { "204": { "$ref": "#/components/responses/deleteFirewallRulesetRule204" }, "default": { "$ref": "#/components/responses/deleteFirewallRulesetRuleDefault" } }, "x-upcloud-visibility": "public" }, "patch": { "tags": [ "firewall-ruleset" ], "summary": "Modify firewall ruleset rule", "description": "Modifies existing firewall ruleset rule by given {ruleset_uuid} and {rule-uuid}.", "operationId": "modifyFirewallRulesetRule", "parameters": [ { "$ref": "#/components/parameters/modifyFirewallRulesetRuleRulesetUuid" }, { "$ref": "#/components/parameters/modifyFirewallRulesetRuleRuleId" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyFirewallRulesetRule" }, "responses": { "200": { "$ref": "#/components/responses/modifyFirewallRulesetRule200" }, "default": { "$ref": "#/components/responses/modifyFirewallRulesetRuleDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/firewall-ruleset/{ruleset-uuid}/labels": { "get": { "tags": [ "firewall-ruleset" ], "summary": "List firewall ruleset labels", "description": "Returns a list of available firewall ruleset labels by given {ruleset-uuid}.", "operationId": "listFirewallRulesetLabels", "parameters": [ { "$ref": "#/components/parameters/listFirewallRulesetLabelsRulesetUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listFirewallRulesetLabels200" }, "default": { "$ref": "#/components/responses/listFirewallRulesetLabelsDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "firewall-ruleset" ], "summary": "Create firewall ruleset label", "description": "Creates a new label by given {ruleset-uuid}. Labels are used for group filtering.", "operationId": "createFirewallRulesetLabel", "parameters": [ { "$ref": "#/components/parameters/createFirewallRulesetLabelRulesetUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/createFirewallRulesetLabel" }, "responses": { "201": { "$ref": "#/components/responses/createFirewallRulesetLabel201" }, "default": { "$ref": "#/components/responses/createFirewallRulesetLabelDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/firewall-ruleset/{ruleset-uuid}/servers": { "get": { "tags": [ "firewall-ruleset" ], "summary": "List servers attached to a firewall ruleset", "description": "Returns a list of servers that are attached to the firewall ruleset by given {ruleset-uuid}.", "operationId": "listFirewallRulesetAttachedServers", "parameters": [ { "$ref": "#/components/parameters/listFirewallRulesetAttachedServersRulesetUuid" } ], "responses": { "200": { "$ref": "#/components/responses/listFirewallRulesetAttachedServers200" }, "default": { "$ref": "#/components/responses/listFirewallRulesetAttachedServersDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/firewall-ruleset/{ruleset-uuid}/labels/{label-key}": { "get": { "tags": [ "firewall-ruleset" ], "summary": "Get firewall ruleset label details", "description": "Returns label details by given {ruleset-uuid} and {label-key}.", "operationId": "getFirewallRulesetLabel", "parameters": [ { "$ref": "#/components/parameters/getFirewallRulesetLabelRulesetUuid" }, { "$ref": "#/components/parameters/getFirewallRulesetLabelLabelKey" } ], "responses": { "200": { "$ref": "#/components/responses/getFirewallRulesetLabel200" }, "default": { "$ref": "#/components/responses/getFirewallRulesetLabelDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "firewall-ruleset" ], "summary": "Delete firewall ruleset label", "description": "Deletes existing label by given {ruleset-uuid} and {label-key}.", "operationId": "deleteFirewallRulesetLabel", "parameters": [ { "$ref": "#/components/parameters/deleteFirewallRulesetLabelRulesetUuid" }, { "$ref": "#/components/parameters/deleteFirewallRulesetLabelLabelKey" } ], "responses": { "204": { "$ref": "#/components/responses/deleteFirewallRulesetLabel204" }, "default": { "$ref": "#/components/responses/deleteFirewallRulesetLabelDefault" } }, "x-upcloud-visibility": "public" }, "patch": { "tags": [ "firewall-ruleset" ], "summary": "Modify firewall ruleset label", "description": "Modifies existing label by given {ruleset-uuid} and {label-key}.", "operationId": "modifyFirewallRulesetLabel", "parameters": [ { "$ref": "#/components/parameters/modifyFirewallRulesetLabelRulesetUuid" }, { "$ref": "#/components/parameters/modifyFirewallRulesetLabelLabelKey" } ], "requestBody": { "$ref": "#/components/requestBodies/modifyFirewallRulesetLabel" }, "responses": { "200": { "$ref": "#/components/responses/modifyFirewallRulesetLabel200" }, "default": { "$ref": "#/components/responses/modifyFirewallRulesetLabelDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/firewall-ruleset/server/{server-uuid}/firewall-rule": { "get": { "tags": [ "firewall-ruleset" ], "summary": "List server firewall rules", "description": "Returns a list of server firewall rules.", "operationId": "listServerFirewallRule", "parameters": [ { "$ref": "#/components/parameters/firewallRulesetListServerFirewallRuleServerUuid" }, { "$ref": "#/components/parameters/firewallRulesetListServerFirewallRuleLimit" }, { "$ref": "#/components/parameters/firewallRulesetListServerFirewallRuleOffset" }, { "$ref": "#/components/parameters/firewallRulesetListServerFirewallRuleSort" } ], "responses": { "200": { "$ref": "#/components/responses/firewallRulesetListServerFirewallRule200" }, "default": { "$ref": "#/components/responses/firewallRulesetListServerFirewallRuleDefault" } }, "x-upcloud-visibility": "public" }, "put": { "tags": [ "firewall-ruleset" ], "summary": "Create multiple server firewall rules", "description": "Creates multiple server firewall rules by given {server-uuid}.", "operationId": "createMultipleServerFirewallRules", "parameters": [ { "$ref": "#/components/parameters/firewallRulesetCreateMultipleServerFirewallRulesServerUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/firewallRulesetCreateMultipleServerFirewallRules" }, "responses": { "200": { "$ref": "#/components/responses/firewallRulesetCreateMultipleServerFirewallRules200" }, "400": { "$ref": "#/components/responses/firewallRulesetCreateMultipleServerFirewallRules400" }, "403": { "$ref": "#/components/responses/firewallRulesetCreateMultipleServerFirewallRules403" }, "404": { "$ref": "#/components/responses/firewallRulesetCreateMultipleServerFirewallRules404" }, "409": { "$ref": "#/components/responses/firewallRulesetCreateMultipleServerFirewallRules409" }, "default": { "$ref": "#/components/responses/firewallRulesetCreateMultipleServerFirewallRulesDefault" } }, "x-upcloud-visibility": "public" }, "post": { "tags": [ "firewall-ruleset" ], "summary": "Create server firewall rule", "description": "Creates a new server firewall rule.", "operationId": "createServerFirewallRule", "parameters": [ { "$ref": "#/components/parameters/firewallRulesetCreateServerFirewallRuleServerUuid" } ], "requestBody": { "$ref": "#/components/requestBodies/firewallRulesetCreateServerFirewallRule" }, "responses": { "201": { "$ref": "#/components/responses/firewallRulesetCreateServerFirewallRule201" }, "400": { "$ref": "#/components/responses/firewallRulesetCreateServerFirewallRule400" }, "403": { "$ref": "#/components/responses/firewallRulesetCreateServerFirewallRule403" }, "404": { "$ref": "#/components/responses/firewallRulesetCreateServerFirewallRule404" }, "409": { "$ref": "#/components/responses/firewallRulesetCreateServerFirewallRule409" }, "default": { "$ref": "#/components/responses/firewallRulesetCreateServerFirewallRuleDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/firewall-ruleset/server/{server-uuid}/firewall-rule/{position}": { "get": { "tags": [ "firewall-ruleset" ], "summary": "Get server firewall rule details", "description": "Returns server firewall rule details by given {server-uuid} and {position}.", "operationId": "getServerFirewallRule", "parameters": [ { "$ref": "#/components/parameters/firewallRulesetGetServerFirewallRuleServerUuid" }, { "$ref": "#/components/parameters/firewallRulesetGetServerFirewallRulePosition" } ], "responses": { "200": { "$ref": "#/components/responses/firewallRulesetGetServerFirewallRule200" }, "default": { "$ref": "#/components/responses/firewallRulesetGetServerFirewallRuleDefault" } }, "x-upcloud-visibility": "public" }, "delete": { "tags": [ "firewall-ruleset" ], "summary": "Delete server firewall rule", "description": "Deletes existing server firewall rule by given {server-uuid} and {position}.", "operationId": "deleteServerFirewallRule", "parameters": [ { "$ref": "#/components/parameters/firewallRulesetDeleteServerFirewallRuleServerUuid" }, { "$ref": "#/components/parameters/firewallRulesetDeleteServerFirewallRulePosition" } ], "responses": { "204": { "$ref": "#/components/responses/firewallRulesetDeleteServerFirewallRule204" }, "400": { "$ref": "#/components/responses/firewallRulesetDeleteServerFirewallRule400" }, "403": { "$ref": "#/components/responses/firewallRulesetDeleteServerFirewallRule403" }, "404": { "$ref": "#/components/responses/firewallRulesetDeleteServerFirewallRule404" }, "409": { "$ref": "#/components/responses/firewallRulesetDeleteServerFirewallRule409" }, "default": { "$ref": "#/components/responses/firewallRulesetDeleteServerFirewallRuleDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/vnc_keymap": { "get": { "tags": [ "vnc_keymap" ], "summary": "List VNC keymaps", "description": "Retrieves a list of supported VNC keymaps.", "operationId": "listVNCKeymaps", "responses": { "200": { "$ref": "#/components/responses/listVNCKeymaps200" }, "default": { "$ref": "#/components/responses/listVNCKeymapsDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/zone": { "get": { "tags": [ "zone" ], "summary": "List zones", "description": "Retrieves a list of zones.", "operationId": "listZones", "responses": { "200": { "$ref": "#/components/responses/listZones200" }, "default": { "$ref": "#/components/responses/listZonesDefault" } }, "x-upcloud-visibility": "public" } }, "/1.3/zone/{zone}/vlans": { "get": { "tags": [ "zone" ], "summary": "List VLANs in a zone", "description": "Retrieves a list of VLANs in a specific zone.", "operationId": "listZoneVLANs", "parameters": [ { "$ref": "#/components/parameters/listZoneVLANsZone" } ], "responses": { "200": { "$ref": "#/components/responses/listZoneVLANs200" }, "default": { "$ref": "#/components/responses/listZoneVLANsDefault" } } } } }, "components": { "schemas": { "createSubaccountRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "sub_account": { "type": "object", "properties": { "username": { "$ref": "#/components/schemas/accountUserName" }, "password": { "type": "string", "format": "password" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "company": { "type": "string" }, "vat_number": { "type": "string" }, "address": { "type": "string" }, "postal_code": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "$ref": "#/components/schemas/accountCountryCode" }, "email": { "type": "string", "format": "email" }, "phone": { "$ref": "#/components/schemas/accountPhoneNumber" }, "language": { "$ref": "#/components/schemas/accountLanguageCode" }, "currency": { "$ref": "#/components/schemas/accountCurrencyCode" }, "timezone": { "type": "string" }, "allow_api": { "$ref": "#/components/schemas/accountBooleanYesno" }, "allow_gui": { "$ref": "#/components/schemas/accountBooleanYesno" }, "roles": { "type": "object", "properties": { "role": { "type": "array", "items": { "type": "string" } } }, "required": [ "role" ], "additionalProperties": false }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/accountLabel" } }, "ip_filters": { "type": "object", "properties": { "ip_filter": { "type": "array", "items": { "type": "string" } } }, "required": [ "ip_filter" ], "additionalProperties": false }, "server_access": { "type": "object", "additionalProperties": true }, "storage_access": { "type": "object", "additionalProperties": true }, "network_access": { "type": "object", "additionalProperties": true }, "tag_access": { "type": "object", "additionalProperties": true }, "enable_3rd_party_services": { "$ref": "#/components/schemas/accountBooleanYesno" } }, "required": [ "username", "email", "phone", "language", "timezone" ], "additionalProperties": false } }, "required": [ "sub_account" ], "additionalProperties": false, "description": "Request for creating a subaccount.", "example": { "sub_account": { "first_name": "first", "last_name": "last", "company": "my company name", "address": "my address", "postal_code": "00130", "city": "Helsinki", "state": "", "country": "FIN", "phone": "+358.31245434", "email": "user@example.com", "vat_number": "my vat number", "timezone": "Europe/Helsinki", "username": "myusername", "password": "mysecr3tPassword", "currency": "EUR", "language": "en", "roles": { "role": [ "technical", "billing", "aux_billing" ] }, "allow_gui": "no", "allow_api": "yes", "network_access": { "network": [] }, "server_access": { "server": [] }, "storage_access": { "storage": [] }, "tag_access": { "tag": [] }, "ip_filters": { "ip_filter": [] }, "labels": [ { "key": "department", "value": "it" } ] } } }, "account": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "account": { "$ref": "#/components/schemas/accountDetails" } }, "required": [ "account" ], "additionalProperties": false, "description": "Response schema containing account details.", "example": { "account": { "username": "apiuser01", "credits": 25.5, "resource_limits": { "managed_databases": 5, "network_peerings": 20, "file_storages": 10, "managed_kubernetes": 5, "tags": 200, "cores": 64, "cloud_server_dev_1xcpu_1gb_10gb_plans": 0, "cloud_server_dev_1xcpu_1gb_plans": 0, "storage_hdd": 10240, "networks": 100, "network_gateways_essentials": 20, "network_gateways": 20, "storage_ssd": 20480, "load_balancers_essentials": 20, "load_balancers": 20, "gpus": 8, "detached_interfaces": 100, "detached_floating_ips": 50, "managed_object_storages": 50, "memory": 524288, "ntp_excess_gib": 100, "public_ipv4": 64, "public_ipv6": 64, "routers": 20, "storage_maxiops": 10240, "storage_standard": 20480, "storage_total": 40960 } } } }, "accountDetails": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "resource_limits": { "$ref": "#/components/schemas/accountResourceLimits" }, "username": { "$ref": "#/components/schemas/accountUserName" }, "credits": { "$ref": "#/components/schemas/accountCredits" }, "trial_mode": { "$ref": "#/components/schemas/accountBoolean01" } }, "required": [ "username", "resource_limits" ], "additionalProperties": true, "description": "Detailed account information and limits.", "example": { "username": "apiuser01", "credits": 25.5, "resource_limits": { "managed_databases": 5, "network_peerings": 20, "file_storages": 10, "managed_kubernetes": 5, "tags": 200, "cores": 64, "cloud_server_dev_1xcpu_1gb_10gb_plans": 0, "cloud_server_dev_1xcpu_1gb_plans": 0, "storage_hdd": 10240, "networks": 100, "network_gateways_essentials": 20, "network_gateways": 20, "storage_ssd": 20480, "load_balancers_essentials": 20, "load_balancers": 20, "gpus": 8, "detached_interfaces": 100, "detached_floating_ips": 50, "managed_object_storages": 50, "memory": 524288, "ntp_excess_gib": 100, "public_ipv4": 64, "public_ipv6": 64, "routers": 20, "storage_maxiops": 10240, "storage_standard": 20480, "storage_total": 40960 } } }, "accounts": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "accounts": { "type": "object", "properties": { "account": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "main", "sub" ] }, "username": { "$ref": "#/components/schemas/accountUserName" }, "roles": { "type": "object", "properties": { "role": { "type": "array", "items": { "type": "string" } } }, "required": [ "role" ], "additionalProperties": false }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/accountLabel" } } }, "required": [ "type", "username", "roles", "labels" ], "additionalProperties": false } } }, "required": [ "account" ], "additionalProperties": false } }, "required": [ "accounts" ], "additionalProperties": false, "description": "Main account and subaccounts accessible to the authenticated account.", "example": { "accounts": { "account": [ { "labels": [], "roles": { "role": [ "technical" ] }, "type": "mymain", "username": "test" }, { "labels": [], "roles": { "role": [ "technical" ] }, "type": "sub", "username": "my_sub_account" }, { "labels": [ { "key": "to_be_removed", "value": "after 2022-31-12" } ], "roles": { "role": [] }, "type": "sub", "username": "my_temp_account" }, { "labels": [], "roles": { "role": [ "billing" ] }, "type": "sub", "username": "my_billing_account" } ] } } }, "accountUserName": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "maxLength": 64, "minLength": 4, "description": "Username for an account." }, "accountRfc3339Datetime": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "2026-07-01T00:00:00Z", "2026-07-31T23:59:59Z" ], "format": "date-time", "description": "Datetime in RFC 3339 format" }, "accountResourceNetworkUsageType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "load_balancer_private", "load_balancer_private_vlan", "load_balancer_public", "network_gateway_private", "network_gateway_private_vlan", "network_gateway_public", "object_storage_v2_private", "object_storage_v2_public", "server_private", "server_private_vlan", "server_public" ], "description": "Network usage type for resource" }, "accountZone": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "fi-hel1", "de-fra1", "us-nyc1" ], "maxLength": 15, "minLength": 2, "pattern": "^[a-z][a-z0-9-]{0,14}[a-z0-9]$", "description": "Zone identifier" }, "accountUsageAccumulateParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "hour", "day" ], "description": "Usage accumulator hour or day parameter" }, "accountUuid": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "format": "uuid", "description": "Universally unique identifier", "example": "0414e0d7-4436-4037-9dd8-6eaf47dce599" }, "accountCountryCode": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 3166-1 Alpha-3 code" }, "accountPhoneNumber": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "description": "Phone number in international format." }, "accountLanguageCode": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[a-z]{2}$", "description": "ISO 639-1 code" }, "accountCurrencyCode": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 code" }, "accountBooleanYesno": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "yes", "no" ], "description": "Boolean value represented as yes/no", "example": "yes" }, "accountLabel": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "key": { "type": "string", "description": "Label key used to classify the resource" }, "value": { "type": "string", "description": "Value associated with the label key" } }, "required": [ "key", "value" ], "additionalProperties": false, "description": "A key/value pair to label and categorize resources", "example": { "key": "env", "value": "production" } }, "accountResourceLimits": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "managed_databases": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum number of managed databases allowed." }, "network_peerings": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum number of network peerings allowed." }, "file_storages": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum number of file storage instances allowed." }, "managed_container_registries": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum number of managed container registries allowed." }, "managed_kubernetes": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum number of managed Kubernetes clusters allowed." }, "tags": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum number of tags allowed." }, "cores": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum number of CPU cores allowed." }, "cloud_server_dev_1xcpu_1gb_10gb_plans": { "type": [ "integer", "null" ], "minimum": 0, "format": "int64", "description": "The maximum number of cloud server dev 1xCPU 1GB 10GB plans allowed." }, "cloud_server_dev_1xcpu_1gb_plans": { "type": [ "integer", "null" ], "minimum": 0, "format": "int64", "description": "The maximum number of cloud server dev 1xCPU 1GB 10GB plans allowed." }, "storage_hdd": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum amount of HDD storage (in GiB) allowed." }, "networks": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum number of networks allowed." }, "network_gateways_essentials": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum number of essential network gateways allowed." }, "network_gateways": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum number of network gateways allowed." }, "storage_ssd": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum amount of SSD storage (in GiB) allowed." }, "load_balancers_essentials": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum number of essential load balancers allowed." }, "load_balancers": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum number of load balancers allowed." }, "gpus": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum number of GPUs allowed." }, "detached_interfaces": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum number of detached network interfaces allowed." }, "detached_floating_ips": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum number of detached floating IPs allowed." }, "managed_object_storages": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum number of managed object storage instances allowed." }, "memory": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum amount of memory (in MiB) allowed." }, "ntp_excess_gib": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum amount of excess NTP data (in GiB) allowed." }, "public_ipv4": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum number of public IPv4 addresses allowed." }, "public_ipv6": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum number of public IPv6 addresses allowed." }, "routers": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum number of routers allowed." }, "storage_maxiops": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum amount of MaxiOPS storage (in GiB) allowed." }, "storage_standard": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum amount of standard storage (in GiB) allowed." }, "storage_total": { "type": "integer", "minimum": 0, "format": "int64", "description": "The maximum total amount of storage (in GiB) allowed." }, "type": {}, "required": {}, "additionalProperties": {} }, "description": "Per-resource quota limits for an account." }, "accountCredits": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "number", "format": "double", "description": "Current account credit balance." }, "accountBoolean01": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "format": "int64", "enum": [ 0, 1 ], "description": "Schema for boolean-like values encoded as 0 or 1." }, "accountError": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "examples": [ "GENERAL_FAILURE" ] }, "error_message": { "type": "string", "examples": [ "Your request could not be fulfilled due to a technical issue." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "A general error response indicating that the request could not be fulfilled due to a technical issue." }, "accountBillingSummary": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "currency": { "$ref": "#/components/schemas/accountCurrencyCode" }, "total_amount": { "type": "number" } }, "additionalProperties": true, "description": "Monthly billing totals grouped by resource type and subtype.", "example": { "currency": "EUR", "managed_databases": { "managed_database": { "resources": [ { "amount": 15.10223, "details": [ { "amount": 15.10223, "hours": 420, "plan": "1x1xCPU-2GB-25GB", "zone": "fi-hel2" } ], "hours": 420, "resource_id": "09001a4d-b525-4ab8-835d-000000000000" } ], "total_amount": 15.10223 }, "total_amount": 15.10223 }, "managed_object_storages": { "managed_object_storage": { "resources": [ { "amount": 5.03384, "details": [ { "amount": 5.03384, "billable_size_gib": 500, "hours": 420, "zone": "fi-hel2" } ], "hours": 420, "resource_id": "127ee42a-8304-477c-84e1-000000000000" } ], "total_amount": 5.03384 }, "total_amount": 5.03384 }, "servers": { "server": { "resources": [ { "amount": 16.18091, "details": [ { "amount": 16.18091, "hours": 420, "labels": [ { "key": "test", "value": "" } ], "plan": "2xCPU-4GB", "zone": "fi-hel2" } ], "hours": 420, "resource_id": "001c2caa-00dc-4eff-9321-000000000000" }, { "amount": 16.10386, "details": [ { "amount": 16.10386, "hours": 418, "labels": [ { "key": "test2", "value": "" } ], "plan": "2xCPU-4GB", "zone": "fi-hel2" }, { "amount": 0.9288, "hours": 12, "labels": [ { "key": "test2", "value": "" } ], "plan": "4xCPU-8GB", "zone": "fi-hel2" } ], "hours": 430, "resource_id": "0010cf04-3608-4512-b4de-000000000000" } ], "total_amount": 33.21357 }, "total_amount": 33.21357 }, "total_amount": 53.34964 } }, "accountBillingSummaryResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "billing": { "$ref": "#/components/schemas/accountBillingSummary" } }, "required": [ "billing" ], "additionalProperties": false, "description": "Response containing a monthly billing summary.", "example": { "billing": { "currency": "EUR", "networks": { "bandwidth": { "total_amount": 52.136 }, "total_amount": 52.136 }, "managed_databases": { "managed_database": { "total_amount": 80.13127 }, "total_amount": 80.13127 }, "managed_object_storages": { "managed_object_storage": { "total_amount": 2.2253 }, "total_amount": 2.2253 }, "servers": { "server": { "total_amount": 28.05132 }, "total_amount": 28.05132 }, "storages": { "storage": { "total_amount": 3.6224 }, "total_amount": 3.6224 }, "total_amount": 166.16629 } } }, "accountCurrentNetworkUsage": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "stats": { "type": "object", "properties": { "current_network_usage": { "type": "object", "properties": { "updated": { "$ref": "#/components/schemas/accountRfc3339Datetime" }, "accumulated_quota_bytes": { "type": "integer", "format": "int64" }, "total_sent_bytes": { "type": "integer", "format": "int64" }, "hourly_quota_increase_bytes": { "type": "integer", "format": "int64" }, "projected_monthly_quota_bytes": { "type": "integer", "format": "int64" } }, "required": [ "updated", "accumulated_quota_bytes", "total_sent_bytes", "hourly_quota_increase_bytes", "projected_monthly_quota_bytes" ], "additionalProperties": false } }, "required": [ "current_network_usage" ], "additionalProperties": false } }, "required": [ "stats" ], "additionalProperties": false, "description": "Current Fair Transfer Policy usage for an account.", "example": { "stats": { "current_network_usage": { "accumulated_quota_bytes": 3546328504778, "hourly_quota_increase_bytes": 10577635230, "projected_monthly_quota_bytes": 7777382596778, "total_sent_bytes": 13682943146, "updated": "2020-10-15T07:00:00Z" } } } }, "accountCreateMsLmaSigningLinkResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "signing_status": { "type": "object", "properties": { "id": { "type": "string" }, "initiated": { "type": "string", "examples": [ "2026-07-29T11:00:00Z" ], "format": "date-time" }, "signed_at": { "type": "string", "examples": [ "2026-07-29T11:05:00Z" ], "format": "date-time" }, "signing_link": { "type": "string", "format": "uri" }, "state": { "type": "string", "enum": [ "initiated", "waiting", "completed", "canceled" ] } }, "required": [ "id", "state", "initiated", "signing_link", "signed_at" ], "example": { "id": "mslma_1234567890", "initiated": "2026-07-29T11:00:00Z", "signed_at": "2026-07-29T11:05:00Z", "signing_link": "https://example.com/sign/mslma_1234567890", "state": "completed" } } }, "description": "Response schema for Microsoft LMA signing link creation.", "example": { "signing_status": { "id": "mslma_1234567890", "initiated": "2026-07-29T11:00:00Z", "signed_at": "2026-07-29T11:05:00Z", "signing_link": "https://example.com/sign/mslma_1234567890", "state": "completed" } } }, "accountResourceNetworkUsage": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "stats": { "type": "object", "properties": { "stat": { "type": "array", "items": { "type": "object", "properties": { "resource_id": { "$ref": "#/components/schemas/accountUuid" }, "service": { "$ref": "#/components/schemas/accountResourceNetworkUsageType" }, "zone": { "$ref": "#/components/schemas/accountZone" }, "start_time": { "$ref": "#/components/schemas/accountRfc3339Datetime" }, "sent_bytes": { "type": [ "integer", "null" ], "format": "int64" } }, "required": [ "resource_id", "service", "zone", "start_time", "sent_bytes" ], "additionalProperties": false } } }, "required": [ "stat" ], "additionalProperties": false } }, "required": [ "stats" ], "additionalProperties": false, "description": "Network usage statistics grouped by resource.", "example": { "stats": { "stat": [ { "resource_id": "00777436-a6f8-43af-9daf-89e8e6833a7a", "sent_bytes": 10094, "service": "server_public", "start_time": "2020-09-07T00:00:00Z", "zone": "de-fra1" }, { "resource_id": "00777436-a6f8-43af-9daf-89e8e6833a7a", "sent_bytes": 35174050, "service": "server_public", "start_time": "2020-09-08T00:00:00Z", "zone": "de-fra1" }, { "resource_id": "00777436-a6f8-43af-9daf-89e8e6833a7a", "sent_bytes": 32790622, "service": "server_public", "start_time": "2020-09-09T00:00:00Z", "zone": "de-fra1" } ] } } }, "accountNetworkUsage": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "stats": { "type": "object", "properties": { "stat": { "type": "array", "items": { "type": "object", "properties": { "start_time": { "$ref": "#/components/schemas/accountRfc3339Datetime" }, "sent_bytes": { "type": "integer", "format": "int64" }, "total_sent_bytes": { "type": "integer", "format": "int64" }, "accumulated_quota_bytes": { "type": "integer", "format": "int64" }, "projected_monthly_quota_bytes": { "type": "integer", "format": "int64" }, "quota_increase_bytes": { "type": "integer", "format": "int64" } }, "required": [ "start_time", "sent_bytes", "total_sent_bytes", "accumulated_quota_bytes", "projected_monthly_quota_bytes", "quota_increase_bytes" ], "additionalProperties": false } } }, "required": [ "stat" ], "additionalProperties": false } }, "required": [ "stats" ], "additionalProperties": false, "description": "Account network usage and Fair Transfer Policy quota statistics.", "example": { "stats": { "stat": [ { "accumulated_quota_bytes": 6352371508013, "projected_monthly_quota_bytes": 6362243967561, "quota_increase_bytes": 9872459548, "sent_bytes": 1254, "start_time": "2020-09-30T22:00:00Z", "total_sent_bytes": 225149331390 }, { "accumulated_quota_bytes": 6362243967561, "projected_monthly_quota_bytes": 6362243967561, "quota_increase_bytes": 9872459548, "sent_bytes": 1254, "start_time": "2020-09-30T23:00:00Z", "total_sent_bytes": 225149332644 }, { "accumulated_quota_bytes": 9872459548, "projected_monthly_quota_bytes": 7345109903712, "quota_increase_bytes": 9872459548, "sent_bytes": 906, "start_time": "2020-10-01T00:00:00Z", "total_sent_bytes": 906 } ] } } }, "accountResourceUsage": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": { "type": "integer", "minimum": 0 }, "description": "Current account resource usage keyed by resource limit name." }, "accountResourceBillingSummaryResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "billing": { "type": "object", "properties": { "currency": { "$ref": "#/components/schemas/accountCurrencyCode" }, "daily_sums": { "type": "object", "additionalProperties": { "type": "number" } }, "details": { "type": "object", "additionalProperties": true }, "total_amount": { "type": "number" } }, "additionalProperties": false } }, "required": [ "billing" ], "additionalProperties": false, "description": "Response containing the monthly billing summary for a resource.", "example": { "billing": { "daily_sums": { "2019-12-02": 3.33684, "2019-12-03": 52.77344, "2019-12-04": 1.07424, "2019-12-05": 1.07424, "2019-12-06": 1.07424, "2019-12-07": 1.07424, "2019-12-08": 1.07424, "2019-12-09": 1.07424, "2019-12-12": 3.22272, "2019-12-13": 0.58188 }, "details": { "hours": 792, "plan": "1xCPU-1GB", "resource_id": "00ce9363-9065-4c2a-9d66-3b0c762f556b", "title": "My Glorious Server", "type": "server", "zone": "fi-hel1" }, "total_amount": 66.36032 } } }, "kubernetesVersion": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/kubernetesClusterVersion" }, "version": { "type": "string", "description": "Kubernetes semantic version" } }, "required": [ "id", "version" ], "description": "Kubernetes version" }, "kubernetesVersions": { "type": "array", "items": { "$ref": "#/components/schemas/kubernetesVersion" }, "description": "List of Kubernetes versions" }, "kubernetesAuthenticationConfigurationYAML": { "type": "string", "description": "kube-apiserver v1 AuthenticationConfiguration YAML document" }, "kubernetesAccepted": { "type": "object", "properties": { "message": { "$ref": "#/components/schemas/kubernetesMessage" } }, "description": "Message" }, "kubernetesCluster": { "type": "object", "properties": { "control_plane_ip_filter": { "$ref": "#/components/schemas/kubernetesIPBlocks" }, "name": { "$ref": "#/components/schemas/kubernetesName" }, "network": { "$ref": "#/components/schemas/kubernetesNetwork" }, "network_cidr": { "$ref": "#/components/schemas/kubernetesNetworkCIDR" }, "storage_encryption": { "$ref": "#/components/schemas/kubernetesDefaultStorageEncryption" }, "node_groups": { "$ref": "#/components/schemas/kubernetesNodeGroups" }, "state": { "$ref": "#/components/schemas/kubernetesClusterState" }, "uuid": { "$ref": "#/components/schemas/kubernetesUuid" }, "zone": { "$ref": "#/components/schemas/kubernetesZone" }, "plan": { "$ref": "#/components/schemas/kubernetesClusterPlan" }, "private_node_groups": { "$ref": "#/components/schemas/kubernetesPrivateNodeGroups" }, "version": { "$ref": "#/components/schemas/kubernetesClusterVersion" }, "authentication": { "$ref": "#/components/schemas/kubernetesAuthenticationConfiguration" }, "labels": {} }, "required": [ "name", "network", "zone", "version", "labels" ], "description": "Kubernetes cluster" }, "kubernetesClusterAvailableUpgrades": { "type": "object", "properties": { "versions": { "type": "array", "items": { "$ref": "#/components/schemas/kubernetesClusterVersion" } } }, "required": [ "versions" ] }, "kubernetesClusterAvailableUpgradesPost": { "type": "object", "properties": { "version": { "$ref": "#/components/schemas/kubernetesClusterVersion" }, "strategy": { "$ref": "#/components/schemas/kubernetesClusterUpgradeStrategy" } }, "required": [ "version" ] }, "kubernetesClusterKubeconfig": { "type": "object", "properties": { "kubeconfig": { "$ref": "#/components/schemas/kubernetesKubeconfig" } }, "required": [ "kubeconfig" ], "description": "Kubernetes cluster kubeconfig" }, "kubernetesClusterPatch": { "type": "object", "properties": { "control_plane_ip_filter": { "$ref": "#/components/schemas/kubernetesIPBlocks" }, "labels": {}, "plan": { "$ref": "#/components/schemas/kubernetesClusterPlan" } }, "required": [ "labels" ] }, "kubernetesClusters": { "type": "array", "items": { "$ref": "#/components/schemas/kubernetesCluster" }, "description": "List of Kubernetes clusters" }, "kubernetesClusterState": { "type": "string", "enum": [ "failed", "pending", "running", "terminated", "terminating", "unknown", "suspended", "upgrading", "upgrade-pending", "upgrade-failed" ], "description": "Cluster operational state" }, "kubernetesNodeState": { "type": "string", "enum": [ "pending", "failed", "running", "terminating", "unknown" ], "description": "Node operational state" }, "kubernetesCount": { "type": "integer", "maximum": 16, "minimum": 0, "format": "int32", "description": "Amount of nodes in a node group" }, "kubernetesDescription": { "type": "string", "description": "Plan description" }, "kubernetesEffect": { "type": "string", "enum": [ "NoExecute", "NoSchedule", "PreferNoSchedule" ], "description": "Taint effect" }, "kubernetesError": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/kubernetesErrorType" }, "title": { "$ref": "#/components/schemas/kubernetesErrorTitle" }, "status": { "$ref": "#/components/schemas/kubernetesErrorStatus" }, "invalid_params": { "$ref": "#/components/schemas/kubernetesErrorInvalidParams" }, "correlation_id": { "$ref": "#/components/schemas/kubernetesErrorCorrelationID" } }, "required": [ "type", "title", "status", "correlation_id" ], "description": "Response error" }, "kubernetesErrorType": { "type": "string", "description": "URI to a page describing the problem" }, "kubernetesErrorTitle": { "type": "string", "description": "human-readable description of the error" }, "kubernetesErrorInvalidParams": { "type": "string", "description": "list of parameters describing a specific part(s) of the request that caused the error" }, "kubernetesErrorCorrelationID": { "type": "string", "description": "unique string that identifies the request that caused the error" }, "kubernetesErrorStatus": { "type": "integer", "format": "int32", "description": "HTTP Status code" }, "kubernetesIPBlock": { "type": "string", "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}($|/(0-32))$", "description": "IP prefix of a single IPv4 address or a network CIDR" }, "kubernetesIPBlocks": { "type": "array", "items": { "$ref": "#/components/schemas/kubernetesIPBlock" }, "maxItems": 100, "uniqueItems": true, "description": "List of IP blocks" }, "kubernetesKey": { "type": "string", "description": "Key of a key-value pair" }, "kubernetesKubeconfig": { "type": "string", "description": "Kubeconfig" }, "kubernetesKubeletArg": { "type": "object", "properties": { "key": { "$ref": "#/components/schemas/kubernetesKey" }, "value": { "$ref": "#/components/schemas/kubernetesValue" } }, "required": [ "key", "value" ], "description": "Kubelet argument presented as key-value pair" }, "kubernetesKubeletArgs": { "type": "array", "items": { "$ref": "#/components/schemas/kubernetesKubeletArg" }, "description": "List of Kubelet arguments" }, "kubernetesLabel": { "type": "object", "properties": { "key": { "$ref": "#/components/schemas/kubernetesKey" }, "value": { "$ref": "#/components/schemas/kubernetesValue" } }, "required": [ "key" ], "description": "Label for identifying node groups, presented as key-value pair" }, "kubernetesLabels": { "type": "array", "items": { "$ref": "#/components/schemas/kubernetesLabel" }, "uniqueItems": true, "description": "List of labels" }, "kubernetesMessage": { "type": "string", "description": "Message text content" }, "kubernetesName": { "type": "string", "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "description": "Name" }, "kubernetesNodeName": { "type": "string", "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "description": "Node name" }, "kubernetesNetwork": { "type": "string", "minLength": 1, "description": "Network UUID" }, "kubernetesNetworkCIDR": { "type": "string", "description": "CIDR of the given network" }, "kubernetesNodeGroup": { "type": "object", "properties": { "count": { "$ref": "#/components/schemas/kubernetesCount" }, "kubelet_args": { "$ref": "#/components/schemas/kubernetesKubeletArgs" }, "labels": { "$ref": "#/components/schemas/kubernetesLabels" }, "name": { "$ref": "#/components/schemas/kubernetesName" }, "plan": { "$ref": "#/components/schemas/kubernetesNodeGroupPlan" }, "custom_plan": { "$ref": "#/components/schemas/kubernetesNodeGroupCustomPlan" }, "cloud_native_plan": { "$ref": "#/components/schemas/kubernetesNodeGroupCloudNativePlan" }, "gpu_plan": { "$ref": "#/components/schemas/kubernetesNodeGroupGPUPlan" }, "ssh_keys": { "$ref": "#/components/schemas/kubernetesSshKeys" }, "state": { "$ref": "#/components/schemas/kubernetesNodeGroupState" }, "storage": { "$ref": "#/components/schemas/kubernetesStorage" }, "storage_encryption": { "$ref": "#/components/schemas/kubernetesStorageEncryption" }, "taints": { "$ref": "#/components/schemas/kubernetesTaints" }, "anti_affinity": { "$ref": "#/components/schemas/kubernetesAntiAffinity" }, "utility_network_access": { "$ref": "#/components/schemas/kubernetesUtilityNetworkAccess" }, "node_updates": { "$ref": "#/components/schemas/kubernetesNodeUpdates" } }, "required": [ "count", "name", "plan" ], "description": "Node group for a Kubernetes cluster" }, "kubernetesNodeGroupPatch": { "type": "object", "properties": { "count": { "$ref": "#/components/schemas/kubernetesCount" } }, "required": [ "count" ] }, "kubernetesNodeGroups": { "type": "array", "items": { "$ref": "#/components/schemas/kubernetesNodeGroup" }, "maxItems": 16, "uniqueItems": true, "description": "List of node groups" }, "kubernetesNodeGroupState": { "type": "string", "enum": [ "failed", "pending", "running", "terminating", "unknown", "scaling-up", "scaling-down" ], "description": "Node group operational state" }, "kubernetesPlan": { "type": "object", "properties": { "description": { "$ref": "#/components/schemas/kubernetesDescription" }, "name": { "$ref": "#/components/schemas/kubernetesName" } }, "required": [ "description", "name" ], "description": "Plan to assign to a node group" }, "kubernetesPlans": { "type": "array", "items": { "$ref": "#/components/schemas/kubernetesPlan" }, "description": "List of plans" }, "kubernetesNodeGroupPlan": { "type": "string", "description": "Node group plan" }, "kubernetesNodeGroupCloudNativePlan": { "type": "object", "properties": { "storage_size": { "$ref": "#/components/schemas/kubernetesStorageSize" }, "storage_tier": { "$ref": "#/components/schemas/kubernetesStorageTier" } }, "required": [ "storage_size" ], "description": "Node group cloud native plan properties" }, "kubernetesNodeGroupGPUPlan": { "type": "object", "properties": { "storage_size": { "$ref": "#/components/schemas/kubernetesStorageSize" }, "storage_tier": { "$ref": "#/components/schemas/kubernetesStorageTier" } }, "required": [ "storage_size" ], "description": "Node group GPU plan properties" }, "kubernetesNodeGroupCustomPlan": { "type": "object", "properties": { "memory": { "type": "integer", "maximum": 131072, "minimum": 1024, "format": "int32", "description": "The amount of memory in megabytes to assign to individual node group node when using custom plan" }, "cores": { "type": "integer", "maximum": 20, "minimum": 1, "format": "int32", "description": "The number of CPU cores dedicated to individual node group nodes when using custom plan" }, "storage_size": { "$ref": "#/components/schemas/kubernetesStorageSize" }, "storage_tier": { "$ref": "#/components/schemas/kubernetesStorageTier" } }, "required": [ "cores", "memory", "storage_size" ], "description": "Node group custom plan properties" }, "kubernetesStorageSize": { "type": "integer", "maximum": 1024, "minimum": 25, "format": "int32", "description": "The size of the storage device in gigabytes." }, "kubernetesStorageTier": { "type": "string", "enum": [ "maxiops", "hdd", "standard" ], "description": "The storage tier to use.", "default": "maxiops" }, "kubernetesStorageEncryption": { "type": "string", "enum": [ "data-at-rest", "none" ], "description": "The storage encryption strategy." }, "kubernetesDefaultStorageEncryption": { "allOf": [ { "$ref": "#/components/schemas/kubernetesStorageEncryption" }, { "description": "The default storage encryption strategy for all node groups." }, {} ] }, "kubernetesSshKey": { "type": "string", "pattern": "^ssh-[0-9A-Za-z]+ AAAA[0-9A-Za-z+/]+[=]{0,3}[ ]?([^@]+@[^@]+)?$", "description": "Public SSH key for accessing the nodes in a group" }, "kubernetesSshKeys": { "type": "array", "items": { "$ref": "#/components/schemas/kubernetesSshKey" }, "uniqueItems": true, "description": "List of public SSH keys" }, "kubernetesStorage": { "type": "string", "format": "uuid", "description": "Storage UUID to use as a template" }, "kubernetesTaint": { "type": "object", "properties": { "effect": { "$ref": "#/components/schemas/kubernetesEffect" }, "key": { "$ref": "#/components/schemas/kubernetesKey" }, "value": { "$ref": "#/components/schemas/kubernetesValue" } }, "required": [ "effect", "key", "value" ], "description": "Kubernetes taint to assign to nodes in a group" }, "kubernetesTaints": { "type": "array", "items": { "$ref": "#/components/schemas/kubernetesTaint" }, "description": "List of taints" }, "kubernetesUuid": { "type": "string", "format": "uuid", "description": "UUID" }, "kubernetesValue": { "type": "string", "maxLength": 255, "description": "Value of a key-value pair" }, "kubernetesZone": { "type": "string", "minLength": 1, "description": "UpCloud zone to provision the Kubernetes cluster in" }, "kubernetesClusterVersion": { "type": "string", "description": "Kubernetes version identifier", "default": "1.26" }, "kubernetesClusterUpgradeStrategy": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/kubernetesClusterUpgradeStrategyType" } }, "required": [ "type" ], "description": "upgrade strategy for node group upgrades" }, "kubernetesClusterUpgradeStrategyType": { "type": "string", "enum": [ "rolling-update", "manual" ], "description": "upgrade strategy type", "default": "manual" }, "kubernetesClusterPlan": { "type": "string", "enum": [ "development", "production-small", "dev-md", "prod-md", "prod-md-ha" ], "description": "Cluster plan", "default": "development" }, "kubernetesAntiAffinity": { "type": "boolean", "description": "Enable anti-affinity policies", "default": false }, "kubernetesPrivateNodeGroups": { "type": "boolean", "description": "Enable private node groups", "default": false }, "kubernetesNodeGroupDetails": { "allOf": [ { "$ref": "#/components/schemas/kubernetesNodeGroup" }, { "type": "object", "properties": { "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/kubernetesNode" }, "description": "List of node group nodes (experimental)" } }, "required": [ "nodes" ] } ], "properties": { "name": { "$ref": "#/components/schemas/kubernetesName" } }, "description": "Kubernetes cluster node" }, "kubernetesNode": { "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Node UUID" }, "name": { "$ref": "#/components/schemas/kubernetesName" }, "kubelet_version": { "$ref": "#/components/schemas/kubernetesClusterVersion" }, "state": { "$ref": "#/components/schemas/kubernetesNodeState" } }, "required": [ "uuid", "name", "state", "kubelet_version" ], "description": "Kubernetes cluster node" }, "kubernetesUtilityNetworkAccess": { "type": "boolean", "description": "Enable utility network access", "default": true }, "kubernetesNodeUpdates": { "properties": { "kubernetes_patches": { "type": "boolean", "description": "Include Kubernetes package patch updates (kubeadm, kubectl, kubelet)", "default": false }, "schedule_dow": { "type": "string", "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday", "daily" ], "description": "The day of the week on which updates will be performed" }, "schedule_time": { "type": "string", "description": "The time at which the updates will be applied in UTC (HH:MM).", "example": "06:00" } }, "required": [ "kubernetes_patches", "schedule_dow", "schedule_time" ], "description": "Enable periodic package updates on node" }, "kubernetesAuthenticationConfiguration": { "type": "array", "items": { "$ref": "#/components/schemas/kubernetesAuthenticationIssuerConfig" }, "description": "List of OIDC issuers and their claim validation rules." }, "kubernetesAuthenticationIssuerConfig": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/kubernetesName" }, "issuer_url": { "type": "string", "format": "uri", "example": "https://accounts.myoidcprovider.com" }, "discovery_url": { "type": "string", "format": "uri", "example": "https://accounts.myoidcprovider.com/.well-known/openid-configuration" }, "audiences": { "type": "array", "items": { "type": "string" }, "description": "Accepted audiences for tokens from this issuer. The first audience is used as the OIDC client id in generated kubeconfigs by default; the OIDC kubeconfig endpoint's `audience` query parameter can select a different one.\n", "example": [ "client-id-123" ] }, "audience_match_policy": { "type": "string", "enum": [ "MatchAny", "" ], "default": "" }, "certificate_authority": { "type": "string", "description": "Base64-encoded PEM certificate authority bundle." }, "claim_mappings": { "$ref": "#/components/schemas/kubernetesClaimMappings" }, "claim_validation_rules": { "type": "array", "items": { "$ref": "#/components/schemas/kubernetesClaimValidationRule" } }, "user_validation_rules": { "type": "array", "items": { "$ref": "#/components/schemas/kubernetesUserValidationRule" } } }, "required": [ "name", "issuer_url", "audiences" ] }, "kubernetesClaimMappings": { "type": "object", "properties": { "username": { "$ref": "#/components/schemas/kubernetesPrefixedClaimOrExpression" }, "groups": { "$ref": "#/components/schemas/kubernetesPrefixedClaimOrExpression" }, "uid": { "$ref": "#/components/schemas/kubernetesClaimOrExpression" }, "extra": { "type": "array", "items": { "$ref": "#/components/schemas/kubernetesExtraMapping" } } }, "description": "Rules for mapping token claims to Kubernetes user attributes." }, "kubernetesPrefixedClaimOrExpression": { "type": "object", "properties": { "claim": { "type": "string", "description": "JWT claim to use. Mutually exclusive with expression.", "example": "email" }, "prefix": { "type": "string", "description": "Prefix prepended to the claim's value. Must be set (may be empty) when claim is set. Mutually exclusive with expression.\n", "nullable": true, "example": "oidc:" }, "expression": { "type": "string", "description": "CEL expression producing the attribute value. Mutually exclusive with claim and prefix.", "example": "claims.email" } }, "description": "Maps a user attribute from either a JWT claim (optionally prefixed) or a CEL expression. Claim and expression are mutually exclusive.\n" }, "kubernetesClaimOrExpression": { "type": "object", "properties": { "claim": { "type": "string", "description": "JWT claim to use. Mutually exclusive with expression.", "example": "sub" }, "expression": { "type": "string", "description": "CEL expression producing the attribute value. Mutually exclusive with claim.", "example": "claims.sub" } }, "description": "Maps a user attribute from either a JWT claim or a CEL expression. Claim and expression are mutually exclusive.\n" }, "kubernetesClaimValidationRule": { "type": "object", "properties": { "claim": { "type": "string", "example": "hd" }, "required_value": { "type": "string", "example": "upcloud.com" }, "expression": { "type": "string", "example": "claims.hd == 'upcloud.com'" }, "message": { "type": "string", "example": "User must belong to the upcloud.com organization domain." } }, "description": "CEL expression used to validate a token claim." }, "kubernetesExtraMapping": { "type": "object", "properties": { "key": { "type": "string", "description": "Domain-prefixed, lowercase key for the extra attribute, e.g. example.org/foo.\n", "example": "example.org/foo" }, "value_expression": { "type": "string", "description": "CEL expression producing the extra attribute value (string or string array).", "example": "claims.some_claim" } }, "required": [ "key", "value_expression" ], "description": "Maps a token claim to an extra user attribute using a CEL expression." }, "kubernetesUserValidationRule": { "type": "object", "properties": { "expression": { "type": "string", "example": "!user.username.startsWith('system:')" }, "message": { "type": "string", "example": "Username must not start with the system: prefix." } }, "required": [ "expression" ], "description": "CEL expression applied to the final authenticated user." }, "currencyCode": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 code" }, "currencyCurrencies": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "currencies": { "type": "object", "properties": { "currency": { "type": "array", "items": { "type": "object", "properties": { "code": { "$ref": "#/components/schemas/currencyCode" }, "rate": { "type": "number", "examples": [ 0.01 ], "format": "double" }, "updated": { "type": "string", "examples": [ "2017-12-15T06:44:47Z" ], "format": "date-time" } }, "required": [ "code", "rate", "updated" ], "example": { "code": "USD", "rate": 0.01, "updated": "2017-12-15T06:44:47Z" } }, "additionalProperties": false, "description": "List of supported currency rate entries." } }, "required": [ "currency" ], "additionalProperties": false, "description": "Wrapped collection of currency rate entries.", "example": { "currency": [ { "code": "EUR", "rate": 0.00846077, "updated": "2017-12-14T10:00:00Z" }, { "code": "GBP", "rate": 0.00743236, "updated": "2017-12-14T10:00:00Z" } ] } } }, "required": [ "currencies" ], "additionalProperties": false, "description": "Response schema for listing supported currencies and exchange rates.", "example": { "currencies": { "currency": [ { "code": "EUR", "rate": 0.00846077, "updated": "2017-12-14T10:00:00Z" }, { "code": "GBP", "rate": 0.00743236, "updated": "2017-12-14T10:00:00Z" }, { "code": "SGD", "rate": 0.01347685, "updated": "2017-12-14T10:00:00Z" }, { "code": "USD", "rate": 0.01, "updated": "2017-12-15T06:44:47Z" } ] } } }, "currencyError": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "examples": [ "GENERAL_FAILURE" ] }, "error_message": { "type": "string", "examples": [ "Your request could not be fulfilled due to a technical issue." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "A general error response indicating that the request could not be fulfilled due to a technical issue." }, "devices": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": { "type": "object", "properties": { "gpu_plans": { "type": "object", "additionalProperties": { "type": "object", "properties": { "amount": { "type": "integer", "minimum": 0, "format": "int64", "example": 1 } }, "required": [ "amount" ], "example": { "amount": 1 } }, "description": "Available GPU plans in the zone.", "example": { "nvidia-a10": { "amount": 1 } } } }, "description": "Availability grouped by zone.", "example": { "gpu_plans": { "nvidia-a10": { "amount": 1 } } } }, "description": "Zone device availability", "example": { "fra1": { "gpu_plans": { "nvidia-a10": { "amount": 1 } } } } }, "deviceError": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "examples": [ "GENERAL_FAILURE" ] }, "error_message": { "type": "string", "examples": [ "Your request could not be fulfilled due to a technical issue." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "A general error response indicating that the request could not be fulfilled due to a technical issue." }, "events": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "events": { "type": "object", "examples": [ { "event": [ { "email": "user@example.com", "first_name": "John", "last_name": "Doe", "server": "00798b85-efdc-41ca-8021-f6ef457b8531", "time": "2024-02-23T12:34:56Z", "type": "server_start" } ] } ], "properties": { "event": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "server": { "$ref": "#/components/schemas/eventsUuid" }, "time": { "type": "string", "examples": [ "2024-02-23T12:34:56Z" ], "format": "date-time", "description": "Timestamp of when the event occurred" }, "type": { "$ref": "#/components/schemas/eventsEventType" } }, "required": [ "server", "time", "type" ] }, "description": "List of events associated with servers" } }, "required": [ "event" ] } }, "description": "Server event type" }, "eventsUuid": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "format": "uuid", "description": "Universally unique identifier", "example": "0414e0d7-4436-4037-9dd8-6eaf47dce599" }, "eventsEventType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "server_create", "server_error", "server_modify", "server_shutdown", "server_start", "server_start_init", "server_stop" ], "description": "Server event type" }, "eventsError": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "examples": [ "GENERAL_FAILURE" ] }, "error_message": { "type": "string", "examples": [ "Your request could not be fulfilled due to a technical issue." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "A general error response indicating that the request could not be fulfilled due to a technical issue." }, "ipAddress": { "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "type": "string", "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}$", "description": "IPv4 address" }, { "type": "string", "pattern": "^[a-fA-F0-9:]+$", "description": "IPv6 address" } ], "description": "IP address", "example": "10.0.0.20" }, "addIpAddressRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ip_address": { "type": "object", "properties": { "access": { "type": "string" }, "family": { "$ref": "#/components/schemas/ipAddressIpFamily" }, "floating": { "$ref": "#/components/schemas/ipAddressBooleanYesno" }, "mac": { "$ref": "#/components/schemas/ipAddressMacAddress" }, "prefix": { "type": "string" }, "release_policy": { "$ref": "#/components/schemas/ipAddressIpReleasePolicy" }, "server": { "$ref": "#/components/schemas/ipAddressUuid" }, "vlan_id": { "type": "string" }, "zone": { "$ref": "#/components/schemas/ipAddressZone" } }, "required": [ "access", "family" ] } }, "required": [ "ip_address" ], "description": "Schema for adding an IP address to a server" }, "bulkPatchIpAddressesRequestV1.3": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ip_addresses": { "type": "array", "items": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/ipAddress" }, "main_account_id": { "$ref": "#/components/schemas/ipAddressAccountId" }, "delegated_to_account_id": { "$ref": "#/components/schemas/ipAddressAccountId" }, "release_policy": { "$ref": "#/components/schemas/ipAddressIpReleasePolicy" } }, "required": [ "address", "main_account_id", "delegated_to_account_id", "release_policy" ], "additionalProperties": false } } }, "required": [ "ip_addresses" ], "additionalProperties": false, "description": "Request schema for bulk patching IP addresses" }, "modifyIpAddressRequestV1.0": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ip_address": { "type": "object", "properties": { "floating": { "$ref": "#/components/schemas/ipAddressBooleanYesno" }, "ptr_record": { "type": "string", "example": "host.example.com" }, "vlan_id": { "type": "string" } }, "required": [ "ptr_record" ], "example": { "ptr_record": "host.example.com" } } }, "required": [ "ip_address" ], "description": "Request schema for modifying an IP address", "example": { "ip_address": { "ptr_record": "host.example.com" } } }, "patchIpAddressRequestV1.3": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ip_address": { "type": "object", "properties": { "ptr_record": { "$ref": "#/components/schemas/ipAddressPtrRecord" }, "mac": { "$ref": "#/components/schemas/ipAddressMacAddress" }, "release_policy": { "$ref": "#/components/schemas/ipAddressIpReleasePolicy" } } } }, "required": [ "ip_address" ], "description": "Request schema for modifying an IP address" }, "ipAddressesResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ip_addresses": { "type": "object", "properties": { "ip_address": { "type": "array", "items": { "$ref": "#/components/schemas/ipAddressDetails" }, "description": "List of IP addresses" } }, "required": [ "ip_address" ], "example": { "ip_address": [ { "access": "public", "address": "203.0.113.10", "family": "IPv4", "ptr_record": "host.example.com" } ] } } }, "required": [ "ip_addresses" ], "additionalProperties": false, "description": "Request schema for IP address operations", "example": { "ip_addresses": { "ip_address": [ { "access": "public", "address": "203.0.113.10", "family": "IPv4", "ptr_record": "host.example.com" } ] } } }, "ipAddressDetails": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "access": { "$ref": "#/components/schemas/ipAddressNetworkType" }, "account_id": { "$ref": "#/components/schemas/ipAddressAccountId" }, "address": { "$ref": "#/components/schemas/ipAddress" }, "delegated_to_account_id": { "$ref": "#/components/schemas/ipAddressDelegatedToAccountId" }, "family": { "$ref": "#/components/schemas/ipAddressIpFamily" }, "floating": { "$ref": "#/components/schemas/ipAddressBooleanYesno" }, "mac": { "$ref": "#/components/schemas/ipAddressMacAddress" }, "part_of_plan": { "$ref": "#/components/schemas/ipAddressBooleanYesno" }, "ptr_record": { "type": "string" }, "release_policy": { "$ref": "#/components/schemas/ipAddressIpReleasePolicy" }, "server": { "$ref": "#/components/schemas/ipAddressUuid" }, "zone": { "$ref": "#/components/schemas/ipAddressZone" } }, "required": [ "access", "address" ], "additionalProperties": false, "description": "Details of an IP address" }, "ipAddressRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ip_addresses": { "type": "array", "items": { "$ref": "#/components/schemas/ipAddressDetails" }, "description": "List of IP addresses to operate on", "example": [ { "access": "public", "address": "203.0.113.10", "family": "IPv4", "ptr_record": "host.example.com" } ] } }, "required": [ "ip_addresses" ], "description": "Request schema for IP address operations", "example": { "ip_addresses": [ { "access": "public", "address": "203.0.113.10", "family": "IPv4", "ptr_record": "host.example.com" } ] } }, "ipAddressResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ip_address": { "$ref": "#/components/schemas/ipAddressDetails" } }, "required": [ "ip_address" ], "additionalProperties": false, "description": "Request schema for IP address operations" }, "ipAddressIpFamily": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "IPv4", "IPv6" ], "description": "IP address family", "example": "IPv4" }, "ipAddressBooleanYesno": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "yes", "no" ], "description": "Boolean value represented as yes/no", "example": "yes" }, "ipAddressMacAddress": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^([0-9A-Fa-f]{2}:){5}([0-9A-Fa-f]{2})$", "description": "MAC address", "example": "de:ff:ff:ff:cc:20" }, "ipAddressIpReleasePolicy": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "release", "keep" ], "description": "Action taken when the resource using the address is deleted: release deletes the address, while keep preserves it as a detached floating IP address", "example": "release" }, "ipAddressUuid": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "format": "uuid", "description": "Universally unique identifier", "example": "0414e0d7-4436-4037-9dd8-6eaf47dce599" }, "ipAddressZone": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "fi-hel1", "de-fra1", "us-nyc1" ], "maxLength": 15, "minLength": 2, "pattern": "^[a-z][a-z0-9-]{0,14}[a-z0-9]$", "description": "Zone identifier" }, "ipAddressAccountId": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "minimum": 1, "format": "int64", "description": "Unique numeric identifier of an account." }, "ipAddressPtrRecord": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string" }, "ipAddressNetworkType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "public", "utility", "private" ], "description": "Network access type", "example": "public" }, "ipAddressDelegatedToAccountId": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": [ "integer", "null" ], "format": "int64", "description": "Attached to a resource that is delegated to another account. Null means not delegated." }, "ipAddressError": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "examples": [ "GENERAL_FAILURE" ] }, "error_message": { "type": "string", "examples": [ "Your request could not be fulfilled due to a technical issue." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "A general error response indicating that the request could not be fulfilled due to a technical issue." }, "networkPeeringCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "configured_status": { "type": "string", "enum": [ "active", "disabled" ], "default": "active" }, "name": { "type": "string", "example": "Peering A->B" }, "network": { "type": "object", "properties": { "uuid": { "$ref": "#/components/schemas/networkPeeringUuid" } }, "required": [ "uuid" ], "description": "Describes the local side of the peering" }, "peer_network": { "type": "object", "properties": { "uuid": { "$ref": "#/components/schemas/networkPeeringUuid" } }, "required": [ "uuid" ], "description": "Describes the peer side of the peering" } }, "required": [ "name", "network", "peer_network" ], "additionalProperties": false, "description": "Describes the mutable properties when creating a network-peering between two networks", "example": { "configured_status": "active", "name": "Peering A->B", "network": { "uuid": "03126dc1-a69f-4bc2-8b24-e31c22d64712" }, "peer_network": { "uuid": "03585987-bf7d-4544-8e9b-5a1b4d74a333" } } }, "networkPeeringModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "configured_status": { "enum": [ "active", "disabled" ] }, "name": { "type": "string" } }, "additionalProperties": false, "description": "Describes the mutable properties when modifying a network-peering", "example": { "configured_status": "disabled", "name": "Peering A->B modified" } }, "networkPeerings": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "network_peerings": { "type": "object", "properties": { "network_peering": { "type": "array", "items": { "$ref": "#/components/schemas/networkPeering" } } }, "required": [ "network_peering" ], "additionalProperties": false, "example": { "network_peering": [ { "configured_status": "active", "name": "Peering A->B", "network": { "uuid": "03126dc1-a69f-4bc2-8b24-e31c22d64712" }, "peer_network": { "uuid": "03585987-bf7d-4544-8e9b-5a1b4d74a333" }, "state": "active", "uuid": "0f7984bc-5d72-4aaf-b587-90e6a8f32efc", "created_at": "2026-07-01T00:00:00Z" } ] } } }, "required": [ "network_peerings" ], "additionalProperties": false, "description": "Network peerings", "example": { "network_peerings": { "network_peering": [ { "configured_status": "active", "name": "Peering A->B", "network": { "uuid": "03126dc1-a69f-4bc2-8b24-e31c22d64712" }, "peer_network": { "uuid": "03585987-bf7d-4544-8e9b-5a1b4d74a333" }, "state": "active", "uuid": "0f7984bc-5d72-4aaf-b587-90e6a8f32efc", "created_at": "2026-07-01T00:00:00Z" } ] } } }, "networkPeering": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "configured_status": { "type": "string", "enum": [ "active", "disabled" ] }, "name": { "$ref": "#/components/schemas/networkPeeringName" }, "network": { "type": "object", "properties": { "ip_networks": { "type": "object", "properties": { "ip_network": { "type": "array", "items": { "properties": { "address": { "$ref": "#/components/schemas/networkPeeringIpCidr" }, "family": { "$ref": "#/components/schemas/networkPeeringIpFamily" } } } } } }, "uuid": { "$ref": "#/components/schemas/networkPeeringUuid" } }, "description": "Describes the local side of the peering" }, "peer_network": { "type": "object", "properties": { "ip_networks": { "type": "object", "properties": { "ip_network": { "type": "array", "items": { "properties": { "address": { "$ref": "#/components/schemas/networkPeeringIpCidr" }, "family": { "$ref": "#/components/schemas/networkPeeringIpFamily" } } } } }, "description": "note: only visible if both sides have a peering defined" }, "uuid": { "$ref": "#/components/schemas/networkPeeringUuid" } }, "description": "Describes the peer side of the peering" }, "state": { "$ref": "#/components/schemas/networkPeeringState" }, "uuid": { "$ref": "#/components/schemas/networkPeeringUuid" }, "created_at": { "oneOf": [ { "$ref": "#/components/schemas/networkPeeringRfc3339Datetime" }, { "type": "null" } ], "description": "When the network peering was created" }, "updated_at": { "oneOf": [ { "$ref": "#/components/schemas/networkPeeringRfc3339Datetime" }, { "type": "null" } ], "description": "When the network peering was last updated. Null until the first modification." } }, "description": "Network peering object describes a peering relationship between two networks", "example": { "configured_status": "active", "name": "Peering A->B", "network": { "ip_networks": { "ip_network": [ { "address": "192.168.0.0/24", "family": "IPv4" }, { "address": "fc02:c4f3::/64", "family": "IPv6" } ] }, "uuid": "03126dc1-a69f-4bc2-8b24-e31c22d64712" }, "peer_network": { "ip_networks": { "ip_network": [ { "address": "192.168.99.0/24", "family": "IPv4" }, { "address": "fc02:c4f3:99::/64", "family": "IPv6" } ] }, "uuid": "03585987-bf7d-4544-8e9b-5a1b4d74a333" }, "state": "active", "uuid": "0f7984bc-5d72-4aaf-b587-90e6a8f32efc", "created_at": "2026-07-01T00:00:00Z" } }, "networkPeeringName": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "maxLength": 255, "minLength": 1, "description": "Name of a network peering relationship." }, "networkPeeringState": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "active", "pending-peer", "provisioning", "conflict-subnet", "missing-local-router", "missing-peer-router", "deleted-peer-network", "disabled", "peer-disabled", "error" ], "description": "Current lifecycle state of a network peering." }, "networkPeeringUuid": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "format": "uuid", "description": "Universally unique identifier", "example": "0414e0d7-4436-4037-9dd8-6eaf47dce599" }, "networkPeeringIpCidr": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "format": "cidr", "description": "IP CIDR" }, "networkPeeringIpFamily": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "IPv4", "IPv6" ], "description": "IP address family", "example": "IPv4" }, "networkPeeringRfc3339Datetime": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "2026-07-01T00:00:00Z", "2026-07-31T23:59:59Z" ], "format": "date-time", "description": "Datetime in RFC 3339 format" }, "networkPeeringError": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "examples": [ "GENERAL_FAILURE" ] }, "error_message": { "type": "string", "examples": [ "Your request could not be fulfilled due to a technical issue." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "A general error response indicating that the request could not be fulfilled due to a technical issue." }, "createNetworkRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "network": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/networkType" }, "name": { "type": "string", "example": "backend-net" }, "zone": { "$ref": "#/components/schemas/networkZone" }, "router": { "$ref": "#/components/schemas/networkUuid" }, "ip_networks": { "type": "object", "properties": { "ip_network": { "type": "array", "items": { "type": "object", "properties": { "family": { "$ref": "#/components/schemas/networkIpFamily" }, "address": { "$ref": "#/components/schemas/networkIpCidr" }, "gateway": { "$ref": "#/components/schemas/networkIpAddress" }, "dhcp": { "$ref": "#/components/schemas/networkBooleanYesno" }, "dhcp_default_route": { "$ref": "#/components/schemas/networkBooleanYesno" }, "dhcp_dns": { "type": "array", "items": { "$ref": "#/components/schemas/networkIpAddress" } }, "dhcp_routes": { "type": "array", "items": { "type": "string" } }, "dhcp_bootfile_url": { "$ref": "#/components/schemas/networkBootfileUrl" }, "dhcp_routes_configuration": { "type": "object", "properties": { "effective_routes_auto_population": { "type": "object", "properties": { "enabled": { "$ref": "#/components/schemas/networkBooleanYesno" }, "exclude_by_source": { "type": "array", "items": { "type": "string" } }, "filter_by_destination": { "type": "array", "items": { "$ref": "#/components/schemas/networkIpCidr" } }, "filter_by_route_type": { "type": "array", "items": { "type": "string" } } } } } } }, "required": [ "family", "address", "dhcp" ] } } }, "required": [ "ip_network" ] }, "labels": { "$ref": "#/components/schemas/networkLabels" } }, "required": [ "type", "name", "zone", "ip_networks" ], "example": { "type": "private", "name": "backend-net", "zone": "fi-hel2", "ip_networks": { "ip_network": [ { "family": "IPv4", "address": "10.0.0.0/24", "dhcp": "yes" } ] } } } }, "required": [ "network" ], "description": "Request schema for creating a network", "example": { "network": { "type": "private", "name": "backend-net", "zone": "fi-hel2", "ip_networks": { "ip_network": [ { "family": "IPv4", "address": "10.0.0.0/24", "dhcp": "yes" } ] } } } }, "networkType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "public", "utility", "private" ], "description": "Network access type", "example": "public" }, "modifyNetworkRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "network": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/networkType" }, "name": { "type": "string" }, "zone": { "$ref": "#/components/schemas/networkZone" }, "tags": { "$ref": "#/components/schemas/networkTags" }, "labels": { "$ref": "#/components/schemas/networkLabels" }, "router": { "$ref": "#/components/schemas/networkUuid" }, "grt_export": { "$ref": "#/components/schemas/networkBoolean01" }, "parent_network": { "type": "string" }, "ip_networks": { "type": "object", "properties": { "ip_network": { "type": "array", "items": { "type": "object", "properties": { "family": { "$ref": "#/components/schemas/networkIpFamily" }, "address": { "$ref": "#/components/schemas/networkIpCidr" }, "gateway": { "$ref": "#/components/schemas/networkIpAddress" }, "dhcp": { "type": "string" }, "dhcp_default_route": { "type": "string" }, "dhcp_dns": { "type": "array", "items": { "$ref": "#/components/schemas/networkIpAddress" } }, "dhcp_routes": { "type": "array", "items": { "$ref": "#/components/schemas/networkIpCidr" } }, "dhcp_bootfile_url": { "type": "string" } }, "required": [ "family", "address" ] } } }, "required": [ "ip_network" ] }, "network_features": { "$ref": "#/components/schemas/networkFeatures" }, "main_account_id": { "$ref": "#/components/schemas/networkAccountId" } }, "required": [ "type", "name", "zone", "tags", "labels", "router", "grt_export", "parent_network", "ip_networks", "network_features", "main_account_id" ] } }, "required": [ "network" ], "description": "Request schema for modifying a network" }, "networkFeatures": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "allow-linklocal-address", "allow-overlapping-ip-network", "managed-by-service", "allow-cgnat-address" ], "description": "Features available for a network" }, "networks": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "networks": { "type": "object", "properties": { "network": { "type": "array", "items": { "$ref": "#/components/schemas/networkDetails" } } }, "required": [ "network" ], "additionalProperties": false, "description": "Container object for network items.", "example": { "network": [ { "uuid": "8f6d1ec2-8f5e-4b67-8fcb-6fa9c1a8a001", "name": "backend-net", "type": "private", "zone": "fi-hel2" } ] } } }, "required": [ "networks" ], "additionalProperties": false, "description": "Response schema containing a list of networks.", "example": { "networks": { "network": [ { "uuid": "8f6d1ec2-8f5e-4b67-8fcb-6fa9c1a8a001", "name": "backend-net", "type": "private", "zone": "fi-hel2" } ] } } }, "networkDetails": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "grt_export": { "$ref": "#/components/schemas/networkBooleanYesno" }, "ip_networks": { "type": "object", "properties": { "ip_network": { "type": "array", "items": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/networkIpCidr" }, "dhcp": { "$ref": "#/components/schemas/networkBooleanYesno" }, "dhcp_bootfile_url": { "$ref": "#/components/schemas/networkBootfileUrl" }, "dhcp_default_route": { "$ref": "#/components/schemas/networkBooleanYesno" }, "dhcp_dns": { "type": "array", "items": { "$ref": "#/components/schemas/networkIpAddress" } }, "dhcp_routes": { "type": "array", "items": { "$ref": "#/components/schemas/networkIpCidr" } }, "family": { "$ref": "#/components/schemas/networkIpFamily" }, "gateway": { "$ref": "#/components/schemas/networkIpAddress" } }, "required": [ "family", "address" ] } } }, "required": [ "ip_network" ] }, "name": { "type": "string" }, "network_features": { "type": "array", "items": { "type": "string" } }, "parent_network": { "$ref": "#/components/schemas/networkUuid" }, "peerings": { "type": "object", "properties": { "peering": { "type": "array", "items": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/networkPeeringName" }, "state": { "$ref": "#/components/schemas/networkPeeringState" }, "uuid": { "$ref": "#/components/schemas/networkUuid" } } } } }, "description": "List of network peerings the network is part of" }, "router": { "$ref": "#/components/schemas/networkUuid" }, "servers": { "type": "object", "properties": { "server": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "uuid": { "$ref": "#/components/schemas/networkUuid" } }, "required": [ "uuid", "title" ] } } }, "required": [ "server" ] }, "services": { "type": "object", "properties": { "service": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "service_routes": { "type": "array", "items": { "$ref": "#/components/schemas/networkIpCidr" } } }, "required": [ "name", "service_routes" ] } } }, "required": [ "service" ], "description": "List of services this network is joined to" }, "tags": { "type": "array", "items": { "type": "string" } }, "type": { "$ref": "#/components/schemas/networkType" }, "uuid": { "type": "string", "format": "uuid" }, "zone": { "$ref": "#/components/schemas/networkZone" } }, "required": [ "name", "zone" ], "description": "Detailed network resource attributes.", "example": { "evi": 1234, "grt_export": "no", "ip_networks": { "ip_network": [ { "family": "IPv4", "address": "192.168.150.0/24", "dhcp": "yes", "dhcp_dns": [ "192.168.150.1", "192.168.150.254" ], "gateway": "192.168.150.1" } ] }, "name": "Example network", "network_features": [ "allow-linklocal-address", "allow-overlapping-ip-network", "managed-by-service" ], "parent_network": "037b0e4b-2734-4d5d-89ba-1737fc4593bf", "peerings": { "peering": [ { "name": "Peering A->B", "state": "pending-peer", "uuid": "0fc82c18-1e5e-4076-afcd-3b85869800e7" } ] }, "router": "0414e0d7-4436-4037-9dd8-6eaf47dce599", "services": { "service": [ { "name": "OBJECT-STORAGE", "service_routes": [ "10.10.10.0/24" ] } ] }, "type": "private", "uuid": "039a8811-e279-46c2-8e45-1962767f5a4c", "zone": "fi-hel1" } }, "network": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "network": { "$ref": "#/components/schemas/networkDetails" } }, "required": [ "network" ], "additionalProperties": false, "description": "Response schema containing a single network." }, "networkLabel": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "key": { "type": "string", "description": "Label key used to classify the resource" }, "value": { "type": "string", "description": "Value associated with the label key" } }, "required": [ "key", "value" ], "additionalProperties": false, "description": "A key/value pair to label and categorize resources", "example": { "key": "env", "value": "production" } }, "networkAccountId": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "minimum": 1, "format": "int64", "description": "Unique numeric identifier of an account." }, "networkUuid": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "format": "uuid", "description": "Universally unique identifier", "example": "0414e0d7-4436-4037-9dd8-6eaf47dce599" }, "networkZone": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "fi-hel1", "de-fra1", "us-nyc1" ], "maxLength": 15, "minLength": 2, "pattern": "^[a-z][a-z0-9-]{0,14}[a-z0-9]$", "description": "Zone identifier" }, "networkIpFamily": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "IPv4", "IPv6" ], "description": "IP address family", "example": "IPv4" }, "networkIpCidr": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "format": "cidr", "description": "IP CIDR" }, "networkIpAddress": { "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "type": "string", "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}$", "description": "IPv4 address" }, { "type": "string", "pattern": "^[a-fA-F0-9:]+$", "description": "IPv6 address" } ], "description": "IP address", "example": "10.0.0.20" }, "networkBooleanYesno": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "yes", "no" ], "description": "Boolean value represented as yes/no", "example": "yes" }, "networkBootfileUrl": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "format": "url", "description": "HTTP or HTTPS URL for DHCP bootfile delivery." }, "networkLabels": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "label": { "type": "array", "items": { "$ref": "#/components/schemas/networkLabel" } } }, "description": "Collection of key/value labels for a resource.", "example": { "label": [ { "key": "env", "value": "prod" }, { "key": "team", "value": "network" } ] } }, "networkCreateInterfaceRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "main_account_id": { "$ref": "#/components/schemas/networkAccountId" }, "interface": { "type": "object", "properties": { "bootable": { "$ref": "#/components/schemas/networkBooleanYesno" }, "network": { "type": "string" }, "source_ip_filtering": { "$ref": "#/components/schemas/networkBooleanYesno" }, "type": { "$ref": "#/components/schemas/networkType" }, "labels": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" }, "visible": { "$ref": "#/components/schemas/networkBooleanYesno" } }, "required": [ "key", "value", "visible" ] } } }, "required": [ "type", "network", "source_ip_filtering", "bootable" ] } }, "description": "Request schema for creating a network interface", "example": { "main_account_id": 123456, "interface": { "type": "private", "network": "8f6d1ec2-8f5e-4b67-8fcb-6fa9c1a8a001", "source_ip_filtering": "yes", "bootable": "no" } } }, "networkTags": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "tags": { "type": "object", "properties": { "tag": { "type": "array", "items": { "type": "object", "properties": { "description": { "$ref": "#/components/schemas/networkDescription" }, "name": { "$ref": "#/components/schemas/networkName" }, "servers": { "$ref": "#/components/schemas/networkServers" } }, "required": [ "name", "servers" ] } } }, "required": [ "tag" ], "example": { "tag": [ { "name": "PROD", "description": "Production servers", "servers": { "server": [ "0077fa3d-32db-4b09-9f5f-30d9e9afb565" ] } } ] } } }, "required": [ "tags" ], "description": "Container object for resource tags.", "example": { "tags": { "tag": [ { "name": "PROD", "description": "Production servers", "servers": { "server": [ "0077fa3d-32db-4b09-9f5f-30d9e9afb565" ] } } ] } } }, "networkDescription": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "Development servers", "Production servers", "Private environment", "Quality Assurance environment", "Web servers", "Database servers" ], "description": "Human-readable description for a tag." }, "networkName": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "DEV", "PROD", "private", "QA", "webserver", "database" ], "maxLength": 32, "minLength": 1, "pattern": "^[A-Za-z0-9_]{1,32}$", "description": "Short name used to identify a tag." }, "networkServers": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "server": { "type": "array", "items": { "type": "string", "examples": [ "0077fa3d-32db-4b09-9f5f-30d9e9afb565", "00c78863-db86-44ea-af70-d6edc4d162bf" ], "format": "uuid", "description": "Unique identifier of the server." } } }, "description": "List of servers associated with the tag.", "example": { "server": [ "0077fa3d-32db-4b09-9f5f-30d9e9afb565", "00c78863-db86-44ea-af70-d6edc4d162bf" ] } }, "networkBoolean01": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "format": "int64", "enum": [ 0, 1 ], "description": "Schema for boolean-like values encoded as 0 or 1." }, "networkError": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "examples": [ "GENERAL_FAILURE" ] }, "error_message": { "type": "string", "examples": [ "Your request could not be fulfilled due to a technical issue." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "A general error response indicating that the request could not be fulfilled due to a technical issue." }, "networkInterfaces": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "interfaces": { "type": "object", "properties": { "interface": { "$ref": "#/components/schemas/networkInterface" } }, "required": [ "interface" ], "example": { "interface": { "uuid": "8f6d1ec2-8f5e-4b67-8fcb-6fa9c1a8a003", "type": "private", "network": "8f6d1ec2-8f5e-4b67-8fcb-6fa9c1a8a001", "mac": "00:16:3e:12:34:56", "source_ip_filtering": "yes", "bootable": "no", "ip_addresses": [ { "ip_address": { "address": "10.0.0.10", "family": "IPv4", "floating": "no", "release_policy": "keep", "dhcp_provided": "yes" } } ] } } } }, "required": [ "interfaces" ], "description": "Response schema for listing network interfaces", "example": { "interfaces": { "interface": { "uuid": "8f6d1ec2-8f5e-4b67-8fcb-6fa9c1a8a003", "type": "private", "network": "8f6d1ec2-8f5e-4b67-8fcb-6fa9c1a8a001", "mac": "00:16:3e:12:34:56", "source_ip_filtering": "yes", "bootable": "no", "ip_addresses": [ { "ip_address": { "address": "10.0.0.10", "family": "IPv4", "floating": "no", "release_policy": "keep", "dhcp_provided": "yes" } } ] } } } }, "networkInterface": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "bootable": { "$ref": "#/components/schemas/networkBooleanYesno" }, "ip_addresses": { "type": "array", "items": { "type": "object" }, "example": [ { "ip_address": { "address": "10.0.0.10", "family": "IPv4", "floating": "no", "release_policy": "keep", "dhcp_provided": "yes" } } ] }, "mac": { "type": "string" }, "network": { "type": "string" }, "source_ip_filtering": { "$ref": "#/components/schemas/networkBooleanYesno" }, "server": { "$ref": "#/components/schemas/networkUuid" }, "type": { "$ref": "#/components/schemas/networkType" }, "uuid": { "$ref": "#/components/schemas/networkUuid" } }, "required": [ "uuid", "type", "network", "mac", "source_ip_filtering", "bootable", "ip_addresses" ], "description": "Response schema for listing network interfaces", "example": { "uuid": "8f6d1ec2-8f5e-4b67-8fcb-6fa9c1a8a003", "type": "private", "network": "8f6d1ec2-8f5e-4b67-8fcb-6fa9c1a8a001", "mac": "00:16:3e:12:34:56", "source_ip_filtering": "yes", "bootable": "no", "ip_addresses": [ { "ip_address": { "address": "10.0.0.10", "family": "IPv4", "floating": "no", "release_policy": "keep", "dhcp_provided": "yes" } } ] } }, "auditLogsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "audit_logs": [] } ], "properties": { "audit_logs": { "type": "array", "items": { "$ref": "#/components/schemas/auditLogsAuditLog" }, "description": "List of audit log events" } }, "title": "Audit Logs Response", "required": [ "audit_logs" ], "description": "Response schema for a list of audit logs" }, "auditLogsQueryParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "my_account", "192.168.1.1", "00798b85-efdc-41ca-8021-f6ef457b8531" ], "title": "QueryParameter", "description": "Search string" }, "auditLogsLimitParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "examples": [ 50, 100 ], "title": "LimitParameter", "maximum": 200, "minimum": 1, "format": "int32", "description": "Number of results to return", "default": 50 }, "auditLogsOffsetParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "examples": [ 0, 50, 100 ], "title": "OffsetParameter", "minimum": 0, "format": "int32", "description": "Page for retrieved results. Note: 0 and 1 retrieve the same first page results. (default 0)", "default": 0 }, "auditLogsActionsParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ "create", "update", "delete" ] ], "items": { "type": "string", "enum": [ "create", "read", "update", "delete", "access-granted", "access-granted-kubeconfig", "access-modified", "access-update", "maintenance-start", "writes-enable", "attach", "clone", "detach", "login", "logout", "start", "stop", "owner-change" ] }, "title": "ActionsParameter", "description": "List of actions to filter by" }, "auditLogsOriginsParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ "api", "gui" ] ], "items": { "type": "string", "enum": [ "api", "gui", "upcloud_internal" ] }, "title": "OriginsParameter", "description": "List of origins to filter by" }, "auditLogsResourceTypesParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ "server", "storage", "network" ] ], "items": { "type": "string", "enum": [ "account", "auth", "init-script", "managed-database", "managed-loadbalancer", "managed-loadbalancer-certificate-bundle", "managed-object-storage", "network-gateway", "server", "storage", "uks", "ssh-key" ] }, "title": "ResourceTypesParameter", "description": "List of resource types to filter by" }, "auditLogsCreatedAfterParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "2024-01-01T00:00:00Z" ], "title": "CreatedAfterParameter", "format": "date-time", "description": "List audit logs created after the given timestamp (including the time of timestamp). Format: ISO timestamp eg. 2024-01-01T23:45:56Z" }, "auditLogsCreatedBeforeParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "2024-12-31T23:59:59Z" ], "title": "CreatedBeforeParameter", "format": "date-time", "description": "List audit logs created before the given timestamp (including the time of timestamp). Format: ISO timestamp eg. 2024-01-01T23:45:56Z" }, "auditLogsFormatParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "csv", "json" ], "title": "FormatParameter", "enum": [ "csv", "json" ], "description": "Export format", "default": "csv" }, "auditLogsCloudEventIDParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "01HQXYZ123456789ABCDEFGHJK" ], "title": "CloudEventIDParameter", "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "description": "Cloud event ID (ULID format)" }, "auditLogsAuditLog": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "time": "2024-03-05T14:30:00Z", "auth_type": "api", "cloud_event_id": "01HQXYZ123456789ABCDEFGHJK", "upcloud_correlation_id": "550e8400-e29b-41d4-a716-446655440000", "resource_type": "server", "action": "start", "origin": "api", "account_username": "john.doe", "ip_address": "192.168.1.100", "resource_id": "00798b85-efdc-41ca-8021-f6ef457b8531" } ], "properties": { "time": { "type": "string", "examples": [ "2024-03-05T14:30:00Z" ], "format": "date-time", "description": "Timestamp of the event" }, "auth_type": { "type": "string", "examples": [ "api", "gui", "basic_auth" ], "description": "Authentication type used (e.g., 'gui', 'api', 'basic_auth')" }, "cloud_event_id": { "type": "string", "examples": [ "01HQXYZ123456789ABCDEFGHJK" ], "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$", "description": "Cloud event ID in ULID format" }, "upcloud_correlation_id": { "type": "string", "examples": [ "550e8400-e29b-41d4-a716-446655440000" ], "description": "UpCloud correlation ID for request tracing" }, "resource_type": { "type": "string", "examples": [ "server", "storage", "network-gateway" ], "enum": [ "account", "auth", "init-script", "managed-database", "managed-loadbalancer", "managed-loadbalancer-certificate-bundle", "managed-object-storage", "network-gateway", "server", "storage", "uks", "ssh-key" ], "description": "Type of resource affected" }, "resource_sub_type": { "type": "string", "examples": [ "session-api-token", "subaccount-api-token" ], "description": "Subtype of resource affected (e.g., 'session-api-token')" }, "action": { "type": "string", "examples": [ "create", "update", "delete" ], "enum": [ "create", "read", "update", "delete", "access-granted", "access-granted-kubeconfig", "access-modified", "access-update", "maintenance-start", "writes-enable", "attach", "clone", "detach", "login", "logout", "start", "stop", "owner-change" ], "description": "Action performed" }, "origin": { "type": "string", "examples": [ "api", "gui" ], "enum": [ "api", "gui", "upcloud_internal" ], "description": "Origin of the request" }, "account_username": { "type": "string", "examples": [ "john.doe" ], "description": "Username that performed the action" }, "ip_address": { "type": "string", "examples": [ "192.168.1.100", "2001:0db8:85a3:0000:0000:8a2e:0370:7334" ], "description": "IP address of the request origin (IPv4 or IPv6). May be masked for internal UpCloud services." }, "resource_id": { "type": "string", "examples": [ "00000000-0000-4000-8000-000000000000", "12345" ], "description": "ID of the affected resource. May be hidden for sensitive resources like auth and account." }, "current_state": { "type": "object", "additionalProperties": true, "description": "Current state of the resource after the action (only present for create/update actions). Structure varies by resource_type." }, "previous_state": { "type": "object", "additionalProperties": true, "description": "Previous state of the resource before the action (only present for update/delete actions). Structure varies by resource_type." } }, "title": "Audit Log", "required": [ "time", "auth_type", "cloud_event_id", "upcloud_correlation_id", "resource_type", "action", "origin", "account_username" ], "description": "A single audit log event" }, "auditLogsErrorResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "type": "https://developers.upcloud.com/1.3/errors#ERROR_INVALID_CREDENTIALS", "title": "Invalid user type.", "correlation_id": "01KV86B1B4ETX8WJD05P4HF412", "status": 401 } ], "properties": { "type": { "type": "string", "examples": [ "https://developers.upcloud.com/1.3/errors#INTERNAL_SERVER_ERROR" ], "format": "uri", "description": "A URI reference that uniquely identifies the problem type only in the context of the provided API. It is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type." }, "title": { "type": "string", "examples": [ "Internal server error." ], "description": "A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized." }, "detail": { "type": "string", "examples": [ "Invalid parameters." ], "description": "A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized." }, "status": { "type": "integer", "maximum": 599, "minimum": 200, "format": "int32", "description": "The HTTP status code generated by the origin server for this occurrence of the problem." }, "invalid_params": { "type": "array", "examples": [ [ { "name": "expires_at", "reason": "Token expiration time must be in the future." } ] ], "items": { "type": "object", "properties": { "name": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "name", "reason" ] } }, "correlation_id": { "type": "string", "examples": [ "01JQV2ETY2K6HHE1KZFY9E1CYC" ], "description": "A unique identifier for the request. This identifier is generated by the server and can be used to track the request in the server logs. It is useful for debugging and support purposes." } }, "required": [ "type", "title", "status" ], "additionalProperties": false, "description": "JSON Problem Details for HTTP APIs" }, "auditLogsFilterOptionsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "resource_types": [ "server", "storage", "network", "auth" ], "actions": [ "create", "read", "update", "delete" ], "origins": [ "api", "gui", "upcloud_internal" ] } ], "properties": { "resource_types": { "type": "array", "examples": [ [ "server", "storage", "network-gateway" ] ], "items": { "type": "string", "enum": [ "account", "auth", "init-script", "managed-database", "managed-loadbalancer", "managed-loadbalancer-certificate-bundle", "managed-object-storage", "network-gateway", "server", "storage", "uks", "ssh-key" ] }, "description": "List of available resource types" }, "actions": { "type": "array", "examples": [ [ "create", "update", "delete" ] ], "items": { "type": "string", "enum": [ "create", "read", "update", "delete", "access-granted", "access-granted-kubeconfig", "access-modified", "access-update", "maintenance-start", "writes-enable", "attach", "clone", "detach", "login", "logout", "start", "stop", "owner-change" ] }, "description": "List of available actions" }, "origins": { "type": "array", "examples": [ [ "api", "gui", "upcloud_internal" ] ], "items": { "type": "string", "enum": [ "api", "gui", "upcloud_internal" ] }, "description": "List of available origins" } }, "title": "Filter Options Response", "required": [ "resource_types", "actions", "origins" ], "description": "Available filter options for audit logs" }, "partnerCreateAccount": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "username": { "type": "string", "examples": [ "newuser" ] }, "password": { "type": "string", "examples": [ "superSecret123" ] }, "contact_details": { "type": "object", "properties": { "address": { "type": "string", "examples": [ "Some street" ] }, "city": { "type": "string", "examples": [ "Some city" ] }, "company": { "type": "string", "examples": [ "Some company" ] }, "country": { "type": "string", "examples": [ "FIN" ], "format": "iso-3166-1-alpha-3" }, "email": { "type": "string", "examples": [ "some.user@example.com" ], "format": "email" }, "first_name": { "type": "string", "examples": [ "Some" ] }, "last_name": { "type": "string", "examples": [ "User" ] }, "phone": { "type": "string", "examples": [ "+358.91234567" ] }, "postal_code": { "type": "string", "examples": [ "00100" ] }, "state": { "type": "string", "examples": [ "" ], "description": "State or province, if applicable. Required for some countries." }, "vat_number": { "type": "string", "examples": [ "FI24315605" ] } }, "required": [ "country", "email", "first_name", "last_name", "phone" ] } }, "required": [ "username", "password" ], "description": "Request payload for creating a partner-managed account." }, "partnerAccounts": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/partnerAccount" }, "description": "Collection of partner-managed accounts." }, "partnerAccount": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "address": { "type": "string", "examples": [ "Some street" ] }, "city": { "type": "string", "examples": [ "Some city" ] }, "company": { "type": "string", "examples": [ "Some company" ] }, "country": { "type": "string", "examples": [ "FIN" ], "format": "iso-3166-1-alpha-3" }, "email": { "type": "string", "examples": [ "some.user@example.com" ], "format": "email" }, "first_name": { "type": "string", "examples": [ "Some" ] }, "last_name": { "type": "string", "examples": [ "User" ] }, "phone": { "type": "string", "examples": [ "+358.91234567" ] }, "postal_code": { "type": "string", "examples": [ "00100" ] }, "state": { "type": "string", "examples": [ "" ] }, "username": { "type": "string", "examples": [ "somename" ] }, "vat_number": { "type": "string", "examples": [ "FI24315605" ] } }, "required": [ "username" ], "description": "Partner-managed account details." }, "partnerError": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "examples": [ "GENERAL_FAILURE" ] }, "error_message": { "type": "string", "examples": [ "Your request could not be fulfilled due to a technical issue." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "A general error response indicating that the request could not be fulfilled due to a technical issue." }, "partnerError400": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "oneOf": [ { "$ref": "#/components/schemas/partnerError400AddressInvalid" }, { "$ref": "#/components/schemas/partnerError400CityInvalid" }, { "$ref": "#/components/schemas/partnerError400CompanyInvalid" }, { "$ref": "#/components/schemas/partnerError400CountryInvalid" }, { "$ref": "#/components/schemas/partnerError400CountryMissing" }, { "$ref": "#/components/schemas/partnerError400EmailInvalid" }, { "$ref": "#/components/schemas/partnerError400EmailMissing" }, { "$ref": "#/components/schemas/partnerError400FirstNameInvalid" }, { "$ref": "#/components/schemas/partnerError400FirstNameMissing" }, { "$ref": "#/components/schemas/partnerError400LastNameInvalid" }, { "$ref": "#/components/schemas/partnerError400LastNameMissing" }, { "$ref": "#/components/schemas/partnerError400PasswordInvalid" }, { "$ref": "#/components/schemas/partnerError400PasswordMissing" }, { "$ref": "#/components/schemas/partnerError400PhoneInvalid" }, { "$ref": "#/components/schemas/partnerError400PhoneMissing" }, { "$ref": "#/components/schemas/partnerError400PostalCodeInvalid" }, { "$ref": "#/components/schemas/partnerError400PostalCodeMissing" } ], "discriminator": { "propertyName": "error_code", "mapping": { "ADDRESS_INVALID": "#/components/schemas/partnerError400AddressInvalid", "CITY_INVALID": "#/components/schemas/partnerError400CityInvalid", "COMPANY_INVALID": "#/components/schemas/partnerError400CompanyInvalid", "COUNTRY_INVALID": "#/components/schemas/partnerError400CountryInvalid", "COUNTRY_MISSING": "#/components/schemas/partnerError400CountryMissing", "EMAIL_INVALID": "#/components/schemas/partnerError400EmailInvalid", "EMAIL_MISSING": "#/components/schemas/partnerError400EmailMissing", "FIRST_NAME_INVALID": "#/components/schemas/partnerError400FirstNameInvalid", "FIRST_NAME_MISSING": "#/components/schemas/partnerError400FirstNameMissing", "LAST_NAME_INVALID": "#/components/schemas/partnerError400LastNameInvalid", "LAST_NAME_MISSING": "#/components/schemas/partnerError400LastNameMissing", "PASSWORD_INVALID": "#/components/schemas/partnerError400PasswordInvalid", "PASSWORD_MISSING": "#/components/schemas/partnerError400PasswordMissing", "PHONE_INVALID": "#/components/schemas/partnerError400PhoneInvalid", "PHONE_MISSING": "#/components/schemas/partnerError400PhoneMissing", "POSTAL_CODE_INVALID": "#/components/schemas/partnerError400PostalCodeInvalid", "POSTAL_CODE_MISSING": "#/components/schemas/partnerError400PostalCodeMissing" } }, "example": { "error_code": "EMAIL_INVALID", "error_message": "The attribute email has an invalid value." } } }, "required": [ "error" ], "additionalProperties": false, "description": "400 Bad Request errors for partner account creation.", "example": { "error": { "error_code": "EMAIL_INVALID", "error_message": "The attribute email has an invalid value." } } }, "partnerError400AddressInvalid": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error_code": { "type": "string", "const": "ADDRESS_INVALID" }, "error_message": { "type": "string", "examples": [ "The attribute address has an invalid value." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false, "description": "The attribute address has an invalid value." }, "partnerError400CityInvalid": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error_code": { "type": "string", "const": "CITY_INVALID" }, "error_message": { "type": "string", "examples": [ "The attribute city has an invalid value." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false, "description": "The attribute city has an invalid value." }, "partnerError400CompanyInvalid": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error_code": { "type": "string", "const": "COMPANY_INVALID" }, "error_message": { "type": "string", "examples": [ "The attribute company has an invalid value." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false, "description": "The attribute company has an invalid value." }, "partnerError400CountryInvalid": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error_code": { "type": "string", "const": "COUNTRY_INVALID" }, "error_message": { "type": "string", "examples": [ "The attribute country has an invalid value." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false, "description": "The attribute country has an invalid value." }, "partnerError400CountryMissing": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error_code": { "type": "string", "const": "COUNTRY_MISSING" }, "error_message": { "type": "string", "examples": [ "The attribute country is missing." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false, "description": "The attribute country is missing from the request." }, "partnerError400EmailInvalid": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error_code": { "type": "string", "const": "EMAIL_INVALID" }, "error_message": { "type": "string", "examples": [ "The attribute email has an invalid value." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false, "description": "The attribute email has an invalid value." }, "partnerError400EmailMissing": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error_code": { "type": "string", "const": "EMAIL_MISSING" }, "error_message": { "type": "string", "examples": [ "The attribute email is missing." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false, "description": "The attribute email is missing from the request." }, "partnerError400FirstNameInvalid": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error_code": { "type": "string", "const": "FIRST_NAME_INVALID" }, "error_message": { "type": "string", "examples": [ "The attribute first_name has an invalid value." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false, "description": "The attribute first_name has an invalid value." }, "partnerError400FirstNameMissing": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error_code": { "type": "string", "const": "FIRST_NAME_MISSING" }, "error_message": { "type": "string", "examples": [ "The attribute first_name is missing." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false, "description": "The attribute first_name is missing from the request." }, "partnerError400LastNameInvalid": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error_code": { "type": "string", "const": "LAST_NAME_INVALID" }, "error_message": { "type": "string", "examples": [ "The attribute last_name has an invalid value." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false, "description": "The attribute last_name has an invalid value." }, "partnerError400LastNameMissing": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error_code": { "type": "string", "const": "LAST_NAME_MISSING" }, "error_message": { "type": "string", "examples": [ "The attribute last_name is missing." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false, "description": "The attribute last_name is missing from the request." }, "partnerError400PasswordInvalid": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error_code": { "type": "string", "const": "PASSWORD_INVALID" }, "error_message": { "type": "string", "examples": [ "The attribute password has an invalid value." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false, "description": "The attribute password has an invalid value." }, "partnerError400PasswordMissing": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error_code": { "type": "string", "const": "PASSWORD_MISSING" }, "error_message": { "type": "string", "examples": [ "The attribute password is missing." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false, "description": "The attribute password is missing from the request." }, "partnerError400PhoneInvalid": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error_code": { "type": "string", "const": "PHONE_INVALID" }, "error_message": { "type": "string", "examples": [ "The attribute phone has an invalid value." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false, "description": "The attribute phone has an invalid value." }, "partnerError400PhoneMissing": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error_code": { "type": "string", "const": "PHONE_MISSING" }, "error_message": { "type": "string", "examples": [ "The attribute phone is missing." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false, "description": "The attribute phone is missing from the request." }, "partnerError400PostalCodeInvalid": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error_code": { "type": "string", "const": "POSTAL_CODE_INVALID" }, "error_message": { "type": "string", "examples": [ "The attribute postal_code has an invalid value." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false, "description": "The attribute postal_code has an invalid value." }, "partnerError400PostalCodeMissing": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error_code": { "type": "string", "const": "POSTAL_CODE_MISSING" }, "error_message": { "type": "string", "examples": [ "The attribute postal_code is missing." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false, "description": "The attribute postal_code is missing from the request." }, "partnerError403": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "const": "ACCOUNT_CREATION_LIMIT_REACHED" }, "error_message": { "type": "string", "examples": [ "Partner account creation limit has been reached." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "403 Forbidden errors for partner account creation." }, "partnerError409": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "const": "ACCOUNT_EXISTS" }, "error_message": { "type": "string", "examples": [ "An account using the given username already exists." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "409 Conflict errors for partner account creation." }, "permission": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "permission": { "$ref": "#/components/schemas/permissionDocument" } }, "description": "A single permission object." }, "permissionDocument": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "options": { "type": "object", "description": "Target specific options." }, "target_identifier": { "$ref": "#/components/schemas/permissionTargetIdentifier" }, "target_type": { "$ref": "#/components/schemas/permissionTargetType" }, "user": { "$ref": "#/components/schemas/permissionUserName" } }, "required": [ "user", "target_type", "target_identifier" ], "additionalProperties": false, "description": "Permission document defining access rights for a sub-account to a specific resource.", "example": { "options": { "storage": "yes" }, "target_identifier": "00e1d79f-d2d8-40ca-a68d-812655b34766", "target_type": "server", "user": "test" } }, "permissionTargetIdentifier": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "description": "Target identifying string. This is type specific and in most cases is a UUID4. Wildcard value \"*\" can be used to\nreference all target resources.\n" }, "permissionTargetType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "enum": [ "server", "storage", "network", "router", "object_storage", "managed_database", "managed_object_storage", "managed_loadbalancer", "managed_kubernetes", "interface", "network_gateway", "tag_access", "managed_container_registry", "file_storage", "ssh_key" ], "description": "Type of the target to grant permission to" }, "permissions": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "permissions": { "type": "object", "properties": { "permission": { "type": "array", "items": { "$ref": "#/components/schemas/permissionDocument" } } }, "required": [ "permission" ], "additionalProperties": false } }, "required": [ "permissions" ], "additionalProperties": false, "description": "List of permissions.", "example": { "permissions": { "permission": [ { "user": "subaccount1", "target_type": "server", "target_identifier": "00e1d79f-d2d8-40ca-a68d-812655b34766", "options": { "storage": "yes" } }, { "user": "subaccount2", "target_type": "storage", "target_identifier": "01f6d5e3-c3b2-41ba-912a-723ab2c12345" } ] } } }, "permissionUserName": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "maxLength": 64, "minLength": 4, "description": "Username for an account." }, "permissionError": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "examples": [ "GENERAL_FAILURE" ] }, "error_message": { "type": "string", "examples": [ "Your request could not be fulfilled due to a technical issue." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "A general error response indicating that the request could not be fulfilled due to a technical issue." }, "plan": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "plans": { "type": "object", "properties": { "plan": { "type": "array", "items": { "type": "object", "properties": { "core_number": { "$ref": "#/components/schemas/planCoreNumber" }, "memory_amount": { "$ref": "#/components/schemas/planMemoryAmount" }, "name": { "$ref": "#/components/schemas/planName" }, "public_traffic_out": { "$ref": "#/components/schemas/planPublicTrafficOut" }, "storage_size": { "$ref": "#/components/schemas/planStorageSize" }, "storage_tier": { "$ref": "#/components/schemas/planStorageTier" }, "gpu_amount": { "$ref": "#/components/schemas/planGpuAmount" }, "gpu_model": { "$ref": "#/components/schemas/planGpuModel" }, "family": { "$ref": "#/components/schemas/planFamily" }, "current_offering": { "$ref": "#/components/schemas/planBooleanYesno" } }, "required": [ "core_number", "memory_amount", "name", "family", "current_offering" ], "additionalProperties": false }, "example": [ { "core_number": 1, "memory_amount": 1024, "name": "1xCPU-1GB", "public_traffic_out": 1024, "storage_size": 25, "storage_tier": "maxiops", "family": "general_purpose", "current_offering": "yes" } ] } }, "required": [ "plan" ], "additionalProperties": false, "example": { "plan": [ { "core_number": 1, "memory_amount": 1024, "name": "1xCPU-1GB", "public_traffic_out": 1024, "storage_size": 25, "storage_tier": "maxiops", "family": "general_purpose", "current_offering": "yes" } ] } } }, "required": [ "plans" ], "additionalProperties": false, "description": "List response containing available server plans.", "example": { "plans": { "plan": [ { "core_number": 1, "memory_amount": 1024, "name": "1xCPU-1GB", "public_traffic_out": 1024, "storage_size": 25, "storage_tier": "maxiops", "family": "general_purpose", "current_offering": "yes" } ] } } }, "planName": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "1xCPU-1GB", "DEV-1xCPU-4GB", "CLOUDNATIVE-1xCPU-8GB", "GPU-12xCPU-128GB-2xL40S" ], "maxLength": 255, "minLength": 1, "description": "Server plan identifier" }, "planFamily": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "general_purpose", "cloud_native" ], "enum": [ "general_purpose", "developer", "cloud_native", "gpu", "starter", "premium" ], "description": "The plan family identifier. Plan families group plans by their intended use case." }, "planCoreNumber": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "format": "int64", "description": "The number of CPU cores included in the plan, represented as a positive integer. This value must be greater than zero." }, "planMemoryAmount": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "format": "int64", "description": "The amount of memory included in the plan, measured in mebibytes (MiB)." }, "planPublicTrafficOut": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "minimum": 0, "format": "int64", "description": "The amount of public traffic out included in the plan, measured in gigabytes (GB)." }, "planStorageSize": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "format": "int64", "description": "The block storage size for the plan in gibibytes (GiB). The value is 0 if the plan does not include block storage." }, "planStorageTier": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": [ "string", "null" ], "examples": [ "hdd", "standard", "maxiops", null ], "description": "Block storage performance and pricing tier. `maxiops` is high-performance block storage, `standard` is general-purpose block storage, and `hdd` is the API name for the high-capacity Archive tier. The value can be null when a plan does not include block storage." }, "planGpuAmount": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "format": "int64", "description": "The number of GPUs included in the plan." }, "planGpuModel": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "NVIDIA L40S" ], "description": "The GPU model included in the plan." }, "planBooleanYesno": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "yes", "no" ], "description": "Boolean value represented as yes/no", "example": "yes" }, "planError": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "examples": [ "GENERAL_FAILURE" ] }, "error_message": { "type": "string", "examples": [ "Your request could not be fulfilled due to a technical issue." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "A general error response indicating that the request could not be fulfilled due to a technical issue." }, "prices": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "prices": { "type": "object", "properties": { "currency": { "$ref": "#/components/schemas/priceCurrency" }, "zone": { "type": "array", "items": { "$ref": "#/components/schemas/zonePrices" } } }, "required": [ "currency", "zone" ], "example": { "currency": "USD", "zone": [ { "server_cores": { "amount": 1, "price": 2.4 }, "server_memory": { "amount": 1024, "price": 3.84 } } ] } } }, "required": [ "prices" ], "description": "Price list for UpCloud resources and services.", "example": { "prices": { "currency": "USD", "zone": [ { "server_cores": { "amount": 1, "price": 2.4 }, "server_memory": { "amount": 1024, "price": 3.84 }, "storage": { "amount": 1, "price": 0.04 } } ] } } }, "zonePrices": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "items": { "type": "object", "additionalProperties": { "type": "object", "properties": { "amount": { "type": "integer", "format": "int32" }, "price": { "type": "number", "format": "double" } }, "required": [ "amount", "price" ], "additionalProperties": false } } }, "description": "Pricing information organized by zone." }, "priceCurrency": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[A-Z]{3}$", "description": "ISO 4217 code" }, "priceError400": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "examples": [ "PRICE_INVALID" ], "enum": [ "PRICE_INVALID" ] }, "message": { "type": "string", "examples": [ "The price ID is invalid" ] } }, "required": [ "code", "message" ] } }, "required": [ "error" ], "description": "Invalid price request error." }, "priceError": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "examples": [ "GENERAL_FAILURE" ] }, "error_message": { "type": "string", "examples": [ "Your request could not be fulfilled due to a technical issue." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "A general error response indicating that the request could not be fulfilled due to a technical issue." }, "routerCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "router": { "type": "object", "properties": { "name": { "type": "string", "example": "Example router" }, "static_routes": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-zA-Z0-9_-]+$" }, "nexthop": { "oneOf": [ { "$ref": "#/components/schemas/routerIpAddress" }, { "type": "string", "enum": [ "no-nexthop" ] } ] }, "route": { "$ref": "#/components/schemas/routerIpCidr" } }, "required": [ "nexthop", "route" ], "additionalProperties": false }, "description": "Static routes that will be added to the routing table of the SDN router", "example": [ { "name": "static-route-0", "nexthop": "192.168.1.1", "route": "0.0.0.0/0" } ] }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/routerLabel" } } }, "required": [ "name" ], "additionalProperties": false, "example": { "name": "Example router", "static_routes": [ { "name": "static-route-0", "nexthop": "192.168.1.1", "route": "0.0.0.0/0" } ] } } }, "required": [ "router" ], "additionalProperties": false, "description": "Request schema for creating a router", "example": { "router": { "name": "Example router", "static_routes": [ { "name": "static-route-0", "nexthop": "192.168.1.1", "route": "0.0.0.0/0" } ] } } }, "routerType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "normal", "service" ], "description": "Type of the router.", "example": "normal" }, "routerModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "router": { "type": "object", "properties": { "name": { "type": "string", "example": "Example router" }, "static_routes": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-zA-Z0-9_-]+$" }, "nexthop": { "oneOf": [ { "$ref": "#/components/schemas/routerIpAddress" }, { "type": "string", "enum": [ "no-nexthop" ] } ] }, "route": { "$ref": "#/components/schemas/routerIpCidr" } }, "required": [ "nexthop", "route" ], "additionalProperties": false }, "description": "Static routes that will be added to the routing table of the SDN router", "example": [ { "name": "static-route-0", "nexthop": "192.168.1.1", "route": "0.0.0.0/0" } ] }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/routerLabel" } } }, "additionalProperties": false, "example": { "name": "Example router", "static_routes": [ { "name": "static-route-0", "nexthop": "192.168.1.1", "route": "0.0.0.0/0" } ] } } }, "required": [ "router" ], "additionalProperties": false, "description": "Request schema for modifying a router", "example": { "router": { "name": "Example router", "labels": [ { "key": "service", "value": "postgres cluster connectivity" } ], "static_routes": [] } } }, "routers": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "routers": { "type": "object", "properties": { "router": { "type": "array", "items": { "$ref": "#/components/schemas/routerDetails" } } }, "required": [ "router" ], "additionalProperties": false, "example": { "router": [ { "attached_network_gateways": [], "attached_networks": { "network": [] }, "labels": [], "name": "Example router", "static_routes": [], "type": "normal", "uuid": "04c0df35-2658-4b0c-8ac7-962090f4e92a" } ] } } }, "required": [ "routers" ], "additionalProperties": false, "description": "A list of routers", "example": { "routers": { "router": [ { "attached_network_gateways": [], "attached_networks": { "network": [] }, "labels": [], "name": "Example router", "static_routes": [], "type": "normal", "uuid": "04c0df35-2658-4b0c-8ac7-962090f4e92a" } ] } } }, "routerDetails": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "attached_network_gateways": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "$ref": "#/components/schemas/routerUuid" } }, "required": [ "uuid" ], "additionalProperties": false }, "description": "Gateways of the networks attached to the router." }, "attached_networks": { "type": "object", "properties": { "network": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "$ref": "#/components/schemas/routerUuid" } }, "required": [ "uuid" ] } } }, "required": [ "network" ], "description": "Networks attached to the router.", "example": { "network": [ { "uuid": "03804f7f-828a-4610-867f-9d62cf9fc14f" } ] } }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/routerLabel" } }, "name": { "type": "string", "example": "Example router" }, "static_routes": { "type": "array", "items": { "$ref": "#/components/schemas/routerRouteNexthop" }, "example": [ { "name": "static-route-0", "nexthop": "192.168.1.1", "route": "0.0.0.0/0", "type": "user" } ] }, "type": { "$ref": "#/components/schemas/routerType" }, "uuid": { "$ref": "#/components/schemas/routerUuid" } }, "required": [ "uuid", "name", "type", "attached_networks", "static_routes", "labels", "attached_network_gateways" ], "additionalProperties": false, "description": "Router describes a virtual router that can route between SDN networks", "example": { "attached_network_gateways": [], "attached_networks": { "network": [ { "uuid": "03804f7f-828a-4610-867f-9d62cf9fc14f" } ] }, "name": "Example router", "static_routes": [ { "name": "static-route-0", "nexthop": "192.168.1.1", "route": "0.0.0.0/0", "type": "user" } ], "labels": [], "type": "normal", "uuid": "0414e0d7-4436-4037-9dd8-6eaf47dce599" } }, "router": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "router": { "$ref": "#/components/schemas/routerDetails" } }, "required": [ "router" ], "additionalProperties": false, "description": "Schema for a single router" }, "routerLabel": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "key": { "type": "string", "description": "Label key used to classify the resource" }, "value": { "type": "string", "description": "Value associated with the label key" } }, "required": [ "key", "value" ], "additionalProperties": false, "description": "A key/value pair to label and categorize resources", "example": { "key": "env", "value": "production" } }, "routerUuid": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "format": "uuid", "description": "Universally unique identifier", "example": "0414e0d7-4436-4037-9dd8-6eaf47dce599" }, "routerIpAddress": { "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "type": "string", "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}$", "description": "IPv4 address" }, { "type": "string", "pattern": "^[a-fA-F0-9:]+$", "description": "IPv6 address" } ], "description": "IP address", "example": "10.0.0.20" }, "routerIpCidr": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "format": "cidr", "description": "IP CIDR" }, "routerRouteNexthop": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-zA-Z0-9_-]+$" }, "nexthop": { "oneOf": [ { "$ref": "#/components/schemas/routerIpAddress" }, { "type": "string", "enum": [ "no-nexthop" ] } ] }, "route": { "$ref": "#/components/schemas/routerIpCidr" }, "type": { "$ref": "#/components/schemas/routerStaticRouteType" } }, "required": [ "name", "nexthop", "route", "type" ], "additionalProperties": false, "description": "Static route with nexthop information." }, "routerStaticRouteType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "user", "service" ], "description": "Type of static route.", "example": "user" }, "routerError": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "examples": [ "GENERAL_FAILURE" ] }, "error_message": { "type": "string", "examples": [ "Your request could not be fulfilled due to a technical issue." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "A general error response indicating that the request could not be fulfilled due to a technical issue." }, "serverGroupModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "server_group": { "type": "object", "properties": { "title": { "type": "string", "description": "The name of the server group", "example": "edge-cluster-a" }, "servers": { "$ref": "#/components/schemas/serverGroupServers" }, "labels": { "type": "object", "properties": { "label": { "type": "array", "items": { "$ref": "#/components/schemas/serverGroupLabel" } } }, "description": "Labels to categorize the server group", "example": { "label": [ { "key": "env", "value": "prod" } ] } }, "anti_affinity": { "$ref": "#/components/schemas/serverGroupAntiAffinity" } }, "additionalProperties": false, "example": { "title": "edge-cluster-a", "servers": { "servers": [ "00fce2f9-f9f4-46ff-86af-9e60f131f5cb" ] }, "labels": { "label": [ { "key": "env", "value": "prod" } ] }, "anti_affinity": "yes" } } }, "required": [ "server_group" ], "additionalProperties": false, "description": "A schema for creating/modifying a server group", "example": { "server_group": { "title": "edge-cluster-a", "servers": { "servers": [ "00fce2f9-f9f4-46ff-86af-9e60f131f5cb" ] }, "labels": { "label": [ { "key": "env", "value": "prod" } ] }, "anti_affinity": "yes" } } }, "serverGroups": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "server_groups": { "type": "object", "properties": { "server_group": { "type": "array", "items": { "$ref": "#/components/schemas/serverGroupDetails" } } }, "required": [ "server_group" ], "additionalProperties": false, "example": { "server_group": [ { "anti_affinity": "yes", "anti_affinity_status": [ { "uuid": "00fce2f9-f9f4-46ff-86af-9e60f131f5cb", "status": "met" } ], "labels": { "label": [ { "key": "env", "value": "prod" } ] }, "servers": { "server": [ "00fce2f9-f9f4-46ff-86af-9e60f131f5cb" ] }, "title": "edge-cluster-a", "uuid": "00fce2f9-f9f4-46ff-86af-9e60f131f5cb" } ] } } }, "required": [ "server_groups" ], "additionalProperties": false, "description": "List of server groups", "example": { "server_groups": { "server_group": [ { "anti_affinity": "yes", "anti_affinity_status": [ { "uuid": "00fce2f9-f9f4-46ff-86af-9e60f131f5cb", "status": "met" } ], "labels": { "label": [ { "key": "env", "value": "prod" } ] }, "servers": { "server": [ "00fce2f9-f9f4-46ff-86af-9e60f131f5cb" ] }, "title": "edge-cluster-a", "uuid": "00fce2f9-f9f4-46ff-86af-9e60f131f5cb" } ] } } }, "serverGroupDetails": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "anti_affinity": { "$ref": "#/components/schemas/serverGroupAntiAffinity" }, "anti_affinity_status": { "type": "array", "items": { "$ref": "#/components/schemas/serverGroupAntiAffinityStatus" } }, "labels": { "type": "object", "properties": { "label": { "type": "array", "items": { "$ref": "#/components/schemas/serverGroupLabel" } } }, "required": [ "label" ], "additionalProperties": false, "description": "List of labels associated with the server group." }, "servers": { "type": "object", "properties": { "server": { "type": "array", "items": { "$ref": "#/components/schemas/serverGroupUuid" } } }, "required": [ "server" ], "additionalProperties": false, "description": "List of servers associated with the server group." }, "title": { "type": "string" }, "uuid": { "$ref": "#/components/schemas/serverGroupUuid" } }, "required": [ "uuid", "title", "anti_affinity", "anti_affinity_status", "labels", "servers" ], "additionalProperties": false, "description": "Details of a server group" }, "serverGroup": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "server_group": { "$ref": "#/components/schemas/serverGroupDetails" } }, "required": [ "server_group" ], "additionalProperties": false, "description": "A single server group" }, "serverGroupLabel": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "key": { "type": "string", "description": "Label key used to classify the resource" }, "value": { "type": "string", "description": "Value associated with the label key" } }, "required": [ "key", "value" ], "additionalProperties": false, "description": "A key/value pair to label and categorize resources", "example": { "key": "env", "value": "production" } }, "serverGroupUuid": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "format": "uuid", "description": "Universally unique identifier", "example": "0414e0d7-4436-4037-9dd8-6eaf47dce599" }, "serverGroupServers": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "servers": { "type": "array", "items": { "$ref": "#/components/schemas/serverGroupUuid" } } }, "required": [ "servers" ], "additionalProperties": false, "description": "List of server UUIDs in the server group", "example": { "servers": [ "00fce2f9-f9f4-46ff-86af-9e60f131f5cb", "0414e0d7-4436-4037-9dd8-6eaf47dce599" ] } }, "serverGroupAntiAffinity": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "strict", "yes", "no" ], "description": "Anti-affinity policy for server groups. Possible values are 'strict', 'yes', or 'no'. 'strict' ensures that no two servers in the group are placed on the same physical host. 'yes' indicates a preference for anti-affinity but does not guarantee it. 'no' means there is no anti-affinity requirement.", "default": "no" }, "serverGroupServerAdd": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "server": { "type": "object", "properties": { "uuid": { "$ref": "#/components/schemas/serverGroupUuid" } }, "required": [ "uuid" ], "additionalProperties": false } }, "required": [ "server" ], "additionalProperties": false, "description": "Schema for adding a server to a server group" }, "serverGroupAntiAffinityStatus": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "uuid": { "$ref": "#/components/schemas/serverGroupUuid" }, "status": { "type": "string", "enum": [ "met", "unmet" ], "description": "Indicates whether the anti-affinity policy is currently being met ('met') or not ('unmet')" } }, "required": [ "uuid", "status" ], "additionalProperties": false, "description": "Status of anti-affinity policy" }, "serverGroupError": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "examples": [ "GENERAL_FAILURE" ] }, "error_message": { "type": "string", "examples": [ "Your request could not be fulfilled due to a technical issue." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "A general error response indicating that the request could not be fulfilled due to a technical issue." }, "serverTagList": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "description": "One or more tag names. Use commas to match any tag, or colons to require all tags.", "example": "prod,web" }, "createServer": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "server": { "type": "object", "properties": { "avoid_host": { "$ref": "#/components/schemas/serverEncodedHostId" }, "boot_order": { "$ref": "#/components/schemas/serverBootOrder" }, "core_number": { "$ref": "#/components/schemas/serverCoreNumber" }, "firewall": { "$ref": "#/components/schemas/serverBooleanOnoff" }, "host": { "$ref": "#/components/schemas/serverEncodedHostId" }, "hostname": { "$ref": "#/components/schemas/serverHostname" }, "ip_addresses": { "$ref": "#/components/schemas/serverIpAddresses" }, "labels": { "$ref": "#/components/schemas/serverLabels" }, "login_user": { "$ref": "#/components/schemas/serverLoginUser" }, "memory_amount": { "$ref": "#/components/schemas/serverMemoryAmount" }, "networking": { "$ref": "#/components/schemas/serverCreateNetworking" }, "nic_model": { "$ref": "#/components/schemas/serverNicModel" }, "password_delivery": { "$ref": "#/components/schemas/serverPasswordDelivery" }, "plan": { "$ref": "#/components/schemas/serverPlan" }, "server_group": { "$ref": "#/components/schemas/serverServerGroup" }, "simple_backup": { "$ref": "#/components/schemas/serverSimpleBackup" }, "metadata": { "$ref": "#/components/schemas/serverBooleanYesno" }, "devices": { "$ref": "#/components/schemas/serverCreateDevices" }, "remote_access_enabled": { "$ref": "#/components/schemas/serverRemoteAccessEnabled" }, "remote_access_password": { "$ref": "#/components/schemas/serverRemoteAccessPassword" }, "remote_access_type": { "$ref": "#/components/schemas/serverRemoteAccessType" }, "storage_devices": { "$ref": "#/components/schemas/serverStorageDevices" }, "timezone": { "$ref": "#/components/schemas/serverTimezone" }, "title": { "$ref": "#/components/schemas/serverTitle" }, "user_data": { "$ref": "#/components/schemas/serverUserData" }, "video_model": { "$ref": "#/components/schemas/serverVideoModel" }, "vnc_keymap": { "$ref": "#/components/schemas/serverVncKeymap" }, "zone": { "$ref": "#/components/schemas/serverZone" } }, "required": [ "title", "zone", "hostname", "storage_devices" ], "additionalProperties": false } }, "required": [ "server" ], "additionalProperties": false, "description": "Cloud Server creation parameters", "example": { "server": { "hostname": "my-server.example.com", "title": "My Server", "zone": "fi-hel1", "storage_devices": { "storage_device": [ { "action": "clone", "storage": "01234567-89ab-cdef-0123-456789abcdef", "title": "Operating System" } ] } } } }, "serverServerGroup": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": [ "string", "null" ], "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "description": "UUID of the server group containing the Cloud Server, or null when the Cloud Server is not in a group.", "example": "0b3d85b4-b3be-46ca-a1e2-3b5d40d60fb1" }, "modifyServer": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "server": { "type": "object", "properties": { "boot_order": { "$ref": "#/components/schemas/serverBootOrder" }, "core_number": { "$ref": "#/components/schemas/serverCoreNumber" }, "firewall": { "$ref": "#/components/schemas/serverBooleanOnoff" }, "firewall_private": { "$ref": "#/components/schemas/serverBooleanOnoff" }, "firewall_private_default_incoming_action": { "type": "string", "enum": [ "accept", "drop" ] }, "firewall_private_default_outgoing_action": { "type": "string", "enum": [ "accept", "drop" ] }, "firewall_public_default_incoming_action": { "type": "string", "enum": [ "accept", "drop" ] }, "firewall_public_default_outgoing_action": { "type": "string", "enum": [ "accept", "drop" ] }, "hostname": { "$ref": "#/components/schemas/serverHostname" }, "labels": { "$ref": "#/components/schemas/serverLabels" }, "memory_amount": { "$ref": "#/components/schemas/serverMemoryAmount" }, "metadata": { "$ref": "#/components/schemas/serverBooleanYesno" }, "nic_model": { "$ref": "#/components/schemas/serverNicModel" }, "plan": { "$ref": "#/components/schemas/serverPlan" }, "remote_access_enabled": { "$ref": "#/components/schemas/serverRemoteAccessEnabled" }, "remote_access_password": { "$ref": "#/components/schemas/serverRemoteAccessPassword" }, "remote_access_type": { "$ref": "#/components/schemas/serverRemoteAccessType" }, "simple_backup": { "$ref": "#/components/schemas/serverSimpleBackup" }, "timezone": { "$ref": "#/components/schemas/serverTimezone" }, "title": { "$ref": "#/components/schemas/serverTitle" }, "video_model": { "$ref": "#/components/schemas/serverVideoModel" }, "vnc_keymap": { "$ref": "#/components/schemas/serverVncKeymap" } }, "minProperties": 1, "additionalProperties": false } }, "required": [ "server" ], "additionalProperties": false, "description": "Fields that can be changed on an existing Cloud Server", "example": { "server": { "core_number": 8, "memory_amount": 16384, "plan": "custom" } } }, "serverRebuild": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "server_rebuild": { "type": "object", "properties": { "clone_source": { "type": "string", "format": "uuid", "description": "UUID of the public template used for the new system disk." }, "delete_detached_disk": { "$ref": "#/components/schemas/serverLegacyBoolean" }, "detach_disk": { "type": "string", "format": "uuid", "description": "UUID of the storage to detach before rebuilding." }, "encrypted": { "$ref": "#/components/schemas/serverLegacyBoolean" }, "login_user": { "type": "object", "properties": { "create_password": { "$ref": "#/components/schemas/serverLegacyBoolean" }, "ssh_keys": { "type": "object", "properties": { "ssh_key": { "type": "array", "items": { "type": "string" }, "description": "SSH public keys in OpenSSH format." } }, "required": [ "ssh_key" ], "additionalProperties": false }, "username": { "type": "string", "description": "Login username." } }, "additionalProperties": false }, "password_delivery": { "type": "string", "enum": [ "email", "sms", "none" ], "description": "One-time password delivery method." }, "storage_title": { "type": "string", "description": "Title of the new system storage." }, "user_data": { "type": "string", "description": "User data supplied to cloud-init." } }, "required": [ "clone_source" ], "additionalProperties": false } }, "required": [ "server_rebuild" ], "additionalProperties": false, "description": "Rebuild Cloud Server request", "example": { "server_rebuild": { "clone_source": "01000000-0000-4000-8000-000020050100", "delete_detached_disk": "yes", "detach_disk": "0169b4f8-051c-4a86-9484-f5b798249949", "encrypted": "yes", "login_user": { "create_password": "no", "ssh_keys": { "ssh_key": [ "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIEexamplekey user@example" ] }, "username": "debian" }, "password_delivery": "none", "storage_title": "Rebuilt system disk" } } }, "relocateServer": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "zone": { "$ref": "#/components/schemas/serverZone" } }, "required": [ "zone" ], "additionalProperties": false, "description": "Relocate Cloud Server request", "example": { "zone": "fi-hel2" } }, "restartServer": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "restart_server": { "type": "object", "anyOf": [ { "properties": { "stop_type": { "const": "hard" } }, "required": [ "stop_type" ] }, { "required": [ "timeout" ] } ], "properties": { "host": { "$ref": "#/components/schemas/serverEncodedHostId" }, "reason": { "$ref": "#/components/schemas/serverReason" }, "stop_type": { "type": "string", "enum": [ "soft", "hard" ], "description": "Type of stop performed before starting again." }, "timeout": { "type": "string", "pattern": "^(?:[1-9]|[1-9][0-9]|[1-5][0-9]{2}|600)$", "description": "Soft-stop timeout in seconds." }, "timeout_action": { "type": "string", "enum": [ "destroy", "ignore" ], "description": "Action when the soft-stop timeout expires.", "default": "ignore" } }, "additionalProperties": false } }, "required": [ "restart_server" ], "additionalProperties": false, "description": "Restart Cloud Server request", "example": { "restart_server": { "stop_type": "soft", "timeout": "60", "timeout_action": "destroy" } } }, "startServer": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "server": { "type": "object", "properties": { "avoid_host": { "$ref": "#/components/schemas/serverEncodedHostId" }, "host": { "$ref": "#/components/schemas/serverEncodedHostId" }, "reason": { "$ref": "#/components/schemas/serverReason" }, "start_type": { "type": "string", "enum": [ "sync", "async" ], "description": "Whether to wait for the Cloud Server to start." } }, "additionalProperties": false } }, "required": [ "server" ], "additionalProperties": false, "description": "Start Cloud Server request", "example": { "server": { "host": 8055964291, "start_type": "sync" } } }, "stopServer": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "stop_server": { "type": "object", "properties": { "reason": { "$ref": "#/components/schemas/serverReason" }, "stop_type": { "type": "string", "enum": [ "soft", "hard" ], "description": "Type of stop operation." }, "timeout": { "type": "string", "pattern": "^(?:[1-9]|[1-9][0-9]|[1-5][0-9]{2}|600)$", "description": "Soft-stop timeout in seconds." } }, "additionalProperties": false } }, "required": [ "stop_server" ], "additionalProperties": false, "description": "Stop Cloud Server request", "example": { "stop_server": { "stop_type": "soft", "timeout": "60" } } }, "getServerList": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "servers": { "type": "object", "properties": { "server": { "type": "array", "items": { "$ref": "#/components/schemas/serverInGetServerList" } } } } }, "required": [ "servers" ], "additionalProperties": false, "description": "Schema for the Cloud Server list response.", "example": { "servers": { "server": [ { "core_number": "2", "created": 1705320000, "hostname": "web-1.example.com", "license": "0", "memory_amount": "2048", "plan": "2xCPU-2GB", "labels": { "label": [ { "key": "env", "value": "production" } ] }, "plan_ipv4_bytes": "34253332", "plan_ipv6_bytes": "0", "simple_backup": "0100,dailies", "state": "started", "tags": { "tag": [ "production", "web" ] }, "title": "Production web server", "uuid": "007bf7bd-e3cf-4a10-bf01-4251dc7f3b65", "zone": "fi-hel1" } ] } } }, "serverInGetServerList": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "created": { "$ref": "#/components/schemas/serverCreated" }, "core_number": { "type": "string", "description": "Number of CPU cores allocated to the Cloud Server." }, "host": { "$ref": "#/components/schemas/serverEncodedHostId" }, "hostname": { "type": "string", "description": "Hostname configured for the Cloud Server." }, "labels": { "type": "object", "properties": { "label": { "type": "array", "items": { "$ref": "#/components/schemas/serverLabel" } } }, "description": "Labels assigned to the Cloud Server." }, "license": { "type": "string", "description": "Hourly operating system license charge in credits." }, "memory_amount": { "type": "string", "description": "Amount of memory allocated to the Cloud Server, in MiB." }, "plan": { "$ref": "#/components/schemas/serverPlanName" }, "plan_ipv4_bytes": { "type": "string", "description": "Public IPv4 outbound traffic used during the current billing month, in bytes." }, "plan_ipv6_bytes": { "type": "string", "description": "Public IPv6 outbound traffic used during the current billing month, in bytes." }, "progress": { "type": "string", "description": "Progress percentage for an operation that places the Cloud Server in maintenance state." }, "simple_backup": { "$ref": "#/components/schemas/serverSimpleBackup" }, "state": { "$ref": "#/components/schemas/serverState" }, "tags": { "$ref": "#/components/schemas/serverTags" }, "title": { "type": "string", "description": "Display title of the Cloud Server." }, "uuid": { "$ref": "#/components/schemas/serverUuid" }, "zone": { "$ref": "#/components/schemas/serverZone" }, "server_group": { "$ref": "#/components/schemas/serverServerGroup" } }, "required": [ "created", "hostname", "core_number", "license", "memory_amount", "state", "title", "uuid", "zone" ], "additionalProperties": false, "description": "Schema for a Cloud Server item returned in Cloud Server list responses.", "example": { "core_number": "2", "created": 1705320000, "hostname": "web-1.example.com", "license": "0", "memory_amount": "2048", "labels": { "label": [ { "key": "env", "value": "production" } ] }, "plan": "2xCPU-2GB", "plan_ipv4_bytes": "34253332", "plan_ipv6_bytes": "0", "simple_backup": "0100,dailies", "state": "started", "tags": { "tag": [ "production", "web" ] }, "title": "Production web server", "uuid": "007bf7bd-e3cf-4a10-bf01-4251dc7f3b65", "zone": "fi-hel1" } }, "serverState": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "started", "stopped", "maintenance", "error", "pending_delete" ], "description": "Current state of the Cloud Server", "example": "started" }, "serverTags": { "$schema": "https://json-schema.org/draft/2020-12/schema", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "object", "properties": { "tag": { "type": "array", "items": { "type": "string" } } }, "required": [ "tag" ], "additionalProperties": false } ], "description": "tags can be an empty array or an object with a tag array", "example": { "tag": [] } }, "createServerResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "server": { "$ref": "#/components/schemas/serverDetails" } }, "required": [ "server" ], "additionalProperties": false, "description": "Newly created Cloud Server and optional one-time login credentials", "example": { "server": { "core_number": "2", "created": 1705320000, "hostname": "my-server.example.com", "license": "0", "memory_amount": "2048", "state": "maintenance", "title": "My Server", "uuid": "007bf7bd-e3cf-4a10-bf01-4251dc7f3b65", "zone": "fi-hel1" } } }, "serverDetails": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "boot_order": { "$ref": "#/components/schemas/serverBootOrder" }, "core_number": { "type": "string", "description": "Number of CPU cores." }, "created": { "$ref": "#/components/schemas/serverCreated" }, "devices": { "type": "object", "properties": { "device": { "type": "array", "items": { "$ref": "#/components/schemas/serverDevice" } } }, "required": [ "device" ] }, "firewall": { "$ref": "#/components/schemas/serverBooleanOnoff" }, "firewall_private": { "$ref": "#/components/schemas/serverBooleanOnoff" }, "firewall_private_default_incoming_action": { "type": "string", "enum": [ "accept", "drop" ] }, "firewall_private_default_outgoing_action": { "type": "string", "enum": [ "accept", "drop" ] }, "firewall_public_default_incoming_action": { "type": "string", "enum": [ "accept", "drop" ] }, "firewall_public_default_outgoing_action": { "type": "string", "enum": [ "accept", "drop" ] }, "host": { "$ref": "#/components/schemas/serverEncodedHostId" }, "hostname": { "type": "string", "description": "Cloud Server hostname." }, "ip_addresses": { "$ref": "#/components/schemas/serverIpAddresses" }, "labels": { "$ref": "#/components/schemas/serverLabels" }, "license": { "type": "string", "description": "Hourly license price" }, "memory_amount": { "type": "string", "description": "Memory in MiB." }, "metadata": { "$ref": "#/components/schemas/serverBooleanYesno" }, "networking": { "$ref": "#/components/schemas/serverNetworking" }, "nic_model": { "$ref": "#/components/schemas/serverNicModel" }, "plan": { "$ref": "#/components/schemas/serverPlanName" }, "plan_ipv4_bytes": { "type": "string", "description": "Public IPv4 outbound traffic this billing month, in bytes." }, "plan_ipv6_bytes": { "type": "string", "description": "Public IPv6 outbound traffic this billing month, in bytes." }, "password": { "type": "string", "description": "One-time login password returned when the Cloud Server is created." }, "progress": { "type": "string", "description": "Progress percentage for an operation in progress." }, "remote_access_enabled": { "$ref": "#/components/schemas/serverRemoteAccessEnabled" }, "remote_access_host": { "type": "string", "description": "Remote access hostname." }, "remote_access_password": { "$ref": "#/components/schemas/serverRemoteAccessPassword" }, "remote_access_port": { "type": "string", "description": "Remote access port." }, "remote_access_type": { "$ref": "#/components/schemas/serverRemoteAccessType" }, "server_group": { "$ref": "#/components/schemas/serverServerGroup" }, "simple_backup": { "$ref": "#/components/schemas/serverSimpleBackup" }, "state": { "$ref": "#/components/schemas/serverState" }, "storage_devices": { "$ref": "#/components/schemas/serverStorageDevicesResponse" }, "tags": { "$ref": "#/components/schemas/serverTags" }, "timezone": { "type": "string", "description": "Configured timezone." }, "title": { "type": "string", "description": "Display title." }, "username": { "$ref": "#/components/schemas/serverUserName" }, "uuid": { "$ref": "#/components/schemas/serverUuid" }, "video_model": { "$ref": "#/components/schemas/serverVideoModel" }, "zone": { "$ref": "#/components/schemas/serverZone" } }, "required": [ "created", "hostname", "core_number", "license", "memory_amount", "state", "title", "uuid", "zone" ], "additionalProperties": false, "description": "Detailed public information about a Cloud Server", "example": { "boot_order": "disk", "core_number": "12", "created": 1705320000, "firewall": "on", "host": 7653311107, "hostname": "server1.example.com", "labels": { "label": [ { "key": "env", "value": "development" } ] }, "license": "0", "memory_amount": "130048", "nic_model": "virtio", "plan": "GPU-12xCPU-128GB-2xL40S", "plan_ipv4_bytes": "3565675343", "plan_ipv6_bytes": "4534432", "remote_access_enabled": "yes", "remote_access_host": "fi-hel1.vnc.upcloud.com", "remote_access_password": "aabbccdd", "remote_access_port": "3000", "remote_access_type": "vnc", "server_group": "0b3d85b4-b3be-46ca-a1e2-3b5d40d60fb1", "simple_backup": "0100,dailies", "state": "started", "storage_devices": { "storage_device": [ { "address": "virtio:0", "boot_disk": "1", "labels": [], "storage": "012580a1-32a1-466e-a323-689ca16f2d43", "storage_encrypted": "yes", "storage_size": 20, "storage_title": "Operating system disk", "type": "disk" } ] }, "tags": { "tag": [ "DEV", "Ubuntu" ] }, "timezone": "UTC", "title": "Development GPU server", "uuid": "0077fa3d-32db-4b09-9f5f-30d9e9afb565", "video_model": "cirrus", "zone": "fi-hel1" } }, "firewallRulesetRelatedServers": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "servers": { "type": "array", "items": { "type": "object", "properties": { "attached_rulesets": { "type": "array", "items": { "$ref": "#/components/schemas/serverFirewallRulesetRelationshipInternal" }, "description": "Private firewall rulesets attached to the Cloud Server." }, "firewall": { "$ref": "#/components/schemas/serverBooleanOnoff" }, "firewall_private": { "$ref": "#/components/schemas/serverBooleanOnoff" }, "firewall_private_default_incoming_action": { "type": "string", "enum": [ "accept", "drop" ], "description": "Default action for unmatched incoming traffic on private interfaces." }, "firewall_private_default_outgoing_action": { "type": "string", "enum": [ "accept", "drop" ], "description": "Default action for unmatched outgoing traffic on private interfaces." }, "title": { "type": "string", "description": "Cloud Server title." }, "uuid": { "$ref": "#/components/schemas/serverUuid" } }, "required": [ "uuid", "title", "firewall", "firewall_private", "firewall_private_default_incoming_action", "firewall_private_default_outgoing_action", "attached_rulesets" ], "additionalProperties": false }, "description": "Cloud Servers visible to the authenticated account that are related to the ruleset." } }, "required": [ "servers" ], "additionalProperties": false, "description": "Accessible Cloud Servers related to a private firewall ruleset and their private ruleset relationships.", "example": { "servers": [ { "attached_rulesets": [ { "applied_version": 3, "created_at": 1787652930, "firewall_ruleset_uuid": "190f56d8-4b3f-4a89-9e5f-320fbc3d17c8", "last_applied_at": 1787652932, "server_uuid": "0077fa3d-32db-4b09-9f5f-30d9e9afb565", "type": "private", "updated_at": null, "version": 3 } ], "firewall": "on", "firewall_private": "on", "firewall_private_default_incoming_action": "drop", "firewall_private_default_outgoing_action": "accept", "title": "Application server", "uuid": "0077fa3d-32db-4b09-9f5f-30d9e9afb565" } ] } }, "getAllServerLabels": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/serverLabel" }, "description": "Unique label key-value pairs used by accessible Cloud Servers, sorted by key and then value. The array may be empty.", "example": [ { "key": "env", "value": "production" }, { "key": "team", "value": "platform" } ] }, "server": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "server": { "$ref": "#/components/schemas/serverDetails" } }, "required": [ "server" ], "additionalProperties": false, "description": "Cloud Server object returned in responses", "example": { "server": { "boot_order": "disk", "core_number": "12", "created": 1705320000, "firewall": "on", "host": 7653311107, "hostname": "server1.example.com", "labels": { "label": [ { "key": "env", "value": "development" } ] }, "license": "0", "memory_amount": "130048", "nic_model": "virtio", "plan": "GPU-12xCPU-128GB-2xL40S", "plan_ipv4_bytes": "3565675343", "plan_ipv6_bytes": "4534432", "remote_access_enabled": "yes", "remote_access_type": "vnc", "server_group": "0b3d85b4-b3be-46ca-a1e2-3b5d40d60fb1", "simple_backup": "0100,dailies", "state": "started", "storage_devices": { "storage_device": [ { "address": "virtio:0", "boot_disk": "1", "labels": [], "storage": "012580a1-32a1-466e-a323-689ca16f2d43", "storage_encrypted": "yes", "storage_size": 20, "storage_title": "Operating system disk", "type": "disk" } ] }, "tags": { "tag": [ "DEV", "Ubuntu" ] }, "timezone": "UTC", "title": "Development GPU server", "uuid": "0077fa3d-32db-4b09-9f5f-30d9e9afb565", "video_model": "cirrus", "zone": "fi-hel1" } } }, "serverUuid": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "format": "uuid", "description": "Universally unique identifier", "example": "0414e0d7-4436-4037-9dd8-6eaf47dce599" }, "serverEncodedHostId": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "examples": [ 7653311107 ], "minimum": 1, "format": "int64", "description": "Encoded Private Cloud host ID" }, "serverLimit": { "type": "integer", "examples": [ 25, 50, 100 ], "maximum": 1000, "minimum": 1, "description": "Maximum number of items to return. Default is 25." }, "serverOffset": { "type": "integer", "examples": [ 0, 25, 50, 100 ], "minimum": 0, "description": "Number of items to skip before starting to return results. Default is 0." }, "serverStatsPeriod": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "daily", "weekly", "monthly", "yearly" ], "description": "The period for which statistics are calculated.", "example": "weekly" }, "serverLegacyBoolean": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "0", "1", "false", "true", "no", "yes", "n", "y", "off", "on" ], "description": "Boolean value accepted by the legacy API" }, "serverBooleanYesno": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "yes", "no" ], "description": "Boolean value represented as yes/no", "example": "yes" }, "serverIpAddress": { "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "type": "string", "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}$", "description": "IPv4 address" }, { "type": "string", "pattern": "^[a-fA-F0-9:]+$", "description": "IPv6 address" } ], "description": "IP address", "example": "10.0.0.20" }, "serverStatsNetworkType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "bytes", "packets" ], "description": "Unit used to measure network activity.", "example": "bytes" }, "serverNetworkType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "public", "utility", "private" ], "description": "Network access type", "example": "public" }, "serverBootOrder": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "description": "Boot device order (comma-separated list)", "example": "cdrom,disk" }, "serverCoreNumber": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "format": "int32", "description": "Number of CPU cores", "example": 2 }, "serverBooleanOnoff": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "on", "off" ], "description": "Boolean value represented as on/off", "example": "on" }, "serverHostname": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "description": "Cloud Server hostname", "example": "example.upcloud.com" }, "serverIpAddresses": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ip_address": { "type": "array", "items": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/serverIpAddress" }, "access": { "$ref": "#/components/schemas/serverNetworkType" }, "family": { "$ref": "#/components/schemas/serverIpFamily" }, "prefix": { "type": "string", "description": "Network prefix length of the IP address" } }, "required": [ "family", "access" ] } } }, "required": [ "ip_address" ], "additionalProperties": false, "description": "IP addresses assigned to the Cloud Server", "example": { "ip_address": [ { "access": "utility", "address": "10.0.0.10", "family": "IPv4" } ] } }, "serverIpFamily": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "IPv4", "IPv6" ], "description": "IP address family", "example": "IPv4" }, "serverLabels": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "label": { "type": "array", "items": { "$ref": "#/components/schemas/serverLabel" } } }, "description": "Cloud Server labels", "example": { "label": [ { "key": "env", "value": "production" } ] } }, "serverLabel": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "key": { "type": "string", "description": "Label key used to classify the resource" }, "value": { "type": "string", "description": "Value associated with the label key" } }, "required": [ "key", "value" ], "additionalProperties": false, "description": "A key/value pair to label and categorize resources", "example": { "key": "env", "value": "production" } }, "serverLoginUser": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "not": { "properties": { "create_password": { "const": "yes" } }, "required": [ "create_password", "ssh_keys" ] }, "properties": { "create_password": { "$ref": "#/components/schemas/serverBooleanYesno" }, "ssh_keys": { "type": "object", "properties": { "ssh_key": { "type": "array", "items": { "type": "string", "description": "Public SSH key in OpenSSH authorized_keys format. Invalid keys are rejected" }, "maxItems": 32, "minItems": 1 } }, "required": [ "ssh_key" ], "additionalProperties": false }, "username": { "type": "string", "description": "Username for logging in to the Cloud Server" } }, "additionalProperties": false, "description": "Login user configuration for Cloud Server creation", "example": { "username": "upclouduser" } }, "serverMemoryAmount": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "format": "int32", "description": "Amount of memory in MB", "example": 2048 }, "serverCreateNetworking": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "interfaces": { "type": "object", "properties": { "interface": { "type": "array", "items": { "type": "object", "properties": { "bootable": { "$ref": "#/components/schemas/serverBooleanYesno" }, "index": { "type": "integer", "minimum": 1, "description": "Index used to identify and order the network interface" }, "ip_addresses": { "type": "object", "properties": { "ip_address": { "type": "array", "items": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/serverIpAddress" }, "dhcp_provided": { "$ref": "#/components/schemas/serverBooleanYesno" }, "family": { "$ref": "#/components/schemas/serverIpFamily" } }, "required": [ "family" ], "additionalProperties": false } } }, "required": [ "ip_address" ], "additionalProperties": false }, "network": { "$ref": "#/components/schemas/serverUuid" }, "source_ip_filtering": { "$ref": "#/components/schemas/serverBooleanYesno" }, "type": { "$ref": "#/components/schemas/serverNetworkType" } }, "required": [ "type", "ip_addresses" ], "additionalProperties": false } } }, "required": [ "interface" ], "additionalProperties": false } }, "required": [ "interfaces" ], "additionalProperties": false, "description": "Network interfaces for a new Cloud Server", "example": { "interfaces": { "interface": [ { "ip_addresses": { "ip_address": [ { "family": "IPv4" } ] }, "type": "public" } ] } } }, "serverNicModel": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "virtio", "e1000", "rtl8139" ], "description": "Network interface card model", "example": "virtio" }, "serverPasswordDelivery": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "description": "Password delivery method", "example": "email" }, "serverPlan": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "description": "Cloud Server plan name", "example": "2xCPU-2GB" }, "serverSimpleBackup": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": [ "string", "null" ], "examples": [ "0100,dailies", "no" ], "description": "Simple backup start time in UTC and frequency, separated by a comma, or no to disable" }, "serverCreateDevices": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "device": { "type": "array", "items": { "type": "object", "properties": { "serial": { "type": "string", "description": "Serial identifier of the attached device" }, "type": { "type": "string", "description": "Type of passthrough device to attach" } }, "required": [ "serial", "type" ], "additionalProperties": false } } }, "required": [ "device" ], "additionalProperties": false, "description": "Passthrough devices requested for a new Cloud Server", "example": { "device": [ { "serial": "1723925007011", "type": "gpu" } ] } }, "serverRemoteAccessEnabled": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "yes", "no" ], "description": "Whether remote access is enabled", "example": "yes" }, "serverRemoteAccessPassword": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "maxLength": 8, "minLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "description": "Eight-character alphanumeric password used to authenticate remote access", "example": "A1b2C3d4" }, "serverRemoteAccessType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "vnc" ], "description": "Protocol used for remote access", "example": "vnc" }, "serverStorageDevices": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "storage_device": { "type": "array", "items": { "type": "object", "allOf": [ {}, {}, {} ], "properties": { "action": { "type": "string", "enum": [ "create", "clone", "attach" ], "description": "Method used to create, clone, or attach storage for the device" }, "address": { "type": "string", "description": "Device address on the Cloud Server" }, "backup_rule": { "type": "object", "properties": { "interval": { "type": "string", "description": "Backup weekday, or daily to create a backup every day" }, "retention": { "type": "integer", "description": "Number of days before an automatic backup is deleted" }, "time": { "type": "string", "description": "UTC backup start time in HHMM format" } } }, "encrypted": { "$ref": "#/components/schemas/serverBooleanYesno" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/serverLabel" } }, "size": { "type": [ "integer", "string" ], "description": "Requested block storage size in gigabytes" }, "storage": { "type": "string", "description": "UUID of the storage resource to attach or clone" }, "tier": { "type": "string", "description": "Performance and pricing tier of the block storage" }, "title": { "type": "string", "description": "Short informational description of the block storage" }, "type": { "type": "string", "description": "Storage device type: disk or cdrom" } }, "required": [ "action" ], "additionalProperties": false }, "maxItems": 16, "minItems": 1 } }, "required": [ "storage_device" ], "additionalProperties": false, "description": "Storage devices to create or attach to the Cloud Server", "example": { "storage_device": [ { "action": "create", "size": "20", "title": "Operating system disk" } ] } }, "serverTimezone": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "description": "Cloud Server timezone", "example": "UTC" }, "serverTitle": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "description": "Cloud Server title", "example": "My Server" }, "serverUserData": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "description": "Setup script body or URL processed during Cloud Server initialization", "example": "#!/bin/sh\napt-get update" }, "serverVideoModel": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "description": "Video adapter model", "example": "vga" }, "serverVncKeymap": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "description": "VNC keyboard layout", "example": "en-us" }, "serverZone": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "fi-hel1", "de-fra1", "us-nyc1" ], "maxLength": 15, "minLength": 2, "pattern": "^[a-z][a-z0-9-]{0,14}[a-z0-9]$", "description": "Zone identifier" }, "serverAttachPrivateFirewallRuleset": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "firewall_ruleset": { "type": "object", "properties": { "firewall_ruleset_uuid": { "$ref": "#/components/schemas/serverUuid" } }, "required": [ "firewall_ruleset_uuid" ], "additionalProperties": false, "description": "Private firewall ruleset to attach." } }, "required": [ "firewall_ruleset" ], "additionalProperties": false, "description": "Parameters for attaching a private firewall ruleset to a Cloud Server.", "example": { "firewall_ruleset": { "firewall_ruleset_uuid": "190f56d8-4b3f-4a89-9e5f-320fbc3d17c8" } } }, "serverBoolean01": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "format": "int64", "enum": [ 0, 1 ], "description": "Schema for boolean-like values encoded as 0 or 1." }, "serverLoadCdrom": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "storage_device": { "type": "object", "properties": { "storage": { "$ref": "#/components/schemas/serverUuid" } }, "required": [ "storage" ], "additionalProperties": false, "description": "Storage to load into the attached CD-ROM device." } }, "required": [ "storage_device" ], "additionalProperties": false, "description": "Parameters for loading a storage into a Cloud Server's CD-ROM device.", "example": { "storage_device": { "storage": "01000000-0000-4000-8000-000060010101" } } }, "serverDetachPrivateFirewallRuleset": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "firewall_ruleset": { "type": "object", "properties": { "firewall_ruleset_uuid": { "$ref": "#/components/schemas/serverUuid" } }, "required": [ "firewall_ruleset_uuid" ], "additionalProperties": false, "description": "Private firewall ruleset to detach." } }, "required": [ "firewall_ruleset" ], "additionalProperties": false, "description": "Parameters for detaching a private firewall ruleset from a Cloud Server.", "example": { "firewall_ruleset": { "firewall_ruleset_uuid": "190f56d8-4b3f-4a89-9e5f-320fbc3d17c8" } } }, "serverUpdateFirewallRules": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "firewall_rules": { "type": "object", "properties": { "firewall_rule": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/serverFirewallRuleItem" } ], "unevaluatedProperties": false }, "maxItems": 1000, "description": "Ordered firewall rules. Supplying an empty array removes all rules." } }, "required": [ "firewall_rule" ], "additionalProperties": false } }, "required": [ "firewall_rules" ], "additionalProperties": false, "description": "Complete replacement for a Cloud Server's firewall rule chain. Array order determines rule positions.", "example": { "firewall_rules": { "firewall_rule": [ { "action": "accept", "comment": "Allow SSH", "destination_port_end": "22", "destination_port_start": "22", "direction": "in", "family": "IPv4", "protocol": "tcp" }, { "action": "drop", "direction": "in" } ] } } }, "serverFirewallRuleItem": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "allOf": [ { "$ref": "#/components/schemas/serverFirewallRuleRequirements" } ], "properties": { "action": { "type": "string", "enum": [ "accept", "drop" ], "description": "Action taken when the rule matches." }, "comment": { "type": "string", "maxLength": 250, "description": "Free-form rule description." }, "destination_address_end": { "type": "string", "description": "Last destination IP address in the range. Must be specified with destination_address_start." }, "destination_address_start": { "type": "string", "description": "First destination IP address in the range. Must be specified with destination_address_end." }, "destination_port_end": { "$ref": "#/components/schemas/serverFirewallRulePort" }, "destination_port_start": { "$ref": "#/components/schemas/serverFirewallRulePort" }, "direction": { "type": "string", "enum": [ "in", "out" ], "description": "Traffic direction to which the rule applies." }, "family": { "type": "string", "enum": [ "IPv4", "IPv6" ], "description": "IP address family. Required when protocol, addresses, ports, or ICMP type are specified." }, "icmp_type": { "$ref": "#/components/schemas/serverFirewallRuleIcmpType" }, "protocol": { "type": "string", "enum": [ "tcp", "udp", "icmp" ], "description": "Network protocol to match." }, "source_address_end": { "type": "string", "description": "Last source IP address in the range. Must be specified with source_address_start." }, "source_address_start": { "type": "string", "description": "First source IP address in the range. Must be specified with source_address_end." }, "source_port_end": { "$ref": "#/components/schemas/serverFirewallRulePort" }, "source_port_start": { "$ref": "#/components/schemas/serverFirewallRulePort" } }, "required": [ "action", "direction" ], "additionalProperties": false, "description": "Firewall rule conditions and action." }, "serverFirewallRuleRequirements": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "allOf": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ] }, "serverFirewallRulePort": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^(?:[1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$" }, "serverFirewallRuleIcmpType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^(?:[0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$" }, "serverCreateFirewallRule": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "firewall_rule": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/serverFirewallRuleRequirements" } ], "properties": { "action": { "type": "string", "enum": [ "accept", "drop" ], "description": "Action taken when the rule matches." }, "comment": { "type": "string", "maxLength": 250, "description": "Free-form rule description." }, "destination_address_end": { "type": "string", "description": "Last destination IP address in the range. Must be specified with destination_address_start." }, "destination_address_start": { "type": "string", "description": "First destination IP address in the range. Must be specified with destination_address_end." }, "destination_port_end": { "$ref": "#/components/schemas/serverFirewallRulePort" }, "destination_port_start": { "$ref": "#/components/schemas/serverFirewallRulePort" }, "direction": { "type": "string", "enum": [ "in", "out" ], "description": "Traffic direction to which the rule applies." }, "family": { "type": "string", "enum": [ "IPv4", "IPv6" ], "description": "IP address family. Required when protocol, addresses, ports, or ICMP type are specified." }, "icmp_type": { "$ref": "#/components/schemas/serverFirewallRuleIcmpType" }, "position": { "type": "string", "pattern": "^(?:[1-9]|[1-9][0-9]{1,2}|1000)$", "description": "Position at which to insert the rule. Rules at and after this position are shifted down. If omitted or greater than the current rule count, the rule is appended." }, "protocol": { "type": "string", "enum": [ "tcp", "udp", "icmp" ], "description": "Network protocol to match." }, "source_address_end": { "type": "string", "description": "Last source IP address in the range. Must be specified with source_address_start." }, "source_address_start": { "type": "string", "description": "First source IP address in the range. Must be specified with source_address_end." }, "source_port_end": { "$ref": "#/components/schemas/serverFirewallRulePort" }, "source_port_start": { "$ref": "#/components/schemas/serverFirewallRulePort" } }, "required": [ "action", "direction" ], "additionalProperties": false } }, "required": [ "firewall_rule" ], "additionalProperties": false, "description": "Parameters for creating a firewall rule.", "example": { "firewall_rule": { "action": "accept", "comment": "Allow SSH from the office network", "destination_port_end": "22", "destination_port_start": "22", "direction": "in", "family": "IPv4", "position": "1", "protocol": "tcp", "source_address_end": "192.0.2.255", "source_address_start": "192.0.2.1" } } }, "serverAddInterface": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "interface": { "type": "object", "properties": { "bootable": { "$ref": "#/components/schemas/serverBooleanYesno" }, "index": { "type": "integer", "maximum": 255, "minimum": 1, "format": "int32", "description": "Interface index; the next available index is used when omitted" }, "ip_addresses": { "type": "object", "properties": { "ip_address": { "type": "array", "items": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/serverIpAddress" }, "dhcp_provided": { "$ref": "#/components/schemas/serverBooleanYesno" }, "family": { "$ref": "#/components/schemas/serverIpFamily" }, "release_policy": { "$ref": "#/components/schemas/serverIpReleasePolicy" } }, "required": [ "family" ] } } }, "required": [ "ip_address" ], "description": "IP addresses to attach to the interface" }, "network": { "$ref": "#/components/schemas/serverUuid" }, "source_ip_filtering": { "$ref": "#/components/schemas/serverBooleanYesno" }, "type": { "$ref": "#/components/schemas/serverNetworkType" } }, "required": [ "type", "ip_addresses" ], "additionalProperties": false } }, "required": [ "interface" ], "additionalProperties": false, "description": "Add network interface request", "example": { "interface": { "ip_addresses": { "ip_address": [ { "address": "10.0.0.20", "dhcp_provided": "yes", "family": "IPv4" } ] }, "network": "0374ce47-4303-4490-987d-32dc96cfd79b", "source_ip_filtering": "yes", "type": "private" } } }, "serverIpReleasePolicy": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "release", "keep" ], "description": "Action taken when the resource using the address is deleted: release deletes the address, while keep preserves it as a detached floating IP address", "example": "release" }, "serverModifyInterface": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "interface": { "type": "object", "properties": { "bootable": { "$ref": "#/components/schemas/serverBooleanYesno" }, "index": { "type": "integer", "maximum": 255, "minimum": 1, "format": "int32", "description": "New index for the interface; defaults to the index in the request path" }, "ip_addresses": { "type": "object", "properties": { "ip_address": { "type": "array", "items": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/serverIpAddress" }, "dhcp_provided": { "$ref": "#/components/schemas/serverBooleanYesno" }, "family": { "$ref": "#/components/schemas/serverIpFamily" } }, "required": [ "family" ] } } }, "required": [ "ip_address" ], "description": "Complete replacement list of IP addresses for the interface" }, "source_ip_filtering": { "$ref": "#/components/schemas/serverBooleanYesno" } }, "minProperties": 1, "additionalProperties": false } }, "required": [ "interface" ], "additionalProperties": false, "description": "Modify network interface request", "example": { "interface": { "bootable": "yes", "index": 5, "source_ip_filtering": "no" } } }, "serverAddIpAddress": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ip_address": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/serverIpAddress" }, "family": { "$ref": "#/components/schemas/serverIpFamily" } }, "required": [ "family" ], "additionalProperties": false } }, "required": [ "ip_address" ], "additionalProperties": false, "description": "Add IP address to a network interface request", "example": { "ip_address": { "address": "10.0.0.30", "family": "IPv4" } } }, "serverReason": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "maxLength": 200, "minLength": 1, "description": "Schema for reason strings used in API payloads." }, "serverAttachStorage": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "storage_device": { "type": "object", "allOf": [ {} ], "properties": { "address": { "type": "string", "pattern": "^(?:ide(?::[01]:[01])?|scsi(?::0:(?:[0-9]|1[0-5]))?|virtio(?::(?:[0-9]|1[0-5]))?)$", "description": "Device address or bus. When only a bus is specified, the next available address on that bus is selected. Defaults to the next available virtio address for disks and IDE address for CD-ROM devices." }, "boot_disk": { "allOf": [ { "$ref": "#/components/schemas/serverBoolean01" } ], "description": "Whether to use this storage device as the boot disk. The Cloud Server boot_order setting takes precedence.", "default": 0 }, "storage": { "$ref": "#/components/schemas/serverUuid" }, "type": { "type": "string", "enum": [ "disk", "cdrom" ], "description": "Type of device to attach.", "default": "disk" } }, "additionalProperties": false, "description": "Storage device to attach." } }, "required": [ "storage_device" ], "additionalProperties": false, "description": "Parameters for attaching a storage device to a Cloud Server.", "example": { "storage_device": { "address": "virtio:0", "boot_disk": 1, "storage": "012580a1-32a1-466e-a323-689ca16f2d43", "type": "disk" } } }, "serverDetachStorage": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "storage_device": { "type": "object", "anyOf": [ { "required": [ "address" ] }, { "required": [ "storage" ] } ], "properties": { "address": { "type": "string", "pattern": "^(?:ide:[01]:[01]|scsi:0:(?:[0-9]|1[0-5])|virtio:(?:[0-9]|1[0-5]))$", "description": "Address of the storage device on the Cloud Server." }, "storage": { "$ref": "#/components/schemas/serverUuid" } }, "additionalProperties": false, "description": "Storage device to detach, identified by either its device address or storage resource UUID." } }, "required": [ "storage_device" ], "additionalProperties": false, "description": "Parameters for detaching a storage device from a Cloud Server.", "example": { "storage_device": { "address": "virtio:0" } } }, "serverCreated": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "minimum": 0, "format": "int64", "description": "Creation timestamp (Unix epoch time)", "example": 1705320000 }, "serverPlanName": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "1xCPU-1GB", "DEV-1xCPU-4GB", "CLOUDNATIVE-1xCPU-8GB", "GPU-12xCPU-128GB-2xL40S" ], "maxLength": 255, "minLength": 1, "description": "Server plan identifier" }, "serverError400": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "examples": [ "SERVER_INVALID" ] }, "message": { "type": "string", "examples": [ "The server UUID is invalid" ] } }, "required": [ "code", "message" ] } }, "required": [ "error" ], "description": "Bad request error", "example": { "error": { "code": "REQUEST_INVALID", "message": "Invalid request parameters or malformed request body" } } }, "serverError403": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "examples": [ "SERVER_FORBIDDEN" ] }, "message": { "type": "string", "examples": [ "Access denied or insufficient permissions" ] } }, "required": [ "code", "message" ] } }, "required": [ "error" ], "description": "Forbidden error", "example": { "error": { "code": "SERVER_FORBIDDEN", "message": "Access denied or insufficient permissions" } } }, "serverError404": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "examples": [ "SERVER_NOT_FOUND" ] }, "message": { "type": "string", "examples": [ "The server UUID does not exist" ] } }, "required": [ "code", "message" ] } }, "required": [ "error" ], "description": "Schema for Cloud Server 404 error responses.", "example": { "error": { "code": "SERVER_NOT_FOUND", "message": "The server 007bf7bd-e3cf-4a10-bf01-4251dc7f3b65 does not exist." } } }, "serverError409": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "examples": [ "SERVER_STATE_ILLEGAL" ] }, "message": { "type": "string", "examples": [ "The server is in a state in which it cannot be used" ] } }, "required": [ "code", "message" ] } }, "required": [ "error" ], "description": "Conflict error", "example": { "error": { "code": "SERVER_STATE_ILLEGAL", "message": "The server is in a state in which it cannot be used" } } }, "serverError": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "examples": [ "GENERAL_FAILURE" ] }, "error_message": { "type": "string", "examples": [ "Your request could not be fulfilled due to a technical issue." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "A general error response indicating that the request could not be fulfilled due to a technical issue." }, "serverDevice": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "serial": { "type": "string" }, "type": { "type": "string" }, "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "serial": { "type": "string" }, "memory": { "$ref": "#/components/schemas/serverMemoryAmount" }, "cores": { "$ref": "#/components/schemas/serverCoreNumber" } }, "required": [ "serial", "memory", "cores" ] } }, "required": [ "serial", "type", "model", "metadata" ], "additionalProperties": false, "description": "Schema for passthrough device information.", "example": { "serial": "1723925007011", "type": "gpu", "model": "NVIDIA L40S", "metadata": { "serial": "1723925007011", "memory": 48, "cores": 18176 } } }, "serverNetworking": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "interfaces": { "type": "object", "properties": { "interface": { "type": "array", "items": { "$ref": "#/components/schemas/serverInterface" }, "description": "Network interfaces ordered by interface index" } }, "required": [ "interface" ], "description": "Network interfaces attached to the Cloud Server" } }, "description": "Network interfaces configured for the Cloud Server", "example": { "interfaces": { "interface": [ { "bootable": "no", "index": 4, "ip_addresses": { "ip_address": [ { "address": "10.0.0.20", "dhcp_provided": "yes", "family": "IPv4", "floating": "no", "release_policy": "release" } ] }, "mac": "de:ff:ff:ff:cc:20", "network": "0374ce47-4303-4490-987d-32dc96cfd79b", "source_ip_filtering": "yes", "type": "private" } ] } } }, "serverInterface": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "bootable": { "$ref": "#/components/schemas/serverBooleanYesno" }, "index": { "type": "integer", "maximum": 255, "minimum": 0, "format": "int32", "description": "Index that identifies and orders the interface" }, "ip_addresses": { "type": "object", "properties": { "ip_address": { "type": "array", "items": { "$ref": "#/components/schemas/serverInterfaceIpAddress" } } }, "required": [ "ip_address" ], "description": "IP addresses attached to the interface" }, "mac": { "$ref": "#/components/schemas/serverMacAddress" }, "network": { "$ref": "#/components/schemas/serverUuid" }, "source_ip_filtering": { "$ref": "#/components/schemas/serverBooleanYesno" }, "type": { "$ref": "#/components/schemas/serverNetworkType" } }, "required": [ "network" ], "description": "Network interface attached to a Cloud Server", "example": { "bootable": "no", "index": 4, "ip_addresses": { "ip_address": [ { "address": "10.0.0.20", "dhcp_provided": "yes", "family": "IPv4", "floating": "no", "release_policy": "release" } ] }, "mac": "de:ff:ff:ff:cc:20", "network": "0374ce47-4303-4490-987d-32dc96cfd79b", "source_ip_filtering": "yes", "type": "private" } }, "serverInterfaceIpAddress": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "address": { "$ref": "#/components/schemas/serverIpAddress" }, "dhcp_provided": { "$ref": "#/components/schemas/serverBooleanYesno" }, "family": { "$ref": "#/components/schemas/serverIpFamily" }, "floating": { "$ref": "#/components/schemas/serverBooleanYesno" }, "release_policy": { "$ref": "#/components/schemas/serverIpReleasePolicy" } }, "required": [ "address", "family" ], "description": "Network interface IP address", "example": { "address": "10.0.0.20", "dhcp_provided": "yes", "family": "IPv4", "floating": "no", "release_policy": "release" } }, "serverMacAddress": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^([0-9A-Fa-f]{2}:){5}([0-9A-Fa-f]{2})$", "description": "MAC address", "example": "de:ff:ff:ff:cc:20" }, "serverStorageDevicesResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "storage_device": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Device address on the Cloud Server." }, "boot_disk": { "type": "string", "enum": [ "0", "1" ], "description": "Whether this device is the Cloud Server's boot disk, encoded as 0 or 1." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/serverLabel" }, "description": "Labels assigned to the storage resource." }, "part_of_plan": { "$ref": "#/components/schemas/serverBooleanYesno" }, "storage": { "type": "string", "description": "Storage resource UUID. Empty for an unloaded CD-ROM device." }, "storage_encrypted": { "$ref": "#/components/schemas/serverBooleanYesno" }, "storage_size": { "type": "integer", "description": "Storage resource size in gibibytes." }, "storage_tier": { "type": "string", "description": "Storage resource performance tier." }, "storage_title": { "type": "string", "description": "Storage resource title." }, "type": { "type": "string", "enum": [ "disk", "cdrom" ], "description": "Attached device type." } }, "required": [ "address", "boot_disk", "labels", "storage", "storage_encrypted", "storage_size", "storage_title", "type" ], "additionalProperties": false } } }, "required": [ "storage_device" ], "additionalProperties": false, "description": "Storage devices attached to a Cloud Server", "example": { "storage_device": [ { "address": "virtio:0", "boot_disk": "1", "labels": [], "storage": "012580a1-32a1-466e-a323-689ca16f2d43", "storage_encrypted": "yes", "storage_size": 20, "storage_title": "Operating system disk", "type": "disk" } ] } }, "serverUserName": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "maxLength": 64, "minLength": 4, "description": "Username for an account." }, "serverFirewallRulesetRelationshipInternal": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "applied_version": { "type": [ "integer", "null" ] }, "created_at": { "type": "integer" }, "firewall_ruleset_uuid": { "$ref": "#/components/schemas/serverUuid" }, "last_applied_at": { "type": [ "integer", "null" ] }, "server_uuid": { "$ref": "#/components/schemas/serverUuid" }, "type": { "type": "string", "enum": [ "public", "private" ] }, "updated_at": { "type": [ "integer", "null" ] }, "version": { "type": "integer" } }, "required": [ "server_uuid", "firewall_ruleset_uuid", "type", "version", "created_at", "updated_at", "last_applied_at", "applied_version" ], "additionalProperties": false, "description": "Firewall ruleset relationship with Unix timestamps." }, "serverFirewallRulesetRelationship": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "firewall_ruleset_uuid": { "$ref": "#/components/schemas/serverUuid" }, "server_uuid": { "$ref": "#/components/schemas/serverUuid" }, "type": { "type": "string", "enum": [ "public", "private" ], "description": "Network interface class to which the ruleset applies." } }, "required": [ "server_uuid", "firewall_ruleset_uuid", "type" ], "additionalProperties": false, "description": "Relationship between a Cloud Server and a firewall ruleset.", "example": { "firewall_ruleset_uuid": "190f56d8-4b3f-4a89-9e5f-320fbc3d17c8", "server_uuid": "0077fa3d-32db-4b09-9f5f-30d9e9afb565", "type": "private" } }, "serverError511": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "Operation failed error", "example": { "error": { "code": "HOTPLUG_FAILED", "message": "The detach failed while the Cloud Server was started. Please stop the Cloud Server and try again." } } }, "serverFirewallRules": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "firewall_rules": { "type": "object", "properties": { "firewall_rule": { "type": "array", "items": { "$ref": "#/components/schemas/serverFirewallRuleResponseItem" } } }, "required": [ "firewall_rule" ], "additionalProperties": false } }, "required": [ "firewall_rules" ], "additionalProperties": false, "description": "Ordered firewall rules configured for a Cloud Server.", "example": { "firewall_rules": { "firewall_rule": [ { "action": "accept", "comment": "Allow SSH from the office network", "destination_address_end": "", "destination_address_start": "", "destination_port_end": "22", "destination_port_start": "22", "direction": "in", "family": "IPv4", "icmp_type": "", "position": "1", "protocol": "tcp", "source_address_end": "192.0.2.255", "source_address_start": "192.0.2.1", "source_port_end": "", "source_port_start": "" } ] } } }, "serverFirewallRuleResponseItem": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "action": { "type": "string", "enum": [ "accept", "drop" ], "description": "Action taken when the rule matches." }, "comment": { "type": "string", "description": "Free-form rule description." }, "destination_address_end": { "type": "string", "description": "Last destination IP address in the matched range, or an empty string when unrestricted." }, "destination_address_start": { "type": "string", "description": "First destination IP address in the matched range, or an empty string when unrestricted." }, "destination_port_end": { "type": "string", "description": "Last destination port in the matched range, or an empty string when unrestricted." }, "destination_port_start": { "type": "string", "description": "First destination port in the matched range, or an empty string when unrestricted." }, "direction": { "type": "string", "enum": [ "in", "out" ], "description": "Traffic direction to which the rule applies." }, "family": { "type": "string", "enum": [ "IPv4", "IPv6", "" ], "description": "IP address family, or an empty string when unrestricted." }, "icmp_type": { "type": "string", "description": "ICMP packet type, or an empty string when unrestricted." }, "position": { "type": "string", "pattern": "^(?:[1-9]|[1-9][0-9]{1,2}|1000)$", "description": "One-based position in the Cloud Server's firewall rule chain." }, "protocol": { "type": "string", "enum": [ "tcp", "udp", "icmp", "" ], "description": "Matched network protocol, or an empty string when unrestricted." }, "source_address_end": { "type": "string", "description": "Last source IP address in the matched range, or an empty string when unrestricted." }, "source_address_start": { "type": "string", "description": "First source IP address in the matched range, or an empty string when unrestricted." }, "source_port_end": { "type": "string", "description": "Last source port in the matched range, or an empty string when unrestricted." }, "source_port_start": { "type": "string", "description": "First source port in the matched range, or an empty string when unrestricted." } }, "required": [ "action", "comment", "destination_address_end", "destination_address_start", "destination_port_end", "destination_port_start", "direction", "family", "icmp_type", "position", "protocol", "source_address_end", "source_address_start", "source_port_end", "source_port_start" ], "additionalProperties": false, "description": "A firewall rule with its position in the Cloud Server's rule chain." }, "serverFirewallRule": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "firewall_rule": { "$ref": "#/components/schemas/serverFirewallRuleResponseItem" } }, "required": [ "firewall_rule" ], "additionalProperties": false, "description": "A firewall rule with its position in the Cloud Server's rule chain.", "example": { "firewall_rule": { "action": "accept", "comment": "Allow SSH from the office network", "destination_address_end": "", "destination_address_start": "", "destination_port_end": "22", "destination_port_start": "22", "direction": "in", "family": "IPv4", "icmp_type": "", "position": "1", "protocol": "tcp", "source_address_end": "192.0.2.255", "source_address_start": "192.0.2.1", "source_port_end": "", "source_port_start": "" } } }, "serverFirewallRulesetRelationships": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "firewall_ruleset_relationships": { "type": "object", "properties": { "private": { "type": "array", "items": { "$ref": "#/components/schemas/serverFirewallRulesetRelationshipDetails" }, "description": "Private firewall rulesets attached to the Cloud Server." } }, "required": [ "private" ], "additionalProperties": false } }, "required": [ "firewall_ruleset_relationships" ], "additionalProperties": false, "description": "Private firewall ruleset relationships for a Cloud Server.", "example": { "firewall_ruleset_relationships": { "private": [ { "applied_version": 3, "created_at": "2026-08-25T10:15:30Z", "firewall_ruleset_uuid": "190f56d8-4b3f-4a89-9e5f-320fbc3d17c8", "last_applied_at": "2026-08-25T10:15:32Z", "server_uuid": "0077fa3d-32db-4b09-9f5f-30d9e9afb565", "type": "private", "updated_at": null, "version": 3 } ] } } }, "serverFirewallRulesetRelationshipDetails": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "applied_version": { "type": [ "integer", "null" ], "description": "Ruleset version most recently applied to the Cloud Server." }, "created_at": { "$ref": "#/components/schemas/serverRfc3339Datetime" }, "firewall_ruleset_uuid": { "$ref": "#/components/schemas/serverUuid" }, "last_applied_at": { "oneOf": [ { "$ref": "#/components/schemas/serverRfc3339Datetime" }, { "type": "null" } ], "description": "Time when this ruleset was last applied, or null if it has not been applied." }, "server_uuid": { "$ref": "#/components/schemas/serverUuid" }, "type": { "type": "string", "description": "Network interface class to which the ruleset applies.", "const": "private" }, "updated_at": { "oneOf": [ { "$ref": "#/components/schemas/serverRfc3339Datetime" }, { "type": "null" } ], "description": "Time when the relationship was last updated, or null if it has not been updated." }, "version": { "type": "integer", "description": "Ruleset version selected for the relationship." } }, "required": [ "server_uuid", "firewall_ruleset_uuid", "type", "version", "created_at", "updated_at", "last_applied_at", "applied_version" ], "additionalProperties": false, "description": "Detailed private firewall ruleset relationship for a Cloud Server.", "example": { "applied_version": 3, "created_at": "2026-08-25T10:15:30Z", "firewall_ruleset_uuid": "190f56d8-4b3f-4a89-9e5f-320fbc3d17c8", "last_applied_at": "2026-08-25T10:15:32Z", "server_uuid": "0077fa3d-32db-4b09-9f5f-30d9e9afb565", "type": "private", "updated_at": null, "version": 3 } }, "serverRfc3339Datetime": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "2026-07-01T00:00:00Z", "2026-07-31T23:59:59Z" ], "format": "date-time", "description": "Datetime in RFC 3339 format" }, "serverGpus": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "gpus": { "type": "array", "items": { "type": "object", "properties": { "firmware": { "type": [ "string", "null" ], "description": "Firmware version of the GPU" }, "serial": { "type": [ "string", "null" ], "description": "Serial number of the GPU" }, "part": { "type": [ "string", "null" ], "description": "Part number of the GPU" }, "model": { "type": "string", "description": "Model name of the GPU" }, "memory_gib": { "type": [ "integer", "null" ], "format": "int32", "description": "Memory size of the GPU in GiB" }, "cores": { "type": [ "integer", "null" ], "format": "int32", "description": "Number of processing cores in the GPU" } }, "required": [ "model" ], "additionalProperties": false } } }, "required": [ "gpus" ], "additionalProperties": false, "description": "GPUs attached to a Cloud Server. The array is empty when no GPUs are attached.", "example": { "gpus": [ { "cores": 5888, "firmware": "92.00.18.00.01", "memory_gib": 24, "model": "NVIDIA RTX A5000", "part": "900-5G132-2500-000", "serial": "GPU-01234567" } ] } }, "serverNetworkingResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "networking": { "$ref": "#/components/schemas/serverNetworking" } }, "required": [ "networking" ], "description": "Cloud Server networking response", "example": { "networking": { "interfaces": { "interface": [ { "bootable": "no", "index": 4, "ip_addresses": { "ip_address": [ { "address": "10.0.0.20", "dhcp_provided": "yes", "family": "IPv4", "floating": "no", "release_policy": "release" } ] }, "mac": "de:ff:ff:ff:cc:20", "network": "0374ce47-4303-4490-987d-32dc96cfd79b", "source_ip_filtering": "yes", "type": "private" } ] } } } }, "serverInterfaceResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "interface": { "$ref": "#/components/schemas/serverInterface" } }, "required": [ "interface" ], "description": "Network interface response", "example": { "interface": { "bootable": "no", "index": 4, "ip_addresses": { "ip_address": [ { "address": "10.0.0.20", "dhcp_provided": "yes", "family": "IPv4", "floating": "no", "release_policy": "release" } ] }, "mac": "de:ff:ff:ff:cc:20", "network": "0374ce47-4303-4490-987d-32dc96cfd79b", "source_ip_filtering": "yes", "type": "private" } } }, "serverIpAddressInterfaceResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "ip_address": { "$ref": "#/components/schemas/serverInterfaceIpAddress" } }, "required": [ "ip_address" ], "description": "IP address response for a network interface", "example": { "ip_address": { "address": "10.0.0.30", "dhcp_provided": "no", "family": "IPv4" } } }, "serverVncHost": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "description": "VNC host IP address or noVNC proxy hostname. Empty when no VNC endpoint is assigned.", "example": "94.237.1.20" }, "serverVncPort": { "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "type": "integer", "maximum": 65535, "minimum": 1, "format": "int32" }, { "type": "string", "const": "" } ], "description": "VNC or noVNC proxy port. Empty when no VNC endpoint is assigned.", "example": 5901 }, "serverRemoteAccessDetails": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "server": { "type": "object", "properties": { "state": { "$ref": "#/components/schemas/serverState" }, "vnc_host": { "$ref": "#/components/schemas/serverVncHost" }, "vnc_password": { "$ref": "#/components/schemas/serverVncPassword" }, "vnc_port": { "$ref": "#/components/schemas/serverVncPort" }, "remote_access_type": { "$ref": "#/components/schemas/serverRemoteAccessType" }, "remote_access_enabled": { "$ref": "#/components/schemas/serverRemoteAccessEnabled" }, "remote_access_password": { "$ref": "#/components/schemas/serverRemoteAccessPassword" } }, "required": [ "state", "vnc_host", "vnc_password", "vnc_port", "remote_access_type", "remote_access_enabled", "remote_access_password" ], "additionalProperties": false } }, "required": [ "server" ], "additionalProperties": false, "description": "Remote access settings and VNC connection details for a Cloud Server", "example": { "server": { "remote_access_enabled": "yes", "remote_access_password": "A1b2C3d4", "remote_access_type": "vnc", "state": "started", "vnc_host": "94.237.1.20", "vnc_password": "A1b2C3d4", "vnc_port": 5901 } } }, "serverVncPassword": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "maxLength": 8, "minLength": 8, "pattern": "^[A-Za-z0-9]{8}$", "description": "VNC password", "example": "A1b2C3d4" }, "serverCpuStats": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "stats": { "type": "object", "properties": { "daily": { "type": "object", "properties": { "summary": { "$ref": "#/components/schemas/serverCpuStatsSummary" } }, "required": [ "summary" ] }, "monthly": { "type": "object", "properties": { "summary": { "$ref": "#/components/schemas/serverCpuStatsSummary" } }, "required": [ "summary" ] }, "yearly": { "type": "object", "properties": { "summary": { "$ref": "#/components/schemas/serverCpuStatsSummary" } }, "required": [ "summary" ] }, "weekly": { "type": "object", "properties": { "summary": { "$ref": "#/components/schemas/serverCpuStatsSummary" } }, "required": [ "summary" ] } }, "minProperties": 1, "additionalProperties": false } }, "required": [ "stats" ], "additionalProperties": false, "description": "CPU usage statistics grouped by period", "example": { "stats": { "daily": { "summary": { "variable": [ { "average": "12 %", "current": "8 %", "maximum": "37 %", "title": "CPU usage %", "total": "51 seconds" } ] } } } } }, "serverCpuStatsSummary": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "variable": { "type": "array", "items": { "type": "object", "properties": { "average": { "type": "string", "description": "Average CPU usage during the period." }, "current": { "type": "string", "description": "Most recent CPU usage." }, "title": { "type": "string", "const": "CPU usage %" }, "maximum": { "type": "string", "description": "Maximum CPU usage during the period." }, "total": { "type": "string", "description": "Total CPU time consumed during the period." } }, "required": [ "average", "current", "title", "maximum", "total" ], "additionalProperties": false } } }, "required": [ "variable" ], "additionalProperties": false, "description": "Summarized CPU statistics values.", "example": { "variable": [ { "average": "12 %", "current": "8 %", "maximum": "37 %", "title": "CPU usage %", "total": "51 seconds" } ] } }, "serverDiskStats": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "stats": { "type": "object", "properties": { "daily": { "type": "object", "properties": { "summary": { "$ref": "#/components/schemas/serverDiskStatsSummary" } }, "required": [ "summary" ] }, "monthly": { "type": "object", "properties": { "summary": { "$ref": "#/components/schemas/serverDiskStatsSummary" } }, "required": [ "summary" ] }, "yearly": { "type": "object", "properties": { "summary": { "$ref": "#/components/schemas/serverDiskStatsSummary" } }, "required": [ "summary" ] }, "weekly": { "type": "object", "properties": { "summary": { "$ref": "#/components/schemas/serverDiskStatsSummary" } }, "required": [ "summary" ] } }, "minProperties": 1, "additionalProperties": false } }, "required": [ "stats" ], "additionalProperties": false, "description": "Aggregate disk read and write statistics grouped by period", "example": { "stats": { "daily": { "summary": { "variable": [ { "average": "1.5 MiBps", "current": "2.0 MiBps", "maximum": "4.0 MiBps", "title": "Read", "total": "8.0 GiB" } ] } } } } }, "serverDiskStatsSummary": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "variable": { "type": "array", "items": { "type": "object", "properties": { "average": { "type": "string", "description": "Average transfer rate or request rate during the period." }, "current": { "type": "string", "description": "Most recent transfer rate or request rate." }, "title": { "type": "string", "enum": [ "Read", "Write" ] }, "maximum": { "type": "string", "description": "Maximum transfer rate or request rate during the period." }, "total": { "type": "string", "description": "Total transferred data or I/O requests during the period." } }, "required": [ "average", "current", "title", "maximum", "total" ], "additionalProperties": false } } }, "required": [ "variable" ], "additionalProperties": false, "description": "Summarized disk read and write statistics values.", "example": { "variable": [ { "average": "1.5 MiBps", "current": "2.0 MiBps", "maximum": "4.0 MiBps", "title": "Read", "total": "8.0 GiB" } ] } }, "serverNetworkStats": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "stats": { "type": "object", "properties": { "daily": { "type": "object", "properties": { "summary": { "$ref": "#/components/schemas/serverNetworkStatsSummary" } }, "required": [ "summary" ] }, "monthly": { "type": "object", "properties": { "summary": { "$ref": "#/components/schemas/serverNetworkStatsSummary" } }, "required": [ "summary" ] }, "yearly": { "type": "object", "properties": { "summary": { "$ref": "#/components/schemas/serverNetworkStatsSummary" } }, "required": [ "summary" ] }, "weekly": { "type": "object", "properties": { "summary": { "$ref": "#/components/schemas/serverNetworkStatsSummary" } }, "required": [ "summary" ] } }, "minProperties": 1, "additionalProperties": false } }, "required": [ "stats" ], "additionalProperties": false, "description": "Aggregate inbound and outbound network statistics grouped by period", "example": { "stats": { "daily": { "summary": { "variable": [ { "average": "12 Mbps", "current": "8.5 Mbps", "maximum": "24 Mbps", "title": "In", "total": "8.0 GiB" } ] } } } } }, "serverNetworkStatsSummary": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "variable": { "type": "array", "items": { "type": "object", "properties": { "average": { "type": "string", "description": "Average bit rate or packet rate during the period." }, "current": { "type": "string", "description": "Most recent bit rate or packet rate." }, "title": { "type": "string", "enum": [ "In", "Out" ] }, "maximum": { "type": "string", "description": "Maximum bit rate or packet rate during the period." }, "total": { "type": "string", "description": "Total transferred data or packets during the period." } }, "required": [ "average", "current", "title", "maximum", "total" ], "additionalProperties": false } } }, "required": [ "variable" ], "additionalProperties": false, "description": "Summarized inbound and outbound network statistics values.", "example": { "variable": [ { "average": "12 Mbps", "current": "8.5 Mbps", "maximum": "24 Mbps", "title": "In", "total": "8.0 GiB" } ] } }, "serverSizes": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "server_sizes": { "type": "object", "properties": { "server_size": { "type": "array", "items": { "type": "object", "properties": { "core_number": { "type": "string", "pattern": "^[0-9]+$", "description": "Number of CPU cores" }, "memory_amount": { "type": "string", "pattern": "^[0-9]+$", "description": "Amount of memory in MB" } }, "required": [ "core_number", "memory_amount" ], "additionalProperties": false }, "example": [ { "core_number": "2", "memory_amount": "4096" } ] } }, "required": [ "server_size" ], "additionalProperties": false, "example": { "server_size": [ { "core_number": "2", "memory_amount": "4096" } ] } } }, "required": [ "server_sizes" ], "additionalProperties": false, "description": "List of server sizes", "example": { "server_sizes": { "server_size": [ { "core_number": "2", "memory_amount": "4096" }, { "core_number": "4", "memory_amount": "8192" } ] } } }, "serverSizeLimits": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "server_size_limits": { "type": "object", "properties": { "core_number_min": { "type": "integer", "minimum": 1, "format": "int64", "description": "Minimum number of CPU cores" }, "core_number_max": { "type": "integer", "maximum": 64, "minimum": 1, "format": "int64", "description": "Maximum number of CPU cores" }, "memory_amount_min": { "type": "integer", "maximum": 524288, "minimum": 1024, "format": "int64", "description": "Minimum amount of memory in MB" }, "memory_amount_max": { "type": "integer", "maximum": 524288, "minimum": 1024, "format": "int64", "description": "Maximum amount of memory in MB" }, "memory_amount_step": { "type": "integer", "minimum": 1024, "format": "int64", "description": "Step size for memory allocation in MB" } }, "required": [ "core_number_min", "core_number_max", "memory_amount_min", "memory_amount_max", "memory_amount_step" ], "additionalProperties": false, "example": { "core_number_min": 1, "core_number_max": 64, "memory_amount_min": 1024, "memory_amount_max": 524288, "memory_amount_step": 1024 } } }, "required": [ "server_size_limits" ], "additionalProperties": false, "description": "Schema for server size limits", "example": { "server_size_limits": { "core_number_min": 1, "core_number_max": 64, "memory_amount_min": 1024, "memory_amount_max": 524288, "memory_amount_step": 1024 } } }, "serverSizeError": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "examples": [ "GENERAL_FAILURE" ] }, "error_message": { "type": "string", "examples": [ "Your request could not be fulfilled due to a technical issue." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "A general error response indicating that the request could not be fulfilled due to a technical issue." }, "createStorageRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "storage": { "type": "object", "properties": { "backup_rule": { "oneOf": [ { "$ref": "#/components/schemas/storageBackupRule" }, { "type": "object" } ], "description": "Schedule for automatic backups. An empty object disables automatic backups." }, "encrypted": { "$ref": "#/components/schemas/storageEncrypted" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/storageLabel" }, "description": "Labels describing and classifying the block storage. Each label contains a key and a value." }, "size": { "oneOf": [ { "type": "integer", "maximum": 4096, "minimum": 1 }, { "type": "string", "pattern": "^(?:[1-9]|[1-9][0-9]{1,2}|[1-3][0-9]{3}|40(?:[0-8][0-9]|9[0-6]))$" } ], "examples": [ 100, "100" ], "description": "Size of the block storage in gigabytes, from 1 through 4096 subject to the account's block storage limits." }, "tier": { "$ref": "#/components/schemas/storageTier" }, "title": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": "^[^<>]*$", "description": "A short, informational description of the block storage." }, "zone": { "$ref": "#/components/schemas/storageZone" } }, "required": [ "zone", "size", "title" ], "additionalProperties": false, "description": "Block storage creation parameters." } }, "required": [ "storage" ], "additionalProperties": false, "description": "Request schema for creating block storage.", "example": { "storage": { "backup_rule": { "interval": "daily", "retention": "7", "time": "0400" }, "encrypted": "yes", "labels": [ { "key": "environment", "value": "production" } ], "size": 50, "tier": "maxiops", "title": "Block Storage 1", "zone": "fi-hel1" } } }, "modifyStorageBody": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "storage": { "type": "object", "properties": { "backup_rule": { "oneOf": [ { "$ref": "#/components/schemas/storageBackupRule" }, { "type": "object" } ], "description": "Schedule for automatic backups of the block storage. An empty object removes the configured schedule." }, "filesystem_resize": { "type": "string", "enum": [ "yes", "no" ], "description": "Set to `yes` when increasing `size` to also resize the last partition and its supported filesystem. The attached Cloud Server, if any, must be stopped." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/storageLabel" }, "description": "Labels describing and classifying the block storage. Each label contains a key and a value." }, "size": { "oneOf": [ { "type": "integer", "maximum": 4096, "minimum": 1 }, { "type": "string", "pattern": "^(?:[1-9]|[1-9][0-9]{1,2}|[1-3][0-9]{3}|40(?:[0-8][0-9]|9[0-6]))$" } ], "examples": [ 100, "100" ], "description": "New block storage size in gigabytes, from 1 through 4096 subject to the account's block storage limits. The new size must be greater than the current size." }, "title": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": "^[^<>]*$", "description": "A short, informational description of the block storage." } }, "additionalProperties": false, "description": "Block storage properties to modify." } }, "required": [ "storage" ], "additionalProperties": false, "description": "Request schema for modifying block storage properties.", "example": { "storage": { "size": 100, "title": "Production data expanded" } } }, "attachStorageRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "storage_device": { "type": "object", "properties": { "server": { "$ref": "#/components/schemas/storageUuid" }, "address": { "type": "string", "examples": [ "scsi", "scsi:0:0", "virtio:0", "ide:0:0" ], "pattern": "^(?:ide(?::[01]:[01])?|scsi(?::0:(?:[0-9]|1[0-5]))?|virtio(?::(?:[0-9]|1[0-5]))?)$", "description": "Device address on the Cloud Server, or an `ide`, `scsi`, or `virtio` bus name for automatic address selection. Defaults to the next available address on the Cloud Server's default disk bus for disks, or the IDE bus for CD-ROM devices." }, "type": { "type": "string", "enum": [ "disk", "cdrom" ], "description": "Type of the attached device. Defaults to `disk`.", "default": "disk" }, "boot_disk": { "type": "string", "enum": [ "0", "1" ], "description": "Whether the device is used as the boot disk unless overridden by the Cloud Server boot order. Defaults to `0`.", "default": "0" } }, "required": [ "server" ], "additionalProperties": false, "description": "Parameters for attaching this storage resource to a Cloud Server in the same zone." } }, "required": [ "storage_device" ], "additionalProperties": false, "description": "Request schema for attaching this storage resource to a Cloud Server.", "example": { "storage_device": { "server": "00798b85-efdc-41ca-8021-f6ef457b8531", "type": "disk" } } }, "createStorageBackupRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "storage": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": "^[^<>]*$", "description": "A short, informational description of the backup." } }, "required": [ "title" ], "additionalProperties": false, "description": "Parameters for the point-in-time backup." } }, "required": [ "storage" ], "additionalProperties": false, "description": "Request schema for creating an on-demand block storage backup.", "example": { "storage": { "title": "Manually created backup" } } }, "cloneStorageRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "storage": { "type": "object", "properties": { "encrypted": { "$ref": "#/components/schemas/storageEncrypted" }, "tier": { "$ref": "#/components/schemas/storageTier" }, "title": { "$ref": "#/components/schemas/storageTitle" }, "zone": { "$ref": "#/components/schemas/storageZone" } }, "required": [ "zone", "title" ], "additionalProperties": false, "description": "Parameters for the cloned block storage." } }, "required": [ "storage" ], "additionalProperties": false, "description": "Request schema for cloning a block storage resource.", "example": { "storage": { "encrypted": "yes", "tier": "maxiops", "title": "Cloned Block Storage", "zone": "fi-hel1" } } }, "createStorageTemplateRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "storage": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": "^[^<>]*$", "description": "A short, informational description of the template." } }, "required": [ "title" ], "additionalProperties": false, "description": "Parameters for creating a template from the block storage." } }, "required": [ "storage" ], "additionalProperties": false, "description": "Request schema for creating a template from a block storage resource.", "example": { "storage": { "title": "My server template" } } }, "storages": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "storages": { "type": "object", "properties": { "storage": { "type": "array", "items": { "$ref": "#/components/schemas/storageListItem" } } }, "required": [ "storage" ], "additionalProperties": false } }, "required": [ "storages" ], "additionalProperties": false, "description": "A list of storage resources accessible to the account.", "example": { "storages": { "storage": [ { "access": "private", "encrypted": "no", "created": "2025-02-27T05:50:50Z", "labels": [ { "key": "environment", "value": "production" } ], "license": 0, "size": 50, "state": "online", "tier": "maxiops", "title": "Production database", "type": "normal", "uuid": "01f3286c-a5ea-4670-8121-d0b9767d625b", "zone": "fi-hel1" } ] } } }, "storageListItem": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "access": { "$ref": "#/components/schemas/storageAccess" }, "encrypted": { "$ref": "#/components/schemas/storageEncrypted" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/storageLabel" }, "description": "Labels describing and classifying the storage resource." }, "license": { "type": "number", "format": "double", "description": "Hourly license fee in credits. The value is `0` when the storage resource has no license fee." }, "part_of_plan": { "type": "string", "description": "Present with value `yes` when the storage resource is included in the Cloud Server plan.", "const": "yes" }, "progress": { "type": "string", "description": "Progress of an active storage operation." }, "created": { "type": "string", "format": "date-time", "description": "Time when the private storage resource or backup was created." }, "origin": { "$ref": "#/components/schemas/storageUuid" }, "size": { "type": "integer", "minimum": 1, "format": "int64", "description": "Size of the storage resource in gigabytes." }, "state": { "$ref": "#/components/schemas/storageState" }, "tier": { "$ref": "#/components/schemas/storageTier" }, "title": { "type": "string", "description": "A short, informational description of the storage resource." }, "type": { "$ref": "#/components/schemas/storageType" }, "template_type": { "$ref": "#/components/schemas/storageTemplateType" }, "uuid": { "$ref": "#/components/schemas/storageUuid" }, "zone": { "$ref": "#/components/schemas/storageZone" } }, "required": [ "access", "license", "size", "state", "title", "type", "uuid", "encrypted", "labels" ], "additionalProperties": false, "description": "Storage resource summary returned by public list operations.", "example": { "access": "private", "created": "2025-02-27T05:50:50Z", "encrypted": "no", "labels": [], "license": 0, "size": 50, "state": "online", "tier": "maxiops", "title": "Databases", "type": "normal", "uuid": "01f3286c-a5ea-4670-8121-d0b9767d625b", "zone": "fi-hel1" } }, "storageState": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "online" ], "enum": [ "online", "maintenance", "error", "pending_delete", "hidden", "cloning", "backuping", "attaching", "detaching", "syncing" ], "description": "Current lifecycle state of the storage resource. `online` is ready for use; `maintenance` indicates ongoing maintenance or an update; `cloning`, `backuping`, and `syncing` indicate active storage operations; `error` indicates that the storage resource is inaccessible because an error occurred." }, "storageTier": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "hdd", "standard", "maxiops" ], "enum": [ "hdd", "standard", "maxiops" ], "description": "Block storage performance and pricing tier. `maxiops` is high-performance block storage, `standard` is general-purpose block storage, and `hdd` is the API name for the high-capacity Archive tier." }, "storageType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "normal" ], "enum": [ "normal", "template", "cdrom", "backup" ], "description": "Storage resource type to return." }, "createStorageResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "storage": { "$ref": "#/components/schemas/storageDetails" } }, "required": [ "storage" ], "additionalProperties": false, "description": "Response containing the created block storage resource.", "example": { "storage": { "access": "private", "backup_rule": { "interval": "daily", "retention": "7", "time": "0400" }, "backups": { "backup": [] }, "created": "2026-08-26T09:15:00Z", "encrypted": "yes", "labels": [ { "key": "environment", "value": "production" } ], "license": 0, "servers": { "server": [] }, "size": 50, "state": "online", "tier": "maxiops", "title": "Production data", "type": "normal", "uuid": "01d4fcd4-e446-433b-8a9c-551a1284952e", "zone": "fi-hel1" } } }, "storageDetails": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "access": { "$ref": "#/components/schemas/storageAccess" }, "encrypted": { "$ref": "#/components/schemas/storageEncrypted" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/storageLabel" }, "description": "Labels describing and classifying the storage resource." }, "license": { "type": "number", "format": "double", "description": "Hourly license cost in credits when the storage resource contains a licensed operating system." }, "backup_rule": { "oneOf": [ { "$ref": "#/components/schemas/storageBackupRule" }, { "type": "object" } ], "description": "Schedule for automatic backups of the storage resource. An empty object indicates that no automatic backup schedule is configured." }, "backups": { "type": "object", "properties": { "backup": { "type": "array", "items": { "$ref": "#/components/schemas/storageUuid" }, "description": "UUIDs of backups associated with this storage resource." } }, "required": [ "backup" ], "additionalProperties": false, "description": "Backups associated with this storage resource." }, "created": { "type": "string", "format": "date-time", "description": "Time when the private storage resource was created." }, "origin": { "$ref": "#/components/schemas/storageUuid" }, "part_of_plan": { "type": "string", "description": "Present with the value `yes` when the storage resource is included in a Cloud Server plan.", "const": "yes" }, "progress": { "type": "string", "description": "Progress of an ongoing storage operation when available." }, "servers": { "type": "object", "properties": { "server": { "type": "array", "items": { "$ref": "#/components/schemas/storageUuid" }, "description": "UUIDs of Cloud Servers to which the storage resource is attached." } }, "required": [ "server" ], "additionalProperties": false, "description": "Cloud Servers to which the storage resource is attached." }, "size": { "type": "integer", "minimum": 1, "format": "int64", "description": "Size of the storage resource in gigabytes." }, "state": { "$ref": "#/components/schemas/storageState" }, "tier": { "$ref": "#/components/schemas/storageTier" }, "title": { "type": "string", "description": "A short, informational description of the storage resource." }, "type": { "$ref": "#/components/schemas/storageType" }, "template_type": { "$ref": "#/components/schemas/storageTemplateType" }, "uuid": { "$ref": "#/components/schemas/storageUuid" }, "zone": { "$ref": "#/components/schemas/storageZone" } }, "required": [ "access", "encrypted", "labels", "license", "servers", "size", "state", "title", "type", "uuid" ], "additionalProperties": false, "description": "Detailed information about a storage resource.", "example": { "access": "private", "backup_rule": {}, "backups": { "backup": [] }, "created": "2026-08-26T09:15:00Z", "encrypted": "no", "labels": [], "license": 0, "servers": { "server": [] }, "size": 50, "state": "online", "tier": "maxiops", "title": "Production data", "type": "normal", "uuid": "01d4fcd4-e446-433b-8a9c-551a1284952e", "zone": "fi-hel1" } }, "storage": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "storage": { "$ref": "#/components/schemas/storageDetails" } }, "required": [ "storage" ], "additionalProperties": false, "description": "Response schema containing a single storage resource.", "example": { "storage": { "access": "private", "backup_rule": {}, "backups": { "backup": [] }, "created": "2026-08-26T09:15:00Z", "encrypted": "no", "labels": [], "license": 0, "servers": { "server": [] }, "size": 50, "state": "online", "tier": "maxiops", "title": "Production data", "type": "normal", "uuid": "01d4fcd4-e446-433b-8a9c-551a1284952e", "zone": "fi-hel1" } } }, "modifyStorageResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "storage": { "$ref": "#/components/schemas/storageDetails" }, "resize_backup": { "$ref": "#/components/schemas/storageDetails" } }, "required": [ "storage" ], "additionalProperties": false, "description": "Response schema for block storage modification operations.", "example": { "storage": { "access": "private", "backup_rule": {}, "backups": { "backup": [] }, "created": "2026-08-26T09:15:00Z", "encrypted": "no", "labels": [], "license": 0, "servers": { "server": [] }, "size": 60, "state": "online", "tier": "maxiops", "title": "Production data expanded", "type": "normal", "uuid": "011d671f-e803-484d-920a-c25b4bb05c01", "zone": "fi-hel1" } } }, "attachStorageResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "storage": { "$ref": "#/components/schemas/storageDetails" } }, "required": [ "storage" ], "additionalProperties": false, "description": "Response containing the attached storage resource and its Cloud Server attachment.", "example": { "storage": { "access": "private", "backup_rule": {}, "backups": { "backup": [] }, "created": "2026-08-26T09:15:00Z", "encrypted": "yes", "labels": [ { "key": "environment", "value": "production" } ], "license": 0, "servers": { "server": [ "009d64ef-31d1-4684-a26b-c86c955cbf46" ] }, "size": 50, "state": "online", "tier": "maxiops", "title": "Production data", "type": "normal", "uuid": "01d4fcd4-e446-433b-8a9c-551a1284952e", "zone": "fi-hel1" } } }, "createStorageBackupResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "storage": { "$ref": "#/components/schemas/storageDetails" } }, "required": [ "storage" ], "additionalProperties": false, "description": "Response containing the on-demand backup being created.", "example": { "storage": { "access": "private", "created": "2026-08-26T09:20:00Z", "encrypted": "yes", "labels": [ { "key": "environment", "value": "production" } ], "license": 0, "origin": "01d4fcd4-e446-433b-8a9c-551a1284952e", "progress": "0", "servers": { "server": [] }, "size": 50, "state": "maintenance", "title": "Manually created backup", "type": "backup", "uuid": "016d343b-14de-4b61-91ca-433dd1ea6c47", "zone": "fi-hel1" } } }, "detachStorageResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "storage": { "$ref": "#/components/schemas/storageDetails" } }, "required": [ "storage" ], "additionalProperties": false, "description": "Response containing the detached storage resource.", "example": { "storage": { "access": "private", "backup_rule": {}, "backups": { "backup": [] }, "created": "2026-08-26T09:15:00Z", "encrypted": "yes", "labels": [ { "key": "environment", "value": "production" } ], "license": 0, "servers": { "server": [] }, "size": 50, "state": "online", "tier": "maxiops", "title": "Production data", "type": "normal", "uuid": "01d4fcd4-e446-433b-8a9c-551a1284952e", "zone": "fi-hel1" } } }, "resizeStorageResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "resize_backup": { "$ref": "#/components/schemas/storageDetails" } }, "required": [ "resize_backup" ], "additionalProperties": false, "description": "Response containing the backup created before resizing the block storage partition and filesystem.", "example": { "resize_backup": { "access": "private", "created": "2021-12-03T06:25:15Z", "encrypted": "no", "labels": [], "license": 0, "size": 100, "state": "online", "origin": "017ca4cc-def2-458d-a797-7782959b30a7", "servers": { "server": [] }, "tier": "maxiops", "title": "Resize Backup", "type": "backup", "uuid": "01beec3a-14ac-4f71-9c63-3338341121c3", "zone": "fi-hel1" } } }, "createStorageTemplateResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "storage": { "$ref": "#/components/schemas/storageDetails" } }, "required": [ "storage" ], "additionalProperties": false, "description": "Response containing the private template being created.", "example": { "storage": { "access": "private", "created": "2026-08-26T09:25:00Z", "encrypted": "yes", "labels": [ { "key": "environment", "value": "production" } ], "license": 0, "servers": { "server": [] }, "size": 50, "state": "maintenance", "tier": "maxiops", "title": "My server template", "type": "template", "uuid": "01be94b8-8f9f-44f7-99df-3d61051173c2", "zone": "fi-hel1" } } }, "storageLabelFilter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "environment", "environment=production" ], "pattern": "^(?!_)[\\x20-\\x3C\\x3E-\\x7E]{2,32}(?:=.*)?$", "description": "Label key or key-value pair to match. A key-only filter matches any value. Repeat the query parameter to require all specified labels; keys are matched case-insensitively." }, "storageSearch": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "database", "01f3286c" ], "maxLength": 255, "minLength": 1, "pattern": "^[^<>]+$", "description": "Partial match against the storage resource title or UUID." }, "storageSortBy": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "title" ], "enum": [ "created", "size", "tier", "title", "type", "zone" ], "description": "Storage resource field by which to sort the results." }, "storageOrderBy": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "asc" ], "enum": [ "asc", "desc" ], "description": "Sort direction. This parameter is used only when `sort_by` is specified." }, "storageLimit": { "type": "integer", "examples": [ 25, 50, 100 ], "maximum": 100, "minimum": 1, "description": "Maximum number of storage resources to return. Default is 25." }, "storageOffset": { "type": "integer", "examples": [ 0, 25, 50, 100 ], "minimum": 0, "description": "Number of items to skip before starting to return results. Default is 0." }, "storageAccessFilter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "private" ], "enum": [ "public", "private" ], "description": "Storage resource access type to return." }, "storageUuid": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "format": "uuid", "description": "Universally unique identifier", "example": "0414e0d7-4436-4037-9dd8-6eaf47dce599" }, "storageBackupRule": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "interval": { "type": "string", "enum": [ "daily", "mon", "tue", "wed", "thu", "fri", "sat", "sun" ], "description": "Weekday when the backup is created, or `daily` to create a backup every day at the same time." }, "time": { "type": "string", "pattern": "^(?:[01][0-9]|2[0-3])[0-5][0-9]$", "description": "UTC time of day when the backup is created, in `HHMM` format." }, "retention": { "type": "string", "pattern": "^(?:[1-9]|[1-9][0-9]{1,2}|10[0-8][0-9]|109[0-5])$", "description": "Number of days before the backup is automatically deleted, from 1 through 1095." } }, "required": [ "interval", "time", "retention" ], "additionalProperties": false, "description": "Schedule for automatic block storage backups.", "example": { "interval": "daily", "retention": "7", "time": "0400" } }, "storageEncrypted": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "yes", "no" ], "enum": [ "yes", "no" ], "description": "Indicates whether the resource is encrypted." }, "storageLabel": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "key": { "type": "string", "description": "Label key used to classify the resource" }, "value": { "type": "string", "description": "Value associated with the label key" } }, "required": [ "key", "value" ], "additionalProperties": false, "description": "A key/value pair to label and categorize resources", "example": { "key": "env", "value": "production" } }, "storageZone": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "fi-hel1", "de-fra1", "us-nyc1" ], "maxLength": 15, "minLength": 2, "pattern": "^[a-z][a-z0-9-]{0,14}[a-z0-9]$", "description": "Zone identifier" }, "storageTitle": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "description": "Human-readable title for a resource." }, "storageAccess": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "public", "private", "utility" ], "description": "Network access level", "example": "public" }, "storageTemplateType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "cloud-init" ], "enum": [ "cloud-init", "native" ], "description": "Template initialization mechanism. `cloud-init` templates support cloud-init metadata, while `native` templates use the operating system's native initialization." }, "storageError": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "examples": [ "GENERAL_FAILURE" ] }, "error_message": { "type": "string", "examples": [ "Your request could not be fulfilled due to a technical issue." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "A general error response indicating that the request could not be fulfilled due to a technical issue." }, "tag": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "tag": { "type": "object", "properties": { "description": { "$ref": "#/components/schemas/tagDescription" }, "name": { "$ref": "#/components/schemas/tagName" }, "servers": { "$ref": "#/components/schemas/tagServers" } }, "required": [ "name", "servers" ], "example": { "name": "PROD", "description": "Production servers", "servers": { "server": [ "0077fa3d-32db-4b09-9f5f-30d9e9afb565" ] } } } }, "required": [ "tag" ], "description": "Container object for a single tag resource.", "example": { "tag": { "name": "PROD", "description": "Production servers", "servers": { "server": [ "0077fa3d-32db-4b09-9f5f-30d9e9afb565" ] } } } }, "tags": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "tags": { "type": "object", "properties": { "tag": { "type": "array", "items": { "type": "object", "properties": { "description": { "$ref": "#/components/schemas/tagDescription" }, "name": { "$ref": "#/components/schemas/tagName" }, "servers": { "$ref": "#/components/schemas/tagServers" } }, "required": [ "name", "servers" ] } } }, "required": [ "tag" ], "example": { "tag": [ { "name": "PROD", "description": "Production servers", "servers": { "server": [ "0077fa3d-32db-4b09-9f5f-30d9e9afb565" ] } } ] } } }, "required": [ "tags" ], "description": "Container object for resource tags.", "example": { "tags": { "tag": [ { "name": "PROD", "description": "Production servers", "servers": { "server": [ "0077fa3d-32db-4b09-9f5f-30d9e9afb565" ] } } ] } } }, "tagName": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "DEV", "PROD", "private", "QA", "webserver", "database" ], "maxLength": 32, "minLength": 1, "pattern": "^[A-Za-z0-9_]{1,32}$", "description": "Short name used to identify a tag." }, "tagDescription": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "Development servers", "Production servers", "Private environment", "Quality Assurance environment", "Web servers", "Database servers" ], "description": "Human-readable description for a tag." }, "tagServers": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "server": { "type": "array", "items": { "type": "string", "examples": [ "0077fa3d-32db-4b09-9f5f-30d9e9afb565", "00c78863-db86-44ea-af70-d6edc4d162bf" ], "format": "uuid", "description": "Unique identifier of the server." } } }, "description": "List of servers associated with the tag.", "example": { "server": [ "0077fa3d-32db-4b09-9f5f-30d9e9afb565", "00c78863-db86-44ea-af70-d6edc4d162bf" ] } }, "tagError": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "examples": [ "GENERAL_FAILURE" ] }, "error_message": { "type": "string", "examples": [ "Your request could not be fulfilled due to a technical issue." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "A general error response indicating that the request could not be fulfilled due to a technical issue." }, "tagError400": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "const": "TAG_INVALID" }, "error_message": { "type": "string", "examples": [ "The tag name is invalid" ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "400 Bad Request errors for tag operations." }, "tagError403": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "const": "TAG_FORBIDDEN" }, "error_message": { "type": "string", "examples": [ "Username does not have access to this tag" ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "400 Forbidden errors for tag operations." }, "tagError409": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "const": "TAG_EXISTS" }, "error_message": { "type": "string", "examples": [ "Tag already exists" ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "description": "409 Conflict errors for tag operations." }, "tagError404": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "const": "TAG_NOT_FOUND" }, "error_message": { "type": "string", "examples": [ "Tag does not exist" ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "404 Not Found errors for tag operations." }, "timezones": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "timezones": { "type": "object", "properties": { "timezone": { "type": "array", "items": { "type": "string" }, "example": [ "UTC", "Europe/Helsinki" ] } }, "required": [ "timezone" ], "additionalProperties": false, "example": { "timezone": [ "UTC", "Europe/Helsinki", "America/New_York" ] } } }, "required": [ "timezones" ], "additionalProperties": false, "description": "List of available timezones", "example": { "timezones": { "timezone": [ "UTC", "Europe/Helsinki", "America/New_York" ] } } }, "timezoneError": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "examples": [ "GENERAL_FAILURE" ] }, "error_message": { "type": "string", "examples": [ "Your request could not be fulfilled due to a technical issue." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "A general error response indicating that the request could not be fulfilled due to a technical issue." }, "accountTokensCreateTokenRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "properties": { "expires_in": {} }, "required": [ "expires_at" ] }, { "properties": { "expires_at": {} }, "required": [ "expires_in" ] } ], "examples": [ { "name": "token", "expires_at": "2025-11-30T08:03:15.944Z", "can_create_tokens": true, "gui": false, "allowed_ip_ranges": [ "0.0.0.0/0", "::/0" ] }, { "name": "token", "expires_in": "1h30min", "can_create_tokens": true, "gui": false, "allowed_ip_ranges": [ "0.0.0.0/0", "::/0" ] } ], "properties": { "name": { "type": "string", "examples": [ "my first token" ], "maxLength": 1024, "minLength": 1, "description": "The name of the token. Does not need to be unique." }, "expires_at": { "type": "string", "format": "date-time", "description": "The requested expiry time of the token, in RFC3339 format (2025-10-12T07:20:50.52Z). Needs to be in the future and maximum of 1 year in the future." }, "expires_in": { "type": "string", "examples": [ "8760h", "720h", "24h", "1h30m", "15m" ], "description": "The requested duration until expiry of the token, e.g. '1h30min'. Needs to be a positive duration and maximum of 1 year. Can be used instead of `expires_at`. Supported units are 'h' for hours, 'm' for minutes and 's' for seconds." }, "can_create_tokens": { "type": "boolean", "description": "Whether the token can create other tokens.", "default": false }, "gui": { "type": "boolean", "description": "Token is for internal GUI use. Can not be used externally.", "default": false }, "allowed_ip_ranges": { "type": "array", "examples": [ [ "0.0.0.0/0", "::/0" ] ], "items": { "$ref": "#/components/schemas/accountTokensIpRange" }, "maxItems": 100, "uniqueItems": true, "description": "List of IP ranges that are allowed to authenticate with the token. Empty list denies access from everywhere. If unset, the default list will be the IP filters of the account. If no IP filters are defined for the account either, the default will be [\"0.0.0.0/0\", \"::/0\"], i.e. allow from any address." } }, "required": [ "name" ], "additionalProperties": false }, "accountTokensIpRange": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "1.2.3.4", "2001:db8::1", "0.0.0.0/0", "::/0", "0.0.0.0-0.0.0.255", "2001:db8::1-2001:db8::ff" ], "title": "IP Range", "description": "IP range from where to accept the token" }, "accountTokensToken": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "id": { "$ref": "#/components/schemas/accountTokensUuidOfTheToken" }, "name": { "type": "string", "examples": [ "my first token" ], "maxLength": 1024, "minLength": 1, "description": "The name of the token. Does not need to be unique." }, "created_at": { "type": "string", "format": "date-time", "description": "Token creation time.", "example": "2025-11-30T08:03:15.944Z" }, "expires_at": { "type": "string", "format": "date-time", "description": "The requested expiry time of the token, in RFC3339 format (2025-10-12T07:20:50.52Z). Needs to be in the future and maximum of 1 year in the future.", "example": "2025-11-30T08:03:15.944Z" }, "last_used_at": { "type": "string", "format": "date-time", "description": "The last time the token was used.", "example": "2025-11-30T08:03:15.944Z" }, "can_create_tokens": { "type": "boolean", "description": "Whether the token can create other tokens.", "default": false, "example": false }, "gui": { "type": "boolean", "description": "Token is for internal GUI use. Can not be used externally.", "default": false, "example": false }, "allowed_ip_ranges": { "type": "array", "items": { "$ref": "#/components/schemas/accountTokensIpRange" }, "maxItems": 100, "uniqueItems": true, "description": "List of IP ranges that are allowed to authenticate with the token. Empty list denies access from everywhere. If unset, the default list will be the IP filters of the account. If no IP filters are defined for the account either, the default will be [\"0.0.0.0/0\", \"::/0\"], i.e. allow from any address.", "example": [ "0.0.0.0/0", "::/0" ] } }, "title": "Token", "additionalProperties": false, "description": "A token." }, "accountTokensUuidOfTheToken": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "e7b3f8a0-4c2d-11ec-bf63-0242ac130002", "e7b3f8a0-4c2d-11ec-bf63-0242ac130003", "e7b3f8a0-4c2d-11ec-bf63-0242ac130004" ], "title": "UUID of the token", "format": "uuid", "description": "UUID of the token" }, "accountTokensProblem400": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "type": "https://developers.upcloud.com/1.3/errors#ERROR_BAD_REQUEST", "title": "Bad request.", "detail": "Invalid parameters.", "invalid_params": [ { "name": "expires_at", "reason": "Token expiration time must be in the future." } ], "correlation_id": "01JQV2ETY2K6HHE1KZFY9E1CYC", "status": 400 } ], "properties": { "type": { "type": "string", "format": "uri", "description": "A URI reference that uniquely identifies the problem type only in the context of the provided API. It is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type.", "const": "https://developers.upcloud.com/1.3/errors#ERROR_BAD_REQUEST" }, "title": { "type": "string", "examples": [ "Bad request." ], "description": "A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized." }, "detail": { "type": "string", "examples": [ "Invalid parameters." ], "description": "A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized." }, "status": { "type": "integer", "format": "int32", "enum": [ 400 ], "description": "The HTTP status code generated by the origin server for this occurrence of the problem." }, "invalid_params": { "type": "array", "examples": [ [ { "name": "expires_at", "reason": "Token expiration time must be in the future." } ] ], "items": { "type": "object", "properties": { "name": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "name", "reason" ] } }, "correlation_id": { "type": "string", "examples": [ "01JQV2ETY2K6HHE1KZFY9E1CYC" ], "description": "A unique identifier for the request. This identifier is generated by the server and can be used to track the request in the server logs. It is useful for debugging and support purposes." } }, "required": [ "type", "title", "status" ], "additionalProperties": false, "description": "JSON Problem Details for HTTP APIs" }, "accountTokensProblem401": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "type": "https://developers.upcloud.com/1.3/errors#ERROR_UNAUTHORIZED", "title": "Unauthorized.", "detail": "Access denied.", "correlation_id": "01JQV2ETY2K6HHE1KZFY9E1CYC", "status": 401 } ], "properties": { "type": { "type": "string", "format": "uri", "description": "A URI reference that uniquely identifies the problem type only in the context of the provided API. It is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type.", "const": "https://developers.upcloud.com/1.3/errors#ERROR_UNAUTHORIZED" }, "title": { "type": "string", "examples": [ "Unauthorized." ], "description": "A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized." }, "detail": { "type": "string", "examples": [ "Invalid parameters." ], "description": "A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized." }, "status": { "type": "integer", "format": "int32", "enum": [ 401 ], "description": "The HTTP status code generated by the origin server for this occurrence of the problem." }, "invalid_params": { "type": "array", "examples": [ [ { "name": "expires_at", "reason": "Token expiration time must be in the future." } ] ], "items": { "type": "object", "properties": { "name": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "name", "reason" ] } }, "correlation_id": { "type": "string", "examples": [ "01JQV2ETY2K6HHE1KZFY9E1CYC" ], "description": "A unique identifier for the request. This identifier is generated by the server and can be used to track the request in the server logs. It is useful for debugging and support purposes." } }, "required": [ "type", "title", "status" ], "additionalProperties": false, "description": "JSON Problem Details for HTTP APIs" }, "accountTokensProblem403": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "type": "https://developers.upcloud.com/1.3/errors#ERROR_FORBIDDEN", "title": "Bad request.", "detail": "Invalid parameters.", "correlation_id": "01JQV2ETY2K6HHE1KZFY9E1CYC", "status": 403 } ], "properties": { "type": { "type": "string", "format": "uri", "description": "A URI reference that uniquely identifies the problem type only in the context of the provided API. It is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type.", "const": "https://developers.upcloud.com/1.3/errors#ERROR_FORBIDDEN" }, "title": { "type": "string", "examples": [ "Bad request." ], "description": "A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized." }, "detail": { "type": "string", "examples": [ "Invalid parameters." ], "description": "A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized." }, "status": { "type": "integer", "format": "int32", "enum": [ 403 ], "description": "The HTTP status code generated by the origin server for this occurrence of the problem." }, "invalid_params": { "type": "array", "examples": [ [ { "name": "expires_at", "reason": "Token expiration time must be in the future." } ] ], "items": { "type": "object", "properties": { "name": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "name", "reason" ] } }, "correlation_id": { "type": "string", "examples": [ "01JQV2ETY2K6HHE1KZFY9E1CYC" ], "description": "A unique identifier for the request. This identifier is generated by the server and can be used to track the request in the server logs. It is useful for debugging and support purposes." } }, "required": [ "type", "title", "status" ], "additionalProperties": false, "description": "JSON Problem Details for HTTP APIs" }, "accountTokensProblem409": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "type": "https://developers.upcloud.com/1.3/errors#ERROR_SERVICE_UNAVAILABLE", "title": "Service unavailable.", "detail": "Try again later.", "correlation_id": "01JQV2ETY2K6HHE1KZFY9E1CYC", "status": 409 } ], "properties": { "type": { "type": "string", "format": "uri", "description": "A URI reference that uniquely identifies the problem type only in the context of the provided API. It is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type.", "const": "https://developers.upcloud.com/1.3/errors#ERROR_SERVICE_UNAVAILABLE" }, "title": { "type": "string", "examples": [ "Service unavailable." ], "description": "A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized." }, "detail": { "type": "string", "examples": [ "Invalid parameters." ], "description": "A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized." }, "status": { "type": "integer", "format": "int32", "enum": [ 400 ], "description": "The HTTP status code generated by the origin server for this occurrence of the problem." }, "invalid_params": { "type": "array", "examples": [ [ { "name": "expires_at", "reason": "Token expiration time must be in the future." } ] ], "items": { "type": "object", "properties": { "name": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "name", "reason" ] } }, "correlation_id": { "type": "string", "examples": [ "01JQV2ETY2K6HHE1KZFY9E1CYC" ], "description": "A unique identifier for the request. This identifier is generated by the server and can be used to track the request in the server logs. It is useful for debugging and support purposes." } }, "required": [ "type", "title", "status" ], "additionalProperties": false, "description": "JSON Problem Details for HTTP APIs" }, "accountTokensProblem": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "type": "https://developers.upcloud.com/1.3/errors#INTERNAL_SERVER_ERROR", "title": "Internal server error.", "detail": "Internal server error.", "invalid_params": [ { "name": "expires_at", "reason": "Token expiration time must be in the future." } ], "correlation_id": "01JQV2ETY2K6HHE1KZFY9E1CYC", "status": 500 } ], "properties": { "type": { "type": "string", "examples": [ "https://developers.upcloud.com/1.3/errors#INTERNAL_SERVER_ERROR" ], "format": "uri", "description": "A URI reference that uniquely identifies the problem type only in the context of the provided API. It is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type." }, "title": { "type": "string", "examples": [ "Internal server error." ], "description": "A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized." }, "detail": { "type": "string", "examples": [ "Invalid parameters." ], "description": "A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized." }, "status": { "type": "integer", "maximum": 599, "minimum": 200, "format": "int32", "description": "The HTTP status code generated by the origin server for this occurrence of the problem." }, "invalid_params": { "type": "array", "examples": [ [ { "name": "expires_at", "reason": "Token expiration time must be in the future." } ] ], "items": { "type": "object", "properties": { "name": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "name", "reason" ] } }, "correlation_id": { "type": "string", "examples": [ "01JQV2ETY2K6HHE1KZFY9E1CYC" ], "description": "A unique identifier for the request. This identifier is generated by the server and can be used to track the request in the server logs. It is useful for debugging and support purposes." } }, "required": [ "type", "title", "status" ], "additionalProperties": false, "description": "JSON Problem Details for HTTP APIs" }, "accountTokensListTokensResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/accountTokensToken" }, "title": "List Tokens Response", "description": "Paged list of tokens.", "example": [ { "id": "0c848138-2559-4562-9520-b1f22c4ae751", "name": "token", "created_at": "2025-03-25T13:46:19.502878Z", "expires_at": "2025-03-25T14:16:19.502644Z", "can_create_tokens": true, "allowed_ip_ranges": [ "1.2.3.4" ], "gui": false }, { "id": "0cc50c9d-6a81-494b-af8c-f7271cfd4d22", "name": "token", "created_at": "2025-03-25T14:12:06.534789Z", "expires_at": "2025-03-25T14:42:06.534342Z", "last_used_at": "2025-03-25T14:12:33.000692Z", "can_create_tokens": true, "allowed_ip_ranges": [ "1.2.3.4" ], "gui": false } ] }, "accountTokensGetTokenResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "id": { "$ref": "#/components/schemas/accountTokensUuidOfTheToken" }, "name": { "type": "string", "examples": [ "my first token" ], "maxLength": 1024, "minLength": 1, "description": "The name of the token. Does not need to be unique." }, "created_at": { "type": "string", "format": "date-time", "description": "Token creation time.", "example": "2025-11-30T08:03:15.944Z" }, "expires_at": { "type": "string", "format": "date-time", "description": "The requested expiry time of the token, in RFC3339 format (2025-10-12T07:20:50.52Z). Needs to be in the future and maximum of 1 year in the future.", "example": "2025-11-30T08:03:15.944Z" }, "last_used_at": { "type": "string", "format": "date-time", "description": "The last time the token was used.", "example": "2025-11-30T08:03:15.944Z" }, "can_create_tokens": { "type": "boolean", "description": "Whether the token can create other tokens.", "default": false, "example": false }, "gui": { "type": "boolean", "description": "Token is for internal GUI use. Can not be used externally.", "default": false, "example": false }, "allowed_ip_ranges": { "type": "array", "items": { "$ref": "#/components/schemas/accountTokensIpRange" }, "maxItems": 100, "uniqueItems": true, "description": "List of IP ranges that are allowed to authenticate with the token. Empty list denies access from everywhere. If unset, the default list will be the IP filters of the account. If no IP filters are defined for the account either, the default will be [\"0.0.0.0/0\", \"::/0\"], i.e. allow from any address.", "example": [ "0.0.0.0/0", "::/0" ] } }, "title": "Get Token Response", "additionalProperties": false, "description": "A token.", "example": { "id": "0c848138-2559-4562-9520-b1f22c4ae751", "name": "token", "token_type": "workspace", "created_at": "2025-03-25T13:46:19.502878Z", "expires_at": "2025-03-25T14:16:19.502644Z", "can_create_tokens": true, "allowed_ip_ranges": [ "1.2.3.4" ], "gui": false } }, "accountTokensProblem404": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "type": "https://developers.upcloud.com/1.3/errors#ERROR_NOT_FOUND", "title": "Not found.", "detail": "User not found.", "correlation_id": "01JQV2ETY2K6HHE1KZFY9E1CYC", "status": 404 } ], "properties": { "type": { "type": "string", "format": "uri", "description": "A URI reference that uniquely identifies the problem type only in the context of the provided API. It is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type.", "const": "https://developers.upcloud.com/1.3/errors#ERROR_NOT_FOUND" }, "title": { "type": "string", "examples": [ "Not found." ], "description": "A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized." }, "detail": { "type": "string", "examples": [ "Invalid parameters." ], "description": "A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized." }, "status": { "type": "integer", "format": "int32", "enum": [ 404 ], "description": "The HTTP status code generated by the origin server for this occurrence of the problem." }, "invalid_params": { "type": "array", "examples": [ [ { "name": "expires_at", "reason": "Token expiration time must be in the future." } ] ], "items": { "type": "object", "properties": { "name": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "name", "reason" ] } }, "correlation_id": { "type": "string", "examples": [ "01JQV2ETY2K6HHE1KZFY9E1CYC" ], "description": "A unique identifier for the request. This identifier is generated by the server and can be used to track the request in the server logs. It is useful for debugging and support purposes." } }, "required": [ "type", "title", "status" ], "additionalProperties": false, "description": "JSON Problem Details for HTTP APIs" }, "objectStorage2QueryParamLimit": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "examples": [ 10, 25, 50, 100 ], "title": "QueryParamLimit", "maximum": 100, "minimum": 0, "description": "Schema for a query parameter specifying the maximum number of entries to return (limit).", "default": 10 }, "objectStorage2QueryParamOffset": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "examples": [ 0, 10, 20, 50 ], "title": "QueryParamOffset", "minimum": 0, "description": "Schema for a query parameter specifying the offset for pagination.", "default": 0 }, "objectStorage2QueryParamSort": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "-created_at", "service_name", "-region_name" ], "title": "QueryParamSort", "enum": [ "created_at", "-created_at", "service_name", "-service_name", "operational_state", "-operational_state", "region_name", "-region_name" ], "description": "Schema for a query parameter specifying the sort field and direction. Prefix with '-' for descending order." }, "objectStorage2ServiceUUID": { "type": "string", "examples": [ "01234567-89ab-cdef-0123-456789abcdef", "fedcba98-7654-3210-fedc-ba9876543210" ], "title": "ServiceUUID", "format": "uuid", "description": "The unique identifier for the service." }, "objectStorage2QueryParamForce": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "boolean", "examples": [ true, false ], "title": "QueryParamForce", "description": "Schema for a query parameter specifying whether to force an operation.", "default": false }, "objectStorage2Name": { "type": "string", "examples": [ "my-object-storage", "fi-hel1", "example-service", "test-bucket", "backup-storage" ], "title": "Name", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "A resource name." }, "objectStorage2CustomDomainName": { "type": "string", "examples": [ "example.com", "objects.example.com" ], "title": "CustomDomainName", "format": "hostname", "description": "A valid hostname for the custom domain. Supports both apex domains (example.com) and subdomains (objects.example.com)." }, "objectStorage2QueryParamTimestamp": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "2024-01-01T00:00:00Z", "2024-12-31T23:59:59Z" ], "title": "QueryParamTimestamp", "format": "date-time", "description": "Schema for a query parameter specifying a timestamp.", "example": "2024-01-01T00:00:00Z" }, "objectStorage2QueryParamInterval": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "1h", "1d", "1w", "1m" ], "title": "QueryParamInterval", "description": "Schema for a query parameter specifying the time interval.", "default": "1h" }, "objectStorage2LabelKey": { "type": "string", "examples": [ "environment", "team", "project", "purpose", "cost-center" ], "title": "LabelKey", "maxLength": 32, "minLength": 2, "pattern": "^[\\x20-\\x5E\\x60-\\x7E][\\x20-\\x7E]+$", "description": "The key of a label." }, "objectStorage2AccessKeyID": { "type": "string", "examples": [ "UCK1234567890ABCDEF", "UCK9876543210FEDCBA" ], "title": "AccessKeyID", "description": "The public identifier for an access key." }, "objectStorage2TagKey": { "type": "string", "examples": [ "environment", "team", "project", "purpose", "cost-center", "data-classification" ], "title": "TagKey", "maxLength": 128, "minLength": 1, "description": "The key of a tag." }, "objectStorage2PolicyVersionID": { "type": "string", "examples": [ "v1", "v2", "v3", "v4" ], "title": "PolicyVersionID", "description": "The version identifier of a policy (e.g., v1, v2)." }, "objectStorage2ServiceCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "example-service", "region": "example", "configured_status": "started", "networks": [ { "name": "example-public-network", "type": "public", "family": "IPv4" }, { "name": "example-private-network", "uuid": "03aa7245-2ff9-49c8-9f0e-7ca0270d71a4", "type": "private", "family": "IPv4" } ] } ], "properties": { "name": { "type": "string", "examples": [ "example-service" ], "maxLength": 64, "minLength": 1 }, "region": { "$ref": "#/components/schemas/objectStorage2Name" }, "configured_status": { "$ref": "#/components/schemas/objectStorage2PropertyConfiguredStatus" }, "networks": { "type": "array", "examples": [ [ { "name": "example-public-network", "type": "public", "family": "IPv4" } ] ], "items": { "$ref": "#/components/schemas/objectStorage2NetworkCreate" }, "maxItems": 8, "description": "Networks to attach to the service. Private networks must reside in the same region as the object storage." }, "custom_domains": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/objectStorage2CustomDomainCreate" }, "maxItems": 5, "description": "Custom domains to attach to the service." }, "labels": { "type": "array", "examples": [ [ { "key": "environment", "value": "production" } ] ], "items": { "$ref": "#/components/schemas/objectStorage2LabelCreate" }, "maxItems": 255, "description": "Labels for classifying the service." }, "properties": { "$ref": "#/components/schemas/objectStorage2PropertiesCreate" }, "termination_protection": { "type": "boolean", "description": "Enables or disables termination protection for the service. When enabled, the service cannot be deleted or powered down unless this is disabled first.", "default": false, "example": false } }, "title": "ServiceCreate", "required": [ "name", "region", "configured_status" ], "additionalProperties": false, "description": "Schema for creating a service, including name, region, status, networks, domains, labels, and properties." }, "objectStorage2PropertyConfiguredStatus": { "type": "string", "examples": [ "started", "stopped" ], "title": "PropertyConfiguredStatus", "enum": [ "started", "stopped" ], "description": "Schema for the configured status of a property." }, "objectStorage2NetworkCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "example-public-network", "type": "public", "family": "IPv4" }, { "name": "example-private-network", "uuid": "03bec0ad-85c3-459e-824d-710f8f24f740", "type": "private", "family": "IPv4" } ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Private network uuid. Omit for public networks.", "example": "03bec0ad-85c3-459e-824d-710f8f24f740" }, "name": { "$ref": "#/components/schemas/objectStorage2Name" }, "type": { "$ref": "#/components/schemas/objectStorage2NetworkType" }, "family": { "$ref": "#/components/schemas/objectStorage2NetworkFamily" } }, "title": "NetworkCreate", "required": [ "name", "type", "family" ], "additionalProperties": false, "description": "Schema for creating a network with optional private UUID, name, type, and family." }, "objectStorage2NetworkType": { "type": "string", "examples": [ "public", "private" ], "title": "NetworkType", "enum": [ "public", "private" ], "description": "Enum for the network type, indicating whether the network is public or private." }, "objectStorage2NetworkFamily": { "type": "string", "examples": [ "IPv4", "IPv6" ], "title": "NetworkFamily", "enum": [ "IPv4", "IPv6" ], "description": "Enum for the network family, indicating the type of IP address used." }, "objectStorage2CustomDomainCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "type": "public", "domain_name": "example.com" }, { "type": "public", "domain_name": "objects.example.com" }, { "type": "public", "mode": "static-website", "domain_name": "static.example.com" } ], "properties": { "type": { "type": "string", "enum": [ "public", "private" ], "description": "Type of the custom domain. At the moment only public is accepted.", "example": "public" }, "mode": { "type": "string", "enum": [ "api", "static-website" ], "description": "Purpose of the domain. 'api' for S3 API access (creates base URL), 'static-website' for static website hosting (no base URL). Cannot be changed after creation.", "default": "api", "example": "api" }, "domain_name": { "type": "string", "maxLength": 254, "minLength": 1, "format": "hostname", "description": "Custom domain to be added. Supports both apex domains (example.com) and subdomains (objects.example.com).", "example": "example.com" } }, "title": "CustomDomainCreate", "required": [ "type", "domain_name" ], "additionalProperties": false, "description": "Schema for creating a custom domain." }, "objectStorage2LabelCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "key": "foo", "value": "bar" } ], "properties": { "key": { "$ref": "#/components/schemas/objectStorage2LabelKey" }, "value": { "$ref": "#/components/schemas/objectStorage2LabelValue" } }, "title": "LabelCreate", "required": [ "key", "value" ], "additionalProperties": false, "description": "Schema for creating a label with a key-value pair." }, "objectStorage2LabelValue": { "type": [ "string", "null" ], "examples": [ "production", "backend", "web-app", "backup", "engineering" ], "title": "LabelValue", "maxLength": 255, "pattern": "\\A[\\p{L}\\p{N}\\p{P}\\p{S}\\p{M}\\p{Z}]*\\z", "description": "Schema for a label value property, allowing a string or null with specific character constraints." }, "objectStorage2PropertiesCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "access_control_origin_override": "https://mycompany.com" } ], "properties": { "access_control_origin_override": { "type": "string", "maxLength": 255, "example": "https://mycompany.com" } }, "title": "PropertiesCreate", "additionalProperties": false, "description": "Schema for creating properties with an optional access control origin override." }, "objectStorage2ServiceReplace": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "example-service", "configured_status": "started", "networks": [ { "name": "example-public-network", "type": "public", "family": "IPv4" }, { "name": "example-private-network", "uuid": "03aa7245-2ff9-49c8-9f0e-7ca0270d71a4", "type": "private", "family": "IPv4" } ], "labels": [ { "key": "example-label-key", "value": "example-label-value" } ] } ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "description": "The name of the service.", "example": "example-service" }, "configured_status": { "$ref": "#/components/schemas/objectStorage2PropertyConfiguredStatus" }, "termination_protection": { "type": "boolean", "description": "Enables or disables termination protection for the service. When enabled, the service cannot be deleted or powered down unless this is disabled first.", "default": false, "example": false }, "networks": { "type": "array", "items": { "$ref": "#/components/schemas/objectStorage2NetworkCreate" }, "maxItems": 8 }, "custom_domains": { "type": "array", "items": { "$ref": "#/components/schemas/objectStorage2CustomDomainCreate" }, "maxItems": 5 }, "static_websites": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/objectStorage2StaticWebsiteConfigCreate" }, "description": "Static website configurations for this service. Array replaces all existing configurations." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/objectStorage2LabelCreate" }, "maxItems": 255 }, "properties": { "$ref": "#/components/schemas/objectStorage2PropertiesCreate" } }, "title": "ServiceReplace", "required": [ "name", "configured_status" ], "additionalProperties": false, "description": "Schema for replacing a service, including name, status, networks, domains, labels, and properties." }, "objectStorage2StaticWebsiteConfigCreate": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "domain_name": { "type": "string", "maxLength": 255, "minLength": 1, "description": "Custom domain to use for static website hosting. Must be a custom domain attached to the service. If omitted, the primary static website domain is used.", "example": "www.example.com" }, "bucket_name": { "type": "string", "maxLength": 254, "minLength": 1, "pattern": "^[a-zA-Z0-9.\\-_]+$", "description": "Name of the S3/ECS bucket containing the website content. Only alphanumerics, dots, hyphens, and underscores are allowed.", "example": "my-website" }, "bucket_prefix": { "type": "string", "maxLength": 1024, "pattern": "^[a-zA-Z0-9/.\\-_]*$", "description": "Optional prefix/subfolder within the bucket. Only alphanumerics, slashes, dots, hyphens, and underscores are allowed.", "default": "", "example": "v2/" }, "index_document": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9/.\\-_]+$", "description": "Default document for directories. Only alphanumerics, slashes, dots, hyphens, and underscores are allowed.", "default": "index.html", "example": "index.html" }, "spa_mode": { "type": [ "boolean", "null" ], "description": "Enable Single Page Application (SPA) mode. When enabled, all non-file routes serve the index document, allowing client-side routing to handle the URL. Essential for React, Vue, Next.js, and similar frameworks.", "default": false, "example": false }, "enabled": { "type": "boolean", "description": "Whether the static website configuration should be active. Defaults to true if not specified.", "default": true, "example": true }, "error_pages": { "type": "array", "items": { "$ref": "#/components/schemas/objectStorage2StaticWebsiteErrorPage" }, "maxItems": 25, "description": "Custom error page configurations for specific HTTP status codes or ranges", "example": [ { "status_code": 404, "error_document": "errors/404.html" }, { "status_range": { "start": 500, "end": 599 }, "error_document": "errors/5xx.html" } ] } }, "title": "StaticWebsiteConfigCreate", "required": [ "bucket_name" ], "additionalProperties": false, "description": "Request body for creating a static website configuration. If domain is omitted, the primary static website domain is used." }, "objectStorage2StaticWebsiteErrorPage": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "oneOf": [ { "required": [ "status_code" ] }, { "required": [ "status_range" ] } ], "properties": { "status_code": { "type": "integer", "examples": [ 403, 404, 500 ], "maximum": 599, "minimum": 400, "description": "Single HTTP status code to match (must be within 4xx or 5xx)." }, "status_range": { "type": "object", "examples": [ { "start": 400, "end": 499 }, { "start": 500, "end": 599 } ], "properties": { "start": { "type": "integer", "maximum": 599, "minimum": 400, "description": "Inclusive lower bound of the HTTP status range (must be within 4xx or 5xx)." }, "end": { "type": "integer", "maximum": 599, "minimum": 400, "description": "Inclusive upper bound of the HTTP status range (must be within 4xx or 5xx)." } }, "required": [ "start", "end" ], "additionalProperties": false, "description": "Inclusive HTTP status code range to match (for example 4xx or 5xx blocks)." }, "error_document": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": "^[^/].*", "description": "Path to the custom error page document relative to the bucket root (e.g., '404.html', 'errors/404.html'). Must not start with '/'.", "example": "404.html" } }, "title": "Static Website Error Page", "required": [ "error_document" ], "additionalProperties": false, "description": "Custom error page configuration for specific HTTP status codes or ranges" }, "objectStorage2ServiceModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "example-service", "configured_status": "started", "networks": [ { "name": "example-private-network", "uuid": "03aa7245-2ff9-49c8-9f0e-7ca0270d71a4", "type": "private", "family": "IPv4" } ], "labels": null } ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "example": "example-service" }, "configured_status": { "$ref": "#/components/schemas/objectStorage2PropertyConfiguredStatus" }, "networks": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/objectStorage2NetworkCreate" }, "maxItems": 8 }, "custom_domains": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/objectStorage2CustomDomainCreate" }, "maxItems": 5 }, "static_websites": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/objectStorage2StaticWebsiteConfigCreate" }, "description": "Static website configurations for this service. Array replaces all existing configurations." }, "labels": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/objectStorage2LabelCreate" }, "maxItems": 255 }, "properties": { "$ref": "#/components/schemas/objectStorage2PropertiesCreate" }, "termination_protection": { "type": "boolean", "description": "Enables or disables termination protection for the service. When enabled, the service cannot be deleted or powered down unless this is disabled first.", "example": false } }, "title": "ServiceModify", "additionalProperties": false, "description": "Schema for modifying a service, including name, status, networks, domains, labels, and properties." }, "objectStorage2CustomDomainModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "type": "public", "domain_name": "example.com" } ], "properties": { "type": { "type": "string", "enum": [ "public", "private" ], "description": "Type of the custom domain." }, "domain_name": { "type": "string", "maxLength": 254, "minLength": 1, "format": "hostname", "description": "New modified custom domain. Supports both apex domains (example.com) and subdomains (objects.example.com)." } }, "title": "CustomDomainModify", "additionalProperties": false, "description": "Schema for modifying a custom domain." }, "objectStorage2BucketCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "my-bucket-1" } ], "properties": { "name": { "type": "string", "maxLength": 254, "minLength": 1, "pattern": "^[a-zA-Z0-9.\\-_]{1,254}$", "description": "Must be unique within the service, and should contain only alphanumeric, .,- and _.", "example": "my-bucket-1" } }, "title": "BucketCreate", "required": [ "name" ], "additionalProperties": false, "description": "Schema for creating a new bucket. " }, "objectStorage2LabelModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "key": "foo", "value": "bar" } ], "properties": { "key": { "$ref": "#/components/schemas/objectStorage2LabelKey" }, "value": { "$ref": "#/components/schemas/objectStorage2LabelValue" } }, "title": "LabelModify", "additionalProperties": false, "description": "Schema for modifying a label with a key-value pair." }, "objectStorage2StaticWebsiteConfigModify": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "bucket_name": { "type": "string", "maxLength": 254, "minLength": 1, "pattern": "^[a-zA-Z0-9.\\-_]+$", "description": "Name of the S3/ECS bucket containing the website content. Only alphanumerics, dots, hyphens, and underscores are allowed.", "example": "my-website" }, "bucket_prefix": { "type": "string", "maxLength": 1024, "pattern": "^[a-zA-Z0-9/.\\-_]*$", "description": "Optional prefix/subfolder within the bucket. Only alphanumerics, slashes, dots, hyphens, and underscores are allowed.", "example": "v2/" }, "index_document": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9/.\\-_]+$", "description": "Default document for directories. Only alphanumerics, slashes, dots, hyphens, and underscores are allowed.", "example": "index.html" }, "spa_mode": { "type": [ "boolean", "null" ], "description": "Enable Single Page Application (SPA) mode. When enabled, all non-file routes serve the index document, allowing client-side routing to handle the URL. Essential for React, Vue, Next.js, and similar frameworks.", "example": true }, "enabled": { "type": "boolean", "description": "Whether the static website configuration should be active", "example": false }, "error_pages": { "type": "array", "items": { "$ref": "#/components/schemas/objectStorage2StaticWebsiteErrorPage" }, "maxItems": 25, "description": "Custom error page configurations for specific HTTP status codes or ranges. Replaces the entire set when provided.", "example": [ { "status_code": 404, "error_document": "errors/404.html" }, { "status_range": { "start": 500, "end": 599 }, "error_document": "errors/5xx.html" } ] } }, "title": "StaticWebsiteConfigModify", "additionalProperties": false, "description": "Request body for updating a static website configuration" }, "objectStorage2UserCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "username": "example_user" } ], "properties": { "username": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "[\\w+=,.@-]+", "description": "The name of the user to create.", "example": "example_user" } }, "title": "UserCreate", "required": [ "username" ], "additionalProperties": false, "description": "Schema for creating a new user." }, "objectStorage2AccessKeyModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "status": "Inactive" } ], "properties": { "status": { "type": "string", "enum": [ "Active", "Inactive" ], "description": "Indicates if the key is active or inactive.", "example": "Inactive" } }, "title": "AccessKeyModify", "additionalProperties": false, "description": "Schema for modifying an access key." }, "objectStorage2PolicyAttachmentCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "test-policy" } ], "properties": { "name": { "type": "string", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9+=,.@_\\- ]+$", "description": "Name of the policy to attach.", "example": "test-policy" } }, "title": "PolicyAttachmentCreate", "required": [ "name" ], "additionalProperties": false, "description": "Schema for creating a policy attachment." }, "objectStorage2InlinePolicyCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "ECSS3FullAccess", "document": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Action\":\"sts:AssumeRole\",\"Effect\":\"Allow\",\"Resource\":\"*\"}]}" } ], "properties": { "name": { "type": "string", "maxLength": 128, "minLength": 1, "description": "Name of the inline policy.", "example": "ECSS3FullAccess" }, "document": { "type": "string", "maxLength": 6144, "minLength": 1, "description": "A valid policy document.", "example": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Action\":\"sts:AssumeRole\",\"Effect\":\"Allow\",\"Resource\":\"*\"}]}" } }, "title": "InlinePolicyCreate", "required": [ "name", "document" ], "description": "Schema for creating an inline policy." }, "objectStorage2TagListRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "key": "environment", "value": "production" }, { "key": "team", "value": "backend" } ] ], "items": { "type": "object", "properties": { "key": { "type": "string", "example": "environment" }, "value": { "type": "string", "example": "production" } }, "title": "TagListRequest", "required": [ "key", "value" ] }, "title": "TagListRequest", "description": "Schema for a list of tags to apply to a resource." }, "objectStorage2PermissionsBoundaryCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "policy_name": "sample-policy" } ], "properties": { "policy_name": { "type": "string", "maxLength": 128, "minLength": 1, "description": "Name of the policy to use as the permissions boundary.", "example": "sample-policy" } }, "title": "PermissionsBoundaryCreate", "required": [ "policy_name" ], "description": "Schema for creating a permissions boundary with a specified policy name." }, "objectStorage2PolicyVersionCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "document": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Action\":[\"*\"],\"Effect\":\"Deny\",\"Resource\":\"*\"}]}", "is_default": true } ], "properties": { "document": { "type": "string", "maxLength": 6144, "minLength": 1, "description": "A valid, URL-encoded policy document.", "example": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Action\":[\"*\"],\"Effect\":\"Deny\",\"Resource\":\"*\"}]}" }, "is_default": { "type": "boolean", "description": "Set this version as the default.", "default": false } }, "title": "PolicyVersionCreate", "required": [ "is_default", "document" ], "additionalProperties": false, "description": "Schema for creating a new version of a policy." }, "objectStorage2PolicySetDefaultVersion": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "version_id": "v2" } ], "properties": { "version_id": { "type": "string", "description": "The policy version ID to set as default.", "example": "v2" } }, "title": "PolicySetDefaultVersion", "required": [ "version_id" ], "description": "Schema for setting a default version of a policy." }, "objectStorage2PolicyCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "example-policy", "description": "example-description", "document": "%7B%22Version%22%3A%20%222012-10-17%22%2C%20%20%22Statement%22%3A%20%5B%7B%22Action%22%3A%20%5B%22iam%3AGetUser%22%5D%2C%20%22Resource%22%3A%20%22%2A%22%2C%20%22Effect%22%3A%20%22Allow%22%2C%20%22Sid%22%3A%20%22editor%22%7D%5D%7D" } ], "properties": { "name": { "type": "string", "maxLength": 128, "minLength": 1, "pattern": "[\\w+=,.@-]+", "description": "Unique name of the policy.", "example": "example-policy" }, "description": { "type": "string", "maxLength": 1000, "minLength": 1, "description": "The policy description.", "example": "example-description" }, "document": { "type": "string", "maxLength": 6144, "minLength": 1, "description": "A valid, URL-encoded policy document.", "example": "%7B%22Version%22%3A%20%222012-10-17%22%2C%20%20%22Statement%22%3A%20%5B%7B%22Action%22%3A%20%5B%22iam%3AGetUser%22%5D%2C%20%22Resource%22%3A%20%22%2A%22%2C%20%22Effect%22%3A%20%22Allow%22%2C%20%22Sid%22%3A%20%22editor%22%7D%5D%7D" } }, "title": "PolicyCreate", "required": [ "name", "document" ], "additionalProperties": false, "description": "Schema for creating a policy with a name, description, and document." }, "objectStorage2GroupCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "new-group" } ], "properties": { "name": { "type": "string", "maxLength": 128, "minLength": 1, "pattern": "[\\w+=,.@-]+", "description": "A valid string to represent the name of the IAM group.", "example": "new-group" } }, "title": "GroupCreate", "required": [ "name" ], "additionalProperties": false, "description": "Schema for creating a new IAM group." }, "objectStorage2RoleCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "assume_role_policy_document": "{\"Version\": \"2012-10-17\",\"Statement\": [{\"Action\": \"sts:AssumeRole\",\"Principal\": {\"AWS\": [\"urn:ecs:iam::ns1:user/Demby\"]},\"Effect\": \"Allow\",\"Resource\": \"*\"}]}", "description": "A test role.", "max_session_duration": 3600, "name": "test-role", "permissions_boundary": "test-policy", "tags": [ { "key": "department", "value": "Finance" }, { "key": "school", "value": "University of Helsinki" } ] } ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "[\\w+=,.@-]+", "example": "test-role" }, "assume_role_policy_document": { "type": "string", "maxLength": 131072, "minLength": 1, "description": "The policy document that grants an entity permission to assume the role.", "example": "{\"Version\": \"2012-10-17\",\"Statement\": [{\"Action\": \"sts:AssumeRole\",\"Principal\": {\"AWS\": [\"urn:ecs:iam::ns1:user/Demby\"]},\"Effect\": \"Allow\",\"Resource\": \"*\"}]}" }, "description": { "type": "string", "maxLength": 1000, "description": "Description of the role.", "example": "A test role." }, "max_session_duration": { "type": "integer", "maximum": 43200, "minimum": 3600, "format": "int32", "description": "Maximum session duration in seconds." }, "permissions_boundary": { "type": "string", "maxLength": 128, "minLength": 1, "description": "Policy name to set as the permissions boundary.", "example": "test-policy" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/objectStorage2RoleTag" }, "description": "Tags to attach to the role (max 50)." } }, "title": "RoleCreate", "required": [ "name", "assume_role_policy_document" ], "additionalProperties": false, "description": "Schema for creating a new role." }, "objectStorage2RoleTag": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "key": "foo", "value": "bar" } ], "properties": { "key": { "$ref": "#/components/schemas/objectStorage2TagKey" }, "value": { "$ref": "#/components/schemas/objectStorage2TagValue" } }, "title": "RoleTag", "required": [ "key" ], "additionalProperties": false, "description": "Schema for tagging roles with key-value pairs." }, "objectStorage2TagValue": { "type": "string", "examples": [ "production", "backend", "web-app", "backup", "engineering", "public" ], "title": "TagValue", "maxLength": 256, "description": "The value of a tag." }, "objectStorage2RoleUpdate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "description": "New description", "max_session_duration": 3900 } ], "properties": { "description": { "type": "string", "maxLength": 1000, "description": "New description for the role.", "example": "New description" }, "max_session_duration": { "type": "integer", "maximum": 43200, "minimum": 3600, "format": "int32", "description": "New maximum session duration in seconds." } }, "title": "RoleUpdate", "additionalProperties": false, "description": "Schema for updating an existing role." }, "objectStorage2AssumeRolePolicyRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "document": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":\"backup.upcloud.com\"},\"Action\":\"sts:AssumeRole\"}]}" } ], "properties": { "document": { "type": "string", "description": "The assume role policy document that grants an entity permission to assume the role.", "example": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":\"backup.upcloud.com\"},\"Action\":\"sts:AssumeRole\"}]}" } }, "title": "AssumeRolePolicyRequest", "required": [ "document" ], "description": "Schema for the request to assume a role with a policy document." }, "objectStorage2ServiceListResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "configured_status": "started", "created_at": "2023-05-07T15:55:24.655776Z", "custom_domains": [ { "domain_name": "objects.example-company.com", "type": "public" } ], "endpoints": [ { "domain_name": "7mf5k.upbucket.com", "iam_url": "https://7mf5k.upbucket.com:4443/iam", "sts_url": "https://7mf5k.upbucket.com:4443/sts", "type": "public" }, { "domain_name": "7mf5k-private.upbucket.com", "iam_url": "https://7mf5k-private.upbucket.com:4443/iam", "sts_url": "https://7mf5k-private.upbucket.com:4443/sts", "type": "private" }, { "domain_name": "static.7mf5k.upbucket.com", "type": "static" } ], "labels": [ { "key": "example-key", "value": "example-value" } ], "name": "example-service", "networks": [ { "family": "IPv4", "name": "example-public-network", "type": "public" }, { "family": "IPv4", "name": "example-private-network", "type": "private", "uuid": "03aa7245-2ff9-49c8-9f0e-7ca0270d71a4" } ], "operational_state": "running", "region": "europe-1", "state_messages": [], "static_website": [ { "domain": "objects.example-company.com", "custom_domain_id": 1, "bucket_name": "website-prod", "bucket_prefix": "public/", "index_document": "index.html", "status": "active", "error_pages": [ { "status_code": 404, "error_document": "404.html" }, { "status_range": { "start": 500, "end": 599 }, "error_document": "500.html" }, { "status_range": { "start": 500, "end": 510 }, "error_document": "500.html" } ], "created_at": "2023-05-07T16:10:30.123456Z", "updated_at": "2023-05-07T16:10:30.123456Z" } ], "updated_at": "2023-05-07T21:38:15.757405Z", "usage": { "total_objects": 310499, "total_size_bytes": 32414921734 }, "uuid": "1200ecde-db95-4d1c-9133-6508f3232567" } ] ], "items": { "$ref": "#/components/schemas/objectStorage2ServiceDetailResponse" }, "title": "ServiceListResponse", "description": "Response schema for a list of services." }, "objectStorage2ServiceDetailResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "configured_status": "started", "created_at": "2023-05-07T15:55:24.655776Z", "custom_domains": [], "endpoints": [ { "type": "public", "mode": "api", "domain_name": "7mf5k.upbucket.com", "iam_url": "https://7mf5k.upbucket.com:4443/iam", "sts_url": "https://7mf5k.upbucket.com:4443/sts" }, { "type": "private", "mode": "api", "domain_name": "7mf5k-private.upbucket.com", "iam_url": "https://7mf5k-private.upbucket.com:4443/iam", "sts_url": "https://7mf5k-private.upbucket.com:4443/sts" }, { "type": "public", "mode": "static-website", "domain_name": "7mf5k-static.upbucket.com" } ], "labels": [ { "key": "example-key", "value": "example-value" } ], "name": "example-service", "networks": [ { "family": "IPv4", "name": "example-public-network", "type": "public" }, { "family": "IPv4", "name": "example-private-network", "type": "private", "uuid": "03aa7245-2ff9-49c8-9f0e-7ca0270d71a4" } ], "operational_state": "setup-checkup", "region": "europe-1", "state_messages": [ { "code": "waiting_certificate_issuing", "created_at": "2025-01-16T11:20:40.372611Z", "message": "Certificate issuing is in progress for domains: 7mf5k-private.upbucket.com, *.7mf5k-private.upbucket.com.", "operational_state": "setup-checkup", "updated_at": "2025-01-16T11:20:40.372611Z" } ], "static_websites": [ { "domain_name": "7mf5k-static.upbucket.com", "bucket_name": "my-website", "bucket_prefix": "", "index_document": "index.html", "enabled": true, "error_pages": [ { "status_code": 404, "error_document": "404.html" } ], "created_at": "2023-05-07T15:55:24.655776Z", "updated_at": "2023-05-07T15:55:24.655776Z" } ], "updated_at": "2023-05-07T21:38:15.757405Z", "usage": { "total_objects": 310499, "total_size_bytes": 32414921734 }, "users": [ { "access_keys": [ { "access_key_id": "AKIA63F41D01345BB477", "created_at": "2023-05-07T20:52:19.705405Z", "last_used_at": "2023-05-07T20:52:17Z", "status": "Active" } ], "arn": "urn:ecs:iam::123bbb5c6a4240409e07f7d89fe28891:user/example_user", "created_at": "2023-05-07T15:55:24.655776Z", "policies": [ { "arn": "urn:ecs:iam:::policy/ECSS3FullAccess", "name": "ECSS3FullAccess" }, { "arn": "urn:ecs:iam:::policy/IAMFullAccess", "name": "IAMFullAccess" } ], "username": "example_user" } ], "uuid": "1200ecde-db95-4d1c-9133-6508f3232567" } ], "properties": { "uuid": { "type": "string", "example": "1200ecde-db95-4d1c-9133-6508f3232567" }, "name": { "type": "string", "example": "example-service" }, "region": { "type": "string", "example": "europe-1" }, "configured_status": { "type": "string", "enum": [ "started", "stopped" ], "example": "started" }, "operational_state": { "type": "string", "enum": [ "pending", "setup-service", "setup-network", "setup-tls", "setup-public-endpoint", "setup-private-endpoint", "setup-dns", "cleanup-deleted-buckets", "setup-iam", "setup-checkup", "running", "stopped", "delete-private-endpoint", "delete-public-endpoint", "delete-buckets", "delete-iam", "delete-namespace", "delete-dns", "delete-tls", "delete-network", "delete-service" ], "example": "running" }, "networks": { "type": "array", "items": { "$ref": "#/components/schemas/objectStorage2NetworkDetailResponse" } }, "usage": { "type": "object", "properties": { "total_size_bytes": { "type": "integer", "example": 32414921734 }, "total_objects": { "type": "integer", "example": 310499 } } }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/objectStorage2LabelDetailResponse" } }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/objectStorage2UserDetailResponse" } }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/objectStorage2EndpointResponse" } }, "custom_domains": { "type": "array", "items": { "$ref": "#/components/schemas/objectStorage2CustomDomainDetailResponse" } }, "static_websites": { "type": "array", "items": { "$ref": "#/components/schemas/objectStorage2StaticWebsiteConfig" }, "description": "Static website configurations for this service" }, "state_messages": { "type": "array", "items": { "type": "object", "properties": { "operational_state": { "type": "string", "example": "setup-checkup" }, "message": { "type": "string", "example": "Certificate issuing is in progress for domains: example.com." }, "code": { "type": "string", "enum": [ "waiting_certificate_issuing", "failed_domain_verification", "failed_custom_domain_verification", "buckets_stuck_in_deletion", "namespace_stuck_in_deletion" ], "example": "waiting_certificate_issuing" }, "created_at": { "type": "string", "format": "date-time", "example": "2025-01-16T11:20:40.372611Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2025-01-16T11:20:40.372611Z" } } } }, "termination_protection": { "type": "boolean", "example": false }, "created_at": { "type": "string", "format": "date-time", "example": "2023-05-07T15:55:24.655776Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2023-05-07T21:38:15.757405Z" } }, "title": "ServiceDetailResponse", "description": "Response schema for service details, including UUID, name, and endpoints." }, "objectStorage2NetworkDetailResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "family": "IPv4", "name": "example-private-network", "type": "private", "uuid": "03bec0ad-85c3-459e-824d-710f8f24f740" } ], "properties": { "family": { "type": "string", "example": "IPv4" }, "name": { "type": "string", "example": "example-private-network" }, "type": { "type": "string", "example": "private" }, "uuid": { "type": "string", "format": "uuid", "example": "03bec0ad-85c3-459e-824d-710f8f24f740" } }, "title": "NetworkDetailResponse", "description": "Schema for network details including family, name, type, and UUID." }, "objectStorage2LabelDetailResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "key": "foo", "value": "bar" } ], "properties": { "key": { "type": "string", "example": "foo" }, "value": { "type": "string", "example": "bar" } }, "title": "LabelDetailResponse", "description": "Schema for label details including key-value pairs." }, "objectStorage2UserDetailResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "access_keys": [ { "access_key_id": "AKIA63F41D01345BB477", "created_at": "2023-05-07T20:52:19.705405Z", "last_used_at": "2023-05-07T20:52:17Z", "status": "Active" } ], "arn": "urn:ecs:iam::123bbb5c6a4240409e07f7d89fe28891:user/example_user", "created_at": "2023-05-07T15:55:24.655776Z", "policies": [ { "arn": "urn:ecs:iam:::policy/ECSS3FullAccess", "name": "ECSS3FullAccess" }, { "arn": "urn:ecs:iam:::policy/IAMFullAccess", "name": "IAMFullAccess" } ], "username": "example_user" } ], "properties": { "username": { "type": "string", "examples": [ "example_user" ] }, "arn": { "type": "string", "examples": [ "urn:ecs:iam::123bbb5c6a4240409e07f7d89fe28891:user/example_user" ] }, "created_at": { "type": "string", "examples": [ "2023-05-07T15:55:24.655776Z" ], "format": "date-time" }, "access_keys": { "type": "array", "items": { "$ref": "#/components/schemas/objectStorage2AccessKeyDetailResponse" } }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/objectStorage2PolicyAttachmentResponse" } }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/objectStorage2TagResponse" } }, "permissions_boundary": { "$ref": "#/components/schemas/objectStorage2PermissionsBoundaryResponse" } }, "title": "UserDetailResponse", "description": "Response schema for user details." }, "objectStorage2AccessKeyDetailResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "access_key_id": "UCK1234567890ABCDEF", "secret_access_key": "", "status": "Active", "created_at": "2024-01-15T10:30:00Z", "last_used_at": "2024-01-20T14:22:15Z" } ], "properties": { "access_key_id": { "type": "string", "examples": [ "UCK1234567890ABCDEF" ] }, "created_at": { "type": "string", "examples": [ "2024-01-15T10:30:00Z" ], "format": "date-time" }, "last_used_at": { "type": "string", "examples": [ "2024-01-20T14:22:15Z" ], "format": "date-time" }, "secret_access_key": { "type": "string", "examples": [ "uCkS3cr3tK3y1234567890abcdefghijklmnopqrstuvwxyz" ], "description": "Only returned upon creation, empty otherwise." }, "status": { "type": "string", "examples": [ "Active" ], "enum": [ "Active", "Inactive" ] } }, "title": "AccessKeyDetailResponse", "description": "Response schema for access key details." }, "objectStorage2PolicyAttachmentResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "arn": "arn:upcloud:iam::01234567-89ab-cdef-0123-456789abcdef:policy/ECSReadOnlyAccess", "name": "ECSReadOnlyAccess" } ], "properties": { "arn": { "type": "string", "example": "arn:upcloud:iam::01234567-89ab-cdef-0123-456789abcdef:policy/ECSReadOnlyAccess" }, "name": { "type": "string", "example": "ECSReadOnlyAccess" } }, "title": "PolicyAttachmentResponse", "description": "Schema representing a policy attachment response." }, "objectStorage2TagResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "key": "foo", "value": "bar" } ], "properties": { "key": { "type": "string", "example": "foo" }, "value": { "type": "string", "example": "bar" } }, "title": "TagResponse", "description": "Schema for a key-value pair tag." }, "objectStorage2PermissionsBoundaryResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "sample-policy" ], "title": "PermissionsBoundaryResponse", "description": "Schema representing a permissions boundary response." }, "objectStorage2EndpointResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "domain_name": "objects.example.com", "iam_url": "https://7mf5k.upbucket.com:4443/iam", "sts_url": "https://7mf5k.upbucket.com:4443/sts", "type": "public", "mode": "api" }, { "domain_name": "abc123-static.upbucket.com", "type": "public", "mode": "static-website" } ], "properties": { "domain_name": { "type": "string", "example": "objects.example.com" }, "iam_url": { "type": "string", "format": "uri", "example": "https://7mf5k.upbucket.com:4443/iam" }, "sts_url": { "type": "string", "format": "uri", "example": "https://7mf5k.upbucket.com:4443/sts" }, "type": { "type": "string", "enum": [ "public", "private" ], "description": "The network access type of the endpoint", "example": "public" }, "mode": { "type": "string", "enum": [ "api", "static-website" ], "description": "The operational mode of the endpoint: 'api' for S3/IAM/STS access, 'static-website' for static website hosting", "example": "api" } }, "title": "EndpointResponse", "description": "Response schema for endpoint details." }, "objectStorage2CustomDomainDetailResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "domain_name": "example.com", "type": "public", "mode": "api" }, { "domain_name": "objects.example.com", "type": "public", "mode": "api" }, { "domain_name": "static.example.com", "type": "public", "mode": "static-website" } ], "properties": { "domain_name": { "type": "string", "description": "Custom domain name. Supports both apex domains and subdomains.", "example": "example.com" }, "type": { "type": "string", "description": "Endpoint type for the custom domain.", "example": "public" }, "mode": { "type": "string", "enum": [ "api", "static-website" ], "description": "Purpose of the domain. 'api' for S3 API access, 'static-website' for static website hosting.", "example": "api" } }, "title": "CustomDomainDetailResponse", "description": "Response schema for custom domain details." }, "objectStorage2StaticWebsiteConfig": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "domain_name": { "type": "string", "maxLength": 255, "minLength": 1, "description": "The domain this configuration applies to", "example": "abc123-static.upbucket.example.com" }, "bucket_name": { "type": "string", "maxLength": 254, "pattern": "^[a-zA-Z0-9.\\-_]*$", "description": "Name of the S3/ECS bucket containing the website content. Only alphanumerics, dots, hyphens, and underscores are allowed.", "example": "my-website" }, "bucket_prefix": { "type": "string", "maxLength": 1024, "pattern": "^[a-zA-Z0-9/.\\-_]*$", "description": "Optional prefix/subfolder within the bucket. Only alphanumerics, slashes, dots, hyphens, and underscores are allowed.", "default": "", "example": "v2/" }, "index_document": { "type": "string", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9/.\\-_]+$", "description": "Default document for directories. Only alphanumerics, slashes, dots, hyphens, and underscores are allowed.", "default": "index.html", "example": "index.html" }, "spa_mode": { "type": "boolean", "description": "Enable Single Page Application (SPA) mode. When enabled, all non-file routes serve the index document, allowing client-side routing to handle the URL. Essential for React, Vue, Next.js, and similar frameworks.", "default": false, "example": true }, "error_pages": { "type": "array", "items": { "$ref": "#/components/schemas/objectStorage2StaticWebsiteErrorPage" }, "maxItems": 25, "description": "Custom error page configurations for specific HTTP status codes or ranges", "example": [ { "status_code": 403, "error_document": "errors/403.html" }, { "status_code": 404, "error_document": "errors/404.html" }, { "status_range": { "start": 400, "end": 499 }, "error_document": "errors/4xx.html" } ] }, "enabled": { "type": "boolean", "description": "Whether the static website configuration is currently active", "example": true }, "created_at": { "type": "string", "format": "date-time", "description": "Timestamp when this configuration was created", "example": "2025-10-28T10:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "Timestamp when this configuration was last updated", "example": "2025-10-28T12:00:00Z" } }, "title": "StaticWebsiteConfig", "required": [ "domain_name", "bucket_name", "bucket_prefix", "index_document", "error_pages", "enabled", "created_at", "updated_at" ], "description": "Static website hosting configuration for a specific domain." }, "objectStorage2ErrorResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "type": "https://developers.upcloud.com/1.3/errors#ERROR_INVALID_REQUEST", "title": "Validation error.", "invalid_params": [ { "name": "configured_status", "reason": "Value must be one of \"started\", \"stopped\"." } ], "correlation_id": "01K1ZM92JWR9YMWTCMV6JPSQ0J", "status": 400 }, { "type": "https://developers.upcloud.com/1.3/errors#ERROR_RESOURCE_NOT_FOUND", "title": "The resource you requested does not exist.", "correlation_id": "01K1ZJC6MSN91RQS3JMEESGG92", "status": 404 }, { "type": "https://developers.upcloud.com/1.3/errors#ERROR_GENERAL_FAILURE", "title": "Your request could not be fulfilled due to a technical issue.", "correlation_id": "01HEPYJ027RF0H29CKHWHCH7RE", "status": 500 } ], "properties": { "type": { "type": "string", "enum": [ "https://developers.upcloud.com/1.3/errors#ERROR_INVALID_REQUEST", "https://developers.upcloud.com/1.3/errors#ERROR_RESOURCE_NOT_FOUND", "https://developers.upcloud.com/1.3/errors#ERROR_INSUFFICIENT_CREDITS", "https://developers.upcloud.com/1.3/errors#ERROR_GENERAL_FAILURE" ], "description": "Error code string.", "example": "https://developers.upcloud.com/1.3/errors#ERROR_INVALID_REQUEST" }, "title": { "type": "string", "examples": [ "Validation error.", "The resource you requested does not exist.", "Your request could not be fulfilled due to a technical issue." ], "description": "Short description of the error." }, "correlation_id": { "type": "string", "examples": [ "01K1K2TKEASWRJ6VFP9ZV5P2H4" ], "description": "Unique identifier for the request, useful for debugging." }, "status": { "type": "integer", "examples": [ 400, 404, 402, 500 ], "format": "int32", "description": "HTTP status code associated with the error." }, "invalid_params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "zone", "networks.0.ip_address" ], "description": "Path to the field with invalid parameter." }, "reason": { "type": "string", "examples": [ "Zone is not valid." ], "description": "Human-readable error message." } }, "required": [ "name", "reason" ] }, "title": "InvalidParameters", "description": "List of invalid parameters in the request." } }, "title": "ErrorResponse", "required": [ "type", "title", "correlation_id", "status" ], "additionalProperties": false, "description": "Schema for error responses from the API." }, "objectStorage2NetworkListResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "family": "IPv4", "name": "example-public-network", "type": "public" }, { "family": "IPv4", "name": "example-private-network", "type": "private", "uuid": "03aa7245-2ff9-49c8-9f0e-7ca0270d71a4" } ] ], "items": { "$ref": "#/components/schemas/objectStorage2NetworkDetailResponse" }, "title": "NetworkListResponse", "description": "Response schema for a list of network details." }, "objectStorage2CustomDomainListResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "domain_name": "example.com", "type": "public", "mode": "api" }, { "domain_name": "objects.example.com", "type": "public", "mode": "api" }, { "domain_name": "static.example.com", "type": "public", "mode": "static-website" } ] ], "items": { "$ref": "#/components/schemas/objectStorage2CustomDomainDetailResponse" }, "title": "CustomDomainListResponse", "description": "Response schema for listing custom domains." }, "objectStorage2RegionListResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "name": "europe-1", "primary_zone": "fi-hel1", "zones": [ { "name": "fi-hel1" }, { "name": "de-fra1" } ] } ] ], "items": { "$ref": "#/components/schemas/objectStorage2RegionDetailResponse" }, "title": "RegionListResponse", "description": "Response schema for listing regions." }, "objectStorage2RegionDetailResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "europe-1", "primary_zone": "fi-hel1", "zones": [ { "name": "fi-hel1" }, { "name": "de-fra1" } ] } ], "properties": { "name": { "type": "string", "example": "europe-1" }, "primary_zone": { "type": "string", "example": "fi-hel1" }, "zones": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "fi-hel1" } } } } }, "title": "RegionDetailResponse", "description": "Response schema for detailed information about a specific region." }, "objectStorage2MetricsUsageResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "total_objects": 1000, "total_size_bytes": 1073741824 } ], "properties": { "total_objects": { "type": "integer", "format": "int32" }, "total_size_bytes": { "type": "integer", "format": "int64" } }, "title": "MetricsUsageResponse", "description": "Response schema for service usage metrics." }, "objectStorage2BucketListResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "name": "my-bucket-1", "total_objects": 1000, "total_size_bytes": 1073741824 } ] ], "items": { "$ref": "#/components/schemas/objectStorage2BucketDetailResponse" }, "title": "BucketListResponse", "description": "Response schema for listing buckets." }, "objectStorage2BucketDetailResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "my-bucket-1", "total_objects": 1000, "total_size_bytes": 1073741824, "deleted": false } ], "properties": { "name": { "type": "string", "example": "my-bucket-1" }, "total_objects": { "type": "integer", "format": "int32" }, "total_size_bytes": { "type": "integer", "format": "int64" }, "deleted": { "type": "boolean", "example": false } }, "title": "BucketDetailResponse", "description": "Response schema for bucket details." }, "objectStorage2MetricsSeriesListResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "bytes_created": 530000, "bytes_deleted": 244000, "bytes_received": 530000, "bytes_total": 7502000, "bytes_transmitted": 0, "end_at": "2023-10-31T12:00:00Z", "objects_created": 79, "objects_deleted": 40, "objects_total": 1237, "start_at": "2023-10-31T11:00:00Z" } ] ], "items": { "type": "object", "properties": { "bytes_created": { "type": "integer", "format": "int64" }, "bytes_deleted": { "type": "integer", "format": "int64" }, "bytes_received": { "type": "integer", "format": "int64" }, "bytes_total": { "type": "integer", "format": "int64" }, "bytes_transmitted": { "type": "integer", "format": "int64" }, "end_at": { "type": "string", "examples": [ "2023-10-31T12:00:00Z" ], "format": "date-time" }, "objects_created": { "type": "integer", "format": "int32" }, "objects_deleted": { "type": "integer", "format": "int32" }, "objects_total": { "type": "integer", "format": "int32" }, "start_at": { "type": "string", "examples": [ "2023-10-31T11:00:00Z" ], "format": "date-time" } } }, "title": "MetricsSeriesListResponse", "description": "Response schema for listing metrics series." }, "objectStorage2LabelListResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "key": "foo", "value": "bar" } ] ], "items": { "$ref": "#/components/schemas/objectStorage2LabelDetailResponse" }, "title": "LabelListResponse", "description": "Response schema for listing labels." }, "objectStorage2ServiceDomains": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "domains": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string", "description": "Domain name (e.g., unc38.local.upbucket.com)", "example": "unc38.local.upbucket.com" }, "type": { "type": "string", "enum": [ "public", "private", "custom" ], "description": "Type of domain (public endpoint, private endpoint, or custom domain)", "example": "public" }, "active": { "type": "boolean", "description": "Whether this domain is active and ready to use (always true for enabled public/private endpoints, true for custom domains only if certificate is ready)", "example": true }, "static_website_configured": { "type": "boolean", "description": "Whether static website hosting is configured for this domain", "example": false } }, "required": [ "domain", "type", "active", "static_website_configured" ] }, "description": "List of all service domains (public, private, custom) with their static website hosting availability and configuration status" } }, "title": "ServiceDomains", "required": [ "domains" ], "description": "Service domains with their static website hosting status" }, "objectStorage2UserListResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "access_keys": [ { "access_key_id": "AKIA63F41D01345BB477", "created_at": "2023-05-07T20:52:19.705405Z", "last_used_at": "2023-05-07T20:52:17Z", "status": "Active" } ], "arn": "urn:ecs:iam::123bbb5c6a4240409e07f7d89fe28891:user/example_user", "created_at": "2023-05-07T15:55:24.655776Z", "policies": [ { "arn": "urn:ecs:iam:::policy/ECSS3FullAccess", "name": "ECSS3FullAccess" }, { "arn": "urn:ecs:iam:::policy/IAMFullAccess", "name": "IAMFullAccess" } ], "username": "example_user" } ] ], "items": { "$ref": "#/components/schemas/objectStorage2UserDetailResponse" }, "title": "UserListResponse", "description": "Response schema for listing users." }, "objectStorage2AccessKeyListResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "access_key_id": "UCK1234567890ABCDEF", "status": "Active", "created_at": "2024-01-15T10:30:00Z", "last_used_at": "2024-01-20T14:22:15Z" } ] ], "items": { "$ref": "#/components/schemas/objectStorage2AccessKeyDetailResponse" }, "title": "AccessKeyListResponse", "description": "Response schema for listing access keys." }, "objectStorage2CreateAccessKeyResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "access_key_id": "UCK1234567890ABCDEF", "secret_access_key": "uCkS3cr3tK3y1234567890abcdefghijklmnopqrstuvwxyz", "status": "Active", "created_at": "2024-01-15T10:30:00Z" } ], "properties": { "access_key_id": { "type": "string" }, "created_at": { "type": "string", "examples": [ "2024-01-15T10:30:00Z" ], "format": "date-time" }, "last_used_at": { "type": "string", "examples": [ "2024-01-15T10:30:00Z" ], "format": "date-time" }, "secret_access_key": { "type": "string", "examples": [ "uCkS3cr3tK3y1234567890abcdefghijklmnopqrstuvwxyz" ], "description": "This is only returned upon creation." }, "status": { "type": "string", "examples": [ "Active" ], "enum": [ "Active", "Inactive" ] } }, "title": "CreateAccessKeyResponse", "description": "Response schema for creating an access key." }, "objectStorage2PolicyAttachmentListResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "arn": "arn:upcloud:iam::01234567-89ab-cdef-0123-456789abcdef:policy/ECSReadOnlyAccess", "name": "ECSReadOnlyAccess" } ] ], "items": { "$ref": "#/components/schemas/objectStorage2PolicyAttachmentResponse" }, "title": "PolicyAttachmentListResponse", "description": "Response schema for listing policy attachments." }, "objectStorage2InlinePolicyResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "ECSS3FullAccess", "document": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Action\":\"sts:AssumeRole\",\"Effect\":\"Allow\",\"Resource\":\"*\"}]}" } ], "properties": { "document": { "type": "string", "example": "ECSS3FullAccess" }, "name": { "type": "string", "example": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Action\":\"sts:AssumeRole\",\"Effect\":\"Allow\",\"Resource\":\"*\"}]}" } }, "title": "InlinePolicyResponse", "description": "Schema representing an inline policy response." }, "objectStorage2InlinePolicyListResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "name": "ECSS3FullAccess", "document": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Action\":\"sts:AssumeRole\",\"Effect\":\"Allow\",\"Resource\":\"*\"}]}" } ] ], "items": { "$ref": "#/components/schemas/objectStorage2InlinePolicyResponse" }, "title": "InlinePolicyListResponse", "description": "Response schema for listing inline policies." }, "objectStorage2TagListResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "key": "environment", "value": "production" }, { "key": "team", "value": "backend" } ] ], "items": { "type": "object", "properties": { "key": { "type": "string", "maxLength": 128, "minLength": 1, "example": "environment" }, "value": { "type": "string", "maxLength": 256, "example": "production" } }, "required": [ "key" ] }, "title": "TagListResponse", "description": "Response schema for listing tags associated with a resource." }, "objectStorage2PolicyVersionListResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "create_date": "2024-03-25T12:47:40Z", "document": "%7B%22Version%22%3A%222012-10-17%22%2C%22Statement%22%3A%5B%7B%22Action%22%3A%5B%22*%22%5D%2C%22Resource%22%3A%22*%22%2C%22Effect%22%3A%22Deny%22%7D%5D%7D", "is_default": false, "version_id": "v4" }, { "create_date": "2024-03-25T12:47:38Z", "document": "%7B%22Version%22%3A%222012-10-17%22%2C%22Statement%22%3A%5B%7B%22Action%22%3A%5B%22*%22%5D%2C%22Resource%22%3A%22*%22%2C%22Effect%22%3A%22Deny%22%7D%5D%7D", "is_default": false, "version_id": "v3" } ] ], "items": { "$ref": "#/components/schemas/objectStorage2PolicyVersionResponse" }, "title": "PolicyVersionListResponse", "description": "Response schema for a list of policy versions." }, "objectStorage2PolicyVersionResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "create_date": "2024-02-05T11:06:16Z", "document": "%7B%22Version%22%3A%222012-10-17%22%2C%22Statement%22%3A%5B%7B%22Action%22%3A%5B%22%2A%22%5D%2C%22Effect%22%3A%22Deny%22%2C%22Resource%22%3A%22%2A%22%7D%5D%7D", "is_default": true, "version_id": "v2" } ], "properties": { "create_date": { "type": "string", "examples": [ "2024-02-05T11:06:16Z" ], "format": "date-time" }, "document": { "type": "string", "examples": [ "%7B%22Version%22%3A%222012-10-17%22%2C%22Statement%22%3A%5B%7B%22Action%22%3A%5B%22%2A%22%5D%2C%22Effect%22%3A%22Deny%22%2C%22Resource%22%3A%22%2A%22%7D%5D%7D" ] }, "is_default": { "type": "boolean" }, "version_id": { "type": "string", "examples": [ "v2" ] } }, "title": "PolicyVersionResponse", "description": "Schema for a policy version response, including creation date, document content, default status, and version ID." }, "objectStorage2PolicyDetailResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "arn": "urn:ecs:iam:::policy/ECSS3FullAccess", "attachment_count": 0, "created_at": "2024-02-05T11:06:16Z", "default_version_id": "v1", "description": "Provides full access to all buckets.", "document": "%7B%0A++++%22Version%22%3A+%222012-10-17%22%2C%0A++++%22Statement%22%3A+%5B%0A++++++++%7B%0A++++++++++++%22Effect%22%3A+%22Allow%22%2C%0A++++++++++++%22Action%22%3A+%22s3%3A*%22%2C%0A++++++++++++%22Resource%22%3A+%22*%22%0A++++++++%7D%0A++++%5D%0A%7D", "name": "ECSS3FullAccess", "system": true, "updated_at": "2024-02-05T11:06:16Z" } ], "properties": { "arn": { "type": "string", "examples": [ "urn:ecs:iam:::policy/ECSS3FullAccess" ] }, "attachment_count": { "type": "integer", "format": "int32" }, "created_at": { "type": "string", "examples": [ "2024-02-05T11:06:16Z" ], "format": "date-time" }, "default_version_id": { "type": "string", "examples": [ "v1" ] }, "description": { "type": "string", "examples": [ "Provides full access to all buckets." ] }, "document": { "type": "string", "examples": [ "%7B%0A++++%22Version%22%3A+%222012-10-17%22%2C%0A++++%22Statement%22%3A+%5B%0A++++++++%7B%0A++++++++++++%22Effect%22%3A+%22Allow%22%2C%0A++++++++++++%22Action%22%3A+%22s3%3A*%22%2C%0A++++++++++++%22Resource%22%3A+%22*%22%0A++++++++%7D%0A++++%5D%0A%7D" ] }, "name": { "type": "string", "examples": [ "ECSS3FullAccess" ] }, "system": { "type": "boolean" }, "updated_at": { "type": "string", "examples": [ "2024-02-05T11:06:16Z" ], "format": "date-time" } }, "title": "PolicyDetailResponse", "description": "Schema for policy details including ARN, attachment count, creation date, default version ID, description, document, name, system status, and last updated date." }, "objectStorage2PolicyListResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "arn": "urn:ecs:iam:::policy/ECSDenyAll", "attachment_count": 0, "created_at": "2024-02-05T11:06:17Z", "default_version_id": "v1", "description": "Deny all access.", "name": "ECSDenyAll", "system": true, "updated_at": "2024-02-05T11:06:17Z" }, { "arn": "urn:ecs:iam:::policy/ECSS3FullAccess", "attachment_count": 1, "created_at": "2024-02-05T11:06:16Z", "default_version_id": "v1", "description": "Provides full access to all buckets.", "name": "ECSS3FullAccess", "system": true, "updated_at": "2024-02-05T11:06:16Z" }, { "arn": "urn:ecs:iam:::policy/ECSS3ReadOnlyAccess", "attachment_count": 0, "created_at": "2024-02-05T11:06:16Z", "default_version_id": "v1", "description": "Provides read only access to all buckets.", "name": "ECSS3ReadOnlyAccess", "system": true, "updated_at": "2024-02-05T11:06:16Z" }, { "arn": "urn:ecs:iam:::policy/IAMFullAccess", "attachment_count": 1, "created_at": "2024-02-05T11:06:16Z", "default_version_id": "v1", "description": "Provides full access to IAM.", "name": "IAMFullAccess", "system": true, "updated_at": "2024-02-05T11:06:16Z" }, { "arn": "urn:ecs:iam:::policy/IAMReadOnlyAccess", "attachment_count": 0, "created_at": "2024-02-05T11:06:16Z", "default_version_id": "v1", "description": "Provides read only access to IAM.", "name": "IAMReadOnlyAccess", "system": true, "updated_at": "2024-02-05T11:06:16Z" } ] ], "items": { "$ref": "#/components/schemas/objectStorage2PolicyDetailResponse" }, "title": "PolicyListResponse", "description": "Response schema for listing policies." }, "objectStorage2GroupListResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "arn": "urn:ecs:iam::1263b59181cc4841969358b08ed70026:group/test-group", "created_at": "2024-04-15T16:28:45Z", "name": "test-group" } ] ], "items": { "$ref": "#/components/schemas/objectStorage2GroupResponse" }, "title": "GroupListResponse", "description": "Response schema for listing groups." }, "objectStorage2GroupResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "arn": "urn:ecs:iam::1263b59181cc4841969358b08ed70026:group/test-group", "created_at": "2024-04-15T16:28:45Z", "name": "test-group" } ], "properties": { "arn": { "type": "string", "examples": [ "urn:ecs:iam::1263b59181cc4841969358b08ed70026:group/test-group" ] }, "created_at": { "type": "string", "examples": [ "2024-04-15T16:28:45Z" ], "format": "date-time" }, "name": { "type": "string", "examples": [ "test-group" ] } }, "title": "GroupResponse", "description": "Response schema for group details." }, "objectStorage2RoleListResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "arn": "urn:ecs:iam::12e8c7066c0445c284c1381f899bcee7:role/example", "assume_role_policy_document": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Action\":\"sts:AssumeRole\",\"Principal\":{\"AWS\":[\"urn:ecs:iam::12442a2fbc06434889edb631be2d0968:user/user1\"]},\"Effect\":\"Allow\",\"Resource\":\"*\"}]}", "created_at": "2024-09-19T12:43:24Z", "description": "An example role", "inline_policies": [ { "name": "InlinePolicy" } ], "max_session_duration": 36000, "name": "example", "permissions_boundary": "SamplePolicy", "policies": [ { "arn": "urn:ecs:iam::12e8c7066c0445c284c1381f899bcee7:policy/SamplePolicy", "name": "SamplePolicy" } ] } ] ], "items": { "$ref": "#/components/schemas/objectStorage2RoleResponse" }, "title": "RoleListResponse", "description": "Response schema for listing roles." }, "objectStorage2RoleResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "arn": "urn:ecs:iam::12e8c7066c0445c284c1381f899bcee7:role/example", "assume_role_policy_document": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Action\":\"sts:AssumeRole\",\"Principal\":{\"AWS\":[\"urn:ecs:iam::12442a2fbc06434889edb631be2d0968:user/user1\"]},\"Effect\":\"Allow\",\"Resource\":\"*\"}]}", "created_at": "2024-09-19T12:43:24Z", "description": "An example role", "inline_policies": [ { "name": "InlinePolicy" } ], "max_session_duration": 36000, "name": "example", "permissions_boundary": "SamplePolicy", "policies": [ { "arn": "urn:ecs:iam::12e8c7066c0445c284c1381f899bcee7:policy/SamplePolicy", "name": "SamplePolicy" } ], "tags": [ { "key": "tag1", "value": "key1" }, { "key": "tag2", "value": "key2" } ] } ], "properties": { "arn": { "type": "string", "examples": [ "urn:ecs:iam::12e8c7066c0445c284c1381f899bcee7:role/example" ] }, "assume_role_policy_document": { "type": "string", "examples": [ "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Action\":\"sts:AssumeRole\",\"Principal\":{\"AWS\":[\"urn:ecs:iam::12442a2fbc06434889edb631be2d0968:user/user1\"]},\"Effect\":\"Allow\",\"Resource\":\"*\"}]}" ] }, "created_at": { "type": "string", "examples": [ "2024-09-19T12:43:24Z" ], "format": "date-time" }, "description": { "type": "string", "examples": [ "An example role" ] }, "inline_policies": { "type": "array", "items": { "properties": { "name": { "type": "string", "examples": [ "InlinePolicy" ] } } } }, "max_session_duration": { "type": "integer", "format": "int32" }, "name": { "type": "string", "examples": [ "example" ] }, "permissions_boundary": { "type": "string", "examples": [ "SamplePolicy" ] }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/objectStorage2PolicyAttachmentResponse" } }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/objectStorage2TagResponse" } } }, "title": "RoleResponse", "description": "Response schema for detailed information about a specific role." }, "objectStorage2AssumeRolePolicyResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "document": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":\"backup.upcloud.com\"},\"Action\":\"sts:AssumeRole\"}]}" } ], "properties": { "document": { "type": "string", "example": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":\"backup.upcloud.com\"},\"Action\":\"sts:AssumeRole\"}]}" } }, "title": "AssumeRolePolicyResponse", "description": "Response schema for assuming a role with a policy document." }, "fileStorageQueryParameterLimit": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "title": "QueryParameterLimit", "maximum": 100, "minimum": 0, "description": "Schema for the limit query parameter, used to specify the maximum number of items to return in a paginated response.", "default": 10 }, "fileStorageQueryParamOffset": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "title": "QueryParamOffset", "minimum": 0, "description": "Query parameter to specify the offset for pagination in API responses, allowing clients to retrieve results starting from a specific point.", "default": 0 }, "fileStorageQueryParamSort": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "title": "QueryParamSort", "enum": [ "created_at", "-created_at" ], "description": "Query parameter to specify the sorting order of results in API responses, allowing clients to order data based on specific fields.", "default": "-created_at" }, "fileStorageEntityUUID": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "17fd43a5-a97e-44f7-98a8-0a787da67069" ], "title": "EntityUUID", "format": "uuid", "description": "The unique identifier." }, "fileStorageName": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "test-name" ], "title": "Name", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "A resource name." }, "fileStorageLabelKey": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "environment" ], "title": "LabelKey", "maxLength": 32, "minLength": 2, "pattern": "^[\\x20-\\x5E\\x60-\\x7E][\\x20-\\x7E]+$", "description": "Represents the label identifier. The key is unique within a service." }, "fileStorageServiceCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "test-name", "zone": "fi-hel2", "configured_status": "started", "size_gib": 250, "encrypted": false, "networks": [ { "uuid": "03720d07-80a9-41ac-90b0-68a932109339", "name": "net", "family": "IPv4", "ip_address": "192.168.147.120" } ], "shares": [ { "name": "read", "path": "/public", "acl": [ { "name": "test-name", "target": "*", "permission": "ro" } ] }, { "name": "write", "path": "/project/data", "acl": [ { "name": "test-name", "target": "192.168.147.0/24", "permission": "rw" }, { "name": "test-name", "target": "local.domain", "permission": "rw" } ] } ], "labels": [ { "key": "environment", "value": "production" } ] } ], "properties": { "name": { "$ref": "#/components/schemas/fileStorageName" }, "zone": { "type": "string", "examples": [ "fi-hel2" ], "title": "Zone", "pattern": "^[a-z]{2}-[a-z]{3}\\d$", "description": "Indicates the zone where the service will be created." }, "configured_status": { "$ref": "#/components/schemas/fileStorageConfiguredStatus" }, "size_gib": { "$ref": "#/components/schemas/fileStorageSizeGiB" }, "encrypted": { "type": "boolean", "examples": [ true, false ], "title": "Encryption at Rest", "description": "Indicates whether encryption at rest is enabled for the service.", "default": false }, "networks": { "type": "array", "items": { "$ref": "#/components/schemas/fileStorageNetworkCreate" }, "maxItems": 1 }, "shares": { "type": "array", "items": { "$ref": "#/components/schemas/fileStorageShareCreate" }, "maxItems": 50 }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/fileStorageLabelCreate" }, "maxItems": 255, "description": "Labels" } }, "title": "ServiceCreate", "required": [ "name", "zone", "configured_status", "size_gib" ], "additionalProperties": false, "description": "Schema for creating a new service." }, "fileStorageConfiguredStatus": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "started" ], "title": "ConfiguredStatus", "enum": [ "started", "stopped" ], "description": "The service configured status indicates the service's current intended status. Managed by the customer." }, "fileStorageSizeGiB": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "examples": [ 250 ], "title": "SizeGiB", "maximum": 25000, "minimum": 250, "format": "int32", "description": "The size of the service in gibibytes (GiB)" }, "fileStorageNetworkCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "uuid": "03720d07-80a9-41ac-90b0-68a932109339", "name": "test-name", "family": "IPv4", "ip_address": "10.20.30.40" } ], "properties": { "uuid": { "$ref": "#/components/schemas/fileStorageNetworkUUID" }, "name": { "$ref": "#/components/schemas/fileStorageName" }, "family": { "$ref": "#/components/schemas/fileStorageNetworkFamily" }, "ip_address": { "$ref": "#/components/schemas/fileStorageIPAddress" } }, "title": "NetworkCreate", "required": [ "uuid", "name", "family" ], "additionalProperties": false, "description": "Schema for creating a network." }, "fileStorageNetworkUUID": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "03720d07-80a9-41ac-90b0-68a932109339" ], "title": "NetworkUUID", "format": "uuid", "description": "Unique identifier for the network." }, "fileStorageNetworkFamily": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "IPv4" ], "title": "NetworkFamily", "enum": [ "IPv4", "IPv6" ], "description": "Network family. IPv6 currently not supported." }, "fileStorageIPAddress": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "10.20.30.40" ], "title": "IPAddress", "format": "ipv4", "description": "The desired IP address for the service. If not specified, the service will be assigned an IP address from the network's pool." }, "fileStorageShareCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "read", "path": "/public", "acl": [ { "name": "test-name", "target": "192.168.147.0/24", "permission": "ro" } ] } ], "properties": { "name": { "type": "string", "examples": [ "test-name" ], "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "A resource name." }, "path": { "$ref": "#/components/schemas/fileStoragePath" }, "acl": { "type": "array", "items": { "$ref": "#/components/schemas/fileStorageAclCreate" }, "maxItems": 50 } }, "title": "ShareCreate", "required": [ "name", "path", "acl" ], "additionalProperties": false, "description": "Schema for creating a new share with access control lists (ACLs)." }, "fileStoragePath": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "/public", "/projects/myproject" ], "title": "Path", "maxLength": 512, "minLength": 1, "pattern": "^/[a-zA-Z0-9/_-]*$", "description": "The absolute path of the share." }, "fileStorageAclCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "$ref": "#/components/schemas/fileStorageName" }, "target": { "type": "string", "examples": [ "192.168.25.147", "192.168.25.0/24", "*" ], "maxLength": 255, "minLength": 1, "description": "The target of the ACL entry. It can be an IP Address, Network Prefix or a wildcard." }, "permission": { "$ref": "#/components/schemas/fileStoragePermission" } }, "title": "AclCreate", "required": [ "name", "target", "permission" ], "additionalProperties": false, "description": "Schema for creating an ACL entry." }, "fileStoragePermission": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "rw" ], "title": "Permission", "enum": [ "ro", "rw" ], "description": "The permission level for the ACL target." }, "fileStorageLabelCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "key": "environment", "value": "production" } ], "properties": { "key": { "$ref": "#/components/schemas/fileStorageLabelKey" }, "value": { "$ref": "#/components/schemas/fileStorageLabelValue" } }, "title": "LabelCreate", "required": [ "key", "value" ], "additionalProperties": false, "description": "Schema for creating a new label." }, "fileStorageLabelValue": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": [ "string", "null" ], "examples": [ "development" ], "title": "LabelValue", "maxLength": 255, "pattern": "\\A[\\p{L}\\p{N}\\p{P}\\p{S}\\p{M}\\p{Z}]*\\z", "description": "Represents the label value." }, "fileStorageServiceReplace": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "test-name", "configured_status": "started", "size_gib": 250, "networks": [ { "uuid": "03720d07-80a9-41ac-90b0-68a932109339", "name": "net", "family": "IPv4", "ip_address": "192.168.147.120" } ], "labels": [ { "key": "environment", "value": "production" } ] } ], "properties": { "name": { "$ref": "#/components/schemas/fileStorageName" }, "configured_status": { "$ref": "#/components/schemas/fileStorageConfiguredStatus" }, "size_gib": { "$ref": "#/components/schemas/fileStorageSizeGiB" }, "networks": { "type": "array", "items": { "$ref": "#/components/schemas/fileStorageNetworkCreate" }, "maxItems": 1 }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/fileStorageLabelCreate" }, "maxItems": 255, "description": "Labels" } }, "title": "ServiceReplace", "required": [ "name", "configured_status", "size_gib" ], "additionalProperties": false, "description": "Schema for replacing an existing service with a new configuration." }, "fileStorageServiceModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "test-name", "configured_status": "started", "size_gib": 250, "networks": [ { "uuid": "03720d07-80a9-41ac-90b0-68a932109339", "name": "net", "family": "IPv4", "ip_address": "192.168.147.120" } ], "labels": [ { "key": "environment", "value": "production" } ] } ], "properties": { "name": { "$ref": "#/components/schemas/fileStorageName" }, "configured_status": { "$ref": "#/components/schemas/fileStorageConfiguredStatus" }, "size_gib": { "$ref": "#/components/schemas/fileStorageSizeGiB" }, "networks": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/fileStorageNetworkCreate" }, "maxItems": 1 }, "labels": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/fileStorageLabelCreate" }, "maxItems": 255 } }, "title": "ServiceModify", "additionalProperties": false, "description": "Schema for modifying an existing service." }, "fileStorageNetworkModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "uuid": "03720d07-80a9-41ac-90b0-68a932109339", "name": "test-name", "family": "IPv4", "ip_address": "10.20.30.40" } ], "properties": { "uuid": { "$ref": "#/components/schemas/fileStorageNetworkUUID" }, "name": { "$ref": "#/components/schemas/fileStorageName" }, "family": { "$ref": "#/components/schemas/fileStorageNetworkFamily" }, "ip_address": { "$ref": "#/components/schemas/fileStorageIPAddress" } }, "title": "NetworkModify", "additionalProperties": false, "description": "Schema for modifying an existing network." }, "fileStorageShareModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "test-name", "acl": [ { "name": "test-name", "target": "192.168.25.0/24", "permission": "ro" } ] } ], "properties": { "name": { "type": "string", "examples": [ "test-name" ], "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "A resource name." }, "acl": { "type": "array", "items": { "$ref": "#/components/schemas/fileStorageAclCreate" }, "maxItems": 50 } }, "title": "ShareModify", "additionalProperties": false, "description": "Schema for modifying an existing share." }, "fileStorageAclModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "test-name", "target": "192.168.25.0/24", "permission": "rw" } ], "properties": { "name": { "$ref": "#/components/schemas/fileStorageName" }, "target": { "type": "string", "examples": [ "192.168.25.147", "192.168.25.0/24", "*" ], "maxLength": 255, "minLength": 1, "description": "The target of the ACL entry. It can be an IP Address, Network Prefix or a wildcard." }, "permission": { "$ref": "#/components/schemas/fileStoragePermission" } }, "title": "AclModify", "additionalProperties": false, "description": "Schema for modifying an existing ACL." }, "fileStorageLabelModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "key": "environment", "value": "production" } ], "properties": { "key": { "$ref": "#/components/schemas/fileStorageLabelKey" }, "value": { "$ref": "#/components/schemas/fileStorageLabelValue" } }, "title": "LabelModify", "additionalProperties": false, "description": "Schema for modifying an existing label." }, "fileStorageServiceListResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "configured_status": "started", "created_at": "2025-08-01T10:40:04.140473Z", "encrypted": false, "labels": [ { "key": "environment", "value": "production" } ], "name": "test2", "networks": [ { "family": "IPv4", "ip_address": "10.10.10.50", "name": "net", "uuid": "0391f203-6eef-4a69-bfcc-fffffbdfdc32" } ], "operational_state": "running", "shares": [ { "acl": [ { "name": "test-name", "permission": "ro", "target": "*" } ], "name": "read", "path": "/public" }, { "acl": [ { "name": "test-name", "permission": "rw", "target": "10.10.10.0/24" }, { "name": "test-name", "permission": "rw", "target": "local.domain" } ], "name": "write", "path": "/project/data" } ], "size_gib": 250, "state_messages": [], "updated_at": "2025-08-03T19:23:52.350216Z", "uuid": "17871d62-6964-4336-b68d-4a85a8ee10fe", "zone": "fi-dev2" } ] ], "items": { "$ref": "#/components/schemas/fileStorageServiceDetailResponse" }, "title": "ServiceListResponse", "description": "Schema for the response containing a list of services." }, "fileStorageServiceDetailResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "configured_status": "started", "created_at": "2025-08-01T10:40:04.140473Z", "encrypted": false, "labels": [ { "key": "environment", "value": "production" } ], "name": "test2", "networks": [ { "family": "IPv4", "ip_address": "10.10.10.50", "name": "net", "uuid": "0391f203-6eef-4a69-bfcc-fffffbdfdc32" } ], "operational_state": "running", "shares": [ { "acl": [ { "name": "test-name", "permission": "ro", "target": "*" } ], "name": "read", "path": "/public" }, { "acl": [ { "name": "test-name", "permission": "rw", "target": "10.10.10.0/24" }, { "name": "test-name", "permission": "rw", "target": "local.domain" } ], "name": "write", "path": "/project/data" } ], "size_gib": 250, "state_messages": [], "updated_at": "2025-08-03T19:23:52.350216Z", "uuid": "17871d62-6964-4336-b68d-4a85a8ee10fe", "zone": "fi-dev2" } ], "properties": { "uuid": { "type": "string" }, "name": { "type": "string" }, "zone": { "type": "string" }, "configured_status": { "type": "string" }, "operational_state": { "type": "string" }, "size_gib": { "type": "integer", "format": "int32" }, "encrypted": { "type": "boolean" }, "networks": { "type": "array", "items": { "$ref": "#/components/schemas/fileStorageNetworkDetailResponse" } }, "shares": { "type": "array", "items": { "$ref": "#/components/schemas/fileStorageShareDetailResponse" } }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/fileStorageLabelDetails" } }, "state_messages": { "type": "array", "items": { "type": "object", "properties": { "operational_state": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" } } } }, "created_at": { "type": "string", "examples": [ "2025-08-01T10:40:04.140473Z" ], "format": "date-time" }, "updated_at": { "type": "string", "examples": [ "2025-08-01T10:40:04.140473Z" ], "format": "date-time" } }, "title": "ServiceDetailResponse", "description": "Schema for the detailed response of a service." }, "fileStorageNetworkDetailResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "family": "IPv4", "ip_address": "192.168.147.250", "name": "test-name", "uuid": "03720d07-80a9-41ac-90b0-68a932109339" } ], "properties": { "family": { "type": "string" }, "ip_address": { "type": "string" }, "name": { "type": "string" }, "uuid": { "type": "string" } }, "title": "NetworkDetailResponse", "description": "Schema for the detailed response of a network." }, "fileStorageShareDetailResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "acl": [ { "name": "test-name", "permission": "rw", "target": "*" } ], "name": "write", "path": "/project/data" } ], "properties": { "name": { "type": "string" }, "path": { "type": "string" }, "acl": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "target": { "type": "string" }, "permission": { "type": "string" } } } } }, "title": "ShareDetailResponse", "description": "Schema for the detailed response of a share." }, "fileStorageLabelDetails": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "key": "environment", "value": "production" } ], "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "title": "LabelDetails", "description": "Schema for label details including key-value pairs." }, "fileStorageErrorResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "type": "https://developers.upcloud.com/1.3/errors#ERROR_INVALID_REQUEST", "title": "Validation error.", "invalid_params": [ { "name": "configured_status", "reason": "Value must be one of \"started\", \"stopped\"." } ], "correlation_id": "01K1RPB4Z1EXJSBFHTVGJD00CV", "status": 400 }, { "type": "https://developers.upcloud.com/1.3/errors#ERROR_RESOURCE_NOT_FOUND", "title": "The resource you requested does not exist.", "correlation_id": "01K1ZJC6MSN91RQS3JMEESGG92", "status": 404 }, { "type": "https://developers.upcloud.com/1.3/errors#ERROR_GENERAL_FAILURE", "title": "Your request could not be fulfilled due to a technical issue.", "correlation_id": "01HEPYJ027RF0H29CKHWHCH7RE", "status": 500 } ], "properties": { "type": { "type": "string", "enum": [ "https://developers.upcloud.com/1.3/errors#ERROR_INVALID_REQUEST", "https://developers.upcloud.com/1.3/errors#ERROR_RESOURCE_NOT_FOUND", "https://developers.upcloud.com/1.3/errors#ERROR_INSUFFICIENT_CREDITS", "https://developers.upcloud.com/1.3/errors#ERROR_GENERAL_FAILURE" ], "description": "Error code string." }, "title": { "type": "string", "examples": [ "Validation error.", "The resource you requested does not exist.", "Your request could not be fulfilled due to a technical issue." ], "description": "Short description of the error." }, "correlation_id": { "type": "string", "examples": [ "01K1K2TKEASWRJ6VFP9ZV5P2H4" ], "description": "Unique identifier for the request, useful for debugging." }, "status": { "type": "integer", "examples": [ 400, 404, 402, 500 ], "format": "int32", "description": "HTTP status code associated with the error." }, "invalid_params": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "zone", "networks.0.ip_address" ], "description": "Path to the field with invalid parameter." }, "reason": { "type": "string", "examples": [ "Zone is not valid." ], "description": "Human-readable error message." } }, "required": [ "name", "reason" ] }, "title": "InvalidParameters", "description": "List of invalid parameters in the request." } }, "title": "ErrorResponse", "required": [ "type", "title", "correlation_id", "status" ], "additionalProperties": false, "description": "Schema for error responses from the API." }, "fileStorageNetworkListResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "family": "IPv4", "ip_address": "192.168.147.250", "name": "test-name", "uuid": "03720d07-80a9-41ac-90b0-68a932109339" } ] ], "items": { "$ref": "#/components/schemas/fileStorageNetworkDetailResponse" }, "title": "NetworkListResponse", "description": "Schema for the response containing a list of networks." }, "fileStorageShareListResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "name": "write", "path": "/project/data", "acl": [ { "name": "test-name", "target": "*", "permission": "rw" } ] }, { "name": "read", "path": "/project/logs", "acl": [ { "name": "test-name", "target": "192.168.147.0/24", "permission": "ro" } ] } ] ], "items": { "$ref": "#/components/schemas/fileStorageShareDetailResponse" }, "title": "ShareListResponse", "description": "Schema for the response containing a list of shares." }, "fileStorageAclListResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "name": "test-name-1", "target": "*", "permission": "rw" }, { "name": "test-name-2", "target": "192.168.147.0/24", "permission": "ro" } ] ], "items": { "$ref": "#/components/schemas/fileStorageAclDetailResponse" }, "title": "AclListResponse", "description": "Schema for the response containing a list of ACLs." }, "fileStorageAclDetailResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "test-name", "permission": "rw", "target": "*" } ], "properties": { "name": { "type": "string" }, "target": { "type": "string" }, "permission": { "type": "string" } }, "title": "AclDetailResponse", "description": "Schema for the detailed response of an ACL." }, "fileStorageLabelsListResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "key": "environment", "value": "production" } ] ], "items": { "$ref": "#/components/schemas/fileStorageLabelDetails" }, "title": "LabelsListResponse", "description": "Response schema for listing labels." }, "LogicalDatabaseCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "my_database", "lc_collate": "en_US.UTF-8", "lc_ctype": "en_US.UTF-8" } ], "properties": { "name": { "type": "string", "examples": [ "my_database" ], "description": "logical database name" }, "lc_collate": { "type": "string", "examples": [ "en_US.UTF-8" ], "description": "Collation order" }, "lc_ctype": { "type": "string", "examples": [ "en_US.UTF-8" ], "description": "Category of a locale definition source file" } }, "title": "LogicalDatabaseCreate", "required": [ "name" ], "additionalProperties": false, "description": "Schema for creating a logical database." }, "LogicalDatabasesResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "name": "postgres", "lc_collate": "en_US.UTF-8", "lc_ctype": "en_US.UTF-8" } ], [ { "name": "mydb", "lc_collate": "en_US.UTF-8", "lc_ctype": "en_US.UTF-8" }, { "name": "testdb", "lc_collate": "en_US.UTF-8", "lc_ctype": "en_US.UTF-8" } ] ], "items": { "$ref": "#/components/schemas/LogicalDatabaseResponse" }, "title": "LogicalDatabasesResponse", "description": "A list of logical databases." }, "LogicalDatabaseResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "postgres", "lc_collate": "en_US.UTF-8", "lc_ctype": "en_US.UTF-8" } ], "properties": { "name": { "type": "string", "description": "The name of the logical database.", "example": "postgres" }, "lc_collate": { "type": "string", "description": "The LC_COLLATE setting of the logical database.", "example": "en_US.UTF-8" }, "lc_ctype": { "type": "string", "description": "The LC_CTYPE setting of the logical database.", "example": "en_US.UTF-8" } }, "title": "LogicalDatabaseResponse", "description": "Schema for a logical database response." }, "databaseServiceType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "mysql", "pg", "opensearch", "valkey" ], "title": "ServiceType", "enum": [ "mysql", "pg", "opensearch", "valkey" ], "description": "The type of service." }, "databaseQueryParamLimit": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "examples": [ 10, 25, 50, 100 ], "title": "QueryParamLimit", "maximum": 100, "minimum": 0, "description": "Schema for a query parameter specifying the maximum number of entries to return (limit).", "default": 10 }, "databaseQueryParamOffset": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "examples": [ 0, 10, 20, 50 ], "title": "QueryParamOffset", "minimum": 0, "description": "Schema for a query parameter specifying the offset for pagination.", "default": 0 }, "databaseQueryParamSort": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "-created_at", "name", "-zone" ], "title": "QueryParamSort", "enum": [ "created_at", "-created_at", "name", "-name", "operational_state", "-operational_state", "zone", "-zone" ], "description": "Schema for a query parameter specifying the sort field and direction. Prefix with '-' for descending order." }, "databaseUuid": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "01234567-89ab-cdef-0123-456789abcdef", "fedcba98-7654-3210-fedc-ba9876543210" ], "title": "UUID", "format": "uuid", "description": "The unique identifier for the integration." }, "databaseLabelKey": { "type": "string", "examples": [ "foo" ], "title": "LabelKey", "maxLength": 32, "minLength": 2, "pattern": "^[\\x20-\\x5E\\x60-\\x7E][\\x20-\\x7E]+$", "description": "The key of a label." }, "databaseIntegrationUUID": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "01234567-89ab-cdef-0123-456789abcdef", "fedcba98-7654-3210-fedc-ba9876543210" ], "title": "IntegrationUUID", "format": "uuid", "description": "The unique identifier for the service." }, "databaseQueryParamOrder": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "asc", "desc" ], "title": "QueryParamOrder", "description": "Schema for a query parameter specifying the order." }, "databaseTitle": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "my-service" ], "title": "Title", "maxLength": 64, "minLength": 1, "description": "The title of an entity." }, "databaseId": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "examples": [ 1001, 1002 ], "title": "ID", "format": "int32", "description": "The unique identifier for the integration." }, "databaseServiceCreateOpenAPI": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "hostname_prefix": "doc-api-unique-prefix", "plan": "1x1xCPU-2GB-25GB", "additional_disk_space_gib": 10, "title": "my-managed-database", "type": "mysql", "zone": "de-fra1", "maintenance": { "dow": "sunday", "time": "05:00:00" }, "termination_protection": false, "properties": { "automatic_utility_network_ip_filter": true, "version": "8", "ip_filter": [] }, "networks": [ { "name": "example-network-1", "type": "private", "family": "IPv4", "uuid": "03631160-d57a-4926-ad48-a2f828229dcb" }, { "name": "example-network-2", "type": "private", "family": "IPv4", "uuid": "03631160-d57a-4926-ad48-a2f828229dcb" } ], "labels": [ { "key": "env", "value": "staging" }, { "key": "foo", "value": "bar" } ] } ], "properties": { "hostname_prefix": { "type": "string", "examples": [ "doc-api-unique-prefix" ], "maxLength": 30, "minLength": 3, "description": "Hostname prefix for the service nodes." }, "title": { "type": "string", "examples": [ "my-managed-database" ], "description": "Human-readable title for the service." }, "type": { "$ref": "#/components/schemas/databaseServiceType" }, "zone": { "type": "string", "examples": [ "de-fra1" ], "pattern": "^[a-z]{2}-[a-z]{3}\\d$", "description": "Zone where the service is created." }, "set_service_uuid": { "type": "string", "examples": [ "550e8400-e29b-41d4-a716-446655440000" ], "format": "uuid", "description": "Optional UUID to assign to the created service." }, "plan": { "type": "string", "examples": [ "1x1xCPU-2GB-25GB", "rdb.standard.2x-2CPU-8GB-120GB-regular" ], "description": "Deprecated: prefer the plan_* selection fields (plan_compute, plan_node_count, plan_storage_gib, plan_backups) for PostgreSQL and MySQL. The plan name remains supported, and required for engines without componentised plans. For componentised (rdb.*) plans the storage segment is the desired TOTAL storage per node: any total reachable from a catalog plan's included storage in the plan's storage steps (within its cap) is a valid plan name, e.g. rdb.standard.2x-2CPU-8GB-120GB-regular selects the 80GB catalog plan with a 40GB dynamic top-up.", "deprecated": true }, "plan_compute": { "type": "string", "examples": [ "rdb.standard.2CPU-8GB" ], "description": "Plan selection: compute shape combining family, CPU and memory as one token, as listed in the plan catalog components. PostgreSQL and MySQL only." }, "plan_node_count": { "type": "integer", "examples": [ 1 ], "description": "Plan selection: number of nodes." }, "plan_storage_gib": { "type": "integer", "examples": [ 120 ], "description": "Plan selection: desired TOTAL storage per node in GiB. Resolution picks the plan whose included storage matches, or tops the closest plan up with dynamic additional storage within the allowed limits. Mutually exclusive with additional_disk_space_gib." }, "plan_backups": { "type": "string", "examples": [ "regular" ], "enum": [ "mini", "regular", "extended" ], "description": "Plan selection: backup tier. PostgreSQL and MySQL tiered plans only." }, "additional_disk_space_gib": { "type": "integer", "examples": [ 10 ], "description": "Additional disk space in GiB. Legacy plans only: componentised (rdb.*) plans set storage as a total via plan_storage_gib or the plan name.", "deprecated": true }, "termination_protection": { "type": "boolean", "examples": [ false ], "description": "When enabled, the service cannot be deleted until termination protection is disabled." }, "maintenance": { "type": "object", "examples": [ { "dow": "sunday", "time": "05:00:00" } ], "properties": { "dow": { "$ref": "#/components/schemas/databaseMaintenanceDow" }, "time": { "$ref": "#/components/schemas/databaseMaintenanceTime" } }, "required": [ "dow", "time" ], "description": "Weekly maintenance window." }, "networks": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/databaseNetworkCreate" }, "maxItems": 8, "description": "SDN networks to attach to the service." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/databaseLabelCreate" }, "maxItems": 255, "description": "Labels used for service filtering." }, "service_integrations": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/databaseServiceIntegrationCreate" }, "description": "Service integrations to configure on creation." }, "properties": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/databaseServicePropertiesMysql" }, { "$ref": "#/components/schemas/databaseServicePropertiesPg" }, { "$ref": "#/components/schemas/databaseServicePropertiesRedis" }, { "$ref": "#/components/schemas/databaseServicePropertiesOpensearch" }, { "$ref": "#/components/schemas/databaseServicePropertiesValkey" } ], "description": "Engine-specific configuration properties. The allowed keys depend on the selected service type; provide the property set matching the chosen type." } }, "title": "ServiceCreateOpenAPI", "required": [ "hostname_prefix", "title", "type", "zone" ], "additionalProperties": false, "description": "Schema for creating a service — OpenAPI version." }, "databaseMaintenanceDow": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday" ], "title": "MaintenanceDow", "enum": [ "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday" ], "description": "Day of the week for maintenance window" }, "databaseMaintenanceTime": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "02:00:00", "14:30:00", "23:45:00" ], "title": "MaintenanceTime", "description": "Time of day for maintenance window in HH:MM:SS format" }, "databaseNetworkCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "my-network", "type": "public", "family": "IPv4" }, { "uuid": "123e4567-e89b-12d3-a456-426614174000", "name": "my-network", "type": "public", "family": "IPv4" } ], "properties": { "uuid": { "type": "string", "examples": [ "123e4567-e89b-12d3-a456-426614174000" ], "format": "uuid", "description": "Optional UUID for the network. If not provided, a new UUID will be generated." }, "name": { "$ref": "#/components/schemas/databaseNetworkName" }, "type": { "$ref": "#/components/schemas/databaseNetworkType" }, "family": { "$ref": "#/components/schemas/databaseNetworkFamily" } }, "title": "NetworkCreate", "required": [ "name", "type", "family" ], "additionalProperties": false, "description": "Schema for creating a network." }, "databaseNetworkName": { "type": "string", "examples": [ "private-network", "public-network" ], "title": "NetworkName", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "The name of the network." }, "databaseNetworkType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "private" ], "title": "NetworkType", "enum": [ "private" ], "description": "The type of network." }, "databaseNetworkFamily": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "IPv4", "IPv6" ], "title": "NetworkFamily", "enum": [ "IPv4", "IPv6" ], "description": "The network protocol family." }, "databaseLabelCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "key": "environment", "value": "production" } ], "properties": { "key": { "$ref": "#/components/schemas/databaseLabelKey" }, "value": { "$ref": "#/components/schemas/databaseLabelValue" } }, "title": "LabelCreate", "required": [ "key", "value" ], "additionalProperties": false, "description": "Schema for creating a label with a key and value." }, "databaseLabelValue": { "type": "string", "examples": [ "bar" ], "title": "LabelValue", "maxLength": 255, "pattern": "\\A[\\p{L}\\p{N}\\p{P}\\p{S}\\p{M}\\p{Z}]*\\z", "description": "The value of a label." }, "databaseServiceIntegrationCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "type": "logs", "destination_uuid": "09e86f48-2dcd-4a43-843d-3532ab112c1d", "properties": { "opensearch_index_days_max": 30, "opensearch_index_prefix": "mysql_logs" } } ], "properties": { "type": { "$ref": "#/components/schemas/databaseServiceIntegration" }, "destination_uuid": { "type": "string", "examples": [ "123e4567-e89b-12d3-a456-426614174000" ], "format": "uuid", "description": "The UUID of the destination where the service integration will send data." }, "properties": { "type": "object" } }, "title": "ServiceIntegrationCreate", "required": [ "type" ], "additionalProperties": false, "description": "Schema for creating a service integration." }, "databaseServiceIntegration": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "logs", "rsyslog", "prometheus" ], "title": "ServiceIntegration", "enum": [ "logs", "prometheus", "rsyslog" ], "description": "The type of service integration." }, "databaseServicePropertiesMysql": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "admin_password": { "type": [ "string", "null" ], "maxLength": 256, "minLength": 8, "pattern": "^[a-zA-Z0-9-_]+$" }, "admin_username": { "type": [ "string", "null" ], "maxLength": 64, "pattern": "^[_A-Za-z0-9][-._A-Za-z0-9]{0,63}$" }, "automatic_sp_privileges": { "type": "boolean", "description": "When enabled, the server automatically grants the EXECUTE and ALTER ROUTINE privileges to the creator of a stored routine and drops them when the routine is dropped." }, "automatic_utility_network_ip_filter": { "type": "boolean", "description": "Automatically allow connections from servers in the utility network within the same zone" }, "backup_hour": { "type": "integer", "maximum": 23, "minimum": 0 }, "backup_minute": { "type": "integer", "maximum": 59, "minimum": 0 }, "binlog_retention_period": { "type": "integer", "maximum": 9007199254740991, "minimum": 600, "description": "Warning: reducing this value can make a large batch of binary logs eligible for purge at once. Depending on the volume, this can sometimes stall the MySQL commit path and block writes until the purge completes. To stay on the safe side, prefer lowering the value gradually in small decrements during a low-traffic window rather than dropping it drastically in one step." }, "connect_timeout": { "type": "integer", "maximum": 3600, "minimum": 2, "description": "The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake" }, "default_time_zone": { "type": "string", "maxLength": 100, "minLength": 2, "pattern": "^([-+][\\d:]*|[\\w/]*)$", "description": "Default server time zone as an offset from UTC (from -12:00 to +12:00), a time zone name, or 'SYSTEM' to use the MySQL server default." }, "div_precision_increment": { "type": "integer", "maximum": 30, "minimum": 0, "description": "Number of digits by which to increase the scale of the result of division operations performed with the / operator. Default is 4." }, "end_markers_in_json": { "type": "boolean", "description": "Whether optimizer JSON output such as EXPLAIN FORMAT=JSON adds end markers that repeat a structure's key near its closing bracket, making large JSON structures easier to read." }, "eq_range_index_dive_limit": { "type": "integer", "maximum": 4294967295, "minimum": 0, "description": "The number of equality ranges in a query at or above which the optimizer switches from index dives to index statistics when estimating the number of qualifying rows. 0 means always use index dives. Default is 200." }, "group_concat_max_len": { "type": "integer", "maximum": 18446744073709552000, "minimum": 4, "description": "The maximum permitted result length in bytes for the GROUP_CONCAT() function." }, "information_schema_stats_expiry": { "type": "integer", "maximum": 31536000, "minimum": 900, "description": "The time, in seconds, before cached statistics expire" }, "innodb_adaptive_hash_index": { "type": "boolean", "description": "Whether InnoDB adaptive hash indexing is enabled. The optimal setting is workload-dependent: it speeds up lookups for some workloads but its internal latch can become a contention point under high concurrency, in which case disabling it can improve throughput." }, "innodb_change_buffer_max_size": { "type": "integer", "maximum": 50, "minimum": 0, "description": "Maximum size for the InnoDB change buffer, as a percentage of the total size of the buffer pool. Default is 25" }, "innodb_flush_neighbors": { "type": "integer", "maximum": 2, "minimum": 0, "description": "Specifies whether flushing a page from the InnoDB buffer pool also flushes other dirty pages in the same extent (default is 1): 0 - dirty pages in the same extent are not flushed, 1 - flush contiguous dirty pages in the same extent, 2 - flush dirty pages in the same extent" }, "innodb_ft_enable_stopword": { "type": "boolean", "description": "Whether stopword processing is applied when creating or rebuilding an InnoDB FULLTEXT index. Enabled by default." }, "innodb_ft_max_token_size": { "type": "integer", "maximum": 84, "minimum": 10, "description": "Maximum length of words that are stored in an InnoDB FULLTEXT index. Changing this parameter will lead to a restart of the MySQL service." }, "innodb_ft_min_token_size": { "type": "integer", "maximum": 16, "minimum": 0, "description": "Minimum length of words that are stored in an InnoDB FULLTEXT index. Changing this parameter will lead to a restart of the MySQL service." }, "innodb_ft_num_word_optimize": { "type": "integer", "maximum": 10000, "minimum": 1000, "description": "Number of words processed during each OPTIMIZE TABLE operation on an InnoDB FULLTEXT index. Default is 2000." }, "innodb_ft_result_cache_limit": { "type": "integer", "maximum": 4294967295, "minimum": 1000000, "description": "Maximum memory in bytes used per query for the InnoDB FULLTEXT search query result cache. UpCloud sizes this automatically based on the service plan's memory; setting a value overrides the calculated default." }, "innodb_ft_server_stopword_table": { "type": [ "null", "string" ], "maxLength": 1024, "pattern": "^.+/.+$", "description": "This option is used to specify your own InnoDB FULLTEXT index stopword list for all InnoDB tables." }, "innodb_ft_user_stopword_table": { "type": [ "null", "string" ], "maxLength": 1024, "pattern": "^.+/.+$", "description": "This option is used to specify your own InnoDB FULLTEXT index stopword list for specific InnoDB tables." }, "innodb_io_capacity": { "type": "integer", "maximum": 4294967295, "minimum": 100, "description": "The number of I/O operations per second (IOPS) available to InnoDB background tasks, such as flushing pages from the buffer pool and merging data from the change buffer. Set this to a value appropriate for the underlying storage; it must not exceed innodb_io_capacity_max." }, "innodb_io_capacity_max": { "type": "integer", "maximum": 4294967295, "minimum": 100, "description": "The maximum number of I/O operations per second (IOPS) that InnoDB background tasks may perform when flushing falls behind. Defaults to twice innodb_io_capacity (minimum 2000). This must be greater than or equal to innodb_io_capacity." }, "innodb_lock_wait_timeout": { "type": "integer", "maximum": 3600, "minimum": 1, "description": "The length of time in seconds an InnoDB transaction waits for a row lock before giving up. Default is 120." }, "innodb_log_buffer_size": { "type": "integer", "maximum": 4294967296, "minimum": 1048576, "description": "The size in bytes of the buffer that InnoDB uses to write to the log files on disk." }, "innodb_online_alter_log_max_size": { "type": "integer", "maximum": 1099511627776, "minimum": 65536, "description": "The upper limit in bytes on the size of the temporary log files used during online DDL operations for InnoDB tables." }, "innodb_optimize_fulltext_only": { "type": "boolean", "description": "When enabled, OPTIMIZE TABLE on InnoDB tables only updates the FULLTEXT index instead of rebuilding the table. Intended to be enabled temporarily during FULLTEXT index maintenance and disabled afterwards; while enabled, OPTIMIZE TABLE does not reclaim table space." }, "innodb_print_all_deadlocks": { "type": "boolean", "description": "When enabled, information about all deadlocks in InnoDB user transactions is recorded in the error log. Disabled by default." }, "innodb_read_io_threads": { "type": "integer", "maximum": 64, "minimum": 1, "description": "The number of I/O threads for read operations in InnoDB. Default is 4. Changing this parameter will lead to a restart of the MySQL service." }, "innodb_rollback_on_timeout": { "type": "boolean", "description": "When enabled a transaction timeout causes InnoDB to abort and roll back the entire transaction. Changing this parameter will lead to a restart of the MySQL service." }, "innodb_thread_concurrency": { "type": "integer", "maximum": 1000, "minimum": 0, "description": "Defines the maximum number of threads permitted inside of InnoDB. Default is 0 (infinite concurrency - no limit)" }, "innodb_write_io_threads": { "type": "integer", "maximum": 64, "minimum": 1, "description": "The number of I/O threads for write operations in InnoDB. Default is 4. Changing this parameter will lead to a restart of the MySQL service." }, "interactive_timeout": { "type": "integer", "maximum": 604800, "minimum": 30, "description": "The number of seconds the server waits for activity on an interactive connection before closing it." }, "internal_tmp_mem_storage_engine": { "type": "string", "enum": [ "TempTable", "MEMORY" ], "description": "The storage engine for in-memory internal temporary tables." }, "ip_filter": { "type": "array", "items": { "type": "string", "title": "CIDR address block", "maxLength": 18, "example": [ "10.0.0.0/24" ] }, "description": "Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'" }, "log_output": { "type": "string", "enum": [ "INSIGHTS", "TABLE", "INSIGHTS,TABLE", "NONE" ], "description": "The slow log output destination when slow_query_log is ON. To enable MySQL AI Insights, choose INSIGHTS. To use MySQL AI Insights and the mysql.slow_log table at the same time, choose INSIGHTS,TABLE. To only use the mysql.slow_log table, choose TABLE. To silence slow logs, choose NONE." }, "long_query_time": { "type": "number", "maximum": 3600, "minimum": 0, "description": "The slow_query_logs work as SQL statements that take more than long_query_time seconds to execute." }, "lower_case_table_names": { "type": "integer", "enum": [ 0, 1 ], "description": "Sets how table and database names are stored and compared. 0 = case-sensitive (default), 1 = names stored lowercase, comparisons are case-insensitive. This option can only be set when creating the service and cannot be changed later. See https://dev.mysql.com/doc/refman/8.0/en/identifier-case-sensitivity.html for details." }, "max_allowed_packet": { "type": "integer", "maximum": 1073741824, "minimum": 102400, "description": "Size of the largest message in bytes that can be received by the server. Default is 67108864 (64M)" }, "max_execution_time": { "type": "integer", "maximum": 4294967295, "minimum": 0, "description": "Execution timeout in milliseconds for read-only top-level SELECT statements. 0 (the default) means no timeout." }, "max_heap_table_size": { "type": "integer", "maximum": 1073741824, "minimum": 1048576, "description": "Limits the size of internal in-memory tables. Also set tmp_table_size. Default is 16777216 (16M)" }, "max_seeks_for_key": { "type": "integer", "maximum": 18446744073709552000, "minimum": 1, "description": "Limit on the assumed maximum number of index seeks when looking up rows based on a key. Lowering this value causes the optimizer to prefer index lookups over table scans." }, "migration": { "type": [ "object", "null" ], "properties": { "dbname": { "type": "string", "title": "Database name for bootstrapping the initial connection", "maxLength": 63 }, "dump_tool": { "type": [ "string", "null" ], "title": "MySQL migration dump tool", "enum": [ "mysqldump", "mydumper", null ], "description": "Experimental! Tool to use for database dump and restore during migration. Default: mysqldump" }, "host": { "type": "string", "title": "Hostname or IP address of the server where to migrate data from", "maxLength": 255 }, "ignore_dbs": { "type": "string", "title": "Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment)", "maxLength": 2048 }, "ignore_roles": { "type": "string", "title": "Comma-separated list of database roles, which should be ignored during migration (supported by PostgreSQL only at the moment)", "maxLength": 2048 }, "method": { "type": "string", "title": "The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types)", "enum": [ "dump", "replication" ] }, "password": { "type": "string", "title": "Password for authentication with the server where to migrate data from", "maxLength": 256 }, "port": { "type": "integer", "title": "Port number of the server where to migrate data from", "maximum": 65535, "minimum": 1 }, "reestablish_replication": { "type": "boolean", "title": "Skip dump-restore part and start replication" }, "ssl": { "type": "boolean", "title": "The server where to migrate data from is secured with SSL" }, "username": { "type": "string", "title": "User name for authentication with the server where to migrate data from", "maxLength": 256 } }, "required": [ "host", "port" ], "additionalProperties": false }, "mysql_incremental_backup": { "type": "object", "properties": { "enabled": { "type": "boolean", "title": "Enable incremental backups", "description": "Enable periodic incremental backups. When enabled, full_backup_week_schedule must be set. Incremental backups only store changes since the last backup, making them faster and more storage-efficient than full backups. This is particularly useful for large databases where daily full backups would be too time-consuming or expensive." }, "full_backup_week_schedule": { "type": [ "string", "null" ], "title": "Full backup week schedule", "pattern": "^[a-z]+(,[a-z]+)*$", "description": "Comma-separated list of days of the week when full backups should be created. Valid values: mon, tue, wed, thu, fri, sat, sun" } }, "required": [ "enabled" ], "additionalProperties": false }, "net_buffer_length": { "type": "integer", "maximum": 1048576, "minimum": 1024, "description": "Start sizes of connection buffer and result buffer. Default is 16384 (16K). Changing this parameter will lead to a restart of the MySQL service." }, "net_read_timeout": { "type": "integer", "maximum": 3600, "minimum": 1, "description": "The number of seconds to wait for more data from a connection before aborting the read." }, "net_write_timeout": { "type": "integer", "maximum": 3600, "minimum": 1, "description": "The number of seconds to wait for a block to be written to a connection before aborting the write." }, "optimizer_prune_level": { "type": "integer", "maximum": 1, "minimum": 0, "description": "Controls the heuristics applied during query optimization to prune less-promising partial plans from the optimizer search space. 0 disables heuristics (exhaustive search); 1 prunes plans based on the number of rows retrieved." }, "optimizer_search_depth": { "type": "integer", "maximum": 62, "minimum": 0, "description": "Maximum depth of search performed by the query optimizer when choosing a join order. Larger values produce better plans for joins over many tables but take longer to compile; 0 lets the optimizer choose the depth automatically." }, "optimizer_switch": { "type": "string", "pattern": "^(default|[a-z_]+=(on|off|default)(,[a-z_]+=(on|off|default))*)$", "description": "Comma-separated list of optimizer flag assignments in the form flag=on|off|default, or the single value 'default' to reset all flags. Flags not listed keep their current values. Controls query optimizer behaviors such as index merge, hash join and semijoin strategies." }, "performance_schema_events_statements_history_size": { "type": [ "integer", "null" ], "maximum": 1024, "minimum": 0, "description": "The number of rows per thread in the events_statements_history table. Changing this parameter will lead to a restart of the MySQL service." }, "public_access": { "type": "boolean", "description": "Allow access to the service from the public Internet" }, "public_access_prometheus": { "type": "boolean", "description": "Allow access to Prometheus metrics from the public Internet" }, "relay_log_space_limit": { "type": "integer", "maximum": 18446744073709552000, "minimum": 134217728, "description": "The maximum amount of space in bytes to use for all relay logs while replicating from an external migration source. When the limit is reached, the replication I/O thread stops fetching relay log events until the SQL thread has caught up. Raise this to give a large migration a bigger relay-log budget; ensure the service disk is sized accordingly. The setting applies only on the node replicating from the external source; standby nodes always use the UpCloud-managed default (the smaller of 5 GiB and 30% of the service disk), which is also used when this option is left unset. Changing this parameter will lead to a restart of the MySQL service." }, "service_log": { "type": [ "boolean", "null" ], "description": "Store logs for the service so that they are available in the HTTP API and console." }, "slow_query_log": { "type": "boolean", "description": "Slow query log enables capturing of slow queries. Setting slow_query_log to false also truncates the mysql.slow_log table." }, "sort_buffer_size": { "type": "integer", "maximum": 1073741824, "minimum": 32768, "description": "Sort buffer size in bytes for ORDER BY optimization. Default is 262144 (256K)" }, "sql_mode": { "type": "string", "maxLength": 1024, "pattern": "^[A-Z_]*(,[A-Z_]+)*$", "description": "Global SQL mode. Set to empty to use MySQL server defaults. When creating a new service and not setting this field UpCloud default SQL mode (strict, SQL standard compliant) will be assigned." }, "sql_require_primary_key": { "type": "boolean", "description": "Require primary key to be defined for new tables or old tables modified with ALTER TABLE and fail if missing. It is recommended to always have primary keys because various functionality may break if any large table is missing them." }, "tmp_table_size": { "type": "integer", "maximum": 1073741824, "minimum": 1048576, "description": "Limits the size of internal in-memory tables. Also set max_heap_table_size. Default is 16777216 (16M)" }, "version": { "type": [ "string", "null" ], "enum": [ "8", "8.4" ] }, "wait_timeout": { "type": "integer", "maximum": 2147483, "minimum": 1, "description": "The number of seconds the server waits for activity on a noninteractive connection before closing it." }, "windowing_use_high_precision": { "type": "boolean", "description": "Whether window functions are computed to high precision. Disabling this trades exactness for speed in window function evaluation." } }, "additionalProperties": false, "description": "mysql properties" }, "databaseServicePropertiesPg": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "admin_password": { "type": [ "string", "null" ], "maxLength": 256, "minLength": 8, "pattern": "^[a-zA-Z0-9-_]+$" }, "admin_username": { "type": [ "string", "null" ], "maxLength": 64, "pattern": "^[_A-Za-z0-9][-._A-Za-z0-9]{0,63}$" }, "automatic_utility_network_ip_filter": { "type": "boolean", "description": "Automatically allow connections from servers in the utility network within the same zone" }, "autovacuum_analyze_scale_factor": { "type": "number", "maximum": 1, "minimum": 0, "description": "Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE (e.g. `0.2` for 20% of the table size). The default is `0.2`." }, "autovacuum_analyze_threshold": { "type": "integer", "maximum": 2147483647, "minimum": 0, "description": "Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is `50`." }, "autovacuum_freeze_max_age": { "type": "integer", "maximum": 1500000000, "minimum": 200000000, "description": "Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. The system launches autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. Changing this parameter causes a service restart." }, "autovacuum_max_workers": { "type": "integer", "maximum": 20, "minimum": 1, "description": "Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is `3`. Changing this parameter causes a service restart." }, "autovacuum_naptime": { "type": "integer", "maximum": 86400, "minimum": 1, "description": "Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds. The default is `60`." }, "autovacuum_vacuum_cost_delay": { "type": "integer", "maximum": 100, "minimum": -1, "description": "Specifies the cost delay value that will be used in automatic VACUUM operations. If `-1` is specified, the regular vacuum_cost_delay value will be used. The default is `2` (upstream default)." }, "autovacuum_vacuum_cost_limit": { "type": "integer", "maximum": 10000, "minimum": -1, "description": "Specifies the cost limit value that will be used in automatic VACUUM operations. If `-1` is specified, the regular vacuum_cost_limit value will be used. The default is `-1` (upstream default)." }, "autovacuum_vacuum_scale_factor": { "type": "number", "maximum": 1, "minimum": 0, "description": "Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM (e.g. `0.2` for 20% of the table size). The default is `0.2`." }, "autovacuum_vacuum_threshold": { "type": "integer", "maximum": 2147483647, "minimum": 0, "description": "Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is `50`." }, "backup_hour": { "type": [ "integer", "null" ], "maximum": 23, "minimum": 0 }, "backup_interval_hours": { "type": [ "integer", "null" ], "maximum": 24, "minimum": 3, "enum": [ 3, 4, 6, 8, 12, 24, null ], "description": "Interval in hours between automatic backups. Minimum value is 3 hours. Must be a divisor of 24 (3, 4, 6, 8, 12, 24). (Applicable to ACU plans only)" }, "backup_minute": { "type": [ "integer", "null" ], "maximum": 59, "minimum": 0 }, "backup_retention_days": { "type": [ "integer", "null" ], "maximum": 30, "minimum": 1, "description": "Number of days to retain automatic backups. Backups older than this value will be automatically deleted. (Applicable to ACU plans only)" }, "bgwriter_delay": { "type": "integer", "maximum": 10000, "minimum": 10, "description": "Specifies the delay between activity rounds for the background writer in milliseconds. The default is `200`." }, "bgwriter_flush_after": { "type": "integer", "maximum": 2048, "minimum": 0, "description": "Whenever more than bgwriter_flush_after bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes. Setting of 0 disables forced writeback. The default is `512`." }, "bgwriter_lru_maxpages": { "type": "integer", "maximum": 1073741823, "minimum": 0, "description": "In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. The default is `100`." }, "bgwriter_lru_multiplier": { "type": "number", "maximum": 10, "minimum": 0, "description": "The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is `2.0`." }, "deadlock_timeout": { "type": "integer", "maximum": 1800000, "minimum": 500, "description": "This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. The default is `1000` (upstream default)." }, "default_toast_compression": { "type": "string", "enum": [ "lz4", "pglz" ], "description": "Specifies the default TOAST compression method for values of compressible columns. The default is `lz4`. Only available for PostgreSQL 14+." }, "enable_ha_replica_dns": { "type": "boolean", "description": "Creates a dedicated read-only DNS that automatically falls back to the primary if standby nodes are unavailable. It switches back when a standby recovers." }, "idle_in_transaction_session_timeout": { "type": "integer", "maximum": 604800000, "minimum": 0, "description": "Time out sessions with open transactions after this number of milliseconds" }, "io_combine_limit": { "type": "integer", "maximum": 32, "minimum": 1, "description": "EXPERIMENTAL: Controls the largest I/O size in operations that combine I/O in 8kB units. Version 17 and up only." }, "io_max_combine_limit": { "type": "integer", "maximum": 128, "minimum": 1, "description": "EXPERIMENTAL: Controls the largest I/O size in operations that combine I/O in 8kB units, and silently limits the user-settable parameter io_combine_limit. Version 18 and up only. Changing this parameter causes a service restart." }, "io_max_concurrency": { "type": "integer", "maximum": 1024, "minimum": -1, "description": "EXPERIMENTAL: Controls the maximum number of I/O operations that one process can execute simultaneously. Version 18 and up only. Changing this parameter causes a service restart." }, "io_method": { "type": "string", "enum": [ "worker", "sync", "io_uring" ], "description": "EXPERIMENTAL: Controls the maximum number of I/O operations that one process can execute simultaneously. Version 18 and up only. Changing this parameter causes a service restart." }, "io_workers": { "type": "integer", "maximum": 32, "minimum": 1, "description": "EXPERIMENTAL: Number of IO worker processes, for io_method=worker. Version 18 and up only." }, "ip_filter": { "type": "array", "items": { "type": "string", "title": "CIDR address block", "maxLength": 18, "example": [ "10.0.0.0/24" ] }, "description": "Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'" }, "jit": { "type": "boolean", "description": "Controls system-wide use of Just-in-Time Compilation (JIT)." }, "log_autovacuum_min_duration": { "type": "integer", "maximum": 2147483647, "minimum": -1, "description": "Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one disables logging autovacuum actions. The default is `1000`." }, "log_error_verbosity": { "type": "string", "enum": [ "TERSE", "DEFAULT", "VERBOSE" ], "description": "Controls the amount of detail written in the server log for each message that is logged." }, "log_line_prefix": { "type": "string", "enum": [ "'pid=%p,user=%u,db=%d,app=%a,client=%h '", "'pid=%p,user=%u,db=%d,app=%a,client=%h,txid=%x,qid=%Q '", "'%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h '", "'%m [%p] %q[user=%u,db=%d,app=%a] '" ], "description": "Choose from one of the available log formats." }, "log_min_duration_statement": { "type": "integer", "maximum": 86400000, "minimum": -1, "description": "Log statements that take more than this number of milliseconds to run, -1 disables" }, "log_temp_files": { "type": "integer", "maximum": 2147483647, "minimum": -1, "description": "Log statements for each temporary file created larger than this number of kilobytes, -1 disables" }, "max_connections": { "type": "integer", "maximum": 60000, "minimum": 25, "description": "Sets the PostgreSQL maximum number of concurrent connections to the database server. For services with a read replica, first increase the read replica's value. After the change is applied to the replica, you can increase the primary service's value. Changing this parameter causes a service restart." }, "max_files_per_process": { "type": "integer", "maximum": 4096, "minimum": 1000, "description": "PostgreSQL maximum number of files that can be open per process. The default is `1000` (upstream default). Changing this parameter causes a service restart." }, "max_locks_per_transaction": { "type": "integer", "maximum": 6400, "minimum": 64, "description": "PostgreSQL maximum locks per transaction. Changing this parameter causes a service restart." }, "max_logical_replication_workers": { "type": "integer", "maximum": 256, "minimum": 4, "description": "PostgreSQL maximum logical replication workers (taken from the pool defined by max_worker_processes). The default is `4` (upstream default). Changing this parameter causes a service restart." }, "max_parallel_workers": { "type": "integer", "maximum": 96, "minimum": 0, "description": "Sets the maximum number of workers that the system can support for parallel queries. The default is `8` (upstream default)." }, "max_parallel_workers_per_gather": { "type": "integer", "maximum": 96, "minimum": 0, "description": "Sets the maximum number of workers that can be started by a single Gather or Gather Merge node. The default is `2` (upstream default)." }, "max_pred_locks_per_transaction": { "type": "integer", "maximum": 5120, "minimum": 64, "description": "PostgreSQL maximum predicate locks per transaction. The default is `64` (upstream default). Changing this parameter causes a service restart." }, "max_prepared_transactions": { "type": "integer", "maximum": 10000, "minimum": 0, "description": "PostgreSQL maximum prepared transactions. The default is `0`. Changing this parameter causes a service restart." }, "max_replication_slots": { "type": "integer", "maximum": 256, "minimum": 8, "description": "PostgreSQL maximum replication slots. The default is `20`. Changing this parameter causes a service restart." }, "max_slot_wal_keep_size": { "type": "integer", "maximum": 2147483647, "minimum": -1, "description": "PostgreSQL maximum WAL size (MB) reserved for replication slots. If `-1` is specified, replication slots may retain an unlimited amount of WAL files. The default is `-1` (upstream default). wal_keep_size minimum WAL size setting takes precedence over this." }, "max_stack_depth": { "type": "integer", "maximum": 6291456, "minimum": 2097152, "description": "Maximum depth of the stack in bytes. The default is `2097152` (upstream default)." }, "max_standby_archive_delay": { "type": "integer", "maximum": 43200000, "minimum": 1, "description": "Max standby archive delay in milliseconds. The default is `30000` (upstream default)." }, "max_standby_streaming_delay": { "type": "integer", "maximum": 43200000, "minimum": 1, "description": "Max standby streaming delay in milliseconds. The default is `30000` (upstream default)." }, "max_sync_workers_per_subscription": { "type": "integer", "maximum": 8, "minimum": 2, "description": "Maximum number of synchronization workers per subscription. The default is `2`." }, "max_wal_senders": { "type": "integer", "maximum": 256, "minimum": 20, "description": "PostgreSQL maximum WAL senders. The default is `20`. Changing this parameter causes a service restart." }, "max_worker_processes": { "type": "integer", "maximum": 288, "minimum": 8, "description": "Sets the maximum number of background processes that the system can support. The default is `8`. Changing this parameter causes a service restart." }, "migration": { "type": [ "object", "null" ], "properties": { "dbname": { "type": "string", "title": "Database name for bootstrapping the initial connection", "maxLength": 63 }, "host": { "type": "string", "title": "Hostname or IP address of the server where to migrate data from", "maxLength": 255 }, "ignore_dbs": { "type": "string", "title": "Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment)", "maxLength": 2048 }, "ignore_roles": { "type": "string", "title": "Comma-separated list of database roles, which should be ignored during migration (supported by PostgreSQL only at the moment)", "maxLength": 2048 }, "method": { "type": "string", "title": "The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types)", "enum": [ "dump", "replication" ] }, "password": { "type": "string", "title": "Password for authentication with the server where to migrate data from", "maxLength": 256 }, "port": { "type": "integer", "title": "Port number of the server where to migrate data from", "maximum": 65535, "minimum": 1 }, "ssl": { "type": "boolean", "title": "The server where to migrate data from is secured with SSL" }, "username": { "type": "string", "title": "User name for authentication with the server where to migrate data from", "maxLength": 256 } }, "required": [ "host", "port" ], "additionalProperties": false }, "node_count": { "type": "integer", "maximum": 100, "minimum": 1 }, "password_encryption": { "type": [ "string", "null" ], "enum": [ "md5", "scram-sha-256" ], "description": "Chooses the algorithm for encrypting passwords." }, "pg_partman_bgw_interval": { "type": "integer", "maximum": 604800, "minimum": 3600, "description": "Sets the time interval in seconds to run pg_partman's scheduled tasks. The default is `3600`." }, "pg_partman_bgw_role": { "type": "string", "maxLength": 64, "pattern": "^[_A-Za-z0-9][-._A-Za-z0-9]{0,63}$", "description": "Controls which role to use for pg_partman's scheduled background tasks." }, "pg_stat_monitor_enable": { "type": "boolean", "description": "Enable the pg_stat_monitor extension. Changing this parameter causes a service restart. When this extension is enabled, pg_stat_statements results for utility commands are unreliable" }, "pg_stat_monitor_pgsm_enable_query_plan": { "type": "boolean", "description": "Enables or disables query plan monitoring. Only available for PostgreSQL 13+." }, "pg_stat_monitor_pgsm_max_buckets": { "type": "integer", "maximum": 10, "minimum": 1, "description": "Sets the maximum number of buckets. Changing this parameter causes a service restart. Only available for PostgreSQL 13+." }, "pg_stat_statements_track": { "type": "string", "enum": [ "all", "top", "none" ], "description": "Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default is `top`." }, "pgaudit": { "type": "object", "properties": { "feature_enabled": { "type": "boolean", "title": "Enable pgaudit extension.", "description": "Enable pgaudit extension. When enabled, pgaudit extension will be automatically installed.Otherwise, extension will be uninstalled but auditing configurations will be preserved." }, "log": { "type": "array", "items": { "type": "string", "enum": [ "all", "ddl", "function", "misc", "misc_set", "read", "role", "write" ] }, "title": "Log", "description": "Specifies which classes of statements will be logged by session audit logging." }, "log_catalog": { "type": "boolean", "title": "Log Catalog", "description": "Specifies that session logging should be enabled in the case where all relations\nin a statement are in pg_catalog." }, "log_client": { "type": "boolean", "title": "Log Client", "description": "Specifies whether log messages will be visible to a client process such as psql." }, "log_level": { "type": "string", "title": "Log level", "enum": [ "debug1", "debug2", "debug3", "debug4", "debug5", "info", "notice", "warning", "log" ], "description": "Specifies the log level that will be used for log entries." }, "log_max_string_length": { "type": "integer", "title": "Log Max String Length", "maximum": 102400, "minimum": -1, "description": "Crop parameters representation and whole statements if they exceed this threshold.\nA (default) value of -1 disable the truncation." }, "log_nested_statements": { "type": "boolean", "title": "Log Nested Statements", "description": "This GUC allows to turn off logging nested statements, that is, statements that are\nexecuted as part of another ExecutorRun." }, "log_parameter": { "type": "boolean", "title": "Log Parameter", "description": "Specifies that audit logging should include the parameters that were passed with the statement." }, "log_parameter_max_size": { "type": "integer", "title": "Log Parameter Max Size", "description": "Specifies that parameter values longer than this setting (in bytes) should not be logged,\nbut replaced with ." }, "log_relation": { "type": "boolean", "title": "Log Relation", "description": "Specifies whether session audit logging should create a separate log entry\nfor each relation (TABLE, VIEW, etc.) referenced in a SELECT or DML statement." }, "log_rows": { "type": "boolean", "title": "Log Rows" }, "log_statement": { "type": "boolean", "title": "Log Statement", "description": "Specifies whether logging will include the statement text and parameters (if enabled)." }, "log_statement_once": { "type": "boolean", "title": "Log Statement Once", "description": "Specifies whether logging will include the statement text and parameters with\nthe first log entry for a statement/substatement combination or with every entry." }, "role": { "type": "string", "title": "Role", "maxLength": 64, "pattern": "^[_A-Za-z0-9][-._A-Za-z0-9]{0,63}$", "description": "Specifies the master role to use for object audit logging." } }, "description": "System-wide settings for the pgaudit extension." }, "pgbouncer": { "type": "object", "properties": { "autodb_idle_timeout": { "type": "integer", "title": "If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled. [seconds]", "maximum": 86400, "minimum": 0 }, "autodb_max_db_connections": { "type": "integer", "title": "Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited.", "maximum": 2147483647, "minimum": 0 }, "autodb_pool_mode": { "type": "string", "title": "PGBouncer pool mode", "enum": [ "transaction", "session", "statement" ] }, "autodb_pool_size": { "type": "integer", "title": "If non-zero then create automatically a pool of that size per user when a pool doesn't exist.", "maximum": 10000, "minimum": 0 }, "ignore_startup_parameters": { "type": "array", "items": { "type": "string", "enum": [ "extra_float_digits", "search_path" ] }, "title": "List of parameters to ignore when given in startup packet", "maxItems": 32 }, "max_prepared_statements": { "type": "integer", "title": "PgBouncer tracks protocol-level named prepared statements related commands sent by the client in transaction and statement pooling modes when max_prepared_statements is set to a non-zero value. Setting it to 0 disables prepared statements. max_prepared_statements defaults to 100, and its maximum is 3000.", "maximum": 3000, "minimum": 0 }, "min_pool_size": { "type": "integer", "title": "Add more server connections to pool if below this number. Improves behavior when usual load comes suddenly back after period of total inactivity. The value is effectively capped at the pool size.", "maximum": 10000, "minimum": 0 }, "server_idle_timeout": { "type": "integer", "title": "If a server connection has been idle more than this many seconds it will be dropped. If 0 then timeout is disabled. [seconds]", "maximum": 86400, "minimum": 0 }, "server_lifetime": { "type": "integer", "title": "The pooler will close an unused server connection that has been connected longer than this. [seconds]", "maximum": 86400, "minimum": 60 }, "server_reset_query_always": { "type": "boolean", "title": "Run server_reset_query (DISCARD ALL) in all pooling modes" } }, "description": "System-wide settings for pgbouncer." }, "pglookout": { "type": "object", "properties": { "max_failover_replication_time_lag": { "type": "integer", "title": "Max Failover Replication Time Lag", "maximum": 9223372036854776000, "minimum": 10, "description": "Number of seconds of master unavailability before triggering database failover to standby" } }, "description": "System-wide settings for pglookout." }, "public_access": { "type": "boolean", "description": "Allow access to the service from the public Internet" }, "public_access_prometheus": { "type": "boolean", "description": "Allow access to Prometheus metrics from the public Internet" }, "service_log": { "type": [ "boolean", "null" ], "description": "Store logs for the service so that they are available in the HTTP API and console." }, "shared_buffers_percentage": { "type": "number", "maximum": 60, "minimum": 20, "description": "Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. Changing this parameter causes a service restart." }, "synchronous_commit": { "type": "string", "enum": [ "local", "remote_write", "remote_apply", "on", "off" ], "description": "Sets the current transaction's synchronization level. The default is `off`. This setting takes precedence over `synchronous_replication`." }, "synchronous_replication": { "type": "string", "enum": [ "quorum", "off" ], "description": "This setting is deprecated. Use synchronous_commit instead. Any change to this setting will automatically update synchronous_commit. Setting the value to quorum changes synchronous_commit to remote_write, while setting it to off changes synchronous_commit to off." }, "temp_file_limit": { "type": "integer", "maximum": 2147483647, "minimum": -1, "description": "PostgreSQL temporary file limit in KiB, -1 for unlimited" }, "timescaledb": { "type": "object", "properties": { "max_background_workers": { "type": "integer", "title": "timescaledb.max_background_workers", "maximum": 4096, "minimum": 1, "description": "The number of background workers for timescaledb operations. You should configure this setting to the sum of your number of databases and the total number of concurrent background workers you want running at any given point in time. Changing this parameter causes a service restart." } }, "description": "System-wide settings for the timescaledb extension" }, "timezone": { "type": "string", "maxLength": 64, "pattern": "^[\\w/]*$", "description": "PostgreSQL service timezone" }, "track_activity_query_size": { "type": "integer", "maximum": 10240, "minimum": 1024, "description": "Specifies the number of bytes reserved to track the currently executing command for each active session. Changing this parameter causes a service restart." }, "track_commit_timestamp": { "type": "string", "enum": [ "off", "on" ], "description": "Record commit time of transactions. Changing this parameter causes a service restart." }, "track_functions": { "type": "string", "enum": [ "all", "pl", "none" ], "description": "Enables tracking of function call counts and time used." }, "track_io_timing": { "type": "string", "enum": [ "off", "on" ], "description": "Enables timing of database I/O calls. The default is `off`. When on, it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms." }, "variant": { "type": [ "string", "null" ], "enum": [ "aiven", "timescale" ] }, "version": { "type": [ "string", "null" ], "enum": [ "15", "16", "17", "18" ] }, "wal_sender_timeout": { "type": "integer", "anyOf": [ { "maximum": 0, "minimum": 0 }, { "maximum": 10800000, "minimum": 5000 } ], "description": "Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout." }, "wal_writer_delay": { "type": "integer", "maximum": 200, "minimum": 10, "description": "WAL flush interval in milliseconds. The default is `200`. Setting this parameter to a lower value may negatively impact performance." }, "work_mem": { "type": "integer", "maximum": 1024, "minimum": 1, "description": "Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. The default is 1MB + 0.075% of total RAM (up to 32MB)." } }, "additionalProperties": false, "description": "pg properties" }, "databaseServicePropertiesRedis": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "automatic_utility_network_ip_filter": { "type": "boolean", "description": "Automatically allow connections from servers in the utility network within the same zone" }, "backup_hour": { "type": [ "integer", "null" ], "maximum": 23, "minimum": 0 }, "backup_minute": { "type": [ "integer", "null" ], "maximum": 59, "minimum": 0 }, "ip_filter": { "type": "array", "items": { "type": "string", "title": "CIDR address block", "maxLength": 18, "example": [ "10.0.0.0/24" ] }, "description": "Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'" }, "migration": { "type": [ "object", "null" ], "properties": { "dbname": { "type": "string", "title": "Database name for bootstrapping the initial connection", "maxLength": 63 }, "host": { "type": "string", "title": "Hostname or IP address of the server where to migrate data from", "maxLength": 255 }, "ignore_dbs": { "type": "string", "title": "Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment)", "maxLength": 2048 }, "ignore_roles": { "type": "string", "title": "Comma-separated list of database roles, which should be ignored during migration (supported by PostgreSQL only at the moment)", "maxLength": 2048 }, "method": { "type": "string", "title": "The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types)", "enum": [ "dump", "replication" ] }, "password": { "type": "string", "title": "Password for authentication with the server where to migrate data from", "maxLength": 256 }, "port": { "type": "integer", "title": "Port number of the server where to migrate data from", "maximum": 65535, "minimum": 1 }, "ssl": { "type": "boolean", "title": "The server where to migrate data from is secured with SSL" }, "username": { "type": "string", "title": "User name for authentication with the server where to migrate data from", "maxLength": 256 } }, "required": [ "host", "port" ], "additionalProperties": false }, "public_access": { "type": "boolean", "description": "Allow access to the service from the public Internet" }, "public_access_prometheus": { "type": "boolean", "description": "Allow access to Prometheus monitoring from the public Internet" }, "redis_acl_channels_default": { "type": "string", "enum": [ "allchannels", "resetchannels" ], "description": "Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Redis configuration acl-pubsub-default." }, "redis_io_threads": { "type": "integer", "maximum": 32, "minimum": 1, "description": "Set Redis IO thread count. Changing this will cause a restart of the Redis service." }, "redis_lfu_decay_time": { "type": "integer", "maximum": 120, "minimum": 1 }, "redis_lfu_log_factor": { "type": "integer", "maximum": 100, "minimum": 0 }, "redis_maxmemory_policy": { "type": [ "string", "null" ], "enum": [ "noeviction", "allkeys-lru", "volatile-lru", "allkeys-random", "volatile-random", "volatile-ttl", "volatile-lfu", "allkeys-lfu" ] }, "redis_notify_keyspace_events": { "type": "string", "maxLength": 32, "pattern": "^[KEg\\$lshzxentdmA]*$" }, "redis_number_of_databases": { "type": "integer", "maximum": 128, "minimum": 1, "description": "Set number of Redis databases. Changing this will cause a restart of the Redis service." }, "redis_persistence": { "type": "string", "enum": [ "off", "rdb" ], "description": "When persistence is 'rdb', Redis does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to the backup schedule for backup purposes. When persistence is 'off', no RDB dumps or backups are done, so data can be lost at any moment if the service is restarted for any reason, or if the service is powered off. Also, the service can't be forked." }, "redis_pubsub_client_output_buffer_limit": { "type": "integer", "maximum": 512, "minimum": 32, "description": "Set output buffer limit for pub / sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan." }, "redis_ssl": { "type": "boolean" }, "redis_timeout": { "type": "integer", "maximum": 2073600, "minimum": 0 }, "redis_version": { "type": [ "string", "null" ], "enum": [ "7.0" ] }, "service_log": { "type": [ "boolean", "null" ], "description": "Store logs for the service so that they are available in the HTTP API and console." } }, "additionalProperties": false, "description": "redis properties" }, "databaseServicePropertiesOpensearch": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "action_auto_create_index_enabled": { "type": "boolean", "description": "Explicitly allow or block automatic creation of indices. Defaults to true" }, "action_destructive_requires_name": { "type": [ "boolean", "null" ] }, "auth_failure_listeners": { "type": "object", "properties": { "internal_authentication_backend_limiting": { "type": "object", "properties": { "allowed_tries": { "type": "integer", "title": "internal_authentication_backend_limiting.allowed_tries", "maximum": 32767, "minimum": 1, "description": "The number of login attempts allowed before login is blocked", "example": 10 }, "authentication_backend": { "type": "string", "title": "internal_authentication_backend_limiting.authentication_backend", "maxLength": 1024, "enum": [ "internal" ], "description": "The internal backend. Enter `internal`", "example": "internal" }, "block_expiry_seconds": { "type": "integer", "title": "internal_authentication_backend_limiting.block_expiry_seconds", "maximum": 2147483647, "minimum": 0, "description": "The duration of time that login remains blocked after a failed login", "example": 600 }, "max_blocked_clients": { "type": "integer", "title": "internal_authentication_backend_limiting.max_blocked_clients", "maximum": 2147483647, "minimum": 0, "description": "The maximum number of blocked IP addresses", "example": 100000 }, "max_tracked_clients": { "type": "integer", "title": "internal_authentication_backend_limiting.max_tracked_clients", "maximum": 2147483647, "minimum": 0, "description": "The maximum number of tracked IP addresses that have failed login", "example": 100000 }, "time_window_seconds": { "type": "integer", "title": "internal_authentication_backend_limiting.time_window_seconds", "maximum": 2147483647, "minimum": 0, "description": "The window of time in which the value for `allowed_tries` is enforced", "example": 3600 }, "type": { "type": "string", "title": "internal_authentication_backend_limiting.type", "maxLength": 1024, "enum": [ "username" ], "description": "The type of rate limiting", "example": "username" } }, "additionalProperties": false } }, "additionalProperties": false }, "automatic_utility_network_ip_filter": { "type": "boolean", "description": "Automatically allow connections from servers in the utility network within the same zone" }, "cluster_filecache_remote_data_ratio": { "type": [ "integer", "number", "null" ], "maximum": 100, "minimum": 0, "description": "Defines a limit of how much total remote data can be referenced as a ratio of the size of the disk reserved for the file cache. This is designed to be a safeguard to prevent oversubscribing a cluster. Defaults to 0." }, "cluster_max_shards_per_node": { "type": "integer", "maximum": 10000, "minimum": 10, "description": "Controls the number of shards allowed in the cluster per data node" }, "cluster_remote_store": { "type": "object", "properties": { "state.global_metadata.upload_timeout": { "type": "string", "title": "The amount of time to wait for the cluster state upload to complete", "pattern": "^\\d+\\s*(?:[dhms]|ms|micros|nanos)$", "description": "The amount of time to wait for the cluster state upload to complete. Defaults to 20s." }, "state.metadata_manifest.upload_timeout": { "type": "string", "title": "The amount of time to wait for the manifest file upload to complete", "pattern": "^\\d+\\s*(?:[dhms]|ms|micros|nanos)$", "description": "The amount of time to wait for the manifest file upload to complete. The manifest file contains the details of each of the files uploaded for a single cluster state, both index metadata files and global metadata files. Defaults to 20s." }, "translog.buffer_interval": { "type": "string", "title": "The default value of the translog buffer interval", "pattern": "^\\d+\\s*(?:[dhms]|ms|micros|nanos)$", "description": "The default value of the translog buffer interval used when performing periodic translog updates. This setting is only effective when the index setting `index.remote_store.translog.buffer_interval` is not present. Defaults to 650ms." }, "translog.max_readers": { "type": "integer", "title": "The maximum number of open translog files for remote-backed indexes", "maximum": 2147483647, "minimum": 100, "description": "Sets the maximum number of open translog files for remote-backed indexes. This limits the total number of translog files per shard. After reaching this limit, the remote store flushes the translog files. Default is 1000. The minimum required is 100." } }, "additionalProperties": false }, "cluster_routing_allocation_balance_prefer_primary": { "type": "boolean", "description": "When set to true, OpenSearch attempts to evenly distribute the primary shards between the cluster nodes. Enabling this setting does not always guarantee an equal number of primary shards on each node, especially in the event of a failover. Changing this setting to false after it was set to true does not invoke redistribution of primary shards. Default is false." }, "cluster_routing_allocation_node_concurrent_recoveries": { "type": "integer", "maximum": 16, "minimum": 2, "description": "How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to node cpu count * 2." }, "cluster_search_request_slowlog": { "type": "object", "properties": { "level": { "type": "string", "title": "Log level", "enum": [ "debug", "info", "trace", "warn" ] }, "threshold": { "type": "object", "properties": { "debug": { "type": "string", "title": "Debug threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1", "pattern": "^[^\\r\\n]*$" }, "info": { "type": "string", "title": "Info threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1", "pattern": "^[^\\r\\n]*$" }, "trace": { "type": "string", "title": "Trace threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1", "pattern": "^[^\\r\\n]*$" }, "warn": { "type": "string", "title": "Warning threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1", "pattern": "^[^\\r\\n]*$" } }, "additionalProperties": false } }, "additionalProperties": false }, "custom_domain": { "type": [ "string", "null" ], "maxLength": 255, "description": "Serve the web frontend using a custom CNAME pointing to the UpCloud DNS name. When you set a custom domain for a service deployed in a VPC, the service certificate is only created for the public-* hostname and the custom domain." }, "custom_keystores": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^\\r\\n]*$" }, "settings": { "oneOf": [ { "type": "object", "properties": { "account": { "type": "string", "title": "Account name", "pattern": "^[^\\r\\n]*$" }, "key": { "type": "string", "title": "Account secret key", "pattern": "^[^\\r\\n]*$", "description": "Azure account secret key. One of key or sas_token should be specified" }, "sas_token": { "type": "string", "title": "SAS token", "pattern": "^[^\\r\\n]*$", "description": "A shared access signatures (SAS) token. One of key or sas_token should be specified" } }, "required": [ "account" ], "additionalProperties": false }, { "type": "object", "properties": { "credentials": { "type": "object", "properties": { "auth_provider_x509_cert_url": { "type": "string", "title": "The certificate service of Google", "example": "https://www.googleapis.com/oauth2/v1/certs" }, "auth_uri": { "type": "string", "title": "The authentication endpoint of Google", "example": "https://accounts.google.com/o/oauth2/auth" }, "client_email": { "type": "string", "title": "Email of the service account", "example": "my-service-account@some-my-project.iam.gserviceaccount.com" }, "client_id": { "type": "string", "title": "Numeric client id for this service account", "example": "103654484443722885992" }, "client_x509_cert_url": { "type": "string", "title": "Certificate URL for your service account", "example": "https://www.googleapis.com/robot/v1/metadata/x509/my-service-account%40some-my-project.iam.gserviceaccount.com" }, "hmac_access_id": { "type": "string", "description": "The access ID for HMAC authentication with Google Cloud Storage" }, "hmac_secret": { "type": "string", "description": "The secret key for HMAC authentication with Google Cloud Storage" }, "private_key": { "type": "string", "title": "PEM-encoded private key", "example": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n" }, "private_key_id": { "type": "string", "title": "Hexadecimal ID number of your private key", "example": "5fdeb02a11ddf081930ac3ac60bf376a0aef8fad" }, "project_id": { "type": "string", "title": "Gcloud project id", "example": "some-my-project" }, "token_uri": { "type": "string", "title": "The token lease endpoint of Google", "example": "https://accounts.google.com/o/oauth2/token" }, "type": { "type": "string", "title": "Credentials type", "description": "Always service_account for credentials created in Gcloud console or CLI", "example": "service_account" }, "universe_domain": { "type": "string", "title": "The universe domain", "description": "The universe domain. The default universe domain is googleapis.com.", "example": "{\"universe_domain\": \"googleapis.com\", ..." } }, "title": "Google service account credentials map", "required": [ "private_key_id", "private_key", "client_email", "client_id", "type" ], "additionalProperties": false } }, "required": [ "credentials" ], "additionalProperties": false }, { "type": "object", "properties": { "access_key": { "type": "string", "title": "AWS Access key", "pattern": "^[^\\r\\n]*$" }, "secret_key": { "type": "string", "title": "AWS secret key", "pattern": "^[^\\r\\n]*$", "description": "AWS secret key" } }, "required": [ "access_key", "secret_key" ], "additionalProperties": false } ] }, "type": { "type": "string", "enum": [ "azure", "gcs", "s3" ] } }, "required": [ "name", "settings", "type" ], "additionalProperties": false }, "description": "Allow to register custom keystores in OpenSearch" }, "custom_repos": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[^\\r\\n]*$" }, "settings": { "oneOf": [ { "type": "object", "properties": { "account": { "type": "string", "title": "Account name", "pattern": "^[^\\r\\n]*$" }, "base_path": { "type": "string", "title": "The path to the repository data within its container", "pattern": "^[^\\r\\n]*$", "description": "The path to the repository data within its container. The value of this setting should not start or end with a /" }, "chunk_size": { "type": "string", "title": "Chunk size", "pattern": "^[^\\r\\n]*$", "description": "Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository" }, "compress": { "type": "boolean", "title": "Metadata files are stored in compressed format", "description": "when set to true metadata files are stored in compressed format" }, "container": { "type": "string", "title": "Azure container name", "pattern": "^[^\\r\\n]*$", "description": "Azure container name" }, "endpoint_suffix": { "type": "string", "title": "Endpoint suffix", "pattern": "^[^\\r\\n]*$", "description": "Defines the DNS suffix for Azure Storage endpoints." }, "key": { "type": "string", "title": "Account secret key", "pattern": "^[^\\r\\n]*$", "description": "Azure account secret key. One of key or sas_token should be specified" }, "max_restore_bytes_per_sec": { "type": "string", "title": "Restore bytes per second", "pattern": "^\\d+\\s*(?:[bB]|[kKmMgGtTpP][bB])$", "description": "Throttles the restore rate per node. Defaults to unlimited. Note that if the recovery settings for managed services are set, this value is overridden by the recovery settings. Value should be a byte size with unit, e.g. 40mb, 100kb, 1gb", "example": "40mb" }, "max_snapshot_bytes_per_sec": { "type": "string", "title": "Snapshot bytes per second", "pattern": "^\\d+\\s*(?:[bB]|[kKmMgGtTpP][bB])$", "description": "Throttles the snapshot rate per node. Defaults to 40mb. Note that if the recovery settings for managed services are set, this value is overridden by the recovery settings. Value should be a byte size with unit, e.g. 40mb, 100kb, 1gb", "example": "40mb" }, "readonly": { "type": "boolean", "title": "Whether the repository is read-only.", "default": false }, "sas_token": { "type": "string", "title": "SAS token", "pattern": "^[^\\r\\n]*$", "description": "A shared access signatures (SAS) token. One of key or sas_token should be specified" } }, "required": [ "account", "base_path", "container" ], "additionalProperties": false }, { "type": "object", "properties": { "base_path": { "type": "string", "title": "The path to the repository data within its container", "pattern": "^[^\\r\\n]*$", "description": "The path to the repository data within its container. The value of this setting should not start or end with a /" }, "bucket": { "type": "string", "title": "Google Cloud Storage bucket name", "pattern": "^[^\\r\\n]*$", "description": "The path to the repository data within its container" }, "chunk_size": { "type": "string", "title": "Chunk size", "pattern": "^[^\\r\\n]*$", "description": "Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository" }, "compress": { "type": "boolean", "title": "Metadata files are stored in compressed format", "description": "when set to true metadata files are stored in compressed format" }, "credentials": { "type": "object", "properties": { "auth_provider_x509_cert_url": { "type": "string", "title": "The certificate service of Google", "example": "https://www.googleapis.com/oauth2/v1/certs" }, "auth_uri": { "type": "string", "title": "The authentication endpoint of Google", "example": "https://accounts.google.com/o/oauth2/auth" }, "client_email": { "type": "string", "title": "Email of the service account", "example": "my-service-account@some-my-project.iam.gserviceaccount.com" }, "client_id": { "type": "string", "title": "Numeric client id for this service account", "example": "103654484443722885992" }, "client_x509_cert_url": { "type": "string", "title": "Certificate URL for your service account", "example": "https://www.googleapis.com/robot/v1/metadata/x509/my-service-account%40some-my-project.iam.gserviceaccount.com" }, "hmac_access_id": { "type": "string", "description": "The access ID for HMAC authentication with Google Cloud Storage" }, "hmac_secret": { "type": "string", "description": "The secret key for HMAC authentication with Google Cloud Storage" }, "private_key": { "type": "string", "title": "PEM-encoded private key", "example": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n" }, "private_key_id": { "type": "string", "title": "Hexadecimal ID number of your private key", "example": "5fdeb02a11ddf081930ac3ac60bf376a0aef8fad" }, "project_id": { "type": "string", "title": "Gcloud project id", "example": "some-my-project" }, "token_uri": { "type": "string", "title": "The token lease endpoint of Google", "example": "https://accounts.google.com/o/oauth2/token" }, "type": { "type": "string", "title": "Credentials type", "description": "Always service_account for credentials created in Gcloud console or CLI", "example": "service_account" }, "universe_domain": { "type": "string", "title": "The universe domain", "description": "The universe domain. The default universe domain is googleapis.com.", "example": "{\"universe_domain\": \"googleapis.com\", ..." } }, "title": "Google service account credentials map", "required": [ "private_key_id", "private_key", "client_email", "client_id", "type" ], "additionalProperties": false }, "max_restore_bytes_per_sec": { "type": "string", "title": "Restore bytes per second", "pattern": "^\\d+\\s*(?:[bB]|[kKmMgGtTpP][bB])$", "description": "Throttles the restore rate per node. Defaults to unlimited. Note that if the recovery settings for managed services are set, this value is overridden by the recovery settings. Value should be a byte size with unit, e.g. 40mb, 100kb, 1gb", "example": "40mb" }, "max_snapshot_bytes_per_sec": { "type": "string", "title": "Snapshot bytes per second", "pattern": "^\\d+\\s*(?:[bB]|[kKmMgGtTpP][bB])$", "description": "Throttles the snapshot rate per node. Defaults to 40mb. Note that if the recovery settings for managed services are set, this value is overridden by the recovery settings. Value should be a byte size with unit, e.g. 40mb, 100kb, 1gb", "example": "40mb" }, "readonly": { "type": "boolean", "title": "Whether the repository is read-only.", "default": false } }, "required": [ "base_path", "bucket", "credentials" ], "additionalProperties": false }, { "type": "object", "properties": { "access_key": { "type": "string", "title": "AWS Access key", "pattern": "^[^\\r\\n]*$" }, "base_path": { "type": "string", "title": "The path to the repository data within its container", "pattern": "^[^\\r\\n]*$", "description": "The path to the repository data within its container. The value of this setting should not start or end with a /" }, "bucket": { "type": "string", "title": "S3 bucket name", "pattern": "^[^\\r\\n]*$" }, "chunk_size": { "type": "string", "title": "Chunk size", "pattern": "^[^\\r\\n]*$", "description": "Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository" }, "compress": { "type": "boolean", "title": "Metadata files are stored in compressed format", "description": "when set to true metadata files are stored in compressed format" }, "endpoint": { "type": "string", "title": "The S3 service endpoint to connect", "pattern": "^[^\\r\\n]*$", "description": "The S3 service endpoint to connect to. If you are using an S3-compatible service then you should set this to the service’s endpoint" }, "max_restore_bytes_per_sec": { "type": "string", "title": "Restore bytes per second", "pattern": "^\\d+\\s*(?:[bB]|[kKmMgGtTpP][bB])$", "description": "Throttles the restore rate per node. Defaults to unlimited. Note that if the recovery settings for managed services are set, this value is overridden by the recovery settings. Value should be a byte size with unit, e.g. 40mb, 100kb, 1gb", "example": "40mb" }, "max_snapshot_bytes_per_sec": { "type": "string", "title": "Snapshot bytes per second", "pattern": "^\\d+\\s*(?:[bB]|[kKmMgGtTpP][bB])$", "description": "Throttles the snapshot rate per node. Defaults to 40mb. Note that if the recovery settings for managed services are set, this value is overridden by the recovery settings. Value should be a byte size with unit, e.g. 40mb, 100kb, 1gb", "example": "40mb" }, "readonly": { "type": "boolean", "title": "Whether the repository is read-only.", "default": false }, "region": { "type": "string", "title": "S3 region", "pattern": "^[^\\r\\n]*$" }, "secret_key": { "type": "string", "title": "AWS secret key", "pattern": "^[^\\r\\n]*$", "description": "AWS secret key" }, "server_side_encryption": { "type": "boolean", "title": "Server side encryption", "description": "When set to true files are encrypted on server side" } }, "required": [ "base_path", "bucket", "region", "access_key", "secret_key" ], "additionalProperties": false } ] }, "type": { "type": "string", "enum": [ "azure", "gcs", "s3" ] } }, "required": [ "name", "type", "settings" ], "additionalProperties": false }, "description": "Allow to register object storage repositories in OpenSearch" }, "disk_watermarks": { "type": "object", "properties": { "flood_stage": { "type": "integer", "title": "Flood stage watermark (percentage)", "description": "The flood stage watermark for disk usage." }, "high": { "type": "integer", "title": "High watermark (percentage)", "description": "The high watermark for disk usage." }, "low": { "type": "integer", "title": "Low watermark (percentage)", "description": "The low watermark for disk usage." } }, "required": [ "low", "high", "flood_stage" ], "additionalProperties": false }, "elasticsearch_version": { "type": [ "string", "null" ], "enum": [ "1", "2", "2.19", "3.3", "3.6" ] }, "email_sender_name": { "type": "string", "maxLength": 40, "pattern": "^[a-zA-Z0-9-_]+$", "description": "This should be identical to the Sender name defined in Opensearch dashboards" }, "email_sender_password": { "type": "string", "maxLength": 1024, "pattern": "^[^\\x00-\\x1F]+$", "description": "Sender password for Opensearch alerts to authenticate with SMTP server" }, "email_sender_username": { "type": "string", "maxLength": 320, "pattern": "^[^\\x00-\\x1F]+$" }, "enable_remote_backed_storage": { "type": "boolean" }, "enable_searchable_snapshots": { "type": "boolean" }, "enable_security_audit": { "type": "boolean" }, "enable_snapshot_api": { "type": "boolean", "description": "Enable/Disable snapshot API for custom repositories, this requires security management to be enabled" }, "http_max_content_length": { "type": "integer", "maximum": 2147483647, "minimum": 1048576, "description": "Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes." }, "http_max_header_size": { "type": "integer", "maximum": 262144, "minimum": 1024, "description": "The max size of allowed headers, in bytes" }, "http_max_initial_line_length": { "type": "integer", "maximum": 65536, "minimum": 1024, "description": "The max length of an HTTP URL, in bytes" }, "index_patterns": { "type": "array", "items": { "type": "object", "properties": { "max_index_count": { "type": "integer", "title": "Maximum number of indexes to keep", "maximum": 9223372036854776000, "minimum": 0, "example": 3 }, "pattern": { "type": "string", "title": "fnmatch pattern", "maxLength": 1024, "pattern": "^[A-Za-z0-9-_.*?]+$", "example": "logs_*_foo_*" }, "sorting_algorithm": { "type": "string", "title": "Deletion sorting algorithm", "enum": [ "alphabetical", "creation_date" ], "default": "creation_date" } }, "title": "Glob pattern and number of indexes matching that pattern to be kept", "required": [ "pattern", "max_index_count" ], "additionalProperties": false, "description": "Allows you to create glob style patterns and set a max number of indexes matching this pattern you want to keep. Creating indexes exceeding this value will cause the oldest one to get deleted. You could for example create a pattern looking like 'logs.?' and then create index logs.1, logs.2 etc, it will delete logs.1 once you create logs.6. Do note 'logs.?' does not apply to logs.10. Note: Setting max_index_count to 0 will do nothing and the pattern gets ignored." } }, "index_rollup": { "type": "object", "properties": { "rollup_dashboards_enabled": { "type": "boolean", "title": "plugins.rollup.dashboards.enabled", "description": "Whether rollups are enabled in OpenSearch Dashboards. Defaults to true." }, "rollup_enabled": { "type": "boolean", "title": "plugins.rollup.enabled", "description": "Whether the rollup plugin is enabled. Defaults to true." }, "rollup_search_backoff_count": { "type": "integer", "title": "plugins.rollup.search.backoff_count", "minimum": 1, "description": "How many retries the plugin should attempt for failed rollup jobs. Defaults to 5." }, "rollup_search_backoff_millis": { "type": "integer", "title": "plugins.rollup.search.backoff_millis", "minimum": 1, "description": "The backoff time between retries for failed rollup jobs. Defaults to 1000ms." }, "rollup_search_search_all_jobs": { "type": "boolean", "title": "plugins.rollup.search.all_jobs", "description": "Whether OpenSearch should return all jobs that match all specified search terms. If disabled, OpenSearch returns just one, as opposed to all, of the jobs that matches the search terms. Defaults to false." } }, "additionalProperties": false }, "index_template": { "type": "object", "properties": { "mapping_nested_objects_limit": { "type": [ "integer", "null" ], "title": "(DEPRECATED) index.mapping.nested_objects.limit", "maximum": 100000, "minimum": 0, "description": "The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000. Deprecated, use an index template instead." }, "number_of_replicas": { "type": [ "integer", "null" ], "title": "(DEPRECATED) index.number_of_replicas", "maximum": 29, "minimum": 0, "description": "The number of replicas each primary shard has. Deprecated, use an index template instead." }, "number_of_shards": { "type": [ "integer", "null" ], "title": "(DEPRECATED) index.number_of_shards", "maximum": 1024, "minimum": 1, "description": "The number of primary shards that an index should have. Deprecated, use an index template instead." } }, "additionalProperties": false }, "indices_fielddata_cache_size": { "type": [ "integer", "null" ], "maximum": 100, "minimum": 3, "description": "Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations." }, "indices_memory_index_buffer_size": { "type": "integer", "maximum": 40, "minimum": 3, "description": "Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance." }, "indices_memory_max_index_buffer_size": { "type": "integer", "maximum": 2048, "minimum": 3, "description": "Absolute value. Default is unbound. Doesn't work without indices.memory.index_buffer_size. Maximum amount of heap used for query cache, an absolute indices.memory.index_buffer_size maximum hard limit." }, "indices_memory_min_index_buffer_size": { "type": "integer", "maximum": 2048, "minimum": 3, "description": "Absolute value. Default is 48mb. Doesn't work without indices.memory.index_buffer_size. Minimum amount of heap used for query cache, an absolute indices.memory.index_buffer_size minimal hard limit." }, "indices_queries_cache_size": { "type": "integer", "maximum": 40, "minimum": 3, "description": "Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality." }, "indices_query_bool_max_clause_count": { "type": "integer", "maximum": 4096, "minimum": 64, "description": "Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value." }, "indices_recovery_max_bytes_per_sec": { "type": "integer", "maximum": 400, "minimum": 40, "description": "Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb" }, "indices_recovery_max_concurrent_file_chunks": { "type": "integer", "maximum": 5, "minimum": 2, "description": "Number of file chunks sent in parallel for each recovery. Defaults to 2." }, "ip_filter": { "type": "array", "items": { "type": "string", "title": "CIDR address block", "maxLength": 18, "example": [ "10.0.0.0/24" ] }, "description": "Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'" }, "ism_enabled": { "type": "boolean" }, "ism_history_enabled": { "type": "boolean" }, "ism_history_max_age": { "type": "integer", "maximum": 2147483647, "minimum": 1 }, "ism_history_max_docs": { "type": "integer", "maximum": 9223372036854776000, "minimum": 1 }, "ism_history_rollover_check_period": { "type": "integer", "maximum": 2147483647, "minimum": 1 }, "ism_history_rollover_retention_period": { "type": "integer", "maximum": 2147483647, "minimum": 1 }, "jwt": { "type": "object", "properties": { "enabled": { "type": "boolean", "title": "Enable or disable OpenSearch JWT authentication", "description": "Enables or disables JWT-based authentication for OpenSearch. When enabled, users can authenticate using JWT tokens." }, "jwt_clock_skew_tolerance_seconds": { "type": [ "integer", "null" ], "title": "JWT clock skew tolerance in seconds", "maximum": 300, "minimum": 0, "description": "The maximum allowed time difference in seconds between the JWT issuer's clock and the OpenSearch server's clock. This helps prevent token validation failures due to minor time synchronization issues." }, "jwt_header": { "type": [ "string", "null" ], "title": "HTTP header name for JWT token", "maxLength": 256, "minLength": 1, "pattern": "^[^\\r\\n]*$", "description": "The HTTP header name where the JWT token is transmitted. Typically 'Authorization' for Bearer tokens." }, "jwt_url_parameter": { "type": [ "string", "null" ], "title": "URL parameter name for JWT token", "maxLength": 256, "minLength": 1, "pattern": "^[^\\r\\n]*$", "description": "If the JWT token is transmitted as a URL parameter instead of an HTTP header, specify the parameter name here." }, "required_audience": { "type": [ "string", "null" ], "title": "Required JWT audience", "maxLength": 1024, "minLength": 1, "pattern": "^[^\\r\\n]*$", "description": "If specified, the JWT must contain an 'aud' claim that matches this value. This provides additional security by ensuring the JWT was issued for the expected audience." }, "required_issuer": { "type": [ "string", "null" ], "title": "Required JWT issuer", "maxLength": 1024, "minLength": 1, "pattern": "^[^\\r\\n]*$", "description": "If specified, the JWT must contain an 'iss' claim that matches this value. This provides additional security by ensuring the JWT was issued by the expected issuer." }, "roles_key": { "type": [ "string", "null" ], "title": "JWT claim key for roles", "maxLength": 256, "minLength": 1, "pattern": "^[^\\r\\n]*$", "description": "The key in the JWT payload that contains the user's roles. If specified, roles will be extracted from the JWT for authorization." }, "signing_key": { "type": "string", "title": "JWT signing key", "maxLength": 1024, "minLength": 1, "description": "The secret key used to sign and verify JWT tokens. This should be a secure, randomly generated key HMAC key or public RSA/ECDSA key." }, "subject_key": { "type": [ "string", "null" ], "title": "JWT claim key for subject", "maxLength": 256, "minLength": 1, "pattern": "^[^\\r\\n]*$", "description": "The key in the JWT payload that contains the user's subject identifier. If not specified, the 'sub' claim is used by default." } }, "required": [ "enabled", "signing_key" ], "additionalProperties": false }, "keep_index_refresh_interval": { "type": "boolean", "description": "UpCloud automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true." }, "knn_memory_circuit_breaker_enabled": { "type": "boolean", "description": "Enable or disable KNN memory circuit breaker. Defaults to true." }, "knn_memory_circuit_breaker_limit": { "type": "integer", "maximum": 100, "minimum": 0, "description": "Maximum amount of memory in percentage that can be used for the KNN index. Defaults to 50% of the JVM heap size. 0 is used to set it to null which can be used to invalidate caches." }, "ml_commons_model_access_control_enabled": { "type": "boolean", "description": "Enable or disable model access control for ML Commons. When enabled, access to ML models is controlled by security permissions. Defaults to false." }, "ml_commons_native_memory_threshold": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Native memory threshold percentage for ML Commons. Controls the maximum percentage of native memory that can be used by ML Commons operations. Defaults to 90%." }, "ml_commons_only_run_on_ml_node": { "type": "boolean", "description": "Enable or disable running ML Commons tasks only on ML nodes. When enabled, ML tasks will only execute on nodes designated as ML nodes. Defaults to true." }, "node_search_cache_size": { "type": [ "string", "null" ], "pattern": "\\d+(?:b|kb|mb|gb|tb)", "description": "Defines a limit of how much total remote data can be referenced as a ratio of the size of the disk reserved for the file cache. This is designed to be a safeguard to prevent oversubscribing a cluster. Defaults to 5gb. Requires restarting all OpenSearch nodes." }, "openid": { "type": "object", "properties": { "client_id": { "type": "string", "title": "The ID of the OpenID Connect client", "maxLength": 1024, "minLength": 1, "pattern": "^[^\\r\\n]*$", "description": "The ID of the OpenID Connect client configured in your IdP. Required." }, "client_secret": { "type": "string", "title": "The client secret of the OpenID Connect", "maxLength": 1024, "minLength": 1, "pattern": "^[^\\r\\n]*$", "description": "The client secret of the OpenID Connect client configured in your IdP. Required." }, "connect_url": { "type": "string", "title": "OpenID Connect metadata/configuration URL", "maxLength": 2048, "pattern": "^[^\\r\\n]*$", "description": "The URL of your IdP where the Security plugin can find the OpenID Connect metadata/configuration settings." }, "enabled": { "type": "boolean", "title": "Enable or disable OpenSearch OpenID Connect authentication", "description": "Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider." }, "header": { "type": "string", "title": "HTTP header name of the JWT token", "maxLength": 1024, "minLength": 1, "pattern": "^[^\\r\\n]*$", "description": "HTTP header name of the JWT token. Optional. Default is Authorization." }, "jwt_header": { "type": [ "string", "null" ], "title": "The HTTP header that stores the token", "maxLength": 1024, "minLength": 1, "pattern": "^[^\\r\\n]*$", "description": "The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer . Optional. Default is Authorization." }, "jwt_url_parameter": { "type": [ "string", "null" ], "title": "URL JWT token.", "maxLength": 1024, "minLength": 1, "pattern": "^[^\\r\\n]*$", "description": "If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional." }, "refresh_rate_limit_count": { "type": [ "integer", "null" ], "title": "The maximum number of unknown key IDs in the time frame", "maximum": 9223372036854776000, "minimum": 10, "description": "The maximum number of unknown key IDs in the time frame. Default is 10. Optional." }, "refresh_rate_limit_time_window_ms": { "type": [ "integer", "null" ], "title": "The time frame to use when checking the maximum number of unknown key IDs, in milliseconds", "maximum": 9223372036854776000, "minimum": 10000, "description": "The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds)." }, "roles_key": { "type": [ "string", "null" ], "title": "The key in the JSON payload that stores the user’s roles", "maxLength": 1024, "minLength": 1, "pattern": "^[^\\r\\n]*$", "description": "The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT" }, "scope": { "type": "string", "title": "The scope of the identity token issued by the IdP", "maxLength": 1024, "minLength": 1, "pattern": "^[^\\r\\n]*$", "description": "The scope of the identity token issued by the IdP. Optional. Default is openid profile email address phone." }, "subject_key": { "type": [ "string", "null" ], "title": "The key in the JSON payload that stores the user’s name", "maxLength": 1024, "minLength": 1, "pattern": "^[^\\r\\n]*$", "description": "The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional." } }, "required": [ "enabled", "connect_url", "client_id", "client_secret" ], "additionalProperties": false }, "opensearch_dashboards": { "type": "object", "properties": { "enabled": { "type": "boolean", "title": "Enable or disable OpenSearch Dashboards" }, "max_old_space_size": { "type": "integer", "title": "max_old_space_size", "maximum": 4096, "minimum": 64, "description": "Limits the maximum amount of memory (in MiB) the OpenSearch Dashboards process can use. This sets the max_old_space_size option of the nodejs running the OpenSearch Dashboards. Note: the memory reserved by OpenSearch Dashboards is not available for OpenSearch." }, "multiple_data_source_enabled": { "type": "boolean", "title": "Enable or disable multiple data sources in OpenSearch Dashboards" }, "opensearch_request_timeout": { "type": "integer", "title": "Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch", "maximum": 120000, "minimum": 5000 }, "session_keepalive": { "type": "boolean", "title": "Determines whether the session TTL resets (is “kept alive”) on each user activity. Optional. Default is true." }, "session_ttl": { "type": "string", "title": "session_ttl", "pattern": "^\\d+\\s*(?:[dhms]|ms|micros|nanos)$", "description": "Defines the time-to-live (TTL) for user sessions. The value should be a time value with unit, e.g. 1m, 5s, 1h, 3d, 100ms. Default is 1 hour." } }, "additionalProperties": false }, "override_main_response_version": { "type": "boolean", "description": "Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false. Deprecated and ignored for service version 3.3 and higher." }, "plugins_alerting_filter_by_backend_roles": { "type": "boolean", "description": "Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false" }, "public_access": { "type": "boolean", "description": "Allow access to the service from the public Internet" }, "public_access_prometheus": { "type": "boolean", "description": "Allow access to Prometheus metrics from the public Internet" }, "reindex_remote_whitelist": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ], "title": "Address (hostname:port or IP:port)", "maxLength": 261, "pattern": "^[^\\r\\n]*$", "example": "anotherservice.aivencloud.com:12398" }, "description": "Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart." }, "remote_store": { "type": "object", "properties": { "segment.pressure.bytes_lag.variance_factor": { "type": "number", "title": "The variance factor that is used to calculate the dynamic bytes lag threshold", "minimum": 1, "description": "The variance factor that is used together with the moving average to calculate the dynamic bytes lag threshold for activating remote segment backpressure. Defaults to 10." }, "segment.pressure.consecutive_failures.limit": { "type": "integer", "title": "The minimum consecutive failure count for activating remote segment backpressure", "maximum": 2147483647, "minimum": 1, "description": "The minimum consecutive failure count for activating remote segment backpressure. Defaults to 5." }, "segment.pressure.enabled": { "type": "boolean", "title": "Enables remote segment backpressure", "description": "Enables remote segment backpressure. Default is `true`" }, "segment.pressure.time_lag.variance_factor": { "type": "number", "title": "The variance factor that is used to calculate the dynamic bytes lag threshold", "minimum": 1, "description": "The variance factor that is used together with the moving average to calculate the dynamic time lag threshold for activating remote segment backpressure. Defaults to 10." } }, "additionalProperties": false }, "saml": { "type": "object", "properties": { "enabled": { "type": "boolean", "title": "Enable or disable OpenSearch SAML authentication", "description": "Enables or disables SAML-based authentication for OpenSearch. When enabled, users can authenticate using SAML with an Identity Provider." }, "idp_entity_id": { "type": "string", "title": "Identity Provider Entity ID", "maxLength": 1024, "minLength": 1, "pattern": "^[^\\r\\n]*$", "description": "The unique identifier for the Identity Provider (IdP) entity that is used for SAML authentication. This value is typically provided by the IdP." }, "idp_metadata_url": { "type": "string", "title": "Identity Provider (IdP) SAML metadata URL", "maxLength": 2048, "minLength": 1, "pattern": "^[^\\r\\n]*$", "description": "The URL of the SAML metadata for the Identity Provider (IdP). This is used to configure SAML-based authentication with the IdP." }, "idp_pemtrustedcas_content": { "type": [ "string", "null" ], "title": "PEM-encoded root CA Content for SAML IdP server verification", "maxLength": 16384, "description": "This parameter specifies the PEM-encoded root certificate authority (CA) content for the SAML identity provider (IdP) server verification. The root CA content is used to verify the SSL/TLS certificate presented by the server." }, "roles_key": { "type": [ "string", "null" ], "title": "SAML response role attribute", "maxLength": 256, "minLength": 1, "pattern": "^[^\\r\\n]*$", "description": "Optional. Specifies the attribute in the SAML response where role information is stored, if available. Role attributes are not required for SAML authentication, but can be included in SAML assertions by most Identity Providers (IdPs) to determine user access levels or permissions." }, "sp_entity_id": { "type": "string", "title": "Service Provider Entity ID", "maxLength": 1024, "minLength": 1, "pattern": "^[^\\r\\n]*$", "description": "The unique identifier for the Service Provider (SP) entity that is used for SAML authentication. This value is typically provided by the SP." }, "subject_key": { "type": [ "string", "null" ], "title": "SAML response subject attribute", "maxLength": 256, "minLength": 1, "pattern": "^[^\\r\\n]*$", "description": "Optional. Specifies the attribute in the SAML response where the subject identifier is stored. If not configured, the NameID attribute is used by default." } }, "required": [ "enabled", "idp_metadata_url", "idp_entity_id", "sp_entity_id" ], "additionalProperties": false }, "script_max_compilations_rate": { "type": "string", "maxLength": 1024, "pattern": "^[^\\r\\n]*$", "description": "Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context" }, "search_backpressure": { "type": "object", "properties": { "mode": { "type": "string", "title": "The search backpressure mode", "enum": [ "monitor_only", "enforced", "disabled" ], "description": "The search backpressure mode. Valid values are monitor_only, enforced, or disabled. Default is monitor_only" }, "node_duress": { "type": "object", "properties": { "cpu_threshold": { "type": "number", "title": "The CPU usage threshold (as a percentage) required for a node to be considered to be under duress", "maximum": 1, "minimum": 0, "description": "The CPU usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.9" }, "heap_threshold": { "type": "number", "title": "The heap usage threshold (as a percentage) required for a node to be considered to be under duress", "maximum": 1, "minimum": 0, "description": "The heap usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.7" }, "num_successive_breaches": { "type": "integer", "title": "The number of successive limit breaches after which the node is considered to be under duress", "minimum": 1, "description": "The number of successive limit breaches after which the node is considered to be under duress. Default is 3" } }, "title": "Node duress settings", "additionalProperties": false }, "search_shard_task": { "type": "object", "properties": { "cancellation_burst": { "type": "number", "title": "The maximum number of search tasks to cancel in a single iteration of the observer thread", "minimum": 1, "description": "The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 10.0" }, "cancellation_rate": { "type": "number", "title": "The maximum number of tasks to cancel per millisecond of elapsed time.", "minimum": 0, "description": "The maximum number of tasks to cancel per millisecond of elapsed time. Default is 0.003" }, "cancellation_ratio": { "type": "number", "title": "The maximum number of tasks to cancel", "maximum": 1, "minimum": 0, "description": "The maximum number of tasks to cancel, as a percentage of successful task completions. Default is 0.1" }, "cpu_time_millis_threshold": { "type": "integer", "title": "The CPU usage threshold (in milliseconds) required for a single search shard task before it is considered for cancellation", "minimum": 0, "description": "The CPU usage threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 15000" }, "elapsed_time_millis_threshold": { "type": "integer", "title": "The elapsed time threshold (in milliseconds) required for a single search shard task before it is considered for cancellation", "minimum": 0, "description": "The elapsed time threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 30000" }, "heap_moving_average_window_size": { "type": "integer", "title": "The number of previously completed search shard tasks to consider when calculating the rolling average of heap usage", "minimum": 0, "description": "The number of previously completed search shard tasks to consider when calculating the rolling average of heap usage. Default is 100" }, "heap_percent_threshold": { "type": "number", "title": "The heap usage threshold (as a percentage) required for a single search shard task before it is considered for cancellation", "maximum": 1, "minimum": 0, "description": "The heap usage threshold (as a percentage) required for a single search shard task before it is considered for cancellation. Default is 0.5" }, "heap_variance": { "type": "number", "title": "The minimum variance required for a single search shard task’s heap usage compared to the rolling average of previously completed tasks before it is considered for cancellation", "minimum": 0, "description": "The minimum variance required for a single search shard task’s heap usage compared to the rolling average of previously completed tasks before it is considered for cancellation. Default is 2.0" }, "total_heap_percent_threshold": { "type": "number", "title": "The heap usage threshold (as a percentage) required for the sum of heap usages of all search shard tasks before cancellation is applied", "maximum": 1, "minimum": 0, "description": "The heap usage threshold (as a percentage) required for the sum of heap usages of all search shard tasks before cancellation is applied. Default is 0.5" } }, "title": "Search shard settings", "additionalProperties": false }, "search_task": { "type": "object", "properties": { "cancellation_burst": { "type": "number", "title": "The maximum number of search tasks to cancel in a single iteration of the observer thread", "minimum": 1, "description": "The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 5.0" }, "cancellation_rate": { "type": "number", "title": "The maximum number of search tasks to cancel per millisecond of elapsed time", "minimum": 0, "description": "The maximum number of search tasks to cancel per millisecond of elapsed time. Default is 0.003" }, "cancellation_ratio": { "type": "number", "title": "The maximum number of search tasks to cancel, as a percentage of successful search task completions", "maximum": 1, "minimum": 0, "description": "The maximum number of search tasks to cancel, as a percentage of successful search task completions. Default is 0.1" }, "cpu_time_millis_threshold": { "type": "integer", "title": "The CPU usage threshold (in milliseconds) required for an individual parent task before it is considered for cancellation", "minimum": 0, "description": "The CPU usage threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 30000" }, "elapsed_time_millis_threshold": { "type": "integer", "title": "The elapsed time threshold (in milliseconds) required for an individual parent task before it is considered for cancellation", "minimum": 0, "description": "The elapsed time threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 45000" }, "heap_moving_average_window_size": { "type": "integer", "title": "The window size used to calculate the rolling average of the heap usage for the completed parent tasks", "minimum": 0, "description": "The window size used to calculate the rolling average of the heap usage for the completed parent tasks. Default is 10" }, "heap_percent_threshold": { "type": "number", "title": "The heap usage threshold (as a percentage) required for an individual parent task before it is considered for cancellation", "maximum": 1, "minimum": 0, "description": "The heap usage threshold (as a percentage) required for an individual parent task before it is considered for cancellation. Default is 0.2" }, "heap_variance": { "type": "number", "title": "The heap usage variance required for an individual parent task before it is considered for cancellation", "minimum": 0, "description": "The heap usage variance required for an individual parent task before it is considered for cancellation. A task is considered for cancellation when taskHeapUsage is greater than or equal to heapUsageMovingAverage * variance. Default is 2.0" }, "total_heap_percent_threshold": { "type": "number", "title": "The heap usage threshold (as a percentage) required for the sum of heap usages of all search tasks before cancellation is applied", "maximum": 1, "minimum": 0, "description": "The heap usage threshold (as a percentage) required for the sum of heap usages of all search tasks before cancellation is applied. Default is 0.5" } }, "title": "Search task settings", "additionalProperties": false } }, "additionalProperties": false }, "search_insights_top_queries": { "type": "object", "properties": { "cpu": { "type": "object", "properties": { "enabled": { "type": "boolean", "title": "Enable or disable top N query monitoring by the metric", "description": "Enable or disable top N query monitoring by the metric", "default": false }, "top_n_size": { "type": "integer", "title": "Specify the value of N for the top N queries by the metric", "minimum": 1 }, "window_size": { "type": "string", "title": "The window size of the top N queries by the metric", "pattern": "^\\d+\\s*(?:[dhms]|ms|micros|nanos)$", "description": "Configure the window size of the top N queries. The value should be a time value with unit, e.g. 1m, 5s, 1h." } }, "title": "Top N queries monitoring by CPU", "additionalProperties": false }, "latency": { "type": "object", "properties": { "enabled": { "type": "boolean", "title": "Enable or disable top N query monitoring by the metric", "description": "Enable or disable top N query monitoring by the metric", "default": false }, "top_n_size": { "type": "integer", "title": "Specify the value of N for the top N queries by the metric", "minimum": 1 }, "window_size": { "type": "string", "title": "The window size of the top N queries by the metric", "pattern": "^\\d+\\s*(?:[dhms]|ms|micros|nanos)$", "description": "Configure the window size of the top N queries. The value should be a time value with unit, e.g. 1m, 5s, 1h." } }, "title": "Top N queries monitoring by latency", "additionalProperties": false }, "memory": { "type": "object", "properties": { "enabled": { "type": "boolean", "title": "Enable or disable top N query monitoring by the metric", "description": "Enable or disable top N query monitoring by the metric", "default": false }, "top_n_size": { "type": "integer", "title": "Specify the value of N for the top N queries by the metric", "minimum": 1 }, "window_size": { "type": "string", "title": "The window size of the top N queries by the metric", "pattern": "^\\d+\\s*(?:[dhms]|ms|micros|nanos)$", "description": "Configure the window size of the top N queries. The value should be a time value with unit, e.g. 1m, 5s, 1h." } }, "title": "Top N queries monitoring by memory", "additionalProperties": false } }, "additionalProperties": false }, "search_max_buckets": { "type": [ "integer", "null" ], "maximum": 1000000, "minimum": 1, "description": "Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined." }, "segrep": { "type": "object", "properties": { "pressure.checkpoint.limit": { "type": "integer", "title": "segrep.pressure.checkpoint.limit", "minimum": 0, "description": "The maximum number of indexing checkpoints that a replica shard can fall behind when copying from primary. Once `segrep.pressure.checkpoint.limit` is breached along with `segrep.pressure.time.limit`, the segment replication backpressure mechanism is initiated. Default is 4 checkpoints." }, "pressure.enabled": { "type": "boolean", "title": "segrep.pressure.enabled", "description": "Enables the segment replication backpressure mechanism. Default is false." }, "pressure.replica.stale.limit": { "type": "number", "title": "segrep.pressure.replica.stale.limit", "maximum": 1, "minimum": 0, "description": "The maximum number of stale replica shards that can exist in a replication group. Once `segrep.pressure.replica.stale.limit` is breached, the segment replication backpressure mechanism is initiated. Default is .5, which is 50% of a replication group." }, "pressure.time.limit": { "type": "string", "title": "segrep.pressure.time.limit", "pattern": "^\\d+\\s*(?:[dhms]|ms|micros|nanos)$", "description": "The maximum amount of time that a replica shard can take to copy from the primary shard. Once segrep.pressure.time.limit is breached along with segrep.pressure.checkpoint.limit, the segment replication backpressure mechanism is initiated. Default is 5 minutes." } }, "additionalProperties": false }, "service_log": { "type": [ "boolean", "null" ], "description": "Store logs for the service so that they are available in the HTTP API and console." }, "shard_indexing_pressure": { "type": "object", "properties": { "enabled": { "type": "boolean", "title": "Enable or disable shard indexing backpressure", "description": "Enable or disable shard indexing backpressure. Default is false" }, "enforced": { "type": "boolean", "title": "Run shard indexing backpressure in shadow mode or enforced mode", "description": "Run shard indexing backpressure in shadow mode or enforced mode.\n In shadow mode (value set as false), shard indexing backpressure tracks all granular-level metrics,\n but it doesn’t actually reject any indexing requests.\n In enforced mode (value set as true),\n shard indexing backpressure rejects any requests to the cluster that might cause a dip in its performance.\n Default is false" }, "operating_factor": { "type": "object", "properties": { "lower": { "type": "number", "title": "Lower occupancy limit of the allocated quota of memory for the shard", "minimum": 0, "description": "Specify the lower occupancy limit of the allocated quota of memory for the shard.\n If the total memory usage of a shard is below this limit,\n shard indexing backpressure decreases the current allocated memory for that shard.\n Default is 0.75" }, "optimal": { "type": "number", "title": "Optimal occupancy of the allocated quota of memory for the shard", "minimum": 0, "description": "Specify the optimal occupancy of the allocated quota of memory for the shard.\n If the total memory usage of a shard is at this level,\n shard indexing backpressure doesn’t change the current allocated memory for that shard.\n Default is 0.85" }, "upper": { "type": "number", "title": "Upper occupancy limit of the allocated quota of memory for the shard", "minimum": 0, "description": "Specify the upper occupancy limit of the allocated quota of memory for the shard.\n If the total memory usage of a shard is above this limit,\n shard indexing backpressure increases the current allocated memory for that shard.\n Default is 0.95" } }, "title": "Operating factor", "additionalProperties": false }, "primary_parameter": { "type": "object", "properties": { "node": { "type": "object", "properties": { "soft_limit": { "type": "number", "title": "Node soft limit", "minimum": 0, "description": "Define the percentage of the node-level memory\n threshold that acts as a soft indicator for strain on a node.\n Default is 0.7" } }, "additionalProperties": false }, "shard": { "type": "object", "properties": { "min_limit": { "type": "number", "title": "Shard min limit", "minimum": 0, "description": "Specify the minimum assigned quota for a new shard in any role (coordinator, primary, or replica).\n Shard indexing backpressure increases or decreases this allocated quota based on the inflow of traffic for the shard.\n Default is 0.001" } }, "additionalProperties": false } }, "title": "Primary parameter", "additionalProperties": false } }, "additionalProperties": false }, "thread_pool_analyze_queue_size": { "type": "integer", "maximum": 2000, "minimum": 10, "description": "Size for the thread pool queue. See documentation for exact details." }, "thread_pool_analyze_size": { "type": "integer", "maximum": 128, "minimum": 1, "description": "Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value." }, "thread_pool_force_merge_size": { "type": "integer", "maximum": 128, "minimum": 1, "description": "Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value." }, "thread_pool_get_queue_size": { "type": "integer", "maximum": 2000, "minimum": 10, "description": "Size for the thread pool queue. See documentation for exact details." }, "thread_pool_get_size": { "type": "integer", "maximum": 128, "minimum": 1, "description": "Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value." }, "thread_pool_search_queue_size": { "type": "integer", "maximum": 2000, "minimum": 10, "description": "Size for the thread pool queue. See documentation for exact details." }, "thread_pool_search_size": { "type": "integer", "maximum": 128, "minimum": 1, "description": "Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value." }, "thread_pool_search_throttled_queue_size": { "type": "integer", "maximum": 2000, "minimum": 10, "description": "Size for the thread pool queue. See documentation for exact details." }, "thread_pool_search_throttled_size": { "type": "integer", "maximum": 128, "minimum": 1, "description": "Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value." }, "thread_pool_write_queue_size": { "type": "integer", "maximum": 2000, "minimum": 10, "description": "Size for the thread pool queue. See documentation for exact details." }, "thread_pool_write_size": { "type": "integer", "maximum": 128, "minimum": 1, "description": "Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value." }, "version": { "type": [ "string", "null" ], "enum": [ "2.19", "3.3", "3.6" ] } }, "additionalProperties": false, "description": "opensearch properties" }, "databaseServicePropertiesValkey": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "automatic_utility_network_ip_filter": { "type": "boolean", "description": "Automatically allow connections from servers in the utility network within the same zone" }, "backup_hour": { "type": [ "integer", "null" ], "maximum": 23, "minimum": 0 }, "backup_minute": { "type": [ "integer", "null" ], "maximum": 59, "minimum": 0 }, "frequent_snapshots": { "type": "boolean", "description": "When enabled, Valkey will create frequent local RDB snapshots. When disabled, Valkey will only take RDB snapshots when a backup is created, based on the backup schedule. This setting is ignored when `valkey_persistence` is set to `off`." }, "ip_filter": { "type": "array", "items": { "type": "string", "title": "CIDR address block", "maxLength": 18, "example": [ "10.0.0.0/24" ] }, "description": "Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'" }, "migration": { "type": [ "object", "null" ], "properties": { "dbname": { "type": "string", "title": "Database name for bootstrapping the initial connection", "maxLength": 63 }, "host": { "type": "string", "title": "Hostname or IP address of the server where to migrate data from", "maxLength": 255 }, "ignore_dbs": { "type": "string", "title": "Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment)", "maxLength": 2048 }, "ignore_roles": { "type": "string", "title": "Comma-separated list of database roles, which should be ignored during migration (supported by PostgreSQL only at the moment)", "maxLength": 2048 }, "method": { "type": "string", "title": "The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types)", "enum": [ "dump", "replication" ] }, "password": { "type": "string", "title": "Password for authentication with the server where to migrate data from", "maxLength": 256 }, "port": { "type": "integer", "title": "Port number of the server where to migrate data from", "maximum": 65535, "minimum": 1 }, "ssl": { "type": "boolean", "title": "The server where to migrate data from is secured with SSL" }, "username": { "type": "string", "title": "User name for authentication with the server where to migrate data from", "maxLength": 256 } }, "required": [ "host", "port" ], "additionalProperties": false }, "public_access": { "type": "boolean", "description": "Allow access to the service from the public Internet" }, "public_access_prometheus": { "type": "boolean", "description": "Allow access to Prometheus metrics from the public Internet" }, "service_log": { "type": [ "boolean", "null" ], "description": "Store logs for the service so that they are available in the HTTP API and console." }, "valkey_acl_channels_default": { "type": "string", "enum": [ "allchannels", "resetchannels" ], "description": "Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Valkey configuration acl-pubsub-default." }, "valkey_active_expire_effort": { "type": "integer", "maximum": 10, "minimum": 1, "description": "Valkey reclaims expired keys both when accessed and in the background. The background process scans for expired keys to free memory. Increasing the active-expire-effort setting (default 1, max 10) uses more CPU to reclaim expired keys faster, reducing memory usage but potentially increasing latency." }, "valkey_activedefrag": { "type": "boolean", "description": "Enable active memory defragmentation. When enabled, Valkey relocates objects off sparsely-used memory pages to reduce fragmentation and return memory to the operating system. Defragmentation runs on the main thread and consumes CPU, so it may increase latency under load." }, "valkey_io_threads": { "type": "integer", "maximum": 256, "minimum": 1, "description": "Set Valkey IO thread count. Changing this will cause a restart of the Valkey service." }, "valkey_lfu_decay_time": { "type": "integer", "maximum": 120, "minimum": 1 }, "valkey_lfu_log_factor": { "type": "integer", "maximum": 100, "minimum": 0 }, "valkey_maxmemory_policy": { "type": [ "string", "null" ], "enum": [ "noeviction", "allkeys-lru", "volatile-lru", "allkeys-random", "volatile-random", "volatile-ttl", "volatile-lfu", "allkeys-lfu" ] }, "valkey_notify_keyspace_events": { "type": "string", "maxLength": 32, "pattern": "^[KEg\\$lshzxentdmA]*$" }, "valkey_number_of_databases": { "type": "integer", "maximum": 128, "minimum": 1, "description": "Set number of Valkey databases. Changing this will cause a restart of the Valkey service." }, "valkey_persistence": { "type": "string", "enum": [ "off", "rdb" ], "description": "When persistence is 'rdb', Valkey does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked." }, "valkey_pubsub_client_output_buffer_limit": { "type": "integer", "maximum": 262144, "minimum": 32, "description": "Set output buffer limit for pub / sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan." }, "valkey_ssl": { "type": "boolean" }, "valkey_timeout": { "type": "integer", "maximum": 2073600, "minimum": 0 }, "valkey_version": { "type": [ "string", "null" ], "enum": [ "8.1", "9.0", "9.1" ] } }, "additionalProperties": false, "description": "valkey properties" }, "databaseServiceModifyOpenAPI": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "title": "my-managed-database", "powered": true, "plan": "1x1xCPU-2GB-25GB", "additional_disk_space_gib": 100, "zone": "de-fra1", "maintenance": { "dow": "sunday", "time": "12:00:00" }, "termination_protection": false, "properties": { "automatic_utility_network_ip_filter": true, "version": "8", "ip_filter": [] }, "networks": [ { "name": "example-network-1", "type": "private", "family": "IPv4", "uuid": "03631160-d57a-4926-ad48-a2f828229dcb" } ] } ], "properties": { "title": { "type": "string", "examples": [ "my-managed-database" ], "description": "Human-readable title for the service." }, "type": { "$ref": "#/components/schemas/databaseServiceType" }, "powered": { "type": "boolean", "examples": [ true ], "description": "Desired power state of the service." }, "zone": { "type": "string", "examples": [ "de-fra1" ], "pattern": "^[a-z]{2}-[a-z]{3}\\d$", "description": "Zone to migrate the service to." }, "plan": { "type": "string", "examples": [ "1x1xCPU-2GB-25GB", "rdb.standard.2x-2CPU-8GB-120GB-regular" ], "description": "Deprecated: prefer the plan_* selection fields (plan_compute, plan_node_count, plan_storage_gib, plan_backups) for PostgreSQL and MySQL. The plan name remains supported, and required for engines without componentised plans. For componentised (rdb.*) plans the storage segment is the desired TOTAL storage per node: any total reachable from a catalog plan's included storage in the plan's storage steps (within its cap) is a valid plan name, e.g. rdb.standard.2x-2CPU-8GB-120GB-regular selects the 80GB catalog plan with a 40GB dynamic top-up.", "deprecated": true }, "plan_compute": { "type": "string", "examples": [ "rdb.standard.2CPU-8GB" ], "description": "Plan selection: compute shape combining family, CPU and memory as one token, as listed in the plan catalog components. PostgreSQL and MySQL only." }, "plan_node_count": { "type": "integer", "examples": [ 1 ], "description": "Plan selection: number of nodes." }, "plan_storage_gib": { "type": "integer", "examples": [ 120 ], "description": "Plan selection: desired TOTAL storage per node in GiB. Resolution picks the plan whose included storage matches, or tops the closest plan up with dynamic additional storage within the allowed limits. Mutually exclusive with additional_disk_space_gib." }, "plan_backups": { "type": "string", "examples": [ "regular" ], "enum": [ "mini", "regular", "extended" ], "description": "Plan selection: backup tier. PostgreSQL and MySQL tiered plans only." }, "additional_disk_space_gib": { "type": "integer", "examples": [ 10 ], "description": "Additional disk space in GiB. Legacy plans only: componentised (rdb.*) plans set storage as a total via plan_storage_gib or the plan name.", "deprecated": true }, "termination_protection": { "type": "boolean", "examples": [ false ], "description": "When enabled, the service cannot be deleted until termination protection is disabled." }, "maintenance": { "type": "object", "examples": [ { "dow": "sunday", "time": "12:00:00" } ], "properties": { "dow": { "$ref": "#/components/schemas/databaseMaintenanceDow" }, "time": { "$ref": "#/components/schemas/databaseMaintenanceTime" } }, "required": [ "dow", "time" ], "description": "Weekly maintenance window." }, "networks": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/databaseNetworkCreate" }, "maxItems": 8, "description": "SDN networks attached to the service." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/databaseLabelCreate" }, "maxItems": 255, "description": "Labels used for service filtering." }, "properties": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/databaseServicePropertiesMysql" }, { "$ref": "#/components/schemas/databaseServicePropertiesPg" }, { "$ref": "#/components/schemas/databaseServicePropertiesRedis" }, { "$ref": "#/components/schemas/databaseServicePropertiesOpensearch" }, { "$ref": "#/components/schemas/databaseServicePropertiesValkey" } ], "description": "Engine-specific configuration properties. The allowed keys depend on the service type; provide the property set matching the service's type." } }, "title": "ServiceModifyOpenAPI", "additionalProperties": false, "description": "Schema for modifying a service — OpenAPI version." }, "databaseServiceTypeModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "target_type": "primary" }, { "target_type": "readonly" }, { "target_type": "analytics" }, { "target_type": "hot" }, { "target_type": "cold" } ], "properties": { "target_type": { "type": "string", "description": "Service type" } }, "title": "ServiceTypeModify", "required": [ "target_type" ], "additionalProperties": false, "description": "Schema for modifying the service type" }, "databaseServiceCloneOpenAPI": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/databaseServiceCloneMysql" }, { "$ref": "#/components/schemas/databaseServiceClonePg" }, { "$ref": "#/components/schemas/databaseServiceCloneRedis" }, { "$ref": "#/components/schemas/databaseServiceCloneOpensearch" }, { "$ref": "#/components/schemas/databaseServiceCloneValkey" } ], "examples": [ { "title": "new-title", "hostname_prefix": "new-hostname-prefix", "clone_time": "2022-01-21T12:21:00Z", "plan": "1x1xCPU-2GB-25GB", "zone": "fi-hel1", "maintenance": { "dow": "sunday", "time": "12:00:00" }, "properties": { "automatic_utility_network_ip_filter": false, "version": "13", "public_access": true, "ip_filter": [ "0.0.0.0/0" ] } } ], "properties": { "plan": { "type": "string", "examples": [ "1x1xCPU-2GB-25GB", "rdb.standard.2x-2CPU-8GB-120GB-regular" ], "description": "Deprecated: prefer the plan_* selection fields (plan_compute, plan_node_count, plan_storage_gib, plan_backups) for PostgreSQL and MySQL. The plan name remains supported, and required for engines without componentised plans. For componentised (rdb.*) plans the storage segment is the desired TOTAL storage per node: any total reachable from a catalog plan's included storage in the plan's storage steps (within its cap) is a valid plan name, e.g. rdb.standard.2x-2CPU-8GB-120GB-regular selects the 80GB catalog plan with a 40GB dynamic top-up.", "deprecated": true }, "plan_compute": { "type": "string", "examples": [ "rdb.standard.2CPU-8GB" ], "description": "Plan selection: compute shape combining family, CPU and memory as one token, as listed in the plan catalog components. PostgreSQL and MySQL only." }, "plan_node_count": { "type": "integer", "examples": [ 1 ], "description": "Plan selection: number of nodes." }, "plan_storage_gib": { "type": "integer", "examples": [ 120 ], "description": "Plan selection: desired TOTAL storage per node in GiB. Resolution picks the plan whose included storage matches, or tops the closest plan up with dynamic additional storage within the allowed limits. Mutually exclusive with additional_disk_space_gib." }, "plan_backups": { "type": "string", "examples": [ "regular" ], "enum": [ "mini", "regular", "extended" ], "description": "Plan selection: backup tier. PostgreSQL and MySQL tiered plans only." }, "additional_disk_space_gib": { "type": "integer", "examples": [ 10 ], "description": "Additional disk space in GiB. Legacy plans only: componentised (rdb.*) plans set storage as a total via plan_storage_gib or the plan name.", "deprecated": true } }, "title": "ServiceCloneOpenAPI", "additionalProperties": false, "description": "Schema for cloning a service — OpenAPI version." }, "databaseServiceCloneMysql": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "hostname_prefix": "dev", "plan": "starter-kit-plan", "clone_time": "2024-01-30T15:04:05Z", "backup_name": "daily-backup-2024-01-30", "zone": "fi-hel1", "termination_protection": false, "maintenance": { "dow": "monday", "time": "03:00:00" }, "additional_disk_space_gib": 10 } ], "properties": { "hostname_prefix": { "type": "string", "maxLength": 30, "minLength": 3, "description": "Hostname prefix" }, "plan": { "type": "string", "minLength": 1, "description": "Deprecated: prefer the plan_* selection fields (plan_compute, plan_node_count, plan_storage_gib, plan_backups). The plan name form remains supported. For componentised (rdb.*) plans the storage segment is the desired TOTAL storage per node: any total reachable from a catalog plan's included storage in the plan's storage steps (within its cap) is a valid plan name, e.g. rdb.standard.2x-2CPU-8GB-120GB-regular selects the 80GB catalog plan with a 40GB dynamic top-up.", "deprecated": true }, "plan_compute": { "type": "string", "examples": [ "rdb.standard.2CPU-8GB" ], "minLength": 1, "description": "Plan selection: compute shape combining family, CPU and memory as one token, as listed in the plan catalog components. PostgreSQL and MySQL only." }, "plan_node_count": { "type": "integer", "examples": [ 1 ], "maximum": 16, "minimum": 1, "format": "int32", "description": "Plan selection: number of nodes." }, "plan_storage_gib": { "type": "integer", "examples": [ 50 ], "minimum": 1, "format": "int32", "description": "Plan selection: desired TOTAL storage per node in GiB. Resolution picks the plan whose included storage matches, or tops the closest plan up with dynamic additional storage within the allowed limits. Mutually exclusive with additional_disk_space_gib." }, "plan_backups": { "type": "string", "examples": [ "regular" ], "enum": [ "mini", "regular", "extended" ], "description": "Plan selection: backup tier. PostgreSQL and MySQL tiered plans only." }, "title": { "$ref": "#/components/schemas/databaseTitle" }, "clone_time": { "type": "string", "examples": [ "2024-01-30T15:04:05Z" ], "maxLength": 32, "format": "date-time", "description": "Clone time" }, "backup_name": { "type": "string", "examples": [ "daily-backup-2024-01-30" ], "maxLength": 128, "pattern": "^[a-zA-Z0-9-_:.]+$", "description": "Backup name" }, "set_service_uuid": { "type": "string", "examples": [ "123e4567-e89b-12d3-a456-426614174000" ], "format": "uuid", "description": "Title" }, "zone": { "type": "string", "examples": [ "fi-hel1" ], "pattern": "^[a-z]{2}-[a-z]{3}\\d$", "description": "Zone" }, "termination_protection": { "type": "boolean", "examples": [ true, false ], "description": "Termination protection", "default": false }, "maintenance": { "type": "object", "properties": { "dow": { "$ref": "#/components/schemas/databaseMaintenanceDow" }, "time": { "$ref": "#/components/schemas/databaseMaintenanceTime" } }, "required": [ "dow", "time" ], "description": "Maintenance" }, "networks": { "type": "array", "items": { "$ref": "#/components/schemas/databaseNetworkCreate" }, "maxItems": 8, "description": "Networks" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/databaseLabelCreate" }, "maxItems": 255, "description": "Labels" }, "additional_disk_space_gib": { "type": "integer", "examples": [ 10, 20 ], "format": "int32", "description": "Additional disk space in GiB. Legacy plans only: componentised (rdb.*) plans set storage as a total via plan_storage_gib or the plan name.", "deprecated": true }, "properties": { "$ref": "#/components/schemas/databaseServicePropertiesMysql" } }, "title": "ServiceCloneMysql", "required": [ "hostname_prefix" ], "additionalProperties": false, "description": "Schema for cloning a MySQL service" }, "databaseServiceClonePg": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "hostname_prefix": "my-pg-service", "plan": "basic-pg-plan", "clone_time": "2024-01-30T15:04:05Z", "backup_name": "daily-backup-2024-01-30", "zone": "fi-hel1", "termination_protection": false, "maintenance": { "dow": "monday", "time": "03:00:00" }, "additional_disk_space_gib": 10 }, { "hostname_prefix": "prod-pg-clone", "plan": "enterprise-pg-plan", "backup_name": "weekly-backup-2024-02-05", "zone": "us-nyc1", "termination_protection": true, "maintenance": { "dow": "wednesday", "time": "22:30:00" }, "additional_disk_space_gib": 20, "set_service_uuid": "123e4567-e89b-12d3-a456-426614174000" } ], "properties": { "hostname_prefix": { "type": "string", "examples": [ "my-pg-service" ], "maxLength": 30, "minLength": 3, "description": "Hostname prefix" }, "plan": { "type": "string", "examples": [ "basic-pg-plan" ], "minLength": 1, "description": "Deprecated: prefer the plan_* selection fields (plan_compute, plan_node_count, plan_storage_gib, plan_backups). The plan name form remains supported. For componentised (rdb.*) plans the storage segment is the desired TOTAL storage per node: any total reachable from a catalog plan's included storage in the plan's storage steps (within its cap) is a valid plan name, e.g. rdb.standard.2x-2CPU-8GB-120GB-regular selects the 80GB catalog plan with a 40GB dynamic top-up.", "deprecated": true }, "plan_compute": { "type": "string", "examples": [ "rdb.standard.2CPU-8GB" ], "minLength": 1, "description": "Plan selection: compute shape combining family, CPU and memory as one token, as listed in the plan catalog components. PostgreSQL and MySQL only." }, "plan_node_count": { "type": "integer", "examples": [ 1 ], "maximum": 16, "minimum": 1, "format": "int32", "description": "Plan selection: number of nodes." }, "plan_storage_gib": { "type": "integer", "examples": [ 50 ], "minimum": 1, "format": "int32", "description": "Plan selection: desired TOTAL storage per node in GiB. Resolution picks the plan whose included storage matches, or tops the closest plan up with dynamic additional storage within the allowed limits. Mutually exclusive with additional_disk_space_gib." }, "plan_backups": { "type": "string", "examples": [ "regular" ], "enum": [ "mini", "regular", "extended" ], "description": "Plan selection: backup tier. PostgreSQL and MySQL tiered plans only." }, "title": { "$ref": "#/components/schemas/databaseTitle" }, "clone_time": { "type": "string", "examples": [ "2024-01-30T15:04:05Z" ], "maxLength": 32, "format": "date-time", "description": "Clone time", "example": "2024-01-30T15:04:05Z" }, "backup_name": { "type": "string", "examples": [ "daily-backup-2024-01-30" ], "maxLength": 128, "pattern": "^[a-zA-Z0-9-_:.]+$", "description": "Backup name" }, "set_service_uuid": { "type": "string", "examples": [ "123e4567-e89b-12d3-a456-426614174000" ], "format": "uuid", "description": "Title" }, "zone": { "type": "string", "examples": [ "fi-hel1" ], "pattern": "^[a-z]{2}-[a-z]{3}\\d$", "description": "Zone" }, "termination_protection": { "type": "boolean", "examples": [ true, false ], "description": "Termination protection" }, "maintenance": { "type": "object", "properties": { "dow": { "$ref": "#/components/schemas/databaseMaintenanceDow" }, "time": { "$ref": "#/components/schemas/databaseMaintenanceTime" } }, "required": [ "dow", "time" ], "description": "Maintenance" }, "networks": { "type": "array", "items": { "$ref": "#/components/schemas/databaseNetworkCreate" }, "maxItems": 8 }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/databaseLabelCreate" }, "maxItems": 255, "description": "Labels" }, "additional_disk_space_gib": { "type": "integer", "format": "int32", "description": "Additional disk space in GiB. Legacy plans only: componentised (rdb.*) plans set storage as a total via plan_storage_gib or the plan name.", "deprecated": true }, "properties": { "$ref": "#/components/schemas/databaseServicePropertiesPg" } }, "title": "ServiceClonePg", "required": [ "hostname_prefix" ], "additionalProperties": false, "description": "Schema for cloning a PostgreSQL service." }, "databaseServiceCloneRedis": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "allOf": [ { "not": { "anyOf": [ { "required": [ "plan_compute" ] }, { "required": [ "plan_node_count" ] }, { "required": [ "plan_storage_gib" ] }, { "required": [ "plan_backups" ] } ], "required": [ "plan" ], "description": "plan and the plan_* selection fields are mutually exclusive" } }, { "not": { "required": [ "plan_storage_gib", "additional_disk_space_gib" ] }, "description": "plan_storage_gib is total storage and excludes additional_disk_space_gib" } ], "examples": [ { "hostname_prefix": "my-redis", "plan": "basic-redis-plan", "clone_time": "2024-01-30T15:04:05Z", "backup_name": "daily-backup-2024-01-30", "zone": "fi-hel1", "termination_protection": false, "maintenance": { "dow": "monday", "time": "03:00:00" } }, { "hostname_prefix": "redis-prod", "plan": "enterprise-redis-plan", "backup_name": "weekly-backup-2024-02-05", "zone": "us-nyc1", "termination_protection": true, "maintenance": { "dow": "wednesday", "time": "22:30:00" }, "set_service_uuid": "123e4567-e89b-12d3-a456-426614174000" } ], "properties": { "hostname_prefix": { "type": "string", "examples": [ "my-redis" ], "maxLength": 30, "minLength": 3, "description": "Hostname prefix" }, "plan": { "type": "string", "examples": [ "basic-redis-plan" ], "minLength": 1, "description": "Plan" }, "plan_compute": { "type": "string", "examples": [ "rdb.standard.2CPU-8GB" ], "minLength": 1, "description": "Plan selection: compute shape combining family, CPU and memory as one token, as listed in the plan catalog components. PostgreSQL and MySQL only." }, "plan_node_count": { "type": "integer", "examples": [ 1 ], "maximum": 16, "minimum": 1, "format": "int32", "description": "Plan selection: number of nodes." }, "plan_storage_gib": { "type": "integer", "examples": [ 50 ], "minimum": 1, "format": "int32", "description": "Plan selection: desired TOTAL storage per node in GiB. Resolution picks the plan whose included storage matches, or tops the closest plan up with dynamic additional storage within the allowed limits. Mutually exclusive with additional_disk_space_gib." }, "plan_backups": { "type": "string", "examples": [ "regular" ], "enum": [ "mini", "regular", "extended" ], "description": "Plan selection: backup tier. PostgreSQL and MySQL tiered plans only." }, "title": { "$ref": "#/components/schemas/databaseTitle" }, "clone_time": { "type": "string", "examples": [ "2024-01-30T15:04:05Z" ], "maxLength": 32, "format": "date-time", "description": "Clone time", "example": "2024-01-30T15:04:05Z" }, "backup_name": { "type": "string", "examples": [ "daily-backup-2024-01-30" ], "maxLength": 128, "pattern": "^[a-zA-Z0-9-_:.]+$", "format": "string", "description": "Backup name" }, "set_service_uuid": { "type": "string", "examples": [ "123e4567-e89b-12d3-a456-426614174000" ], "format": "uuid", "description": "Title" }, "zone": { "type": "string", "examples": [ "fi-hel1" ], "pattern": "^[a-z]{2}-[a-z]{3}\\d$", "description": "Zone" }, "termination_protection": { "type": "boolean", "examples": [ true, false ], "description": "Termination protection" }, "maintenance": { "type": "object", "properties": { "dow": { "$ref": "#/components/schemas/databaseMaintenanceDow" }, "time": { "$ref": "#/components/schemas/databaseMaintenanceTime" } }, "required": [ "dow", "time" ], "description": "Maintenance" }, "networks": { "type": "array", "items": { "$ref": "#/components/schemas/databaseNetworkCreate" }, "maxItems": 8 }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/databaseLabelCreate" }, "maxItems": 255, "description": "Labels" }, "properties": { "$ref": "#/components/schemas/databaseServicePropertiesRedis" } }, "title": "ServiceCloneRedis", "required": [ "hostname_prefix" ], "additionalProperties": false, "description": "Schema for cloning a Redis service." }, "databaseServiceCloneOpensearch": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "allOf": [ { "not": { "anyOf": [ { "required": [ "plan_compute" ] }, { "required": [ "plan_node_count" ] }, { "required": [ "plan_storage_gib" ] }, { "required": [ "plan_backups" ] } ], "required": [ "plan" ], "description": "plan and the plan_* selection fields are mutually exclusive" } }, { "not": { "required": [ "plan_storage_gib", "additional_disk_space_gib" ] }, "description": "plan_storage_gib is total storage and excludes additional_disk_space_gib" } ], "examples": [ { "hostname_prefix": "my-opensearch", "plan": "my-plan", "clone_time": "2024-01-30T15:04:05Z", "backup_name": "daily-backup-2024-01-30", "zone": "fi-hel1", "termination_protection": false, "maintenance": { "dow": "monday", "time": "03:00:00" }, "additional_disk_space_gib": 10 }, { "hostname_prefix": "search-prod", "plan": "enterprise-plan", "backup_name": "weekly-backup-2024-02-05", "zone": "us-nyc1", "termination_protection": true, "maintenance": { "dow": "wednesday", "time": "22:30:00" }, "additional_disk_space_gib": 20 } ], "properties": { "hostname_prefix": { "type": "string", "examples": [ "my-opensearch" ], "maxLength": 30, "minLength": 3, "description": "Hostname prefix" }, "plan": { "type": "string", "examples": [ "my-plan" ], "minLength": 1, "description": "Plan" }, "plan_compute": { "type": "string", "examples": [ "rdb.standard.2CPU-8GB" ], "minLength": 1, "description": "Plan selection: compute shape combining family, CPU and memory as one token, as listed in the plan catalog components. PostgreSQL and MySQL only." }, "plan_node_count": { "type": "integer", "examples": [ 1 ], "maximum": 16, "minimum": 1, "format": "int32", "description": "Plan selection: number of nodes." }, "plan_storage_gib": { "type": "integer", "examples": [ 50 ], "minimum": 1, "format": "int32", "description": "Plan selection: desired TOTAL storage per node in GiB. Resolution picks the plan whose included storage matches, or tops the closest plan up with dynamic additional storage within the allowed limits. Mutually exclusive with additional_disk_space_gib." }, "plan_backups": { "type": "string", "examples": [ "regular" ], "enum": [ "mini", "regular", "extended" ], "description": "Plan selection: backup tier. PostgreSQL and MySQL tiered plans only." }, "title": { "$ref": "#/components/schemas/databaseTitle" }, "clone_time": { "type": "string", "examples": [ "2024-01-30T15:04:05Z" ], "maxLength": 32, "format": "date-time", "description": "Clone time", "example": "2024-01-30T15:04:05Z" }, "backup_name": { "type": "string", "examples": [ "daily-backup-2024-01-30" ], "maxLength": 128, "pattern": "^[a-zA-Z0-9-_:.]+$", "format": "string", "description": "Backup name" }, "set_service_uuid": { "type": "string", "examples": [ "123e4567-e89b-12d3-a456-426614174000" ], "format": "uuid", "description": "Title" }, "zone": { "type": "string", "examples": [ "fi-hel1" ], "pattern": "^[a-z]{2}-[a-z]{3}\\d$", "description": "Zone" }, "termination_protection": { "type": "boolean", "examples": [ true, false ], "description": "Termination protection" }, "maintenance": { "type": "object", "properties": { "dow": { "$ref": "#/components/schemas/databaseMaintenanceDow" }, "time": { "$ref": "#/components/schemas/databaseMaintenanceTime" } }, "required": [ "dow", "time" ], "description": "Maintenance" }, "networks": { "type": "array", "items": { "$ref": "#/components/schemas/databaseNetworkCreate" }, "maxItems": 8, "description": "Networks" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/databaseLabelCreate" }, "maxItems": 255, "description": "Labels" }, "additional_disk_space_gib": { "type": "integer", "examples": [ 10, 20 ], "format": "int32", "description": "Additional disk space in GiB" }, "properties": { "$ref": "#/components/schemas/databaseServicePropertiesOpensearch" } }, "title": "ServiceCloneOpensearch", "required": [ "hostname_prefix" ], "additionalProperties": false, "description": "Schema for cloning an OpenSearch service" }, "databaseServiceCloneValkey": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "allOf": [ { "not": { "anyOf": [ { "required": [ "plan_compute" ] }, { "required": [ "plan_node_count" ] }, { "required": [ "plan_storage_gib" ] }, { "required": [ "plan_backups" ] } ], "required": [ "plan" ], "description": "plan and the plan_* selection fields are mutually exclusive" } }, { "not": { "required": [ "plan_storage_gib", "additional_disk_space_gib" ] }, "description": "plan_storage_gib is total storage and excludes additional_disk_space_gib" } ], "properties": { "hostname_prefix": { "type": "string", "examples": [ "my-service" ], "maxLength": 30, "minLength": 3, "description": "Hostname prefix" }, "plan": { "type": "string", "examples": [ "basic-plan" ], "minLength": 1, "description": "Plan" }, "plan_compute": { "type": "string", "examples": [ "rdb.standard.2CPU-8GB" ], "minLength": 1, "description": "Plan selection: compute shape combining family, CPU and memory as one token, as listed in the plan catalog components. PostgreSQL and MySQL only." }, "plan_node_count": { "type": "integer", "examples": [ 1 ], "maximum": 16, "minimum": 1, "format": "int32", "description": "Plan selection: number of nodes." }, "plan_storage_gib": { "type": "integer", "examples": [ 50 ], "minimum": 1, "format": "int32", "description": "Plan selection: desired TOTAL storage per node in GiB. Resolution picks the plan whose included storage matches, or tops the closest plan up with dynamic additional storage within the allowed limits. Mutually exclusive with additional_disk_space_gib." }, "plan_backups": { "type": "string", "examples": [ "regular" ], "enum": [ "mini", "regular", "extended" ], "description": "Plan selection: backup tier. PostgreSQL and MySQL tiered plans only." }, "title": { "$ref": "#/components/schemas/databaseTitle" }, "clone_time": { "type": "string", "examples": [ "2024-01-30T15:04:05Z" ], "maxLength": 32, "format": "date-time", "description": "Clone time", "example": "2024-01-30T15:04:05Z" }, "backup_name": { "type": "string", "examples": [ "daily-backup-2024-01-30" ], "maxLength": 128, "pattern": "^[a-zA-Z0-9-_:.]+$", "format": "string", "description": "Backup name" }, "set_service_uuid": { "type": "string", "examples": [ "123e4567-e89b-12d3-a456-426614174000" ], "format": "uuid", "description": "Title" }, "zone": { "type": "string", "examples": [ "fi-hel1" ], "pattern": "^[a-z]{2}-[a-z]{3}\\d$", "description": "Zone" }, "termination_protection": { "type": "boolean", "examples": [ true, false ], "description": "Termination protection" }, "maintenance": { "type": "object", "properties": { "dow": { "$ref": "#/components/schemas/databaseMaintenanceDow" }, "time": { "$ref": "#/components/schemas/databaseMaintenanceTime" } }, "required": [ "dow", "time" ], "description": "Maintenance" }, "networks": { "type": "array", "items": { "$ref": "#/components/schemas/databaseNetworkCreate" }, "maxItems": 8 }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/databaseLabelCreate" }, "maxItems": 255, "description": "Labels" }, "properties": { "$ref": "#/components/schemas/databaseServicePropertiesValkey" } }, "title": "ServiceCloneValkey", "required": [ "hostname_prefix" ], "additionalProperties": false, "description": "Schema for cloning a service with valkey." }, "databaseServiceUpgrade": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "target_version": "12" }, { "target_version": "13" }, { "target_version": "14" }, { "target_version": "15" }, { "target_version": "16" } ], "properties": { "target_version": { "type": "string", "description": "Version to upgrade the service", "example": "12" } }, "title": "ServiceUpgrade", "required": [ "target_version" ], "additionalProperties": false, "description": "Schema for upgrading the service version" }, "databaseLabelModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "key": "environment", "value": "production" } ], "properties": { "key": { "$ref": "#/components/schemas/databaseLabelKey" }, "value": { "$ref": "#/components/schemas/databaseLabelValue" } }, "title": "LabelModify", "minProperties": 1, "additionalProperties": false, "description": "Schema for modifying a label with a key and/or value." }, "databaseServiceAclModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "access_control": true }, { "extended_access_control": true }, { "access_control": false, "extended_access_control": true }, { "access_control": true, "extended_access_control": false } ], "properties": { "access_control": { "type": "boolean", "examples": [ true, false ], "description": "Enables OpenSearch access control" }, "extended_access_control": { "type": "boolean", "examples": [ true, false ], "description": "Enables OpenSearch extended access control" } }, "title": "ServiceAclModify", "minProperties": 1, "additionalProperties": false, "description": "Schema for modifying service access control settings." }, "databaseServiceSecurityModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "admin_password": "Curr3nt@Passw0rd!", "new_password": "N3w@Str0ngPassw0rd!" }, { "admin_password": "Adm1nPrev#2025", "new_password": "Rotated#Adm1n2025!" }, { "admin_password": "Old$SecureP@ss99", "new_password": "Fresh$SecureKey88" } ], "properties": { "admin_password": { "type": "string", "examples": [ "current_password_123" ], "description": "Current admin password" }, "new_password": { "type": "string", "examples": [ "new_secure_password_456" ], "description": "New admin password" } }, "title": "ServiceSecurityModify", "required": [ "admin_password", "new_password" ], "additionalProperties": false, "description": "Schema for modifying service security settings" }, "databaseServiceSecurityEnable": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "admin_password": "Str0ngP@ssw0rd!" }, { "admin_password": "Adm1n#2025$Secure" }, { "admin_password": "S3rv!ce_Access-Key" }, { "admin_password": "Sup3r$Admin!Token" }, { "admin_password": "P@55w0rd_R0t@tion#1" } ], "properties": { "admin_password": { "type": "string", "examples": [ "Str0ngP@ssw0rd!" ], "description": "Security admin password" } }, "title": "ServiceSecurityEnable", "required": [ "admin_password" ], "additionalProperties": false, "description": "Schema for enabling security on a service instance" }, "databaseIntegrationEndpointCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "type": { "$ref": "#/components/schemas/databaseIntegrationEndpoint" }, "name": { "type": "string", "examples": [ "webhook-endpoint" ], "description": "The name of the integration endpoint." }, "properties": { "type": "object", "examples": [ { "format": "rfc5424", "max_message_size": 8192, "port": 514, "server": "1.1.1.1", "tls": false } ], "description": "A key-value map of properties specific to the integration endpoint type." } }, "title": "IntegrationEndpointCreate", "required": [ "name", "type" ], "additionalProperties": false, "description": "Schema for creating an integration endpoint." }, "databaseIntegrationEndpoint": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "rsyslog" ], "title": "IntegrationEndpoint", "enum": [ "logs", "prometheus", "rsyslog" ], "description": "The type of integration endpoint." }, "databaseIntegrationEndpointModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": true, "example": { "server": "3.3.3.3", "port": 514, "tls": true } } }, "title": "IntegrationEndpointModify", "additionalProperties": false, "description": "Schema for modifying an integration endpoint." }, "databaseConnectionPoolCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "database": "defaultdb", "pool_mode": "statement", "pool_name": "readonly-pool", "pool_size": 10, "username": "readonly" } ], "properties": { "database": { "type": "string", "examples": [ "defaultdb" ], "description": "Database" }, "pool_mode": { "type": "string", "examples": [ "session", "transaction", "statement" ], "enum": [ "session", "transaction", "statement" ], "description": "Connection Pool mode" }, "pool_name": { "type": "string", "examples": [ "pool-1" ], "description": "Connection Pool name" }, "pool_size": { "type": "integer", "examples": [ 20 ], "format": "int32", "description": "Connection Pool size" }, "username": { "type": "string", "examples": [ "app-user" ], "description": "Connection Pool username" } }, "title": "ConnectionPoolCreate", "required": [ "database", "pool_mode", "pool_name", "pool_size" ], "additionalProperties": false, "description": "Schema for creating a connection pool." }, "databaseConnectionPoolModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "database": "defaultdb", "pool_mode": "session", "pool_size": 20, "username": "app-user" } ], "properties": { "database": { "type": "string", "examples": [ "defaultdb" ], "description": "Database" }, "pool_mode": { "type": "string", "examples": [ "session", "transaction", "statement" ], "enum": [ "session", "transaction", "statement" ], "description": "Connection Pool mode" }, "pool_size": { "type": "integer", "examples": [ 20 ], "format": "int32", "description": "Connection Pool size" }, "username": { "type": [ "string", "null" ], "examples": [ "app-user", null ], "description": "Connection Pool username" } }, "title": "ConnectionPoolModify", "minProperties": 1, "additionalProperties": false, "description": "Schema for modifying a connection pool." }, "databaseServiceIntegrationModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "properties": { "key1": "value1" } } ], "properties": { "properties": { "type": "object", "examples": [ { "key1": "value1" } ] } }, "title": "ServiceIntegrationModify", "additionalProperties": false, "description": "Schema for modifying a service integration." }, "databaseServiceTaskCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "operation": "dataset_import", "dataset_import": { "dataset_name": "customer-events" } }, { "operation": "migration_check", "migration_check": { "source_service_uri": "postgresql://user:password@hostname:5432/dbname" } }, { "operation": "migration_check", "migration_check": { "source_service_uri": "postgresql://replica:secret@10.0.0.12:5432/source", "ignore_dbs": "postgres,template1", "method": "Replication" } }, { "operation": "upgrade", "target_version": "15" }, { "operation": "upgrade_check", "upgrade_check": { "target_version": "18" } } ], "properties": { "dataset_import": { "type": "object", "properties": { "dataset_name": { "type": "string", "examples": [ "example-dataset" ], "description": "The name of the dataset to be imported." } }, "required": [ "dataset_name" ], "additionalProperties": false }, "migration_check": { "type": "object", "properties": { "ignore_dbs": { "type": "string", "examples": [ "defaultdb" ], "description": "Databases to ignore during the migration check, separated by commas." }, "ignore_roles": { "type": "string" }, "method": { "type": "string", "examples": [ "Replication" ], "description": "The migration method to be used." }, "source_service_uri": { "type": "string", "examples": [ "postgresql://user:password@hostname:port/dbname" ], "description": "The URI of the source service for migration." } }, "required": [ "source_service_uri" ], "additionalProperties": false }, "upgrade_check": { "type": "object", "properties": { "target_version": { "type": "string", "examples": [ "18" ], "minLength": 1, "description": "The target major version for the upgrade check." } }, "required": [ "target_version" ], "additionalProperties": false }, "target_version": { "type": "string", "examples": [ "14" ], "minLength": 1, "description": "The target version for upgrade operations." }, "operation": { "type": "string", "examples": [ "upgrade" ], "description": "The operation to be performed." } }, "title": "ServiceTaskCreate", "required": [ "operation" ], "additionalProperties": false, "description": "Schema for creating a service task with various operations such as dataset import and migration checks." }, "databaseServiceUserCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "username": "api-doc-user", "authentication": "caching_sha2_password", "password": "new-password" } ], "properties": { "username": { "type": "string", "examples": [ "defaultdb" ], "description": "The username of the service user" }, "password": { "type": "string", "examples": [ "strongpassword123" ], "description": "The password of the service user" }, "authentication": { "type": "string", "examples": [ "caching_sha2_password" ], "description": "The authentication method for the service user" }, "redis_access_control": { "type": "object", "properties": { "categories": { "type": "array", "items": { "type": "string" }, "description": "List of categories for Redis ACL" }, "channels": { "type": "array", "items": { "type": "string" }, "description": "List of channels for Redis ACL" }, "commands": { "type": "array", "items": { "type": "string" }, "description": "List of commands for Redis ACL" }, "keys": { "type": "array", "items": { "type": "string" }, "description": "List of keys for Redis ACL" } }, "minProperties": 1, "additionalProperties": false, "description": "Redis access control settings" }, "pg_access_control": { "type": "object", "properties": { "allow_replication": { "type": "boolean", "examples": [ true, false ], "description": "Flag to allow or disallow replication" } }, "required": [ "allow_replication" ], "additionalProperties": false, "description": "PostgreSQL access control settings" }, "opensearch_access_control": { "type": "object", "properties": { "rules": { "type": "array", "items": { "properties": { "index": { "type": "string", "examples": [ "logs-*" ], "description": "The index pattern for the rule" }, "permission": { "type": "string", "examples": [ "read", "write", "admin" ], "description": "The permission level for the index" } }, "required": [ "index", "permission" ], "additionalProperties": false }, "description": "List of index permission rules" } }, "required": [ "rules" ], "additionalProperties": false, "description": "OpenSearch access control settings" }, "valkey_access_control": { "type": "object", "properties": { "categories": { "type": "array", "items": { "type": "string" }, "description": "List of categories for Valkey ACL" }, "channels": { "type": "array", "items": { "type": "string" }, "description": "List of channels for Valkey ACL" }, "commands": { "type": "array", "items": { "type": "string" }, "description": "List of commands for Valkey ACL" }, "keys": { "type": "array", "items": { "type": "string" }, "description": "List of keys for Valkey ACL" } }, "minProperties": 1, "additionalProperties": false, "description": "Valkey access control settings" } }, "title": "ServiceUserCreate", "required": [ "username" ], "additionalProperties": false, "description": "Schema for creating a service user with access control settings" }, "databaseServiceUserModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "password": "new_secure_password_123!", "authentication": "caching_sha2_password" } ], "properties": { "password": { "type": "string", "examples": [ "new_secure_password_123!" ], "description": "New password for the service user" }, "authentication": { "type": "string", "examples": [ "caching_sha2_password", "mysql_native_password" ], "description": "Authentication method for the service user" } }, "title": "ServiceUserModify", "minProperties": 1, "additionalProperties": false, "description": "Schema for modifying a service user" }, "databaseServiceUserAclModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "redis_access_control": { "categories": [ "@admin", "@read" ], "channels": [ "news", "alerts" ], "commands": [ "GET", "SET" ], "keys": [ "user:*", "session:*" ] }, "pg_access_control": { "allow_replication": true }, "opensearch_access_control": { "rules": [ { "index": "logs-*", "permission": "read" } ] }, "valkey_access_control": { "categories": [ "@write" ], "channels": [ "updates" ], "commands": [ "DEL" ], "keys": [ "cache:*" ] } } ], "properties": { "redis_access_control": { "type": "object", "properties": { "categories": { "type": "array", "items": { "type": "string" }, "description": "List of categories for ACL" }, "channels": { "type": "array", "items": { "type": "string" }, "description": "List of channels for ACL" }, "commands": { "type": "array", "items": { "type": "string" }, "description": "List of commands for ACL" }, "keys": { "type": "array", "items": { "type": "string" }, "description": "List of keys for ACL" } }, "minProperties": 1, "additionalProperties": false, "description": "Redis ACL modification schema" }, "pg_access_control": { "type": "object", "properties": { "allow_replication": { "type": "boolean", "examples": [ true, false ], "description": "Flag to allow or disallow replication" } }, "required": [ "allow_replication" ], "additionalProperties": false, "description": "PostgreSQL replication permission modification schema" }, "opensearch_access_control": { "type": "object", "properties": { "rules": { "type": "array", "items": { "properties": { "index": { "type": "string" }, "permission": { "type": "string" } }, "required": [ "index", "permission" ], "additionalProperties": false }, "description": "List of index permission rules" } }, "required": [ "rules" ], "additionalProperties": false, "description": "OpenSearch index permission modification schema" }, "valkey_access_control": { "type": "object", "properties": { "categories": { "type": "array", "items": { "type": "string" }, "description": "List of categories for ACL" }, "channels": { "type": "array", "items": { "type": "string" }, "description": "List of channels for ACL" }, "commands": { "type": "array", "items": { "type": "string" }, "description": "List of commands for ACL" }, "keys": { "type": "array", "items": { "type": "string" }, "description": "List of keys for ACL" } }, "minProperties": 1, "additionalProperties": false, "description": "Valkey ACL modification schema" } }, "title": "ServiceUserAclModify", "minProperties": 1, "additionalProperties": false, "description": "Schema for modifying user access control lists (ACL) for various services" }, "databaseAvailableServiceTypesResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "postgres": { "name": "postgresql", "description": "PostgreSQL - Object-Relational Database Management System", "latest_available_version": "18.1", "service_plans": [ { "node_count": 3, "plan": "2x2xCPU-4GB-50G", "core_number": 2, "storage_size": 51200, "memory_amount": 8192, "max_memory_percent": 90, "backup_retention": 7, "zones": { "zone": [ { "name": "zone1", "description": "Primary zone" }, { "name": "zone2", "description": "Secondary zone" } ] }, "backup_config": { "interval": 24, "max_count": 7, "recovery_mode": "point_in_time" } } ], "properties": { "automatic_utility_network_ip_filter": false, "ip_filter": [ "0.0.0.0/0" ], "public_access": true, "version": "13" }, "dependencies": {} } } ], "title": "AvailableServiceTypesResponse", "additionalProperties": { "$ref": "#/components/schemas/databaseServiceTypeResponse" }, "description": "Response map schema for available service types" }, "databaseServiceTypeResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "examples": [ { "name": "postgresql", "description": "PostgreSQL - Object-Relational Database Management System", "latest_available_version": "18.1", "service_plans": [ { "backup_config": { "interval": 24, "max_count": 3, "recovery_mode": "pitr" }, "backup_config_pg": { "interval": 24, "max_count": 3, "recovery_mode": "pitr" }, "node_count": 1, "zones": { "zone": [ { "name": "au-syd1" }, { "name": "de-fra1" }, { "name": "es-mad1" }, { "name": "fi-hel1" }, { "name": "fi-hel2" }, { "name": "nl-ams1" }, { "name": "pl-waw1" }, { "name": "se-sto1" }, { "name": "sg-sin1" }, { "name": "uk-lon1" }, { "name": "us-chi1" }, { "name": "us-nyc1" }, { "name": "us-sjo1" } ] }, "plan": "1x1xCPU-1GB-10GB", "core_number": 1, "storage_size": 10240, "memory_amount": 1024 } ], "properties": { "automatic_utility_network_ip_filter": false, "ip_filter": [ "0.0.0.0/0" ], "public_access": true, "version": "13" }, "dependencies": {} } ], "properties": { "name": { "type": "string", "description": "The name of the service type", "example": "postgresql" }, "description": { "type": "string", "description": "The description of the service type", "example": "PostgreSQL - Object-Relational Database Management System" }, "latest_available_version": { "type": "string", "description": "The latest available version of the service type", "example": "18.1" }, "service_plans": { "type": "array", "items": { "$ref": "#/components/schemas/databaseServicePlanResponse" } }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/databasePropertySchemaResponse" } }, "dependencies": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/databaseDependencyResponse" } } }, "title": "ServiceTypeResponse", "description": "Response schema for available service types" }, "databaseServicePlanResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "node_count": 3, "plan": "2x2xCPU-4GB-50G", "core_number": 2, "storage_size": 51200, "memory_amount": 8192, "zones": { "zone": [ { "name": "zone1", "description": "Primary zone" }, { "name": "zone2", "description": "Secondary zone" } ] }, "backup_config": { "interval": 24, "max_count": 7, "recovery_mode": "point_in_time" } } ], "properties": { "backup_config": { "$ref": "#/components/schemas/databaseBackupConfigResponse" }, "backup_config_pg": { "$ref": "#/components/schemas/databaseBackupConfigResponse" }, "backup_config_mysql": { "$ref": "#/components/schemas/databaseBackupConfigResponse" }, "backup_config_redis": { "$ref": "#/components/schemas/databaseBackupConfigResponse" }, "backup_config_valkey": { "$ref": "#/components/schemas/databaseBackupConfigResponse" }, "backup_config_opensearch": { "$ref": "#/components/schemas/databaseBackupConfigOpenSearchResponse" }, "node_count": { "type": "integer", "format": "int32", "description": "Number of nodes in the service plan", "example": 10 }, "zones": { "type": "object", "properties": { "zone": { "type": "array", "items": { "$ref": "#/components/schemas/databaseZoneInfoResponse" } } } }, "plan": { "type": "string", "description": "Name of the service plan", "example": "2x2xCPU-4GB-50G" }, "core_number": { "type": "integer", "format": "int32", "description": "Number of CPU cores per node", "example": 2 }, "storage_size": { "type": "integer", "format": "int32", "description": "Storage size in MiB per node", "example": 25600 }, "memory_amount": { "type": "integer", "format": "int32", "description": "Memory amount in MB per node", "example": 4096 }, "components": { "$ref": "#/components/schemas/databasePlanComponentsResponse" } }, "title": "ServicePlanResponse", "description": "Schema definition for a service plan" }, "databaseBackupConfigResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "interval": 24, "max_count": 7, "recovery_mode": "point_in_time" } ], "properties": { "interval": { "type": "integer", "examples": [ 24 ], "format": "int32", "description": "Backup interval" }, "max_count": { "type": "integer", "examples": [ 7 ], "format": "int32", "description": "Maximum number of backups to keep" }, "recovery_mode": { "type": "string", "examples": [ "point_in_time" ], "description": "Recovery mode for backups" } }, "title": "BackupConfigResponse", "description": "General backup configuration schema" }, "databaseBackupConfigOpenSearchResponse": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "examples": [ { "frequent_interval_minutes": 15, "frequent_oldest_age_minutes": 60, "infrequent_interval_minutes": 240, "infrequent_oldest_age_minutes": 1440, "recovery_mode": "point_in_time" } ], "properties": { "frequent_interval_minutes": { "type": "integer", "format": "int32", "description": "Frequent backup interval in minutes", "example": "15" }, "frequent_oldest_age_minutes": { "type": "integer", "format": "int32", "description": "Oldest age for frequent backups in minutes", "example": "60" }, "infrequent_interval_minutes": { "type": "integer", "format": "int32", "description": "Infrequent backup interval in minutes", "example": "240" }, "infrequent_oldest_age_minutes": { "type": "integer", "format": "int32", "description": "Oldest age for infrequent backups in minutes", "example": "1440" }, "recovery_mode": { "type": "string", "description": "Recovery mode for backups", "example": "point_in_time" } }, "title": "BackupConfigOpenSearchResponse", "description": "OpenSearch specific backup configuration response" }, "databaseZoneInfoResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "fi-hel-1" } ], "properties": { "name": { "type": "string", "description": "Zone identifier", "example": "fi-hel-1" } }, "title": "ZoneInfoResponse", "description": "Schema for representing a Zone" }, "databasePlanComponentsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "compute": { "family": "standard", "node_count": 2, "cpu": 4, "memory_gb": 8 }, "storage": { "included_gib": 100, "dynamic_storage_supported": true }, "backups": { "name": "regular", "retention_days": 15 } } ], "properties": { "compute": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "rdb.standard.2CPU-8GB" ], "description": "Compute shape name usable as plan_compute in requests." }, "family": { "type": "string", "enum": [ "development", "standard", "memory" ], "description": "Compute family for tiered plans. Omitted for classic plans.", "example": "standard" }, "node_count": { "type": "integer", "format": "int32", "description": "Number of nodes", "example": 2 }, "cpu": { "type": "integer", "format": "int32", "description": "CPU cores per node", "example": 4 }, "memory_gb": { "type": "integer", "format": "int32", "description": "Memory per node in GB", "example": 8 } }, "description": "Compute resources per service" }, "storage": { "type": "object", "properties": { "included_gib": { "type": "integer", "format": "int32", "description": "Storage included in the plan per node, in GB. Omitted for tiered (rdb.*) plans, which present storage as a single total_gib.", "example": 100 }, "dynamic_storage_supported": { "type": "boolean", "description": "Whether the storage total can be adjusted on top of the plan's included storage.", "example": true }, "additional_gib": { "type": "integer", "format": "int32", "description": "Extra dynamic storage configured on the service, in GB. Only present on legacy (non-tiered) service responses; tiered plans present total_gib instead.", "example": 40 }, "total_gib": { "type": "integer", "format": "int32", "description": "Total storage, in GB. For tiered (rdb.*) plans this is the single storage number: the plan's base storage in the catalog, or the chosen total (included plus dynamic) on a service response. Omitted for legacy catalog plans.", "example": 140 } }, "description": "Storage included in the plan. Omitted for service types without persistent storage." }, "backups": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "mini", "regular", "extended" ], "description": "Backup tier name for tiered plans. Omitted when the plan retention does not map to a named tier.", "example": "standard" }, "retention_days": { "type": "integer", "format": "int32", "description": "Backup retention in days", "example": 15 }, "frequent": { "type": "object", "properties": { "interval_minutes": { "type": "integer", "format": "int32", "example": 60 }, "retention_days": { "type": "integer", "format": "int32", "example": 1 } }, "description": "Frequent backup window, OpenSearch only" }, "infrequent": { "type": "object", "properties": { "interval_minutes": { "type": "integer", "format": "int32", "example": 1440 }, "retention_days": { "type": "integer", "format": "int32", "example": 14 } }, "description": "Infrequent backup window, OpenSearch only" } }, "description": "Backup characteristics of the plan" } }, "title": "PlanComponentsResponse", "description": "Structured breakdown of a service plan into compute, storage and backups components. Sizes are expressed in GB to match plan naming; the classic MB/MiB fields on the plan object are unchanged." }, "databasePropertySchemaResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "$schema": { "type": "string", "description": "JSON Schema URI", "example": "https://json-schema.org/draft/2020-12/schema" }, "$id": { "type": "string", "description": "Schema identifier", "example": "sample-id" }, "createOnly": { "type": "boolean", "description": "Whether the property can only be set during creation", "example": false }, "default": { "type": "object", "description": "Any valid JSON value is allowed here", "example": { "foo": "bar" } }, "example": { "type": "object", "description": "Any valid JSON value is allowed here", "example": { "foo": "bar" } }, "maxLength": { "type": "integer", "format": "int32", "description": "Maximum length for the property schema", "example": 255 }, "minLength": { "type": "integer", "format": "int32", "description": "Minimum length for the property schema", "example": 255 }, "pattern": { "type": "string", "description": "Allowed patterns for the property", "example": "^[a-zA-Z0-9_./:-]+(\\[[^\\]]+\\])?$" }, "title": { "type": "string", "description": "Human-readable title for the property", "example": "Sample Property" }, "type": { "type": "string", "description": "Data type of the property", "example": "any string" }, "user_error": { "type": "string", "description": "User-friendly error message", "example": "Invalid input provided" }, "items": { "$ref": "#/components/schemas/databasePropertySchemaResponse" }, "properties": { "type": "object", "examples": [ { "foobar": [ { "title": "property schema title" } ] } ], "additionalProperties": { "$ref": "#/components/schemas/databasePropertySchemaResponse" }, "description": "Properties for object type" }, "dependencies": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/databaseDependencyResponse" }, "description": "Property dependency collection", "example": { "required": [ "host", "port" ] } }, "required": { "type": "array", "items": { "type": "string" }, "description": "List of required properties", "example": [ "host", "port" ] }, "maxItems": { "type": "integer", "format": "int32", "description": "Maximum number of items for arrays", "example": 10 }, "description": { "type": "string", "description": "Description of the property", "example": "This is a sample property used for demonstration purposes." }, "minimum": { "type": "array", "items": { "type": "object" }, "description": "Minimum values for numeric properties" }, "maximum": { "type": "array", "items": { "type": "object" }, "description": "Maximum values for numeric properties", "example": [ 1, 0 ] }, "enum": { "type": "array", "items": {}, "description": "Enumeration of allowed values" }, "additionalProperties": { "type": "boolean", "examples": [ true, false ], "description": "Whether additional properties are allowed" } }, "title": "PropertySchemaResponse", "description": "Schema definition for a single property" }, "databaseDependencyResponse": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "examples": [ { "required": [ "host", "port" ] } ], "properties": { "required": { "type": "array", "items": { "type": "string" }, "description": "List of required properties when this dependency is present", "example": [ "host", "port" ] } }, "title": "DependencyResponse", "description": "a dependency definition" }, "databaseErrorResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "examples": [ { "error_message": "Authentication credentials wrong", "error_code": "401" } ], "properties": { "error_message": { "type": "string", "description": "Error message describing the error." }, "error_code": { "type": "string", "description": "Error code associated with the error." } }, "required": [ "error_message", "error_code" ] } }, "title": "ErrorResponse", "additionalProperties": false, "description": "Schema for error responses from the API." }, "databasePlansResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "service_types": [ { "type": "pg", "latest_version": "18.6", "componentised": true, "zones": [ "fi-hel1", "de-fra1" ], "backup_tiers": [ "regular", "extended" ], "node_counts": [ 1, 2, 3 ], "compute_shapes": [ { "compute": "rdb.standard.2CPU-8GB", "family": "standard", "cpu": 2, "memory_gb": 8, "dynamic_storage_supported": true, "node_counts": [ 1, 2, 3 ], "backups": [ "regular" ], "storage": { "step_gib": 10, "dynamic_max_multiplier": 4, "total_cap_gib": 10240, "options": [ { "base_gib": 80, "max_gib": 400 } ] } } ] } ] } ], "properties": { "service_types": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "examples": [ "pg", "mysql" ], "enum": [ "mysql", "pg" ], "description": "Service type identifier." }, "latest_version": { "type": "string", "examples": [ "18.6", "8.4.8" ], "description": "Latest available major version for this service type. Omitted when not applicable." }, "componentised": { "type": "boolean", "examples": [ true ], "description": "Always true for entries in this response; kept as an explicit indicator of componentised plans." }, "zones": { "type": "array", "items": { "type": "string", "examples": [ "fi-hel1", "de-fra1" ] }, "description": "Zones where this service type is available." }, "backup_tiers": { "type": "array", "items": { "type": "string", "examples": [ "regular" ], "enum": [ "mini", "regular", "extended" ] }, "description": "Backup tiers offered across this service type's plans. Omitted when the service type exposes no named backup tiers." }, "node_counts": { "type": "array", "items": { "type": "integer", "examples": [ 1, 2, 3 ], "format": "int32" }, "description": "Distinct node counts offered across this service type's plans." }, "compute_shapes": { "type": "array", "items": { "type": "object", "properties": { "compute": { "type": "string", "examples": [ "rdb.standard.2CPU-8GB" ], "description": "Compute shape name, usable as plan_compute in requests." }, "family": { "type": "string", "examples": [ "standard" ], "enum": [ "development", "standard", "memory" ], "description": "Compute family." }, "cpu": { "type": "integer", "examples": [ 2 ], "format": "int32", "description": "CPU cores per node." }, "memory_gb": { "type": "integer", "examples": [ 8 ], "format": "int32", "description": "Memory per node in GB." }, "dynamic_storage_supported": { "type": "boolean", "examples": [ true ], "description": "Whether the storage total can be scaled beyond the base storage via dynamic storage." }, "node_counts": { "type": "array", "items": { "type": "integer", "examples": [ 1, 2, 3 ], "format": "int32" }, "description": "Node counts available for this compute shape." }, "backups": { "type": "array", "items": { "type": "string", "examples": [ "regular" ], "enum": [ "mini", "regular", "extended" ] }, "description": "Backup tiers available for this compute shape. Omitted when the shape exposes no named backup tiers." }, "storage": { "type": [ "object", "null" ], "properties": { "step_gib": { "type": "integer", "examples": [ 10 ], "format": "int32", "description": "Granularity, in GiB, at which dynamic storage can be adjusted." }, "dynamic_max_multiplier": { "type": "integer", "examples": [ 4 ], "format": "int32", "description": "Maximum multiplier applied to a base size when scaling storage dynamically." }, "total_cap_gib": { "type": [ "integer", "null" ], "examples": [ 10240 ], "format": "int32", "description": "Hard ceiling on base plus dynamic storage, in GiB, or null when the engine enforces no fixed total cap." }, "options": { "type": "array", "items": { "type": "object", "properties": { "base_gib": { "type": "integer", "examples": [ 80 ], "format": "int32", "description": "Base storage size, in GiB." }, "max_gib": { "type": "integer", "examples": [ 400 ], "format": "int32", "description": "Largest total storage reachable from this base via dynamic storage (base plus multiplier times base), capped at total_cap_gib where it applies." } }, "required": [ "base_gib", "max_gib" ], "additionalProperties": false }, "description": "Base-storage options offered for this compute shape." } }, "required": [ "step_gib", "dynamic_max_multiplier", "total_cap_gib", "options" ], "additionalProperties": false, "description": "Storage choices for this compute shape: the distinct base sizes with the total each scales to, plus the shared dynamic-storage rules. Null for shapes without customer storage." } }, "required": [ "compute", "family", "cpu", "memory_gb", "dynamic_storage_supported", "node_counts" ], "additionalProperties": false }, "description": "Distinct compute shapes offered for this service type." } }, "required": [ "type", "componentised", "zones", "node_counts", "compute_shapes" ], "additionalProperties": false }, "description": "Available service types that offer componentised plans." } }, "title": "PlansResponse", "required": [ "service_types" ], "additionalProperties": false, "description": "Lists available componentised database plans." }, "databaseServiceInformationListResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "uuid": "123e4567-e89b-12d3-a456-426614174000", "zone": "fi-hel1", "name": "my-db", "type": "pg" } ] ], "items": { "$ref": "#/components/schemas/databaseServiceInformationResponse" }, "title": "ServiceInformationListResponse", "description": "Schema for a list of service information" }, "databaseServiceInformationResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "uuid": { "type": "string", "examples": [ "123e4567-e89b-12d3-a456-426614174000" ], "format": "uuid", "description": "The unique identifier for the service." }, "zone": { "type": "string", "examples": [ "fi-hel1" ], "description": "The zone where the service is hosted." }, "name": { "type": "string", "examples": [ "my-db" ], "description": "The name of the service." }, "title": { "type": "string", "examples": [ "My Database Service" ], "description": "The title of the service." }, "type": { "type": "string", "examples": [ "pg" ], "description": "The type of the service." }, "plan": { "type": "string", "examples": [ "1x1xCPU-2GB-25GB" ], "description": "The plan of the service. For componentised (rdb.*) plans this is the effective plan name: the storage segment shows the total storage per node the service is configured with, and the same name is accepted back on create, modify and clone." }, "plan_components": { "$ref": "#/components/schemas/databasePlanComponentsResponse" }, "additional_disk_space_gib": { "type": "integer", "examples": [ 10 ], "format": "int32", "description": "The additional disk space allocated to the service in GiB. Always 0 for componentised (rdb.*) plans, where storage is expressed only as the total in the plan name and in plan_components." }, "state": { "type": "string", "examples": [ "running" ], "description": "The current state of the service." }, "state_error": { "type": "object", "examples": [ { "init": "failed" } ], "additionalProperties": { "type": "string" }, "description": "A map of errors related to the service state." }, "powered": { "type": "boolean", "examples": [ true ], "description": "Indicates whether the service is powered on." }, "termination_protection": { "type": "boolean", "examples": [ false ], "description": "Indicates whether termination protection is enabled for the service." }, "node_count": { "type": "integer", "examples": [ 1 ], "format": "int32", "description": "The number of nodes in the service." }, "create_time": { "type": "string", "examples": [ "2023-10-01T12:00:00Z" ], "format": "date-time", "description": "The time when the service was created." }, "update_time": { "type": "string", "examples": [ "2023-10-10T12:00:00Z" ], "format": "date-time", "description": "The time when the service was last updated." }, "service_uri": { "type": "string", "examples": [ "postgres://upadmin:example-prefix-project@pg-2x2xcpu-4gb-50gb-de-fra1-example-prefix-project.db.upclouddatabases.com:11550/defaultdb?sslmode=require" ], "format": "uri", "description": "The URI for accessing the service." }, "service_uri_params": { "type": "object", "examples": [ { "dbname": "defaultdb", "host": "pg-2x2xcpu-4gb-50gb-de-fra1-example-prefix-project.db.upclouddatabases.com", "password": "example-prefix-project", "port": "11550", "ssl_mode": "require", "user": "upadmin" } ], "additionalProperties": {}, "description": "A map of connection parameters for the service." }, "maintenance": { "$ref": "#/components/schemas/databaseMaintenanceWindowResponse" }, "metadata": { "type": "object", "examples": [ { "owner": "team-databases" } ], "additionalProperties": {}, "description": "A map of metadata key-value pairs for the service." }, "properties": { "type": "object", "examples": [ { "public_access": false } ], "additionalProperties": {}, "description": "A map of additional properties for the service." }, "networks": { "type": "array", "examples": [ [ { "uuid": "123e4567-e89b-12d3-a456-426614174000", "name": "example-private-network", "family": "IPv4", "type": "private", "create_time": "2025-08-01T10:40:04.140473Z", "update_time": "2025-08-01T10:40:04.140473Z" } ] ], "items": { "$ref": "#/components/schemas/databaseNetworkInformationDetailsResponse" }, "description": "List of network information details associated with the service." }, "node_states": { "type": "array", "examples": [ [ { "name": "node-1", "role": "master", "state": "running", "progress_updates": [ { "completed": false, "current": 45, "max": 100, "min": 0, "phase": "prepare", "unit": "bytes_uncompressed" } ] } ] ], "items": { "$ref": "#/components/schemas/databaseNodeStateResponse" }, "description": "The states of individual nodes in the service." }, "labels": { "type": "array", "examples": [ [ { "key": "environment", "value": "production" } ] ], "items": { "$ref": "#/components/schemas/databaseLabelInformationResponse" }, "description": "List of label information associated with the service." }, "backups": { "type": "array", "examples": [ [ { "backup_name": "pg-backup-2024-01-01", "backup_time": "2024-01-01T12:00:00Z", "data_size": 36413440 } ] ], "items": { "$ref": "#/components/schemas/databaseBackupResponse" }, "description": "List of backups associated with the service." }, "components": { "type": "array", "examples": [ [ { "component": "pg", "host": "pg-2x2xcpu-4gb-50gb-de-fra1-example-prefix-project.db.upclouddatabases.com", "port": 1150, "route": "dynamic", "usage": "replica", "ssl": true } ] ], "items": { "$ref": "#/components/schemas/databaseServiceComponentResponse" }, "description": "List of service components associated with the service." }, "connection_pools": { "type": "array", "examples": [ [ { "connection_uri": "postgresql://user:password@hostname:5432/dbname", "database": "pg-db-1", "pool_mode": "session", "pool_name": "pool-2", "pool_size": 10, "username": "updamin" } ] ], "items": { "$ref": "#/components/schemas/databaseConnectionPoolResponse" }, "description": "List of connection pools associated with the service." }, "users": { "type": "array", "examples": [ [ { "username": "admin", "password": "my-password", "authentication": "caching_sha2_password", "type": "admin" } ] ], "items": { "$ref": "#/components/schemas/databaseUserResponse" }, "description": "List of users associated with the service." }, "databases": { "$ref": "#/components/schemas/LogicalDatabasesResponse" }, "acls": { "type": "array", "examples": [ [ { "id": "123e4567-e89b-12d3-a456-426614174000", "permission": "read-write", "topic": "sensors/temperature", "username": "user123" } ] ], "items": { "$ref": "#/components/schemas/databaseAclResponse" }, "description": "List of ACLs associated with the service." }, "service_integrations": { "type": "array", "examples": [ [ { "uuid": "123e4567-e89b-12d3-a456-426614174000", "type": "rsyslog", "source_name": "my-database", "source_uuid": "123e4567-e89b-12d3-a456-426614174000", "destination_name": "my-rsyslog-server", "destination_uuid": "123e4567-e89b-12d3-a456-426614174000", "state": "active", "state_error": [], "node_states": [ { "name": "node-1", "status": "running", "errors": [ "some error" ], "likely_error_cause": null } ], "properties": { "key1": "value1", "key2": 2, "key3": true } } ] ], "items": { "$ref": "#/components/schemas/databaseServiceIntegrationResponse" }, "description": "List of service integrations associated with the service." } }, "title": "ServiceInformationResponse", "description": "Schema for service information response." }, "databaseMaintenanceWindowResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "dow": "Monday", "time": "02:00:00", "pending_updates": [ { "deadline": "2022-01-21T12:21:00Z", "description": "description related to the update", "start_after": "2022-01-21T12:21:00Z", "start_at": "2022-10-21T12:21:00Z" } ] } ], "properties": { "dow": { "type": "string", "examples": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "description": "Day of the week when maintenance occurs (e.g., Monday, Tuesday)." }, "time": { "type": "string", "examples": [ "02:00:00", "14:30:00", "23:59:00" ], "description": "Time of day when maintenance should start (e.g., HH:MM:SS format)." }, "pending_updates": { "type": "array", "items": { "$ref": "#/components/schemas/databaseMaintenancePendingUpdatesResponse" }, "description": "List of updates pending during this maintenance window." } }, "title": "MaintenanceWindowResponse", "description": "Schema for a maintenance window response." }, "databaseMaintenancePendingUpdatesResponse": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "examples": [ { "deadline": "2022-01-21T12:21:00Z", "description": "description related to the update", "start_after": "2022-01-21T12:21:00Z", "start_at": "2022-10-21T12:21:00Z" } ], "properties": { "deadline": { "type": "string", "format": "date-time", "description": "The deadline by which the update must be applied", "example": "2022-01-21T12:21:00Z" }, "description": { "type": "string", "description": "A description of the pending update", "example": "description related to the update" }, "start_after": { "type": "string", "format": "date-time", "description": "The earliest time after which the update can start", "example": "2022-01-21T12:21:00Z" }, "start_at": { "type": "string", "format": "date-time", "description": "The exact scheduled start time for the update", "example": "2022-10-21T12:21:00Z" } }, "title": "MaintenancePendingUpdatesResponse", "description": "Response schema for pending maintenance updates." }, "databaseNetworkInformationDetailsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "uuid": "123e4567-e89b-12d3-a456-426614174000", "name": "example-private-network", "family": "IPv4", "type": "private", "create_time": "2025-08-01T10:40:04.140473Z", "update_time": "2025-08-01T10:40:04.140473Z" } ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier for the network", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "description": "Name of the network", "example": "example-private-network" }, "family": { "type": "string", "examples": [ "IPv4", "IPv6" ], "enum": [ "IPv4", "IPv6" ], "description": "Address family (e.g., IPv4, IPv6)" }, "type": { "type": "string", "examples": [ "private", "public" ], "enum": [ "private", "public" ], "description": "Type of network (e.g., private, public)" }, "create_time": { "type": "string", "format": "date-time", "description": "Timestamp when the network was created", "example": "2025-08-01T10:40:04.140473Z" }, "update_time": { "type": "string", "format": "date-time", "description": "Timestamp when the network was last updated", "example": "2025-08-01T10:40:04.140473Z" } }, "title": "NetworkInformationDetailsResponse", "description": "Schema for network information response details" }, "databaseNodeStateResponse": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "examples": [ { "name": "node-1", "role": "master", "state": "running", "progress_updates": [ { "completed": false, "current": 45, "max": 100, "min": 0, "phase": "prepare", "unit": "bytes_uncompressed" } ] } ], "properties": { "name": { "type": "string", "description": "Name of the node.", "example": "node-1" }, "role": { "type": "string", "description": "Role of the node in the service.", "example": "master" }, "state": { "type": "string", "description": "Current state of the node.", "example": "running" }, "progress_updates": { "$ref": "#/components/schemas/databaseNodeProgressUpdatesResponse" } }, "title": "NodeStateResponse", "description": "Schema for the state of a node in a service." }, "databaseNodeProgressUpdatesResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/databaseNodeProgressUpdateResponse" }, "title": "NodeProgressUpdatesResponse", "description": "Response schema for node progress updates" }, "databaseNodeProgressUpdateResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "completed": false, "current": 45, "max": 100, "min": 0, "phase": "prepare", "unit": "bytes_uncompressed" } ], "properties": { "completed": { "type": "boolean", "description": "Indicates whether the progress is fully completed.", "example": false }, "current": { "type": "integer", "format": "int32", "description": "The current progress value.", "example": 45 }, "max": { "type": "integer", "format": "int32", "description": "The maximum value for the progress range.", "example": 100 }, "min": { "type": "integer", "format": "int32", "description": "The minimum value for the progress range.", "example": 0 }, "phase": { "type": "string", "description": "The current node progress.", "example": "prepare" }, "unit": { "type": "string", "description": "The unit of measurement for the progress values (e.g., percent, MB).", "example": "bytes_uncompressed" } }, "title": "NodeProgressUpdateResponse", "description": "Schema for node progress update response." }, "databaseLabelInformationResponse": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "examples": [ { "key": "environment", "value": "production" } ], "properties": { "key": { "type": "string", "description": "The key of the label.", "example": "environment" }, "value": { "type": "string", "description": "The value of the label.", "example": "production" } }, "title": "LabelInformationResponse", "description": "Schema representing a label with a key and value." }, "databaseBackupResponse": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "examples": [ { "backup_name": "pg-backup-2024-01-01", "backup_time": "2024-01-01T12:00:00Z", "data_size": 36413440 } ], "properties": { "backup_name": { "type": "string", "description": "The name of the backup.", "example": "pg-backup-2024-01-01" }, "backup_time": { "type": "string", "format": "date-time", "description": "The time the backup was created.", "example": "2024-01-01T12:00:00Z" }, "data_size": { "type": "integer", "format": "int32", "description": "The size of the backup data in bytes." } }, "title": "BackupResponse", "description": "Schema for a backup response." }, "databaseServiceComponentResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "component": "pg", "host": "pg-2x2xcpu-4gb-50gb-de-fra1-example-prefix-project.db.upclouddatabases.com", "port": 1150, "route": "dynamic", "usage": "replica", "ssl": true } ], "properties": { "component": { "type": "string", "description": "The name of the service component.", "example": "pg" }, "host": { "type": "string", "format": "hostname", "description": "The hostname or IP address of the service component.", "example": "pg-2x2xcpu-4gb-50gb-de-fra1-example-prefix-project.db.upclouddatabases.com" }, "port": { "type": "integer", "maximum": 65535, "minimum": 0, "format": "int32", "description": "The port number of the service component.", "example": 1150 }, "route": { "type": "string", "description": "The route to access the service component.", "example": "dynamic" }, "usage": { "type": "string", "description": "The usage of the service component.", "example": "replica" }, "ssl": { "type": "boolean", "description": "Indicates if SSL is enabled for the service component.", "example": true } }, "title": "ServiceComponentResponse", "description": "Schema for a service component response." }, "databaseConnectionPoolResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "connection_uri": { "type": "string", "format": "uri", "description": "The connection URI of the connection pool.", "example": "postgresql://user:password@hostname:5432/dbname" }, "database": { "type": "string", "description": "The database name associated with the connection pool.", "example": "defaultdb" }, "pool_mode": { "type": "string", "description": "The mode of the connection pool.", "example": "session" }, "pool_name": { "type": "string", "examples": [ "pool-2" ], "description": "The name of the connection pool." }, "pool_size": { "type": "integer", "format": "int32", "description": "The size of the connection pool.", "example": 10 }, "username": { "type": "string", "description": "The username for the connection pool", "example": "updamin" } }, "title": "ConnectionPoolResponse", "description": "Schema for a connection pool response." }, "databaseUserResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "username": "admin", "password": "my-password", "authentication": "caching_sha2_password", "type": "admin" } ], "properties": { "username": { "type": "string", "description": "The username of the user.", "example": "admin" }, "password": { "type": "string", "description": "The password of the user.", "example": "my-password" }, "authentication": { "type": "string", "description": "The authentication method used by the user.", "example": "caching_sha2_password" }, "type": { "type": "string", "description": "The type of the user.", "example": "admin" }, "pg_access_control": { "$ref": "#/components/schemas/databasePgAccessControlResponse" }, "redis_access_control": { "$ref": "#/components/schemas/databaseRedisAccessControlResponse" }, "valkey_access_control": { "$ref": "#/components/schemas/databaseValkeyAccessControlResponse" }, "opensearch_access_control": { "$ref": "#/components/schemas/databaseOpenSearchAccessControlResponse" } }, "title": "UserResponse", "description": "Schema for a user response." }, "databasePgAccessControlResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "allow_replication": true } ], "properties": { "allow_replication": { "type": "boolean", "description": "If true, allows replication connections.", "example": false } }, "title": "PgAccessControlResponse", "description": "Schema for PostgreSQL access control response." }, "databaseRedisAccessControlResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "categories": [ "@all", "@fast" ], "channels": [ "news", "updates" ], "commands": [ "GET", "SET", "DEL" ], "keys": [ "user:*", "session:*" ] } ], "properties": { "categories": { "type": "array", "items": { "type": "string" }, "description": "List of command categories the user has access to.", "example": [ "@all", "@fast" ] }, "channels": { "type": "array", "items": { "type": "string" }, "description": "List of Pub/Sub channels the user has access to.", "example": [ "news", "updates" ] }, "commands": { "type": "array", "items": { "type": "string" }, "description": "List of specific commands the user has access to.", "example": [ "GET", "SET", "DEL" ] }, "keys": { "type": "array", "items": { "type": "string" }, "description": "List of key patterns the user has access to.", "example": [ "user:*", "session:*" ] } }, "title": "RedisAccessControlResponse", "description": "Schema for Redis access control response." }, "databaseValkeyAccessControlResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "categories": [ "@all", "@fast" ], "channels": [ "news", "updates" ], "commands": [ "GET", "SET", "DEL" ], "keys": [ "user:*", "session:*" ] } ], "properties": { "categories": { "type": "array", "items": { "type": "string" }, "description": "List of command categories the user has access to.", "example": [ "@all", "@fast" ] }, "channels": { "type": "array", "items": { "type": "string" }, "description": "List of Pub/Sub channels the user has access to.", "example": [ "news", "updates" ] }, "commands": { "type": "array", "items": { "type": "string" }, "description": "List of specific commands the user has access to.", "example": [ "GET", "SET", "DEL" ] }, "keys": { "type": "array", "items": { "type": "string" }, "description": "List of key patterns the user has access to.", "example": [ "user:*", "session:*" ] } }, "title": "ValkeyAccessControlResponse", "description": "Schema for Valkey user access control response" }, "databaseOpenSearchAccessControlResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "rules": [ { "index": "log-*", "permission": "read" } ] } ], "properties": { "rules": { "type": "array", "items": { "$ref": "#/components/schemas/databaseOpenSearchAccessControlRuleResponse" } } }, "title": "OpenSearchAccessControlResponse", "description": "Schema for OpenSearch access control response." }, "databaseOpenSearchAccessControlRuleResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "index": "log-*", "permission": "read" } ], "properties": { "index": { "type": "string", "description": "Index name or pattern (e.g., 'log-*' for all indices starting with 'log-')", "example": "log-*" }, "permission": { "type": "string", "description": "Permission level for the specified index", "example": "read" } }, "title": "OpenSearchAccessControlRuleResponse", "description": "Schema for OpenSearch access control rule response." }, "databaseAclResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "permission": "read-write", "topic": "sensors/temperature", "username": "user123" } ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the ACL entry.", "example": "123e4567-e89b-12d3-a456-426614174000" }, "permission": { "type": "string", "description": "The permission level for the ACL entry.", "example": "read-write" }, "topic": { "type": "string", "description": "The topic associated with the ACL entry.", "example": "sensors/temperature" }, "username": { "type": "string", "description": "The username associated with the ACL entry.", "example": "user123" } }, "title": "AclResponse", "description": "Response schema for an Access Control List (ACL) entry." }, "databaseServiceIntegrationResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "uuid": "123e4567-e89b-12d3-a456-426614174000", "type": "rsyslog", "source_name": "my-database", "source_uuid": "123e4567-e89b-12d3-a456-426614174000", "destination_name": "my-rsyslog-server", "destination_uuid": "123e4567-e89b-12d3-a456-426614174000", "state": "active", "state_error": [], "node_states": [ { "name": "node-1", "status": "running", "errors": [ "some error" ], "likely_error_cause": null } ], "properties": { "key1": "value1", "key2": 2, "key3": true } } ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "The UUID of the service integration.", "example": "123e4567-e89b-12d3-a456-426614174000" }, "type": { "type": "string", "description": "The type of service integration.", "example": "rsyslog" }, "source_name": { "type": "string", "description": "The name of the source service.", "example": "my-database" }, "source_uuid": { "type": "string", "format": "uuid", "description": "The UUID of the source service.", "example": "123e4567-e89b-12d3-a456-426614174000" }, "destination_name": { "type": "string", "description": "The name of the destination service.", "example": "my-rsyslog-server" }, "destination_uuid": { "type": "string", "format": "uuid", "description": "The UUID of the destination service.", "example": "123e4567-e89b-12d3-a456-426614174000" }, "state": { "type": "string", "description": "The current state of the service integration.", "example": "active" }, "state_error": { "type": "array", "items": {}, "description": "A list of errors related to the service integration state." }, "node_states": { "type": "array", "items": { "$ref": "#/components/schemas/databaseIntegrationNodeStateResponse" }, "description": "The states of individual nodes in the service integration." }, "properties": { "type": "object", "additionalProperties": {}, "description": "A map of additional properties for the service integration." } }, "title": "ServiceIntegrationResponse", "description": "Schema for a service integration response." }, "databaseIntegrationNodeStateResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "node-1", "status": "running", "errors": [ "some error" ], "likely_error_cause": null } ], "properties": { "name": { "type": "string", "description": "The name of the integration node", "example": "node-1" }, "status": { "type": "string", "description": "The current status of the node", "example": "running" }, "errors": { "type": "array", "items": {}, "description": "A list of errors encountered by the node" }, "likely_error_cause": { "type": [ "string", "null" ], "examples": [ "some error" ], "description": "The likely cause of the error" } }, "title": "IntegrationNodeStateResponse", "description": "Schema for representing the state of an integration node" }, "databaseNetworksInformationResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/databaseNetworkInformationDetailsResponse" }, "title": "NetworksInformationResponse", "description": "Schema for networks information response" }, "databaseLabelsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "key": "environment", "value": "production" } ] ], "items": { "$ref": "#/components/schemas/databaseLabelResponse" }, "title": "LabelsResponse", "description": "Schema for a list of labels." }, "databaseLabelResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "key": "environment", "value": "production" } ], "properties": { "key": { "type": "string", "description": "The key of the label to delete.", "example": "environment" }, "value": { "type": "string", "description": "The value of the label to delete.", "example": "production" } }, "title": "LabelResponse", "description": "Schema for deleting a label with a key and value." }, "databaseAvailableExtensionsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "default_version": "1.12", "name": "pg_stat_statements", "versions": [ "1.10", "1.11", "1.12" ] }, { "default_version": "3.4.0", "name": "postgis", "versions": [ "3.3.0", "3.4.0" ] }, { "default_version": "0.8.1", "name": "vector", "versions": [ "0.8.1" ] }, { "default_version": "1.1", "name": "uuid-ossp", "versions": [ "1.1" ] } ] ], "items": { "type": "object", "properties": { "default_version": { "type": "string", "description": "The default version of the extension", "example": "1.12" }, "name": { "type": "string", "description": "The name of the PostgreSQL extension", "example": "pg_stat_statements" }, "versions": { "type": "array", "items": { "type": "string" }, "minItems": 1, "description": "List of available versions for this extension", "example": [ "1.10", "1.11", "1.12" ] } }, "required": [ "default_version", "name", "versions" ], "additionalProperties": false }, "title": "AvailableExtensionsResponse", "description": "Response schema for listing available PostgreSQL extensions" }, "databasePGAvailableExtensionsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "version": "16", "extensions": [ { "default_version": "1.12", "name": "pg_stat_statements", "versions": [ "1.10", "1.11", "1.12" ] }, { "default_version": "3.4.0", "name": "postgis", "versions": [ "3.3.0", "3.4.0" ] } ] }, { "version": "15", "extensions": [ { "default_version": "1.10", "name": "pg_stat_statements", "versions": [ "1.9", "1.10" ] }, { "default_version": "3.3.0", "name": "postgis", "versions": [ "3.2.0", "3.3.0" ] } ] } ] ], "items": { "type": "object", "properties": { "version": { "type": "string", "description": "The PostgreSQL major version", "example": "16" }, "extensions": { "type": "array", "items": { "type": "object", "properties": { "default_version": { "type": "string", "description": "The default version of the extension", "example": "1.12" }, "name": { "type": "string", "description": "The name of the PostgreSQL extension", "example": "pg_stat_statements" }, "versions": { "type": "array", "items": { "type": "string" }, "minItems": 1, "description": "List of available versions for this extension", "example": [ "1.10", "1.11", "1.12" ] } }, "required": [ "default_version", "name", "versions" ], "additionalProperties": false }, "description": "List of available extensions for this PostgreSQL version" } }, "required": [ "version", "extensions" ], "additionalProperties": false }, "title": "PGAvailableExtensionsResponse", "description": "Response schema for listing available PostgreSQL extensions grouped by version" }, "databaseVersionsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "major_version": "8", "service_type": "mysql", "state": "available", "end_of_life_time": null, "availability_end_time": null, "availability_start_time": "2019-05-10T00:00:00Z", "termination_time": null, "upgrade_to_service_type": null, "upgrade_to_version": null, "upstream_end_of_life_time": null }, { "major_version": "16", "service_type": "pg", "state": "available", "end_of_life_time": "2028-11-09T00:00:00Z", "availability_end_time": "2028-05-09T00:00:00Z", "availability_start_time": "2024-01-08T00:00:00Z", "termination_time": null, "upgrade_to_service_type": null, "upgrade_to_version": null, "upstream_end_of_life_time": "2028-11-09T00:00:00Z" }, { "major_version": "2", "service_type": "opensearch", "state": "available", "end_of_life_time": null, "availability_end_time": null, "availability_start_time": "2022-07-12T00:00:00Z", "termination_time": null, "upgrade_to_service_type": null, "upgrade_to_version": null, "upstream_end_of_life_time": null } ] ], "items": { "type": "object", "properties": { "major_version": { "type": "string", "description": "The major version of the service", "example": "16" }, "service_type": { "type": "string", "enum": [ "mysql", "pg", "opensearch", "valkey" ], "description": "The type of service (e.g., mysql, pg, opensearch, valkey)", "example": "pg" }, "state": { "type": "string", "enum": [ "available", "preview" ], "description": "The availability state of the version", "example": "available" }, "end_of_life_time": { "type": [ "string", "null" ], "format": "date-time", "description": "The date when this version reaches end of life", "example": "2028-11-09T00:00:00Z" }, "availability_end_time": { "type": [ "string", "null" ], "format": "date-time", "description": "The date when this version will no longer be available for new services", "example": "2028-05-09T00:00:00Z" }, "availability_start_time": { "type": [ "string", "null" ], "format": "date-time", "description": "The date when this version became available", "example": "2024-01-08T00:00:00Z" }, "termination_time": { "type": [ "string", "null" ], "format": "date-time", "description": "The date when services running this version will be terminated", "example": "2028-11-09T00:00:00Z" }, "upgrade_to_service_type": { "type": [ "string", "null" ], "format": "date-time", "description": "The service type to upgrade to when this version reaches end of life", "example": "2028-11-09T00:00:00Z" }, "upgrade_to_version": { "type": [ "string", "null" ], "description": "The version to upgrade to when this version reaches end of life", "example": "2" }, "upstream_end_of_life_time": { "type": [ "string", "null" ], "format": "date-time", "description": "The upstream end of life date for this version", "example": "2028-11-09T00:00:00Z" } }, "required": [ "major_version", "service_type", "state" ], "additionalProperties": false }, "title": "VersionsResponse", "description": "Response schema for listing available service versions across all service types" }, "databaseAccessControlSettingsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "access_control": false, "extended_access_control": true } ], "properties": { "access_control": { "type": "boolean", "description": "If true, access control is enabled for the cluster.", "example": false }, "extended_access_control": { "type": "boolean", "description": "If true, extended access control features are enabled.", "example": true } }, "title": "AccessControlSettingsResponse", "description": "Response schema for access control settings of a cluster." }, "databaseOpenSearchSecurityPluginStatusResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "security_plugin_admin_enabled": true, "security_plugin_available": true, "security_plugin_enabled": true } ], "properties": { "security_plugin_admin_enabled": { "type": "boolean", "description": "Indicates if the security plugin admin is enabled", "example": true }, "security_plugin_available": { "type": "boolean", "description": "Indicates if the security plugin is available", "example": true }, "security_plugin_enabled": { "type": "boolean", "description": "Indicates if the security plugin is enabled", "example": true } }, "title": "OpenSearchSecurityPluginStatusResponse", "description": "OpenSearch security plugin status response" }, "databaseMetricsItemResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "cpu_usage": { "data": { "cols": [ { "label": "time", "type": "date" }, { "label": "test-1 (master)", "type": "number" }, { "label": "test-2 (standby)", "type": "number" } ], "rows": [ [ "2022-01-21T13:10:30Z", 2.744682398273781, 3.054323473090861 ], [ "2022-01-21T13:11:00Z", 3.0735645433218366, 2.972423595745795 ], [ "2022-01-21T13:11:30Z", 2.61619694060839, 3.1358378052207883 ], [ "2022-01-21T13:12:00Z", 3.275132296130991, 4.196249043309251 ] ] }, "hints": { "title": "CPU usage %" } }, "disk_usage": { "data": { "cols": [ { "label": "time", "type": "date" }, { "label": "test-1 (master)", "type": "number" }, { "label": "test-2 (standby)", "type": "number" } ], "rows": [ [ "2022-01-21T13:10:30Z", 5.654416415900109, 5.58959125727556 ], [ "2022-01-21T13:11:00Z", 5.654416415900109, 5.58959125727556 ], [ "2022-01-21T13:11:30Z", 5.654416415900109, 5.58959125727556 ] ] }, "hints": { "title": "Disk space usage %" } }, "diskio_reads": { "data": { "cols": [ { "label": "time", "type": "date" }, { "label": "test-1 (master)", "type": "number" }, { "label": "test-2 (standby)", "type": "number" } ], "rows": [ [ "2022-01-21T13:10:30Z", 0, 0 ], [ "2022-01-21T13:11:00Z", 0, 0 ], [ "2022-01-21T13:11:30Z", 0, 0 ] ] }, "hints": { "title": "Disk iops (reads)" } }, "diskio_writes": { "data": { "cols": [ { "label": "time", "type": "date" }, { "label": "test-1 (master)", "type": "number" }, { "label": "test-2 (standby)", "type": "number" } ], "rows": [ [ "2022-01-21T13:10:30Z", 3, 2 ], [ "2022-01-21T13:11:00Z", 2, 3 ], [ "2022-01-21T13:11:30Z", 4, 3 ] ] }, "hints": { "title": "Disk iops (writes)" } }, "load_average": { "data": { "cols": [ { "label": "time", "type": "date" }, { "label": "test-1 (master)", "type": "number" }, { "label": "test-2 (standby)", "type": "number" } ], "rows": [ [ "2022-01-21T13:10:30Z", 0.11, 0.11 ], [ "2022-01-21T13:11:00Z", 0.14, 0.1 ], [ "2022-01-21T13:11:30Z", 0.14, 0.09 ] ] }, "hints": { "title": "Load average (5 min)" } }, "mem_usage": { "data": { "cols": [ { "label": "time", "type": "date" }, { "label": "test-1 (master)", "type": "number" }, { "label": "test-2 (standby)", "type": "number" } ], "rows": [ [ "2022-01-21T13:10:30Z", 11.491766148261078, 12.318932883261219 ], [ "2022-01-21T13:11:00Z", 11.511967645759277, 12.304403727425075 ], [ "2022-01-21T13:11:30Z", 11.488581675749048, 12.272260458006759 ] ] }, "hints": { "title": "Memory usage %" } }, "net_receive": { "data": { "cols": [ { "label": "time", "type": "date" }, { "label": "test-1 (master)", "type": "number" }, { "label": "test-2 (standby)", "type": "number" } ], "rows": [ [ "2022-01-21T13:10:30Z", 442, 470 ], [ "2022-01-21T13:11:00Z", 439, 384 ], [ "2022-01-21T13:11:30Z", 466, 458 ] ] }, "hints": { "title": "Network receive (bytes/s)" } }, "net_send": { "data": { "cols": [ { "label": "time", "type": "date" }, { "label": "test-1 (master)", "type": "number" }, { "label": "test-2 (standby)", "type": "number" } ], "rows": [ [ "2022-01-21T13:10:30Z", 672, 581 ], [ "2022-01-21T13:11:00Z", 660, 555 ], [ "2022-01-21T13:11:30Z", 694, 573 ] ] }, "hints": { "title": "Network transmit (bytes/s)" } } } ], "properties": { "data": { "$ref": "#/components/schemas/databaseMetricsDataResponse" }, "hints": { "type": "object", "properties": { "title": { "type": "string", "examples": [ "CPU Usage Over Time" ], "description": "A human-readable title for the metric data." } }, "description": "Additional hints or metadata about the metric data." } }, "title": "MetricsItemResponse", "description": "Schema for a single metrics item response." }, "databaseMetricsDataResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "cols": [ { "label": "time", "type": "date" }, { "label": "test-1 (master)", "type": "number", "format": "float" }, { "label": "test-2 (standby)", "type": "number", "format": "float" } ], "rows": [ [ "2022-01-21T13:10:30Z", 2.744682398273781, 3.054323473090861 ], [ "2022-01-21T13:11:00Z", 3.0735645433218366, 2.972423595745795 ], [ "2022-01-21T13:11:30Z", 2.61619694060839, 3.1358378052207883 ], [ "2022-01-21T13:12:00Z", 3.275132296130991, 4.196249043309251 ] ] } ], "properties": { "cols": { "type": "array", "examples": [ [ { "label": "time", "type": "date" }, { "label": "test-1 (master)", "type": "number", "format": "float" }, { "label": "test-2 (standby)", "type": "number", "format": "float" } ] ], "items": { "$ref": "#/components/schemas/databaseMetricsColumnHeaderResponse" } }, "rows": { "type": "array", "examples": [ [ "2022-01-21T13:10:30Z", 2.744682398273781, 3.054323473090861 ], [ "2022-01-21T13:11:00Z", 3.0735645433218366, 2.972423595745795 ], [ "2022-01-21T13:11:30Z", 2.61619694060839, 3.1358378052207883 ], [ "2022-01-21T13:12:00Z", 3.275132296130991, 4.196249043309251 ] ], "items": { "$ref": "#/components/schemas/databaseMetricsRowDataResponse" } } }, "title": "MetricsDataResponse", "description": "Schema for metrics data response." }, "databaseMetricsColumnHeaderResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "label": "cpu_usage", "type": "gauge" } ], "properties": { "label": { "type": "string", "description": "The label for the column header.", "example": "cpu_usage" }, "type": { "type": "string", "description": "The label for the column header.", "example": "gauge" } }, "title": "MetricsColumnHeaderResponse", "description": "Schema for a metrics column header response." }, "databaseMetricsRowDataResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": {}, "title": "MetricsRowDataResponse", "description": "Array of objects representing a row of metrics data - can be any format." }, "databaseServiceAlertsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/databaseServiceAlertResponse" }, "title": "ServiceAlertsResponse", "description": "Schema for service alerts response" }, "databaseServiceAlertResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "create_time": "2023-10-05T14:48:00Z", "event": "user_alert_os_too_many_shards.", "service_type": "opensearch", "severity": "warning" } ], "properties": { "create_time": { "type": "string", "format": "date-time", "description": "The time when the alert was created.", "example": "2023-10-05T14:48:00Z" }, "event": { "type": "string", "description": "A brief description of the alert event.", "example": "user_alert_os_too_many_shards." }, "service_type": { "type": "string", "description": "The type of service associated with the alert.", "example": "opensearch" }, "severity": { "type": "string", "description": "The severity level of the alert.", "example": "warning" } }, "title": "ServiceAlertResponse", "description": "Schema for a service alert" }, "databaseIntegrationEndpointsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "uuid": "20e86f48-2dcd-4a43-843d-3532ab112c1d", "name": "rsyslog", "type": "rsyslog", "properties": { "format": "rfc5424", "max_message_size": 8192, "port": 514, "sd": "", "server": "94.237.95.164", "tls": false } } ] ], "items": { "$ref": "#/components/schemas/databaseIntegrationEndpointResponse" }, "title": "IntegrationEndpointsResponse", "description": "Schema for a list of integration endpoints." }, "databaseIntegrationEndpointResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "uuid": "20e86f48-2dcd-4a43-843d-3532ab112c1d", "name": "rsyslog", "type": "rsyslog", "properties": { "format": "rfc5424", "max_message_size": 8192, "port": 514, "sd": "", "server": "94.237.95.164", "tls": false } } ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "The universally unique identifier (UUID) of the integration endpoint.", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "description": "The name of the integration endpoint.", "example": "rsyslog" }, "type": { "type": "string", "description": "The type of the integration endpoint.", "example": "rsyslog" }, "properties": { "type": "object", "examples": [ { "format": "rfc5424", "max_message_size": 8192, "port": 514, "sd": "", "server": "94.237.95.164", "tls": false } ], "additionalProperties": true, "description": "A key-value map of properties specific to the integration endpoint type." } }, "title": "IntegrationEndpointResponse", "description": "Schema for an integration endpoint response." }, "databaseAccountCaResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "certificate": "-----BEGIN CERTIFICATE-----\naxxxxxxxxxxxxx+tkP9Uh9+PxxxxxcNAQEM\nBQAwOjE4MDYGA1UEAwwvZWYzMTc1xxxxxxxxxx0YjM2OWIz\nM2RkIFByb2plY3QgQ0EwHhcNMjEwMzMwMDgxNDU0WhcNMzEwMzI4MDgxNDU0WjA6\nMTgwNgYDVQQDDC9lZjMxNzU1NC1lNzYzLTQ5ZjUtODI4Ni1lZDRiMzY5YjMzZGQg\nUHJvamVjdCBDQTCCAaIwDQYJKoZIhvcNAQEBBQxxxxggGBAK1Vh4GR\nlfxPZ3Icw8E1WlS5+9rADOdrstYtL3oiHBqzljmjvKf1Vuu0LLHtszWrCElOvoZ4\nzhg6+yVIB9YcvTZJNU0BNlIilF0rafn/40pFjeKrtxxxxxxxxxxy48Hnk\nMAiqoRyJ6hGRpYmKVip2sbMEtI+X9xQahlhlTMLo9082gS2hI5nvmhDqRiOlly28\ntwr2I/nbsIao8pIE19bdptKVqrv9x+O51O2JK7NlyjxnJVaHS9Tv6z1gG0GZgzYW\nkram1U8oTu72cjvGhMIBhgz7AlQ74PMtAub/eH4hipGU4LDZQiZ+9kCT+FCD9uAq\nIq+ALiLPHTCaGiKTJYoerutgrmrz1HZp6RmxRc8Wk7MdPp8OHqSXUnewKSGlzEl3\nhlJ5UMOVQ+tSDffAuvA6phUS0mmm1xxxxxxxxxxxxxxxMcrVE8AjbF5nkieOV0r6hIwIDAQAB\noz8wPTAdBgNVHQ4EFxxxxgQUHTUNeVDpSFx8fjq9xxxxxxxxFDnqn8xY0iAwDwYDVR0TBAgwBgEB\n/wIBADALBgNxxxxxxxxxxLtt8qOjsbvS\nYZtePpqZjx7NkmFdScc0LOBj6oXFetcJlhLQKzrguQDi/trt29sxjZZ5zLnQufnE\ns8IYtbclhDbF0qGG15oP8tYVRXfzKLHF4HfuMrdiyqzF/q6Qy0fVIiFWD7t1it8V\nPLqlk9oFDL7xUnsZOfYcqv8Ct+aWE7L73gJVgUkDHP+gkdGTWKYm4zzYTLfqh1Iu\nyivOjn+KSyjjtsJsOGUDZBkh215OMKPp4JpWQpgQeK6kjTnwuMwEYYFyhfu/z5wU\nwN7z7Ad39fyGmQzkGbFXtP0te4MFElOVSkiHaB4T4lTM6690st6+uIhFI1Qo/oAY\n30ybOpOTLF7FZxwY5Z+BTW27hytyECLkG3b4iKIqKsRIvlFkwKP8cfKjq7ImSbBG\nOJ8JBcraffygrLznbJ2979Y9yN+n+8wW0xxxxxxxxxxov24snxDmm6fAMoO1\nxBM7c2KZA5ZoZDefcz9e28r7xxxx==\n-----END CERTIFICATE-----\n" } ], "properties": { "certificate": { "type": "string", "description": "Name of the CA", "example": "-----BEGIN CERTIFICATE-----\naxxxxxxxxxxxxx+tkP9Uh9+PxxxxxcNAQEM\nBQAwOjE4MDYGA1UEAwwvZWYzMTc1xxxxxxxxxx0YjM2OWIz\nM2RkIFByb2plY3QgQ0EwHhcNMjEwMzMwMDgxNDU0WhcNMzEwMzI4MDgxNDU0WjA6\nMTgwNgYDVQQDDC9lZjMxNzU1NC1lNzYzLTQ5ZjUtODI4Ni1lZDRiMzY5YjMzZGQg\nUHJvamVjdCBDQTCCAaIwDQYJKoZIhvcNAQEBBQxxxxggGBAK1Vh4GR\nlfxPZ3Icw8E1WlS5+9rADOdrstYtL3oiHBqzljmjvKf1Vuu0LLHtszWrCElOvoZ4\nzhg6+yVIB9YcvTZJNU0BNlIilF0rafn/40pFjeKrtxxxxxxxxxxy48Hnk\nMAiqoRyJ6hGRpYmKVip2sbMEtI+X9xQahlhlTMLo9082gS2hI5nvmhDqRiOlly28\ntwr2I/nbsIao8pIE19bdptKVqrv9x+O51O2JK7NlyjxnJVaHS9Tv6z1gG0GZgzYW\nkram1U8oTu72cjvGhMIBhgz7AlQ74PMtAub/eH4hipGU4LDZQiZ+9kCT+FCD9uAq\nIq+ALiLPHTCaGiKTJYoerutgrmrz1HZp6RmxRc8Wk7MdPp8OHqSXUnewKSGlzEl3\nhlJ5UMOVQ+tSDffAuvA6phUS0mmm1xxxxxxxxxxxxxxxMcrVE8AjbF5nkieOV0r6hIwIDAQAB\noz8wPTAdBgNVHQ4EFxxxxgQUHTUNeVDpSFx8fjq9xxxxxxxxFDnqn8xY0iAwDwYDVR0TBAgwBgEB\n/wIBADALBgNxxxxxxxxxxLtt8qOjsbvS\nYZtePpqZjx7NkmFdScc0LOBj6oXFetcJlhLQKzrguQDi/trt29sxjZZ5zLnQufnE\ns8IYtbclhDbF0qGG15oP8tYVRXfzKLHF4HfuMrdiyqzF/q6Qy0fVIiFWD7t1it8V\nPLqlk9oFDL7xUnsZOfYcqv8Ct+aWE7L73gJVgUkDHP+gkdGTWKYm4zzYTLfqh1Iu\nyivOjn+KSyjjtsJsOGUDZBkh215OMKPp4JpWQpgQeK6kjTnwuMwEYYFyhfu/z5wU\nwN7z7Ad39fyGmQzkGbFXtP0te4MFElOVSkiHaB4T4lTM6690st6+uIhFI1Qo/oAY\n30ybOpOTLF7FZxwY5Z+BTW27hytyECLkG3b4iKIqKsRIvlFkwKP8cfKjq7ImSbBG\nOJ8JBcraffygrLznbJ2979Y9yN+n+8wW0xxxxxxxxxxov24snxDmm6fAMoO1\nxBM7c2KZA5ZoZDefcz9e28r7xxxx==\n-----END CERTIFICATE-----\n" } }, "title": "AccountCaResponse", "description": "Response schema for account CA" }, "databaseProjectAlertsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/databaseProjectAlertResponse" }, "title": "ProjectAlertsResponse", "description": "Schema for a project alerts" }, "databaseProjectAlertResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "create_time": "2025-08-01T10:40:04.140473Z", "event": "pg-disk-full", "uuid": "123e4567-e89b-12d3-a456-426614174000", "title": "pg-1x2xcpu-2", "service_type": "pg", "severity": "critical" } ], "properties": { "create_time": { "type": "string", "format": "date-time", "description": "Timestamp when the alert was created", "example": "2025-08-01T10:40:04.140473Z" }, "event": { "type": "string", "description": "Event type for the alert", "example": "pg-disk-full" }, "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier for the alert", "example": "123e4567-e89b-12d3-a456-426614174000" }, "title": { "type": "string", "description": "Optional title of the alert", "example": "pg-1x2xcpu-2" }, "service_type": { "type": "string", "description": "Service type related to the alert", "example": "pg" }, "severity": { "type": "string", "description": "Severity of the alert", "example": "critical" } }, "title": "ProjectAlertResponse", "description": "Schema for a project alert response" }, "databaseServiceStatusResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "state": "running" } ], "properties": { "state": { "type": "string", "description": "The service status indicates the service's current operational status.", "example": "running" } }, "title": "ServiceStatusResponse", "description": "Schema for representing the status of a service instance." }, "databaseServiceVersionsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ "12", "13", "14", "15", "16" ] ], "items": { "type": "string", "description": "Available service version", "example": "12" }, "title": "ServiceVersionsResponse", "description": "Schema for representing available service versions" }, "databaseUpCloudApiResponse": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "examples": [ { "errors": [ { "message": "Invalid request", "more_info": "https://developers.upcloud.com/errors", "status": 400 } ], "message": "An error occurred while processing your request." } ], "properties": { "errors": { "type": "array", "items": { "properties": { "message": { "type": "string", "description": "A descriptive error message." }, "more_info": { "type": "string", "description": "A URL pointing to more information about the error." }, "status": { "type": "integer", "format": "int32", "description": "The HTTP status code associated with the error." } } }, "description": "A list of error messages returned by UpCloud's API.", "example": [ { "message": "Invalid request", "more_info": "https://developers.upcloud.com/errors", "status": 400 } ] }, "message": { "type": "string", "description": "The time the backup was created.", "example": "An error occurred while processing your request." } }, "title": "UpCloudApiResponse", "description": "Schema for UpCloud API error responses." }, "databaseServiceMigrationStatusResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "method": "replication", "seconds_behind_master": 0, "source_active": true, "status": "done", "databases": [ { "dbname": "defaultdb", "method": "replication", "status": "syncing" } ] } ], "properties": { "error": { "type": "string", "description": "Error message if any", "example": "some error occurred" }, "method": { "type": "string", "description": "Migration method used", "example": "replication" }, "seconds_behind_master": { "type": "integer", "format": "int32", "description": "Seconds behind master", "example": 10 }, "source_active": { "type": "boolean", "description": "Is source active", "example": true }, "status": { "type": "string", "description": "Current status of the migration", "example": "syncing" }, "databases": { "type": "array", "items": { "$ref": "#/components/schemas/databaseMigrationStatusDetailsResponse" } } }, "title": "ServiceMigrationStatusResponse", "description": "Response schema for service migration status" }, "databaseMigrationStatusDetailsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "error": "some error occurred", "dbname": "defaultdb", "method": "replication", "status": "syncing" } ], "properties": { "error": { "type": "string", "description": "Error message if any", "example": "some error occurred" }, "dbname": { "type": "string", "description": "Name of the database", "example": "defaultdb" }, "method": { "type": "string", "description": "Migration method used", "example": "replication" }, "status": { "type": "string", "description": "Current status of the migration", "example": "syncing" } }, "title": "MigrationStatusDetailsResponse", "description": "Schema for migration status details response." }, "databaseMetricsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "cpu_usage": { "data": { "cols": [ { "label": "time", "type": "date" }, { "label": "test-1 (master)", "type": "number" }, { "label": "test-2 (standby)", "type": "number" } ], "rows": [ [ "2022-01-21T13:10:30Z", 2.744682398273781, 3.054323473090861 ], [ "2022-01-21T13:11:00Z", 3.0735645433218366, 2.972423595745795 ], [ "2022-01-21T13:11:30Z", 2.61619694060839, 3.1358378052207883 ], [ "2022-01-21T13:12:00Z", 3.275132296130991, 4.196249043309251 ] ] }, "hints": { "title": "CPU usage %" } }, "disk_usage": { "data": { "cols": [ { "label": "time", "type": "date" }, { "label": "test-1 (master)", "type": "number" }, { "label": "test-2 (standby)", "type": "number" } ], "rows": [ [ "2022-01-21T13:10:30Z", 5.654416415900109, 5.58959125727556 ], [ "2022-01-21T13:11:00Z", 5.654416415900109, 5.58959125727556 ], [ "2022-01-21T13:11:30Z", 5.654416415900109, 5.58959125727556 ] ] }, "hints": { "title": "Disk space usage %" } }, "diskio_reads": { "data": { "cols": [ { "label": "time", "type": "date" }, { "label": "test-1 (master)", "type": "number" }, { "label": "test-2 (standby)", "type": "number" } ], "rows": [ [ "2022-01-21T13:10:30Z", 0, 0 ], [ "2022-01-21T13:11:00Z", 0, 0 ], [ "2022-01-21T13:11:30Z", 0, 0 ] ] }, "hints": { "title": "Disk iops (reads)" } }, "diskio_writes": { "data": { "cols": [ { "label": "time", "type": "date" }, { "label": "test-1 (master)", "type": "number" }, { "label": "test-2 (standby)", "type": "number" } ], "rows": [ [ "2022-01-21T13:10:30Z", 3, 2 ], [ "2022-01-21T13:11:00Z", 2, 3 ], [ "2022-01-21T13:11:30Z", 4, 3 ] ] }, "hints": { "title": "Disk iops (writes)" } }, "load_average": { "data": { "cols": [ { "label": "time", "type": "date" }, { "label": "test-1 (master)", "type": "number" }, { "label": "test-2 (standby)", "type": "number" } ], "rows": [ [ "2022-01-21T13:10:30Z", 0.11, 0.11 ], [ "2022-01-21T13:11:00Z", 0.14, 0.1 ], [ "2022-01-21T13:11:30Z", 0.14, 0.09 ] ] }, "hints": { "title": "Load average (5 min)" } }, "mem_usage": { "data": { "cols": [ { "label": "time", "type": "date" }, { "label": "test-1 (master)", "type": "number" }, { "label": "test-2 (standby)", "type": "number" } ], "rows": [ [ "2022-01-21T13:10:30Z", 11.491766148261078, 12.318932883261219 ], [ "2022-01-21T13:11:00Z", 11.511967645759277, 12.304403727425075 ], [ "2022-01-21T13:11:30Z", 11.488581675749048, 12.272260458006759 ] ] }, "hints": { "title": "Memory usage %" } }, "net_receive": { "data": { "cols": [ { "label": "time", "type": "date" }, { "label": "test-1 (master)", "type": "number" }, { "label": "test-2 (standby)", "type": "number" } ], "rows": [ [ "2022-01-21T13:10:30Z", 442, 470 ], [ "2022-01-21T13:11:00Z", 439, 384 ], [ "2022-01-21T13:11:30Z", 466, 458 ] ] }, "hints": { "title": "Network receive (bytes/s)" } }, "net_send": { "data": { "cols": [ { "label": "time", "type": "date" }, { "label": "test-1 (master)", "type": "number" }, { "label": "test-2 (standby)", "type": "number" } ], "rows": [ [ "2022-01-21T13:10:30Z", 672, 581 ], [ "2022-01-21T13:11:00Z", 660, 555 ], [ "2022-01-21T13:11:30Z", 694, 573 ] ] }, "hints": { "title": "Network transmit (bytes/s)" } } } ], "title": "MetricsResponse", "additionalProperties": { "$ref": "#/components/schemas/databaseMetricsItemResponse" }, "description": "Schema for metrics response." }, "databaseQueryStatisticsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "mysql": { "type": "array", "examples": [ [ { "avg_timer_wait": 12345, "count_star": 100, "digest": "abc123def456", "digest_text": "SELECT * FROM users WHERE id = ?", "first_seen": "2024-06-01T12:00:00Z", "last_seen": "2024-06-10T15:30:00Z" } ] ], "items": { "$ref": "#/components/schemas/databaseQueryStatisticsMysqlResponse" } }, "pg": { "type": "array", "examples": [ [ { "blk_read_time": 0, "blk_write_time": 0, "calls": 57425, "database_name": "defaultdb", "local_blks_dirtied": 0, "local_blks_hit": 0, "local_blks_read": 0, "local_blks_written": 0, "max_time": 133387, "mean_time": 1060, "min_time": 151, "query": "COMMIT", "rows": 0, "shared_blks_dirtied": 0, "shared_blks_hit": 0, "shared_blks_read": 0, "shared_blks_written": 0, "stddev_time": 0, "temp_blks_read": 0, "temp_blks_written": 0, "total_time": 60879904, "user_name": "upadmin" } ] ], "items": { "$ref": "#/components/schemas/databaseQueryStatisticsPgResponse" } } }, "title": "QueryStatisticsResponse", "description": "Schema for query statistics response." }, "databaseQueryStatisticsMysqlResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "avg_timer_wait": 12345, "count_star": 100, "digest": "abc123def456", "digest_text": "SELECT * FROM users WHERE id = ?", "first_seen": "2024-06-01T12:00:00Z", "last_seen": "2024-06-10T15:30:00Z", "max_timer_wait": 54321, "min_timer_wait": 100, "quantile_95": 20000, "quantile_99": 30000, "quantile_999": 40000, "query_sample_seen": "2024-06-05T10:00:00Z", "query_sample_text": "SELECT * FROM users WHERE id = 1", "query_sample_timer_wait": 15000, "schema_name": "my_database", "sum_created_tmp_disk_tables": 2, "sum_created_tmp_tables": 5, "sum_errors": 0, "sum_lock_time": 1000, "sum_no_good_index_used": 1, "sum_no_index_used": 3, "sum_rows_affected": 10, "sum_rows_examined": 1000, "sum_rows_sent": 500, "sum_select_full_join": 0, "sum_select_full_range_join": 0, "sum_select_range": 2, "sum_select_range_check": 0, "sum_select_scan": 4, "sum_sort_merge_passes": 1, "sum_sort_range": 2, "sum_sort_rows": 100, "sum_sort_scan": 3, "sum_timer_wait": 20000, "sum_warnings": 0 } ], "properties": { "avg_timer_wait": { "type": "integer", "format": "int32", "description": "Average wait time for the query.", "example": 12345 }, "count_star": { "type": "integer", "format": "int32", "description": "Total number of times the query was executed.", "example": 100 }, "digest": { "type": "string", "description": "Query digest hash.", "example": "abc123def456" }, "digest_text": { "type": "string", "description": "Normalized query text.", "example": "SELECT * FROM users WHERE id = ?" }, "first_seen": { "type": "string", "format": "date-time", "description": "Timestamp when the query was first seen.", "example": "2024-06-01T12:00:00Z" }, "last_seen": { "type": "string", "format": "date-time", "description": "Timestamp when the query was last seen.", "example": "2024-06-10T15:30:00Z" }, "max_timer_wait": { "type": "integer", "format": "int32", "description": "Maximum wait time for the query.", "example": 54321 }, "min_timer_wait": { "type": "integer", "format": "int32", "description": "Minimum wait time for the query.", "example": 100 }, "quantile_95": { "type": "integer", "format": "int32", "description": "95th percentile wait time.", "example": 20000 }, "quantile_99": { "type": "integer", "format": "int32", "description": "99th percentile wait time.", "example": 30000 }, "quantile_999": { "type": "integer", "format": "int32", "description": "99.9th percentile wait time.", "example": 40000 }, "query_sample_seen": { "type": "string", "format": "date-time", "description": "Timestamp when the sample query was seen.", "example": "2024-06-05T10:00:00Z" }, "query_sample_text": { "type": "string", "description": "Sample query text.", "example": "SELECT * FROM users WHERE id = 1" }, "query_sample_timer_wait": { "type": "integer", "format": "int32", "description": "Wait time for the sample query.", "example": 15000 }, "schema_name": { "type": "string", "description": "Name of the database schema.", "example": "my_database" }, "sum_created_tmp_disk_tables": { "type": "integer", "format": "int32", "description": "Total number of temporary disk tables created.", "example": 2 }, "sum_created_tmp_tables": { "type": "integer", "format": "int32", "description": "Total number of temporary tables created.", "example": 5 }, "sum_errors": { "type": "integer", "format": "int32", "description": "Total number of errors encountered.", "example": 0 }, "sum_lock_time": { "type": "integer", "format": "int32", "description": "Total lock time for the query.", "example": 1000 }, "sum_no_good_index_used": { "type": "integer", "format": "int32", "description": "Total number of times no good index was used.", "example": 1 }, "sum_no_index_used": { "type": "integer", "format": "int32", "description": "Total number of times no index was used.", "example": 3 }, "sum_rows_affected": { "type": "integer", "format": "int32", "description": "Total number of rows affected.", "example": 10 }, "sum_rows_examined": { "type": "integer", "format": "int32", "description": "Total number of rows examined.", "example": 1000 }, "sum_rows_sent": { "type": "integer", "format": "int32", "description": "Total number of rows sent.", "example": 500 }, "sum_select_full_join": { "type": "integer", "format": "int32", "description": "Total number of full joins performed.", "example": 0 }, "sum_select_full_range_join": { "type": "integer", "format": "int32", "description": "Total number of full range joins performed.", "example": 0 }, "sum_select_range": { "type": "integer", "format": "int32", "description": "Total number of range selects performed.", "example": 2 }, "sum_select_range_check": { "type": "integer", "format": "int32", "description": "Total number of range checks performed.", "example": 0 }, "sum_select_scan": { "type": "integer", "format": "int32", "description": "Total number of select scans performed.", "example": 4 }, "sum_sort_merge_passes": { "type": "integer", "format": "int32", "description": "Total number of sort merge passes.", "example": 1 }, "sum_sort_range": { "type": "integer", "format": "int32", "description": "Total number of sort range operations.", "example": 2 }, "sum_sort_rows": { "type": "integer", "format": "int32", "description": "Total number of rows sorted.", "example": 100 }, "sum_sort_scan": { "type": "integer", "format": "int32", "description": "Total number of sort scans performed.", "example": 3 }, "sum_timer_wait": { "type": "integer", "format": "int32", "description": "Total wait time for the query.", "example": 20000 }, "sum_warnings": { "type": "integer", "format": "int32", "description": "Total number of warnings generated.", "example": 0 } }, "title": "QueryStatisticsMysqlResponse", "description": "Schema for MySQL query statistics response." }, "databaseQueryStatisticsPgResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "blk_read_time": 120, "blk_write_time": 45, "calls": 10, "database_name": "mydb", "local_blks_dirtied": 2, "local_blks_hit": 100, "local_blks_read": 5, "local_blks_written": 3, "max_time": 300, "mean_time": 150, "min_time": 100, "query": "SELECT * FROM users WHERE id = 1", "rows": 20, "shared_blks_dirtied": 4, "shared_blks_hit": 200, "shared_blks_read": 8, "shared_blks_written": 6, "stddev_time": 20, "temp_blks_read": 1, "temp_blks_written": 1, "total_time": 1500, "user_name": "postgres" } ], "properties": { "blk_read_time": { "type": "integer", "format": "int32", "description": "Time spent reading data blocks, in milliseconds.", "example": 120 }, "blk_write_time": { "type": "integer", "format": "int32", "description": "Time spent writing data blocks, in milliseconds.", "example": 45 }, "calls": { "type": "integer", "format": "int32", "description": "Number of times the query was executed.", "example": 10 }, "database_name": { "type": "string", "description": "Name of the database.", "example": "mydb" }, "local_blks_dirtied": { "type": "integer", "format": "int32", "description": "Number of local blocks dirtied.", "example": 2 }, "local_blks_hit": { "type": "integer", "format": "int32", "description": "Number of local block cache hits.", "example": 100 }, "local_blks_read": { "type": "integer", "format": "int32", "description": "Number of local blocks read.", "example": 5 }, "local_blks_written": { "type": "integer", "format": "int32", "description": "Number of local blocks written.", "example": 3 }, "max_time": { "type": "integer", "format": "int32", "description": "Maximum execution time, in milliseconds.", "example": 300 }, "mean_time": { "type": "integer", "format": "int32", "description": "Mean execution time, in milliseconds.", "example": 150 }, "min_time": { "type": "integer", "format": "int32", "description": "Minimum execution time, in milliseconds.", "example": 100 }, "query": { "type": "string", "description": "The SQL query text.", "example": "SELECT * FROM users WHERE id = 1" }, "rows": { "type": "integer", "format": "int32", "description": "Total number of rows returned or affected.", "example": 20 }, "shared_blks_dirtied": { "type": "integer", "format": "int32", "description": "Number of shared blocks dirtied.", "example": 4 }, "shared_blks_hit": { "type": "integer", "format": "int32", "description": "Number of shared block cache hits.", "example": 200 }, "shared_blks_read": { "type": "integer", "format": "int32", "description": "Number of shared blocks read.", "example": 8 }, "shared_blks_written": { "type": "integer", "format": "int32", "description": "Number of shared blocks written.", "example": 6 }, "stddev_time": { "type": "integer", "format": "int32", "description": "Standard deviation of execution time, in milliseconds.", "example": 20 }, "temp_blks_read": { "type": "integer", "format": "int32", "description": "Number of temporary blocks read.", "example": 1 }, "temp_blks_written": { "type": "integer", "format": "int32", "description": "Number of temporary blocks written.", "example": 1 }, "total_time": { "type": "integer", "format": "int32", "description": "Total execution time, in milliseconds.", "example": 1500 }, "user_name": { "type": "string", "description": "Name of the user who executed the query.", "example": "postgres" } }, "title": "QueryStatisticsPgResponse", "description": "Schema for PostgreSQL query statistics response." }, "databaseLogListResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "first_log_offset": "123456", "offset": "123460", "logs": [ { "hostname": "upcloud-doc-hostname", "msg": "[10-1] pid=3328089,user=postgres,db=defaultdb,app=[unknown],client=[local] LOG: connection authorized: user=postgres database=defaultdb", "time": "2022-01-21T13:07:23.687241Z", "service": "postgresql-13.service" } ] } ], "properties": { "first_log_offset": { "type": "string", "description": "Offset of the first log entry in the list.", "example": "123456" }, "offset": { "type": "string", "description": "Current offset for pagination.", "example": "123460" }, "logs": { "type": "array", "items": { "$ref": "#/components/schemas/databaseLogEntryResponse" }, "description": "Array of log entries from UpCloud services.", "example": [ { "hostname": "upc-pg-1a2b3c4d5e", "msg": "UpCloud PostgreSQL backup completed successfully", "time": "2024-06-12T14:23:00Z", "service": "upcloud-pg" } ] } }, "title": "LogListResponse", "description": "Schema representing a paginated list of log entries from UpCloud services." }, "databaseLogEntryResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "hostname": "api-doc-hostname", "msg": "[10-1] pid=3328089,user=postgres,db=defaultdb,app=[unknown],client=[local] LOG: connection authorized: user=postgres database=defaultdb", "time": "2022-01-21T13:07:23.687241Z", "service": "postgresql-13.service" } ], "properties": { "hostname": { "type": "string", "description": "The name of the UpCloud service host where the log entry originated.", "example": "api-doc-hostname" }, "msg": { "type": "string", "description": "The log message content.", "example": "[10-1] pid=3328089,user=postgres,db=defaultdb,app=[unknown],client=[local] LOG: connection authorized: user=postgres database=defaultdb" }, "time": { "type": "string", "format": "date-time", "description": "Timestamp of the log entry.", "example": "2022-01-21T13:07:23.687241Z" }, "service": { "type": "string", "description": "Name of the UpCloud service that generated the log entry.", "example": "postgresql-13.service" } }, "title": "LogEntryResponse", "description": "Schema representing a log entry from an UpCloud service." }, "databaseConnectionPoolsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/databaseConnectionPoolResponse" }, "title": "ConnectionPoolsResponse", "description": "An array of connection pool response objects." }, "databaseIndexesResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "create_time": "2023-05-11T13:24:10.623Z", "docs": 1, "health": "green", "index_name": ".kibana_1", "number_of_replicas": 0, "number_of_shards": 1, "read_only_allow_delete": false, "size": 5313, "status": "open" } ], [ { "create_time": "2023-05-11T13:24:10.623Z", "docs": 1, "health": "green", "index_name": ".kibana_1", "number_of_replicas": 0, "number_of_shards": 1, "read_only_allow_delete": false, "size": 5313, "status": "open" }, { "create_time": "2023-05-11T13:24:10.623Z", "docs": 42, "health": "yellow", "index_name": "logs-2023.05.11", "number_of_replicas": 1, "number_of_shards": 3, "read_only_allow_delete": false, "size": 1048576, "status": "open" } ] ], "items": { "$ref": "#/components/schemas/databaseIndexResponse" }, "title": "IndexesResponse", "description": "Response schema for indexes" }, "databaseIndexResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "create_time": "2023-05-11T13:24:10.623Z", "docs": 1, "health": "green", "index_name": ".kibana_1", "number_of_replicas": 0, "number_of_shards": 1, "read_only_allow_delete": false, "size": 5313, "status": "open" } ], "properties": { "create_time": { "type": "string", "format": "date-time", "description": "Creation time of the index.", "example": "2023-05-11T13:24:10.623Z" }, "docs": { "type": "integer", "format": "int32", "description": "Number of documents in the index.", "example": 1 }, "health": { "type": "string", "description": "Health status of the index.", "example": "green" }, "index_name": { "type": "string", "description": "Name of the index.", "example": ".kibana_1" }, "number_of_replicas": { "type": "integer", "format": "int32", "description": "Number of replicas for the index.", "example": 1 }, "number_of_shards": { "type": "integer", "format": "int32", "description": "Number of shards for the index.", "example": 1 }, "read_only_allow_delete": { "type": "boolean", "description": "Indicates if the index is read-only and allows deletion.", "example": false }, "size": { "type": "integer", "format": "int32", "description": "Size of the index in bytes.", "example": 5313 }, "status": { "type": "string", "description": "Status of the index.", "example": "open" } }, "title": "IndexResponse", "description": "Schema representing the details of an index." }, "databaseServiceIntegrationsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/databaseServiceIntegrationResponse" }, "title": "ServiceIntegrationsResponse", "description": "Schema for a list of service integrations" }, "databaseServiceNetworkDetailsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "create_time": "2023-10-05T14:48:00.000Z", "update_time": "2023-10-05T14:48:00.000Z", "state": "active", "network_peerings": [ { "create_time": "2023-10-05T14:48:00.000Z", "update_time": "2023-10-05T14:48:00.000Z", "network_peer": "03196597-b972-4815-ba3a-85bb18365ced", "state": "active", "state_info": "The peering is in active state." } ] } ], "properties": { "create_time": { "type": [ "string", "null" ], "examples": [ "2023-10-05T14:48:00.000Z" ], "format": "date-time", "description": "The creation time of the service network." }, "update_time": { "type": [ "string", "null" ], "examples": [ "2023-10-05T14:48:00.000Z" ], "format": "date-time", "description": "The last update time of the service network." }, "state": { "type": "string", "examples": [ "active" ], "description": "The current state of the service network." }, "network_peerings": { "type": "array", "items": { "$ref": "#/components/schemas/databasePeeringStatusResponse" } } }, "title": "ServiceNetworkDetailsResponse", "description": "Schema for service network details response" }, "databasePeeringStatusResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "create_time": "2023-10-05T14:48:00.000Z", "update_time": "2023-10-05T14:48:00.000Z", "network_peer": "03196597-b972-4815-ba3a-85bb18365ced", "state": "active", "state_info": "The peering is in active state." } ], "properties": { "create_time": { "type": "string", "format": "date-time", "description": "The time when the peering status was created.", "example": "2023-10-05T14:48:00.000Z" }, "update_time": { "type": "string", "format": "date-time", "description": "The time when the peering status was last updated.", "example": "2023-10-05T14:48:00.000Z" }, "network_peer": { "type": "string", "format": "uuid", "description": "The UUID of the network peer.", "example": "03196597-b972-4815-ba3a-85bb18365ced" }, "state": { "type": "string", "description": "The current state of the peering connection.", "example": "active" }, "state_info": { "type": "string", "description": "Additional information about the current state of the peering connection.", "example": "The peering is in active state." } }, "title": "PeeringStatusResponse", "description": "Schema for peering status response." }, "databaseCurrentSessionsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "pg": { "type": "array", "items": { "$ref": "#/components/schemas/databasePgCurrentSessionResponse" } }, "mysql": { "type": "array", "items": { "$ref": "#/components/schemas/databaseMysqlCurrentSessionResponse" } }, "redis": { "type": "array", "items": { "$ref": "#/components/schemas/databaseRedisValkeyCurrentSessionResponse" } }, "valkey": { "type": "array", "items": { "$ref": "#/components/schemas/databaseRedisValkeyCurrentSessionResponse" } } }, "title": "CurrentSessionsResponse", "description": "Schema for representing current sessions for various services" }, "databasePgCurrentSessionResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "application_name": "client 1.5.14", "backend_start": "2025-09-21T12:34:56Z", "backend_type": "client backend", "backend_xid": 742, "backend_xmin": 731, "client_addr": "198.51.100.42", "client_hostname": "app-host.example.internal", "client_port": 52344, "datid": 16384, "datname": "defaultdb", "id": "3328089", "query": "SELECT name, setting FROM pg_settings WHERE source = $1", "query_duration": "00:00:01.234", "query_start": "2025-09-21T12:35:10Z", "state": "active", "state_change": "2025-09-21T12:35:10Z", "usename": "upadmin", "usesysid": 10, "wait_event": "ClientRead", "wait_event_type": "Client", "xact_start": "2025-09-21T12:35:05Z" } ], "properties": { "application_name": { "type": "string", "description": "Name of the application that is connected to this service.", "example": "client 1.5.14" }, "backend_start": { "type": "string", "format": "date-time", "description": "Time when this process was started (when the client connected).", "example": "2025-09-21T12:34:56Z" }, "backend_type": { "type": "string", "description": "Type of current service (e.g., client backend).", "example": "client backend" }, "backend_xid": { "type": "integer", "format": "int32", "description": "Top-level transaction identifier of this service, if any.", "example": 742 }, "backend_xmin": { "type": "integer", "format": "int32", "description": "The current service's xmin horizon.", "example": 731 }, "client_addr": { "type": "string", "description": "IP address of the connected client.", "example": "198.51.100.42" }, "client_hostname": { "type": "string", "description": "Hostname of the connected client (reverse DNS of client_addr).", "example": "app-host.example.internal" }, "client_port": { "type": "integer", "format": "int32", "description": "TCP port number used by the client, or -1 if a Unix socket is used.", "example": 52344 }, "datid": { "type": "integer", "format": "int32", "description": "OID of the database this service is connected to.", "example": 16384 }, "datname": { "type": "string", "description": "Name of the database this service is connected to.", "example": "defaultdb" }, "id": { "type": "string", "description": "Process ID of this service.", "example": "3328089" }, "query": { "type": "string", "description": "Most recent query. If state is active, this is the currently executing query.", "example": "SELECT name, setting FROM pg_settings WHERE source = $1" }, "query_duration": { "type": "string", "description": "The active query's current duration (as a string).", "example": "00:00:01.234" }, "query_start": { "type": "string", "format": "date-time", "description": "Time when the currently active (or last) query started.", "example": "2025-09-21T12:35:10Z" }, "state": { "type": "string", "description": "Overall state of this service (e.g., 'active' or 'idle').", "example": "active" }, "state_change": { "type": "string", "format": "date-time", "description": "Time when the state was last changed.", "example": "2025-09-21T12:35:10Z" }, "usename": { "type": "string", "description": "Name of the user logged into this service.", "example": "upadmin" }, "usesysid": { "type": "integer", "format": "int32", "description": "OID of the user logged into this service.", "example": 10 }, "wait_event": { "type": "string", "description": "Wait event name if the service is currently waiting.", "example": "ClientRead" }, "wait_event_type": { "type": "string", "description": "Type of event for which the service is waiting (if any).", "example": "Client" }, "xact_start": { "type": "string", "format": "date-time", "description": "Time when the current transaction started.", "example": "2025-09-21T12:35:05Z" } }, "title": "PgCurrentSessionResponse", "description": "Schema for PostgreSQL current session response." }, "databaseMysqlCurrentSessionResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "application_name": "my-app", "client_addr": "198.51.100.23", "datname": "defaultdb", "id": "3159", "query": "SELECT 1", "query_duration": 125000000, "state": "active", "usename": "appuser" } ], "properties": { "application_name": { "type": "string", "description": "Name of the application that is connected to this service.", "example": "my-app" }, "client_addr": { "type": "string", "description": "IP address of the client connected to this service.", "example": "198.51.100.23" }, "datname": { "type": "string", "description": "Name of the database this service is connected to.", "example": "defaultdb" }, "id": { "type": "string", "description": "Process ID of this service.", "example": "3159" }, "query": { "type": "string", "description": "Text of this service's most recent query. If state is active this shows the currently executing query; otherwise an empty string.", "example": "SELECT 1" }, "query_duration": { "type": "integer", "format": "int64", "description": "The active query’s current duration, serialized as nanoseconds.", "example": 125000000 }, "state": { "type": "string", "description": "Current overall state of this service. Allowed values include: active (executing a query) and idle (waiting for a new client command).", "example": "active" }, "usename": { "type": "string", "description": "Name of the user logged into this service.", "example": "appuser" } }, "title": "MysqlCurrentSessionResponse", "description": "Schema for the current session of a MySQL service." }, "databaseRedisValkeyCurrentSessionResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "active_channel_subscriptions": 2, "active_database": 0, "active_pattern_matching_channel_subscriptions": 1, "application_name": "my-app", "client_addr": "[fff0:fff0:fff0:fff0:0:fff0:fff0:fff0]:39956", "connection_age": 2079483000000000, "connection_idle": 3000000000, "flags": [ "N", "U" ], "flags_raw": "NU", "id": 15, "multi_exec_commands": -1, "output_buffer": 0, "output_buffer_memory": 0, "output_list_length": 0, "query": "info", "query_buffer": 0, "query_buffer_free": 0 } ], "properties": { "active_channel_subscriptions": { "type": "integer", "format": "int32", "description": "Number of active channel subscriptions.", "example": 2 }, "active_database": { "type": "integer", "format": "int32", "description": "Current database ID.", "example": 0 }, "active_pattern_matching_channel_subscriptions": { "type": "integer", "format": "int32", "description": "Number of pattern matching subscriptions.", "example": 1 }, "application_name": { "type": "string", "description": "Name of the application that is connected to this service.", "example": "my-app" }, "client_addr": { "type": "string", "description": "IP address of the client connected to this service.", "example": "[fff0:fff0:fff0:fff0:0:fff0:fff0:fff0]:39956" }, "connection_age": { "type": "integer", "format": "int32", "description": "Total duration of the connection in nanoseconds.", "example": 2079483000000000 }, "connection_idle": { "type": "integer", "format": "int32", "description": "Idle time of the connection in nanoseconds.", "example": 3000000000 }, "flags": { "type": "array", "items": { "type": "string" }, "description": "List of flags describing the client connection.", "example": [ "N", "U" ] }, "flags_raw": { "type": "string", "description": "Client connection flags (raw string).", "example": "NU" }, "id": { "type": "integer", "format": "int32", "description": "Process ID of this session.", "example": 15 }, "multi_exec_commands": { "type": "integer", "format": "int32", "description": "Number of commands in a MULTI/EXEC context.", "example": -1 }, "output_buffer": { "type": "integer", "format": "int32", "description": "Output buffer length.", "example": 0 }, "output_buffer_memory": { "type": "integer", "format": "int32", "description": "Output buffer memory usage.", "example": 0 }, "output_list_length": { "type": "integer", "format": "int32", "description": "Output list length (replies queued when buffer is full).", "example": 0 }, "query": { "type": "string", "description": "The last executed command.", "example": "info" }, "query_buffer": { "type": "integer", "format": "int32", "description": "Query buffer length (0 means no query pending).", "example": 0 }, "query_buffer_free": { "type": "integer", "format": "int32", "description": "Free space of the query buffer (0 means the buffer is full).", "example": 0 } }, "title": "RedisValkeyCurrentSessionResponse", "description": "Schema for Redis Valkey current session response." }, "databaseTerminateSessionResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "success": true } ], "properties": { "success": { "type": "boolean", "description": "Indicates whether the session termination was successful.", "example": true } }, "title": "TerminateSessionResponse", "description": "Schema for the response received after terminating a session" }, "databaseServiceTaskResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "allOf": [ { "$ref": "#/components/schemas/databaseServiceTaskBaseResponse" }, { "type": "object", "properties": { "operation_type": { "type": "string", "description": "The type of operation being performed.", "example": "async" } } } ], "examples": [ { "create_time": "2022-10-04T12:21:42Z", "operation": "mysql_migration_check", "id": "9b39f10d-e356-437b-b907-d6d5574721b2", "result_codes": [], "result": "All pre-checks passed successfully, preferred migration method will be [Replication]", "success": true, "operation_type": "async" } ], "title": "ServiceTaskResponse", "description": "Response schema for retrieving information about a service task, including the operation type." }, "databaseServiceTaskBaseResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "create_time": "2022-10-04T12:21:42Z", "operation": "mysql_migration_check", "id": "9b39f10d-e356-437b-b907-d6d5574721b2", "result_codes": [], "result": "All pre-checks passed successfully, preferred migration method will be [Replication]", "success": true } ], "properties": { "create_time": { "type": "string", "format": "date-time", "description": "The time when the service task was created", "example": "2022-10-04T12:21:42Z" }, "result": { "type": "string", "description": "Optional result message", "example": "All pre-checks passed successfully, preferred migration method will be [Replication]" }, "result_codes": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "description": "Optional list of result codes as key-value maps" }, "ignore_dbs": { "type": "string", "examples": [ "defaultdb" ], "description": "Optional list of databases to ignore" }, "operation": { "type": "string", "description": "The operation being performed", "example": "mysql_migration_check" }, "success": { "type": "boolean", "description": "Indicates if the operation was successful", "example": true }, "method": { "type": "string", "description": "Optional method used for the operation", "example": "Replication" }, "source_pg_version": { "type": "string", "description": "Optional source PostgreSQL version", "example": "13" }, "target_pg_version": { "type": "string", "description": "Optional target PostgreSQL version", "example": "14" }, "id": { "type": "string", "format": "uuid", "description": "Optional identifier for the task", "example": "9b39f10d-e356-437b-b907-d6d5574721b2" } }, "title": "ServiceTaskBaseResponse", "additionalProperties": false, "description": "Schema for representing a service task response" }, "databaseServiceTaskDetailsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "allOf": [ { "$ref": "#/components/schemas/databaseServiceTaskBaseResponse" }, { "type": "object", "properties": { "result_codes": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } }, "result": { "type": "string", "description": "A human-readable summary of the task result.", "example": "ok *Clusters are compatible*" }, "success": { "type": "boolean", "description": "Indicates whether the task completed successfully.", "example": true } } } ], "title": "ServiceTaskDetailsResponse", "description": "Response schema for retrieving detailed information about a specific service task, including result codes and success status." }, "databaseUsersResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "username": "admin", "password": "my-password", "authentication": "caching_sha2_password", "type": "admin" } ] ], "items": { "$ref": "#/components/schemas/databaseUserResponse" }, "title": "UsersResponse", "description": "Schema for the response containing a list of users" }, "gatewayMetricsDetailsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "gateway-service", "active_connections": 0, "created_at": "2025-03-26T12:34:56Z", "updated_at": "2025-03-26T12:34:56Z", "total_accepted_connections": 0, "total_rejected_sessions": 0 } ], "properties": { "name": { "type": "string", "examples": [ "gateway-service", "vpn-tunnel-1" ], "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the gateway" }, "active_connections": { "type": "integer", "examples": [ 0 ], "format": "int64", "description": "Number of active connections" }, "created_at": { "type": "string", "examples": [ "2025-03-26T12:34:56Z" ], "format": "date-time", "description": "Timestamp of when the metrics was created." }, "updated_at": { "type": "string", "examples": [ "2025-03-26T12:34:56Z" ], "format": "date-time", "description": "Timestamp of when the metrics was last updated." }, "total_accepted_connections": { "type": "integer", "examples": [ 0 ], "format": "int64", "description": "Number of accepted connections" }, "total_rejected_sessions": { "type": "integer", "examples": [ 0 ], "format": "int64", "description": "Number of rejected sessions" } }, "title": "Gateway metrics details response", "description": "Response schema for gateway metrics details." }, "gatewayQueryParamLimit": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "examples": [ 10, 25, 50, 100 ], "title": "Query param limit", "maximum": 100, "minimum": 0, "format": "int64", "description": "Schema for a query parameter specifying the maximum number of entries to return (limit).", "default": 10 }, "gatewayQueryParamOffset": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "examples": [ 0, 10, 20, 50 ], "title": "Query param offset", "minimum": 0, "format": "int64", "description": "Schema for a query parameter specifying the offset for pagination.", "default": 0 }, "gatewayName": { "type": "string", "examples": [ "advanced", "development" ], "title": "Name", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "The name for the resource." }, "gatewayUuid": { "type": "string", "examples": [ "01234567-89ab-cdef-0123-456789abcdef", "fedcba98-7654-3210-fedc-ba9876543210" ], "title": "UUID", "format": "uuid", "description": "The unique identifier for the resource." }, "gatewayServiceOperationalState": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "pending" ], "title": "Service operational state", "enum": [ "pending", "setup-agent", "setup-link-network", "setup-service", "setup-network", "setup-gw", "checkup", "setup-dns", "running", "stopped", "delete-dns", "delete-gw", "delete-network", "delete-server", "delete-link-network", "delete-service", "detach-link-network" ], "description": "Service operational state" }, "gatewayServiceConfiguredStatus": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "started" ], "title": "Service configured status", "enum": [ "started", "stopped" ], "description": "Service configured status" }, "gatewayServiceFeatures": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "nat" ], "title": "Service features", "enum": [ "nat", "vpn" ], "description": "Service features" }, "gatewayQueryParamSortServices": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "-created_at", "name", "-uuid" ], "title": "Query param sort services", "enum": [ "created_at", "-created_at", "name", "-name", "uuid", "-uuid" ], "description": "Sort services by field. Prefix with '-' for descending order." }, "gatewayLabelKey": { "type": "string", "examples": [ "environment", "team", "project", "purpose", "cost-center" ], "title": "Label key", "maxLength": 32, "minLength": 2, "pattern": "^[\\x20-\\x5E\\x60-\\x7E][\\x20-\\x7E]+$", "description": "The key of a label." }, "gatewayServiceCreateRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "gateway-service", "plan": "development-gwaas-1c2g", "zone": "fi-hel1", "features": [], "routers": [], "addresses": [], "connections": [], "labels": [], "configured_status": "started", "automatic_tunnel_internal_ip_allocation": true } ], "properties": { "name": { "type": "string", "examples": [ "gateway-service", "vpn-tunnel-1" ], "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the service" }, "plan": { "type": "string", "examples": [ "development-gwaas-1c2g" ], "description": "Plan" }, "zone": { "type": "string", "examples": [ "fi-hel1" ], "pattern": "^[a-z]{2}-[a-z]{3}\\d$", "description": "Zone" }, "features": { "type": "array", "examples": [ [ "nat" ] ], "items": { "$ref": "#/components/schemas/gatewayServiceFeatures" }, "minItems": 1, "description": "Active features" }, "routers": { "type": "array", "examples": [ [ { "uuid": "fedcba98-7654-3210-fedc-ba9876543210" } ] ], "items": { "$ref": "#/components/schemas/gatewayRouterCreateRequest" }, "maxItems": 1, "minItems": 1, "description": "Service routers" }, "addresses": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayAddressCreateRequest" }, "maxItems": 2, "description": "Service addresses" }, "connections": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayConnectionCreateRequest" }, "description": "Service connections" }, "labels": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayLabelCreateRequest" }, "maxItems": 255, "description": "Labels" }, "configured_status": { "$ref": "#/components/schemas/gatewayServiceConfiguredStatus" }, "automatic_tunnel_internal_ip_allocation": { "type": "boolean", "examples": [ true, false ], "description": "Allocate and use tunnel internal IPs automatically", "default": true } }, "title": "Service create request", "required": [ "name", "plan", "zone", "features", "routers", "configured_status" ], "additionalProperties": false, "description": "Gateway service" }, "gatewayRouterCreateRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "uuid": "01234567-89ab-cdef-0123-456789abcdef" } ], "properties": { "uuid": { "$ref": "#/components/schemas/gatewayUuid" } }, "title": "Router create request", "required": [ "uuid" ], "additionalProperties": false, "description": "Network gateway router" }, "gatewayAddressCreateRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "gateway-service" } ], "properties": { "name": { "type": "string", "examples": [ "gateway-service", "vpn-tunnel-1" ], "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the address" }, "address": { "type": "string", "examples": [ "203.0.113.10" ], "format": "ipv4", "description": "Floating IP address" } }, "title": "Address create request", "required": [ "name" ], "additionalProperties": false, "description": "Gateway address" }, "gatewayConnectionCreateRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "gateway-service", "type": "ipsec", "local_routes": [], "remote_routes": [], "tunnels": [] } ], "properties": { "uuid": { "$ref": "#/components/schemas/gatewayUuid" }, "name": { "type": "string", "examples": [ "gateway-service", "vpn-tunnel-1" ], "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the connection" }, "type": { "$ref": "#/components/schemas/gatewayConnectionType" }, "local_routes": { "type": "array", "examples": [ [ { "name": "upcloud-example-route", "type": "static", "static_network": "10.0.0.0/24" } ] ], "items": { "$ref": "#/components/schemas/gatewayConnectionRouteRequest" }, "description": "Connection local routes" }, "remote_routes": { "type": "array", "examples": [ [ { "name": "remote-example-route", "type": "static", "static_network": "10.0.1.0/24" } ] ], "items": { "$ref": "#/components/schemas/gatewayConnectionRouteRequest" }, "description": "Connection remote routes" }, "tunnels": { "type": "array", "examples": [ [ { "name": "example-tunnel-1", "local_address": { "name": "public-ip-1" }, "remote_address": { "address": "100.10.0.111" }, "ipsec": { "authentication": { "authentication": "psk", "psk": "{your PSK}" } }, "tunnel_internal_ip": "169.254.17.1", "internal_peer_ping_interval": 0 } ] ], "items": { "$ref": "#/components/schemas/gatewayTunnelCreateRequest" }, "description": "Connection tunnels" } }, "title": "Connection create request", "required": [ "name", "type" ], "additionalProperties": false, "description": "Network gateway VPN connection" }, "gatewayConnectionType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "ipsec" ], "title": "Connection type", "enum": [ "ipsec" ], "description": "Connection type" }, "gatewayConnectionRouteRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "gateway-service", "type": "static", "static_network": "10.0.0.0/24" } ], "properties": { "name": { "type": "string", "examples": [ "gateway-service", "vpn-tunnel-1" ], "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Route name" }, "type": { "$ref": "#/components/schemas/gatewayConnectionRouteType" }, "static_network": { "type": "string", "examples": [ "10.0.0.0/24" ], "description": "Static network subnet" } }, "title": "Connection route request", "required": [ "name", "type", "static_network" ], "additionalProperties": false, "description": "Network gateway VPN connection route" }, "gatewayConnectionRouteType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "static" ], "title": "Connection route type", "enum": [ "static" ], "description": "Connection route type" }, "gatewayTunnelCreateRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "gateway-service", "local_address": { "name": "gateway-service" }, "remote_address": { "address": "203.0.113.10" }, "ipsec": { "authentication": { "type": "psk", "psk": "MySecretPsk123" }, "phase1_algorithms": [], "phase2_algorithms": [], "phase1_integrity_algorithms": [], "phase2_integrity_algorithms": [], "phase1_dh_group_numbers": [], "phase2_dh_group_numbers": [] }, "tunnel_internal_ip": "10.0.0.1", "internal_peer_ping_interval": 0 } ], "properties": { "uuid": { "$ref": "#/components/schemas/gatewayUuid" }, "name": { "type": "string", "examples": [ "gateway-service", "vpn-tunnel-1" ], "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the tunnel" }, "local_address": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "gateway-service", "vpn-tunnel-1" ], "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the local peer address" } }, "description": "Local peer address" }, "remote_address": { "type": "object", "properties": { "address": { "type": "string", "examples": [ "203.0.113.10" ], "maxLength": 64, "minLength": 1, "description": "Remote peer address" } }, "description": "Remote peer address" }, "ipsec": { "type": "object", "properties": { "authentication": { "type": "object", "properties": { "authentication": { "$ref": "#/components/schemas/gatewayIpsecAuthenticationType" }, "psk": { "type": "string", "examples": [ "MySecretPsk123" ], "maxLength": 64, "minLength": 8, "pattern": "^[a-zA-Z1-9_.][a-zA-Z0-9_.]+$", "description": "IPsec PSK" } }, "required": [ "authentication", "psk" ], "additionalProperties": false, "description": "IPsec authentication configuration" }, "phase1_algorithms": { "type": "array", "examples": [ [ "aes128", "aes256", "aes128gcm128", "aes256gcm128" ] ], "items": { "$ref": "#/components/schemas/gatewaySupportedProposalAlgorithms" }, "uniqueItems": true, "description": "Phase 1 proposal algorithms", "default": [ "aes128", "aes256", "aes128gcm128", "aes256gcm128" ] }, "phase2_algorithms": { "type": "array", "examples": [ [ "aes128", "aes256", "aes128gcm128", "aes256gcm128" ] ], "items": { "$ref": "#/components/schemas/gatewaySupportedProposalAlgorithms" }, "uniqueItems": true, "description": "Phase 2 security association algorithms", "default": [ "aes128", "aes256", "aes128gcm128", "aes256gcm128" ] }, "phase1_integrity_algorithms": { "type": "array", "examples": [ [ "sha256", "sha384", "sha512" ] ], "items": { "$ref": "#/components/schemas/gatewaySupportedIntegrityAlgorithms" }, "uniqueItems": true, "description": "Phase 1 integrity algorithms", "default": [ "sha256", "sha384", "sha512" ] }, "phase2_integrity_algorithms": { "type": "array", "examples": [ [ "sha256", "sha384", "sha512" ] ], "items": { "$ref": "#/components/schemas/gatewaySupportedIntegrityAlgorithms" }, "uniqueItems": true, "description": "Phase 2 integrity algorithms", "default": [ "sha256", "sha384", "sha512" ] }, "phase1_dh_group_numbers": { "type": "array", "examples": [ [ 16, 18, 19 ] ], "items": { "$ref": "#/components/schemas/gatewayDiffieHellmanGroupNumber" }, "uniqueItems": true, "description": "Phase 1 Diffie-Hellman group numbers", "default": [ 14, 16, 18, 19, 20, 21 ] }, "phase2_dh_group_numbers": { "type": "array", "examples": [ [ 14, 16, 18, 19 ] ], "items": { "$ref": "#/components/schemas/gatewayDiffieHellmanGroupNumber" }, "uniqueItems": true, "description": "Phase 2 Diffie-Hellman group numbers", "default": [ 14, 16, 18, 19, 20, 21 ] }, "ike_lifetime": { "type": "integer", "examples": [ 86400 ], "maximum": 2147483647, "minimum": 0, "format": "int32", "description": "Maximum IKE SA lifetime in seconds", "default": 86400 }, "rekey_time": { "type": "integer", "examples": [ 14400 ], "maximum": 2147483647, "minimum": 0, "format": "int32", "description": "IKE SA rekey time in seconds", "default": 14400 }, "child_rekey_time": { "type": "integer", "examples": [ 1440 ], "maximum": 2147483647, "minimum": 0, "format": "int32", "description": "IKE child SA rekey time in seconds", "default": 1440 }, "dpd_delay": { "type": "integer", "examples": [ 30 ], "maximum": 2147483647, "minimum": 0, "format": "int32", "description": "Delay before sending Dead Peer Detection packets if no traffic is detected, in seconds", "default": 30 }, "dpd_timeout": { "type": "integer", "examples": [ 120 ], "maximum": 2147483647, "minimum": 0, "format": "int32", "description": "Timeout period for DPD reply before considering the peer to be dead, in seconds", "default": 120 } }, "required": [ "authentication" ], "additionalProperties": false, "description": "IPsec configuration" }, "tunnel_internal_ip": { "type": "string", "examples": [ "169.254.17.1", "" ], "maxLength": 64, "description": "Tunnel internal IP address, \"\" if disabled", "default": "" }, "internal_peer_ping_interval": { "type": "integer", "examples": [ 0 ], "format": "int64", "description": "Internal peer ping interval in seconds, or zero if disabled", "default": 0 } }, "title": "Tunnel create request", "required": [ "name", "ipsec", "local_address", "remote_address" ], "additionalProperties": false, "description": "Network gateway VPN connection tunnel" }, "gatewayIpsecAuthenticationType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "psk" ], "title": "IPsec authentication type", "enum": [ "psk" ], "description": "IPsec authentication type" }, "gatewaySupportedProposalAlgorithms": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "aes128gcm16" ], "title": "Supported proposal algorithms", "enum": [ "aes128gcm16", "aes128gcm128", "aes192gcm16", "aes192gcm128", "aes256gcm16", "aes256gcm128", "aes128", "aes192", "aes256" ], "description": "List of supported IPsec proposal algorithms" }, "gatewaySupportedIntegrityAlgorithms": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "sha1" ], "title": "Supported integrity algorithms", "enum": [ "aes128gmac", "aes256gmac", "sha1", "sha256", "sha384", "sha512" ], "description": "List of supported IPsec integrity algorithms" }, "gatewayDiffieHellmanGroupNumber": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "examples": [ 2, 5, 14 ], "title": "Diffie-Hellman group number", "format": "int64", "enum": [ 2, 5, 14, 15, 16, 18, 19, 20, 21, 24 ], "description": "Diffie-Hellman group number" }, "gatewayLabelCreateRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "key": "environment", "value": "production" } ], "properties": { "key": { "$ref": "#/components/schemas/gatewayLabelKey" }, "value": { "$ref": "#/components/schemas/gatewayLabelValue" } }, "title": "Label create request", "required": [ "key", "value" ], "additionalProperties": false, "description": "Gateway label" }, "gatewayLabelValue": { "type": "string", "examples": [ "production", "backend", "web-app", "backup", "engineering" ], "title": "Label value", "maxLength": 255, "pattern": "\\A[\\p{L}\\p{N}\\p{P}\\p{S}\\p{M}\\p{Z}]*\\z", "description": "The value of a label.", "nullable": true }, "gatewayServiceReplaceRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "gateway-service", "plan": "development-gwaas-1c2g", "configured_status": "started", "labels": [], "automatic_tunnel_internal_ip_allocation": true } ], "properties": { "name": { "type": "string", "examples": [ "gateway-service", "vpn-tunnel-1" ], "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the service" }, "plan": { "type": "string", "examples": [ "development-gwaas-1c2g" ], "description": "Plan" }, "configured_status": { "$ref": "#/components/schemas/gatewayServiceConfiguredStatus" }, "connections": { "description": "Service connections" }, "labels": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayLabelCreateRequest" }, "maxItems": 255, "description": "Labels" }, "automatic_tunnel_internal_ip_allocation": { "type": "boolean", "examples": [ true, false ], "description": "Allocate and use tunnel internal IPs automatically" } }, "title": "Service replace request", "required": [ "name", "configured_status" ], "additionalProperties": false, "description": "Request to replace a gateway service" }, "gatewayServiceModifyRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "gateway-service", "features": [], "plan": "development-gwaas-1c2g", "configured_status": "started", "connections": [], "labels": [], "automatic_tunnel_internal_ip_allocation": true } ], "properties": { "name": { "type": "string", "examples": [ "gateway-service", "vpn-tunnel-1" ], "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the service" }, "features": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayServiceFeatures" }, "minItems": 1, "description": "Active features" }, "plan": { "type": "string", "examples": [ "development-gwaas-1c2g" ], "description": "Plan" }, "configured_status": { "$ref": "#/components/schemas/gatewayServiceConfiguredStatus" }, "connections": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayConnectionModifyRequest" }, "description": "Service connections" }, "labels": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayLabelCreateRequest" }, "maxItems": 255, "description": "Labels" }, "automatic_tunnel_internal_ip_allocation": { "type": "boolean", "examples": [ true, false ], "description": "Allocate and use tunnel internal IPs automatically" } }, "title": "Service modify request", "additionalProperties": false, "description": "Request to modify a gateway service" }, "gatewayConnectionModifyRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "uuid": "01234567-89ab-cdef-0123-456789abcdef", "name": "gateway-service", "type": "ipsec", "local_routes": [ { "name": "modified-routes", "type": "static", "static_network": "10.0.22.0/24" } ] } ], "properties": { "uuid": { "$ref": "#/components/schemas/gatewayUuid" }, "name": { "type": "string", "examples": [ "gateway-service", "vpn-tunnel-1" ], "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the connection" }, "type": { "$ref": "#/components/schemas/gatewayConnectionType" }, "local_routes": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayConnectionRouteRequest" }, "description": "Connection local routes" }, "remote_routes": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayConnectionRouteRequest" }, "description": "Connection remote routes" }, "tunnels": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayTunnelModifyRequest" }, "description": "Tunnels" } }, "title": "Connection modify request", "additionalProperties": false, "description": "Network gateway VPN connection" }, "gatewayTunnelModifyRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "uuid": "01234567-89ab-cdef-0123-456789abcdef", "name": "gateway-service", "local_address": { "name": "gateway-service" }, "remote_address": { "address": "203.0.113.10" }, "ipsec": { "authentication": { "type": "psk", "psk": "MySecretPsk123" }, "phase1_algorithms": [], "phase2_algorithms": [], "phase1_integrity_algorithms": [], "phase2_integrity_algorithms": [], "phase1_dh_group_numbers": [], "phase2_dh_group_numbers": [] }, "tunnel_internal_ip": "10.0.0.1", "internal_peer_ping_interval": 0 } ], "properties": { "uuid": { "$ref": "#/components/schemas/gatewayUuid" }, "name": { "type": "string", "examples": [ "gateway-service", "vpn-tunnel-1" ], "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the tunnel" }, "local_address": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "gateway-service", "vpn-tunnel-1" ], "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the local peer address" } }, "description": "Local peer address" }, "remote_address": { "type": "object", "properties": { "address": { "type": "string", "examples": [ "203.0.113.10" ], "maxLength": 64, "minLength": 1, "description": "Remote peer address" } }, "description": "Remote peer address" }, "ipsec": { "type": "object", "properties": { "authentication": { "type": "object", "properties": { "authentication": { "$ref": "#/components/schemas/gatewayIpsecAuthenticationType" }, "psk": { "type": "string", "examples": [ "MySecretPsk123" ], "maxLength": 64, "minLength": 8, "pattern": "^[a-zA-Z1-9_.][a-zA-Z0-9_.]+$", "description": "IPsec PSK" } }, "required": [ "authentication" ], "additionalProperties": false, "description": "IPsec authentication configuration" }, "phase1_algorithms": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewaySupportedProposalAlgorithms" }, "uniqueItems": true, "description": "Phase 1 algorithms" }, "phase2_algorithms": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewaySupportedProposalAlgorithms" }, "uniqueItems": true, "description": "Phase 2 algorithms" }, "phase1_integrity_algorithms": { "type": "array", "examples": [ [ "sha256", "sha384", "sha512" ] ], "items": { "$ref": "#/components/schemas/gatewaySupportedIntegrityAlgorithms" }, "uniqueItems": true, "description": "Phase 1 integrity algorithms", "default": [ "sha256", "sha384", "sha512" ] }, "phase2_integrity_algorithms": { "type": "array", "examples": [ [ "sha256", "sha384", "sha512" ] ], "items": { "$ref": "#/components/schemas/gatewaySupportedIntegrityAlgorithms" }, "uniqueItems": true, "description": "Phase 2 integrity algorithms", "default": [ "sha256", "sha384", "sha512" ] }, "phase1_dh_group_numbers": { "type": "array", "examples": [ [ 16, 18, 19 ] ], "items": { "$ref": "#/components/schemas/gatewayDiffieHellmanGroupNumber" }, "uniqueItems": true, "description": "Phase 1 Diffie-Hellman group numbers", "default": [ 14, 16, 18, 19, 20, 21 ] }, "phase2_dh_group_numbers": { "type": "array", "examples": [ [ 14, 16, 18, 19 ] ], "items": { "$ref": "#/components/schemas/gatewayDiffieHellmanGroupNumber" }, "uniqueItems": true, "description": "Phase 2 Diffie-Hellman group numbers", "default": [ 14, 16, 18, 19, 20, 21 ] }, "ike_lifetime": { "type": "integer", "examples": [ 86400 ], "maximum": 2147483647, "minimum": 0, "format": "int32", "description": "Maximum IKE SA lifetime in seconds", "default": 86400 }, "rekey_time": { "type": "integer", "examples": [ 14400 ], "maximum": 2147483647, "minimum": 0, "format": "int32", "description": "IKE SA rekey time in seconds", "default": 14400 }, "child_rekey_time": { "type": "integer", "examples": [ 1440 ], "maximum": 2147483647, "minimum": 0, "format": "int32", "description": "IKE child SA rekey time in seconds", "default": 1440 }, "dpd_delay": { "type": "integer", "examples": [ 30 ], "maximum": 2147483647, "minimum": 0, "format": "int32", "description": "Delay before sending Dead Peer Detection packets if no traffic is detected, in seconds", "default": 30 }, "dpd_timeout": { "type": "integer", "examples": [ 120 ], "maximum": 2147483647, "minimum": 0, "format": "int32", "description": "Timeout period for DPD reply before considering the peer to be dead, in seconds", "default": 120 } }, "required": [ "authentication" ], "additionalProperties": false, "description": "IPsec configuration" }, "tunnel_internal_ip": { "type": "string", "examples": [ "10.0.0.1", "" ], "maxLength": 64, "description": "Tunnel internal IP address, \"\" if disabled" }, "internal_peer_ping_interval": { "type": "integer", "examples": [ 0 ], "format": "int64", "description": "Internal peer ping interval in seconds, or zero if disabled" } }, "title": "Tunnel modify request", "additionalProperties": false, "description": "Request to modify a VPN tunnel" }, "gatewayLabelModifyRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "key": "environment", "value": "production" } ], "properties": { "key": { "$ref": "#/components/schemas/gatewayLabelKey" }, "value": { "$ref": "#/components/schemas/gatewayLabelValue" } }, "title": "Label modify request", "additionalProperties": false, "description": "Gateway label" }, "gatewayAddressModifyRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "address": "203.0.113.10" } ], "properties": { "address": { "type": "string", "examples": [ "203.0.113.10" ], "format": "ipv4", "description": "Floating IP address to assign to the service address." } }, "title": "Address modify request", "required": [ "address" ], "additionalProperties": false, "description": "Gateway service address modify request" }, "gatewayServiceLogSessionCreateRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "session_type": "vpn" } ], "properties": { "session_type": { "$ref": "#/components/schemas/gatewayServiceLogSessionTypes" } }, "title": "Service log session create request", "required": [ "session_type" ], "additionalProperties": false, "description": "Request to create a new log session for a service." }, "gatewayServiceLogSessionTypes": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "vpn" ], "title": "Service log session types", "enum": [ "vpn" ], "description": "Service log session types" }, "gatewayPlanListResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayPlanDetailsResponse" }, "title": "Plan list response", "description": "Response schema for a list of gateway plans." }, "gatewayPlanDetailsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "gateway-service", "server_number": 4, "per_gateway_max_connections": 5005000, "supported_features": [], "vpn_tunnel_amount": 50, "per_gateway_bandwidth_mbps": 5005, "per_gateway_maximum_vpn_bandwidth_mbps": 5005 } ], "properties": { "name": { "type": "string", "examples": [ "gateway-service", "vpn-tunnel-1" ], "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the plan" }, "server_number": { "type": "integer", "examples": [ 4 ], "maximum": 8, "minimum": 1, "format": "int64", "description": "Number of nodes" }, "per_gateway_max_connections": { "type": "integer", "examples": [ 5005000 ], "maximum": 10000000, "minimum": 10000, "format": "int64", "description": "Per gateway (agent node server) maximum conntrack connections" }, "supported_features": { "type": "array", "examples": [ [ "vpn" ] ], "items": { "$ref": "#/components/schemas/gatewayServiceFeatures" }, "minItems": 1 }, "vpn_tunnel_amount": { "type": "integer", "examples": [ 50 ], "maximum": 100, "minimum": 0, "format": "int64", "description": "Number of VPN tunnels this plan allows." }, "per_gateway_bandwidth_mbps": { "type": "integer", "examples": [ 5005 ], "maximum": 10000, "minimum": 10, "format": "int64", "description": "Per gateway (agent node server) bandwidth in megabits per second." }, "per_gateway_maximum_vpn_bandwidth_mbps": { "type": "integer", "examples": [ 5005 ], "maximum": 10000, "minimum": 10, "format": "int64", "description": "Per gateway (agent node server) maximum vpn bandwidth in megabits per second." } }, "title": "Plan details response", "description": "Response schema for gateway plan details." }, "gatewayErrorResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "type": "example", "title": "Validation error.", "correlation_id": "01K1K2TKEASWRJ6VFP9ZV5P2H4", "status": 400, "invalid_params": [] } ], "properties": { "type": { "type": "string", "examples": [ "example" ], "description": "Error code string." }, "title": { "type": "string", "examples": [ "Validation error.", "The resource you requested does not exist.", "Your request could not be fulfilled due to a technical issue." ], "description": "Short description of the error." }, "correlation_id": { "type": "string", "examples": [ "01K1K2TKEASWRJ6VFP9ZV5P2H4" ], "description": "Unique identifier for the request, useful for debugging." }, "status": { "type": "integer", "examples": [ 400, 404, 402, 500 ], "format": "int32", "description": "HTTP status code associated with the error." }, "invalid_params": { "type": "array", "examples": [ [] ], "title": "InvalidParameters", "description": "List of invalid parameters in the request.", "items": { "type": "object" } } }, "title": "Error response", "required": [ "type", "title", "correlation_id", "status" ], "additionalProperties": false, "description": "Schema for error responses from the API." }, "gatewayAddressDetailsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "gateway-service", "address": "203.0.113.10", "provisioned_by": "service" } ], "properties": { "name": { "type": "string", "examples": [ "gateway-service", "vpn-tunnel-1" ], "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the address" }, "address": { "type": "string", "examples": [ "203.0.113.10" ], "format": "ip-address", "description": "VPN address" }, "provisioned_by": { "type": "string", "examples": [ "service", "user" ], "description": "Provisioner of the address" } }, "title": "Address details response", "additionalProperties": false, "description": "Response schema for gateway address details." }, "gatewayLabelDetailsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "key": "environment", "value": "production" } ], "properties": { "key": { "type": "string", "examples": [ "environment", "team" ], "maxLength": 32, "minLength": 2, "pattern": "^[\\x20-\\x5E\\x60-\\x7E][\\x20-\\x7E]+$", "description": "Key" }, "value": { "type": "string", "examples": [ "production", "dev-1" ], "maxLength": 255, "pattern": "\\A[\\p{L}\\p{N}\\p{P}\\p{S}\\p{Z}]*\\z", "description": "Value" } }, "title": "Label details response", "required": [ "key", "value" ], "additionalProperties": false, "description": "Gateway label" }, "gatewayIpsecMetricsDetailsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "ike_sas": [] } ], "properties": { "ike_sas": { "type": [ "array", "null" ], "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayIpsecIkeSaMetricsDetailsResponse" }, "description": "List of IKE SAs" } }, "title": "IPsec metrics details response", "description": "Response schema for IPsec IKE SA metrics details." }, "gatewayIpsecIkeSaMetricsDetailsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "gateway-service", "tunnel_id": 0, "unique_id": "gateway-service", "version": 0, "operational_state": "idle", "internal_state": "uninitialized", "initator": true, "established": 0, "rekey_time": 0, "reauth_time": 0, "child_sas": [], "local_host": "203.0.113.10", "remote_host": "203.0.113.10", "local_id": "203.0.113.10", "remote_id": "203.0.113.10", "heuristic_state": "none", "created_at": "2025-03-26T12:34:56Z", "updated_at": "2025-03-26T12:34:56Z" } ], "properties": { "name": { "type": "string", "examples": [ "gateway-service", "vpn-tunnel-1" ], "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the gateway" }, "tunnel_id": { "type": "integer", "examples": [ 0 ], "format": "int64", "description": "ID of the tunnel" }, "unique_id": { "type": "string", "examples": [ "gateway-service", "vpn-tunnel-1" ], "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Unique ID of the IKE SA" }, "version": { "type": "integer", "examples": [ 0 ], "format": "int64", "description": "Version of the IKE SA" }, "operational_state": { "type": "string", "examples": [ "idle" ], "enum": [ "idle", "connecting", "established", "destroying", "unknown" ], "description": "Operational state of the IKE SA" }, "internal_state": { "type": "string", "examples": [ "uninitialized" ], "enum": [ "uninitialized", "created", "connecting", "established", "passive", "rekeying", "rekeyed", "deleting", "destroying", "unavailable", "unknown" ], "description": "Internal state of the IKE SA" }, "initator": { "type": "boolean", "examples": [ true, false ], "description": "Whether the local gateway is the initiator of the IKE SA" }, "established": { "type": "integer", "examples": [ 0 ], "format": "int64" }, "rekey_time": { "type": "integer", "examples": [ 0 ], "format": "int64" }, "reauth_time": { "type": "integer", "examples": [ 0 ], "format": "int64" }, "child_sas": { "type": "array", "examples": [ [] ], "items": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the child SA" }, "tunnel_id": { "type": "integer", "format": "int64" }, "unique_id": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Unique ID of the child SA" }, "state": { "type": "string", "enum": [ "created", "routed", "installing", "installed", "updating", "rekeyed", "rekeying", "retrying", "deleting", "deleted", "destroying", "unavailable", "unknown" ], "description": "Operational state of the child SA" }, "spi_in": { "type": "string" }, "spi_out": { "type": "string" }, "bytes_in": { "type": "integer", "format": "int64" }, "bytes_out": { "type": "integer", "format": "int64" }, "packets_in": { "type": "integer", "format": "int64" }, "packets_out": { "type": "integer", "format": "int64" }, "rekey_time": { "type": "integer", "format": "int64" }, "life_time": { "type": "integer", "format": "int64" }, "install_time": { "type": "integer", "format": "int64" }, "local_traffic_selector": { "type": "array", "items": { "type": "string" } }, "remote_traffic_selector": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "examples": [ "2025-03-26T12:34:56Z" ], "format": "date-time", "description": "Timestamp of when the child SA was created." }, "updated_at": { "type": "string", "examples": [ "2025-03-26T12:34:56Z" ], "format": "date-time", "description": "Timestamp of when the child SA was last updated." } } } }, "local_host": { "type": "string", "examples": [ "203.0.113.10" ], "format": "ip-address", "description": "Local host IP address" }, "remote_host": { "type": "string", "examples": [ "203.0.113.10" ], "format": "ip-address", "description": "Remote host IP address" }, "local_id": { "type": "string", "examples": [ "203.0.113.10" ], "format": "ip-address", "description": "Local IKE identity" }, "remote_id": { "type": "string", "examples": [ "203.0.113.10" ], "format": "ip-address", "description": "Remote IKE identity" }, "heuristic_state": { "type": "object", "properties": { "tunnel_up": { "type": "boolean", "examples": [ true, false ] }, "tunnel_healthy": { "type": "boolean", "examples": [ true, false ] }, "last_down_message": { "type": "string", "examples": [ "IKE SA is down due to network issues" ] }, "updated_at": { "type": "string", "examples": [ "2025-03-26T12:34:56Z" ], "format": "date-time", "description": "Timestamp of when the heuristic state was last updated." }, "last_down_message_updated_at": { "type": "string", "examples": [ "2025-03-26T12:34:56Z" ], "format": "date-time", "description": "Timestamp of when the last down message was updated." }, "up_events": { "type": "integer", "examples": [ 0 ], "format": "int64", "description": "Number of times the IKE SA has transitioned to up state" }, "down_events": { "type": "integer", "examples": [ 0 ], "format": "int64", "description": "Number of times the IKE SA has transitioned to down state" }, "log_message_bad_events": { "type": "integer", "examples": [ 0 ], "format": "int64", "description": "Number of times the IKE SA has logged a bad message" } }, "description": "Heuristic state of the IKE SA" }, "created_at": { "type": "string", "examples": [ "2025-03-26T12:34:56Z" ], "format": "date-time", "description": "Timestamp of when the IKE SA was created." }, "updated_at": { "type": "string", "examples": [ "2025-03-26T12:34:56Z" ], "format": "date-time", "description": "Timestamp of when the IKE SA was last updated." } }, "title": "IPsec IKE SA metrics details response", "description": "Response schema for IPsec IKE SA metrics details." }, "gatewayServiceListResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayServiceDetailsResponse" }, "title": "Service list response", "description": "Response schema for a list of gateway services." }, "gatewayServiceDetailsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "uuid": "01234567-89ab-cdef-0123-456789abcdef", "name": "gateway-service", "zone": "fi-hel1", "plan": "development-gwaas-1c2g", "features": [], "addresses": [], "connections": [], "configured_status": "started", "automatic_tunnel_internal_ip_allocation": true, "labels": [], "created_at": "2025-03-26T12:34:56Z", "updated_at": "2025-03-26T12:34:56Z" } ], "properties": { "uuid": { "$ref": "#/components/schemas/gatewayUuid" }, "name": { "type": "string", "examples": [ "gateway-service", "vpn-tunnel-1" ], "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the service" }, "zone": { "type": "string", "examples": [ "fi-hel1" ], "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Zone of the service" }, "plan": { "type": "string", "examples": [ "development-gwaas-1c2g" ], "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Plan" }, "features": { "type": "array", "examples": [ [ "vpn" ] ], "items": { "$ref": "#/components/schemas/gatewayServiceFeatures" }, "minItems": 1, "description": "Active features" }, "routers": { "$ref": "#/components/schemas/gatewayRouterDetailsResponse" }, "addresses": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayAddressDetailsResponse" } }, "connections": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayConnectionDetailsResponse" } }, "configured_status": { "$ref": "#/components/schemas/gatewayServiceConfiguredStatus" }, "operational_state": { "$ref": "#/components/schemas/gatewayServiceOperationalState" }, "automatic_tunnel_internal_ip_allocation": { "type": "boolean", "examples": [ true, false ], "description": "Allocate and use tunnel internal IPs automatically" }, "labels": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayLabelDetailsResponse" }, "maxItems": 255, "description": "Labels" }, "created_at": { "type": "string", "examples": [ "2025-03-26T12:34:56Z" ], "format": "date-time", "description": "Timestamp of when the service was created." }, "updated_at": { "type": "string", "examples": [ "2025-03-26T12:34:56Z" ], "format": "date-time", "description": "Timestamp of when the service was last updated." } }, "title": "Service details response", "description": "Gateway service" }, "gatewayRouterDetailsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "uuid": "01234567-89ab-cdef-0123-456789abcdef", "created_at": "2025-03-26T12:34:56Z", "updated_at": "2025-03-26T12:34:56Z" } ], "properties": { "uuid": { "type": "string", "examples": [ "01234567-89ab-cdef-0123-456789abcdef" ], "format": "uuid", "description": "Router UUID" }, "created_at": { "type": "string", "examples": [ "2025-03-26T12:34:56Z" ], "format": "date-time", "description": "Timestamp of when the router was created." }, "updated_at": { "type": "string", "examples": [ "2025-03-26T12:34:56Z" ], "format": "date-time", "description": "Timestamp of when the router was last updated." } }, "title": "Router details response", "description": "Response schema for gateway router details." }, "gatewayConnectionDetailsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "uuid": "01234567-89ab-cdef-0123-456789abcdef", "name": "gateway-service", "type": "ipsec", "local_routes": [], "remote_routes": [], "tunnels": [], "created_at": "2025-03-26T12:34:56Z", "updated_at": "2025-03-26T12:34:56Z" } ], "properties": { "uuid": { "$ref": "#/components/schemas/gatewayUuid" }, "name": { "type": "string", "examples": [ "gateway-service", "vpn-tunnel-1" ], "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the connection" }, "type": { "$ref": "#/components/schemas/gatewayConnectionType" }, "local_routes": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayConnectionRouteDetailsResponse" }, "description": "Local routes for the connection" }, "remote_routes": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayConnectionRouteDetailsResponse" }, "description": "Remote routes for the connection" }, "tunnels": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayTunnelDetailsResponse" } }, "created_at": { "type": "string", "examples": [ "2025-03-26T12:34:56Z" ], "format": "date-time", "description": "Timestamp of when the connection was created." }, "updated_at": { "type": "string", "examples": [ "2025-03-26T12:34:56Z" ], "format": "date-time", "description": "Timestamp of when the connection was last updated." } }, "title": "Connection details response", "description": "Response schema for gateway connection details." }, "gatewayConnectionRouteDetailsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "gateway-service", "type": "static", "static_network": "10.0.0.0/24" } ], "properties": { "name": { "type": "string", "examples": [ "gateway-service", "vpn-tunnel-1" ], "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the connection" }, "type": { "$ref": "#/components/schemas/gatewayConnectionRouteType" }, "static_network": { "type": "string", "examples": [ "10.0.0.0/24" ], "format": "ip-network", "description": "Static network for the connection route" } }, "title": "Connection route details response", "description": "Response schema for gateway connection route details." }, "gatewayTunnelDetailsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "uuid": "01234567-89ab-cdef-0123-456789abcdef", "name": "gateway-service", "internal_peer_ping_interval": 0, "operational_state": "established", "created_at": "2025-03-26T12:34:56Z", "updated_at": "2025-03-26T12:34:56Z", "tunnel_up": true, "tunnel_healthy": true } ], "properties": { "uuid": { "$ref": "#/components/schemas/gatewayUuid" }, "name": { "type": "string", "examples": [ "gateway-service", "vpn-tunnel-1" ], "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the tunnel" }, "local_address": { "$ref": "#/components/schemas/gatewayLocalPeerAddressDetailsResponse" }, "remote_address": { "$ref": "#/components/schemas/gatewayRemotePeerAddressDetailsResponse" }, "ipsec": { "$ref": "#/components/schemas/gatewayIpsecDetailsResponse" }, "tunnel_internal_ip": { "$ref": "#/components/schemas/gatewayTunnelInternalIpDetailsResponse" }, "internal_peer_ping_interval": { "type": "integer", "examples": [ 0 ], "minimum": 0, "format": "int64", "description": "Internal peer ping interval in seconds" }, "operational_state": { "$ref": "#/components/schemas/gatewayTunnelOperationalState" }, "created_at": { "type": "string", "examples": [ "2025-03-26T12:34:56Z" ], "format": "date-time", "description": "Timestamp of when the tunnel was created." }, "updated_at": { "type": "string", "examples": [ "2025-03-26T12:34:56Z" ], "format": "date-time", "description": "Timestamp of when the tunnel was last updated." }, "tunnel_up": { "type": "boolean", "examples": [ true, false ], "description": "Indicates whether the tunnel is up" }, "tunnel_healthy": { "type": "boolean", "examples": [ true, false ], "description": "Indicates whether the tunnel is healthy" } }, "title": "Tunnel details response", "additionalProperties": false, "description": "Response schema for gateway tunnel details." }, "gatewayLocalPeerAddressDetailsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "gateway-service" } ], "properties": { "name": { "type": "string", "examples": [ "gateway-service", "vpn-tunnel-1" ], "maxLength": 64, "minLength": 1, "description": "Name of the local peer" } }, "title": "Local peer address details response", "description": "Response schema for local peer address details." }, "gatewayRemotePeerAddressDetailsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "address": "203.0.113.10" } ], "properties": { "address": { "type": "string", "examples": [ "203.0.113.10" ], "format": "ip-address", "description": "Remote peer address" } }, "title": "Remote peer address details response", "description": "Response schema for remote peer address details." }, "gatewayIpsecDetailsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "ike_lifetime": 30, "rekey_time": 30, "child_rekey_time": 60, "dpd_delay": 40, "dpd_timeout": 20, "authentication": { "authentication": "psk", "psk": "{your PSK}" } } ], "properties": { "authentication": { "$ref": "#/components/schemas/gatewayAuthenticationDetailsResponse" }, "phase1_algorithms": { "type": "array", "examples": [ [ "aes128", "aes256", "aes128gcm128", "aes256gcm128" ] ], "items": { "$ref": "#/components/schemas/gatewaySupportedProposalAlgorithms" }, "uniqueItems": true, "description": "Phase 1 proposal algorithms", "default": [ "aes128", "aes256", "aes128gcm128", "aes256gcm128" ] }, "phase2_algorithms": { "type": "array", "examples": [ [ "aes128", "aes256", "aes128gcm128", "aes256gcm128" ] ], "items": { "$ref": "#/components/schemas/gatewaySupportedProposalAlgorithms" }, "uniqueItems": true, "description": "Phase 2 security association algorithms", "default": [ "aes128", "aes256", "aes128gcm128", "aes256gcm128" ] }, "phase1_integrity_algorithms": { "type": "array", "examples": [ [ "sha256", "sha384", "sha512" ] ], "items": { "$ref": "#/components/schemas/gatewaySupportedIntegrityAlgorithms" }, "uniqueItems": true, "description": "Phase 1 integrity algorithms", "default": [ "sha256", "sha384", "sha512" ] }, "phase2_integrity_algorithms": { "type": "array", "examples": [ [ "sha256", "sha384", "sha512" ] ], "items": { "$ref": "#/components/schemas/gatewaySupportedIntegrityAlgorithms" }, "uniqueItems": true, "description": "Phase 2 integrity algorithms", "default": [ "sha256", "sha384", "sha512" ] }, "ike_lifetime": { "type": "integer", "examples": [ 86400 ], "maximum": 2147483647, "minimum": 0, "format": "int32", "description": "Maximum IKE SA lifetime in seconds", "default": 86400 }, "rekey_time": { "type": "integer", "examples": [ 14400 ], "maximum": 2147483647, "minimum": 0, "format": "int32", "description": "IKE SA rekey time in seconds", "default": 14400 }, "child_rekey_time": { "type": "integer", "examples": [ 1440 ], "maximum": 2147483647, "minimum": 0, "format": "int32", "description": "IKE child SA rekey time in seconds", "default": 1440 }, "dpd_delay": { "type": "integer", "examples": [ 30 ], "maximum": 2147483647, "minimum": 0, "format": "int32", "description": "Delay before sending Dead Peer Detection packets if no traffic is detected, in seconds", "default": 30 }, "dpd_timeout": { "type": "integer", "examples": [ 120 ], "maximum": 2147483647, "minimum": 0, "format": "int32", "description": "Timeout period for DPD reply before considering the peer to be dead, in seconds", "default": 120 }, "phase1_dh_group_numbers": { "type": "array", "examples": [ [ 16, 18, 19 ] ], "items": { "$ref": "#/components/schemas/gatewayDiffieHellmanGroupNumber" }, "uniqueItems": true, "description": "Phase 1 Diffie-Hellman group numbers", "default": [ 14, 16, 18, 19, 20, 21 ] }, "phase2_dh_group_numbers": { "type": "array", "examples": [ [ 14, 16, 18, 19 ] ], "items": { "$ref": "#/components/schemas/gatewayDiffieHellmanGroupNumber" }, "uniqueItems": true, "description": "Phase 2 Diffie-Hellman group numbers", "default": [ 14, 16, 18, 19, 20, 21 ] } }, "title": "IPsec details response", "description": "Response schema for IPsec configuration details." }, "gatewayAuthenticationDetailsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "authentication": "psk" } ], "properties": { "authentication": { "$ref": "#/components/schemas/gatewayIpsecAuthenticationType" } }, "title": "Authentication details response", "additionalProperties": false, "description": "Response schema for authentication details." }, "gatewayTunnelInternalIpDetailsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "hasParseError": true } ], "properties": { "ip": { "$ref": "#/components/schemas/gatewayAddress" }, "hasParseError": { "type": "boolean", "examples": [ true, false ], "description": "Indicates if there is a parse error with the tunnel internal IP" } }, "title": "Tunnel internal IP details response", "description": "Response schema for gateway tunnel internal IP details." }, "gatewayAddress": { "type": "object", "examples": [ { "addr": 0 } ], "properties": { "addr": { "type": "integer", "examples": [ 0 ], "format": "int64", "description": "Address" } }, "title": "Address" }, "gatewayTunnelOperationalState": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "idle" ], "title": "Tunnel operational state", "enum": [ "idle", "connecting", "established", "destroying", "unknown" ], "description": "Tunnel operational state" }, "gatewayConnectionListResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayConnectionDetailsResponse" }, "title": "Connection list response", "description": "Response schema for a list of gateway connections." }, "gatewayTunnelListResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayTunnelDetailsResponse" }, "title": "Tunnel list response", "description": "Response schema for a list of gateway tunnels." }, "gatewayServiceLabelListResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayLabelDetailsResponse" }, "title": "Service label list response", "description": "Response schema for a list of service labels." }, "gatewayAddressListResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayAddressDetailsResponse" }, "title": "Address list response", "description": "Response schema for a list of gateway addresses." }, "gatewayServiceMetricsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "gateways": [] } ], "properties": { "gateways": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/gatewayMetricsDetailsResponse" } }, "ipsec_metrics": { "$ref": "#/components/schemas/gatewayIpsecMetricsDetailsResponse" } }, "title": "Service metrics response", "description": "Response schema for service metrics." }, "gatewayServiceLogSessionCreateResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "sessions": [ "vpn" ] } ], "properties": { "sessions": { "type": "array", "items": { "$ref": "#/components/schemas/gatewayServiceLogSessionDetailsResponse" }, "description": "List of service sessions created." } }, "title": "Service log session create response", "required": [ "sessions" ], "additionalProperties": false, "description": "Response schema for service log session creation." }, "gatewayServiceLogSessionDetailsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "sessions": [ { "session_id": "01234567-89ab-cdef-0123-456789abcdef", "token": "01234567-89ab-cdef-0123-456789abcdef" } ] } ], "properties": { "session_id": { "$ref": "#/components/schemas/gatewayUuid" }, "token": { "$ref": "#/components/schemas/gatewayUuid" } }, "title": "Service log session details response", "required": [ "session_id", "token" ], "additionalProperties": false, "description": "Response schema for details of a service log session." }, "loadBalancerLimitParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "examples": [ 10, 50, 100 ], "title": "LimitParameter", "maximum": 100, "minimum": 0, "format": "int32", "description": "Number of entries to receive at most.", "default": 10 }, "loadBalancerOffsetParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "examples": [ 0, 10, 20 ], "title": "OffsetParameter", "minimum": 0, "format": "int32", "description": "Offset for retrieved results.", "default": 0 }, "loadBalancerSortServicesParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "-created_at", "name", "-uuid" ], "title": "SortServicesParameter", "enum": [ "created_at", "-created_at", "name", "-name", "uuid", "-uuid" ], "description": "Sort services by field. Prefix with '-' for descending order." }, "loadBalancerLabelFilterParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ "env=staging" ], [ "env" ], [ "env=staging", "region=us" ] ], "items": { "type": "string", "pattern": "^[a-zA-Z0-9_-]+(=[a-zA-Z0-9_-]*)?$" }, "title": "LabelFilterParameter", "description": "Filter resources by label. Can be provided multiple times for multiple labels. Format: 'key=value' for exact match or 'key' for existence check." }, "loadBalancerServiceParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "01234567-89ab-cdef-0123-456789abcdef", "fedcba98-7654-3210-fedc-ba9876543210" ], "title": "ServiceParameter", "format": "uuid", "description": "The UUID of the service." }, "loadBalancerFrontendParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "example-frontend-1", "example-frontend-2" ], "title": "FrontendParameter", "description": "The name of the frontend." }, "loadBalancerTlsConfigParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "example-tls-config-1", "example-tls-config-2" ], "title": "TlsConfigParameter", "description": "The name of the TLS configuration." }, "loadBalancerRuleParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "example-rule-1", "example-rule-2" ], "title": "RuleParameter", "description": "The name of the rule." }, "loadBalancerBackendParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "backend-infra", "backend-customer-1" ], "title": "BackendParameter", "description": "The name of the backend." }, "loadBalancerMemberParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "dev-member", "qa-member" ], "title": "MemberParameter", "description": "The name of the member." }, "loadBalancerNetworkParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "example-network-1", "example-network-2" ], "title": "NetworkParameter", "description": "The name of the network." }, "loadBalancerIpAddressParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "192.168.1.1", "2001:db8::1" ], "title": "IpAddressParameter", "description": "The IP address parameter." }, "loadBalancerResolverParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "example-resolver-1", "example-resolver-2" ], "title": "ResolverParameter", "description": "The name of the resolver." }, "loadBalancerLabelParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "example-key-1", "example-key-2" ], "title": "LabelParameter", "description": "The label key parameter." }, "loadBalancerMetricsSortParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "start_at", "-start_at" ], "title": "MetricsSortParameter", "enum": [ "start_at", "-start_at" ], "description": "Sort metrics by field. Prefix with '-' for descending order." }, "loadBalancerCertificateBundleParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "01234567-89ab-cdef-0123-456789abcdef", "fedcba98-7654-3210-fedc-ba9876543210" ], "title": "CertificateBundleParameter", "format": "uuid", "description": "The UUID of the certificate bundle." }, "loadBalancerPlanParameter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "example-plan-1", "example-plan-2" ], "title": "PlanParameter", "description": "The name of the plan." }, "loadBalancerServiceCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "my-loadbalancer", "zone": "fi-hel1", "plan": "production-small", "configured_status": "started", "frontends": [] } ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "description": "Name of the service", "example": "my-loadbalancer" }, "zone": { "type": "string", "pattern": "^[a-z]{2}-[a-z]{3}\\d$", "description": "Zone", "example": "fi-hel1" }, "plan": { "type": "string", "description": "Plan", "example": "production" }, "configured_status": { "$ref": "#/components/schemas/loadBalancerServiceConfiguredStatus" }, "frontends": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/loadBalancerFrontendCreate" }, "description": "Service frontends" }, "backends": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/loadBalancerBackendCreate" }, "description": "Service backends" }, "resolvers": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/loadBalancerResolverCreate" }, "description": "Service resolvers" }, "network_uuid": { "type": "string", "format": "uuid", "description": "Private Network UUID", "example": "01234567-89ab-cdef-0123-456789abcdef" }, "networks": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/loadBalancerNetworkCreate" }, "description": "Service networks" }, "labels": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/loadBalancerLabelCreate" }, "maxItems": 255, "description": "Labels" }, "maintenance_dow": { "$ref": "#/components/schemas/loadBalancerMaintenanceDayOfWeek" }, "maintenance_time": { "$ref": "#/components/schemas/loadBalancerMaintenanceTime" }, "ip_addresses": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/loadBalancerIpAddressCreate" }, "description": "List of IP addresses for the network" } }, "title": "Service Create", "required": [ "name", "zone", "plan", "configured_status", "frontends" ], "additionalProperties": false, "description": "Load Balancer Service" }, "loadBalancerServiceConfiguredStatus": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "title": "Service configured status", "enum": [ "started", "stopped" ], "description": "Service configured status", "example": "started" }, "loadBalancerFrontendCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "my-frontend", "port": 80, "mode": "http", "default_backend": "my-backend" } ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the frontend", "example": "my-frontend" }, "port": { "type": "integer", "maximum": 65535, "minimum": 1, "format": "int32", "description": "Port to listen" }, "mode": { "$ref": "#/components/schemas/loadBalancerFrontendMode" }, "default_backend": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Default backend" }, "networks": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerFrontendNetworkCreate" }, "description": "Network names" }, "tls_configs": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/loadBalancerTlsConfigCreate" }, "description": "TLS Configs" }, "rules": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/loadBalancerRuleCreate" }, "description": "Rules" }, "properties": { "$ref": "#/components/schemas/loadBalancerFrontendPropertiesCreate" } }, "title": "Frontend Create", "required": [ "name", "port", "mode", "default_backend" ], "additionalProperties": false, "description": "Load Balancer Frontend" }, "loadBalancerFrontendMode": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "title": "Frontend mode", "enum": [ "http", "tcp" ], "description": "Mode" }, "loadBalancerFrontendNetworkCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the Network", "example": "public-network-1" } }, "title": "Frontend Network Create", "required": [ "name" ], "additionalProperties": false, "description": "Load Balancer Network", "example": { "name": "public-network-1" } }, "loadBalancerTlsConfigCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the config", "example": "tls-config-1" }, "certificate_bundle_uuid": { "type": "string", "format": "uuid", "description": "Certificate Bundle UUID", "example": "123e4567-e89b-12d3-a456-426614174000" } }, "title": "TLS Config Create", "required": [ "name", "certificate_bundle_uuid" ], "additionalProperties": false, "description": "Load Balancer TLS Config", "example": { "name": "tls-config-1", "certificate_bundle_uuid": "123e4567-e89b-12d3-a456-426614174000" } }, "loadBalancerRuleCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "my-rule", "priority": 10, "matching_condition": "and", "matchers": [], "actions": [ { "type": "use_backend", "action_use_backend": { "backend": "backend-1" } } ] } ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the rule", "example": "my-rule" }, "priority": { "type": "integer", "maximum": 100, "minimum": 0, "format": "int32", "description": "Priority", "example": 10 }, "matching_condition": { "$ref": "#/components/schemas/loadBalancerMatchingCondition" }, "matchers": { "type": [ "array", "null" ], "examples": [ [] ], "items": { "$ref": "#/components/schemas/loadBalancerMatcherCreate" }, "maxItems": 40, "description": "Rule matchers" }, "actions": { "type": "array", "examples": [ [ { "type": "use_backend", "action_use_backend": { "backend": "backend-1" } } ] ], "items": { "$ref": "#/components/schemas/loadBalancerActionCreate" }, "maxItems": 40, "minItems": 1, "description": "Rule actions" } }, "title": "Rule Create", "required": [ "name", "priority", "matchers", "actions" ], "additionalProperties": false, "description": "Load Balancer Forwarding Rule" }, "loadBalancerMatchingCondition": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "and" ], "title": "MatchingCondition", "enum": [ "and", "or" ], "description": "Defines how multiple matching criteria are combined to evaluate a condition." }, "loadBalancerMatcherCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "properties": { "type": { "const": "src_ip" }, "inverse": { "type": "boolean", "description": "Inverse rule" }, "match_src_ip": { "$ref": "#/components/schemas/loadBalancerMatcherIpCreate" } }, "required": [ "type", "match_src_ip" ], "additionalProperties": false }, { "properties": { "type": { "const": "src_port" }, "inverse": { "type": "boolean", "description": "Inverse rule" }, "match_src_port": { "$ref": "#/components/schemas/loadBalancerMatcherIntCreate" } }, "required": [ "type", "match_src_port" ], "additionalProperties": false }, { "properties": { "type": { "const": "body_size" }, "inverse": { "type": "boolean", "description": "Inverse rule" }, "match_body_size": { "$ref": "#/components/schemas/loadBalancerMatcherIntCreate" } }, "required": [ "type", "match_body_size" ], "additionalProperties": false }, { "properties": { "type": { "const": "cookie" }, "inverse": { "type": "boolean", "description": "Inverse rule" }, "match_cookie": { "$ref": "#/components/schemas/loadBalancerMatcherStringArgCreate" } }, "required": [ "type", "match_cookie" ], "additionalProperties": false }, { "properties": { "type": { "const": "header" }, "inverse": { "type": "boolean", "description": "Inverse rule" }, "match_header": { "$ref": "#/components/schemas/loadBalancerMatcherStringArgCreate" } }, "required": [ "type", "match_header" ], "additionalProperties": false }, { "properties": { "type": { "const": "url_param" }, "inverse": { "type": "boolean", "description": "Inverse rule" }, "match_url_param": { "$ref": "#/components/schemas/loadBalancerMatcherStringArgCreate" } }, "required": [ "type", "match_url_param" ], "additionalProperties": false }, { "properties": { "type": { "const": "http_method" }, "inverse": { "type": "boolean", "description": "Inverse rule" }, "match_http_method": { "$ref": "#/components/schemas/loadBalancerMatcherHttpMethodCreate" } }, "required": [ "type", "match_http_method" ], "additionalProperties": false }, { "properties": { "type": { "const": "path" }, "inverse": { "type": "boolean", "description": "Inverse rule" }, "match_path": { "$ref": "#/components/schemas/loadBalancerMatcherStringCreate" } }, "required": [ "type", "match_path" ], "additionalProperties": false }, { "properties": { "type": { "const": "url" }, "inverse": { "type": "boolean", "description": "Inverse rule" }, "match_url": { "$ref": "#/components/schemas/loadBalancerMatcherStringCreate" } }, "required": [ "type", "match_url" ], "additionalProperties": false }, { "properties": { "type": { "const": "host" }, "inverse": { "type": "boolean", "description": "Inverse rule" }, "match_host": { "$ref": "#/components/schemas/loadBalancerMatcherHostCreate" } }, "required": [ "type", "match_host" ], "additionalProperties": false }, { "properties": { "type": { "const": "url_query" }, "inverse": { "type": "boolean", "description": "Inverse rule" }, "match_url_query": { "$ref": "#/components/schemas/loadBalancerMatcherStringCreate" } }, "required": [ "type", "match_url_query" ], "additionalProperties": false }, { "properties": { "type": { "const": "num_members_up" }, "inverse": { "type": "boolean", "description": "Inverse rule" }, "match_num_members_up": { "$ref": "#/components/schemas/loadBalancerMatcherBackendCreate" } }, "required": [ "type", "match_num_members_up" ], "additionalProperties": false }, { "properties": { "type": { "const": "request_header" }, "inverse": { "type": "boolean", "description": "Inverse rule" }, "match_request_header": { "$ref": "#/components/schemas/loadBalancerMatcherStringArgCreate" } }, "required": [ "type", "match_request_header" ], "additionalProperties": false }, { "properties": { "type": { "const": "response_header" }, "inverse": { "type": "boolean", "description": "Inverse rule" }, "match_response_header": { "$ref": "#/components/schemas/loadBalancerMatcherStringArgCreate" } }, "required": [ "type", "match_response_header" ], "additionalProperties": false }, { "properties": { "type": { "const": "http_status" }, "inverse": { "type": "boolean", "description": "Inverse rule" }, "match_http_status": { "$ref": "#/components/schemas/loadBalancerMatcherIntCreate" } }, "required": [ "type", "match_http_status" ], "additionalProperties": false } ], "title": "Matcher Create", "description": "Load Balancer Forwarding Rule Matcher" }, "loadBalancerMatcherIpCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "value": { "type": "string", "description": "IP address or CIDR to match against. Accepts IPv4 (e.g., 192.168.1.1), IPv6 (e.g., 2001:db8::1), or CIDR notation (e.g., 192.168.1.0/24).", "example": "192.168.1.1" } }, "title": "Matcher IP Create", "required": [ "value" ], "additionalProperties": false, "description": "Forwarding rule IP matcher for matching source IP addresses. Accepts IPv4, IPv6 addresses or CIDR notation.", "example": { "value": "192.168.1.1" } }, "loadBalancerMatcherIntCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "oneOf": [ { "properties": { "value": { "type": "null" } }, "title": "Range matcher", "required": [ "method", "range_start", "range_end" ] }, { "properties": { "range_start": { "type": "null" }, "range_end": { "type": "null" } }, "title": "Equality/comparison matcher", "required": [ "method", "value" ] } ], "properties": { "method": { "$ref": "#/components/schemas/loadBalancerRuleMatcherIntMethod" }, "value": { "type": "integer", "format": "int32", "description": "Value" }, "range_start": { "type": "integer", "format": "int32", "description": "Value" }, "range_end": { "type": "integer", "format": "int32", "description": "Value" } }, "title": "Matcher Int Create", "required": [ "method" ], "additionalProperties": false, "description": "Forwarding rule integer matcher" }, "loadBalancerRuleMatcherIntMethod": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "title": "Rule matcher int method", "enum": [ "range", "equal", "greater_or_equal", "greater", "less_or_equal", "less" ], "description": "Method" }, "loadBalancerMatcherStringArgCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "properties": { "method": { "$ref": "#/components/schemas/loadBalancerStringMatcherMethods" }, "name": { "type": "string", "description": "Name of the parameter" }, "value": { "type": "string", "description": "Value" }, "ignore_case": { "type": "boolean", "description": "Ignore case" } }, "required": [ "method", "name", "value" ], "additionalProperties": false }, { "properties": { "method": { "$ref": "#/components/schemas/loadBalancerStringMatcherMethodsNoValue" }, "name": { "type": "string", "description": "Name of the parameter" } }, "required": [ "method", "name" ], "additionalProperties": false } ], "title": "Matcher String Arg Create", "description": "Forwarding rule string matcher" }, "loadBalancerStringMatcherMethods": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "exact", "substring", "starts" ], "title": "String matcher methods", "enum": [ "exact", "substring", "regexp", "starts", "ends", "domain" ], "description": "String matcher methods", "example": "substring" }, "loadBalancerStringMatcherMethodsNoValue": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "exists", "ip" ], "title": "String matcher methods no value", "enum": [ "exists", "ip" ], "description": "String matcher methods (no value)", "example": "exists" }, "loadBalancerMatcherHttpMethodCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "value": { "$ref": "#/components/schemas/loadBalancerHttpMethods" } }, "title": "Matcher HTTP Method Create", "required": [ "value" ], "additionalProperties": false, "description": "Forwarding rule HTTP method matcher" }, "loadBalancerHttpMethods": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "title": "HTTP methods", "enum": [ "GET", "HEAD", "POST", "PUT", "PATCH", "DELETE", "CONNECT", "OPTIONS", "TRACE" ], "description": "HTTP methods" }, "loadBalancerMatcherStringCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "properties": { "method": { "$ref": "#/components/schemas/loadBalancerStringMatcherMethods" }, "value": { "type": "string", "description": "Value" }, "ignore_case": { "type": "boolean", "description": "Ignore case" } }, "required": [ "method", "value" ], "additionalProperties": false }, { "properties": { "method": { "$ref": "#/components/schemas/loadBalancerStringMatcherMethodsNoValue" } }, "required": [ "method" ], "additionalProperties": false } ], "title": "Matcher String Create", "description": "Forwarding rule string matcher" }, "loadBalancerMatcherHostCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "value": { "type": "string", "format": "hostname", "description": "Value" } }, "title": "Matcher Host Create", "required": [ "value" ], "additionalProperties": false, "description": "Forwarding rule host matcher", "example": { "value": "example.com" } }, "loadBalancerMatcherBackendCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "oneOf": [ { "properties": { "value": { "type": "null" } }, "title": "Range matcher", "required": [ "backend", "method", "range_start", "range_end" ] }, { "properties": { "range_start": { "type": "null" }, "range_end": { "type": "null" } }, "title": "Equality/comparison matcher", "required": [ "backend", "method", "value" ] } ], "properties": { "backend": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the backend" }, "method": { "$ref": "#/components/schemas/loadBalancerRuleMatcherIntMethod" }, "value": { "type": "integer", "maximum": 100, "minimum": 0, "format": "int32", "description": "Value" }, "range_start": { "type": "integer", "maximum": 100, "minimum": 0, "format": "int32", "description": "Value" }, "range_end": { "type": "integer", "maximum": 100, "minimum": 0, "format": "int32", "description": "Value" } }, "title": "Matcher Backend Create", "additionalProperties": false, "description": "Forwarding rule backend matcher" }, "loadBalancerActionCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "properties": { "type": { "const": "use_backend" }, "action_use_backend": { "$ref": "#/components/schemas/loadBalancerActionUseBackendCreate" } }, "required": [ "type", "action_use_backend" ], "additionalProperties": false }, { "properties": { "type": { "const": "http_return" }, "action_http_return": { "$ref": "#/components/schemas/loadBalancerActionHttpReturnCreate" } }, "required": [ "type", "action_http_return" ], "additionalProperties": false }, { "properties": { "type": { "const": "http_redirect" }, "action_http_redirect": { "$ref": "#/components/schemas/loadBalancerActionHttpRedirectCreate" } }, "required": [ "type", "action_http_redirect" ], "additionalProperties": false }, { "properties": { "type": { "const": "tcp_reject" }, "action_tcp_reject": { "$ref": "#/components/schemas/loadBalancerActionTcpRejectCreate" } }, "required": [ "type", "action_tcp_reject" ], "additionalProperties": false }, { "properties": { "type": { "const": "set_forwarded_headers" }, "action_set_forwarded_headers": { "$ref": "#/components/schemas/loadBalancerActionSetForwardedHeaders" } }, "required": [ "type", "action_set_forwarded_headers" ], "additionalProperties": false }, { "properties": { "type": { "const": "set_request_header" }, "action_set_request_header": { "$ref": "#/components/schemas/loadBalancerActionSetHeaderCreate" } }, "required": [ "type", "action_set_request_header" ], "additionalProperties": false }, { "properties": { "type": { "const": "set_response_header" }, "action_set_response_header": { "$ref": "#/components/schemas/loadBalancerActionSetHeaderCreate" } }, "required": [ "type", "action_set_response_header" ], "additionalProperties": false }, { "properties": { "type": { "const": "http_rewrite_path" }, "action_http_rewrite_path": { "$ref": "#/components/schemas/loadBalancerActionHttpRewritePathCreate" } }, "required": [ "type", "action_http_rewrite_path" ], "additionalProperties": false }, { "properties": { "type": { "const": "http_rewrite_uri" }, "action_http_rewrite_uri": { "$ref": "#/components/schemas/loadBalancerActionHttpRewriteUriCreate" } }, "required": [ "type", "action_http_rewrite_uri" ], "additionalProperties": false } ], "title": "Action Create", "description": "Load Balancer Forwarding Rule Action" }, "loadBalancerActionUseBackendCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "backend": "backend-1" } ], "properties": { "backend": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the backend", "example": "backend-1" } }, "title": "Action Use Backend Create", "required": [ "backend" ], "additionalProperties": false, "description": "Forwarding rule use backend action", "example": { "backend": "backend-1" } }, "loadBalancerActionHttpReturnCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "status": 200, "content_type": "text/plain", "payload": "SGVsbG8gV29ybGQ=" } ], "properties": { "status": { "type": "integer", "maximum": 599, "minimum": 100, "format": "int32", "description": "HTTP Status code", "example": 200 }, "content_type": { "$ref": "#/components/schemas/loadBalancerContentTypes" }, "payload": { "type": "string", "maxLength": 4096, "minLength": 1, "format": "base64", "description": "Response body content to return to the client." } }, "title": "Action HTTP Return Create", "required": [ "status", "content_type", "payload" ], "additionalProperties": false, "description": "Forwarding rule HTTP Return action" }, "loadBalancerContentTypes": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "title": "Content types", "enum": [ "text/plain", "text/html", "application/javascript", "application/json" ], "description": "Content types" }, "loadBalancerActionHttpRedirectCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "type": "object", "properties": { "location": { "type": "string", "maxLength": 255, "minLength": 1, "format": "uri-reference", "description": "Value" }, "status": { "type": "integer", "title": "ActionHttpRedirectStatus", "format": "int32", "enum": [ 301, 302, 303, 307, 308 ], "description": "HTTP Status code" } }, "required": [ "location" ], "additionalProperties": false }, { "type": "object", "properties": { "scheme": { "type": "string", "title": "ActionHttpRedirectScheme", "enum": [ "http", "https" ], "description": "URL Schemes" }, "status": { "type": "integer", "title": "ActionHttpRedirectStatus", "format": "int32", "enum": [ 301, 302, 303, 307, 308 ], "description": "HTTP Status code" } }, "required": [ "scheme" ], "additionalProperties": false } ], "examples": [ { "location": "https://example.com/new-path", "status": 302 }, { "scheme": "https", "status": 301 } ], "title": "Action HTTP Redirect Create", "description": "Forwarding rule HTTP Redirect action" }, "loadBalancerActionTcpRejectCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "title": "Action TCP Reject Create", "additionalProperties": false, "description": "Forwarding rule TCP reject action", "example": {} }, "loadBalancerActionSetForwardedHeaders": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "title": "Action Set Forwarded Headers", "additionalProperties": false, "description": "Forwarding rule Set forwarded headers", "example": {} }, "loadBalancerActionSetHeaderCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "header": { "type": "string", "maxLength": 256, "minLength": 1, "description": "Name of the HTTP header to set or modify in the request or response.", "example": "X-Custom-Header" }, "value": { "type": "string", "maxLength": 256, "description": "Value to assign to the specified HTTP header.", "example": "CustomValue" } }, "title": "Action Set Header Create", "required": [ "header" ], "additionalProperties": false, "description": "Forwarding rule HTTP set header action", "example": { "header": "X-Custom-Header", "value": "CustomValue" } }, "loadBalancerActionHttpRewritePathCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "match_pattern": { "type": "string", "examples": [ "^(.*/)$", "^/api/(.*)$", "^(.*)$", "" ], "description": "Regex pattern to match against the path. Use empty string \"\" to match the entire path (defaults to ^(.*)$)" }, "rewrite_to": { "type": "string", "examples": [ "\\1index.html", "/new-path/\\1", "/static/content.html" ], "minLength": 1, "description": "Replacement pattern (can use capture groups like \\1 if match_pattern is provided)" } }, "title": "Action HTTP Rewrite Path Create", "required": [ "match_pattern", "rewrite_to" ], "additionalProperties": false, "description": "Rewrite HTTP request path using regex pattern" }, "loadBalancerActionHttpRewriteUriCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "match_pattern": { "type": "string", "examples": [ "^(.*)\\?(.*)$", "^/api/(.*)$", "^(.*)$", "" ], "description": "Regex pattern to match against the full URI. Use empty string \"\" to match the entire URI (defaults to ^(.*)$)" }, "rewrite_to": { "type": "string", "examples": [ "/v2/\\1", "/new-path/\\1?\\2", "/static/resource" ], "minLength": 1, "description": "Replacement pattern (can use capture groups like \\1 if match_pattern is provided)" } }, "title": "Action HTTP Rewrite Uri Create", "required": [ "match_pattern", "rewrite_to" ], "additionalProperties": false, "description": "Rewrite HTTP request URI using regex pattern" }, "loadBalancerFrontendPropertiesCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "timeout_client": { "type": "integer", "maximum": 86400, "minimum": 1, "format": "int32", "description": "Client timeout", "example": 60 }, "inbound_proxy_protocol": { "type": "boolean", "description": "Enable or disable inbound proxy protocol support", "example": false }, "http2_enabled": { "type": "boolean", "description": "Allows for HTTP2 connection via ALPN" } }, "title": "Frontend Properties Create", "additionalProperties": false, "description": "Frontend Properties", "example": { "timeout_client": 60, "inbound_proxy_protocol": false, "http2_enabled": true } }, "loadBalancerBackendCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "my-backend", "members": [] } ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the backend", "example": "my-backend" }, "members": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/loadBalancerMemberCreate" }, "description": "Backend members" }, "tls_configs": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/loadBalancerTlsConfigCreate" }, "description": "TLS Configs" }, "resolver": { "oneOf": [ { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$" }, { "type": "string" }, { "type": "null" } ], "description": "Resolver reference" }, "properties": { "$ref": "#/components/schemas/loadBalancerBackendPropertiesCreate" } }, "title": "Backend Create", "required": [ "name", "members" ], "additionalProperties": false, "description": "Load Balancer Backend" }, "loadBalancerMemberCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "oneOf": [ { "properties": { "type": { "const": "static" }, "ip": { "type": "string", "oneOf": [ { "type": "string", "format": "ipv4" }, { "type": "string", "format": "ipv6" } ], "format": "ip", "description": "Target IP address (IPv4 or IPv6)" }, "port": { "type": "integer", "maximum": 65535, "minimum": 1, "format": "int32", "description": "Target Port" } }, "title": "Static member", "required": [ "name", "ip", "port", "weight", "max_sessions", "type", "enabled" ] }, { "properties": { "type": { "const": "dynamic" }, "ip": { "oneOf": [ { "type": "string", "oneOf": [ { "type": "string", "format": "ipv4" }, { "type": "string", "format": "ipv6" } ], "format": "ip" }, { "type": "null" } ], "description": "Fallback IP address (IPv4 or IPv6)" }, "port": { "oneOf": [ { "type": "integer", "maximum": 65535, "minimum": 1, "format": "int32" }, { "type": "null" } ], "description": "Target Port" } }, "title": "Dynamic member", "required": [ "name", "weight", "max_sessions", "type", "enabled" ] } ], "examples": [ { "name": "member-1", "weight": 100, "max_sessions": 1000, "type": "dynamic", "enabled": true } ], "properties": { "name": { "type": "string", "format": "domainname", "description": "Name of the member", "example": "member-1" }, "server_uuid": { "type": "string", "format": "uuid", "description": "Target server UUID", "example": "01234567-89ab-cdef-0123-456789abcdef" }, "weight": { "type": "integer", "examples": [ 100 ], "maximum": 100, "minimum": 0, "format": "int32", "description": "Target weight" }, "max_sessions": { "type": "integer", "examples": [ 1000 ], "maximum": 500000, "minimum": 0, "format": "int32", "description": "Maximum number of sessions before queueing" }, "type": { "$ref": "#/components/schemas/loadBalancerMemberType" }, "enabled": { "type": "boolean", "description": "Is member enabled" }, "backup": { "type": "boolean", "description": "Is backup member" }, "ip": { "type": [ "string", "null" ], "description": "IP address of the backend member server. Depending on the member type, this can be an IPv4 address, IPv6 address, or a domain name for dynamic members." }, "port": { "type": [ "integer", "null" ], "description": "Port number on which the backend member server listens." } }, "title": "Member Create", "additionalProperties": false, "description": "Load Balancer backend member" }, "loadBalancerMemberType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "dynamic" ], "title": "Member type", "enum": [ "static", "dynamic" ], "description": "Member type" }, "loadBalancerBackendPropertiesCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "timeout_server": { "type": "integer", "maximum": 2145600, "minimum": 1, "format": "int32", "description": "Server timeout" }, "timeout_tunnel": { "type": "integer", "maximum": 2145600, "minimum": 1, "format": "int32", "description": "Tunnel timeout" }, "outbound_proxy_protocol": { "$ref": "#/components/schemas/loadBalancerProxyProtocolVersionOrDisabled" }, "health_check_type": { "$ref": "#/components/schemas/loadBalancerHealthCheckType" }, "health_check_interval": { "type": "integer", "maximum": 86400, "minimum": 1, "format": "int32", "description": "Interval between health checks" }, "health_check_fall": { "type": "integer", "maximum": 100, "minimum": 1, "format": "int32", "description": "Sets how many failed health checks are allowed" }, "health_check_rise": { "type": "integer", "maximum": 100, "minimum": 1, "format": "int32", "description": "Sets how many passing checks there must be before returning server to the rotation" }, "health_check_url": { "type": "string", "maxLength": 255, "minLength": 1, "description": "Target url for health check HTTP GET requests" }, "health_check_expected_status": { "type": "integer", "maximum": 599, "minimum": 100, "format": "int32", "description": "Expected HTTP status code returned by the customer application to mark server as healthy", "example": 200 }, "health_check_on_down": { "$ref": "#/components/schemas/loadBalancerChecksOnDown" }, "health_check_tls_verify": { "type": "boolean", "description": "Allows health check CA verification on TLS connections" }, "sticky_session_cookie_name": { "type": [ "string", "null" ], "maxLength": 64, "pattern": "^[a-zA-Z0-9_-]*$", "description": "Sets sticky session cookie name. Empty string disables sticky session." }, "sticky_session_cookie_attributes": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 64, "pattern": "^$|^[a-zA-Z0-9=;\\s]+$" } ], "description": "Controls additional cookie attributes appended to sticky session cookies. Supports combinations of: SameSite=Strict|Lax|None, Secure, HttpOnly, Partitioned (semicolon-separated). Note: SameSite=None and Partitioned require Secure." }, "tls_enabled": { "type": "boolean", "description": "Enables TLS between LB backend and member servers" }, "tls_verify": { "type": "boolean", "description": "Enables CA verification on TLS backend connections" }, "tls_use_system_ca": { "type": "boolean", "description": "Force Load Balancer to verify member certificates against system CA bundle" }, "http2_enabled": { "type": "boolean", "description": "Allows for HTTP2 connection via ALPN" } }, "title": "Backend Properties Create", "additionalProperties": false, "description": "Backend Properties" }, "loadBalancerProxyProtocolVersionOrDisabled": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": [ "string", "null" ], "title": "Proxy protocol version or disabled", "enum": [ "v1", "v2", "", null ], "description": "Empty string means disabled" }, "loadBalancerHealthCheckType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "title": "Health check type", "enum": [ "tcp", "http" ], "description": "Health check type" }, "loadBalancerChecksOnDown": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "title": "Checks on down", "enum": [ "", "shutdown-sessions" ], "description": "Checks on down category" }, "loadBalancerResolverCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the resolver", "example": "default-resolver" }, "nameservers": { "type": "array", "items": { "type": "string", "format": "ipv4-port" }, "maxItems": 10, "minItems": 1, "description": "Nameservers", "example": [ "1.1.1.1:53", "8.8.8.8:53" ] }, "retries": { "type": "integer", "maximum": 10, "minimum": 1, "format": "int32", "description": "Number of retries on failure", "example": 3 }, "timeout": { "type": "integer", "maximum": 60, "minimum": 1, "format": "int32", "description": "Timeout for the query in seconds", "example": 5 }, "timeout_retry": { "type": "integer", "maximum": 60, "minimum": 1, "format": "int32", "description": "Timeout for the query retries in seconds", "example": 3 }, "cache_valid": { "type": "integer", "maximum": 86400, "minimum": 1, "format": "int32", "description": "Time in seconds to cache valid results", "example": 300 }, "cache_invalid": { "type": "integer", "maximum": 86400, "minimum": 1, "format": "int32", "description": "Time in seconds to cache invalid results", "example": 60 } }, "title": "Resolver Create", "required": [ "name", "nameservers", "retries", "timeout", "timeout_retry", "cache_valid", "cache_invalid" ], "additionalProperties": false, "description": "Load Balancer Resolver", "example": { "name": "default-resolver", "nameservers": [ "1.1.1.1:53", "8.8.8.8:53" ], "retries": 3, "timeout": 5, "timeout_retry": 3, "cache_valid": 300, "cache_invalid": 60 } }, "loadBalancerNetworkCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "my-network", "type": "private", "family": "IPv4" } ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the network" }, "uuid": { "type": "string", "format": "uuid", "description": "Network UUID" }, "type": { "$ref": "#/components/schemas/loadBalancerNetworkType" }, "family": { "$ref": "#/components/schemas/loadBalancerNetworkFamily" } }, "title": "Network Create", "required": [ "name", "type", "family" ], "additionalProperties": false, "description": "Load Balancer Network." }, "loadBalancerNetworkType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "title": "Network type", "enum": [ "public", "private" ], "description": "Network type" }, "loadBalancerNetworkFamily": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "title": "Network family", "enum": [ "IPv4", "IPv6" ], "description": "Network family" }, "loadBalancerLabelCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "key": { "type": "string", "maxLength": 32, "minLength": 2, "pattern": "^[\\x20-\\x5E\\x60-\\x7E][\\x20-\\x7E]+$", "description": "Key" }, "value": { "type": [ "string", "null" ], "maxLength": 255, "pattern": "\\A[\\p{L}\\p{N}\\p{P}\\p{S}\\p{M}\\p{Z}]*\\z", "description": "Value" } }, "title": "Label Create", "required": [ "key", "value" ], "additionalProperties": false, "description": "Load Balancer Label", "example": { "key": "environment", "value": "production" } }, "loadBalancerMaintenanceDayOfWeek": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "title": "maintenance day of week", "enum": [ "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday" ], "description": "Day of week", "example": "monday" }, "loadBalancerMaintenanceTime": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "title": "Maintenance Time", "pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]Z$", "description": "Maintenance time", "example": "03:15:00Z" }, "loadBalancerIpAddressCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "address": { "type": "string", "format": "ipv4", "description": "IP address", "example": "192.168.1.10" }, "network_name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the target network", "example": "private-net-1" } }, "title": "IP Address Create", "required": [ "address" ], "additionalProperties": false, "description": "IP address object", "example": { "address": "192.168.1.10", "network_name": "private-net-1" } }, "loadBalancerServiceReplace": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "my-loadbalancer", "plan": "production", "configured_status": "started" } ], "properties": { "name": { "type": "string", "examples": [ "my-loadbalancer" ], "maxLength": 64, "minLength": 1, "description": "Name of the service" }, "plan": { "type": "string", "examples": [ "production" ], "description": "Plan" }, "configured_status": { "$ref": "#/components/schemas/loadBalancerServiceConfiguredStatus" }, "frontends": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerFrontendCreate" }, "description": "Service frontends" }, "backends": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerBackendCreate" }, "description": "Service backends" }, "resolvers": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerResolverCreate" }, "description": "Service resolvers" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerLabelCreate" }, "maxItems": 255, "description": "Labels" }, "maintenance_dow": { "$ref": "#/components/schemas/loadBalancerMaintenanceDayOfWeek" }, "maintenance_time": { "$ref": "#/components/schemas/loadBalancerMaintenanceTime" }, "ip_addresses": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerIpAddressCreate" }, "description": "List of IP addresses for the network" } }, "title": "Service Replace", "required": [ "name", "plan", "configured_status" ], "additionalProperties": false, "description": "Load Balancer Service." }, "loadBalancerServiceModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "updated-loadbalancer" } ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "description": "Name of the service", "example": "updated-loadbalancer" }, "plan": { "type": "string", "description": "Plan", "example": "production" }, "configured_status": { "$ref": "#/components/schemas/loadBalancerServiceConfiguredStatus" }, "frontends": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/loadBalancerFrontendCreate" }, "description": "Service frontends" }, "backends": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/loadBalancerBackendCreate" }, "description": "Service backends" }, "resolvers": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/loadBalancerResolverCreate" }, "description": "Service resolvers" }, "labels": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/loadBalancerLabelCreate" }, "maxItems": 255, "description": "Labels" }, "maintenance_dow": { "$ref": "#/components/schemas/loadBalancerMaintenanceDayOfWeek" }, "maintenance_time": { "$ref": "#/components/schemas/loadBalancerMaintenanceTime" }, "ip_addresses": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerIpAddressCreate" }, "description": "List of IP addresses for the network" } }, "title": "Service Modify", "additionalProperties": false, "description": "Load Balancer Service" }, "loadBalancerFrontendModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "updated-frontend", "port": 443 } ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the frontend" }, "port": { "type": "integer", "maximum": 65535, "minimum": 1, "format": "int32", "description": "Port to listen" }, "mode": { "$ref": "#/components/schemas/loadBalancerFrontendMode" }, "default_backend": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Default backend" }, "properties": { "$ref": "#/components/schemas/loadBalancerFrontendPropertiesCreate" }, "networks": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerFrontendNetworkCreate" }, "description": "Network names" }, "tls_configs": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/loadBalancerTlsConfigCreate" }, "description": "TLS Configs" }, "rules": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/loadBalancerRuleCreate" }, "description": "Rules" } }, "title": "Frontend Modify", "additionalProperties": false, "description": "Load Balancer Frontend" }, "loadBalancerTlsConfigModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "updated-tls-config" } ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the config" }, "certificate_bundle_uuid": { "type": "string", "format": "uuid", "description": "Certificate Bundle UUID" } }, "title": "TLS Config Modify", "additionalProperties": false, "description": "Load Balancer TLS Config", "example": { "name": "tls-config-1", "certificate_bundle_uuid": "123e4567-e89b-12d3-a456-426614174000" } }, "loadBalancerRuleModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "updated-rule", "priority": 10 } ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the rule" }, "priority": { "type": "integer", "maximum": 100, "minimum": 0, "format": "int32", "description": "Priority" }, "matching_condition": { "$ref": "#/components/schemas/loadBalancerMatchingCondition" }, "matchers": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/loadBalancerMatcherCreate" }, "maxItems": 40, "description": "Rule matchers" }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerActionCreate" }, "maxItems": 40, "minItems": 1, "description": "Rule actions" } }, "title": "Rule Modify", "additionalProperties": false, "description": "Load Balancer Forwarding Rule" }, "loadBalancerBackendModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "updated-backend" } ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the backend" }, "members": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/loadBalancerMemberModify" }, "description": "Backend members" }, "tls_configs": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/loadBalancerTlsConfigCreate" }, "description": "TLS Configs" }, "resolver": { "oneOf": [ { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$" }, { "type": "string" }, { "type": "null" } ], "description": "Resolver reference" }, "properties": { "$ref": "#/components/schemas/loadBalancerBackendPropertiesCreate" } }, "title": "Backend Modify", "additionalProperties": false, "description": "Load Balancer Backend" }, "loadBalancerMemberModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "oneOf": [ { "properties": { "type": { "const": "static" }, "ip": { "type": "string", "oneOf": [ { "type": "string", "format": "ipv4" }, { "type": "string", "format": "ipv6" } ], "format": "ip", "description": "Target IP address (IPv4 or IPv6)" }, "port": { "type": "integer", "maximum": 65535, "minimum": 1, "format": "int32", "description": "Target Port" } }, "title": "Static member" }, { "properties": { "type": { "const": "dynamic" }, "ip": { "oneOf": [ { "type": "string", "oneOf": [ { "type": "string", "format": "ipv4" }, { "type": "string", "format": "ipv6" } ], "format": "ip" }, { "type": "null" } ], "description": "Fallback IP address (IPv4 or IPv6)" }, "port": { "oneOf": [ { "type": "integer", "maximum": 65535, "minimum": 1, "format": "int32" }, { "type": "null" } ], "description": "Target Port" } }, "title": "Dynamic member", "required": [ "type" ] } ], "examples": [ { "name": "updated-member", "enabled": true } ], "properties": { "name": { "type": "string", "format": "domainname", "description": "Name of the member" }, "server_uuid": { "type": "string", "format": "uuid", "description": "Target server UUID" }, "weight": { "type": "integer", "maximum": 100, "minimum": 0, "format": "int32", "description": "Target weight" }, "max_sessions": { "type": "integer", "maximum": 500000, "minimum": 0, "format": "int32", "description": "Maximum number of sessions before queueing" }, "type": { "$ref": "#/components/schemas/loadBalancerMemberType" }, "enabled": { "type": "boolean", "description": "Is member enabled" }, "backup": { "type": "boolean", "description": "Is backup member" }, "ip": { "type": [ "string", "null" ], "description": "IP address of the backend member server. Depending on the member type, this can be an IPv4 address, IPv6 address, or a domain name for dynamic members." }, "port": { "type": [ "integer", "null" ], "description": "Port number on which the backend member server listens." } }, "title": "Member Modify", "additionalProperties": false, "description": "Load Balancer backend member" }, "loadBalancerNetworkModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "updated-network" } ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the network" } }, "title": "Network Modify", "additionalProperties": false, "description": "Load Balancer Network" }, "loadBalancerResolverModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "updated-resolver" } ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the resolver", "example": "custom-resolver" }, "nameservers": { "type": "array", "items": { "type": "string", "format": "ipv4-port" }, "maxItems": 10, "minItems": 1, "description": "Nameservers", "example": [ "1.1.1.1:53", "8.8.8.8:53" ] }, "retries": { "type": "integer", "maximum": 10, "minimum": 1, "format": "int32", "description": "Number of retries on failure", "example": 3 }, "timeout": { "type": "integer", "maximum": 60, "minimum": 1, "format": "int32", "description": "Timeout for the query in seconds", "example": 5 }, "timeout_retry": { "type": "integer", "maximum": 60, "minimum": 1, "format": "int32", "description": "Timeout for the query retries in seconds", "example": 3 }, "cache_valid": { "type": "integer", "maximum": 86400, "minimum": 1, "format": "int32", "description": "Time in seconds to cache valid results", "example": 300 }, "cache_invalid": { "type": "integer", "maximum": 86400, "minimum": 1, "format": "int32", "description": "Time in seconds to cache invalid results", "example": 60 } }, "title": "Resolver Modify", "additionalProperties": false, "description": "Load Balancer Resolver", "example": { "name": "default-resolver", "nameservers": [ "1.1.1.1:53", "8.8.8.8:53" ], "retries": 3, "timeout": 5, "timeout_retry": 3, "cache_valid": 300, "cache_invalid": 60 } }, "loadBalancerLabelModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "key": "updated-key", "value": "updated-value" } ], "properties": { "key": { "type": "string", "maxLength": 32, "minLength": 2, "pattern": "^[\\x20-\\x5E\\x60-\\x7E][\\x20-\\x7E]+$", "description": "Key" }, "value": { "type": [ "string", "null" ], "maxLength": 255, "pattern": "\\A[\\p{L}\\p{N}\\p{P}\\p{S}\\p{M}\\p{Z}]*\\z", "description": "Value" } }, "title": "Label Modify", "additionalProperties": false, "description": "Load Balancer Label", "example": { "key": "environment", "value": "production" } }, "loadBalancerCertificateBundleCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "oneOf": [ { "properties": { "type": { "const": "manual" }, "hostnames": { "type": "null" }, "key_type": { "type": "null" } }, "title": "Manual bundle", "required": [ "name", "type", "certificate", "private_key" ] }, { "properties": { "type": { "const": "dynamic" }, "certificate": { "type": "null" }, "intermediates": { "type": "null" }, "private_key": { "type": "null" } }, "title": "Dynamic bundle", "required": [ "name", "type", "hostnames", "key_type" ] }, { "properties": { "type": { "const": "authority" }, "hostnames": { "type": "null" }, "key_type": { "type": "null" }, "private_key": { "type": "null" }, "intermediates": { "type": "null" } }, "title": "Authority bundle", "required": [ "name", "type", "certificate" ] } ], "examples": [ { "name": "my-certificate", "type": "manual", "certificate": "LS0tLS1CRUdJTi...==", "private_key": "LS0tLS1CRUdJTi...==" } ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the bundle", "example": "my-certificate-bundle" }, "type": { "type": "string", "title": "CertificateBundleCreateTlsType", "enum": [ "manual", "dynamic", "authority" ], "description": "Certificate bundle type", "example": "manual" }, "hostnames": { "type": "array", "items": { "type": "string", "format": "domainname-allow-wildcard" }, "maxItems": 100, "minItems": 1, "description": "Array of hostnames" }, "certificate": { "type": [ "string", "null" ], "format": "certificate", "description": "Certificate", "contentEncoding": "base64" }, "intermediates": { "type": [ "string", "null" ], "format": "multiple-certificates", "description": "Intermediate certificates", "contentEncoding": "base64" }, "private_key": { "type": [ "string", "null" ], "format": "private-key", "description": "Private key", "contentEncoding": "base64" }, "challenge_key": { "type": "string", "maxLength": 64, "minLength": 1, "description": "Unique key used for ACME DNS challenge validation when obtaining certificates dynamically." }, "key_type": { "type": "string", "title": "CertificateBundleCreateKeyType", "enum": [ "rsa", "ecdsa" ], "description": "Private key type" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerLabelCreate" }, "maxItems": 255, "description": "Labels" } }, "title": "Certificate Bundle Create", "required": [ "name", "type" ], "additionalProperties": false, "description": "Load Balancer certificate bundle" }, "loadBalancerCertificateBundleModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "oneOf": [ { "$ref": "#/components/schemas/loadBalancerCertificateBundleManualModify" }, { "$ref": "#/components/schemas/loadBalancerCertificateBundleDynamicModify" }, { "$ref": "#/components/schemas/loadBalancerCertificateBundleAuthorityModify" } ], "examples": [ { "name": "updated-cert-bundle", "certificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0t...", "private_key": "LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQo=" } ], "title": "Certificate Bundle Modify", "description": "Modify a load balancer certificate bundle (manual, dynamic, or authority type)" }, "loadBalancerCertificateBundleManualModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "updated-manual-cert" } ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the bundle" }, "certificate": { "type": [ "string", "null" ], "format": "certificate", "description": "Certificate", "contentEncoding": "base64" }, "intermediates": { "type": [ "string", "null" ], "format": "multiple-certificates", "description": "Intermediate certificates", "contentEncoding": "base64" }, "private_key": { "type": [ "string", "null" ], "format": "private-key", "description": "Private key", "contentEncoding": "base64" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerLabelCreate" }, "maxItems": 255, "description": "Labels" } }, "title": "Certificate Bundle Manual Modify", "additionalProperties": false, "description": "Load Balancer certificate bundle manual type" }, "loadBalancerCertificateBundleDynamicModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "updated-dynamic-cert" } ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the bundle" }, "hostnames": { "type": "array", "items": { "type": "string", "format": "domainname-allow-wildcard" }, "maxItems": 1000, "minItems": 1, "description": "Array of hostnames" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerLabelCreate" }, "maxItems": 255, "description": "Labels" }, "challenge_key": { "type": "string", "maxLength": 64, "minLength": 1, "description": "Unique key used for ACME DNS challenge validation when obtaining certificates dynamically." } }, "title": "Certificate Bundle Dynamic Modify", "additionalProperties": false, "description": "Load Balancer certificate bundle dynamic type" }, "loadBalancerCertificateBundleAuthorityModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "updated-cert-bundle" } ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the bundle" }, "certificate": { "type": "string", "format": "certificate", "description": "Certificate", "contentEncoding": "base64" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerLabelCreate" }, "maxItems": 255, "description": "Labels" } }, "title": "Certificate Bundle Authority Modify", "additionalProperties": false, "description": "Load Balancer certificate bundle dynamic type" }, "loadBalancerServicesResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerService" }, "title": "Services Response", "description": "Response schema for a list of services." }, "loadBalancerService": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "uuid": "b7a3f6a4-4a8f-4a5c-b7a5-9c9a1e5a6d3e", "name": "loadbalancer-prod-eu", "zone": "de-fra1", "plan": "medium", "configured_status": "configured", "operational_state": "running", "frontends": [], "backends": [], "resolvers": [], "networks": [], "ip_addresses": [], "labels": [], "maintenance_dow": "tuesday", "maintenance_time": "02:00:00.000Z", "created_at": "2025-11-06T08:00:00.000Z", "updated_at": "2025-11-06T09:15:00.000Z" } ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier of the service.", "example": "b7a3f6a4-4a8f-4a5c-b7a5-9c9a1e5a6d3e" }, "name": { "type": "string", "description": "Human-readable name assigned to the service.", "example": "loadbalancer-prod-eu" }, "zone": { "type": "string", "description": "UpCloud zone where the service is deployed.", "example": "de-fra1" }, "plan": { "type": "string", "description": "Selected load balancer plan defining node size, performance, and pricing tier.", "example": "medium" }, "configured_status": { "type": "string", "description": "Configuration status of the service (e.g., whether all components are correctly provisioned).", "example": "configured" }, "operational_state": { "type": "string", "enum": [ "pending", "running", "failing", "stopped", "degraded" ], "description": "Current operational state of the service, describing its runtime behavior and availability.", "example": "running" }, "frontends": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/loadBalancerFrontend" }, "description": "List of frontend configurations associated with the service." }, "backends": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/loadBalancerBackend" }, "description": "List of backend configurations linked to this service." }, "resolvers": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/loadBalancerResolver" }, "description": "DNS resolvers available for this service." }, "networks": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/loadBalancerNetwork" }, "description": "Networks attached to this service." }, "ip_addresses": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/loadBalancerIpAddress" }, "description": "IP addresses assigned to this service." }, "labels": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/loadBalancerLabelResponse" }, "description": "Labels associated with the service for metadata tagging and identification." }, "maintenance_dow": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "description": "Day of week scheduled for maintenance operations.", "example": "tuesday" }, "maintenance_time": { "type": "string", "examples": [ "2025-11-06T08:00:00.000Z" ], "format": "time", "description": "Time of day (in UTC) scheduled for maintenance operations." }, "created_at": { "type": "string", "examples": [ "2025-11-06T08:00:00.000Z" ], "format": "date-time", "description": "Timestamp when the service was created." }, "updated_at": { "type": "string", "examples": [ "2025-11-06T09:15:00.000Z" ], "format": "date-time", "description": "Timestamp when the service was last updated." }, "network_uuid": { "type": "string", "description": "Deprecated: old field replaced by the networks array." }, "dns_name": { "type": "string", "description": "Deprecated: legacy DNS field replaced by service-level IP addressing." } }, "title": "Service", "required": [ "uuid", "name", "zone", "plan", "configured_status", "created_at", "updated_at" ], "additionalProperties": false, "description": "Represents a load balancer service instance that groups together frontends, backends, and related agents. It defines the service plan, network configuration, and operational state across all nodes." }, "loadBalancerFrontend": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "frontend-1", "port": 80, "mode": "http", "default_backend": "backend-1", "tls_configs": [ { "name": "frontend-tls-config", "certificate_bundle_uuid": "a4b9f1a3-9b7c-4f21-8b33-fd68efb7c001", "created_at": "2025-11-06T10:15:00.000Z", "updated_at": "2025-11-06T11:00:00.000Z" } ], "rules": [ { "name": "redirect-to-https", "priority": 1, "matching_condition": "and", "matchers": [ { "type": "path", "inverse": false, "match_path": { "method": "starts_with", "value": "/api", "ignore_case": true } } ], "actions": [ { "type": "set_forwarded_headers", "action_set_forwarded_headers": {} }, { "type": "set_request_header", "action_set_request_header": { "header": "X-Forwarded-Proto", "value": "https" } }, { "type": "http_redirect", "action_http_redirect": { "location": "https://example.com", "status": 301 } } ], "created_at": "2025-11-06T09:00:00.000Z", "updated_at": "2025-11-06T09:30:00.000Z" } ], "properties": { "inbound_proxy_protocol": false, "timeout_client": 50000, "http2_enabled": true, "frontend_id": 301 }, "networks": [ { "name": "public-network" }, { "name": "private-network" } ], "created_at": "2025-11-06T09:00:00.000Z", "updated_at": "2025-12-06T09:00:00.000Z" } ], "properties": { "name": { "type": "string", "description": "Human-readable name assigned to the frontend.", "example": "frontend-1" }, "port": { "type": "integer", "format": "int32", "description": "Port number on which the frontend listens for incoming connections.", "example": 80 }, "mode": { "type": "string", "enum": [ "http", "tcp" ], "description": "Operating mode defining the protocol layer at which the frontend operates.", "example": "http" }, "default_backend": { "type": "string", "description": "Name of the backend used when no routing rules match the incoming request.", "example": "backend-1" }, "tls_configs": { "$ref": "#/components/schemas/loadBalancerTlsConfigsResponse" }, "rules": { "$ref": "#/components/schemas/loadBalancerRulesResponse" }, "properties": { "$ref": "#/components/schemas/loadBalancerFrontendPropertiesResponse" }, "networks": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false }, "example": [ { "name": "public-network" }, { "name": "private-network" } ] }, "created_at": { "type": "string", "examples": [ "2025-11-06T09:00:00.000Z" ], "format": "date-time", "description": "Timestamp when the frontend was created (RFC 3339 format)." }, "updated_at": { "type": "string", "examples": [ "2025-12-06T09:00:00.000Z" ], "format": "date-time", "description": "Timestamp when the frontend was last updated (RFC 3339 format)." } }, "title": "Frontend", "required": [ "name", "port", "mode", "default_backend", "tls_configs", "rules", "properties", "networks", "created_at", "updated_at" ], "description": "Represents a frontend configuration in the load balancer service, defining how client connections are received, the listening port and protocol, TLS settings, routing rules, and default backend association." }, "loadBalancerTlsConfigsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerTlsConfig" }, "title": "TLS Configs Response", "description": "Represents a list of TLS configuration for a frontend or backend, defining the certificate bundle and associated identifiers within the load balancer service." }, "loadBalancerTlsConfig": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "frontend-tls-config", "certificate_bundle_uuid": "a4b9f1a3-9b7c-4f21-8b33-fd68efb7c001", "created_at": "2025-11-06T10:15:00.000Z", "updated_at": "2025-11-06T11:00:00.000Z" } ], "properties": { "name": { "type": "string", "description": "Human-readable name assigned to the TLS configuration.", "example": "frontend-tls-config" }, "certificate_bundle_uuid": { "type": "string", "format": "uuid", "description": "UUID of the certificate bundle used for TLS encryption.", "example": "a4b9f1a3-9b7c-4f21-8b33-fd68efb7c001" }, "created_at": { "type": "string", "examples": [ "2025-11-06T10:15:00.000Z" ], "format": "date-time", "description": "Timestamp when the TLS configuration was created (RFC 3339 format)." }, "updated_at": { "type": "string", "examples": [ "2025-11-06T11:00:00.000Z" ], "format": "date-time", "description": "Timestamp when the TLS configuration was last updated (RFC 3339 format)." } }, "title": "TLS Config", "required": [ "name", "certificate_bundle_uuid", "created_at", "updated_at" ], "description": "Represents a TLS configuration for a frontend or backend, defining the certificate bundle and associated identifiers within the load balancer service." }, "loadBalancerRulesResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerRule" }, "title": "Rules Response", "description": "Represents a list of load balancer rules that define how incoming requests are matched and processed, including conditions, actions, and backend target associations." }, "loadBalancerRule": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "redirect-to-https", "priority": 1, "matching_condition": "and", "matchers": [ { "type": "path", "inverse": false, "match_path": { "method": "starts_with", "value": "/api", "ignore_case": true } } ], "actions": [ { "type": "set_forwarded_headers", "action_set_forwarded_headers": {} }, { "type": "set_request_header", "action_set_request_header": { "header": "X-Forwarded-Proto", "value": "https" } }, { "type": "http_redirect", "action_http_redirect": { "location": "https://example.com", "status": 301 } } ], "created_at": "2025-11-06T09:00:00.000Z", "updated_at": "2025-11-06T09:30:00.000Z" } ], "properties": { "name": { "type": "string", "description": "Human-readable name assigned to the routing rule.", "example": "redirect-to-https" }, "priority": { "type": "integer", "format": "int32", "description": "Priority order for rule evaluation, where lower values indicate higher priority.", "example": 100 }, "matching_condition": { "type": "string", "enum": [ "and", "or" ], "description": "Logical operator determining how multiple matchers are combined (and/or).", "example": "and" }, "matchers": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerMatcherResponse" }, "description": "List of conditions that incoming requests must satisfy for this rule to apply.", "example": [ { "type": "path", "inverse": false, "match_path": { "method": "starts_with", "value": "/api", "ignore_case": true } } ] }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerActionResponse" }, "description": "List of actions to execute when the rule matches an incoming request.", "example": [ { "type": "set_forwarded_headers", "action_set_forwarded_headers": {} }, { "type": "set_request_header", "action_set_request_header": { "header": "X-Forwarded-Proto", "value": "https" } }, { "type": "http_redirect", "action_http_redirect": { "location": "https://example.com", "status": 301 } } ] }, "created_at": { "type": "string", "examples": [ "2025-11-06T09:00:00.000Z" ], "format": "date-time", "description": "Timestamp when the rule was created (RFC 3339 format)." }, "updated_at": { "type": "string", "examples": [ "2025-12-06T09:00:00.000Z" ], "format": "date-time", "description": "Timestamp when the rule was last updated (RFC 3339 format)." } }, "title": "Rule", "required": [ "name", "priority", "matching_condition", "matchers", "actions", "created_at", "updated_at" ], "description": "Represents a load balancer rule that defines how incoming traffic is matched and processed by a frontend, including priority, matching conditions, and actions to perform." }, "loadBalancerMatcherResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "type": { "type": "string", "enum": [ "src_ip", "src_port", "body_size", "cookie", "header", "url_param", "request_header", "response_header", "http_status", "http_method", "path", "url", "host", "url_query", "num_members_up" ], "description": "Type of matcher defining which aspect of the request or response to evaluate." }, "inverse": { "type": "boolean", "description": "Indicates whether to invert the match result (true) or use it as-is (false)." }, "match_src_ip": { "$ref": "#/components/schemas/loadBalancerMatchIpResponse" }, "match_src_port": { "$ref": "#/components/schemas/loadBalancerMatchIntResponse" }, "match_body_size": { "$ref": "#/components/schemas/loadBalancerMatchIntResponse" }, "match_cookie": { "$ref": "#/components/schemas/loadBalancerMatchStringWithArgResponse" }, "match_header": { "$ref": "#/components/schemas/loadBalancerMatchStringWithArgResponse" }, "match_url_param": { "$ref": "#/components/schemas/loadBalancerMatchStringWithArgResponse" }, "match_request_header": { "$ref": "#/components/schemas/loadBalancerMatchStringWithArgResponse" }, "match_response_header": { "$ref": "#/components/schemas/loadBalancerMatchStringWithArgResponse" }, "match_http_status": { "$ref": "#/components/schemas/loadBalancerMatchIntResponse" }, "match_http_method": { "$ref": "#/components/schemas/loadBalancerMatchStringResponse" }, "match_path": { "$ref": "#/components/schemas/loadBalancerMatchStringResponse" }, "match_url": { "$ref": "#/components/schemas/loadBalancerMatchStringResponse" }, "match_host": { "$ref": "#/components/schemas/loadBalancerMatchStringResponse" }, "match_url_query": { "$ref": "#/components/schemas/loadBalancerMatchStringResponse" }, "match_num_members_up": { "$ref": "#/components/schemas/loadBalancerMatchBackendResponse" } }, "title": "Matcher Response", "required": [ "type", "inverse" ], "additionalProperties": false, "description": "Defines a matcher used to evaluate specific conditions in requests or responses.", "example": { "type": "src_ip", "inverse": false, "match_src_ip": { "value": "192.168.1.0/24" } } }, "loadBalancerMatchIpResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "value": { "type": "string", "description": "IP address or CIDR subnet to match against the source IP. Accepts IPv4, IPv6, or CIDR notation." } }, "title": "Match IP Response", "required": [ "value" ], "additionalProperties": false, "description": "Defines a match condition based on the source IP address or subnet. Used when the matcher type is 'src_ip'.", "example": { "value": "192.168.1.0/24" } }, "loadBalancerMatchIntResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "method": { "type": "string", "enum": [ "equal", "greater_or_equal", "greater", "less_or_equal", "less" ], "description": "Comparison method used to evaluate the integer value.", "example": "greater_or_equal" }, "value": { "type": "integer", "minimum": 0, "format": "int32", "description": "Integer value to compare against using the specified comparison method." }, "range_start": { "type": "integer", "format": "int32", "description": "Starting value of the range for range-based integer matching.", "example": 0 }, "range_end": { "type": "integer", "format": "int32", "description": "Ending value of the range for range-based integer matching.", "example": 1024 } }, "title": "Match Int Response", "required": [ "method", "value" ], "additionalProperties": true, "description": "Defines integer matching criteria for requests or responses.", "example": { "method": "greater_or_equal", "value": 100, "range_start": 0, "range_end": 1024 } }, "loadBalancerMatchStringWithArgResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "allOf": [ { "$ref": "#/components/schemas/loadBalancerMatchStringResponse" }, { "type": "object", "properties": { "name": { "type": "string", "example": "Authorization" } }, "required": [ "name" ] } ], "title": "Match String With Arg Response", "description": "Extends MatchString with an additional 'name' parameter, used for matchers that require a key-value pair (e.g., matching headers, cookies, or URL parameters).", "example": { "name": "Authorization", "method": "contains", "value": "/api", "ignore_case": true } }, "loadBalancerMatchStringResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "method": { "type": "string", "enum": [ "equal", "contains", "starts_with", "ends_with", "regex" ], "description": "String comparison method used to evaluate the match condition.", "example": "contains" }, "value": { "type": "string", "description": "String value or pattern to match against using the specified comparison method.", "example": "/api" }, "ignore_case": { "type": "boolean", "description": "Indicates whether the string comparison should be case-insensitive.", "example": true } }, "title": "Match String Response", "additionalProperties": true, "description": "Defines a string-based match condition, used for matching values such as paths, headers, URLs, or hostnames.", "example": { "method": "contains", "value": "/api", "ignore_case": true } }, "loadBalancerMatchBackendResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "allOf": [ { "$ref": "#/components/schemas/loadBalancerMatchIntResponse" }, { "type": "object", "properties": { "backend": { "type": "string", "example": "backend-1" } }, "required": [ "backend" ], "additionalProperties": true } ], "title": "Match Backend Response", "description": "Defines a backend health matcher used to compare the number of healthy (up) members in a specific backend against a threshold value. Used when the matcher type is 'num_members_up'.", "example": { "backend": "backend-1", "method": "greater_or_equal", "value": 2, "range_start": 0, "range_end": 10 } }, "loadBalancerActionResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "type": { "type": "string", "enum": [ "use_backend", "http_return", "http_redirect", "tcp_reject", "set_forwarded_headers", "set_request_header", "set_response_header", "http_rewrite_path", "http_rewrite_uri" ], "description": "Type of action defining how matched requests should be processed or modified.", "example": "use_backend" }, "action_use_backend": { "$ref": "#/components/schemas/loadBalancerActionUseBackendResponse" }, "action_http_return": { "$ref": "#/components/schemas/loadBalancerActionHttpReturnResponse" }, "action_http_redirect": { "$ref": "#/components/schemas/loadBalancerActionHttpRedirectResponse" }, "action_tcp_reject": { "$ref": "#/components/schemas/loadBalancerActionTcpRejectResponse" }, "action_set_forwarded_headers": { "$ref": "#/components/schemas/loadBalancerActionSetForwardedHeadersResponse" }, "action_set_request_header": { "$ref": "#/components/schemas/loadBalancerActionSetHeaderResponse" }, "action_set_response_header": { "$ref": "#/components/schemas/loadBalancerActionSetHeaderResponse" }, "action_http_rewrite_path": { "$ref": "#/components/schemas/loadBalancerActionHttpRewritePathResponse" }, "action_http_rewrite_uri": { "$ref": "#/components/schemas/loadBalancerActionHttpRewriteUriResponse" } }, "title": "Action Response", "required": [ "type" ], "additionalProperties": false, "description": "Represents a rule action that defines how matched traffic should be processed or modified within the load balancer. Each action type includes a corresponding configuration object.", "example": { "type": "use_backend", "action_use_backend": { "backend": "api-backend" } } }, "loadBalancerActionUseBackendResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "backend": { "type": "string", "description": "Name of the backend to which the request should be routed when this action executes.", "example": "api-backend" } }, "title": "Action Use Backend Response", "required": [ "backend" ], "additionalProperties": false, "description": "Defines the backend target to which the request should be routed when the rule matches. Used when the action type is 'use_backend'.", "example": { "backend": "api-backend" } }, "loadBalancerActionHttpReturnResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "status": { "type": "integer", "maximum": 599, "minimum": 100, "format": "int32", "description": "HTTP status code to return.", "example": 403 }, "content_type": { "type": "string", "description": "MIME type of the response body.", "example": "text/plain" }, "payload": { "type": "string", "description": "Base64-encoded payload returned as the response body.", "contentEncoding": "base64", "example": "QWNjZXNzIERlbmllZAo=" } }, "title": "Action HTTP Return Response", "required": [ "status", "content_type", "payload" ], "additionalProperties": false, "description": "Defines a custom HTTP response returned to the client when a rule matches. Used when the action type is 'http_return'.", "example": { "status": 403, "content_type": "text/plain", "payload": "QWNjZXNzIERlbmllZAo=" } }, "loadBalancerActionHttpRedirectResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "location": { "type": "string", "description": "Absolute or relative URL to which requests are redirected.", "example": "https://example.com" }, "status": { "type": "integer", "format": "int32", "description": "HTTP status code for the redirection. Common values are 301 (permanent) or 302 (temporary).", "example": 301 } }, "title": "Action HTTP Redirect Response", "required": [ "location", "status" ], "additionalProperties": false, "description": "Defines an HTTP redirection action used to redirect incoming requests to a specified URL with a given HTTP status code. Used when the action type is 'http_redirect'.", "example": { "location": "https://example.com", "status": 301 } }, "loadBalancerActionTcpRejectResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "title": "Action TCP Reject Response", "additionalProperties": false, "description": "Defines a TCP rejection action that immediately closes incoming connections when a rule matches. Used when the action type is 'tcp_reject'.", "example": {} }, "loadBalancerActionSetForwardedHeadersResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "title": "Action Set Forwarded Headers Response", "additionalProperties": false, "description": "Defines an action that automatically adds standard X-Forwarded-* headers (such as X-Forwarded-For and X-Forwarded-Proto) to requests before forwarding them to the backend. Used when the action type is 'set_forwarded_headers'.", "example": {} }, "loadBalancerActionSetHeaderResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "header": { "type": "string", "description": "Name of the HTTP header to add or modify.", "example": "X-Custom-Header" }, "value": { "type": "string", "description": "Value to assign to the specified header.", "example": "Processed-By-UpCloud-LB" } }, "title": "Action Set Header Response", "required": [ "header", "value" ], "additionalProperties": false, "description": "Defines an action that adds or modifies an HTTP header in a request or response. Used when the action type is 'set_request_header' or 'set_response_header'.", "example": { "header": "X-Custom-Header", "value": "Processed-By-UpCloud-LB" } }, "loadBalancerActionHttpRewritePathResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "match_pattern": { "type": "string", "description": "Regex pattern to match against the path." }, "rewrite_to": { "type": "string", "description": "Replacement pattern (can use capture groups like \\1)." } }, "title": "Action HTTP Rewrite Path Response", "required": [ "match_pattern", "rewrite_to" ], "additionalProperties": false, "description": "Defines an action that rewrites the HTTP request path using a regex pattern.", "example": { "match_pattern": "^/api/(.*)$", "rewrite_to": "/v2/\\1" } }, "loadBalancerActionHttpRewriteUriResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "match_pattern": { "type": "string", "description": "Regex pattern to match against the full URI." }, "rewrite_to": { "type": "string", "description": "Replacement pattern (can use capture groups like \\1)." } }, "title": "Action HTTP Rewrite Uri Response", "required": [ "match_pattern", "rewrite_to" ], "additionalProperties": false, "description": "Defines an action that rewrites the HTTP request URI using a regex pattern.", "example": { "match_pattern": "^/api/(.*)$", "rewrite_to": "/v2/\\1" } }, "loadBalancerFrontendPropertiesResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "inbound_proxy_protocol": { "type": "boolean", "description": "Enables or disables support for the Proxy Protocol on inbound connections, allowing client IP addresses to be forwarded to the backend.", "example": false }, "timeout_client": { "type": "integer", "format": "int32", "description": "Maximum inactivity timeout for a client connection, in milliseconds. Determines how long a client connection can remain idle before being closed.", "example": 50000 }, "http2_enabled": { "type": "boolean", "description": "Indicates whether HTTP/2 protocol support is enabled for this frontend.", "example": true }, "frontend_id": { "type": "integer", "format": "int32", "description": "Identifier linking these properties to the parent frontend configuration.", "example": 301 } }, "title": "Frontend Properties Response", "required": [ "timeout_client", "frontend_id" ], "additionalProperties": false, "description": "Defines configurable properties for a frontend, such as client timeout settings, protocol options, and linkage to its parent frontend resource.", "example": { "inbound_proxy_protocol": false, "timeout_client": 50000, "http2_enabled": true, "frontend_id": 301 } }, "loadBalancerBackend": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "api-backend", "members": [ { "name": "member-1", "ip": "192.168.1.10", "port": 8080, "weight": 10, "max_sessions": 100, "type": "static", "enabled": true, "backup": false, "created_at": "2025-11-05T12:30:00.000Z", "updated_at": "2025-11-05T13:45:00.000Z" } ], "tls_configs": [ { "name": "backend-tls-config", "certificate_bundle_uuid": "a4b9f1a3-9b7c-4f21-8b33-fd68efb7c001", "created_at": "2025-11-06T10:15:00.000Z", "updated_at": "2025-11-06T11:00:00.000Z" } ], "resolver": "resolver-default", "properties": { "backend_id": 401, "timeout_server": 5000, "timeout_tunnel": 15000, "health_check_type": "http", "health_check_interval": 10, "health_check_fall": 3, "health_check_rise": 2, "health_check_url": "/status", "health_check_expected_status": 200, "health_check_tls_verify": true, "health_check_on_down": "shutdown-sessions", "tls_enabled": true, "tls_verify": true, "tls_use_system_ca": false, "http2_enabled": true }, "created_at": "2025-11-06T09:00:00.000Z", "updated_at": "2025-11-06T11:30:00.000Z" } ], "properties": { "name": { "type": "string", "description": "Human-readable name of the backend", "example": "api-backend" }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerMember" }, "description": "List of backend member servers (nodes) participating in this backend configuration.", "example": [ { "name": "member-1", "ip": "192.168.1.10", "port": 8080, "weight": 10, "max_sessions": 100, "type": "static", "enabled": true, "backup": false, "created_at": "2025-11-05T12:30:00.000Z", "updated_at": "2025-11-05T13:45:00.000Z" }, { "name": "member-2", "ip": "192.168.1.11", "port": 8080, "weight": 8, "max_sessions": 120, "type": "static", "enabled": true, "backup": false, "created_at": "2025-11-05T12:35:00.000Z", "updated_at": "2025-11-05T13:50:00.000Z" } ] }, "tls_configs": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerTlsConfig" }, "description": "TLS configurations associated with this backend, specifying certificate bundles and identifiers.", "example": [ { "name": "backend-tls-config", "certificate_bundle_uuid": "a4b9f1a3-9b7c-4f21-8b33-fd68efb7c001", "created_at": "2025-11-06T10:15:00.000Z", "updated_at": "2025-11-06T11:00:00.000Z" } ] }, "resolver": { "type": [ "string", "null" ], "description": "Optional outbound DNS resolver reference used by this backend. Null when not set.", "example": "resolver-default" }, "properties": { "$ref": "#/components/schemas/loadBalancerBackendPropertiesResponse" }, "created_at": { "type": "string", "examples": [ "2025-11-06T09:00:00.000Z" ], "format": "date-time", "description": "Timestamp when the backend was created (RFC 3339 format)." }, "updated_at": { "type": "string", "examples": [ "2025-11-06T11:30:00.000Z" ], "format": "date-time", "description": "Timestamp when the backend was last updated (RFC 3339 format)." } }, "title": "Backend", "required": [ "name", "members", "tls_configs", "properties", "created_at", "updated_at" ], "description": "Represents a backend configuration in the load balancer service, containing backend members, resolver settings, TLS configurations, and backend-specific properties such as timeouts and health checks." }, "loadBalancerMember": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "member-1", "ip": "192.168.1.10", "port": 8080, "weight": 10, "max_sessions": 100, "type": "static", "enabled": true, "backup": false, "created_at": "2025-11-05T12:30:00.000Z", "updated_at": "2025-11-05T13:45:00.000Z" } ], "properties": { "name": { "type": "string", "description": "Human-readable name assigned to the backend member.", "example": "member-1" }, "ip": { "type": "string", "format": "ipv4", "description": "IP address of the backend member server.", "example": "192.168.1.1" }, "port": { "type": "integer", "maximum": 65535, "minimum": 1, "format": "int32", "description": "Port number on which the backend member server listens.", "example": 80 }, "weight": { "type": "integer", "format": "int32", "description": "Relative weight for load balancing, determining the proportion of requests sent to this member.", "example": 100 }, "max_sessions": { "type": "integer", "format": "int32", "description": "Maximum number of concurrent connections allowed to this backend member.", "example": 1000 }, "type": { "type": "string", "enum": [ "static", "dynamic" ], "description": "Type of backend configuration. Allowed values are 'static' and 'dynamic'.", "example": "static" }, "enabled": { "type": "boolean", "description": "Indicates whether the backend member is actively participating in load balancing.", "example": true }, "backup": { "type": "boolean", "description": "Indicates whether this member serves as a backup, only receiving traffic when all primary members are unavailable.", "example": false }, "created_at": { "type": "string", "examples": [ "2023-01-01T00:00:00.000Z" ], "format": "date-time", "description": "Timestamp when the backend member was created (RFC 3339 format)." }, "updated_at": { "type": "string", "examples": [ "2023-01-02T00:00:00.000Z" ], "format": "date-time", "description": "Timestamp when the backend member was last updated (RFC 3339 format)." } }, "title": "Member", "required": [ "name", "ip", "port", "weight", "max_sessions", "type", "enabled", "backup", "created_at", "updated_at" ], "description": "Represents a single backend member (server node) participating in a load balancer backend configuration." }, "loadBalancerBackendPropertiesResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "backend_id": { "type": "integer", "format": "int32", "description": "Identifier of the backend.", "example": 401 }, "outbound_proxy_protocol": { "$ref": "#/components/schemas/loadBalancerProxyProtocolVersionOrDisabled" }, "timeout_server": { "type": "integer", "format": "int32", "description": "Server timeout in milliseconds.", "example": 30000 }, "timeout_tunnel": { "type": "integer", "format": "int32", "description": "Tunnel timeout in milliseconds.", "example": 30000 }, "health_check_type": { "type": "string", "description": "Type of health check.", "example": "http" }, "health_check_interval": { "type": "integer", "format": "int32", "description": "Interval between health checks in seconds.", "example": 10 }, "health_check_fall": { "type": "integer", "format": "int32", "description": "Number of failed checks before marking as unhealthy.", "example": 3 }, "health_check_rise": { "type": "integer", "format": "int32", "description": "Number of successful checks before marking as healthy.", "example": 2 }, "health_check_url": { "type": "string", "description": "URL for HTTP health checks.", "example": "/status" }, "health_check_expected_status": { "type": "integer", "format": "int32", "description": "Expected HTTP status code from health check.", "example": 200 }, "health_check_tls_verify": { "type": "boolean", "description": "Whether to verify TLS in health check.", "example": true }, "health_check_on_down": { "type": "string", "description": "Action to take when backend is down.", "example": "shutdown-sessions" }, "sticky_session_cookie_name": { "type": [ "string", "null" ], "description": "Name of the sticky session cookie.", "example": "SESSIONID" }, "sticky_session_cookie_attributes": { "type": [ "string", "null" ], "description": "Additional cookie attributes appended to sticky session cookies. Supports combinations of: SameSite=Strict|Lax|None, Secure, HttpOnly, Partitioned (semicolon-separated).", "example": "SameSite=Strict; Secure; HttpOnly" }, "tls_enabled": { "type": "boolean", "description": "Whether TLS is enabled.", "example": true }, "tls_verify": { "type": "boolean", "description": "Whether to verify backend TLS certificate.", "example": false }, "tls_use_system_ca": { "type": "boolean", "description": "Whether to use system CA for backend TLS.", "example": true }, "http2_enabled": { "type": "boolean", "description": "Whether HTTP/2 is enabled for the backend.", "example": true } }, "title": "Backend Properties Response", "required": [ "backend_id", "timeout_server", "timeout_tunnel", "health_check_type", "health_check_interval", "health_check_fall", "health_check_rise", "health_check_url", "health_check_expected_status", "health_check_tls_verify", "health_check_on_down", "tls_enabled", "tls_verify", "tls_use_system_ca", "http2_enabled" ], "additionalProperties": false, "description": "Properties of a backend configuration.", "example": { "backend_id": 401, "outbound_proxy_protocol": "v2", "timeout_server": 30000, "timeout_tunnel": 30000, "health_check_type": "http", "health_check_interval": 10, "health_check_fall": 3, "health_check_rise": 2, "health_check_url": "/status", "health_check_expected_status": 200, "health_check_tls_verify": true, "health_check_on_down": "shutdown-sessions", "sticky_session_cookie_name": "SESSIONID", "sticky_session_cookie_attributes": "SameSite=Strict; Secure; HttpOnly", "tls_enabled": true, "tls_verify": false, "tls_use_system_ca": true, "http2_enabled": true } }, "loadBalancerResolver": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "default-resolver", "nameservers": [ "94.237.127.9", "94.237.40.9" ], "retries": 3, "timeout": 1000, "timeout_retry": 1500, "cache_valid": 86400, "cache_invalid": 60, "created_at": "2025-11-06T09:00:00.000Z", "updated_at": "2025-11-06T09:30:00.000Z" } ], "properties": { "name": { "type": "string", "description": "Human-readable name assigned to the DNS resolver.", "example": "default-resolver" }, "nameservers": { "type": "array", "items": { "type": "string", "format": "ipv4-port" }, "description": "List of DNS nameserver addresses (with optional port) used to resolve backend member hostnames.", "example": [ "1.1.1.1:53", "8.8.8.8:53" ] }, "retries": { "type": "integer", "format": "int32", "description": "Number of retry attempts for failed DNS queries.", "example": 3 }, "timeout": { "type": "integer", "format": "int32", "description": "Initial timeout in milliseconds for DNS query responses.", "example": 30 }, "timeout_retry": { "type": "integer", "format": "int32", "description": "Timeout in milliseconds for DNS query retry attempts.", "example": 5 }, "cache_valid": { "type": "integer", "format": "int32", "description": "Time in seconds to cache valid (successful) DNS responses.", "example": 60 }, "cache_invalid": { "type": "integer", "format": "int32", "description": "Time in seconds to cache invalid (failed) DNS responses.", "example": 5 }, "created_at": { "type": "string", "examples": [ "2025-11-06T09:00:00.000Z" ], "format": "date-time", "description": "Timestamp when the DNS resolver was created (RFC 3339 format)." }, "updated_at": { "type": "string", "examples": [ "2025-12-06T09:00:00.000Z" ], "format": "date-time", "description": "Timestamp when the DNS resolver was last updated (RFC 3339 format)." } }, "title": "Resolver", "required": [ "name", "nameservers", "retries", "timeout", "timeout_retry", "cache_valid", "cache_invalid", "created_at", "updated_at" ], "description": "Represents a DNS resolver configuration for a load balancer service, defining the nameservers, retry behavior, and caching rules used to resolve backend hostnames." }, "loadBalancerNetwork": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "public-network", "uuid": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d", "type": "private", "family": "IPv4", "dns_name": "lb-network.local", "created_at": "2025-11-06T09:00:00.000Z", "updated_at": "2025-11-06T11:15:00.000Z" } ], "properties": { "name": { "type": "string", "description": "Human-readable name assigned to the network.", "example": "public-network" }, "uuid": { "type": "string", "description": "UUID represented as a string", "example": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d" }, "type": { "type": "string", "description": "Network type indicating the visibility scope (public or private).", "example": "public" }, "family": { "type": "string", "description": "IP address family used by this network (IPv4 or IPv6).", "example": "IPv4" }, "dns_name": { "type": "string", "description": "Fully qualified domain name (FQDN) for accessing the load balancer through this network.", "example": "lb-0a498284629e4629a55d0415a6e89dda-1.upcloudlb.com" }, "created_at": { "type": "string", "examples": [ "2025-11-06T09:00:00.000Z" ], "format": "date-time", "description": "Timestamp when the network was created (RFC 3339 format)." }, "updated_at": { "type": "string", "examples": [ "2025-11-06T09:30:00.000Z" ], "format": "date-time", "description": "Timestamp when the network was last updated (RFC 3339 format)." } }, "title": "Network", "required": [ "name", "uuid", "type", "family", "created_at", "updated_at" ], "additionalProperties": false, "description": "Represent a network from where traffic is consumed and routed." }, "loadBalancerIpAddress": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "address": "192.168.1.10", "network_name": "public-network", "created_at": "2025-11-06T09:00:00.000Z", "updated_at": "2025-11-06T11:15:00.000Z" } ], "properties": { "address": { "type": "string", "description": "IP address assigned to the load balancer service on this network.", "example": "192.168.1.10" }, "network_name": { "type": "string", "description": "Name of the network to which this IP address belongs.", "example": "public-network" }, "created_at": { "type": "string", "examples": [ "2025-11-06T09:00:00.000Z" ], "format": "date-time", "description": "Timestamp when the IP address was created (RFC 3339 format)." }, "updated_at": { "type": "string", "examples": [ "2025-11-06T11:15:00.000Z" ], "format": "date-time", "description": "Timestamp when the IP address was last updated (RFC 3339 format)." } }, "title": "IP Address", "required": [ "address", "network_name", "created_at", "updated_at" ], "description": "Represents an IP address associated with a network interface of the load balancer service, including addressing details and provisioning information." }, "loadBalancerLabelResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "key": "environment", "value": "production" } ], "properties": { "key": { "type": "string", "description": "Label key used for identification and filtering.", "example": "environment" }, "value": { "type": [ "string", "null" ], "description": "The value of the label (optional).", "example": "production" } }, "title": "Label Response", "required": [ "key" ], "additionalProperties": false, "description": "Represents a key-value label associated with the load balancer service" }, "loadBalancerErrorResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "examples": [ { "error_message": "Authentication credentials wrong", "error_code": "401" } ], "properties": { "error_message": { "type": "string", "description": "Error message describing the error." }, "error_code": { "type": "string", "description": "Error code associated with the error." } }, "required": [ "error_message", "error_code" ], "description": "Error details containing the error message and code." } }, "title": "ErrorResponse", "additionalProperties": false, "description": "Schema for error responses from the API." }, "loadBalancerFrontendsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerFrontend" }, "title": "Frontends Response", "description": "An array of frontend configurations for a load balancer service." }, "loadBalancerFrontendTlsConfigsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerTlsConfig" }, "title": "Frontend TLS Configs Response", "description": "Represents a list of TLS configurations for a frontend or backend, defining the certificate bundle and associated identifiers within the load balancer service." }, "loadBalancerBackendsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerBackend" }, "title": "Backends Response", "description": "Response schema for a list of backends." }, "loadBalancerMembersResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerMember" }, "title": "Members Response", "description": "Response schema for a list of members." }, "loadBalancerIpAddressesResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerIpAddress" }, "title": "IP Addresses Response", "description": "A list of floating public IPv4 addresses attached to the load balancer service, each including its network interface metadata." }, "loadBalancerResolversResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerResolver" }, "title": "Resolvers Response", "description": "Represents a list of DNS resolver configurations for a load balancer service." }, "loadBalancerServiceLabelsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerLabelResponse" }, "title": "Service Labels Response", "description": "Represents a list of key-value label associated with the load balancer service" }, "loadBalancerMetrics": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "frontends": [], "backends": [] } ], "properties": { "frontends": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/loadBalancerFrontendMetricsResponse" }, "description": "List of frontend metrics." }, "backends": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/loadBalancerBackendMetricsResponse" }, "description": "List of backend metrics." } }, "title": "Metrics", "required": [ "frontends", "backends" ], "additionalProperties": false, "description": "Represents a snapshot of load balancer metrics collected by the monitoring agent, including frontend and backend statistics for a given service at a specific timestamp." }, "loadBalancerFrontendMetricsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "allOf": [ { "$ref": "#/components/schemas/loadBalancerCommonMetricsResponse" }, { "$ref": "#/components/schemas/loadBalancerRequestMetricsResponse" } ], "properties": { "frontend_id": { "type": "integer", "format": "int32", "description": "Unique identifier for the frontend.", "example": 301 }, "name": { "type": "string", "description": "Human-readable name of the frontend.", "example": "frontend-http" }, "request_rate": { "type": "integer", "format": "int32", "description": "Rate of incoming requests per second.", "example": 120 }, "total_denied_connections": { "type": "integer", "format": "int32", "description": "Total number of denied client connections.", "example": 5 }, "total_denied_sessions": { "type": "integer", "format": "int32", "description": "Total number of denied sessions due to connection or rule constraints.", "example": 3 }, "total_invalid_requests": { "type": "integer", "format": "int32", "description": "Total number of malformed or invalid HTTP requests received.", "example": 7 }, "created_at": { "type": "string", "examples": [ "2025-11-06T09:00:00.000Z" ], "format": "date-time", "description": "Timestamp indicating when the frontend metrics entry was created." }, "updated_at": { "type": "string", "examples": [ "2025-11-06T09:30:00.000Z" ], "format": "date-time", "description": "Timestamp indicating when the frontend metrics entry was last updated." } }, "title": "Frontend Metrics Response", "required": [ "frontend_id", "name", "request_rate", "total_denied_connections", "total_denied_sessions", "total_invalid_requests", "created_at", "updated_at" ], "additionalProperties": false, "description": "Represents aggregated performance and traffic metrics for a load balancer frontend, including connection statistics, HTTP response counts, and per-second request rates. Combines general metrics, request-specific metrics, and creation timestamps for observability and monitoring purposes." }, "loadBalancerCommonMetricsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "total_request_bytes": { "type": "integer", "format": "int64", "description": "Total number of request bytes processed.", "example": 12543000 }, "total_response_bytes": { "type": "integer", "format": "int64", "description": "Total number of response bytes processed.", "example": 11789000 }, "total_denied_responses": { "type": "integer", "format": "int32", "description": "Total number of denied responses.", "example": 2 }, "total_http_responses_1xx": { "type": "integer", "format": "int32", "description": "Total number of HTTP 1xx informational responses.", "example": 5 }, "total_http_responses_2xx": { "type": "integer", "format": "int32", "description": "Total number of HTTP 2xx successful responses.", "example": 984 }, "total_http_responses_3xx": { "type": "integer", "format": "int32", "description": "Total number of HTTP 3xx redirection responses.", "example": 45 }, "total_http_responses_4xx": { "type": "integer", "format": "int32", "description": "Total number of HTTP 4xx client error responses.", "example": 22 }, "total_http_responses_5xx": { "type": "integer", "format": "int32", "description": "Total number of HTTP 5xx server error responses.", "example": 8 }, "total_http_responses_other": { "type": "integer", "format": "int32", "description": "Total number of HTTP responses outside the standard 1xx–5xx range.", "example": 0 }, "total_sessions": { "type": "integer", "format": "int32", "description": "Total number of sessions handled.", "example": 1100 }, "session_rate": { "type": "integer", "format": "int32", "description": "Average rate of sessions per second.", "example": 25 }, "current_sessions": { "type": "integer", "format": "int32", "description": "Current number of active sessions.", "example": 4 } }, "title": "Common Metrics Response", "required": [ "total_request_bytes", "total_response_bytes", "total_denied_responses", "total_http_responses_1xx", "total_http_responses_2xx", "total_http_responses_3xx", "total_http_responses_4xx", "total_http_responses_5xx", "total_http_responses_other", "total_sessions", "session_rate", "current_sessions" ], "additionalProperties": false, "description": "Represents general traffic and session statistics collected for a load balancer frontend or backend, including request and response byte counts, HTTP status distribution, and session activity metrics." }, "loadBalancerRequestMetricsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "total_http_requests": { "type": "integer", "format": "int32", "description": "Total number of HTTP requests processed.", "example": 12500 }, "total_denied_requests": { "type": "integer", "format": "int32", "description": "Total number of denied HTTP requests.", "example": 35 }, "total_intercepted_requests": { "type": "integer", "format": "int32", "description": "Total number of intercepted HTTP requests by internal rules or actions.", "example": 12 } }, "title": "Request Metrics Response", "required": [ "total_http_requests", "total_denied_requests", "total_intercepted_requests" ], "additionalProperties": false, "description": "Represents basic HTTP request statistics collected by the load balancer, including the total number of processed, denied, and intercepted requests." }, "loadBalancerBackendMetricsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "allOf": [ { "$ref": "#/components/schemas/loadBalancerCommonMetricsResponse" }, { "$ref": "#/components/schemas/loadBalancerServerMetricsResponse" }, { "$ref": "#/components/schemas/loadBalancerAvgTimeMetricsResponse" } ], "properties": { "backend_id": { "type": "integer", "format": "int32", "description": "Unique identifier for the backend.", "example": 401 }, "name": { "type": "string", "description": "Human-readable name of the backend.", "example": "backend-api" }, "downtime_s": { "type": "integer", "format": "int32", "description": "Total downtime duration in seconds.", "example": 45 }, "active_servers": { "type": "integer", "format": "int32", "description": "Number of currently active servers in the backend.", "example": 3 }, "backup_servers": { "type": "integer", "format": "int32", "description": "Number of backup servers available for failover.", "example": 1 }, "members": { "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/loadBalancerMemberMetricsResponse" }, "description": "List of metrics for individual backend members (servers)." }, "created_at": { "type": "string", "examples": [ "2025-11-06T09:00:00.000Z" ], "format": "date-time", "description": "Timestamp when the backend metrics record was created." }, "updated_at": { "type": "string", "examples": [ "2025-11-06T09:30:00.000Z" ], "format": "date-time", "description": "Timestamp when the backend metrics record was last updated." } }, "title": "Backend Metrics Response", "required": [ "backend_id", "name", "downtime_s", "active_servers", "backup_servers", "members", "created_at", "updated_at" ], "additionalProperties": false, "description": "Represents collected performance, availability, and traffic statistics for a load balancer backend, including member activity, response times, and aggregated server metrics." }, "loadBalancerServerMetricsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "total_failed_checks_transitions": { "type": "integer", "format": "int32", "description": "Total number of times the server transitioned from healthy to failed state due to failed health checks.", "example": 3 }, "total_client_aborted": { "type": "integer", "format": "int32", "description": "Total number of sessions aborted by clients before completion.", "example": 12 }, "total_failed_connections": { "type": "integer", "format": "int32", "description": "Total number of failed connection attempts to the server.", "example": 5 }, "total_invalid_responses": { "type": "integer", "format": "int32", "description": "Total number of invalid responses received from the server.", "example": 2 }, "total_routed_requests": { "type": "integer", "format": "int32", "description": "Total number of requests successfully routed to the server.", "example": 14892 }, "total_server_aborted": { "type": "integer", "format": "int32", "description": "Total number of sessions aborted by the server before completion.", "example": 4 }, "total_server_redispatches": { "type": "integer", "format": "int32", "description": "Total number of requests that were redispatched to another server after failure.", "example": 7 }, "total_server_connection_retries": { "type": "integer", "format": "int32", "description": "Total number of retries attempted for failed server connections.", "example": 9 }, "connections_waiting": { "type": "integer", "format": "int32", "description": "Current number of connections waiting for a server slot.", "example": 1 } }, "title": "Server Metrics Response", "required": [ "total_failed_checks_transitions", "total_client_aborted", "total_failed_connections", "total_invalid_responses", "total_routed_requests", "total_server_aborted", "total_server_redispatches", "total_server_connection_retries", "connections_waiting" ], "additionalProperties": false, "description": "Represents detailed server-level performance and reliability metrics, including connection errors, aborted sessions, and routing statistics for a load balancer backend member." }, "loadBalancerAvgTimeMetricsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "avg_connection_time_ms": { "type": "integer", "format": "int32", "description": "Average time taken to establish a connection in milliseconds.", "example": 12 }, "avg_queue_time_ms": { "type": "integer", "format": "int32", "description": "Average time spent in queue before being processed, in milliseconds.", "example": 5 }, "avg_server_response_time_ms": { "type": "integer", "format": "int32", "description": "Average server response time in milliseconds.", "example": 28 }, "avg_total_time_ms": { "type": "integer", "format": "int32", "description": "Average total time from connection start to response completion, in milliseconds.", "example": 45 } }, "title": "Avg Time Metrics Response", "required": [ "avg_connection_time_ms", "avg_queue_time_ms", "avg_server_response_time_ms", "avg_total_time_ms" ], "additionalProperties": false, "description": "Represents average timing statistics for backend performance, including connection establishment, queuing, server response, and total transaction times, all measured in milliseconds." }, "loadBalancerMemberMetricsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "allOf": [ { "$ref": "#/components/schemas/loadBalancerCommonMetricsResponse" }, { "$ref": "#/components/schemas/loadBalancerServerMetricsResponse" }, { "$ref": "#/components/schemas/loadBalancerAvgTimeMetricsResponse" } ], "properties": { "member_id": { "type": "integer", "format": "int32", "description": "Unique identifier of the backend member.", "example": 101 }, "name": { "type": "string", "description": "Human-readable name of the backend member.", "example": "backend-member-1" }, "backend_id": { "type": "integer", "format": "int32", "description": "Identifier of the backend this member belongs to.", "example": 401 }, "status": { "type": "string", "enum": [ "up", "down", "unknown", "maint", "drain" ], "description": "Current operational status of the member.", "example": "up" }, "check_status": { "type": "string", "enum": [ "checking", "failed", "passing", "unknown" ], "description": "Result of the latest health check for the member.", "example": "passing" }, "check_http_code": { "type": "integer", "format": "int32", "description": "HTTP status code returned by the last health check (if applicable).", "example": 200 }, "last_check_content": { "type": "string", "description": "Response content returned by the last health check.", "example": "OK" }, "last_check_desc": { "type": "string", "description": "Description or additional diagnostic information from the last health check.", "example": "Health check passed successfully." }, "total_failed_checks": { "type": "integer", "format": "int32", "description": "Total number of failed health checks recorded for this member.", "example": 2 }, "created_at": { "type": "string", "examples": [ "2025-11-06T09:00:00.000Z" ], "format": "date-time", "description": "Timestamp of when the member was created." }, "updated_at": { "type": "string", "examples": [ "2025-11-06T09:30:00.000Z" ], "format": "date-time", "description": "Timestamp of when the member metrics were last updated." } }, "title": "Member Metrics Response", "required": [ "member_id", "name", "backend_id", "status", "check_status", "check_http_code", "total_failed_checks", "created_at", "updated_at" ], "additionalProperties": false, "description": "Represents detailed performance and health metrics for an individual backend member (server) within a load balancer. Includes operational status, health check results, and aggregated traffic and timing statistics." }, "loadBalancerMetricsSeriesResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerMetrics" }, "title": "Metrics Series Response", "description": "Response schema for a mapping of metric series identifiers to their corresponding metrics data." }, "loadBalancerFrontendMetricsSeriesResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerFrontendMetricsSeries" }, "title": "Frontend Metrics Series Response", "description": "Response schema for a list of frontend metrics series." }, "loadBalancerFrontendMetricsSeries": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "start_at": "2025-11-06T09:00:00.000Z", "end_at": "2025-11-06T09:05:00.000Z", "frontends": [ "frontend-http", "frontend-https" ], "denied_connections": 15, "denied_sessions": 8, "invalid_requests": 12, "request_bytes": 15432000, "response_bytes": 14321000, "denied_responses": 6, "http_responses_1xx": 2, "http_responses_2xx": 940, "http_responses_3xx": 47, "http_responses_4xx": 33, "http_responses_5xx": 12, "http_responses_other": 0, "sessions": 1040, "http_requests": 15000, "denied_requests": 28, "intercepted_requests": 9 } ], "properties": { "start_at": { "type": "string", "examples": [ "2025-11-06T09:00:00.000Z" ], "format": "date-time", "description": "Timestamp marking the beginning of the metrics aggregation period." }, "end_at": { "type": "string", "examples": [ "2025-11-06T09:05:00.000Z" ], "format": "date-time", "description": "Timestamp marking the end of the metrics aggregation period." }, "frontends": { "type": "array", "items": { "type": "string", "example": "frontend-http" }, "description": "List of frontend names or identifiers included in the aggregated data.", "example": [ "frontend-http", "frontend-https" ] }, "denied_connections": { "type": "integer", "format": "int32", "description": "Total number of denied frontend connections within the time range.", "example": 15 }, "denied_sessions": { "type": "integer", "format": "int32", "description": "Total number of denied sessions during the period.", "example": 8 }, "invalid_requests": { "type": "integer", "format": "int32", "description": "Number of malformed or invalid HTTP requests received.", "example": 12 }, "request_bytes": { "type": "integer", "format": "int32", "description": "Total size of incoming request payloads, in bytes.", "example": 15432000 }, "response_bytes": { "type": "integer", "format": "int32", "description": "Total size of outgoing response payloads, in bytes.", "example": 14321000 }, "denied_responses": { "type": "integer", "format": "int32", "description": "Number of HTTP responses that were denied or rejected.", "example": 6 }, "http_responses_1xx": { "type": "integer", "format": "int32", "description": "Count of informational (1xx) HTTP responses.", "example": 2 }, "http_responses_2xx": { "type": "integer", "format": "int32", "description": "Count of successful (2xx) HTTP responses.", "example": 940 }, "http_responses_3xx": { "type": "integer", "format": "int32", "description": "Count of redirection (3xx) HTTP responses.", "example": 47 }, "http_responses_4xx": { "type": "integer", "format": "int32", "description": "Count of client error (4xx) HTTP responses.", "example": 33 }, "http_responses_5xx": { "type": "integer", "format": "int32", "description": "Count of server error (5xx) HTTP responses.", "example": 12 }, "http_responses_other": { "type": "integer", "format": "int32", "description": "Count of HTTP responses with codes outside the 1xx–5xx range.", "example": 0 }, "sessions": { "type": "integer", "format": "int32", "description": "Total number of frontend sessions handled.", "example": 1040 }, "http_requests": { "type": "integer", "format": "int32", "description": "Total number of HTTP requests processed during the aggregation period.", "example": 15000 }, "denied_requests": { "type": "integer", "format": "int32", "description": "Total number of HTTP requests denied.", "example": 28 }, "intercepted_requests": { "type": "integer", "format": "int32", "description": "Number of requests intercepted before reaching the backend.", "example": 9 } }, "title": "Frontend Metrics Series", "required": [ "start_at", "end_at", "frontends" ], "additionalProperties": false, "description": "Aggregated time-series metrics for load balancer frontends, representing cumulative statistics between a start and end timestamp across one or more frontend instances." }, "loadBalancerBackendMetricsSeriesResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [] ], "items": { "$ref": "#/components/schemas/loadBalancerBackendMetricsSeries" }, "title": "Backend Metrics Series Response", "description": "Response schema for a list of backend metrics series." }, "loadBalancerBackendMetricsSeries": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "start_at": { "type": "string", "examples": [ "2025-11-06T09:00:00.000Z" ], "format": "date-time", "description": "Timestamp marking the start of the metrics collection period." }, "end_at": { "type": "string", "examples": [ "2025-11-06T10:00:00.000Z" ], "format": "date-time", "description": "Timestamp marking the end of the metrics collection period." }, "backends": { "type": "array", "items": { "type": "string" }, "description": "List of backend identifiers included in the metrics series.", "example": [ "backend-api", "backend-web" ] }, "request_bytes": { "type": "integer", "format": "int64", "description": "Total number of request bytes processed.", "example": 12345678 }, "response_bytes": { "type": "integer", "format": "int64", "description": "Total number of response bytes sent.", "example": 11876543 }, "denied_responses": { "type": "integer", "format": "int32", "description": "Total number of denied responses.", "example": 12 }, "http_responses_1xx": { "type": "integer", "format": "int32", "description": "Count of HTTP 1xx informational responses.", "example": 2 }, "http_responses_2xx": { "type": "integer", "format": "int32", "description": "Count of HTTP 2xx successful responses.", "example": 9500 }, "http_responses_3xx": { "type": "integer", "format": "int32", "description": "Count of HTTP 3xx redirection responses.", "example": 35 }, "http_responses_4xx": { "type": "integer", "format": "int32", "description": "Count of HTTP 4xx client error responses.", "example": 18 }, "http_responses_5xx": { "type": "integer", "format": "int32", "description": "Count of HTTP 5xx server error responses.", "example": 6 }, "http_responses_other": { "type": "integer", "format": "int32", "description": "Count of HTTP responses outside the 1xx–5xx range.", "example": 0 }, "sessions": { "type": "integer", "format": "int32", "description": "Total number of sessions.", "example": 220 }, "downtime": { "type": "integer", "format": "int32", "description": "Total downtime in seconds.", "example": 45 }, "failed_checks_transitions": { "type": "integer", "format": "int32", "description": "Number of transitions from healthy to failed health checks.", "example": 3 }, "client_aborted": { "type": "integer", "format": "int32", "description": "Number of client-aborted connections.", "example": 5 }, "failed_connections": { "type": "integer", "format": "int32", "description": "Number of failed connections.", "example": 2 }, "invalid_responses": { "type": "integer", "format": "int32", "description": "Number of invalid responses.", "example": 1 }, "routed_requests": { "type": "integer", "format": "int32", "description": "Number of routed requests.", "example": 15200 }, "server_aborted": { "type": "integer", "format": "int32", "description": "Number of server-aborted connections.", "example": 2 }, "server_redispatches": { "type": "integer", "format": "int32", "description": "Number of server redispatches.", "example": 3 }, "server_connection_retries": { "type": "integer", "format": "int32", "description": "Number of server connection retries.", "example": 4 } }, "title": "Backend Metrics Series", "required": [ "start_at", "end_at", "backends" ], "additionalProperties": false, "description": "Aggregated performance, availability, and traffic statistics for a load balancer backend, including member metrics and average timing metrics." }, "loadBalancerMemberMetricsSeriesResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "start_at": "2025-11-06T09:00:00.000Z", "end_at": "2025-11-06T10:00:00.000Z", "members": [ "backend-member-1", "backend-member-2" ], "request_bytes": 12345678, "response_bytes": 11876543, "denied_responses": 12, "http_responses_1xx": 2, "http_responses_2xx": 9500, "http_responses_3xx": 35, "http_responses_4xx": 18, "http_responses_5xx": 6, "http_responses_other": 0, "sessions": 220, "downtime": 45, "failed_checks_transitions": 3, "client_aborted": 7, "failed_connections": 2, "invalid_responses": 1, "routed_requests": 10234, "server_aborted": 4, "server_redispatches": 5, "server_connection_retries": 9, "failed_checks": 15 } ], "properties": { "start_at": { "type": "string", "examples": [ "2025-11-06T09:00:00.000Z" ], "format": "date-time", "description": "Timestamp marking the start of the metrics collection period." }, "end_at": { "type": "string", "examples": [ "2025-11-06T10:00:00.000Z" ], "format": "date-time", "description": "Timestamp marking the end of the metrics collection period." }, "members": { "type": "array", "items": { "type": "string" }, "description": "List of backend member identifiers included in the metrics series.", "example": [ "backend-member-1", "backend-member-2" ] }, "request_bytes": { "type": "integer", "format": "int64", "description": "Total number of request bytes processed by all members in the series.", "example": 12345678 }, "response_bytes": { "type": "integer", "format": "int64", "description": "Total number of response bytes sent by all members.", "example": 11876543 }, "denied_responses": { "type": "integer", "format": "int32", "description": "Total number of denied responses returned during the period.", "example": 12 }, "http_responses_1xx": { "type": "integer", "format": "int32", "description": "Count of HTTP 1xx informational responses.", "example": 2 }, "http_responses_2xx": { "type": "integer", "format": "int32", "description": "Count of HTTP 2xx successful responses.", "example": 9500 }, "http_responses_3xx": { "type": "integer", "format": "int32", "description": "Count of HTTP 3xx redirection responses.", "example": 35 }, "http_responses_4xx": { "type": "integer", "format": "int32", "description": "Count of HTTP 4xx client error responses.", "example": 18 }, "http_responses_5xx": { "type": "integer", "format": "int32", "description": "Count of HTTP 5xx server error responses.", "example": 6 }, "http_responses_other": { "type": "integer", "format": "int32", "description": "Count of HTTP responses outside the 1xx–5xx range.", "example": 0 }, "sessions": { "type": "integer", "format": "int32", "description": "Total number of active or completed sessions during the metrics window.", "example": 220 }, "downtime": { "type": "integer", "format": "int32", "description": "Total downtime duration in seconds.", "example": 45 }, "failed_checks_transitions": { "type": "integer", "format": "int32", "description": "Number of transitions from healthy to failed health checks detected during the period.", "example": 3 }, "client_aborted": { "type": "integer", "format": "int32", "description": "Number of connections aborted by the client.", "example": 7 }, "failed_connections": { "type": "integer", "format": "int32", "description": "Number of backend connection attempts that failed.", "example": 2 }, "invalid_responses": { "type": "integer", "format": "int32", "description": "Number of invalid or malformed responses detected.", "example": 1 }, "routed_requests": { "type": "integer", "format": "int32", "description": "Total number of requests successfully routed to the backend members.", "example": 10234 }, "server_aborted": { "type": "integer", "format": "int32", "description": "Number of connections aborted by the backend server.", "example": 4 }, "server_redispatches": { "type": "integer", "format": "int32", "description": "Number of requests redispatched to another backend member after an initial failure.", "example": 5 }, "server_connection_retries": { "type": "integer", "format": "int32", "description": "Number of backend connection retry attempts.", "example": 9 }, "failed_checks": { "type": "integer", "format": "int32", "description": "Total number of failed health checks for all members combined.", "example": 15 } }, "title": "Member Metrics Series Response", "required": [ "start_at", "end_at", "members" ], "additionalProperties": false, "description": "Aggregated time-series metrics for backend members, showing request and response statistics, connection health, and server performance during a given time window." }, "loadBalancerCertificatesBundleResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerCertificateBundle" }, "title": "Certificates Bundle Response", "description": "Response schema for a list of certificate bundles." }, "loadBalancerCertificateBundle": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "uuid": "8d2f4a1e-0e3f-44a9-a0f5-9b8c84e9c701", "name": "mydomain-cert-bundle", "tls_type": "dynamic", "operational_state": "setup-challenge", "hostnames": [ "example.com", "www.example.com" ], "key_type": "rsa", "labels": [], "not_before": "2025-11-06T09:00:00.000Z", "not_after": "2026-11-06T09:00:00.000Z", "created_at": "2025-11-06T09:00:00.000Z", "updated_at": "2025-11-06T11:00:00.000Z" } ], "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier for the certificate bundle.", "example": "8d2f4a1e-0e3f-44a9-a0f5-9b8c84e9c701" }, "name": { "type": "string", "description": "Human-readable name assigned to the certificate bundle.", "example": "mydomain-cert-bundle" }, "tls_type": { "type": "string", "enum": [ "manual", "dynamic", "authority" ], "description": "The certificate bundle type. Determines how the certificate is provisioned and managed.", "example": "dynamic" }, "operational_state": { "type": "string", "enum": [ "pending", "setup-challenge", "complete-challenge", "idle", "failed-challenge" ], "description": "Current operational state of the certificate bundle.", "example": "pending" }, "certificate": { "type": "string", "description": "PEM-encoded certificate data (base64).", "contentEncoding": "base64", "example": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0t..." }, "intermediates": { "type": "string", "description": "PEM-encoded intermediate certificates (base64).", "contentEncoding": "base64", "example": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0t..." }, "hostnames": { "type": "array", "items": { "type": "string" }, "description": "List of hostnames covered by this certificate bundle.", "example": [ "example.com", "www.example.com" ] }, "challenge_problems": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerChallengeProblemResponse" }, "description": "Problems reported during ACME challenge validation." }, "key_type": { "type": "string", "enum": [ "rsa", "ecdsa" ], "description": "Type of private key used for this certificate bundle.", "example": "rsa" }, "services": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerEmbeddedServiceResponse" }, "description": "List of load balancer services that use this certificate bundle." }, "not_before": { "type": "string", "examples": [ "2025-11-06T09:00:00.000Z" ], "format": "date-time", "description": "The start date and time of certificate validity." }, "not_after": { "type": "string", "examples": [ "2026-11-06T09:00:00.000Z" ], "format": "date-time", "description": "The expiration date and time of certificate validity." }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerLabelResponse" }, "description": "List of labels attached to this certificate bundle." }, "created_at": { "type": "string", "examples": [ "2025-11-06T09:00:00.000Z" ], "format": "date-time", "description": "Timestamp when this certificate bundle was created." }, "updated_at": { "type": "string", "examples": [ "2025-11-06T11:00:00.000Z" ], "format": "date-time", "description": "Timestamp when this certificate bundle was last updated." } }, "title": "Certificate Bundle", "required": [ "uuid", "name", "tls_type", "operational_state", "created_at", "updated_at" ], "additionalProperties": false, "description": "Represents a certificate bundle used in a load balancer TLS configuration. A bundle may be manually uploaded, dynamically issued via ACME, or represent an authority certificate. It includes certificate data, challenge details, and metadata about its lifecycle." }, "loadBalancerChallengeProblemResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "hostname": { "type": "string", "description": "The hostname for which the ACME challenge validation failed or encountered an error.", "example": "example.com" }, "problem": { "$ref": "#/components/schemas/loadBalancerProblemResponse" } }, "title": "Challenge Problem Response", "required": [ "hostname", "problem" ], "additionalProperties": false, "description": "Represents a problem encountered during ACME challenge validation for a specific hostname. Includes detailed error information following the Problem Details (RFC7807) format.", "example": { "hostname": "example.com", "problem": { "type": "https://api.example.com/problems/dns-lookup-failed", "title": "DNS lookup failed", "detail": "The DNS resolver could not resolve the domain name 'example.com'.", "status": 400, "correlation_id": "req-7b39a1c9b6a14e07b9d4c2a4c5d8b7f2" } } }, "loadBalancerProblemResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "type": { "type": "string", "format": "uri", "description": "A URI reference identifying the problem type. When dereferenced, it typically provides human-readable documentation for the error.", "example": "https://api.example.com/problems/invalid-request" }, "title": { "type": "string", "description": "A short, human-readable summary of the problem type. This value should not vary between occurrences of the same error type.", "example": "Invalid request" }, "detail": { "type": "string", "description": "A human-readable explanation specific to this occurrence of the problem.", "example": "The provided domain name is not valid." }, "status": { "type": "integer", "format": "int64", "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "example": 400 }, "invalid_params": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerProblemInvalidParamResponse" }, "description": "A list of invalid parameters that caused the problem. Used to provide detailed feedback for validation errors.", "example": [ { "name": "hostnames[0]", "reason": "Invalid domain name format" } ] }, "correlation_id": { "type": "string", "format": "uuid", "description": "A unique identifier for this error instance, useful for tracing or debugging requests.", "example": "req-8b29d3a6a4cf4d22a17e2b8e31cd4a12" } }, "title": "Problem Response", "required": [ "type", "title", "status" ], "additionalProperties": false, "description": "Represents an error object following the Problem Details specification (RFC7807). Provides machine-readable and human-readable information about an error that occurred while processing a request.", "example": { "type": "https://api.example.com/problems/invalid-request", "title": "Invalid request", "detail": "The provided domain name is not valid.", "status": 400, "invalid_params": [ { "name": "hostnames[0]", "reason": "Invalid domain name format" } ], "correlation_id": "req-8b29d3a6a4cf4d22a17e2b8e31cd4a12" } }, "loadBalancerProblemInvalidParamResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the parameter or form field that caused the validation error. It can include structural delimiters to indicate nested fields (e.g., 'data.attributes.email').", "example": "hostnames[0]" }, "reason": { "type": "string", "description": "A human-readable message explaining why the parameter value was invalid, either syntactically or semantically.", "example": "Invalid domain name format" } }, "title": "Problem Invalid Param Response", "required": [ "name", "reason" ], "additionalProperties": false, "description": "Provides detailed information about a specific invalid parameter that caused a request to fail validation, as an extension of RFC7807 Problem Details.", "example": { "name": "hostnames[0]", "reason": "Invalid domain name format" } }, "loadBalancerEmbeddedServiceResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "description": "Unique identifier for the load balancer service.", "example": "d9f1b2a4-5c8d-4b73-91e0-8d5a0dc2e734" }, "name": { "type": "string", "description": "Human-readable name of the embedded service.", "example": "customer-service-lb" }, "frontends": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerEmbeddedFrontendResponse" }, "description": "List of frontends associated with the service. Each frontend defines how client connections are received.", "example": [ { "name": "frontend-http", "tls_configs": [ { "id": 42, "name": "frontend-tls-config", "frontend_id": 7, "backend_id": 12, "certificate_bundle_uuid": "a4b9f1a3-9b7c-4f21-8b33-fd68efb7c001", "created_at": "2025-11-06T10:15:00.000Z", "updated_at": "2025-11-06T11:00:00.000Z" } ] } ] }, "backends": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerEmbeddedBackendResponse" }, "description": "List of backends associated with the service. Each backend defines how traffic is distributed to target servers.", "example": [ { "name": "backend-app", "tls_configs": [ { "id": 56, "name": "backend-tls-config", "frontend_id": 7, "backend_id": 9, "certificate_bundle_uuid": "b1a5f3d8-2b3e-4b61-981f-d42cfb9a43e2", "created_at": "2025-11-06T10:45:00.000Z", "updated_at": "2025-11-06T11:20:00.000Z" } ] } ] }, "deleted": { "type": "boolean", "description": "Indicates whether the service has been marked as deleted.", "example": false } }, "title": "Embedded Service Response", "required": [ "uuid", "name" ], "additionalProperties": false, "description": "Represents a minimal embedded reference to a load balancer service, including its UUID, name, and lists of associated frontends and backends.", "example": { "uuid": "d9f1b2a4-5c8d-4b73-91e0-8d5a0dc2e734", "name": "customer-service-lb", "frontends": [ { "name": "frontend-http", "tls_configs": [ { "id": 42, "name": "frontend-tls-config", "frontend_id": 7, "backend_id": 12, "certificate_bundle_uuid": "a4b9f1a3-9b7c-4f21-8b33-fd68efb7c001", "created_at": "2025-11-06T10:15:00.000Z", "updated_at": "2025-11-06T11:00:00.000Z" } ] } ], "backends": [ { "name": "backend-app", "tls_configs": [ { "id": 56, "name": "backend-tls-config", "frontend_id": 7, "backend_id": 9, "certificate_bundle_uuid": "b1a5f3d8-2b3e-4b61-981f-d42cfb9a43e2", "created_at": "2025-11-06T10:45:00.000Z", "updated_at": "2025-11-06T11:20:00.000Z" } ] } ], "deleted": false } }, "loadBalancerEmbeddedFrontendResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "description": "Human-readable name of the embedded frontend within the load balancer service.", "example": "frontend-http" }, "tls_configs": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerTlsConfig" }, "description": "List of TLS configuration objects associated with this frontend. Each entry references a certificate bundle used for secure connections.", "example": [ { "id": 42, "name": "frontend-tls-config", "frontend_id": 7, "backend_id": 12, "certificate_bundle_uuid": "a4b9f1a3-9b7c-4f21-8b33-fd68efb7c001", "created_at": "2025-11-06T10:15:00.000Z", "updated_at": "2025-11-06T11:00:00.000Z" } ] } }, "title": "Embedded Frontend Response", "required": [ "name" ], "additionalProperties": false, "description": "Represents a minimal embedded reference to a frontend within a load balancer service, including its name and any associated TLS configurations.", "example": { "name": "frontend-http", "tls_configs": [ { "id": 42, "name": "frontend-tls-config", "frontend_id": 7, "backend_id": 12, "certificate_bundle_uuid": "a4b9f1a3-9b7c-4f21-8b33-fd68efb7c001", "created_at": "2025-11-06T10:15:00.000Z", "updated_at": "2025-11-06T11:00:00.000Z" } ] } }, "loadBalancerEmbeddedBackendResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "description": "Human-readable name of the embedded backend within the load balancer service.", "example": "backend-app" }, "tls_configs": { "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerTlsConfig" }, "description": "List of TLS configuration objects associated with this backend. Each entry defines a certificate bundle used for secure connections to backend servers.", "example": [ { "id": 56, "name": "backend-tls-config", "frontend_id": 7, "backend_id": 9, "certificate_bundle_uuid": "b1a5f3d8-2b3e-4b61-981f-d42cfb9a43e2", "created_at": "2025-11-06T10:45:00.000Z", "updated_at": "2025-11-06T11:20:00.000Z" } ] } }, "title": "Embedded Backend Response", "required": [ "name" ], "additionalProperties": false, "description": "Represents a minimal embedded reference to a backend within the load balancer service, including its name and associated TLS configurations.", "example": { "name": "backend-app", "tls_configs": [ { "id": 56, "name": "backend-tls-config", "frontend_id": 7, "backend_id": 9, "certificate_bundle_uuid": "b1a5f3d8-2b3e-4b61-981f-d42cfb9a43e2", "created_at": "2025-11-06T10:45:00.000Z", "updated_at": "2025-11-06T11:20:00.000Z" } ] } }, "loadBalancerCertificateBundleLabelsResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerLabelResponse" }, "title": "Certificate Bundle Labels Response", "description": "Represents a list of label key-value pairs attached to a certificate bundle within the load-balancer service, used for resource classification, billing and filtering." }, "loadBalancerDnsChallengeDomainResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "domain": { "type": "string", "description": "The DNS challenge domain to use for ACME validation.", "example": "_acme-challenge.example.upcloudlb.com" } }, "title": "DNS Challenge Domain Response", "required": [ "domain" ], "additionalProperties": false, "description": "Response schema for DNS challenge domain information." }, "loadBalancerPlansResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "array", "items": { "$ref": "#/components/schemas/loadBalancerPlan" }, "title": "Plans Response", "description": "List of available load balancer plans, each defining the node size, performance characteristics, and associated pricing options." }, "loadBalancerPlan": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the plan.", "example": "development" }, "server_number": { "type": "integer", "format": "int32", "description": "Number of servers included in the plan.", "example": 2 }, "per_server_max_sessions": { "type": "integer", "format": "int32", "description": "Maximum number of sessions allowed per server.", "example": 100 } }, "title": "Plan", "additionalProperties": false, "description": "Represents a load balancer plan, defining the node size, performance characteristics, and associated pricing options." }, "firewallRulesetVersion": { "type": "integer", "examples": [ 1, 678 ], "title": "Firewall Ruleset Version", "minimum": 1, "format": "int64", "description": "The firewall ruleset version." }, "createFirewallRuleset": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "example_firewall_ruleset", "stateful": true, "enabled": false, "default_dns_rules_enabled": false } ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the firewall ruleset" }, "description": { "type": "string", "maxLength": 250, "description": "Description of the firewall ruleset" }, "stateful": { "type": "boolean" }, "enabled": { "type": "boolean" }, "default_dns_rules_enabled": { "type": "boolean" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/firewallRulesetCreateLabel" }, "maxItems": 255, "description": "Labels" } }, "title": "Create Firewall Ruleset", "required": [ "name" ], "additionalProperties": false, "description": "Create firewall ruleset" }, "firewallRulesetModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "name": "modified_example_firewall_ruleset", "description": "Modified example stateless firewall ruleset", "enabled": false, "labels": [] } ], "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the ruleset" }, "description": { "type": "string", "maxLength": 250, "description": "Description of the firewall ruleset" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/firewallRulesetCreateLabel" }, "maxItems": 255, "description": "Labels" }, "enabled": { "type": "boolean", "description": "Enabled" }, "default_dns_rules_enabled": { "type": "boolean" } }, "title": "Firewall ruleset modify", "additionalProperties": false, "description": "Modify firewall ruleset" }, "firewallRulesetListResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "uuid": "1200ecde-db95-4d1c-9133-6508f3232567", "name": "example_stateless_firewall_ruleset", "description": "Example stateless firewall ruleset", "stateful": false, "enabled": true, "default_dns_rules_enabled": false, "labels": [ { "key": "example-key", "value": "example-value" } ], "server_uuid": "03aa7245-2ff9-49c8-9f0e-7ca0270d71a4" }, { "uuid": "1200ecde-db95-4d1c-9133-6508f3232445", "name": "example_stateful_firewall_ruleset", "description": "Example stateful firewall ruleset", "stateful": true, "enabled": true, "default_dns_rules_enabled": false, "labels": [ { "key": "example-key", "value": "example-value" } ] } ] ], "items": { "$ref": "#/components/schemas/firewallRulesetDetailResponse" }, "title": "Firewall Ruleset List Response", "description": "Response schema for a list of firewall rulesets." }, "firewallRulesetDetailResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "uuid": "1200ecde-db95-4d1c-9133-6508f3232567", "name": "example_firewall_ruleset", "description": "Example stateless firewall ruleset", "stateful": false, "enabled": true, "default_dns_rules_enabled": false, "labels": [ { "key": "example-key", "value": "example-value" } ], "server_uuid": "03aa7245-2ff9-49c8-9f0e-7ca0270d71a4" } ], "properties": { "uuid": { "$ref": "#/components/schemas/firewallRulesetServerUuid" }, "name": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Name of the firewall ruleset" }, "description": { "type": "string", "maxLength": 250, "description": "Description of the firewall ruleset" }, "stateful": { "type": "boolean" }, "version": { "$ref": "#/components/schemas/firewallRulesetVersion" }, "enabled": { "type": "boolean" }, "default_dns_rules_enabled": { "type": "boolean" }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/firewallRulesetCreateLabel" }, "maxItems": 255, "description": "Labels" }, "server_uuid": { "$ref": "#/components/schemas/firewallRulesetServerUuid" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "title": "Firewall Ruleset Detail Response", "additionalProperties": false, "description": "Response schema for firewall ruleset details, including UUID, name, description, stateful, enabled, labels and serverUUID." }, "firewallRulesetRuleDetailResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "examples": [ { "uuid": "16e7d7fc-9a90-4f42-83f5-ea0396f1592b", "direction": "in", "action": "accept", "family": "IPv4", "protocol": "tcp", "enabled": false } ], "properties": { "uuid": { "$ref": "#/components/schemas/firewallRulesetServerUuid" }, "enabled": { "type": "boolean", "description": "Enabled" }, "action": {}, "comment": { "type": "string", "maxLength": 250, "description": "Comments" }, "destination_address_start": { "type": "string", "format": "ip-address" }, "destination_address_end": { "type": "string", "format": "ip-address" }, "destination_port_start": { "type": "integer", "maximum": 65535, "minimum": 0, "format": "int64" }, "destination_port_end": { "type": "integer", "maximum": 65535, "minimum": 0, "format": "int64" }, "destination_address_cidr": { "type": "string" }, "direction": {}, "family": {}, "icmp_type": { "type": "integer", "maximum": 255, "minimum": 0, "format": "int64" }, "position": { "type": "integer", "maximum": 1000, "minimum": 0, "format": "int64" }, "protocol": {}, "source_address_start": { "type": "string", "format": "ip-address" }, "source_address_end": { "type": "string", "format": "ip-address" }, "source_port_start": { "type": "integer", "maximum": 65535, "minimum": 0, "format": "int64" }, "source_port_end": { "type": "integer", "maximum": 65535, "minimum": 0, "format": "int64" }, "source_address_cidr": { "type": "string", "format": "ip-address" } }, "title": "Firewall Ruleset Rule Detail Response", "required": [ "action", "direction", "family" ], "additionalProperties": false, "description": "Response schema for firewall ruleset rule details." }, "firewallRulesetQueryParamLimit": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "examples": [ 10, 25, 50, 100 ], "title": "QueryParamLimit", "maximum": 100, "minimum": 0, "format": "int64", "description": "Schema for a query parameter specifying the maximum number of entries to return (limit).", "default": 10 }, "firewallRulesetQueryParamOffset": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "examples": [ 0, 10, 20, 50 ], "title": "Query Param Offset", "minimum": 0, "format": "int64", "description": "Schema for a query parameter specifying the offset for pagination.", "default": 0 }, "firewallRulesetQueryParamSort": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "name", "created_at", "updated_at" ], "title": "Query Param Sort", "description": "Schema for a query parameter specifying the sort field.", "default": "-created_at" }, "firewallRulesetServerUuid": { "type": "string", "examples": [ "01234567-89ab-cdef-0123-456789abcdef", "fedcba98-7654-3210-fedc-ba9876543210" ], "title": "Server UUID", "format": "uuid", "description": "The unique identifier for the server." }, "firewallRulesetLabelKey": { "type": "string", "examples": [ "environment", "team", "project", "purpose", "cost-center" ], "title": "Label Key", "maxLength": 32, "minLength": 2, "pattern": "^[\\x20-\\x5E\\x60-\\x7E][\\x20-\\x7E]+$", "description": "The key of a label." }, "firewallRulesetServerFirewallRulePosition": { "type": "integer", "examples": [ 1, 678 ], "title": "Server Firewall Rule Position", "maximum": 1000, "minimum": 1, "format": "int64", "description": "The server firewall rule position." }, "firewallRulesetCreateLabel": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "key": "dev", "value": "dev-1" }, { "key": "staging", "value": "stg-1" } ], "properties": { "key": { "type": "string", "maxLength": 32, "minLength": 2, "pattern": "^[\\x20-\\x5E\\x60-\\x7E][\\x20-\\x7E]+$", "description": "Key" }, "value": { "type": "string", "maxLength": 255, "pattern": "\\A[\\p{L}\\p{N}\\p{P}\\p{S}\\p{Z}]*\\z", "description": "Value" } }, "title": "Create Label", "required": [ "key", "value" ], "additionalProperties": false, "description": "UpCloud firewall ruleset Label" }, "firewallRulesetFirewallMultipleRuleCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ [ { "direction": "in", "action": "accept", "family": "IPv4", "protocol": "tcp", "enabled": false }, { "direction": "out", "action": "drop", "family": "IPv6" } ] ], "properties": { "rules": { "type": "array", "items": { "$ref": "#/components/schemas/firewallRulesetFirewallRuleCreate" } } }, "required": [ "rules" ], "additionalProperties": false }, "firewallRulesetFirewallRuleCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "direction": "in", "action": "accept", "family": "IPv4", "protocol": "tcp", "enabled": false }, { "direction": "out", "action": "drop", "family": "IPv6" } ], "properties": { "enabled": { "type": "boolean", "description": "Enabled" }, "action": { "$ref": "#/components/schemas/firewallRulesetRuleAction" }, "comment": { "type": "string", "maxLength": 250, "description": "Comments" }, "destination_address_start": { "type": "string", "format": "ip-address" }, "destination_address_end": { "type": "string", "format": "ip-address" }, "destination_port_start": { "type": "integer", "maximum": 65535, "minimum": 0, "format": "int64" }, "destination_port_end": { "type": "integer", "maximum": 65535, "minimum": 0, "format": "int64" }, "destination_address_cidr": { "type": "string" }, "direction": { "$ref": "#/components/schemas/firewallRulesetRuleDirection" }, "family": { "$ref": "#/components/schemas/firewallRulesetRuleFamily" }, "icmp_type": { "$ref": "#/components/schemas/firewallRulesetIcmpType" }, "position": { "type": "integer", "maximum": 1000, "minimum": 0, "format": "int64" }, "protocol": { "$ref": "#/components/schemas/firewallRulesetRuleProtocol" }, "source_address_start": { "type": "string", "format": "ip-address" }, "source_address_end": { "type": "string", "format": "ip-address" }, "source_port_start": { "type": "integer", "maximum": 65535, "minimum": 0, "format": "int64" }, "source_port_end": { "type": "integer", "maximum": 65535, "minimum": 0, "format": "int64" }, "source_address_cidr": { "type": "string" } }, "required": [ "action", "direction", "family" ], "additionalProperties": false }, "firewallRulesetRuleAction": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "title": "Rule Action", "enum": [ "accept", "drop" ], "description": "Rule action." }, "firewallRulesetRuleDirection": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "title": "Rule Direction", "enum": [ "in", "out" ], "description": "Rule direction." }, "firewallRulesetRuleFamily": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "title": "Rule Family", "enum": [ "IPv4", "IPv6", "" ], "description": "Rule family." }, "firewallRulesetIcmpType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "title": "ICMP Type", "maximum": 255, "minimum": -1, "format": "int64", "description": "ICMP type.", "default": -1 }, "firewallRulesetRuleProtocol": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "title": "Rule Protocol", "enum": [ "tcp", "udp", "icmp", "esp", "ah", "all", "" ], "description": "Rule protocol." }, "firewallRulesetFirewallRuleModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "direction": "in", "action": "accept", "family": "IPv4", "protocol": "tcp", "enabled": false }, { "direction": "out", "action": "drop", "family": "IPv6" } ], "properties": { "enabled": { "type": "boolean", "description": "Enabled" }, "action": { "$ref": "#/components/schemas/firewallRulesetRuleAction" }, "comment": { "type": "string", "maxLength": 250, "description": "Comments" }, "destination_address_start": { "type": "string", "format": "ip-address" }, "destination_address_end": { "type": "string", "format": "ip-address" }, "destination_port_start": { "type": "integer", "maximum": 65535, "minimum": 0, "format": "int64" }, "destination_port_end": { "type": "integer", "maximum": 65535, "minimum": 0, "format": "int64" }, "destination_address_cidr": { "type": "string" }, "direction": { "$ref": "#/components/schemas/firewallRulesetRuleDirection" }, "family": { "$ref": "#/components/schemas/firewallRulesetRuleFamily" }, "icmp_type": { "$ref": "#/components/schemas/firewallRulesetIcmpType" }, "position": { "type": "integer", "maximum": 1000, "minimum": 0, "format": "int64" }, "protocol": { "$ref": "#/components/schemas/firewallRulesetRuleProtocol" }, "source_address_start": { "type": "string", "format": "ip-address" }, "source_address_end": { "type": "string", "format": "ip-address" }, "source_port_start": { "type": "integer", "maximum": 65535, "minimum": 0, "format": "int64" }, "source_port_end": { "type": "integer", "maximum": 65535, "minimum": 0, "format": "int64" }, "source_address_cidr": { "type": "string", "format": "ip-address" } }, "additionalProperties": true }, "firewallRulesetLabelModify": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "key": "foo", "value": "bar" } ], "properties": { "key": { "$ref": "#/components/schemas/firewallRulesetLabelKey" }, "value": { "$ref": "#/components/schemas/firewallRulesetLabelValue" } }, "title": "Label Modify", "additionalProperties": false, "description": "Schema for modifying a label with a key-value pair." }, "firewallRulesetLabelValue": { "type": "string", "examples": [ "production", "backend", "web-app", "backup", "engineering" ], "title": "Label Value", "maxLength": 255, "pattern": "\\A[\\p{L}\\p{N}\\p{P}\\p{S}\\p{M}\\p{Z}]*\\z", "description": "Schema for a label value property, allowing a string or null with specific character constraints.", "nullable": true }, "firewallRulesetServerMultipleFirewallRulesCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "firewall_rules": { "firewall_rule": [ { "action": "accept", "comment": "Allow SSH from this network", "destination_address_start": null, "destination_address_end": null, "destination_port_start": "22", "destination_port_end": "22", "direction": "in", "family": "IPv4", "source_address_start": "192.168.1.1", "source_address_end": "192.168.1.255", "source_port_start": null, "source_port_end": null, "icmp_type": null, "protocol": "tcp" }, { "action": "accept", "comment": "Allow DNS from this network", "destination_address_start": null, "destination_address_end": null, "destination_port_start": "53", "destination_port_end": "53", "direction": "in", "family": "IPv4", "source_address_start": "1.1.1.1", "source_address_end": "1.1.1.1", "source_port_start": null, "source_port_end": null, "icmp_type": null, "protocol": "tcp" }, { "action": "drop", "comment": "dfg", "destination_address_start": "100.100.128.2", "destination_address_end": "100.100.128.2", "destination_port_start": "89", "destination_port_end": "89", "direction": "out", "family": "IPv4", "source_address_start": null, "source_address_end": null, "source_port_start": null, "source_port_end": null, "icmp_type": null, "protocol": "tcp" }, { "action": "accept", "comment": "'w???''?p'2'?12??12?3?'231", "destination_address_start": "2a04:3540:1001:1000:1411:4dff:fea5:1bab", "destination_address_end": "2a04:3540:1001:1000:1411:4dff:fea5:1bab", "destination_port_start": null, "destination_port_end": null, "direction": "out", "family": "IPv6", "source_address_start": null, "source_address_end": null, "source_port_start": null, "source_port_end": null, "icmp_type": "12", "protocol": "icmp" } ] } }, { "firewall_rules": null } ], "properties": { "firewall_rules": { "oneOf": [ { "type": "null" }, { "type": "object", "examples": [ { "firewall_rule": [ { "direction": "in", "action": "accept", "family": "IPv4", "protocol": "tcp" }, { "direction": "out", "action": "drop", "family": "IPv4" } ] } ], "properties": { "firewall_rule": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/firewallRulesetServerFirewallRule" } }, { "type": "null" } ] } }, "required": [ "firewall_rule" ], "additionalProperties": false } ] } }, "title": "Server Multiple Firewall Rules Create", "required": [ "firewall_rules" ], "additionalProperties": false, "description": "Creates multiple server firewall rules." }, "firewallRulesetServerFirewallRule": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "direction": "in", "action": "accept", "family": "IPv4", "protocol": "tcp" }, { "direction": "out", "action": "drop", "family": "IPv4" } ], "properties": { "direction": { "$ref": "#/components/schemas/firewallRulesetRuleDirection" }, "action": { "$ref": "#/components/schemas/firewallRulesetRuleAction" }, "position": { "oneOf": [ { "type": "integer", "maximum": 1000, "minimum": 1, "format": "int64" }, { "type": "string", "pattern": "^([1-9][0-9]?[0-9]?|1000)$|^$" } ], "description": "Rule position" }, "family": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^(IPv4|IPv6)$" }, { "type": "string", "pattern": "^$" } ] }, "protocol": { "oneOf": [ { "type": "null" }, { "type": "string", "pattern": "^(tcp|udp|icmp)$" }, { "type": "string", "pattern": "^$" } ], "description": "Rule protocol" }, "enabled": { "type": "string", "pattern": "^(true|1|yes|false|0|no)$|^$", "description": "Rule enabled" }, "icmp_type": { "oneOf": [ { "type": "null" }, { "type": "integer", "maximum": 255, "minimum": 0, "format": "int64" }, { "type": "string", "pattern": "^([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$|^$" } ], "description": "ICMP type" }, "destination_port_start": { "oneOf": [ { "type": "null" }, { "type": "integer", "maximum": 65535, "minimum": 1, "format": "int64" }, { "type": "string", "pattern": "^([1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$|^$" } ], "description": "Destination port range starts from this port number" }, "destination_port_end": { "oneOf": [ { "type": "null" }, { "type": "integer", "maximum": 65535, "minimum": 1, "format": "int64" }, { "type": "string", "pattern": "^([1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$|^$" } ], "description": "Destination port range ends at this port number" }, "source_port_start": { "oneOf": [ { "type": "null" }, { "type": "integer", "maximum": 65535, "minimum": 1, "format": "int64" }, { "type": "string", "pattern": "^([1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$|^$" } ], "description": "Source port range starts from this port number" }, "source_port_end": { "oneOf": [ { "type": "null" }, { "type": "integer", "maximum": 65535, "minimum": 1, "format": "int64" }, { "type": "string", "pattern": "^([1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$|^$" } ], "description": "Source port range ends at this port number" }, "destination_address_start": { "anyOf": [ { "type": "string", "format": "ipv4" }, { "type": "string", "format": "ipv6" }, { "type": "string", "pattern": "^$" }, { "type": "null" } ], "description": "Destination address range starts from this address" }, "destination_address_end": { "anyOf": [ { "type": "string", "format": "ipv4" }, { "type": "string", "format": "ipv6" }, { "type": "string", "pattern": "^$" }, { "type": "null" } ], "description": "Destination address range ends from to this address" }, "source_address_start": { "anyOf": [ { "type": "string", "format": "ipv4" }, { "type": "string", "format": "ipv6" }, { "type": "string", "pattern": "^$" }, { "type": "null" } ], "description": "Source address range starts from this address" }, "source_address_end": { "anyOf": [ { "type": "string", "format": "ipv4" }, { "type": "string", "format": "ipv6" }, { "type": "string", "pattern": "^$" }, { "type": "null" } ], "description": "Source address range ends at this address" }, "comment": { "type": "string", "maxLength": 250, "description": "Comment" } }, "title": "Server Firewall Rule", "required": [ "direction", "action" ], "additionalProperties": false, "description": "Server firewall rule" }, "firewallRulesetServerFirewallRuleCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "firewall_rule": { "position": "1", "direction": "in", "family": "IPv4", "protocol": "tcp", "source_address_start": "192.168.1.1", "source_address_end": "192.168.1.255", "source_port_end": "", "source_port_start": "", "destination_address_start": "", "destination_address_end": "", "destination_port_start": "22", "destination_port_end": "22", "icmp_type": "", "action": "accept", "comment": "Allow SSH from this network" } } ], "properties": { "firewall_rule": { "$ref": "#/components/schemas/firewallRulesetServerFirewallRule" } }, "required": [ "firewall_rule" ], "additionalProperties": false }, "firewallRulesetErrorResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "type": "https://developers.upcloud.com/1.3/errors#ERROR_INVALID_REQUEST", "title": "Validation error.", "invalid_params": [ { "name": "configured_status", "reason": "Value must be one of \"started\", \"stopped\"." } ], "correlation_id": "01K1ZM92JWR9YMWTCMV6JPSQ0J", "status": 400 }, { "type": "https://developers.upcloud.com/1.3/errors#ERROR_NOT_FOUND", "title": "The resource you requested does not exist.", "correlation_id": "01K1ZJC6MSN91RQS3JMEESGG92", "status": 404 }, { "type": "https://developers.upcloud.com/1.3/errors#ERROR_GENERAL_FAILURE", "title": "Your request could not be fulfilled due to a technical issue.", "correlation_id": "01HEPYJ027RF0H29CKHWHCH7RE", "status": 500 } ], "properties": { "type": { "type": "string", "description": "Error code string." }, "title": { "type": "string", "examples": [ "Validation error.", "The resource you requested does not exist.", "Your request could not be fulfilled due to a technical issue." ], "description": "Short description of the error." }, "correlation_id": { "type": "string", "examples": [ "01K1K2TKEASWRJ6VFP9ZV5P2H4" ], "description": "Unique identifier for the request, useful for debugging." }, "status": { "type": "integer", "examples": [ 400, 404, 402, 500 ], "format": "int32", "description": "HTTP status code associated with the error." }, "invalid_params": { "type": "array", "title": "InvalidParameters", "description": "List of invalid parameters in the request.", "items": { "type": "object" } } }, "title": "Error Response", "required": [ "type", "title", "correlation_id", "status" ], "additionalProperties": false, "description": "Schema for error responses from the API." }, "firewallRulesetFirewallRuleListResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "rules": [ { "uuid": "16e7d7fc-9a90-4f42-83f5-ea0396f1592b", "direction": "in", "action": "accept", "family": "IPv4", "protocol": "tcp", "enabled": false } ] } ], "properties": { "rules": { "type": "array", "items": { "$ref": "#/components/schemas/firewallRulesetRuleDetailResponse" } } }, "title": "Firewall Rule List Response", "required": [ "rules" ], "description": "Response schema for a list of firewall ruleset rules." }, "firewallRulesetLabelListResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "array", "examples": [ [ { "key": "foo", "value": "bar" } ] ], "items": { "$ref": "#/components/schemas/firewallRulesetLabelDetailResponse" }, "title": "Label List Response", "description": "Response schema for listing labels." }, "firewallRulesetLabelDetailResponse": { "$schema": "http://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "key": "foo", "value": "bar" } ], "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "title": "Label Detail Response", "description": "Schema for label details including key-value pairs." }, "firewallRulesetServerFirewallDetailResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "firewall_rules": { "firewall_rule": [ { "direction": "in", "action": "accept", "family": "IPv4", "protocol": "tcp" }, { "direction": "out", "action": "drop", "family": "IPv4" } ] } } ], "properties": { "firewall_rules": { "$ref": "#/components/schemas/firewallRulesetServerFirewallRules" } }, "title": "Server Firewall Detail Response", "required": [ "firewall_rules" ], "additionalProperties": false, "description": "Server firewall detail response." }, "firewallRulesetServerFirewallRules": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "firewall_rule": [ { "direction": "in", "action": "accept", "family": "IPv4", "protocol": "tcp" }, { "direction": "out", "action": "drop", "family": "IPv4" } ] } ], "properties": { "firewall_rule": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/firewallRulesetServerFirewallRule" } }, { "type": "null" } ] } }, "title": "Server Firewall Rules", "required": [ "firewall_rule" ], "additionalProperties": false, "description": "Server firewall rules." }, "firewallRulesetErrorLegacyResponse": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "error": { "error_code": "SERVER_INVALID", "error_message": "The server UUID is invalid." } } ], "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "examples": [ "SERVER_INVALID" ] }, "error_message": { "type": "string", "examples": [ "The server UUID is invalid." ] } }, "description": "Schema for legacy error response." } }, "title": "Error Legacy Response", "required": [ "error" ], "additionalProperties": false, "description": "Schema for legacy error responses from API." }, "firewallRulesetServerFirewallRuleDetail": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "examples": [ { "firewall_rule": { "direction": "in", "action": "accept", "family": "IPv4", "protocol": "tcp" } } ], "properties": { "firewall_rule": { "$ref": "#/components/schemas/firewallRulesetServerFirewallRule" } }, "title": "Server Firewall Rule Detail", "required": [ "firewall_rule" ], "additionalProperties": false, "description": "Server firewall rule detail" }, "vncKeymapKeymaps": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "keymaps": { "type": "object", "properties": { "keymap": { "type": "array", "items": { "type": "string" }, "example": [ "fi", "us" ] } }, "required": [ "keymap" ], "additionalProperties": false, "example": { "keymap": [ "fi", "us", "de" ] } } }, "required": [ "keymaps" ], "additionalProperties": false, "description": "List of available VNC keymaps", "example": { "keymaps": { "keymap": [ "fi", "us", "de" ] } } }, "vncKeymapError": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "examples": [ "GENERAL_FAILURE" ] }, "error_message": { "type": "string", "examples": [ "Your request could not be fulfilled due to a technical issue." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "A general error response indicating that the request could not be fulfilled due to a technical issue." }, "zone": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "examples": [ "fi-hel1", "de-fra1", "us-nyc1" ], "maxLength": 15, "minLength": 2, "pattern": "^[a-z][a-z0-9-]{0,14}[a-z0-9]$", "description": "Zone identifier" }, "zones": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "zones": { "type": "object", "properties": { "zone": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "id": { "$ref": "#/components/schemas/zone" }, "public": { "$ref": "#/components/schemas/zoneBooleanYesno" } }, "required": [ "description", "id", "public" ], "additionalProperties": false }, "example": [ { "id": "de-fra1", "description": "Germany, Frankfurt", "public": "yes" } ] } }, "required": [ "zone" ], "additionalProperties": false, "example": { "zone": [ { "id": "de-fra1", "description": "Germany, Frankfurt", "public": "yes" } ] } } }, "required": [ "zones" ], "additionalProperties": false, "description": "Zones schema", "example": { "zones": { "zone": [ { "id": "de-fra1", "description": "Germany, Frankfurt", "public": "yes" }, { "id": "fi-hel2", "description": "Finland, Helsinki", "public": "no" } ] } } }, "zoneVlans": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "zone_vlans": { "type": "object", "properties": { "vlan": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "format": "int64" }, "access": { "type": "string", "maxLength": 255 }, "description": { "type": "string", "maxLength": 255 }, "default": { "$ref": "#/components/schemas/zoneBoolean01" } }, "required": [ "id", "access", "description", "default" ], "additionalProperties": false }, "example": [ { "id": 100, "access": "public", "description": "default public vlan", "default": 1 } ] } }, "required": [ "vlan" ], "additionalProperties": false, "example": { "vlan": [ { "id": 100, "access": "public", "description": "default public vlan", "default": 1 } ] } } }, "required": [ "zone_vlans" ], "additionalProperties": false, "description": "Schema for zone VLANs", "example": { "zone_vlans": { "vlan": [ { "id": 100, "access": "public", "description": "default public vlan", "default": 1 } ] } } }, "zoneBooleanYesno": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "string", "enum": [ "yes", "no" ], "description": "Boolean value represented as yes/no", "example": "yes" }, "zoneError": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "error": { "type": "object", "properties": { "error_code": { "type": "string", "examples": [ "GENERAL_FAILURE" ] }, "error_message": { "type": "string", "examples": [ "Your request could not be fulfilled due to a technical issue." ] } }, "required": [ "error_code", "error_message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false, "description": "A general error response indicating that the request could not be fulfilled due to a technical issue." }, "zoneBoolean01": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "integer", "format": "int64", "enum": [ 0, 1 ], "description": "Schema for boolean-like values encoded as 0 or 1." } }, "responses": { "accountDetails200": { "description": "Account details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account" } } } }, "accountDetailsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountError" } } } }, "listAccounts200": { "description": "Account list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts" } } } }, "listAccountsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountError" } } } }, "getAccountNetworkTopUsage200": { "description": "Top resource network usage statistics.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountResourceNetworkUsage" } } } }, "getAccountNetworkTopUsageDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountError" } } } }, "getAccountNetworkUsage200": { "description": "Account network usage statistics.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountNetworkUsage" } } } }, "getAccountNetworkUsageDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountError" } } } }, "getAccountResourceUsage200": { "description": "Current account resource usage.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountResourceUsage" } } } }, "getAccountResourceUsageDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountError" } } } }, "getAccountResourceNetworkUsage200": { "description": "Resource network usage statistics.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountResourceNetworkUsage" } } } }, "getAccountResourceNetworkUsageDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountError" } } } }, "createSubaccount204": { "description": "Subaccount created." }, "createSubaccountDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountError" } } } }, "deleteSubaccount204": { "description": "Subaccount deleted." }, "deleteSubaccountDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountError" } } } }, "accountGetMonthlyDetailedBillingSummary200": { "description": "Detailed monthly billing summary.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountBillingSummary" } } } }, "accountGetMonthlyDetailedBillingSummaryDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountError" } } } }, "accountGetMonthlyBillingSummary200": { "description": "Monthly billing summary.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountBillingSummaryResponse" } } } }, "accountGetMonthlyBillingSummaryDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountError" } } } }, "accountGetCurrentNetworkUsage200": { "description": "Current Fair Transfer Policy usage.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountCurrentNetworkUsage" } } } }, "accountGetCurrentNetworkUsageDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountError" } } } }, "accountCreateMSLMASigningLink201": { "description": "LMA signing link created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountCreateMsLmaSigningLinkResponse" } } } }, "accountCreateMSLMASigningLinkDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountError" } } } }, "accountGetMonthlyResourceBillingSummary200": { "description": "Monthly resource billing summary.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountResourceBillingSummaryResponse" } } } }, "accountGetMonthlyResourceBillingSummaryDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountError" } } } }, "kubernetesBadRequest": { "description": "400 Bad request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/kubernetesError" }, "example": { "type": "https://developers.upcloud.com/1.3/errors#INVALID_REQUEST", "title": "payload validation failed", "correlation_id": "01GSCRT0RDS9EB2HMMMP5550ZR", "status": 400 } } } }, "kubernetesDeleteCluster": { "description": "202 deleteCluster response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesAccepted" }, "example": { "message": "deletion started for cluster 11111111-1111-1111-1111-1111" } } } }, "kubernetesDeleteNodeGroup": { "description": "202 deleteNodeGroup response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesAccepted" }, "example": { "message": "deletion started for node group 'small'" } } } }, "kubernetesDeleteNodeGroupNode": { "description": "202 deleteNodeGroup response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesAccepted" }, "example": { "message": "deletion started for node group node 'small/node-xyz'" } } } }, "kubernetesGetCluster": { "description": "200 getCluster response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesCluster" }, "example": { "control_plane_ip_filter": [ "1.2.3.4/24", "1.1.1.1" ], "name": "example-cluster", "network": "33333333-3333-3333-333333333333", "network_cidr": "172.16.0.0/24", "node_groups": [ { "count": 4, "kubelet_args": [ { "key": "log-flush-frequency", "value": "5s" } ], "labels": [ { "key": "managedBy", "value": "exampleDevelopmentTeam" }, { "key": "environment", "value": "development" } ], "name": "small", "plan": "K8S-2xCPU-4GB", "ssh_keys": [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV" ], "state": "running", "storage": "01000000-0000-4000-8000-000160010100", "taints": [ { "effect": "NoSchedule", "key": "environment", "value": "development" } ] }, { "count": 8, "kubelet_args": [ { "key": "log-flush-frequency", "value": "15s" } ], "labels": [ { "key": "managedBy", "value": "exampleStagingTeam" }, { "key": "environment", "value": "staging" } ], "name": "medium", "plan": "K8S-4xCPU-8GB", "ssh_keys": [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV" ], "state": "pending", "storage": "01000000-0000-4000-8000-000160010100", "taints": [ { "effect": "NoSchedule", "key": "environment", "value": "staging" } ] } ], "uuid": "11111111-1111-1111-1111-111111111111", "state": "running", "zone": "de-fra1" } } } }, "kubernetesGetClusterKubeconfig": { "description": "200 getClusterKubeconfig response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesClusterKubeconfig" }, "example": { "kubeconfig": "apiVersion: v1\nclusters:\n- cluster:\n certificate-authority-data: FAKEBASE64=\n server: https://server\n name: example-cluster\ncontexts:\n- context:\n cluster: example-cluster\n user: example-cluster-admin\n name: example-cluster-admin@example-cluster\ncurrent-context: example-cluster-admin@example-cluster\nkind: Config\npreferences: {}\nusers:\n- name: example-cluster-admin\n user:\n client-certificate-data: FAKEBASE64=\n client-key-data: FAKEBASE64=\n" } } } }, "kubernetesGetNodeGroupDetails": { "description": "200 getNodeGroupDetails response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesNodeGroupDetails" } } } }, "kubernetesGetAvailableUpgrades": { "description": "200 upgrades response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesClusterAvailableUpgrades" }, "example": [ { "versions": [ "1.31.8", "1.32.0" ] } ] } } }, "kubernetesPostUpgrade": { "description": "200 upgrades response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesClusterAvailableUpgradesPost" }, "example": { "version": "1.31", "strategy": { "type": "manual" } } } } }, "kubernetesGetNodeGroups": { "description": "200 getNodeGroups response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesNodeGroups" }, "example": [ { "count": 4, "kubelet_args": [ { "key": "log-flush-frequency", "value": "5s" } ], "labels": [ { "key": "managedBy", "value": "exampleDevelopmentTeam" }, { "key": "environment", "value": "development" } ], "name": "small", "plan": "K8S-2xCPU-4GB", "ssh_keys": [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV" ], "state": "running", "storage": "01000000-0000-4000-8000-000160010100", "taints": [ { "effect": "NoSchedule", "key": "environment", "value": "development" } ] }, { "count": 8, "kubelet_args": [ { "key": "log-flush-frequency", "value": "15s" } ], "labels": [ { "key": "managedBy", "value": "exampleStagingTeam" }, { "key": "environment", "value": "staging" } ], "name": "medium", "plan": "K8S-4xCPU-8GB", "ssh_keys": [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV" ], "state": "pending", "storage": "01000000-0000-4000-8000-000160010100", "taints": [ { "effect": "NoSchedule", "key": "environment", "value": "staging" } ] } ] } } }, "kubernetesGetClusters": { "description": "200 getClusters response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesClusters" }, "example": [ { "control_plane_ip_filter": [ "1.2.3.4/24", "1.1.1.1" ], "name": "example-cluster", "network": "33333333-3333-3333-333333333333", "network_cidr": "172.16.0.0/24", "node_groups": [ { "count": 4, "kubelet_args": [ { "key": "log-flush-frequency", "value": "5s" } ], "labels": [ { "key": "managedBy", "value": "exampleDevelopmentTeam" }, { "key": "environment", "value": "development" } ], "name": "small", "plan": "K8S-2xCPU-4GB", "ssh_keys": [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV" ], "state": "running", "storage": "01000000-0000-4000-8000-000160010100", "taints": [ { "effect": "NoSchedule", "key": "environment", "value": "development" } ] }, { "count": 8, "kubelet_args": [ { "key": "log-flush-frequency", "value": "15s" } ], "labels": [ { "key": "managedBy", "value": "exampleStagingTeam" }, { "key": "environment", "value": "staging" } ], "name": "medium", "plan": "K8S-4xCPU-8GB", "ssh_keys": [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV" ], "state": "pending", "storage": "01000000-0000-4000-8000-000160010100", "taints": [ { "effect": "NoSchedule", "key": "environment", "value": "staging" } ] } ], "uuid": "11111111-1111-1111-1111-111111111111", "state": "running", "zone": "de-fra1" }, { "name": "another-example-cluster", "network": "another33333333-3333-3333-333333333333", "network_cidr": "172.16.0.0/24", "node_groups": [ { "count": 4, "name": "large", "plan": "K8S-8xCPU-32GB", "ssh_keys": [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV" ], "state": "running", "storage": "01000000-0000-4000-8000-000160010100" } ], "uuid": "22222222-2222-2222-2222-222222222222", "state": "pending", "zone": "de-fra1" } ] } } }, "kubernetesGetPlan": { "description": "200 getPlans response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesPlans" }, "example": [ { "description": "K8S-2xCPU-4GB", "name": "small" }, { "description": "K8S-4xCPU-8GB", "name": "medium" }, { "description": "K8S-8xCPU-32GB", "name": "large" } ] } } }, "kubernetesGetVersion": { "description": "200 getVersions response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesVersions" }, "example": [ { "id": "1.26", "version": "1.26.4" }, { "id": "1.27", "version": "1.27.2" } ] } } }, "kubernetesInternalServerError": { "description": "500 Internal server error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/kubernetesError" }, "example": { "type": "https://developers.upcloud.com/1.3/errors#ERROR_GENERIC_ERROR", "title": "failed to get version.", "correlation_id": "01GSCRT0RDS9EB2HMMMP5550ZR", "status": 500 } } } }, "kubernetesNotFound": { "description": "404 Not found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/kubernetesError" }, "example": { "type": "https://developers.upcloud.com/1.3/errors#ERROR_NOT_FOUND", "title": "cluster not found.", "correlation_id": "01GSCRT0RDS9EB2HMMMP5550ZR", "status": 404 } } } }, "kubernetesConflict": { "description": "409 Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/kubernetesError" }, "example": { "type": "https://developers.upcloud.com/1.3/errors#CONFLICT", "title": "an authentication entry with this name already exists.", "correlation_id": "01GSCRT0RDS9EB2HMMMP5550ZR", "status": 409 } } } }, "kubernetesPostCluster": { "description": "201 postCluster response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesCluster" }, "example": { "control_plane_ip_filter": [ "1.2.3.0/24", "1.1.1.1" ], "name": "example-cluster", "network": "33333333-3333-3333-333333333333", "network_cidr": "172.16.0.0/24", "node_groups": [ { "count": 4, "kubelet_args": [ { "key": "log-flush-frequency", "value": "5s" } ], "labels": [ { "key": "managedBy", "value": "exampleDevelopmentTeam" }, { "key": "environment", "value": "development" } ], "name": "example-node-group-small", "plan": "K8S-2xCPU-4GB", "ssh_keys": [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV" ], "state": "pending", "storage": "01000000-0000-4000-8000-000160010100", "taints": [ { "effect": "NoSchedule", "key": "environment", "value": "development" } ] }, { "count": 8, "kubelet_args": [ { "key": "log-flush-frequency", "value": "15s" } ], "labels": [ { "key": "managedBy", "value": "exampleStagingTeam" }, { "key": "environment", "value": "staging" } ], "name": "example-node-group-medium", "plan": "K8S-4xCPU-8GB", "ssh_keys": [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV" ], "state": "pending", "storage": "01000000-0000-4000-8000-000160010100", "taints": [ { "effect": "NoSchedule", "key": "environment", "value": "staging" } ] } ], "uuid": "11111111-1111-1111-1111-111111111111", "state": "pending", "zone": "de-fra1" } } } }, "kubernetesPatchCluster": { "description": "202 patchCluster response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesCluster" }, "example": { "control_plane_ip_filter": [ "1.2.3.0/24", "1.1.1.1" ], "name": "example-cluster", "network": "33333333-3333-3333-333333333333", "network_cidr": "172.16.0.0/24", "node_groups": [ { "count": 4, "kubelet_args": [ { "key": "log-flush-frequency", "value": "5s" } ], "labels": [ { "key": "managedBy", "value": "exampleDevelopmentTeam" }, { "key": "environment", "value": "development" } ], "name": "example-node-group-small", "plan": "K8S-2xCPU-4GB", "ssh_keys": [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV" ], "state": "pending", "storage": "01000000-0000-4000-8000-000160010100", "taints": [ { "effect": "NoSchedule", "key": "environment", "value": "development" } ] }, { "count": 8, "kubelet_args": [ { "key": "log-flush-frequency", "value": "15s" } ], "labels": [ { "key": "managedBy", "value": "exampleStagingTeam" }, { "key": "environment", "value": "staging" } ], "name": "example-node-group-medium", "plan": "K8S-4xCPU-8GB", "ssh_keys": [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV" ], "state": "running", "storage": "01000000-0000-4000-8000-000160010100", "taints": [ { "effect": "NoSchedule", "key": "environment", "value": "staging" } ] } ], "uuid": "11111111-1111-1111-1111-111111111111", "state": "running", "zone": "de-fra1" } } } }, "kubernetesPatchNodeGroup": { "description": "200 patchNodeGroup response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesNodeGroup" }, "example": { "count": 16, "kubelet_args": [ { "key": "log-flush-frequency", "value": "5s" } ], "labels": [ { "key": "managedBy", "value": "exampleDevelopmentTeam" }, { "key": "environment", "value": "development" } ], "name": "small", "plan": "K8S-2xCPU-4GB", "ssh_keys": [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV" ], "state": "running", "storage": "01000000-0000-4000-8000-000160010100", "taints": [ { "effect": "NoSchedule", "key": "environment", "value": "development" } ] } } } }, "kubernetesPostNodeGroup": { "description": "201 postNodeGroup response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesNodeGroup" }, "example": { "count": 4, "kubelet_args": [ { "key": "log-flush-frequency", "value": "5s" } ], "labels": [ { "key": "managedBy", "value": "exampleDevelopmentTeam" }, { "key": "environment", "value": "development" } ], "name": "small", "plan": "K8S-2xCPU-4GB", "ssh_keys": [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV" ], "state": "pending", "storage": "01000000-0000-4000-8000-000160010100", "taints": [ { "effect": "NoSchedule", "key": "environment", "value": "development" } ] } } } }, "kubernetesUnAuthorized": { "description": "401 Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/kubernetesError" }, "example": { "type": "https://developers.upcloud.com/1.3/errors#AUTHENTICATION_FAILED", "title": "Authentication failed using the given username and password.", "correlation_id": "01GSCRT0RDS9EB2HMMMP5550ZR", "status": 401 } } } }, "kubernetesUnProcessableEntity": { "description": "422 Unprocessable entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/kubernetesError" }, "example": { "type": "https://developers.upcloud.com/1.3/errors#INVALID_REQUEST", "title": "zone is not valid", "correlation_id": "01GSCRT0RDS9EB2HMMMP5550ZR", "status": 422 } } } }, "kubernetesListClusterAuthentication200": { "description": "List of authentication entries.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesAuthenticationConfiguration" } } } }, "kubernetesCreateClusterAuthentication201": { "description": "Authentication entry created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesAuthenticationIssuerConfig" } } } }, "kubernetesSetClusterAuthentication200": { "description": "Authentication configuration replaced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesAuthenticationConfiguration" } } } }, "kubernetesImportClusterAuthentication200": { "description": "Authentication configuration imported.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesAuthenticationConfiguration" } } } }, "kubernetesGetClusterAuthentication200": { "description": "Authentication entry details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesAuthenticationIssuerConfig" } } } }, "kubernetesUpdateClusterAuthentication200": { "description": "Authentication entry updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesAuthenticationIssuerConfig" } } } }, "kubernetesDeleteClusterAuthentication204": { "description": "Authentication entry deleted." }, "currencyListCurrencies200": { "description": "A list of currencies with their exchange rates.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/currencyCurrencies" } } } }, "currencyListCurrenciesDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/currencyError" } } } }, "getAvailablePassthroughDevices200": { "description": "A list of available passthrough devices.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/devices" } } } }, "getAvailablePassthroughDevicesDefault": { "description": "General failure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deviceError" } } } }, "listEvents200": { "description": "A list of events.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/events" } } } }, "listEventsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/eventsError" } } } }, "listIPAddresses200": { "description": "A list of servers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ipAddressesResponse" } } } }, "listIPAddressesDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ipAddressError" } } } }, "addIPAddress201": { "description": "The newly created IP address.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ipAddressRequest" } } } }, "addIPAddressDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ipAddressError" } } } }, "bulkModifyIPAddresses204": { "description": "The IP addresses were successfully modified." }, "bulkModifyIPAddressesDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ipAddressError" } } } }, "getIPAddressDetails200": { "description": "Details of the specified IP address.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ipAddressResponse" } } } }, "getIPAddressDetailsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ipAddressError" } } } }, "modifyIPAddress202": { "description": "The modified IP address.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ipAddressRequest" } } } }, "modifyIPAddressDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ipAddressError" } } } }, "deleteIPAddress204": { "description": "IP address successfully deleted." }, "deleteIPAddressDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ipAddressError" } } } }, "patchModifyIPAddress202": { "description": "The modified IP address.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ipAddressRequest" } } } }, "patchModifyIPAddressDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ipAddressError" } } } }, "listNetworkPeerings200": { "description": "A list of network peerings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkPeerings" } } } }, "listNetworkPeeringsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/networkPeeringError" } } } }, "createNetworkPeering201": { "description": "The network peering was successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkPeering" } } } }, "createNetworkPeering400": { "description": "Invalid request data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkPeeringError" } } } }, "createNetworkPeering404": { "description": "One of the specified networks does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkPeeringError" } } } }, "createNetworkPeering409": { "description": "A peering between the specified networks already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkPeeringError" } } } }, "createNetworkPeeringDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/networkPeeringError" } } } }, "getNetworkPeering200": { "description": "Details of the specified network peering.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkPeering" } } } }, "getNetworkPeering404": { "description": "The specified network peering does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkPeeringError" } } } }, "getNetworkPeeringDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/networkPeeringError" } } } }, "deleteNetworkPeering204": { "description": "The network peering was successfully deleted." }, "deleteNetworkPeering404": { "description": "The specified network peering does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkPeeringError" } } } }, "deleteNetworkPeeringDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/networkPeeringError" } } } }, "modifyNetworkPeering200": { "description": "The network peering was successfully modified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkPeering" } } } }, "modifyNetworkPeering400": { "description": "Invalid request data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkPeeringError" } } } }, "modifyNetworkPeering404": { "description": "The specified network peering does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkPeeringError" } } } }, "modifyNetworkPeeringDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/networkPeeringError" } } } }, "listNetworks200": { "description": "List of networks.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networks" } } } }, "listNetworksDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/networkError" } } } }, "createNetwork201": { "description": "Created network.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/network" } } } }, "createNetworkDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/networkError" } } } }, "listNetworkInterfaces200": { "description": "List of network interfaces.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkInterfaces" } } } }, "listNetworkInterfacesDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/networkError" } } } }, "createNetworkInterface201": { "description": "Created network interface.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkInterface" } } } }, "createNetworkInterfaceDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/networkError" } } } }, "getNetworkInterfaceDetails200": { "description": "Details of the requested network interface.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/network" } } } }, "getNetworkInterfaceDetailsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/networkError" } } } }, "deleteNetworkInterface204": { "description": "Network interface successfully deleted." }, "deleteNetworkInterfaceDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/networkError" } } } }, "getNetworkDetails200": { "description": "Details of the requested network.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/network" } } } }, "getNetworkDetailsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/networkError" } } } }, "modifyNetwork200": { "description": "Updated network details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/network" } } } }, "modifyNetworkDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/networkError" } } } }, "deleteNetwork204": { "description": "Network successfully deleted." }, "deleteNetworkDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/networkError" } } } }, "listAuditLogs200": { "description": "Successful response", "headers": { "UpCloud-Total-Count": { "description": "Total count of items available", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/auditLogsResponse" } } } }, "listAuditLogsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/auditLogsErrorResponse" } } } }, "exportAuditLogs200": { "description": "File download. Returns JSON array of audit logs when format=json, or CSV when format=csv.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/auditLogsResponse" } } } }, "exportAuditLogsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/auditLogsErrorResponse" } } } }, "auditLogsGetAuditLog200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/auditLogsAuditLog" } } } }, "auditLogsGetAuditLogDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/auditLogsErrorResponse" } } } }, "auditLogsGetFilterOptions200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/auditLogsFilterOptionsResponse" } } } }, "auditLogsGetFilterOptionsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/auditLogsErrorResponse" } } } }, "listPartnerAccounts200": { "description": "A list of partner accounts.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerAccounts" } } } }, "listPartnerAccountsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/partnerError" } } } }, "createPartnerAccount201": { "description": "Created partner account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerAccount" } } } }, "createPartnerAccount400": { "description": "Invalid or missing attribute(s) in the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerError400" } } } }, "createPartnerAccount403": { "description": "Partner specific account creation limit has been reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerError403" } } } }, "createPartnerAccount409": { "description": "An account using the given `username` already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerError409" } } } }, "createPartnerAccountDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/partnerError" } } } }, "listPermissions200": { "description": "A list of permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/permissions" } } } }, "listPermissionsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/permissionError" } } } }, "replacePermissions200": { "description": "The updated list of permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/permissions" } } } }, "replacePermissionsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/permissionError" } } } }, "grantPermission200": { "description": "The granted permission.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/permission" } } } }, "grantPermissionDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/permissionError" } } } }, "revokePermission204": { "description": "Permission successfully revoked. No content in response body." }, "revokePermissionDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/permissionError" } } } }, "revokeAllPermissionsByTarget204": { "description": "All permissions for the specified target successfully revoked. No content in response body." }, "revokeAllPermissionsByTargetDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/permissionError" } } } }, "revokeAllPermissionsByUser204": { "description": "All permissions for the specified user successfully revoked. No content in response body." }, "revokeAllPermissionsByUserDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/permissionError" } } } }, "listPlans200": { "description": "A list of plans.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plan" } } } }, "listPlansDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/planError" } } } }, "getPrice200": { "description": "A price list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/prices" } } } }, "getPrice400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/priceError400" } } } }, "getPriceDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/priceError" } } } }, "listRouters200": { "description": "A list of routers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routers" } } } }, "listRoutersDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/routerError" } } } }, "createRouter201": { "description": "Router created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/router" } } } }, "createRouter400": { "description": "Invalid input data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routerError" } } } }, "createRouter409": { "description": "Router with the same name already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routerError" } } } }, "createRouterDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/routerError" } } } }, "getRouter200": { "description": "Router details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/router" } } } }, "getRouter404": { "description": "Router not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routerError" } } } }, "getRouterDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/routerError" } } } }, "deleteRouter204": { "description": "Router deleted successfully." }, "deleteRouter404": { "description": "Router not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routerError" } } } }, "deleteRouter409": { "description": "Router cannot be deleted due to existing dependencies.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routerError" } } } }, "deleteRouterDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/routerError" } } } }, "modifyRouter200": { "description": "Router modified successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/router" } } } }, "modifyRouter400": { "description": "Invalid input data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routerError" } } } }, "modifyRouter404": { "description": "Router not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routerError" } } } }, "modifyRouter409": { "description": "Conflict in modifying the router.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routerError" } } } }, "modifyRouterDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/routerError" } } } }, "listServerGroups200": { "description": "A list of server groups.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverGroups" } } } }, "listServerGroupsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverGroupError" } } } }, "createServerGroup200": { "description": "Details of the created server group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverGroup" } } } }, "createServerGroupDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverGroupError" } } } }, "getServerGroup200": { "description": "Details of the server group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverGroup" } } } }, "getServerGroupDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverGroupError" } } } }, "deleteServerGroup204": { "description": "The server group was successfully deleted. No content is returned." }, "deleteServerGroupDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverGroupError" } } } }, "modifyServerGroup200": { "description": "Details of the modified server group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverGroup" } } } }, "modifyServerGroupDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverGroupError" } } } }, "listServerGroupMembers200": { "description": "A list of servers in the server group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverGroupServers" } } } }, "listServerGroupMembersDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverGroupError" } } } }, "serverGroupAddServerToGroup204": { "description": "The server was successfully added to the group. No content is returned." }, "serverGroupAddServerToGroupDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverGroupError" } } } }, "serverGroupRemoveServerFromGroup204": { "description": "The server was successfully removed from the group. No content is returned." }, "serverGroupRemoveServerFromGroupDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverGroupError" } } } }, "listServers200": { "description": "Cloud Server list returned successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getServerList" } } } }, "listServers400": { "description": "Invalid filter or sorting parameter.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "listServers403": { "description": "Access denied or insufficient permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "listServers404": { "description": "A requested tag does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "listServers409": { "description": "A repeated filter exceeds its allowed limit or a UUID is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "listServersDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "createServer202": { "description": "Created a Cloud Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createServerResponse" } } } }, "createServer400": { "description": "Invalid request parameters or malformed request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "createServer403": { "description": "Access denied or insufficient permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "createServer404": { "description": "Passthrough device not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "createServer409": { "description": "Conflicting operation in progress or invalid resource state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "createServerDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "getServer200": { "description": "Cloud Server details returned successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server" } } } }, "getServer400": { "description": "The Cloud Server UUID is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "getServer403": { "description": "Username does not have access to this Cloud Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "getServer404": { "description": "Cloud Server does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "getServerDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "modifyServer202": { "description": "Modified a Cloud Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server" } } } }, "modifyServer400": { "description": "Invalid request parameters or malformed request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "modifyServer403": { "description": "Access denied or insufficient permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "modifyServer404": { "description": "Cloud Server not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "modifyServer409": { "description": "Conflicting operation in progress or invalid resource state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "modifyServerDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "deleteServer204": { "description": "Cloud Server deleted." }, "deleteServer400": { "description": "Invalid Cloud Server or deletion policy.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "deleteServer403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "deleteServer404": { "description": "Cloud Server not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "deleteServer409": { "description": "Cloud Server or storage is in an invalid state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "deleteServerDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "cancelServerOperation204": { "description": "Operation cancelled." }, "cancelServerOperation400": { "description": "The Cloud Server UUID is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "cancelServerOperation403": { "description": "Username does not have access to this Cloud Server or the Cloud Server is not in a state that allows its operation to be cancelled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "cancelServerOperation404": { "description": "Cloud Server does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "cancelServerOperation409": { "description": "Operation cannot be cancelled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "cancelServerOperationDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "listServerGPUs200": { "description": "GPU list returned successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverGpus" } } } }, "listServerGPUs400": { "description": "The Cloud Server UUID is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "listServerGPUs403": { "description": "Username does not have access to this Cloud Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "listServerGPUs404": { "description": "Cloud Server does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "listServerGPUsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "getServerNetworking200": { "description": "Cloud Server networking details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverNetworkingResponse" } } } }, "getServerNetworking400": { "description": "The Cloud Server UUID is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "getServerNetworking403": { "description": "Username does not have access to this Cloud Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "getServerNetworking404": { "description": "Cloud Server does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "getServerNetworkingDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "addServerInterface201": { "description": "Network interface added", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverInterfaceResponse" } } } }, "addServerInterface400": { "description": "The Cloud Server UUID is invalid or the request body is malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "addServerInterface403": { "description": "Username does not have access to this Cloud Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "addServerInterface404": { "description": "Cloud Server or network does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "addServerInterface409": { "description": "The Cloud Server is not stopped, the requested index is in use, or an interface, address, or device limit would be exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "addServerInterfaceDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "modifyServerInterface200": { "description": "Network interface modified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverInterfaceResponse" } } } }, "modifyServerInterface400": { "description": "The Cloud Server UUID or interface index is invalid or the request body is malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "modifyServerInterface403": { "description": "Username does not have access to this Cloud Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "modifyServerInterface404": { "description": "Cloud Server or interface does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "modifyServerInterface409": { "description": "The Cloud Server is not stopped, the requested new index is in use, or the requested interface configuration is not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "modifyServerInterfaceDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "deleteServerInterface204": { "description": "Success" }, "deleteServerInterface400": { "description": "The Cloud Server UUID or interface index is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "deleteServerInterface403": { "description": "Username does not have access to this Cloud Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "deleteServerInterface404": { "description": "Cloud Server or interface does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "deleteServerInterface409": { "description": "The Cloud Server is not stopped", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "deleteServerInterfaceDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "addServerInterfaceIpAddress201": { "description": "IP address added", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverIpAddressInterfaceResponse" } } } }, "addServerInterfaceIpAddress400": { "description": "The Cloud Server UUID or interface index is invalid or the request body is malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "addServerInterfaceIpAddress403": { "description": "Username does not have access to this Cloud Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "addServerInterfaceIpAddress404": { "description": "Cloud Server or interface does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "addServerInterfaceIpAddress409": { "description": "The interface type does not support this operation, the address is already attached or invalid for the network, the address family conflicts, or an address limit would be exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "addServerInterfaceIpAddressDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "deleteServerInterfaceIpAddress204": { "description": "Success" }, "deleteServerInterfaceIpAddress400": { "description": "The Cloud Server UUID, interface index or IP address is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "deleteServerInterfaceIpAddress403": { "description": "Username does not have access to this Cloud Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "deleteServerInterfaceIpAddress404": { "description": "Cloud Server, interface, or attached IP address does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "deleteServerInterfaceIpAddress409": { "description": "The interface type does not support this operation or deleting the address would violate the minimum address limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "deleteServerInterfaceIpAddressDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "rebuildServer202": { "description": "Cloud Server rebuild initiated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server" } } } }, "rebuildServer400": { "description": "The Cloud Server UUID is invalid or the request body is malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "rebuildServer403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "rebuildServer404": { "description": "Cloud Server or storage does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "rebuildServer409": { "description": "Cloud Server or storage cannot be rebuilt in its current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "rebuildServerDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "relocateServer200": { "description": "Cloud Server relocated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server" } } } }, "relocateServer400": { "description": "The Cloud Server UUID is invalid or the request body is malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "relocateServer403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "relocateServer404": { "description": "Cloud Server or zone does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "relocateServer409": { "description": "Cloud Server or an attached resource cannot be relocated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "relocateServerDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "restartServer200": { "description": "Cloud Server restart initiated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server" } } } }, "restartServer400": { "description": "Invalid Cloud Server or restart options.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "restartServer403": { "description": "Access denied or quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "restartServer404": { "description": "Cloud Server or host not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "restartServer409": { "description": "Cloud Server cannot be restarted in its current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "restartServerDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "startServer200": { "description": "Cloud Server start initiated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server" } } } }, "startServer400": { "description": "Invalid Cloud Server or start options.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "startServer403": { "description": "Access denied or quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "startServer404": { "description": "Cloud Server or host not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "startServer409": { "description": "Cloud Server cannot be started in its current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "startServerDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "stopServer200": { "description": "Cloud Server stop initiated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server" } } } }, "stopServer400": { "description": "The Cloud Server UUID is invalid or the request body is malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "stopServer403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "stopServer404": { "description": "Cloud Server does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "stopServer409": { "description": "Cloud Server cannot be stopped in its current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "stopServerDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverListFirewallRulesetRelationships200": { "description": "Cloud Servers related to the firewall ruleset", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetRelatedServers" } } } }, "serverListFirewallRulesetRelationships400": { "description": "The firewall ruleset UUID is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "serverListFirewallRulesetRelationshipsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverGetLabels200": { "description": "Cloud Server labels returned successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getAllServerLabels" } } } }, "serverGetLabelsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverAttachPrivateFirewallRuleset200": { "description": "Private firewall ruleset relationship", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverFirewallRulesetRelationship" } } } }, "serverAttachPrivateFirewallRuleset400": { "description": "The Cloud Server UUID is invalid or the request body is malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "serverAttachPrivateFirewallRuleset403": { "description": "Username does not have access to this Cloud Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "serverAttachPrivateFirewallRuleset404": { "description": "Cloud Server or firewall ruleset does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "serverAttachPrivateFirewallRuleset409": { "description": "The Cloud Server state does not allow the ruleset relationship to be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "serverAttachPrivateFirewallRulesetDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverEjectCDROM200": { "description": "CD-ROM ejected; updated Cloud Server details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server" } } } }, "serverEjectCDROM400": { "description": "The Cloud Server UUID is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "serverEjectCDROM403": { "description": "The Cloud Server or loaded storage is not accessible to the authenticated account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "serverEjectCDROM404": { "description": "Cloud Server does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "serverEjectCDROM409": { "description": "The Cloud Server or storage state does not allow ejecting the CD-ROM, or no CD-ROM device is attached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "serverEjectCDROM511": { "description": "The CD-ROM media could not be ejected from the running Cloud Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError511" } } } }, "serverEjectCDROMDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverLoadCDROM200": { "description": "CD-ROM image loaded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server" } } } }, "serverLoadCDROM400": { "description": "The Cloud Server UUID is invalid or the request body is malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "serverLoadCDROM403": { "description": "The Cloud Server or storage is not accessible to the authenticated account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "serverLoadCDROM404": { "description": "Cloud Server or storage does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "serverLoadCDROM409": { "description": "The Cloud Server or storage state does not allow loading the CD-ROM, no CD-ROM device is attached, or the storage is already attached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "serverLoadCDROM511": { "description": "The CD-ROM media could not be ejected or loaded on the running Cloud Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError511" } } } }, "serverLoadCDROMDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverDetachPrivateFirewallRuleset200": { "description": "Private firewall ruleset relationship", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverFirewallRulesetRelationship" } } } }, "serverDetachPrivateFirewallRuleset400": { "description": "The Cloud Server UUID is invalid or the request body is malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "serverDetachPrivateFirewallRuleset403": { "description": "Username does not have access to this Cloud Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "serverDetachPrivateFirewallRuleset404": { "description": "Cloud Server, firewall ruleset, or relationship does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "serverDetachPrivateFirewallRuleset409": { "description": "The Cloud Server state does not allow the ruleset relationship to be changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "serverDetachPrivateFirewallRulesetDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverListFirewallRules200": { "description": "A list of firewall rules", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverFirewallRules" } } } }, "serverListFirewallRules400": { "description": "The Cloud Server UUID is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "serverListFirewallRules403": { "description": "Username does not have access to this Cloud Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "serverListFirewallRules404": { "description": "Cloud Server does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "serverListFirewallRulesDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverUpdateFirewallRules204": { "description": "Firewall rules replaced" }, "serverUpdateFirewallRules400": { "description": "The Cloud Server UUID is invalid or the request body is malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "serverUpdateFirewallRules403": { "description": "Username does not have access to this Cloud Server or the Cloud Server is not in a state that allows firewall rules to be updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "serverUpdateFirewallRules404": { "description": "Cloud Server does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "serverUpdateFirewallRules409": { "description": "A conflicting operation is already in progress for this Cloud Server (unless /force is used) or there are duplicate firewall rule positions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "serverUpdateFirewallRulesDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverCreateFirewallRule201": { "description": "Created firewall rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverFirewallRule" } } } }, "serverCreateFirewallRule400": { "description": "The Cloud Server UUID is invalid or the request body is malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "serverCreateFirewallRule403": { "description": "Username does not have access to this Cloud Server or the Cloud Server is not in a state that allows firewall rules to be created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "serverCreateFirewallRule404": { "description": "Cloud Server does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "serverCreateFirewallRule409": { "description": "A conflicting operation is already in progress for this Cloud Server or the firewall rule position is already in use", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "serverCreateFirewallRuleDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverGetFirewallRule200": { "description": "Firewall rule details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverFirewallRule" } } } }, "serverGetFirewallRule400": { "description": "The Cloud Server UUID or rule ID is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "serverGetFirewallRule403": { "description": "Username does not have access to this Cloud Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "serverGetFirewallRule404": { "description": "Cloud Server or firewall rule does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "serverGetFirewallRuleDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverDeleteFirewallRule204": { "description": "Success" }, "serverDeleteFirewallRule400": { "description": "The Cloud Server UUID or rule ID is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "serverDeleteFirewallRule403": { "description": "Username does not have access to this Cloud Server or the Cloud Server is not in a state that allows firewall rules to be deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "serverDeleteFirewallRule404": { "description": "Cloud Server or firewall rule does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "serverDeleteFirewallRule409": { "description": "A conflicting operation is already in progress for this Cloud Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "serverDeleteFirewallRuleDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverListPrivateFirewallRulesetRelationships200": { "description": "Private firewall ruleset relationships", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverFirewallRulesetRelationships" } } } }, "serverListPrivateFirewallRulesetRelationships400": { "description": "The Cloud Server UUID is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "serverListPrivateFirewallRulesetRelationships403": { "description": "Username does not have access to this Cloud Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "serverListPrivateFirewallRulesetRelationships404": { "description": "Cloud Server does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "serverListPrivateFirewallRulesetRelationshipsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverGetRemoteAccessDetails200": { "description": "Remote access details returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverRemoteAccessDetails" } } } }, "serverGetRemoteAccessDetails400": { "description": "Invalid Cloud Server UUID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "serverGetRemoteAccessDetails403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "serverGetRemoteAccessDetails404": { "description": "Cloud Server not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "serverGetRemoteAccessDetailsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverGetCPUStats200": { "description": "CPU statistics returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverCpuStats" } } } }, "serverGetCPUStats400": { "description": "Invalid Cloud Server UUID or statistics period.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "serverGetCPUStats403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "serverGetCPUStats404": { "description": "Cloud Server not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "serverGetCPUStatsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverGetCPUStatsByPeriod200": { "description": "CPU statistics returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverCpuStats" } } } }, "serverGetCPUStatsByPeriod400": { "description": "Invalid Cloud Server UUID or statistics period.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "serverGetCPUStatsByPeriod403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "serverGetCPUStatsByPeriod404": { "description": "Cloud Server not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "serverGetCPUStatsByPeriodDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverGetDiskStats200": { "description": "Disk statistics returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverDiskStats" } } } }, "serverGetDiskStats400": { "description": "Invalid Cloud Server UUID, activity type, or statistics period.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "serverGetDiskStats403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "serverGetDiskStats404": { "description": "Cloud Server not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "serverGetDiskStatsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverGetDiskStatsByPeriod200": { "description": "Disk statistics returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverDiskStats" } } } }, "serverGetDiskStatsByPeriod400": { "description": "Invalid Cloud Server UUID, activity type, or statistics period.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "serverGetDiskStatsByPeriod403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "serverGetDiskStatsByPeriod404": { "description": "Cloud Server not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "serverGetDiskStatsByPeriodDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverGetNetworkStats200": { "description": "Network statistics returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverNetworkStats" } } } }, "serverGetNetworkStats400": { "description": "Invalid Cloud Server UUID, activity type, network type, or statistics period.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "serverGetNetworkStats403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "serverGetNetworkStats404": { "description": "Cloud Server not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "serverGetNetworkStatsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverGetNetworkStatsByNetwork200": { "description": "Network statistics returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverNetworkStats" } } } }, "serverGetNetworkStatsByNetwork400": { "description": "Invalid Cloud Server UUID, activity type, network type, or statistics period.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "serverGetNetworkStatsByNetwork403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "serverGetNetworkStatsByNetwork404": { "description": "Cloud Server not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "serverGetNetworkStatsByNetworkDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverGetNetworkStatsByNetworkAndPeriod200": { "description": "Network statistics returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverNetworkStats" } } } }, "serverGetNetworkStatsByNetworkAndPeriod400": { "description": "Invalid Cloud Server UUID, activity type, network type, or statistics period.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "serverGetNetworkStatsByNetworkAndPeriod403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "serverGetNetworkStatsByNetworkAndPeriod404": { "description": "Cloud Server not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "serverGetNetworkStatsByNetworkAndPeriodDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverAttachStorageDevice200": { "description": "Storage device attached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server" } } } }, "serverAttachStorageDevice400": { "description": "The Cloud Server UUID is invalid or the request body is malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "serverAttachStorageDevice403": { "description": "The Cloud Server or storage resource is not accessible to the authenticated account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "serverAttachStorageDevice404": { "description": "Cloud Server or storage resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "serverAttachStorageDevice409": { "description": "A conflicting operation is already in progress for this Cloud Server or the storage device is already attached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "serverAttachStorageDeviceDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverDetachStorageDevice200": { "description": "Storage device detached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server" } } } }, "serverDetachStorageDevice400": { "description": "The Cloud Server UUID is invalid or the request body is malformed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "serverDetachStorageDevice403": { "description": "The Cloud Server or attached storage resource is not accessible to the authenticated account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "serverDetachStorageDevice404": { "description": "Cloud Server does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "serverDetachStorageDevice409": { "description": "A conflicting operation is already in progress for this Cloud Server or the storage device is not attached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError409" } } } }, "serverDetachStorageDevice511": { "description": "The running Cloud Server could not hot-detach the storage device", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError511" } } } }, "serverDetachStorageDeviceDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "serverGetVNCDetails200": { "description": "VNC connection details returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverRemoteAccessDetails" } } } }, "serverGetVNCDetails400": { "description": "Invalid Cloud Server UUID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError400" } } } }, "serverGetVNCDetails403": { "description": "Access denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError403" } } } }, "serverGetVNCDetails404": { "description": "Cloud Server not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverError404" } } } }, "serverGetVNCDetailsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverError" } } } }, "listServerSizes200": { "description": "A list of server sizes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverSizes" } } } }, "listServerSizesDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverSizeError" } } } }, "getServerSizeLimits200": { "description": "Server size limits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverSizeLimits" } } } }, "getServerSizeLimitsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/serverSizeError" } } } }, "getStorageList200": { "description": "A list of storage resources", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storages" } } } }, "getStorageList400": { "description": "Invalid query parameter value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "getStorageListDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "createStorage201": { "description": "Block storage created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createStorageResponse" } } } }, "createStorageDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "getStorageListByBackup200": { "description": "A list of storage resources", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storages" } } } }, "getStorageListByBackup400": { "description": "Invalid query parameter value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "getStorageListByBackupDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "getStorageListByCdrom200": { "description": "A list of storage resources", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storages" } } } }, "getStorageListByCdrom400": { "description": "Invalid query parameter value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "getStorageListByCdromDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "getFavoriteStorageList200": { "description": "A list of favorite storage resources", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storages" } } } }, "getFavoriteStorageListDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "getStorageListByNormal200": { "description": "A list of storage resources", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storages" } } } }, "getStorageListByNormal400": { "description": "Invalid query parameter value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "getStorageListByNormalDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "getStorageListByPrivateAccess200": { "description": "A list of storage resources", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storages" } } } }, "getStorageListByPrivateAccess400": { "description": "Invalid query parameter value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "getStorageListByPrivateAccessDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "getStorageListByPublicAccess200": { "description": "A list of storage resources", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storages" } } } }, "getStorageListByPublicAccess400": { "description": "Invalid query parameter value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "getStorageListByPublicAccessDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "getStorageListByTemplate200": { "description": "A list of storage resources", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storages" } } } }, "getStorageListByTemplate400": { "description": "Invalid query parameter value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "getStorageListByTemplateDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "getStorageListByTypeAndAccess200": { "description": "A list of storage resources", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storages" } } } }, "getStorageListByTypeAndAccess400": { "description": "Invalid query parameter value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "getStorageListByTypeAndAccessDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "getStorageInfo200": { "description": "Storage resource details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage" } } } }, "getStorageInfo404": { "description": "Storage resource not found" }, "getStorageInfoDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "modifyStorage200": { "description": "Block storage modified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/modifyStorageResponse" } } } }, "modifyStorageDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "deleteStorage204": { "description": "Storage resource deleted" }, "deleteStorageDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "attachStorageToServer200": { "description": "Storage resource attached to Cloud Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachStorageResponse" } } } }, "attachStorageToServerDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "cancelStorageOperation204": { "description": "Block storage operation cancelled" }, "cancelStorageOperationDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "cloneStorage201": { "description": "Block storage cloned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createStorageResponse" } } } }, "cloneStorage404": { "description": "Storage resource not found" }, "cloneStorageDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "detachStorageFromServer200": { "description": "Storage resource detached from Cloud Server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/detachStorageResponse" } } } }, "detachStorageFromServerDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "addStorageToFavorites204": { "description": "Storage resource added to favorites" }, "addStorageToFavoritesDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "removeStorageFromFavorites204": { "description": "Storage resource removed from favorites" }, "removeStorageFromFavoritesDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "resizeStorage200": { "description": "Block storage resize started", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resizeStorageResponse" } } } }, "resizeStorageDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "restoreStorageFromBackup204": { "description": "Block storage restore started" }, "restoreStorageFromBackupDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "createTemplateFromStorage201": { "description": "Template created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createStorageTemplateResponse" } } } }, "createTemplateFromStorageDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "storageCreateOnDemandBackup201": { "description": "On-demand backup created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createStorageBackupResponse" } } } }, "storageCreateOnDemandBackupDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/storageError" } } } }, "listTags200": { "description": "A list of tags.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tags" } } } }, "listTagsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/tagError" } } } }, "createTag200": { "description": "Created tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } } }, "createTag400": { "description": "The tag name is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tagError400" } } } }, "createTag403": { "description": "Username does not have access to this tag", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tagError403" } } } }, "createTag409": { "description": "Tag already exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tagError409" } } } }, "createTagDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/tagError" } } } }, "getTag200": { "description": "Tag details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } } }, "getTag400": { "description": "The tag name is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tagError400" } } } }, "getTag403": { "description": "Username does not have access to this tag", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tagError403" } } } }, "getTag404": { "description": "Tag does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tagError404" } } } }, "getTagDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/tagError" } } } }, "modifyTag200": { "description": "Modified tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } } }, "modifyTag400": { "description": "The tag name is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tagError400" } } } }, "modifyTag403": { "description": "Username does not have access to this tag", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tagError403" } } } }, "modifyTag404": { "description": "Tag does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tagError404" } } } }, "modifyTagDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/tagError" } } } }, "deleteTag204": { "description": "Tag deleted successfully." }, "deleteTag400": { "description": "The tag name is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tagError400" } } } }, "deleteTag403": { "description": "Username does not have access to this tag", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tagError403" } } } }, "deleteTag404": { "description": "Tag does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tagError404" } } } }, "deleteTagDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/tagError" } } } }, "listTimezones200": { "description": "A list of timezones.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/timezones" } } } }, "listTimezonesDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/timezoneError" } } } }, "accountTokensCreateToken201": { "description": "Token created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountTokensToken" } } } }, "accountTokensCreateToken400": { "description": "Invalid input for token creation", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountTokensProblem400" } } } }, "accountTokensCreateToken401": { "description": "Unauthorized user for token creation", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountTokensProblem401" } } } }, "accountTokensCreateToken403": { "description": "The token used to authenticate is not allowed to create additional tokens", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountTokensProblem403" } } } }, "accountTokensCreateToken409": { "description": "A token with the same already exists", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountTokensProblem409" } } } }, "accountTokensCreateTokenDefault": { "description": "Unexpected Problem creating token", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountTokensProblem" } } } }, "accountTokensListTokens200": { "description": "A paged array of tokens", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountTokensListTokensResponse" } } } }, "accountTokensListTokens401": { "description": "Unauthorized user for listing tokens", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountTokensProblem401" } } } }, "accountTokensListTokensDefault": { "description": "Unexpected Problem listing tokens", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountTokensProblem" } } } }, "accountTokensGetToken200": { "description": "Details of the token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountTokensGetTokenResponse" } } } }, "accountTokensGetToken401": { "description": "Unauthorized user for getting token details", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountTokensProblem401" } } } }, "accountTokensGetToken404": { "description": "Token not found, or not accessible to the authorized account.\n", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountTokensProblem404" } } } }, "accountTokensGetTokenDefault": { "description": "Unexpected Problem", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountTokensProblem" } } } }, "accountTokensRevokeToken204": { "description": "Token was revoked successfully" }, "accountTokensRevokeToken401": { "description": "Unauthorized user for deleting token", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountTokensProblem401" } } } }, "accountTokensRevokeToken404": { "description": "Token not found, or not accessible to the authorized account\n", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountTokensProblem404" } } } }, "accountTokensRevokeTokenDefault": { "description": "Unexpected Problem deleting token", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/accountTokensProblem" } } } }, "createObjectStorage201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2ServiceDetailResponse" } } } }, "getObjectStorage200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2ServiceDetailResponse" } } } }, "replaceObjectStorage200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2ServiceDetailResponse" } } } }, "deleteObjectStorage204": { "description": "No Content" }, "modifyObjectStorage200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2ServiceDetailResponse" } } } }, "objectStorage2ListObjectStorages200": { "description": "OK", "headers": { "UpCloud-Total-Count": { "description": "Total count of items available", "schema": { "type": "integer", "format": "int32" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2ServiceListResponse" } } } }, "objectStorage2ListObjectStoragesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2CreateObjectStorageDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2GetObjectStorageDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ReplaceObjectStorageDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2DeleteObjectStorageDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ModifyObjectStorageDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ListObjectStorageNetworks200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2NetworkListResponse" } } } }, "objectStorage2ListObjectStorageNetworksDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2CreateObjectStorageNetwork201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2NetworkDetailResponse" } } } }, "objectStorage2CreateObjectStorageNetworkDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2GetObjectStorageNetwork200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2NetworkDetailResponse" } } } }, "objectStorage2GetObjectStorageNetworkDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2DeleteObjectStorageNetwork204": { "description": "No Content" }, "objectStorage2DeleteObjectStorageNetworkDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ListObjectStorageCustomDomains200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2CustomDomainListResponse" } } } }, "objectStorage2ListObjectStorageCustomDomainsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2AttachObjectStorageCustomDomain201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2CustomDomainDetailResponse" } } } }, "objectStorage2AttachObjectStorageCustomDomainDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2GetObjectStorageCustomDomain200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2CustomDomainDetailResponse" } } } }, "objectStorage2GetObjectStorageCustomDomainDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2DeleteObjectStorageCustomDomain204": { "description": "No Content" }, "objectStorage2DeleteObjectStorageCustomDomainDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ModifyObjectStorageCustomDomain200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2CustomDomainDetailResponse" } } } }, "objectStorage2ModifyObjectStorageCustomDomainDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ListObjectStorageRegions200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2RegionListResponse" } } } }, "objectStorage2ListObjectStorageRegionsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2GetObjectStorageRegion200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2RegionDetailResponse" } } } }, "objectStorage2GetObjectStorageRegionDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2GetObjectStorageMetrics200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2MetricsUsageResponse" } } } }, "objectStorage2GetObjectStorageMetricsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ListObjectStorageBucketMetrics200": { "description": "OK", "headers": { "UpCloud-Total-Count": { "description": "Total count of items available", "schema": { "type": "integer", "format": "int32" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2BucketListResponse" } } } }, "objectStorage2ListObjectStorageBucketMetricsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2CreateObjectStorageBucket201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2BucketDetailResponse" } } } }, "objectStorage2CreateObjectStorageBucketDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2DeleteObjectStorageBucket204": { "description": "No Content" }, "objectStorage2DeleteObjectStorageBucketDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ListObjectStorageMetricsSeries200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2MetricsSeriesListResponse" } } } }, "objectStorage2ListObjectStorageMetricsSeriesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ListObjectStorageLabels200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2LabelListResponse" } } } }, "objectStorage2ListObjectStorageLabelsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2CreateObjectStorageLabel201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2LabelDetailResponse" } } } }, "objectStorage2CreateObjectStorageLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2GetObjectStorageLabel200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2LabelDetailResponse" } } } }, "objectStorage2GetObjectStorageLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2DeleteObjectStorageLabel204": { "description": "No Content" }, "objectStorage2DeleteObjectStorageLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ModifyObjectStorageLabel200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2LabelDetailResponse" } } } }, "objectStorage2ModifyObjectStorageLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ListObjectStorageStaticWebsites200": { "description": "OK" }, "objectStorage2ListObjectStorageStaticWebsitesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2CreateObjectStorageStaticWebsite201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2StaticWebsiteConfig" } } } }, "objectStorage2CreateObjectStorageStaticWebsiteDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2GetObjectStorageStaticWebsite200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2StaticWebsiteConfig" } } } }, "objectStorage2GetObjectStorageStaticWebsiteDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2DeleteObjectStorageStaticWebsite204": { "description": "No Content" }, "objectStorage2DeleteObjectStorageStaticWebsiteDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ModifyObjectStorageStaticWebsite200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2StaticWebsiteConfig" } } } }, "objectStorage2ModifyObjectStorageStaticWebsiteDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ListObjectStorageDomains200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2ServiceDomains" } } } }, "objectStorage2ListObjectStorageDomainsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ListObjectStorageUsers200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2UserListResponse" } } } }, "objectStorage2ListObjectStorageUsersDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2CreateObjectStorageUser201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2UserDetailResponse" } } } }, "objectStorage2CreateObjectStorageUserDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2GetObjectStorageUser200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2UserDetailResponse" } } } }, "objectStorage2GetObjectStorageUserDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2DeleteObjectStorageUser204": { "description": "No Content" }, "objectStorage2DeleteObjectStorageUserDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ListObjectStorageAccessKeys200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2AccessKeyListResponse" } } } }, "objectStorage2ListObjectStorageAccessKeysDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2CreateObjectStorageAccessKey201": { "description": "Created. Note: secret_access_key is returned only on creation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2CreateAccessKeyResponse" } } } }, "objectStorage2CreateObjectStorageAccessKeyDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2GetObjectStorageAccessKeyDetails200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2AccessKeyDetailResponse" } } } }, "objectStorage2GetObjectStorageAccessKeyDetailsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2DeleteObjectStorageAccessKey204": { "description": "No Content" }, "objectStorage2DeleteObjectStorageAccessKeyDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ModifyObjectStorageAccessKeyDetails200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2AccessKeyDetailResponse" } } } }, "objectStorage2ModifyObjectStorageAccessKeyDetailsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ListObjectStorageAttachedUserPolicies200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2PolicyAttachmentListResponse" } } } }, "objectStorage2ListObjectStorageAttachedUserPoliciesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2AttachObjectStorageUserPolicy204": { "description": "No Content" }, "objectStorage2AttachObjectStorageUserPolicyDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2DetachObjectStorageUserPolicy204": { "description": "No Content" }, "objectStorage2DetachObjectStorageUserPolicyDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2GetObjectStorageUserInlinePolicy200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2InlinePolicyResponse" } } } }, "objectStorage2GetObjectStorageUserInlinePolicyDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2DeleteObjectStorageUserInlinePolicy204": { "description": "No Content" }, "objectStorage2DeleteObjectStorageUserInlinePolicyDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ListObjectStorageUserInlinePolicies200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2InlinePolicyListResponse" } } } }, "objectStorage2ListObjectStorageUserInlinePoliciesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2CreateObjectStorageUserInlinePolicy201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2InlinePolicyResponse" } } } }, "objectStorage2CreateObjectStorageUserInlinePolicyDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2GetObjectStorageUserTags200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2TagListResponse" } } } }, "objectStorage2GetObjectStorageUserTagsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ReplaceObjectStorageUserTags200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2TagListResponse" } } } }, "objectStorage2ReplaceObjectStorageUserTagsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2DeleteObjectStorageUserTag204": { "description": "No Content" }, "objectStorage2DeleteObjectStorageUserTagDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2CreateObjectStorageUserPermissionsBoundary200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2PermissionsBoundaryResponse" } } } }, "objectStorage2CreateObjectStorageUserPermissionsBoundaryDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2DeleteObjectStorageUserPermissionsBoundary204": { "description": "No Content" }, "objectStorage2DeleteObjectStorageUserPermissionsBoundaryDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ListObjectStoragePolicyVersions200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2PolicyVersionListResponse" } } } }, "objectStorage2ListObjectStoragePolicyVersionsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2CreateObjectStoragePolicyVersion201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2PolicyVersionResponse" } } } }, "objectStorage2CreateObjectStoragePolicyVersionDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2GetObjectStoragePolicyVersion200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2PolicyVersionResponse" } } } }, "objectStorage2GetObjectStoragePolicyVersionDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2DeleteObjectStoragePolicyVersion204": { "description": "No Content" }, "objectStorage2DeleteObjectStoragePolicyVersionDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2GetObjectStoragePolicy200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2PolicyDetailResponse" } } } }, "objectStorage2GetObjectStoragePolicyDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2DeleteObjectStoragePolicy204": { "description": "No Content" }, "objectStorage2DeleteObjectStoragePolicyDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2SetObjectStorageDefaultPolicyVersion200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2PolicyDetailResponse" } } } }, "objectStorage2SetObjectStorageDefaultPolicyVersionDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ListObjectStoragePolicies200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2PolicyListResponse" } } } }, "objectStorage2ListObjectStoragePoliciesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2CreateObjectStoragePolicy201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2PolicyDetailResponse" } } } }, "objectStorage2CreateObjectStoragePolicyDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ListObjectStorageIAMGroupPolicies200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2PolicyAttachmentListResponse" } } } }, "objectStorage2ListObjectStorageIAMGroupPoliciesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2AttachObjectStorageIAMGroupPolicy204": { "description": "No Content" }, "objectStorage2AttachObjectStorageIAMGroupPolicyDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2DetachObjectStorageIAMGroupPolicy204": { "description": "No Content" }, "objectStorage2DetachObjectStorageIAMGroupPolicyDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ListObjectStorageGroups200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2GroupListResponse" } } } }, "objectStorage2ListObjectStorageGroupsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2CreateObjectStorageGroup201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2GroupResponse" } } } }, "objectStorage2CreateObjectStorageGroupDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2GetObjectStorageGroup200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2GroupResponse" } } } }, "objectStorage2GetObjectStorageGroupDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2DeleteObjectStorageGroup204": { "description": "No Content" }, "objectStorage2DeleteObjectStorageGroupDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2AttachObjectStorageUserToGroup204": { "description": "No Content" }, "objectStorage2AttachObjectStorageUserToGroupDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2RemoveObjectStorageUserFromGroup204": { "description": "No Content" }, "objectStorage2RemoveObjectStorageUserFromGroupDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ListObjectStorageGroupInlinePolicies200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2InlinePolicyListResponse" } } } }, "objectStorage2ListObjectStorageGroupInlinePoliciesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2CreateObjectStorageGroupInlinePolicy201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2InlinePolicyResponse" } } } }, "objectStorage2CreateObjectStorageGroupInlinePolicyDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2GetObjectStorageGroupInlinePolicy200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2InlinePolicyResponse" } } } }, "objectStorage2GetObjectStorageGroupInlinePolicyDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2DeleteObjectStorageGroupInlinePolicy204": { "description": "No Content" }, "objectStorage2DeleteObjectStorageGroupInlinePolicyDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ListObjectStorageRoles200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2RoleListResponse" } } } }, "objectStorage2ListObjectStorageRolesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2CreateObjectStorageRole201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2RoleResponse" } } } }, "objectStorage2CreateObjectStorageRoleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2GetObjectStorageRole200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2RoleResponse" } } } }, "objectStorage2GetObjectStorageRoleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2DeleteObjectStorageRole204": { "description": "No Content" }, "objectStorage2DeleteObjectStorageRoleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2UpdateObjectStorageRole200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2RoleResponse" } } } }, "objectStorage2UpdateObjectStorageRoleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ListObjectStorageRoleInlinePolicies200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2InlinePolicyListResponse" } } } }, "objectStorage2ListObjectStorageRoleInlinePoliciesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2CreateObjectStorageRoleInlinePolicy201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2InlinePolicyResponse" } } } }, "objectStorage2CreateObjectStorageRoleInlinePolicyDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2GetObjectStorageRoleInlinePolicy200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2InlinePolicyResponse" } } } }, "objectStorage2GetObjectStorageRoleInlinePolicyDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2DeleteObjectStorageRoleInlinePolicy204": { "description": "No Content" }, "objectStorage2DeleteObjectStorageRoleInlinePolicyDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2CreateObjectStorageRolePermissionsBoundary200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2PermissionsBoundaryResponse" } } } }, "objectStorage2CreateObjectStorageRolePermissionsBoundaryDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2DeleteObjectStorageRolePermissionsBoundary204": { "description": "No Content" }, "objectStorage2DeleteObjectStorageRolePermissionsBoundaryDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2AssumeObjectStorageRolePolicy200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2AssumeRolePolicyResponse" } } } }, "objectStorage2AssumeObjectStorageRolePolicyDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ListObjectStorageAttachedRolePolicies200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2PolicyAttachmentListResponse" } } } }, "objectStorage2ListObjectStorageAttachedRolePoliciesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2AttachObjectStoragePolicyToRole204": { "description": "No Content" }, "objectStorage2AttachObjectStoragePolicyToRoleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2DetachObjectStoragePolicyFromRole204": { "description": "No Content" }, "objectStorage2DetachObjectStoragePolicyFromRoleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2GetObjectStorageRoleTags200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2TagListResponse" } } } }, "objectStorage2GetObjectStorageRoleTagsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2ReplaceObjectStorageRoleTags200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2TagListResponse" } } } }, "objectStorage2ReplaceObjectStorageRoleTagsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "objectStorage2DeleteObjectStorageRoleTag204": { "description": "No Content" }, "objectStorage2DeleteObjectStorageRoleTagDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/objectStorage2ErrorResponse" } } } }, "listFileStorages200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageServiceListResponse" } } } }, "listFileStoragesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "createFileStorage201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageServiceDetailResponse" } } } }, "createFileStorageDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "getFileStorage200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageServiceDetailResponse" } } } }, "getFileStorageDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "replaceFileStorage200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageServiceDetailResponse" } } } }, "replaceFileStorageDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "deleteFileStorage204": { "description": "No Content" }, "deleteFileStorageDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "modifyFileStorage200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageServiceDetailResponse" } } } }, "modifyFileStorageDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "listFileStorageNetworks200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageNetworkListResponse" } } } }, "listFileStorageNetworksDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "createFileStorageNetwork201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageNetworkDetailResponse" } } } }, "createFileStorageNetworkDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "getFileStorageNetwork200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageNetworkDetailResponse" } } } }, "getFileStorageNetworkDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "deleteFileStorageNetwork204": { "description": "No Content" }, "deleteFileStorageNetworkDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "modifyFileStorageNetwork200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageNetworkDetailResponse" } } } }, "modifyFileStorageNetworkDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "listFileStorageShares200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageShareListResponse" } } } }, "listFileStorageSharesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "createFileStorageShare201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageShareDetailResponse" } } } }, "createFileStorageShareDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "getFileStorageShare200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageShareDetailResponse" } } } }, "getFileStorageShareDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "deleteFileStorageShare204": { "description": "No Content" }, "deleteFileStorageShareDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "modifyFileStorageShare200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageShareDetailResponse" } } } }, "modifyFileStorageShareDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "listFileStorageAcls200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageAclListResponse" } } } }, "listFileStorageAclsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "createFileStorageAcl201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageAclDetailResponse" } } } }, "createFileStorageAclDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "getFileStorageAcl200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageAclDetailResponse" } } } }, "getFileStorageAclDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "deleteFileStorageAcl204": { "description": "No Content" }, "deleteFileStorageAclDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "modifyFileStorageAcl200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageAclDetailResponse" } } } }, "modifyFileStorageAclDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "listFileStorageLabels200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageLabelsListResponse" } } } }, "listFileStorageLabelsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "createFileStorageLabel201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageLabelDetails" } } } }, "createFileStorageLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "getFileStorageLabel200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageLabelDetails" } } } }, "getFileStorageLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "deleteFileStorageLabel204": { "description": "No Content" }, "deleteFileStorageLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "modifyFileStorageLabel200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageLabelDetails" } } } }, "modifyFileStorageLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "getFileStorageCurrentState200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageServiceDetailResponse" } } } }, "getFileStorageCurrentStateDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/fileStorageErrorResponse" } } } }, "listDatabaseTypes200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseAvailableServiceTypesResponse" } } } }, "listDatabaseTypesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "listDatabasePlans200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databasePlansResponse" } } } }, "listDatabasePlansDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabaseType200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceTypeResponse" } } } }, "getDatabaseTypeDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "listDatabases200": { "description": "OK", "headers": { "UpCloud-Total-Count": { "description": "Total count of items available", "schema": { "type": "integer", "format": "int32" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceInformationListResponse" } } } }, "listDatabasesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "createDatabase201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceInformationResponse" } } } }, "createDatabaseDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabase200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceInformationResponse" } } } }, "getDatabaseDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "deleteDatabase204": { "description": "No Content" }, "deleteDatabaseDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "modifyDatabase200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceInformationResponse" } } } }, "modifyDatabaseDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "modifyDatabaseType200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceInformationResponse" } } } }, "modifyDatabaseTypeDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "cloneDatabase201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceInformationResponse" } } } }, "cloneDatabaseDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "listDatabaseNetworks200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseNetworksInformationResponse" } } } }, "listDatabaseNetworksDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "createDatabaseNetwork201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseNetworkInformationDetailsResponse" } } } }, "createDatabaseNetworkDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabaseNetwork200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseNetworkInformationDetailsResponse" } } } }, "getDatabaseNetworkDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "deleteDatabaseNetwork204": { "description": "No Content" }, "deleteDatabaseNetworkDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "upgradeDatabase201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceInformationResponse" } } } }, "upgradeDatabaseDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "listDatabaseLabels200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseLabelsResponse" } } } }, "listDatabaseLabelsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "createDatabaseLabel201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseLabelResponse" } } } }, "createDatabaseLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabaseLabel200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseLabelResponse" } } } }, "getDatabaseLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "deleteDatabaseLabel204": { "description": "No Content" }, "deleteDatabaseLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "modifyDatabaseLabel200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseLabelResponse" } } } }, "modifyDatabaseLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabaseAvailableExtensions200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseAvailableExtensionsResponse" } } } }, "getDatabaseAvailableExtensionsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabaseTypeVersions200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseVersionsResponse" } } } }, "getDatabaseTypeVersionsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabaseAccessControl200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseAccessControlSettingsResponse" } } } }, "getDatabaseAccessControlDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "modifyDatabaseAccessControl200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseAccessControlSettingsResponse" } } } }, "modifyDatabaseAccessControlDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabaseSecurity200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseOpenSearchSecurityPluginStatusResponse" } } } }, "getDatabaseSecurityDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "modifyDatabaseSecurityAdmin200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseOpenSearchSecurityPluginStatusResponse" } } } }, "modifyDatabaseSecurityAdminDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "enableDatabaseSecurityAdmin201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseOpenSearchSecurityPluginStatusResponse" } } } }, "enableDatabaseSecurityAdminDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "listDatabaseIntegrationEndpoints200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseIntegrationEndpointsResponse" } } } }, "listDatabaseIntegrationEndpointsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "createDatabaseIntegrationEndpoint201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseIntegrationEndpointResponse" } } } }, "createDatabaseIntegrationEndpointDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabaseIntegrationEndpoint200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseIntegrationEndpointResponse" } } } }, "getDatabaseIntegrationEndpointDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "deleteDatabaseIntegrationEndpoint204": { "description": "No Content" }, "deleteDatabaseIntegrationEndpointDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "modifyDatabaseIntegrationEndpoint200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseIntegrationEndpointResponse" } } } }, "modifyDatabaseIntegrationEndpointDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabaseAccountCA200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseAccountCaResponse" } } } }, "getDatabaseAccountCADefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "listDatabaseAlerts200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseProjectAlertsResponse" } } } }, "listDatabaseAlertsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabaseStatus200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceStatusResponse" } } } }, "getDatabaseStatusDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabaseVersions200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceVersionsResponse" } } } }, "getDatabaseVersionsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "startDatabaseManualMaintenance200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseUpCloudApiResponse" } } } }, "startDatabaseManualMaintenanceDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "enableDatabaseTemporaryWrites201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseUpCloudApiResponse" } } } }, "enableDatabaseTemporaryWritesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabaseMigrationStatus200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceMigrationStatusResponse" } } } }, "getDatabaseMigrationStatusDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabaseAlerts200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceAlertsResponse" } } } }, "getDatabaseAlertsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabaseMetrics200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseMetricsResponse" } } } }, "getDatabaseMetricsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabaseQueryStatistics200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseQueryStatisticsResponse" } } } }, "getDatabaseQueryStatisticsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabaseLogs200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseLogListResponse" } } } }, "getDatabaseLogsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "listDatabaseConnectionPools200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseConnectionPoolsResponse" } } } }, "listDatabaseConnectionPoolsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "createDatabaseConnectionPool201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseConnectionPoolResponse" } } } }, "createDatabaseConnectionPoolDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabaseConnectionPool200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseConnectionPoolResponse" } } } }, "getDatabaseConnectionPoolDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "deleteDatabaseConnectionPool204": { "description": "No Content" }, "deleteDatabaseConnectionPoolDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "modifyDatabaseConnectionPool200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseConnectionPoolResponse" } } } }, "modifyDatabaseConnectionPoolDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "listDatabaseIndices200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseIndexesResponse" } } } }, "listDatabaseIndicesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "deleteDatabaseIndex204": { "description": "No Content" }, "deleteDatabaseIndexDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "listDatabaseIntegrations200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceIntegrationsResponse" } } } }, "listDatabaseIntegrationsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "createDatabaseIntegration201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceIntegrationResponse" } } } }, "createDatabaseIntegrationDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabaseIntegration200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceIntegrationResponse" } } } }, "getDatabaseIntegrationDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "deleteDatabaseIntegration204": { "description": "No Content" }, "deleteDatabaseIntegrationDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "modifyDatabaseIntegration200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceIntegrationResponse" } } } }, "modifyDatabaseIntegrationDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "listDatabaseLogicalDatabases200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogicalDatabasesResponse" } } } }, "listDatabaseLogicalDatabasesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "createDatabaseLogicalDatabase201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogicalDatabaseResponse" } } } }, "createDatabaseLogicalDatabaseDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "deleteDatabaseLogicalDatabase204": { "description": "No Content" }, "deleteDatabaseLogicalDatabaseDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabasePeeringsStatus200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceNetworkDetailsResponse" } } } }, "getDatabasePeeringsStatusDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabaseSessions200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseCurrentSessionsResponse" } } } }, "getDatabaseSessionsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "terminateDatabaseSession204": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseTerminateSessionResponse" } } } }, "terminateDatabaseSessionDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "createDatabaseTask201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceTaskResponse" } } } }, "createDatabaseTaskDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabaseTask200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceTaskDetailsResponse" } } } }, "getDatabaseTaskDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "listDatabaseUsers200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseUsersResponse" } } } }, "listDatabaseUsersDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "createDatabaseUser201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseUserResponse" } } } }, "createDatabaseUserDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "getDatabaseUser200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseUserResponse" } } } }, "getDatabaseUserDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "deleteDatabaseUser204": { "description": "No Content" }, "deleteDatabaseUserDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "modifyDatabaseUser200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseUserResponse" } } } }, "modifyDatabaseUserDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "modifyDatabaseUserAccessControl200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseUserResponse" } } } }, "modifyDatabaseUserAccessControlDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "databaseGetPGAvailableExtensions200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databasePGAvailableExtensionsResponse" } } } }, "databaseGetPGAvailableExtensionsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/databaseErrorResponse" } } } }, "listGatewayPlans200": { "description": "OK", "headers": { "UpCloud-Total-Count": { "description": "Total count of items available", "schema": { "type": "integer", "format": "int32" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayPlanListResponse" } } } }, "listGatewayPlansDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "getGatewayPlan200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayPlanDetailsResponse" } } } }, "getGatewayPlanDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "listGatewayServices200": { "description": "OK", "headers": { "UpCloud-Total-Count": { "description": "Total count of items available", "schema": { "type": "integer", "format": "int32" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayServiceListResponse" } } } }, "listGatewayServicesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "createGatewayService200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayServiceDetailsResponse" } } } }, "createGatewayServiceDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "getGatewayService200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayServiceDetailsResponse" } } } }, "getGatewayServiceDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "replaceGatewayService200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayServiceDetailsResponse" } } } }, "replaceGatewayServiceDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "deleteGatewayService204": { "description": "No Content" }, "deleteGatewayServiceDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "modifyGatewayService200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayServiceDetailsResponse" } } } }, "modifyGatewayServiceDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "flushGatewayNat200": { "description": "No Content" }, "flushGatewayNatDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "listGatewayConnections200": { "description": "OK", "headers": { "UpCloud-Total-Count": { "description": "Total count of items available", "schema": { "type": "integer", "format": "int32" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayConnectionListResponse" } } } }, "listGatewayConnectionsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "createGatewayConnection200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayConnectionDetailsResponse" } } } }, "createGatewayConnectionDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "getGatewayConnection200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayConnectionDetailsResponse" } } } }, "getGatewayConnectionDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "deleteGatewayConnection204": { "description": "No Content" }, "deleteGatewayConnectionDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "modifyGatewayConnection200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayConnectionDetailsResponse" } } } }, "modifyGatewayConnectionDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "listGatewayTunnels200": { "description": "OK", "headers": { "UpCloud-Total-Count": { "description": "Total count of items available", "schema": { "type": "integer", "format": "int32" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayTunnelListResponse" } } } }, "listGatewayTunnelsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "createGatewayTunnel200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayTunnelDetailsResponse" } } } }, "createGatewayTunnelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "getGatewayTunnel200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayTunnelDetailsResponse" } } } }, "getGatewayTunnelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "deleteGatewayTunnel204": { "description": "No Content" }, "deleteGatewayTunnelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "modifyGatewayTunnel200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayTunnelDetailsResponse" } } } }, "modifyGatewayTunnelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "listGatewayServiceLabels200": { "description": "OK", "headers": { "UpCloud-Total-Count": { "description": "Total count of items available", "schema": { "type": "integer", "format": "int32" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayServiceLabelListResponse" } } } }, "listGatewayServiceLabelsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "createGatewayServiceLabel201": { "description": "Created" }, "createGatewayServiceLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "getGatewayServiceLabel200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayLabelDetailsResponse" } } } }, "getGatewayServiceLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "deleteGatewayServiceLabel204": { "description": "No Content" }, "deleteGatewayServiceLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "modifyGatewayServiceLabel200": { "description": "OK" }, "modifyGatewayServiceLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "listGatewayAddresses200": { "description": "OK", "headers": { "UpCloud-Total-Count": { "description": "Total count of items available", "schema": { "type": "integer", "format": "int32" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayAddressListResponse" } } } }, "listGatewayAddressesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "getGatewayAddress200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayAddressDetailsResponse" } } } }, "getGatewayAddressDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "modifyGatewayAddress200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayAddressDetailsResponse" } } } }, "modifyGatewayAddressDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "releaseGatewayFloatingIp202": { "description": "Accepted" }, "releaseGatewayFloatingIpDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "getGatewayMetrics200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayServiceMetricsResponse" } } } }, "getGatewayMetricsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "createGatewayServiceLogSession200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayServiceLogSessionCreateResponse" } } } }, "createGatewayServiceLogSessionDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/gatewayErrorResponse" } } } }, "listLoadBalancers200": { "description": "Created", "headers": { "UpCloud-Total-Count": { "description": "Total count of items available", "schema": { "type": "integer", "format": "int32" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerServicesResponse" } } } }, "listLoadBalancersDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "createLoadBalancer201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerService" } } } }, "createLoadBalancerDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "getLoadBalancer200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerService" } } } }, "getLoadBalancerDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "replaceLoadBalancer200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerService" } } } }, "replaceLoadBalancerDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "deleteLoadBalancer204": { "description": "No Content" }, "deleteLoadBalancerDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "modifyLoadBalancer200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerService" } } } }, "modifyLoadBalancerDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "listLoadBalancerFrontends200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerFrontendsResponse" } } } }, "listLoadBalancerFrontendsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "createLoadBalancerFrontend201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerFrontend" } } } }, "createLoadBalancerFrontendDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "getLoadBalancerFrontend200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerFrontend" } } } }, "getLoadBalancerFrontendDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "deleteLoadBalancerFrontend204": { "description": "No Content" }, "deleteLoadBalancerFrontendDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "modifyLoadBalancerFrontend200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerFrontend" } } } }, "modifyLoadBalancerFrontendDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "listLoadBalancerFrontendTlsConfigs200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerFrontendTlsConfigsResponse" } } } }, "listLoadBalancerFrontendTlsConfigsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "createLoadBalancerFrontendTlsConfig201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerTlsConfig" } } } }, "createLoadBalancerFrontendTlsConfigDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "getLoadBalancerFrontendTlsConfig200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerTlsConfig" } } } }, "getLoadBalancerFrontendTlsConfigDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "deleteLoadBalancerFrontendTlsConfig204": { "description": "No Content" }, "deleteLoadBalancerFrontendTlsConfigDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "modifyLoadBalancerFrontendTlsConfig200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerTlsConfig" } } } }, "modifyLoadBalancerFrontendTlsConfigDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "listLoadBalancerRules200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerRulesResponse" } } } }, "listLoadBalancerRulesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "createLoadBalancerRule201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerRule" } } } }, "createLoadBalancerRuleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "getLoadBalancerRule200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerRule" } } } }, "getLoadBalancerRuleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "replaceLoadBalancerRule200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerRule" } } } }, "replaceLoadBalancerRuleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "deleteLoadBalancerRule204": { "description": "No Content" }, "deleteLoadBalancerRuleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "modifyLoadBalancerRule200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerRule" } } } }, "modifyLoadBalancerRuleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "listLoadBalancerBackends200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerBackendsResponse" } } } }, "listLoadBalancerBackendsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "createLoadBalancerBackend201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerBackend" } } } }, "createLoadBalancerBackendDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "getLoadBalancerBackend200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerBackend" } } } }, "getLoadBalancerBackendDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "deleteLoadBalancerBackend204": { "description": "No Content" }, "deleteLoadBalancerBackendDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "modifyLoadBalancerBackend200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerBackend" } } } }, "modifyLoadBalancerBackendDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "listLoadBalancerMembers200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerMembersResponse" } } } }, "listLoadBalancerMembersDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "createLoadBalancerMember201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerMember" } } } }, "createLoadBalancerMemberDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "getLoadBalancerMember200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerMember" } } } }, "getLoadBalancerMemberDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "deleteLoadBalancerMember204": { "description": "No Content" }, "deleteLoadBalancerMemberDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "modifyLoadBalancerMember200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerMember" } } } }, "modifyLoadBalancerMemberDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "listLoadBalancerBackendTlsConfigs200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerTlsConfigsResponse" } } } }, "listLoadBalancerBackendTlsConfigsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "createLoadBalancerBackendTlsConfig201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerTlsConfig" } } } }, "createLoadBalancerBackendTlsConfigDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "getLoadBalancerBackendTlsConfig200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerTlsConfig" } } } }, "getLoadBalancerBackendTlsConfigDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "deleteLoadBalancerBackendTlsConfig204": { "description": "No Content" }, "deleteLoadBalancerBackendTlsConfigDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "modifyLoadBalancerBackendTlsConfig200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerTlsConfig" } } } }, "modifyLoadBalancerBackendTlsConfigDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "modifyLoadBalancerNetwork200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerNetwork" } } } }, "modifyLoadBalancerNetworkDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "listLoadBalancerIpAddresses200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerIpAddressesResponse" } } } }, "listLoadBalancerIpAddressesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "createLoadBalancerIpAddress201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerIpAddress" } } } }, "createLoadBalancerIpAddressDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "getLoadBalancerIpAddress200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerIpAddressesResponse" } } } }, "getLoadBalancerIpAddressDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "deleteLoadBalancerIpAddress204": { "description": "No Content" }, "deleteLoadBalancerIpAddressDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "listLoadBalancerResolvers200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerResolversResponse" } } } }, "listLoadBalancerResolversDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "createLoadBalancerResolver201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerResolver" } } } }, "createLoadBalancerResolverDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "getLoadBalancerResolver200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerResolver" } } } }, "getLoadBalancerResolverDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "deleteLoadBalancerResolver204": { "description": "No Content" }, "deleteLoadBalancerResolverDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "modifyLoadBalancerResolver200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerResolver" } } } }, "modifyLoadBalancerResolverDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "listLoadBalancerLabels200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerServiceLabelsResponse" } } } }, "listLoadBalancerLabelsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "createLoadBalancerLabel201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerLabelResponse" } } } }, "createLoadBalancerLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "getLoadBalancerLabel200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerLabelResponse" } } } }, "getLoadBalancerLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "deleteLoadBalancerLabel204": { "description": "No Content" }, "deleteLoadBalancerLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "modifyLoadBalancerLabel200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerLabelResponse" } } } }, "modifyLoadBalancerLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "getLoadBalancerMetrics200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerMetrics" } } } }, "getLoadBalancerMetricsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "getLoadBalancerMetricsSeries200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerMetricsSeriesResponse" } } } }, "getLoadBalancerMetricsSeriesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "getLoadBalancerFrontendCombinedMetricsSeries200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerFrontendMetricsSeriesResponse" } } } }, "getLoadBalancerFrontendCombinedMetricsSeriesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "getLoadBalancerFrontendMetricsSeries200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerFrontendMetricsSeriesResponse" } } } }, "getLoadBalancerFrontendMetricsSeriesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "getLoadBalancerBackendCombinedMetricsSeries200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerBackendMetricsSeriesResponse" } } } }, "getLoadBalancerBackendCombinedMetricsSeriesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "getLoadBalancerBackendMetricsSeries200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerBackendMetricsSeriesResponse" } } } }, "getLoadBalancerBackendMetricsSeriesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "getLoadBalancerMemberCombinedMetricsSeries200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerMemberMetricsSeriesResponse" } } } }, "getLoadBalancerMemberCombinedMetricsSeriesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "getLoadBalancerMemberMetricsSeries200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerMemberMetricsSeriesResponse" } } } }, "getLoadBalancerMemberMetricsSeriesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "listLoadBalancerCertificateBundles200": { "description": "Created", "headers": { "UpCloud-Total-Count": { "description": "Total count of items available", "schema": { "type": "integer", "format": "int32" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerCertificatesBundleResponse" } } } }, "listLoadBalancerCertificateBundlesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "createLoadBalancerCertificateBundle201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerCertificateBundle" } } } }, "createLoadBalancerCertificateBundleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "getLoadBalancerCertificateBundle200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerCertificateBundle" } } } }, "getLoadBalancerCertificateBundleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "deleteLoadBalancerCertificateBundle204": { "description": "No Content" }, "deleteLoadBalancerCertificateBundleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "modifyLoadBalancerCertificateBundle200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerCertificateBundle" } } } }, "modifyLoadBalancerCertificateBundleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "listLoadBalancerCertificateBundleLabels200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerCertificateBundleLabelsResponse" } } } }, "listLoadBalancerCertificateBundleLabelsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "createLoadBalancerCertificateBundleLabel201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerLabelResponse" } } } }, "createLoadBalancerCertificateBundleLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "getLoadBalancerCertificateBundleLabel200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerLabelResponse" } } } }, "getLoadBalancerCertificateBundleLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "deleteLoadBalancerCertificateBundleLabel204": { "description": "No Content" }, "deleteLoadBalancerCertificateBundleLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "modifyLoadBalancerCertificateBundleLabel200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerLabelResponse" } } } }, "modifyLoadBalancerCertificateBundleLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "getLoadBalancerDnsChallengeDomain200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerDnsChallengeDomainResponse" } } } }, "getLoadBalancerDnsChallengeDomainDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "listLoadBalancerPlans200": { "description": "Created", "headers": { "UpCloud-Total-Count": { "description": "Total count of items available", "schema": { "type": "integer", "format": "int32" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerPlansResponse" } } } }, "listLoadBalancerPlansDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "getLoadBalancerPlan200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerPlan" } } } }, "getLoadBalancerPlanDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/loadBalancerErrorResponse" } } } }, "listFirewallRulesets200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetListResponse" } } } }, "listFirewallRulesetsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "createFirewallRuleset201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetDetailResponse" } } } }, "createFirewallRulesetDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "getFirewallRuleset200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetDetailResponse" } } } }, "getFirewallRulesetDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "deleteFirewallRuleset204": { "description": "No Content" }, "deleteFirewallRulesetDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "modifyFirewallRuleset200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetDetailResponse" } } } }, "modifyFirewallRulesetDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "restoreFirewallRuleset200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetDetailResponse" } } } }, "restoreFirewallRulesetDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "listFirewallRulesetRules200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetFirewallRuleListResponse" } } } }, "listFirewallRulesetRulesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "createMultipleFirewallRulesetRule200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetFirewallRuleListResponse" } } } }, "createMultipleFirewallRulesetRuleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "createFirewallRulesetRule201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetRuleDetailResponse" } } } }, "createFirewallRulesetRuleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "getFirewallRulesetRule200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetRuleDetailResponse" } } } }, "getFirewallRulesetRuleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "deleteFirewallRulesetRule204": { "description": "No Content" }, "deleteFirewallRulesetRuleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "modifyFirewallRulesetRule200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetRuleDetailResponse" } } } }, "modifyFirewallRulesetRuleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "listFirewallRulesetLabels200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetLabelListResponse" } } } }, "listFirewallRulesetLabelsDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "createFirewallRulesetLabel201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetLabelDetailResponse" } } } }, "createFirewallRulesetLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "listFirewallRulesetAttachedServers200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetLabelListResponse" } } } }, "listFirewallRulesetAttachedServersDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "getFirewallRulesetLabel200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetLabelDetailResponse" } } } }, "getFirewallRulesetLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "deleteFirewallRulesetLabel204": { "description": "No Content" }, "deleteFirewallRulesetLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "modifyFirewallRulesetLabel200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetLabelDetailResponse" } } } }, "modifyFirewallRulesetLabelDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "firewallRulesetListServerFirewallRule200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetServerFirewallDetailResponse" } } } }, "firewallRulesetListServerFirewallRuleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "firewallRulesetCreateMultipleServerFirewallRules200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetServerFirewallDetailResponse" } } } }, "firewallRulesetCreateMultipleServerFirewallRules400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorLegacyResponse" } } } }, "firewallRulesetCreateMultipleServerFirewallRules403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorLegacyResponse" } } } }, "firewallRulesetCreateMultipleServerFirewallRules404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorLegacyResponse" } } } }, "firewallRulesetCreateMultipleServerFirewallRules409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorLegacyResponse" } } } }, "firewallRulesetCreateMultipleServerFirewallRulesDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "firewallRulesetCreateServerFirewallRule201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetServerFirewallRuleDetail" } } } }, "firewallRulesetCreateServerFirewallRule400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorLegacyResponse" } } } }, "firewallRulesetCreateServerFirewallRule403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorLegacyResponse" } } } }, "firewallRulesetCreateServerFirewallRule404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorLegacyResponse" } } } }, "firewallRulesetCreateServerFirewallRule409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorLegacyResponse" } } } }, "firewallRulesetCreateServerFirewallRuleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "firewallRulesetGetServerFirewallRule200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetServerFirewallRuleDetail" } } } }, "firewallRulesetGetServerFirewallRuleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "firewallRulesetDeleteServerFirewallRule204": { "description": "No Content" }, "firewallRulesetDeleteServerFirewallRule400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorLegacyResponse" } } } }, "firewallRulesetDeleteServerFirewallRule403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorLegacyResponse" } } } }, "firewallRulesetDeleteServerFirewallRule404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorLegacyResponse" } } } }, "firewallRulesetDeleteServerFirewallRule409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorLegacyResponse" } } } }, "firewallRulesetDeleteServerFirewallRuleDefault": { "description": "Unexpected error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/firewallRulesetErrorResponse" } } } }, "listVNCKeymaps200": { "description": "A list of VNC keymaps.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vncKeymapKeymaps" } } } }, "listVNCKeymapsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/vncKeymapError" } } } }, "listZones200": { "description": "A list of zones.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zones" } } } }, "listZonesDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/zoneError" } } } }, "listZoneVLANs200": { "description": "A list of zones.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zoneVlans" } } } }, "listZoneVLANsDefault": { "description": "General failure", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/zoneError" } } } } }, "parameters": { "listAccountsLabel": { "name": "label", "in": "query", "description": "Filter by label key or key-value pair. Repeat the parameter to require all labels. Label keys are matched case-insensitively.", "required": false, "schema": { "type": "string" } }, "getAccountNetworkTopUsageFrom": { "name": "from", "in": "query", "description": "Start of the usage period.", "required": true, "schema": { "$ref": "#/components/schemas/accountRfc3339Datetime" } }, "getAccountNetworkTopUsageTo": { "name": "to", "in": "query", "description": "End of the usage period.", "required": true, "schema": { "$ref": "#/components/schemas/accountRfc3339Datetime" } }, "getAccountNetworkTopUsageService": { "name": "service", "in": "query", "description": "Filter by service type. Repeat the parameter to include multiple service types.", "required": false, "schema": { "$ref": "#/components/schemas/accountResourceNetworkUsageType" } }, "getAccountNetworkTopUsageZone": { "name": "zone", "in": "query", "description": "Filter by zone. Repeat the parameter to include multiple zones.", "required": false, "schema": { "$ref": "#/components/schemas/accountZone" } }, "getAccountNetworkTopUsageAccumulate": { "name": "accumulate", "in": "query", "description": "Accumulation period for the usage statistics.", "required": false, "schema": { "$ref": "#/components/schemas/accountUsageAccumulateParameter" } }, "getAccountNetworkUsageFrom": { "name": "from", "in": "query", "description": "First measurement timestamp in RFC 3339 format.", "required": true, "schema": { "$ref": "#/components/schemas/accountRfc3339Datetime" } }, "getAccountNetworkUsageTo": { "name": "to", "in": "query", "description": "Last measurement timestamp in RFC 3339 format.", "required": true, "schema": { "$ref": "#/components/schemas/accountRfc3339Datetime" } }, "getAccountNetworkUsageAccumulate": { "name": "accumulate", "in": "query", "description": "Accumulate the transfer statistics by hour or day.", "required": false, "schema": { "$ref": "#/components/schemas/accountUsageAccumulateParameter" } }, "getAccountResourceNetworkUsageFrom": { "name": "from", "in": "query", "description": "Data start timestamp in RFC 3339 format.", "required": true, "schema": { "$ref": "#/components/schemas/accountRfc3339Datetime" } }, "getAccountResourceNetworkUsageTo": { "name": "to", "in": "query", "description": "Data end timestamp in RFC 3339 format.", "required": true, "schema": { "$ref": "#/components/schemas/accountRfc3339Datetime" } }, "getAccountResourceNetworkUsageService": { "name": "service", "in": "query", "description": "Limit results to a service type. Repeat the parameter to include multiple service types.", "required": false, "schema": { "$ref": "#/components/schemas/accountResourceNetworkUsageType" } }, "getAccountResourceNetworkUsageResourceId": { "name": "resource_id", "in": "query", "description": "Limit results to this resource UUID.", "required": false, "schema": { "$ref": "#/components/schemas/accountUuid" } }, "getAccountResourceNetworkUsageZone": { "name": "zone", "in": "query", "description": "Limit results to a zone. Repeat the parameter to include multiple zones.", "required": false, "schema": { "$ref": "#/components/schemas/accountZone" } }, "getAccountResourceNetworkUsageAccumulate": { "name": "accumulate", "in": "query", "description": "Accumulate the transfer statistics by hour or day.", "required": false, "schema": { "$ref": "#/components/schemas/accountUsageAccumulateParameter" } }, "deleteSubaccountUsername": { "name": "username", "in": "path", "description": "Subaccount username.", "required": true, "schema": { "$ref": "#/components/schemas/accountUserName" } }, "accountGetMonthlyDetailedBillingSummaryYear": { "name": "year", "in": "path", "description": "Billing year.", "required": true, "schema": { "type": "string", "pattern": "^20\\d{2}$" } }, "accountGetMonthlyDetailedBillingSummaryMonth": { "name": "month", "in": "path", "description": "Billing month.", "required": true, "schema": { "type": "string", "pattern": "^(0[1-9]|1[0-2])$" } }, "accountGetMonthlyDetailedBillingSummaryUsername": { "name": "username", "in": "query", "description": "Return the billing summary for this account instead of the calling account. Requires Partner API access and an existing association with the account.", "required": false, "schema": { "$ref": "#/components/schemas/accountUserName" } }, "accountGetMonthlyDetailedBillingSummaryResourceId": { "name": "resource_id", "in": "query", "description": "Return details only for this resource UUID or IP address.", "required": false, "schema": { "type": "string", "maxLength": 128 } }, "accountGetMonthlyBillingSummaryYear": { "name": "year", "in": "path", "description": "Billing year.", "required": true, "schema": { "type": "string", "pattern": "^20\\d{2}$" } }, "accountGetMonthlyBillingSummaryMonth": { "name": "month", "in": "path", "description": "Billing month.", "required": true, "schema": { "type": "string", "pattern": "^(0[1-9]|1[0-2])$" } }, "accountGetMonthlyResourceBillingSummaryResourceId": { "name": "resource_id", "in": "path", "description": "Server UUID, storage UUID, or IP address.", "required": true, "schema": { "type": "string" } }, "accountGetMonthlyResourceBillingSummaryYear": { "name": "year", "in": "path", "description": "Billing year.", "required": true, "schema": { "type": "string", "pattern": "^20\\d{2}$" } }, "accountGetMonthlyResourceBillingSummaryMonth": { "name": "month", "in": "path", "description": "Billing month.", "required": true, "schema": { "type": "string", "pattern": "^(0[1-9]|1[0-2])$" } }, "getKubernetesClusterOIDCKubeconfigAudience": { "name": "audience", "in": "query", "description": "Which of the issuer's configured audiences to use as the OIDC client id in the generated kubeconfig. When omitted, the issuer's first audience is used. Must match one of the issuer's audiences.\n", "required": false, "schema": { "type": "string" } }, "kubernetesUuid": { "name": "uuid", "in": "path", "description": "UUID", "required": true, "schema": { "$ref": "#/components/schemas/kubernetesUuid" } }, "kubernetesName": { "name": "name", "in": "path", "description": "Name", "required": true, "schema": { "$ref": "#/components/schemas/kubernetesName" } }, "kubernetesNodeName": { "name": "node-name", "in": "path", "description": "Node name", "required": true, "schema": { "$ref": "#/components/schemas/kubernetesNodeName" } }, "getAvailablePassthroughDevicesZone": { "name": "zone", "in": "query", "description": "Filter results to a specific zone.", "required": false, "schema": { "type": "string" } }, "getAvailablePassthroughDevicesType": { "name": "type", "in": "query", "description": "Filter results to a specific device type. The only valid type is \"gpu\" for now.", "required": false, "schema": { "type": "string", "enum": [ "gpu" ] } }, "listEventsServerUuid": { "name": "server_uuid", "in": "path", "description": "Filter results to a specific server.", "required": true, "schema": { "type": "string", "format": "uuid" } }, "listEventsOffset": { "name": "offset", "in": "path", "description": "The number of items to skip before starting to collect the result set. Default is 0.", "required": true, "schema": { "type": "integer", "minimum": 0 } }, "listEventsCount": { "name": "count", "in": "path", "description": "The numbers of items to return.", "required": true, "schema": { "type": "integer", "maximum": 10000, "minimum": 1 } }, "getIPAddressDetailsAddress": { "name": "address", "in": "path", "description": "The IP address to retrieve details for.", "required": true, "schema": { "type": "string", "format": "ipv4" } }, "modifyIPAddressAddress": { "name": "address", "in": "path", "description": "The IP address to modify.", "required": true, "schema": { "$ref": "#/components/schemas/ipAddress" } }, "deleteIPAddressAddress": { "name": "address", "in": "path", "description": "The IP address to delete.", "required": true, "schema": { "$ref": "#/components/schemas/ipAddress" } }, "patchModifyIPAddressAddress": { "name": "address", "in": "path", "description": "The IP address to modify.", "required": true, "schema": { "type": "string", "format": "ipv4" } }, "listNetworkPeeringsUuid": { "name": "uuid", "in": "query", "description": "Filter by network peering UUID.", "required": false, "schema": { "$ref": "#/components/schemas/networkPeeringUuid" } }, "listNetworkPeeringsNetworkUuidLocal": { "name": "network_uuid_local", "in": "query", "description": "Filter by local network uuid.", "required": false, "schema": { "$ref": "#/components/schemas/networkPeeringUuid" } }, "listNetworkPeeringsNetworkUuidPeer": { "name": "network_uuid_peer", "in": "query", "description": "Filter by peer network uuid.", "required": false, "schema": { "$ref": "#/components/schemas/networkPeeringUuid" } }, "listNetworkPeeringsLabel": { "name": "label", "in": "query", "description": "Label filter in the form key=value. Can be specified multiple times to filter by multiple labels.", "required": false, "schema": { "type": "string" } }, "getNetworkPeeringPeeringUuid": { "name": "peering_uuid", "in": "path", "description": "The network peering identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, "deleteNetworkPeeringPeeringUuid": { "name": "peering_uuid", "in": "path", "description": "The network peering identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, "modifyNetworkPeeringPeeringUuid": { "name": "peering_uuid", "in": "path", "description": "The network peering identifier.", "required": true, "schema": { "type": "string", "format": "uuid" } }, "listNetworksLabel": { "name": "label", "in": "query", "description": "Filter networks by labels.", "required": false, "schema": { "$ref": "#/components/schemas/networkLabel" } }, "getNetworkInterfaceDetailsUuid": { "name": "uuid", "in": "path", "description": "UUID of the network interface.", "required": true, "schema": { "$ref": "#/components/schemas/networkUuid" } }, "deleteNetworkInterfaceUuid": { "name": "uuid", "in": "path", "description": "UUID of the network.", "required": true, "schema": { "$ref": "#/components/schemas/networkUuid" } }, "getNetworkDetailsUuid": { "name": "uuid", "in": "path", "description": "UUID of the network.", "required": true, "schema": { "$ref": "#/components/schemas/networkUuid" } }, "modifyNetworkUuid": { "name": "uuid", "in": "path", "description": "UUID of the network.", "required": true, "schema": { "$ref": "#/components/schemas/networkUuid" } }, "deleteNetworkUuid": { "name": "uuid", "in": "path", "description": "UUID of the network.", "required": true, "schema": { "$ref": "#/components/schemas/networkUuid" } }, "listAuditLogsQ": { "name": "q", "in": "query", "description": "Filter audit logs using a keyword such as account username, resource ID or IP address.", "required": false, "schema": { "$ref": "#/components/schemas/auditLogsQueryParameter" } }, "listAuditLogsLimit": { "name": "limit", "in": "query", "description": "Number of results to return (max 100, default 50)", "required": false, "schema": { "$ref": "#/components/schemas/auditLogsLimitParameter" } }, "listAuditLogsOffset": { "name": "offset", "in": "query", "description": "Offset for retrieved results. (default 0)", "required": false, "schema": { "$ref": "#/components/schemas/auditLogsOffsetParameter" } }, "listAuditLogsActions": { "name": "actions", "in": "query", "description": "List of actions to filter by", "required": false, "schema": { "$ref": "#/components/schemas/auditLogsActionsParameter" } }, "listAuditLogsOrigins": { "name": "origins", "in": "query", "description": "List of origins to filter by", "required": false, "schema": { "$ref": "#/components/schemas/auditLogsOriginsParameter" } }, "listAuditLogsResourceTypes": { "name": "resource_types", "in": "query", "description": "List of resource types to filter by", "required": false, "schema": { "$ref": "#/components/schemas/auditLogsResourceTypesParameter" } }, "listAuditLogsCreatedAfter": { "name": "created_after", "in": "query", "description": "List audit logs created after the given timestamp (including the time of timestamp). Format: ISO timestamp eg. 2024-01-01T23:45:56Z", "required": false, "schema": { "$ref": "#/components/schemas/auditLogsCreatedAfterParameter" } }, "listAuditLogsCreatedBefore": { "name": "created_before", "in": "query", "description": "List audit logs created before the given timestamp (including the time of timestamp). Format: ISO timestamp eg. 2024-01-01T23:45:56Z", "required": false, "schema": { "$ref": "#/components/schemas/auditLogsCreatedBeforeParameter" } }, "exportAuditLogsFormat": { "name": "format", "in": "query", "description": "Export format: 'csv' or 'json' (default: csv)", "required": false, "schema": { "$ref": "#/components/schemas/auditLogsFormatParameter" } }, "auditLogsGetAuditLogCloudEventID": { "name": "cloudEventID", "in": "path", "description": "Cloud event ID (ULID format)", "required": true, "schema": { "$ref": "#/components/schemas/auditLogsCloudEventIDParameter" } }, "grantPermissionSkipTargetCheck": { "name": "skip_target_check", "in": "query", "description": "If true, skips the check whether the target resource exists. Default is false.", "required": false, "schema": { "type": "boolean" } }, "revokeAllPermissionsByTargetTargetType": { "name": "target_type", "in": "path", "description": "The type of the target resource (e.g., \"server\", \"storage\").", "required": true, "schema": { "type": "string" } }, "revokeAllPermissionsByTargetTargetIdentifier": { "name": "target_identifier", "in": "path", "description": "The identifier of the target resource.", "required": true, "schema": { "type": "string" } }, "revokeAllPermissionsByTargetMainAccountId": { "name": "main_account_id", "in": "query", "description": "If specified, revokes permissions for resources owned by the specified main account ID. Default is the current main account.", "required": false, "schema": { "type": "integer", "minimum": 1 } }, "revokeAllPermissionsByUserUser": { "name": "user", "in": "path", "description": "The username of the sub-account.", "required": true, "schema": { "type": "string" } }, "getPriceZone": { "name": "zone", "in": "query", "description": "Filter results to a specific zone. Can be specified multiple times.", "required": false, "schema": { "type": "string" } }, "listRoutersLabel": { "name": "label", "in": "query", "description": "A label filter. Can be specified multiple times to create an AND condition. Format: label=key:value", "schema": { "$ref": "#/components/schemas/routerLabel" } }, "getRouterRouter": { "name": "router", "in": "path", "description": "The router identifier.", "required": true, "schema": { "$ref": "#/components/schemas/routerUuid" } }, "deleteRouterRouter": { "name": "router", "in": "path", "description": "The router identifier.", "required": true, "schema": { "$ref": "#/components/schemas/routerUuid" } }, "modifyRouterRouter": { "name": "router", "in": "path", "description": "The router identifier.", "required": true, "schema": { "$ref": "#/components/schemas/routerUuid" } }, "listServerGroupsLabel": { "name": "label", "in": "query", "description": "A label filter to apply. Format: key:value. Multiple labels can be specified by repeating the parameter.", "required": false, "schema": { "$ref": "#/components/schemas/serverGroupLabel" } }, "getServerGroupUuid": { "name": "uuid", "in": "path", "description": "The UUID of the server group to retrieve.", "required": true, "schema": { "$ref": "#/components/schemas/serverGroupUuid" } }, "deleteServerGroupUuid": { "name": "uuid", "in": "path", "description": "The UUID of the server group to delete.", "required": true, "schema": { "$ref": "#/components/schemas/serverGroupUuid" } }, "modifyServerGroupUuid": { "name": "uuid", "in": "path", "description": "The UUID of the server group to modify.", "required": true, "schema": { "$ref": "#/components/schemas/serverGroupUuid" } }, "listServerGroupMembersUuid": { "name": "uuid", "in": "path", "description": "The UUID of the server group whose members are to be listed.", "required": true, "schema": { "$ref": "#/components/schemas/serverGroupUuid" } }, "serverGroupAddServerToGroupUuid": { "name": "uuid", "in": "path", "description": "The UUID of the server group to which the server will be added.", "required": true, "schema": { "$ref": "#/components/schemas/serverGroupUuid" } }, "serverGroupRemoveServerFromGroupUuid": { "name": "uuid", "in": "path", "description": "The UUID of the server group from which the server will be removed.", "required": true, "schema": { "$ref": "#/components/schemas/serverGroupUuid" } }, "serverGroupRemoveServerFromGroupServerUuid": { "name": "server_uuid", "in": "path", "description": "The UUID of the server to remove from the group.", "required": true, "schema": { "$ref": "#/components/schemas/serverGroupUuid" } }, "listServersLabel": { "name": "label", "in": "query", "description": "Filter by label key or key-value pair using \"key\" or \"key=value\". Repeat the parameter to require all labels.", "required": false, "schema": { "type": "string" } }, "listServersUuid": { "name": "uuid", "in": "query", "description": "Filter by Cloud Server UUID. Repeat the parameter to match any of up to five UUIDs.", "required": false, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "listServersHost": { "name": "host", "in": "query", "description": "Filter by Private Cloud host ID. Repeat the parameter to match any of up to five hosts.", "required": false, "schema": { "$ref": "#/components/schemas/serverEncodedHostId" } }, "listServersDevice": { "name": "device", "in": "query", "description": "Filter by attached device using \"type=gpu\" or \"type!=gpu\". Repeat the parameter for up to five filters.", "required": false, "schema": { "type": "string" } }, "listServersState": { "name": "state", "in": "query", "description": "Filter by the current Cloud Server state.", "required": false, "schema": { "type": "string", "enum": [ "started", "stopped", "maintenance", "error" ] } }, "listServersTag": { "name": "tag", "in": "query", "description": "Filter by tag name. Separate names with commas to match any tag or colons to require all tags.", "required": false, "schema": { "$ref": "#/components/schemas/serverTagList" } }, "listServersSearch": { "name": "search", "in": "query", "description": "Search UUIDs, titles, hostnames, zones, zone descriptions, IP addresses, tags, and template names.", "required": false, "schema": { "type": "string" } }, "listServersSortBy": { "name": "sort_by", "in": "query", "description": "Field to sort by.", "required": false, "schema": { "type": "string", "enum": [ "title", "zone", "size", "cores", "memory", "popularity" ] } }, "listServersOrderBy": { "name": "order_by", "in": "query", "description": "Sort direction. Only applied when sort_by is specified.", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, "listServersLimit": { "name": "limit", "in": "query", "description": "Maximum number of Cloud Servers to return.", "required": false, "schema": { "$ref": "#/components/schemas/serverLimit" } }, "listServersOffset": { "name": "offset", "in": "query", "description": "Number of Cloud Servers to skip.", "required": false, "schema": { "$ref": "#/components/schemas/serverOffset" } }, "getServerUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "modifyServerUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "deleteServerUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "deleteServerStorages": { "name": "storages", "in": "query", "description": "Whether to delete attached storage devices.", "required": false, "schema": { "$ref": "#/components/schemas/serverLegacyBoolean" } }, "deleteServerBackups": { "name": "backups", "in": "query", "description": "How to handle backups when deleting storage devices. The delete value is valid only when storages is set to a truthy value.", "required": false, "schema": { "type": "string", "enum": [ "keep", "keep_latest", "delete" ] } }, "cancelServerOperationUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "listServerGPUsUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "getServerNetworkingUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "addServerInterfaceUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "modifyServerInterfaceUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "modifyServerInterfaceIndex": { "name": "index", "in": "path", "description": "Network interface index", "required": true, "schema": { "type": "integer", "minimum": 1, "format": "int32" } }, "deleteServerInterfaceUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "deleteServerInterfaceIndex": { "name": "index", "in": "path", "description": "Network interface index", "required": true, "schema": { "type": "integer", "minimum": 1, "format": "int32" } }, "addServerInterfaceIpAddressUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "addServerInterfaceIpAddressIndex": { "name": "index", "in": "path", "description": "Network interface index", "required": true, "schema": { "type": "integer", "minimum": 1, "format": "int32" } }, "addServerInterfaceIpAddressForce": { "name": "force", "in": "query", "description": "Move the address from another interface when that interface can retain its required minimum number of addresses", "required": false, "schema": { "$ref": "#/components/schemas/serverBooleanYesno" } }, "deleteServerInterfaceIpAddressUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "deleteServerInterfaceIpAddressIndex": { "name": "index", "in": "path", "description": "Network interface index", "required": true, "schema": { "type": "integer", "minimum": 1, "format": "int32" } }, "deleteServerInterfaceIpAddressIp": { "name": "ip", "in": "path", "description": "IP address to delete", "required": true, "schema": { "$ref": "#/components/schemas/serverIpAddress" } }, "rebuildServerUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "relocateServerUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "restartServerUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "startServerUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "stopServerUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "serverListFirewallRulesetRelationshipsRulesetUuid": { "name": "ruleset_uuid", "in": "path", "description": "Firewall ruleset UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "serverAttachPrivateFirewallRulesetUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "serverEjectCDROMUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "serverLoadCDROMUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "serverDetachPrivateFirewallRulesetUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "serverListFirewallRulesUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "serverUpdateFirewallRulesUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "serverCreateFirewallRuleUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "serverGetFirewallRuleUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "serverGetFirewallRulePosition": { "name": "position", "in": "path", "description": "Firewall rule position", "required": true, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "format": "int32" } }, "serverDeleteFirewallRuleUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "serverDeleteFirewallRulePosition": { "name": "position", "in": "path", "description": "Firewall rule position", "required": true, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "format": "int32" } }, "serverListPrivateFirewallRulesetRelationshipsUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "serverGetRemoteAccessDetailsUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "serverGetCPUStatsUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "serverGetCPUStatsByPeriodUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "serverGetCPUStatsByPeriodPeriod": { "name": "period", "in": "path", "description": "Statistics period.", "required": true, "schema": { "$ref": "#/components/schemas/serverStatsPeriod" } }, "serverGetDiskStatsUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "serverGetDiskStatsType": { "name": "type", "in": "path", "description": "Measure disk activity as transferred bytes or I/O requests.", "required": true, "schema": { "type": "string", "enum": [ "bytes", "requests" ] } }, "serverGetDiskStatsByPeriodUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "serverGetDiskStatsByPeriodType": { "name": "type", "in": "path", "description": "Measure disk activity as transferred bytes or I/O requests.", "required": true, "schema": { "type": "string", "enum": [ "bytes", "requests" ] } }, "serverGetDiskStatsByPeriodPeriod": { "name": "period", "in": "path", "description": "Statistics period.", "required": true, "schema": { "$ref": "#/components/schemas/serverStatsPeriod" } }, "serverGetNetworkStatsUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "serverGetNetworkStatsType": { "name": "type", "in": "path", "description": "Measure network activity as transferred bytes or packets.", "required": true, "schema": { "$ref": "#/components/schemas/serverStatsNetworkType" } }, "serverGetNetworkStatsByNetworkUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "serverGetNetworkStatsByNetworkType": { "name": "type", "in": "path", "description": "Measure network activity as transferred bytes or packets.", "required": true, "schema": { "$ref": "#/components/schemas/serverStatsNetworkType" } }, "serverGetNetworkStatsByNetworkNetwork": { "name": "network", "in": "path", "description": "Network access type to aggregate.", "required": true, "schema": { "$ref": "#/components/schemas/serverNetworkType" } }, "serverGetNetworkStatsByNetworkAndPeriodUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "serverGetNetworkStatsByNetworkAndPeriodType": { "name": "type", "in": "path", "description": "Measure network activity as transferred bytes or packets.", "required": true, "schema": { "$ref": "#/components/schemas/serverStatsNetworkType" } }, "serverGetNetworkStatsByNetworkAndPeriodNetwork": { "name": "network", "in": "path", "description": "Network access type to aggregate.", "required": true, "schema": { "$ref": "#/components/schemas/serverNetworkType" } }, "serverGetNetworkStatsByNetworkAndPeriodPeriod": { "name": "period", "in": "path", "description": "Statistics period.", "required": true, "schema": { "$ref": "#/components/schemas/serverStatsPeriod" } }, "serverAttachStorageDeviceUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "serverDetachStorageDeviceUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "serverGetVNCDetailsUuid": { "name": "uuid", "in": "path", "description": "Cloud Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/serverUuid" } }, "getStorageListLabel": { "name": "label", "in": "query", "description": "Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.", "required": false, "schema": { "$ref": "#/components/schemas/storageLabelFilter" } }, "getStorageListSearch": { "name": "search", "in": "query", "description": "Search storage resource titles and UUIDs by partial match.", "required": false, "schema": { "$ref": "#/components/schemas/storageSearch" } }, "getStorageListSortBy": { "name": "sort_by", "in": "query", "description": "Field by which to sort the results.", "required": false, "schema": { "$ref": "#/components/schemas/storageSortBy" } }, "getStorageListOrderBy": { "name": "order_by", "in": "query", "description": "Sort direction. Used only when `sort_by` is specified.", "required": false, "schema": { "$ref": "#/components/schemas/storageOrderBy" } }, "getStorageListLimit": { "name": "limit", "in": "query", "description": "Maximum number of storage resources to return.", "required": false, "schema": { "$ref": "#/components/schemas/storageLimit" } }, "getStorageListOffset": { "name": "offset", "in": "query", "description": "Number of storage resources to skip before returning results.", "required": false, "schema": { "$ref": "#/components/schemas/storageOffset" } }, "getStorageListByBackupLabel": { "name": "label", "in": "query", "description": "Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.", "required": false, "schema": { "$ref": "#/components/schemas/storageLabelFilter" } }, "getStorageListByBackupSearch": { "name": "search", "in": "query", "description": "Search storage resource titles and UUIDs by partial match.", "required": false, "schema": { "$ref": "#/components/schemas/storageSearch" } }, "getStorageListByBackupSortBy": { "name": "sort_by", "in": "query", "description": "Field by which to sort the results.", "required": false, "schema": { "$ref": "#/components/schemas/storageSortBy" } }, "getStorageListByBackupOrderBy": { "name": "order_by", "in": "query", "description": "Sort direction. Used only when `sort_by` is specified.", "required": false, "schema": { "$ref": "#/components/schemas/storageOrderBy" } }, "getStorageListByBackupLimit": { "name": "limit", "in": "query", "description": "Maximum number of storage resources to return.", "required": false, "schema": { "$ref": "#/components/schemas/storageLimit" } }, "getStorageListByBackupOffset": { "name": "offset", "in": "query", "description": "Number of storage resources to skip before returning results.", "required": false, "schema": { "$ref": "#/components/schemas/storageOffset" } }, "getStorageListByCdromLabel": { "name": "label", "in": "query", "description": "Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.", "required": false, "schema": { "$ref": "#/components/schemas/storageLabelFilter" } }, "getStorageListByCdromSearch": { "name": "search", "in": "query", "description": "Search storage resource titles and UUIDs by partial match.", "required": false, "schema": { "$ref": "#/components/schemas/storageSearch" } }, "getStorageListByCdromSortBy": { "name": "sort_by", "in": "query", "description": "Field by which to sort the results.", "required": false, "schema": { "$ref": "#/components/schemas/storageSortBy" } }, "getStorageListByCdromOrderBy": { "name": "order_by", "in": "query", "description": "Sort direction. Used only when `sort_by` is specified.", "required": false, "schema": { "$ref": "#/components/schemas/storageOrderBy" } }, "getStorageListByCdromLimit": { "name": "limit", "in": "query", "description": "Maximum number of storage resources to return.", "required": false, "schema": { "$ref": "#/components/schemas/storageLimit" } }, "getStorageListByCdromOffset": { "name": "offset", "in": "query", "description": "Number of storage resources to skip before returning results.", "required": false, "schema": { "$ref": "#/components/schemas/storageOffset" } }, "getStorageListByNormalLabel": { "name": "label", "in": "query", "description": "Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.", "required": false, "schema": { "$ref": "#/components/schemas/storageLabelFilter" } }, "getStorageListByNormalSearch": { "name": "search", "in": "query", "description": "Search storage resource titles and UUIDs by partial match.", "required": false, "schema": { "$ref": "#/components/schemas/storageSearch" } }, "getStorageListByNormalSortBy": { "name": "sort_by", "in": "query", "description": "Field by which to sort the results.", "required": false, "schema": { "$ref": "#/components/schemas/storageSortBy" } }, "getStorageListByNormalOrderBy": { "name": "order_by", "in": "query", "description": "Sort direction. Used only when `sort_by` is specified.", "required": false, "schema": { "$ref": "#/components/schemas/storageOrderBy" } }, "getStorageListByNormalLimit": { "name": "limit", "in": "query", "description": "Maximum number of storage resources to return.", "required": false, "schema": { "$ref": "#/components/schemas/storageLimit" } }, "getStorageListByNormalOffset": { "name": "offset", "in": "query", "description": "Number of storage resources to skip before returning results.", "required": false, "schema": { "$ref": "#/components/schemas/storageOffset" } }, "getStorageListByPrivateAccessLabel": { "name": "label", "in": "query", "description": "Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.", "required": false, "schema": { "$ref": "#/components/schemas/storageLabelFilter" } }, "getStorageListByPrivateAccessSearch": { "name": "search", "in": "query", "description": "Search storage resource titles and UUIDs by partial match.", "required": false, "schema": { "$ref": "#/components/schemas/storageSearch" } }, "getStorageListByPrivateAccessSortBy": { "name": "sort_by", "in": "query", "description": "Field by which to sort the results.", "required": false, "schema": { "$ref": "#/components/schemas/storageSortBy" } }, "getStorageListByPrivateAccessOrderBy": { "name": "order_by", "in": "query", "description": "Sort direction. Used only when `sort_by` is specified.", "required": false, "schema": { "$ref": "#/components/schemas/storageOrderBy" } }, "getStorageListByPrivateAccessLimit": { "name": "limit", "in": "query", "description": "Maximum number of storage resources to return.", "required": false, "schema": { "$ref": "#/components/schemas/storageLimit" } }, "getStorageListByPrivateAccessOffset": { "name": "offset", "in": "query", "description": "Number of storage resources to skip before returning results.", "required": false, "schema": { "$ref": "#/components/schemas/storageOffset" } }, "getStorageListByPublicAccessLabel": { "name": "label", "in": "query", "description": "Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.", "required": false, "schema": { "$ref": "#/components/schemas/storageLabelFilter" } }, "getStorageListByPublicAccessSearch": { "name": "search", "in": "query", "description": "Search storage resource titles and UUIDs by partial match.", "required": false, "schema": { "$ref": "#/components/schemas/storageSearch" } }, "getStorageListByPublicAccessSortBy": { "name": "sort_by", "in": "query", "description": "Field by which to sort the results.", "required": false, "schema": { "$ref": "#/components/schemas/storageSortBy" } }, "getStorageListByPublicAccessOrderBy": { "name": "order_by", "in": "query", "description": "Sort direction. Used only when `sort_by` is specified.", "required": false, "schema": { "$ref": "#/components/schemas/storageOrderBy" } }, "getStorageListByPublicAccessLimit": { "name": "limit", "in": "query", "description": "Maximum number of storage resources to return.", "required": false, "schema": { "$ref": "#/components/schemas/storageLimit" } }, "getStorageListByPublicAccessOffset": { "name": "offset", "in": "query", "description": "Number of storage resources to skip before returning results.", "required": false, "schema": { "$ref": "#/components/schemas/storageOffset" } }, "getStorageListByTemplateLabel": { "name": "label", "in": "query", "description": "Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.", "required": false, "schema": { "$ref": "#/components/schemas/storageLabelFilter" } }, "getStorageListByTemplateSearch": { "name": "search", "in": "query", "description": "Search storage resource titles and UUIDs by partial match.", "required": false, "schema": { "$ref": "#/components/schemas/storageSearch" } }, "getStorageListByTemplateSortBy": { "name": "sort_by", "in": "query", "description": "Field by which to sort the results.", "required": false, "schema": { "$ref": "#/components/schemas/storageSortBy" } }, "getStorageListByTemplateOrderBy": { "name": "order_by", "in": "query", "description": "Sort direction. Used only when `sort_by` is specified.", "required": false, "schema": { "$ref": "#/components/schemas/storageOrderBy" } }, "getStorageListByTemplateLimit": { "name": "limit", "in": "query", "description": "Maximum number of storage resources to return.", "required": false, "schema": { "$ref": "#/components/schemas/storageLimit" } }, "getStorageListByTemplateOffset": { "name": "offset", "in": "query", "description": "Number of storage resources to skip before returning results.", "required": false, "schema": { "$ref": "#/components/schemas/storageOffset" } }, "getStorageListByTypeAndAccessType": { "name": "type", "in": "path", "description": "Storage resource type to return.", "required": true, "schema": { "$ref": "#/components/schemas/storageType" } }, "getStorageListByTypeAndAccessAccess": { "name": "access", "in": "path", "description": "Storage resource access type to return.", "required": true, "schema": { "$ref": "#/components/schemas/storageAccessFilter" } }, "getStorageListByTypeAndAccessLabel": { "name": "label", "in": "query", "description": "Filter by label key or key-value pair. Repeat the parameter to require multiple labels; label keys are matched case-insensitively.", "required": false, "schema": { "$ref": "#/components/schemas/storageLabelFilter" } }, "getStorageListByTypeAndAccessSearch": { "name": "search", "in": "query", "description": "Search storage resource titles and UUIDs by partial match.", "required": false, "schema": { "$ref": "#/components/schemas/storageSearch" } }, "getStorageListByTypeAndAccessSortBy": { "name": "sort_by", "in": "query", "description": "Field by which to sort the results.", "required": false, "schema": { "$ref": "#/components/schemas/storageSortBy" } }, "getStorageListByTypeAndAccessOrderBy": { "name": "order_by", "in": "query", "description": "Sort direction. Used only when `sort_by` is specified.", "required": false, "schema": { "$ref": "#/components/schemas/storageOrderBy" } }, "getStorageListByTypeAndAccessLimit": { "name": "limit", "in": "query", "description": "Maximum number of storage resources to return.", "required": false, "schema": { "$ref": "#/components/schemas/storageLimit" } }, "getStorageListByTypeAndAccessOffset": { "name": "offset", "in": "query", "description": "Number of storage resources to skip before returning results.", "required": false, "schema": { "$ref": "#/components/schemas/storageOffset" } }, "getStorageInfoUuid": { "name": "uuid", "in": "path", "description": "Storage resource UUID", "required": true, "schema": { "$ref": "#/components/schemas/storageUuid" } }, "modifyStorageUuid": { "name": "uuid", "in": "path", "description": "Block storage UUID", "required": true, "schema": { "$ref": "#/components/schemas/storageUuid" } }, "deleteStorageUuid": { "name": "uuid", "in": "path", "description": "Storage resource UUID", "required": true, "schema": { "$ref": "#/components/schemas/storageUuid" } }, "deleteStorageBackups": { "name": "backups", "in": "query", "description": "Policy for handling backups when deleting a storage resource. Defaults to `keep`. Allowed values: keep, delete, keep_latest", "required": false, "schema": { "type": "string", "enum": [ "keep", "delete", "keep_latest" ] } }, "attachStorageToServerUuid": { "name": "uuid", "in": "path", "description": "Storage resource UUID", "required": true, "schema": { "$ref": "#/components/schemas/storageUuid" } }, "cancelStorageOperationUuid": { "name": "uuid", "in": "path", "description": "Block storage UUID", "required": true, "schema": { "$ref": "#/components/schemas/storageUuid" } }, "cloneStorageUuid": { "name": "uuid", "in": "path", "description": "Storage resource UUID", "required": true, "schema": { "$ref": "#/components/schemas/storageUuid" } }, "detachStorageFromServerUuid": { "name": "uuid", "in": "path", "description": "Storage resource UUID", "required": true, "schema": { "$ref": "#/components/schemas/storageUuid" } }, "addStorageToFavoritesUuid": { "name": "uuid", "in": "path", "description": "Storage resource UUID", "required": true, "schema": { "$ref": "#/components/schemas/storageUuid" } }, "removeStorageFromFavoritesUuid": { "name": "uuid", "in": "path", "description": "Storage resource UUID", "required": true, "schema": { "$ref": "#/components/schemas/storageUuid" } }, "resizeStorageUuid": { "name": "uuid", "in": "path", "description": "Block storage UUID", "required": true, "schema": { "$ref": "#/components/schemas/storageUuid" } }, "restoreStorageFromBackupUuid": { "name": "uuid", "in": "path", "description": "Backup UUID", "required": true, "schema": { "$ref": "#/components/schemas/storageUuid" } }, "createTemplateFromStorageUuid": { "name": "uuid", "in": "path", "description": "Block storage UUID", "required": true, "schema": { "$ref": "#/components/schemas/storageUuid" } }, "storageCreateOnDemandBackupUuid": { "name": "uuid", "in": "path", "description": "Block storage UUID", "required": true, "schema": { "$ref": "#/components/schemas/storageUuid" } }, "getTagName": { "name": "name", "in": "path", "description": "Tag name", "required": true, "schema": { "$ref": "#/components/schemas/tagName" } }, "modifyTagName": { "name": "name", "in": "path", "description": "Tag name", "required": true, "schema": { "$ref": "#/components/schemas/tagName" } }, "deleteTagName": { "name": "name", "in": "path", "description": "Tag name", "required": true, "schema": { "$ref": "#/components/schemas/tagName" } }, "accountTokensListTokensLimit": { "name": "limit", "in": "query", "description": "How many tokens to return at per page", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "format": "int32", "default": 20 } }, "accountTokensListTokensOffset": { "name": "offset", "in": "query", "description": "Offset to start listing the tokens from", "required": false, "schema": { "type": "integer", "minimum": 0, "format": "int32", "default": 0 } }, "accountTokensListTokensGui": { "name": "gui", "in": "query", "description": "Filter tokens based on GUI flag (true or false). Default is no value, i.e. no filtering and all tokens are returned.", "required": false, "schema": { "type": "boolean", "example": true } }, "accountTokensListTokensSort": { "name": "sort", "in": "query", "description": "Comma-separated list of fields to sort by. Prefix with '+' for ascending or '-' for descending order. Supported fields: created_at, expires_at, last_used_at, name. Example: sort=+name,-created_at. If no prefix is given, descending is assumed. Follows OpenAPI collectionFormat 'csv'.\n", "required": false, "schema": { "type": "string", "example": "+name,-created_at" } }, "accountTokensGetTokenTokenUuid": { "name": "token-uuid", "in": "path", "description": "The uuid of the token to get", "required": true, "schema": { "type": "string", "format": "uuid" } }, "accountTokensRevokeTokenTokenUuid": { "name": "token-uuid", "in": "path", "description": "The uuid of the token to delete", "required": true, "schema": { "type": "string", "format": "uuid" } }, "objectStorage2ListObjectStoragesLimit": { "name": "limit", "in": "query", "description": "Number of entries to receive at most.", "required": false, "schema": { "$ref": "#/components/schemas/objectStorage2QueryParamLimit" } }, "objectStorage2ListObjectStoragesOffset": { "name": "offset", "in": "query", "description": "Offset for retrieved results.", "required": false, "schema": { "$ref": "#/components/schemas/objectStorage2QueryParamOffset" } }, "objectStorage2ListObjectStoragesSort": { "name": "sort", "in": "query", "description": "Order of returned results.", "required": false, "schema": { "$ref": "#/components/schemas/objectStorage2QueryParamSort" } }, "objectStorage2GetObjectStorageServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2ReplaceObjectStorageServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DeleteObjectStorageServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DeleteObjectStorageForce": { "name": "force", "in": "query", "description": "If the parameter is provided, the deletion process starts even if the service is not empty.", "required": false, "schema": { "$ref": "#/components/schemas/objectStorage2QueryParamForce" } }, "objectStorage2ModifyObjectStorageServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2ListObjectStorageNetworksServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2CreateObjectStorageNetworkServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2GetObjectStorageNetworkServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2GetObjectStorageNetworkNetworkName": { "name": "network-name", "in": "path", "description": "The name of the network.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DeleteObjectStorageNetworkServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DeleteObjectStorageNetworkNetworkName": { "name": "network-name", "in": "path", "description": "The name of the network.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2ListObjectStorageCustomDomainsServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2AttachObjectStorageCustomDomainServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2GetObjectStorageCustomDomainServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2GetObjectStorageCustomDomainCustomDomainName": { "name": "custom-domain-name", "in": "path", "description": "The domain name.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2CustomDomainName" } }, "objectStorage2DeleteObjectStorageCustomDomainServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DeleteObjectStorageCustomDomainCustomDomainName": { "name": "custom-domain-name", "in": "path", "description": "The domain name.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2CustomDomainName" } }, "objectStorage2ModifyObjectStorageCustomDomainServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2ModifyObjectStorageCustomDomainCustomDomainName": { "name": "custom-domain-name", "in": "path", "description": "The domain name.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2CustomDomainName" } }, "objectStorage2GetObjectStorageRegionRegionName": { "name": "region-name", "in": "path", "description": "The name of the region.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2GetObjectStorageMetricsServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2ListObjectStorageBucketMetricsServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2ListObjectStorageBucketMetricsLimit": { "name": "limit", "in": "query", "description": "Number of entries to receive at most.", "required": false, "schema": { "$ref": "#/components/schemas/objectStorage2QueryParamLimit" } }, "objectStorage2ListObjectStorageBucketMetricsOffset": { "name": "offset", "in": "query", "description": "Offset for retrieved results.", "required": false, "schema": { "$ref": "#/components/schemas/objectStorage2QueryParamOffset" } }, "objectStorage2CreateObjectStorageBucketServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DeleteObjectStorageBucketServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DeleteObjectStorageBucketBucketName": { "name": "bucket-name", "in": "path", "description": "The name of the bucket.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2ListObjectStorageMetricsSeriesServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2ListObjectStorageMetricsSeriesFrom": { "name": "from", "in": "query", "description": "Beginning of the time range for which to return metrics.", "required": false, "schema": { "$ref": "#/components/schemas/objectStorage2QueryParamTimestamp" } }, "objectStorage2ListObjectStorageMetricsSeriesTo": { "name": "to", "in": "query", "description": "End of the time range for which to return metrics.", "required": false, "schema": { "$ref": "#/components/schemas/objectStorage2QueryParamTimestamp" } }, "objectStorage2ListObjectStorageMetricsSeriesInterval": { "name": "interval", "in": "query", "description": "Metrics aggregation interval.", "required": false, "schema": { "$ref": "#/components/schemas/objectStorage2QueryParamInterval" } }, "objectStorage2ListObjectStorageMetricsSeriesSort": { "name": "sort", "in": "query", "description": "Order of returned results.", "required": false, "schema": { "$ref": "#/components/schemas/objectStorage2QueryParamSort" } }, "objectStorage2ListObjectStorageMetricsSeriesLimit": { "name": "limit", "in": "query", "description": "Number of entries to receive at most.", "required": false, "schema": { "$ref": "#/components/schemas/objectStorage2QueryParamLimit" } }, "objectStorage2ListObjectStorageMetricsSeriesOffset": { "name": "offset", "in": "query", "description": "Offset for retrieved results.", "required": false, "schema": { "$ref": "#/components/schemas/objectStorage2QueryParamOffset" } }, "objectStorage2ListObjectStorageLabelsServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2CreateObjectStorageLabelServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2GetObjectStorageLabelServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2GetObjectStorageLabelLabelKey": { "name": "label-key", "in": "path", "description": "The key of the label.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2LabelKey" } }, "objectStorage2DeleteObjectStorageLabelServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DeleteObjectStorageLabelLabelKey": { "name": "label-key", "in": "path", "description": "The key of the label.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2LabelKey" } }, "objectStorage2ModifyObjectStorageLabelServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2ModifyObjectStorageLabelLabelKey": { "name": "label-key", "in": "path", "description": "The key of the label.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2LabelKey" } }, "objectStorage2ListObjectStorageStaticWebsitesServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2CreateObjectStorageStaticWebsiteServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2GetObjectStorageStaticWebsiteServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2GetObjectStorageStaticWebsiteCustomDomainName": { "name": "custom-domain-name", "in": "path", "description": "The domain name.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2CustomDomainName" } }, "objectStorage2DeleteObjectStorageStaticWebsiteServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DeleteObjectStorageStaticWebsiteCustomDomainName": { "name": "custom-domain-name", "in": "path", "description": "The domain name.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2CustomDomainName" } }, "objectStorage2ModifyObjectStorageStaticWebsiteServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2ModifyObjectStorageStaticWebsiteCustomDomainName": { "name": "custom-domain-name", "in": "path", "description": "The domain name.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2CustomDomainName" } }, "objectStorage2ListObjectStorageDomainsServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2ListObjectStorageUsersServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2CreateObjectStorageUserServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2GetObjectStorageUserServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2GetObjectStorageUserUsername": { "name": "username", "in": "path", "description": "The name of the user.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DeleteObjectStorageUserServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DeleteObjectStorageUserUsername": { "name": "username", "in": "path", "description": "The name of the user.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2ListObjectStorageAccessKeysServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2ListObjectStorageAccessKeysUsername": { "name": "username", "in": "path", "description": "The name of the user.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2CreateObjectStorageAccessKeyServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2CreateObjectStorageAccessKeyUsername": { "name": "username", "in": "path", "description": "The name of the user.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2GetObjectStorageAccessKeyDetailsServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2GetObjectStorageAccessKeyDetailsUsername": { "name": "username", "in": "path", "description": "The name of the user.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2GetObjectStorageAccessKeyDetailsAccessKeyId": { "name": "access-key-id", "in": "path", "description": "The ID of the access key.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2AccessKeyID" } }, "objectStorage2DeleteObjectStorageAccessKeyServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DeleteObjectStorageAccessKeyUsername": { "name": "username", "in": "path", "description": "The name of the user.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DeleteObjectStorageAccessKeyAccessKeyId": { "name": "access-key-id", "in": "path", "description": "The ID of the access key.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2AccessKeyID" } }, "objectStorage2ModifyObjectStorageAccessKeyDetailsServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2ModifyObjectStorageAccessKeyDetailsUsername": { "name": "username", "in": "path", "description": "The name of the user.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2ModifyObjectStorageAccessKeyDetailsAccessKeyId": { "name": "access-key-id", "in": "path", "description": "The ID of the access key.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2AccessKeyID" } }, "objectStorage2ListObjectStorageAttachedUserPoliciesServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2ListObjectStorageAttachedUserPoliciesUsername": { "name": "username", "in": "path", "description": "The name of the user.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2AttachObjectStorageUserPolicyServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2AttachObjectStorageUserPolicyUsername": { "name": "username", "in": "path", "description": "The name of the user.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DetachObjectStorageUserPolicyServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DetachObjectStorageUserPolicyUsername": { "name": "username", "in": "path", "description": "The name of the user.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DetachObjectStorageUserPolicyNestedName": { "name": "nested-name", "in": "path", "description": "The name of the policy to detach.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2GetObjectStorageUserInlinePolicyServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2GetObjectStorageUserInlinePolicyUsername": { "name": "username", "in": "path", "description": "The name of the user.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2GetObjectStorageUserInlinePolicyUserPolicyName": { "name": "user-policy-name", "in": "path", "description": "The name of the inline policy.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DeleteObjectStorageUserInlinePolicyServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DeleteObjectStorageUserInlinePolicyUsername": { "name": "username", "in": "path", "description": "The name of the user.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DeleteObjectStorageUserInlinePolicyUserPolicyName": { "name": "user-policy-name", "in": "path", "description": "The name of the inline policy.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2ListObjectStorageUserInlinePoliciesServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2ListObjectStorageUserInlinePoliciesUsername": { "name": "username", "in": "path", "description": "The name of the user.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2CreateObjectStorageUserInlinePolicyServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2CreateObjectStorageUserInlinePolicyUsername": { "name": "username", "in": "path", "description": "The name of the user.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2GetObjectStorageUserTagsServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2GetObjectStorageUserTagsUsername": { "name": "username", "in": "path", "description": "The name of the user.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2ReplaceObjectStorageUserTagsServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2ReplaceObjectStorageUserTagsUsername": { "name": "username", "in": "path", "description": "The name of the user.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DeleteObjectStorageUserTagServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DeleteObjectStorageUserTagUsername": { "name": "username", "in": "path", "description": "The name of the user.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DeleteObjectStorageUserTagUserTagKey": { "name": "user-tag-key", "in": "path", "description": "The key of the user tag.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2TagKey" } }, "objectStorage2CreateObjectStorageUserPermissionsBoundaryServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2CreateObjectStorageUserPermissionsBoundaryUsername": { "name": "username", "in": "path", "description": "The name of the user.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DeleteObjectStorageUserPermissionsBoundaryServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DeleteObjectStorageUserPermissionsBoundaryUsername": { "name": "username", "in": "path", "description": "The name of the user.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2ListObjectStoragePolicyVersionsServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2ListObjectStoragePolicyVersionsPolicyName": { "name": "policy-name", "in": "path", "description": "The name of the policy.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2CreateObjectStoragePolicyVersionServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2CreateObjectStoragePolicyVersionPolicyName": { "name": "policy-name", "in": "path", "description": "The name of the policy.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2GetObjectStoragePolicyVersionServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2GetObjectStoragePolicyVersionPolicyName": { "name": "policy-name", "in": "path", "description": "The name of the policy.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2GetObjectStoragePolicyVersionPolicyVersion": { "name": "policy-version", "in": "path", "description": "The version identifier of the policy.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2PolicyVersionID" } }, "objectStorage2DeleteObjectStoragePolicyVersionServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DeleteObjectStoragePolicyVersionPolicyName": { "name": "policy-name", "in": "path", "description": "The name of the policy.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DeleteObjectStoragePolicyVersionPolicyVersion": { "name": "policy-version", "in": "path", "description": "The version identifier of the policy.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2PolicyVersionID" } }, "objectStorage2GetObjectStoragePolicyServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2GetObjectStoragePolicyPolicyName": { "name": "policy-name", "in": "path", "description": "The name of the policy.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DeleteObjectStoragePolicyServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DeleteObjectStoragePolicyPolicyName": { "name": "policy-name", "in": "path", "description": "The name of the policy.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2SetObjectStorageDefaultPolicyVersionServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2SetObjectStorageDefaultPolicyVersionPolicyName": { "name": "policy-name", "in": "path", "description": "The name of the policy.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2ListObjectStoragePoliciesServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2CreateObjectStoragePolicyServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2ListObjectStorageIAMGroupPoliciesServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2ListObjectStorageIAMGroupPoliciesGroupName": { "name": "group-name", "in": "path", "description": "The name of the group.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2AttachObjectStorageIAMGroupPolicyServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2AttachObjectStorageIAMGroupPolicyGroupName": { "name": "group-name", "in": "path", "description": "The name of the group.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DetachObjectStorageIAMGroupPolicyServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DetachObjectStorageIAMGroupPolicyGroupName": { "name": "group-name", "in": "path", "description": "The name of the group.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DetachObjectStorageIAMGroupPolicyPolicyName": { "name": "policy-name", "in": "path", "description": "The name of the policy.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2ListObjectStorageGroupsServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2CreateObjectStorageGroupServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2GetObjectStorageGroupServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2GetObjectStorageGroupGroupName": { "name": "group-name", "in": "path", "description": "The name of the group.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DeleteObjectStorageGroupServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DeleteObjectStorageGroupGroupName": { "name": "group-name", "in": "path", "description": "The name of the group.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2AttachObjectStorageUserToGroupServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2AttachObjectStorageUserToGroupGroupName": { "name": "group-name", "in": "path", "description": "The name of the group.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2AttachObjectStorageUserToGroupUsername": { "name": "username", "in": "path", "description": "The name of the user.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2RemoveObjectStorageUserFromGroupServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2RemoveObjectStorageUserFromGroupGroupName": { "name": "group-name", "in": "path", "description": "The name of the group.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2RemoveObjectStorageUserFromGroupUsername": { "name": "username", "in": "path", "description": "The name of the user.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2ListObjectStorageGroupInlinePoliciesServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2ListObjectStorageGroupInlinePoliciesGroupName": { "name": "group-name", "in": "path", "description": "The name of the group.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2CreateObjectStorageGroupInlinePolicyServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2CreateObjectStorageGroupInlinePolicyGroupName": { "name": "group-name", "in": "path", "description": "The name of the group.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2GetObjectStorageGroupInlinePolicyServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2GetObjectStorageGroupInlinePolicyGroupName": { "name": "group-name", "in": "path", "description": "The name of the group.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2GetObjectStorageGroupInlinePolicyGroupPolicyName": { "name": "group-policy-name", "in": "path", "description": "The name of the inline policy.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DeleteObjectStorageGroupInlinePolicyServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DeleteObjectStorageGroupInlinePolicyGroupName": { "name": "group-name", "in": "path", "description": "The name of the group.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DeleteObjectStorageGroupInlinePolicyGroupPolicyName": { "name": "group-policy-name", "in": "path", "description": "The name of the inline policy.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2ListObjectStorageRolesServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2CreateObjectStorageRoleServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2GetObjectStorageRoleServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2GetObjectStorageRoleRoleName": { "name": "role-name", "in": "path", "description": "The name of the role.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DeleteObjectStorageRoleServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DeleteObjectStorageRoleRoleName": { "name": "role-name", "in": "path", "description": "The name of the role.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2UpdateObjectStorageRoleServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2UpdateObjectStorageRoleRoleName": { "name": "role-name", "in": "path", "description": "The name of the role.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2ListObjectStorageRoleInlinePoliciesServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2ListObjectStorageRoleInlinePoliciesRoleName": { "name": "role-name", "in": "path", "description": "The name of the role.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2CreateObjectStorageRoleInlinePolicyServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2CreateObjectStorageRoleInlinePolicyRoleName": { "name": "role-name", "in": "path", "description": "The name of the role.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2GetObjectStorageRoleInlinePolicyServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2GetObjectStorageRoleInlinePolicyRoleName": { "name": "role-name", "in": "path", "description": "The name of the role.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2GetObjectStorageRoleInlinePolicyRolePolicyName": { "name": "role-policy-name", "in": "path", "description": "The name of the inline policy.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DeleteObjectStorageRoleInlinePolicyServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DeleteObjectStorageRoleInlinePolicyRoleName": { "name": "role-name", "in": "path", "description": "The name of the role.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DeleteObjectStorageRoleInlinePolicyRolePolicyName": { "name": "role-policy-name", "in": "path", "description": "The name of the inline policy.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2CreateObjectStorageRolePermissionsBoundaryServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2CreateObjectStorageRolePermissionsBoundaryRoleName": { "name": "role-name", "in": "path", "description": "The name of the role.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DeleteObjectStorageRolePermissionsBoundaryServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DeleteObjectStorageRolePermissionsBoundaryRoleName": { "name": "role-name", "in": "path", "description": "The name of the role.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2AssumeObjectStorageRolePolicyServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2AssumeObjectStorageRolePolicyRoleName": { "name": "role-name", "in": "path", "description": "The name of the role.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2ListObjectStorageAttachedRolePoliciesServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2ListObjectStorageAttachedRolePoliciesRoleName": { "name": "role-name", "in": "path", "description": "The name of the role.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2AttachObjectStoragePolicyToRoleServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2AttachObjectStoragePolicyToRoleRoleName": { "name": "role-name", "in": "path", "description": "The name of the role.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DetachObjectStoragePolicyFromRoleServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DetachObjectStoragePolicyFromRoleRoleName": { "name": "role-name", "in": "path", "description": "The name of the role.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DetachObjectStoragePolicyFromRoleRolePolicyName": { "name": "role-policy-name", "in": "path", "description": "The name of the inline policy.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2GetObjectStorageRoleTagsServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2GetObjectStorageRoleTagsRoleName": { "name": "role-name", "in": "path", "description": "The name of the role.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2ReplaceObjectStorageRoleTagsServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2ReplaceObjectStorageRoleTagsRoleName": { "name": "role-name", "in": "path", "description": "The name of the role.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DeleteObjectStorageRoleTagServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2ServiceUUID" } }, "objectStorage2DeleteObjectStorageRoleTagRoleName": { "name": "role-name", "in": "path", "description": "The name of the role.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2Name" } }, "objectStorage2DeleteObjectStorageRoleTagRoleTagKey": { "name": "role-tag-key", "in": "path", "description": "The key of the role tag.", "required": true, "schema": { "$ref": "#/components/schemas/objectStorage2TagKey" } }, "listFileStoragesLimit": { "name": "limit", "in": "query", "description": "Number of entries to receive at most.", "required": false, "schema": { "$ref": "#/components/schemas/fileStorageQueryParameterLimit" } }, "listFileStoragesOffset": { "name": "offset", "in": "query", "description": "Offset for retrieved results.", "required": false, "schema": { "$ref": "#/components/schemas/fileStorageQueryParamOffset" } }, "listFileStoragesSort": { "name": "sort", "in": "query", "description": "Order of returned results.", "required": false, "schema": { "$ref": "#/components/schemas/fileStorageQueryParamSort" } }, "getFileStorageServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "replaceFileStorageServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "deleteFileStorageServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "modifyFileStorageServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "listFileStorageNetworksServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "createFileStorageNetworkServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "getFileStorageNetworkServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "getFileStorageNetworkNetworkName": { "name": "network-name", "in": "path", "description": "The name of the network.", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageName" } }, "deleteFileStorageNetworkServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "deleteFileStorageNetworkNetworkName": { "name": "network-name", "in": "path", "description": "The name of the network.", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageName" } }, "modifyFileStorageNetworkServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "modifyFileStorageNetworkNetworkName": { "name": "network-name", "in": "path", "description": "The name of the network.", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageName" } }, "listFileStorageSharesServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "createFileStorageShareServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "getFileStorageShareServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "getFileStorageShareShareName": { "name": "share-name", "in": "path", "description": "The name of the share.", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageName" } }, "deleteFileStorageShareServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "deleteFileStorageShareShareName": { "name": "share-name", "in": "path", "description": "The name of the share.", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageName" } }, "modifyFileStorageShareServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "modifyFileStorageShareShareName": { "name": "share-name", "in": "path", "description": "The name of the share.", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageName" } }, "listFileStorageAclsServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "listFileStorageAclsShareName": { "name": "share-name", "in": "path", "description": "The name of the share.", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageName" } }, "createFileStorageAclServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "createFileStorageAclShareName": { "name": "share-name", "in": "path", "description": "The name of the share.", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageName" } }, "getFileStorageAclServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "getFileStorageAclShareName": { "name": "share-name", "in": "path", "description": "The name of the share.", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageName" } }, "getFileStorageAclAclName": { "name": "acl-name", "in": "path", "description": "The name of the ACL.", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageName" } }, "deleteFileStorageAclServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "deleteFileStorageAclShareName": { "name": "share-name", "in": "path", "description": "The name of the share.", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageName" } }, "deleteFileStorageAclAclName": { "name": "acl-name", "in": "path", "description": "The name of the ACL.", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageName" } }, "modifyFileStorageAclServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "modifyFileStorageAclShareName": { "name": "share-name", "in": "path", "description": "The name of the share.", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageName" } }, "modifyFileStorageAclAclName": { "name": "acl-name", "in": "path", "description": "The name of the ACL.", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageName" } }, "listFileStorageLabelsServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "createFileStorageLabelServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "getFileStorageLabelServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "getFileStorageLabelLabelKey": { "name": "label-key", "in": "path", "description": "The key of the label.", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageLabelKey" } }, "deleteFileStorageLabelServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "deleteFileStorageLabelLabelKey": { "name": "label-key", "in": "path", "description": "The key of the label.", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageLabelKey" } }, "modifyFileStorageLabelServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "modifyFileStorageLabelLabelKey": { "name": "label-key", "in": "path", "description": "The key of the label.", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageLabelKey" } }, "getFileStorageCurrentStateServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/fileStorageEntityUUID" } }, "getDatabaseTypeServiceTypeName": { "name": "service-type-name", "in": "path", "description": "Service type parameter", "required": true, "schema": { "$ref": "#/components/schemas/databaseServiceType" } }, "listDatabasesLimit": { "name": "limit", "in": "query", "description": "Number of entries to receive at most.", "required": false, "schema": { "$ref": "#/components/schemas/databaseQueryParamLimit" } }, "listDatabasesOffset": { "name": "offset", "in": "query", "description": "Offset for retrieved results.", "required": false, "schema": { "$ref": "#/components/schemas/databaseQueryParamOffset" } }, "listDatabasesSort": { "name": "sort", "in": "query", "description": "Sort results by the specified field. Prefix with '-' for descending order. Supported fields: `created_at`, `name` (service hostname), `operational_state` (service status), `zone` (location).", "required": false, "schema": { "$ref": "#/components/schemas/databaseQueryParamSort" } }, "getDatabaseUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "deleteDatabaseUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "modifyDatabaseUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "modifyDatabaseTypeUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "cloneDatabaseUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "listDatabaseNetworksUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "createDatabaseNetworkUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseNetworkUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseNetworkNetworkName": { "name": "network-name", "in": "path", "description": "Network UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "deleteDatabaseNetworkUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "deleteDatabaseNetworkNetworkName": { "name": "network-name", "in": "path", "description": "Network UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "upgradeDatabaseUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "listDatabaseLabelsUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "createDatabaseLabelUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseLabelUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseLabelLabelKey": { "name": "label-key", "in": "path", "description": "Label ID", "required": true, "schema": { "$ref": "#/components/schemas/databaseLabelKey" } }, "deleteDatabaseLabelUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "deleteDatabaseLabelLabelKey": { "name": "label-key", "in": "path", "description": "Label ID", "required": true, "schema": { "$ref": "#/components/schemas/databaseLabelKey" } }, "modifyDatabaseLabelUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "modifyDatabaseLabelLabelKey": { "name": "label-key", "in": "path", "description": "Label ID", "required": true, "schema": { "$ref": "#/components/schemas/databaseLabelKey" } }, "getDatabaseAvailableExtensionsUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseAccessControlUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "modifyDatabaseAccessControlUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseSecurityUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "modifyDatabaseSecurityAdminUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "enableDatabaseSecurityAdminUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseIntegrationEndpointIntegrationUuid": { "name": "integration-uuid", "in": "path", "description": "Integration UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseIntegrationUUID" } }, "deleteDatabaseIntegrationEndpointIntegrationUuid": { "name": "integration-uuid", "in": "path", "description": "Integration UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseIntegrationUUID" } }, "modifyDatabaseIntegrationEndpointIntegrationUuid": { "name": "integration-uuid", "in": "path", "description": "Integration UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseIntegrationUUID" } }, "getDatabaseStatusUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseVersionsUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "startDatabaseManualMaintenanceUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "enableDatabaseTemporaryWritesUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseMigrationStatusUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseAlertsUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseMetricsUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseQueryStatisticsUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseQueryStatisticsLimit": { "name": "limit", "in": "query", "description": "Number of entries to receive at most.", "required": false, "schema": { "$ref": "#/components/schemas/databaseQueryParamLimit" } }, "getDatabaseQueryStatisticsOffset": { "name": "offset", "in": "query", "description": "Offset for retrieved results.", "required": false, "schema": { "$ref": "#/components/schemas/databaseQueryParamOffset" } }, "getDatabaseQueryStatisticsOrder": { "name": "order", "in": "query", "description": "Sort order", "required": false, "schema": { "$ref": "#/components/schemas/databaseQueryParamOrder" } }, "getDatabaseLogsUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseLogsLimit": { "name": "limit", "in": "query", "description": "Number of entries to receive at most.", "required": false, "schema": { "$ref": "#/components/schemas/databaseQueryParamLimit" } }, "getDatabaseLogsOffset": { "name": "offset", "in": "query", "description": "Offset for retrieved results.", "required": false, "schema": { "$ref": "#/components/schemas/databaseQueryParamOffset" } }, "getDatabaseLogsOrder": { "name": "order", "in": "query", "description": "Sort order", "required": false, "schema": { "$ref": "#/components/schemas/databaseQueryParamOrder" } }, "listDatabaseConnectionPoolsUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "listDatabaseConnectionPoolsSort": { "name": "sort", "in": "query", "description": "Order of returned results.", "required": false, "schema": { "$ref": "#/components/schemas/databaseQueryParamOrder" } }, "createDatabaseConnectionPoolUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseConnectionPoolUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseConnectionPoolPoolName": { "name": "pool-name", "in": "path", "description": "Connection Pool Name", "required": true, "schema": { "$ref": "#/components/schemas/databaseTitle" } }, "deleteDatabaseConnectionPoolUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "deleteDatabaseConnectionPoolPoolName": { "name": "pool-name", "in": "path", "description": "Connection Pool Name", "required": true, "schema": { "$ref": "#/components/schemas/databaseTitle" } }, "modifyDatabaseConnectionPoolUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "modifyDatabaseConnectionPoolPoolName": { "name": "pool-name", "in": "path", "description": "Connection Pool Name", "required": true, "schema": { "$ref": "#/components/schemas/databaseTitle" } }, "listDatabaseIndicesUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "deleteDatabaseIndexUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "deleteDatabaseIndexIndexName": { "name": "index-name", "in": "path", "description": "OpenSearch Index Name", "required": true, "schema": { "$ref": "#/components/schemas/databaseTitle" } }, "listDatabaseIntegrationsUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "createDatabaseIntegrationUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseIntegrationUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseIntegrationIntegrationUuid": { "name": "integration-uuid", "in": "path", "description": "Integration UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseIntegrationUUID" } }, "deleteDatabaseIntegrationUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "deleteDatabaseIntegrationIntegrationUuid": { "name": "integration-uuid", "in": "path", "description": "Integration UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseIntegrationUUID" } }, "modifyDatabaseIntegrationUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "modifyDatabaseIntegrationIntegrationUuid": { "name": "integration-uuid", "in": "path", "description": "Integration UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseIntegrationUUID" } }, "listDatabaseLogicalDatabasesUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "createDatabaseLogicalDatabaseUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "deleteDatabaseLogicalDatabaseUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "deleteDatabaseLogicalDatabaseDatabaseName": { "name": "database-name", "in": "path", "description": "Database name", "required": true, "schema": { "$ref": "#/components/schemas/databaseTitle" } }, "getDatabasePeeringsStatusUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseSessionsUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseSessionsLimit": { "name": "limit", "in": "query", "description": "Number of entries to receive at most.", "required": false, "schema": { "$ref": "#/components/schemas/databaseQueryParamLimit" } }, "getDatabaseSessionsOffset": { "name": "offset", "in": "query", "description": "Offset for retrieved results.", "required": false, "schema": { "$ref": "#/components/schemas/databaseQueryParamOffset" } }, "getDatabaseSessionsOrder": { "name": "order", "in": "query", "description": "Sort order", "required": false, "schema": { "$ref": "#/components/schemas/databaseQueryParamOrder" } }, "terminateDatabaseSessionUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "terminateDatabaseSessionPid": { "name": "pid", "in": "path", "description": "Session PID", "required": true, "schema": { "$ref": "#/components/schemas/databaseId" } }, "createDatabaseTaskUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseTaskUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseTaskTaskId": { "name": "task-id", "in": "path", "description": "Task ID", "required": true, "schema": { "$ref": "#/components/schemas/databaseId" } }, "listDatabaseUsersUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "createDatabaseUserUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseUserUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "getDatabaseUserUsername": { "name": "username", "in": "path", "description": "Username identifier", "required": true, "schema": { "$ref": "#/components/schemas/databaseTitle" } }, "deleteDatabaseUserUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "deleteDatabaseUserUsername": { "name": "username", "in": "path", "description": "Username identifier", "required": true, "schema": { "$ref": "#/components/schemas/databaseTitle" } }, "modifyDatabaseUserUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "modifyDatabaseUserUsername": { "name": "username", "in": "path", "description": "Username identifier", "required": true, "schema": { "$ref": "#/components/schemas/databaseTitle" } }, "modifyDatabaseUserAccessControlUuid": { "name": "uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/databaseUuid" } }, "modifyDatabaseUserAccessControlUsername": { "name": "username", "in": "path", "description": "Username identifier", "required": true, "schema": { "$ref": "#/components/schemas/databaseTitle" } }, "listGatewayPlansLimit": { "name": "limit", "in": "query", "description": "Number of entries to receive at most.", "required": false, "schema": { "$ref": "#/components/schemas/gatewayQueryParamLimit" } }, "listGatewayPlansOffset": { "name": "offset", "in": "query", "description": "Offset for retrieved results.", "required": false, "schema": { "$ref": "#/components/schemas/gatewayQueryParamOffset" } }, "getGatewayPlanPlanName": { "name": "plan-name", "in": "path", "description": "Plan identifier", "required": true, "schema": { "$ref": "#/components/schemas/gatewayName" } }, "listGatewayServicesLimit": { "name": "limit", "in": "query", "description": "Number of entries to receive at most.", "required": false, "schema": { "$ref": "#/components/schemas/gatewayQueryParamLimit" } }, "listGatewayServicesOffset": { "name": "offset", "in": "query", "description": "Offset for retrieved results.", "required": false, "schema": { "$ref": "#/components/schemas/gatewayQueryParamOffset" } }, "listGatewayServicesSort": { "name": "sort", "in": "query", "description": "Sort resources by field. Prefix with '-' for descending order.", "required": false, "schema": { "$ref": "#/components/schemas/gatewayQueryParamSortServices" } }, "getGatewayServiceServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "replaceGatewayServiceServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "deleteGatewayServiceServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "modifyGatewayServiceServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "flushGatewayNatServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "listGatewayConnectionsServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "createGatewayConnectionServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "getGatewayConnectionServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "getGatewayConnectionConnectionUuid": { "name": "connection-uuid", "in": "path", "description": "Connection UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "deleteGatewayConnectionServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "deleteGatewayConnectionConnectionUuid": { "name": "connection-uuid", "in": "path", "description": "Connection UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "modifyGatewayConnectionServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "modifyGatewayConnectionConnectionUuid": { "name": "connection-uuid", "in": "path", "description": "Connection UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "listGatewayTunnelsServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "listGatewayTunnelsConnectionUuid": { "name": "connection-uuid", "in": "path", "description": "Connection UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "createGatewayTunnelServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "createGatewayTunnelConnectionUuid": { "name": "connection-uuid", "in": "path", "description": "Connection UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "getGatewayTunnelServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "getGatewayTunnelConnectionUuid": { "name": "connection-uuid", "in": "path", "description": "Connection UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "getGatewayTunnelTunnelUuid": { "name": "tunnel-uuid", "in": "path", "description": "Tunnel UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "deleteGatewayTunnelServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "deleteGatewayTunnelConnectionUuid": { "name": "connection-uuid", "in": "path", "description": "Connection UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "deleteGatewayTunnelTunnelUuid": { "name": "tunnel-uuid", "in": "path", "description": "Tunnel UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "modifyGatewayTunnelServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "modifyGatewayTunnelConnectionUuid": { "name": "connection-uuid", "in": "path", "description": "Connection UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "modifyGatewayTunnelTunnelUuid": { "name": "tunnel-uuid", "in": "path", "description": "Tunnel UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "listGatewayServiceLabelsServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "createGatewayServiceLabelServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "getGatewayServiceLabelServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "getGatewayServiceLabelLabelKey": { "name": "label-key", "in": "path", "description": "Label identifier", "required": true, "schema": { "$ref": "#/components/schemas/gatewayLabelKey" } }, "deleteGatewayServiceLabelServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "deleteGatewayServiceLabelLabelKey": { "name": "label-key", "in": "path", "description": "Label identifier", "required": true, "schema": { "$ref": "#/components/schemas/gatewayLabelKey" } }, "modifyGatewayServiceLabelServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "modifyGatewayServiceLabelLabelKey": { "name": "label-key", "in": "path", "description": "Label identifier", "required": true, "schema": { "$ref": "#/components/schemas/gatewayLabelKey" } }, "listGatewayAddressesServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "getGatewayAddressServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "getGatewayAddressAddressName": { "name": "address-name", "in": "path", "description": "Address identifier", "required": true, "schema": { "$ref": "#/components/schemas/gatewayName" } }, "modifyGatewayAddressServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "modifyGatewayAddressAddressName": { "name": "address-name", "in": "path", "description": "Address identifier", "required": true, "schema": { "$ref": "#/components/schemas/gatewayName" } }, "releaseGatewayFloatingIpServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "releaseGatewayFloatingIpAddressName": { "name": "address-name", "in": "path", "description": "Address identifier", "required": true, "schema": { "$ref": "#/components/schemas/gatewayName" } }, "getGatewayMetricsServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "createGatewayServiceLogSessionServiceUuid": { "name": "service-uuid", "in": "path", "description": "Service UUID", "required": true, "schema": { "$ref": "#/components/schemas/gatewayUuid" } }, "listLoadBalancersLimit": { "name": "limit", "in": "query", "description": "Number of entries to receive at most.", "required": false, "schema": { "$ref": "#/components/schemas/loadBalancerLimitParameter" } }, "listLoadBalancersOffset": { "name": "offset", "in": "query", "description": "Offset for retrieved results.", "required": false, "schema": { "$ref": "#/components/schemas/loadBalancerOffsetParameter" } }, "listLoadBalancersSort": { "name": "sort", "in": "query", "description": "Sort resources by field. Prefix with '-' for descending order.", "required": false, "schema": { "$ref": "#/components/schemas/loadBalancerSortServicesParameter" } }, "listLoadBalancersLabel": { "name": "label", "in": "query", "description": "Filter resources by label. Can be provided multiple times for multiple labels. Format: 'key=value' for exact match or 'key' for existence check.", "required": false, "schema": { "$ref": "#/components/schemas/loadBalancerLabelFilterParameter" } }, "getLoadBalancerServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "replaceLoadBalancerServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "deleteLoadBalancerServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "modifyLoadBalancerServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "listLoadBalancerFrontendsServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "createLoadBalancerFrontendServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "getLoadBalancerFrontendServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "getLoadBalancerFrontendFrontendName": { "name": "frontend-name", "in": "path", "description": "The unique identifier for the frontend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerFrontendParameter" } }, "deleteLoadBalancerFrontendServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "deleteLoadBalancerFrontendFrontendName": { "name": "frontend-name", "in": "path", "description": "The unique identifier for the frontend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerFrontendParameter" } }, "modifyLoadBalancerFrontendServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "modifyLoadBalancerFrontendFrontendName": { "name": "frontend-name", "in": "path", "description": "The unique identifier for the frontend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerFrontendParameter" } }, "listLoadBalancerFrontendTlsConfigsServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "listLoadBalancerFrontendTlsConfigsFrontendName": { "name": "frontend-name", "in": "path", "description": "The unique identifier for the frontend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerFrontendParameter" } }, "createLoadBalancerFrontendTlsConfigServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "createLoadBalancerFrontendTlsConfigFrontendName": { "name": "frontend-name", "in": "path", "description": "The unique identifier for the frontend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerFrontendParameter" } }, "getLoadBalancerFrontendTlsConfigServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "getLoadBalancerFrontendTlsConfigFrontendName": { "name": "frontend-name", "in": "path", "description": "The unique identifier for the frontend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerFrontendParameter" } }, "getLoadBalancerFrontendTlsConfigTlsConfigName": { "name": "tls-config-name", "in": "path", "description": "The unique identifier for the TLS configuration.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerTlsConfigParameter" } }, "deleteLoadBalancerFrontendTlsConfigServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "deleteLoadBalancerFrontendTlsConfigFrontendName": { "name": "frontend-name", "in": "path", "description": "The unique identifier for the frontend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerFrontendParameter" } }, "deleteLoadBalancerFrontendTlsConfigTlsConfigName": { "name": "tls-config-name", "in": "path", "description": "The unique identifier for the TLS configuration.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerTlsConfigParameter" } }, "modifyLoadBalancerFrontendTlsConfigServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "modifyLoadBalancerFrontendTlsConfigFrontendName": { "name": "frontend-name", "in": "path", "description": "The unique identifier for the frontend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerFrontendParameter" } }, "modifyLoadBalancerFrontendTlsConfigTlsConfigName": { "name": "tls-config-name", "in": "path", "description": "The unique identifier for the TLS configuration.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerTlsConfigParameter" } }, "listLoadBalancerRulesServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "listLoadBalancerRulesFrontendName": { "name": "frontend-name", "in": "path", "description": "The unique identifier for the frontend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerFrontendParameter" } }, "createLoadBalancerRuleServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "createLoadBalancerRuleFrontendName": { "name": "frontend-name", "in": "path", "description": "The unique identifier for the frontend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerFrontendParameter" } }, "getLoadBalancerRuleServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "getLoadBalancerRuleFrontendName": { "name": "frontend-name", "in": "path", "description": "The unique identifier for the frontend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerFrontendParameter" } }, "getLoadBalancerRuleRuleName": { "name": "rule-name", "in": "path", "description": "The unique identifier for the rule.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerRuleParameter" } }, "replaceLoadBalancerRuleServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "replaceLoadBalancerRuleFrontendName": { "name": "frontend-name", "in": "path", "description": "The unique identifier for the frontend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerFrontendParameter" } }, "replaceLoadBalancerRuleRuleName": { "name": "rule-name", "in": "path", "description": "The unique identifier for the rule.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerRuleParameter" } }, "deleteLoadBalancerRuleServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "deleteLoadBalancerRuleFrontendName": { "name": "frontend-name", "in": "path", "description": "The unique identifier for the frontend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerFrontendParameter" } }, "deleteLoadBalancerRuleRuleName": { "name": "rule-name", "in": "path", "description": "The unique identifier for the rule.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerRuleParameter" } }, "modifyLoadBalancerRuleServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "modifyLoadBalancerRuleFrontendName": { "name": "frontend-name", "in": "path", "description": "The unique identifier for the frontend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerFrontendParameter" } }, "modifyLoadBalancerRuleRuleName": { "name": "rule-name", "in": "path", "description": "The unique identifier for the rule.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerRuleParameter" } }, "listLoadBalancerBackendsServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "createLoadBalancerBackendServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "getLoadBalancerBackendServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "getLoadBalancerBackendBackendName": { "name": "backend-name", "in": "path", "description": "The unique identifier for the backend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerBackendParameter" } }, "deleteLoadBalancerBackendServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "deleteLoadBalancerBackendBackendName": { "name": "backend-name", "in": "path", "description": "The unique identifier for the backend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerBackendParameter" } }, "modifyLoadBalancerBackendServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "modifyLoadBalancerBackendBackendName": { "name": "backend-name", "in": "path", "description": "The unique identifier for the backend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerBackendParameter" } }, "listLoadBalancerMembersServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "listLoadBalancerMembersBackendName": { "name": "backend-name", "in": "path", "description": "The unique identifier for the backend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerBackendParameter" } }, "createLoadBalancerMemberServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "createLoadBalancerMemberBackendName": { "name": "backend-name", "in": "path", "description": "The unique identifier for the backend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerBackendParameter" } }, "getLoadBalancerMemberServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "getLoadBalancerMemberBackendName": { "name": "backend-name", "in": "path", "description": "The unique identifier for the backend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerBackendParameter" } }, "getLoadBalancerMemberMemberName": { "name": "member-name", "in": "path", "description": "The unique identifier for the member.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerMemberParameter" } }, "deleteLoadBalancerMemberServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "deleteLoadBalancerMemberBackendName": { "name": "backend-name", "in": "path", "description": "The unique identifier for the backend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerBackendParameter" } }, "deleteLoadBalancerMemberMemberName": { "name": "member-name", "in": "path", "description": "The unique identifier for the member.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerMemberParameter" } }, "modifyLoadBalancerMemberServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "modifyLoadBalancerMemberBackendName": { "name": "backend-name", "in": "path", "description": "The unique identifier for the backend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerBackendParameter" } }, "modifyLoadBalancerMemberMemberName": { "name": "member-name", "in": "path", "description": "The unique identifier for the member.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerMemberParameter" } }, "listLoadBalancerBackendTlsConfigsServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "listLoadBalancerBackendTlsConfigsBackendName": { "name": "backend-name", "in": "path", "description": "The unique identifier for the backend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerBackendParameter" } }, "createLoadBalancerBackendTlsConfigServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "createLoadBalancerBackendTlsConfigBackendName": { "name": "backend-name", "in": "path", "description": "The unique identifier for the backend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerBackendParameter" } }, "getLoadBalancerBackendTlsConfigServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "getLoadBalancerBackendTlsConfigBackendName": { "name": "backend-name", "in": "path", "description": "The unique identifier for the backend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerBackendParameter" } }, "getLoadBalancerBackendTlsConfigTlsConfigName": { "name": "tls-config-name", "in": "path", "description": "The unique identifier for the TLS configuration.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerTlsConfigParameter" } }, "deleteLoadBalancerBackendTlsConfigServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "deleteLoadBalancerBackendTlsConfigBackendName": { "name": "backend-name", "in": "path", "description": "The unique identifier for the backend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerBackendParameter" } }, "deleteLoadBalancerBackendTlsConfigTlsConfigName": { "name": "tls-config-name", "in": "path", "description": "The unique identifier for the TLS configuration.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerTlsConfigParameter" } }, "modifyLoadBalancerBackendTlsConfigServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "modifyLoadBalancerBackendTlsConfigBackendName": { "name": "backend-name", "in": "path", "description": "The unique identifier for the backend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerBackendParameter" } }, "modifyLoadBalancerBackendTlsConfigTlsConfigName": { "name": "tls-config-name", "in": "path", "description": "The unique identifier for the TLS configuration.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerTlsConfigParameter" } }, "modifyLoadBalancerNetworkServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "modifyLoadBalancerNetworkNetworkName": { "name": "network-name", "in": "path", "description": "The unique identifier for the network.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerNetworkParameter" } }, "listLoadBalancerIpAddressesServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "createLoadBalancerIpAddressServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "getLoadBalancerIpAddressServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "getLoadBalancerIpAddressIpAddress": { "name": "ip-address", "in": "path", "description": "The unique identifier for the IP address.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerIpAddressParameter" } }, "deleteLoadBalancerIpAddressServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "deleteLoadBalancerIpAddressIpAddress": { "name": "ip-address", "in": "path", "description": "The unique identifier for the IP address.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerIpAddressParameter" } }, "listLoadBalancerResolversServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "createLoadBalancerResolverServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "getLoadBalancerResolverServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "getLoadBalancerResolverResolverName": { "name": "resolver-name", "in": "path", "description": "The unique identifier for the resolver.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerResolverParameter" } }, "deleteLoadBalancerResolverServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "deleteLoadBalancerResolverResolverName": { "name": "resolver-name", "in": "path", "description": "The unique identifier for the resolver.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerResolverParameter" } }, "modifyLoadBalancerResolverServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "modifyLoadBalancerResolverResolverName": { "name": "resolver-name", "in": "path", "description": "The unique identifier for the resolver.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerResolverParameter" } }, "listLoadBalancerLabelsServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "createLoadBalancerLabelServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "getLoadBalancerLabelServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "getLoadBalancerLabelLabelKey": { "name": "label-key", "in": "path", "description": "The unique identifier for the label.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerLabelParameter" } }, "deleteLoadBalancerLabelServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "deleteLoadBalancerLabelLabelKey": { "name": "label-key", "in": "path", "description": "The unique identifier for the label.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerLabelParameter" } }, "modifyLoadBalancerLabelServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "modifyLoadBalancerLabelLabelKey": { "name": "label-key", "in": "path", "description": "The unique identifier for the label.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerLabelParameter" } }, "getLoadBalancerMetricsServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "getLoadBalancerMetricsSeriesServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "getLoadBalancerFrontendCombinedMetricsSeriesServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "getLoadBalancerFrontendCombinedMetricsSeriesSort": { "name": "sort", "in": "query", "description": "Sort metrics by field. Prefix with '-' for descending order.", "required": false, "schema": { "$ref": "#/components/schemas/loadBalancerMetricsSortParameter" } }, "getLoadBalancerFrontendMetricsSeriesServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "getLoadBalancerFrontendMetricsSeriesFrontendName": { "name": "frontend-name", "in": "path", "description": "The unique identifier for the frontend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerFrontendParameter" } }, "getLoadBalancerFrontendMetricsSeriesSort": { "name": "sort", "in": "query", "description": "Sort metrics by field. Prefix with '-' for descending order.", "required": false, "schema": { "$ref": "#/components/schemas/loadBalancerMetricsSortParameter" } }, "getLoadBalancerBackendCombinedMetricsSeriesServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "getLoadBalancerBackendCombinedMetricsSeriesSort": { "name": "sort", "in": "query", "description": "Sort metrics by field. Prefix with '-' for descending order.", "required": false, "schema": { "$ref": "#/components/schemas/loadBalancerMetricsSortParameter" } }, "getLoadBalancerBackendMetricsSeriesServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "getLoadBalancerBackendMetricsSeriesBackendName": { "name": "backend-name", "in": "path", "description": "The unique identifier for the backend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerBackendParameter" } }, "getLoadBalancerBackendMetricsSeriesSort": { "name": "sort", "in": "query", "description": "Sort metrics by field. Prefix with '-' for descending order.", "required": false, "schema": { "$ref": "#/components/schemas/loadBalancerMetricsSortParameter" } }, "getLoadBalancerMemberCombinedMetricsSeriesServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "getLoadBalancerMemberCombinedMetricsSeriesBackendName": { "name": "backend-name", "in": "path", "description": "The unique identifier for the backend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerBackendParameter" } }, "getLoadBalancerMemberCombinedMetricsSeriesSort": { "name": "sort", "in": "query", "description": "Sort metrics by field. Prefix with '-' for descending order.", "required": false, "schema": { "$ref": "#/components/schemas/loadBalancerMetricsSortParameter" } }, "getLoadBalancerMemberMetricsSeriesServiceUuid": { "name": "service-uuid", "in": "path", "description": "The unique identifier for the service.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerServiceParameter" } }, "getLoadBalancerMemberMetricsSeriesBackendName": { "name": "backend-name", "in": "path", "description": "The unique identifier for the backend.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerBackendParameter" } }, "getLoadBalancerMemberMetricsSeriesMemberName": { "name": "member-name", "in": "path", "description": "The unique identifier for the member.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerMemberParameter" } }, "getLoadBalancerMemberMetricsSeriesSort": { "name": "sort", "in": "query", "description": "Sort metrics by field. Prefix with '-' for descending order.", "required": false, "schema": { "$ref": "#/components/schemas/loadBalancerMetricsSortParameter" } }, "listLoadBalancerCertificateBundlesLimit": { "name": "limit", "in": "query", "description": "Number of entries to receive at most.", "required": false, "schema": { "$ref": "#/components/schemas/loadBalancerLimitParameter" } }, "listLoadBalancerCertificateBundlesOffset": { "name": "offset", "in": "query", "description": "Offset for retrieved results.", "required": false, "schema": { "$ref": "#/components/schemas/loadBalancerOffsetParameter" } }, "listLoadBalancerCertificateBundlesLabel": { "name": "label", "in": "query", "description": "Filter resources by label. Can be provided multiple times for multiple labels. Format: 'key=value' for exact match or 'key' for existence check.", "required": false, "schema": { "$ref": "#/components/schemas/loadBalancerLabelFilterParameter" } }, "getLoadBalancerCertificateBundleBundleUuid": { "name": "bundle-uuid", "in": "path", "description": "The unique identifier for the certificate bundle.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerCertificateBundleParameter" } }, "deleteLoadBalancerCertificateBundleBundleUuid": { "name": "bundle-uuid", "in": "path", "description": "The unique identifier for the certificate bundle.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerCertificateBundleParameter" } }, "modifyLoadBalancerCertificateBundleBundleUuid": { "name": "bundle-uuid", "in": "path", "description": "The unique identifier for the certificate bundle.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerCertificateBundleParameter" } }, "listLoadBalancerCertificateBundleLabelsBundleUuid": { "name": "bundle-uuid", "in": "path", "description": "The unique identifier for the certificate bundle.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerCertificateBundleParameter" } }, "createLoadBalancerCertificateBundleLabelBundleUuid": { "name": "bundle-uuid", "in": "path", "description": "The unique identifier for the certificate bundle.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerCertificateBundleParameter" } }, "getLoadBalancerCertificateBundleLabelBundleUuid": { "name": "bundle-uuid", "in": "path", "description": "The unique identifier for the certificate bundle.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerCertificateBundleParameter" } }, "getLoadBalancerCertificateBundleLabelLabelKey": { "name": "label-key", "in": "path", "description": "The unique identifier for the label.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerLabelParameter" } }, "deleteLoadBalancerCertificateBundleLabelBundleUuid": { "name": "bundle-uuid", "in": "path", "description": "The unique identifier for the certificate bundle.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerCertificateBundleParameter" } }, "deleteLoadBalancerCertificateBundleLabelLabelKey": { "name": "label-key", "in": "path", "description": "The unique identifier for the label.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerLabelParameter" } }, "modifyLoadBalancerCertificateBundleLabelBundleUuid": { "name": "bundle-uuid", "in": "path", "description": "The unique identifier for the certificate bundle.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerCertificateBundleParameter" } }, "modifyLoadBalancerCertificateBundleLabelLabelKey": { "name": "label-key", "in": "path", "description": "The unique identifier for the label.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerLabelParameter" } }, "listLoadBalancerPlansLimit": { "name": "limit", "in": "query", "description": "Number of entries to receive at most.", "required": false, "schema": { "$ref": "#/components/schemas/loadBalancerLimitParameter" } }, "listLoadBalancerPlansOffset": { "name": "offset", "in": "query", "description": "Offset for retrieved results.", "required": false, "schema": { "$ref": "#/components/schemas/loadBalancerOffsetParameter" } }, "getLoadBalancerPlanPlanName": { "name": "plan-name", "in": "path", "description": "The unique identifier for the plan.", "required": true, "schema": { "$ref": "#/components/schemas/loadBalancerPlanParameter" } }, "listFirewallRulesetsLimit": { "name": "limit", "in": "query", "description": "Number of entries to receive at most.", "required": false, "schema": { "$ref": "#/components/schemas/firewallRulesetQueryParamLimit" } }, "listFirewallRulesetsOffset": { "name": "offset", "in": "query", "description": "Offset for retrieved results.", "required": false, "schema": { "$ref": "#/components/schemas/firewallRulesetQueryParamOffset" } }, "listFirewallRulesetsSort": { "name": "sort", "in": "query", "description": "Order of returned results.", "required": false, "schema": { "$ref": "#/components/schemas/firewallRulesetQueryParamSort" } }, "getFirewallRulesetRulesetUuid": { "name": "ruleset-uuid", "in": "path", "description": "Firewall ruleset UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "deleteFirewallRulesetRulesetUuid": { "name": "ruleset-uuid", "in": "path", "description": "Firewall ruleset UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "modifyFirewallRulesetRulesetUuid": { "name": "ruleset-uuid", "in": "path", "description": "Firewall ruleset UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "restoreFirewallRulesetRulesetUuid": { "name": "ruleset-uuid", "in": "path", "description": "Firewall ruleset UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "restoreFirewallRulesetRulesetVersion": { "name": "ruleset-version", "in": "path", "description": "Firewall ruleset version", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetVersion" } }, "listFirewallRulesetRulesRulesetUuid": { "name": "ruleset-uuid", "in": "path", "description": "Firewall ruleset UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "listFirewallRulesetRulesLimit": { "name": "limit", "in": "query", "description": "Number of entries to receive at most.", "required": false, "schema": { "$ref": "#/components/schemas/firewallRulesetQueryParamLimit" } }, "listFirewallRulesetRulesOffset": { "name": "offset", "in": "query", "description": "Offset for retrieved results.", "required": false, "schema": { "$ref": "#/components/schemas/firewallRulesetQueryParamOffset" } }, "listFirewallRulesetRulesSort": { "name": "sort", "in": "query", "description": "Order of returned results.", "required": false, "schema": { "$ref": "#/components/schemas/firewallRulesetQueryParamSort" } }, "createMultipleFirewallRulesetRuleRulesetUuid": { "name": "ruleset-uuid", "in": "path", "description": "Firewall ruleset UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "createFirewallRulesetRuleRulesetUuid": { "name": "ruleset-uuid", "in": "path", "description": "Firewall ruleset UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "getFirewallRulesetRuleRulesetUuid": { "name": "ruleset-uuid", "in": "path", "description": "Firewall ruleset UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "getFirewallRulesetRuleRuleId": { "name": "rule-id", "in": "path", "description": "Firewall ruleset rule UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "deleteFirewallRulesetRuleRulesetUuid": { "name": "ruleset-uuid", "in": "path", "description": "Firewall ruleset UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "deleteFirewallRulesetRuleRuleId": { "name": "rule-id", "in": "path", "description": "Firewall ruleset rule UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "modifyFirewallRulesetRuleRulesetUuid": { "name": "ruleset-uuid", "in": "path", "description": "Firewall ruleset UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "modifyFirewallRulesetRuleRuleId": { "name": "rule-id", "in": "path", "description": "Firewall ruleset rule UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "listFirewallRulesetLabelsRulesetUuid": { "name": "ruleset-uuid", "in": "path", "description": "Firewall ruleset UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "createFirewallRulesetLabelRulesetUuid": { "name": "ruleset-uuid", "in": "path", "description": "Firewall ruleset UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "listFirewallRulesetAttachedServersRulesetUuid": { "name": "ruleset-uuid", "in": "path", "description": "Firewall ruleset UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "getFirewallRulesetLabelRulesetUuid": { "name": "ruleset-uuid", "in": "path", "description": "Firewall ruleset UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "getFirewallRulesetLabelLabelKey": { "name": "label-key", "in": "path", "description": "The key of the label.", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetLabelKey" } }, "deleteFirewallRulesetLabelRulesetUuid": { "name": "ruleset-uuid", "in": "path", "description": "Firewall ruleset UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "deleteFirewallRulesetLabelLabelKey": { "name": "label-key", "in": "path", "description": "The key of the label.", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetLabelKey" } }, "modifyFirewallRulesetLabelRulesetUuid": { "name": "ruleset-uuid", "in": "path", "description": "Firewall ruleset UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "modifyFirewallRulesetLabelLabelKey": { "name": "label-key", "in": "path", "description": "The key of the label.", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetLabelKey" } }, "firewallRulesetListServerFirewallRuleServerUuid": { "name": "server-uuid", "in": "path", "description": "Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "firewallRulesetListServerFirewallRuleLimit": { "name": "limit", "in": "query", "description": "Number of entries to receive at most.", "required": false, "schema": { "$ref": "#/components/schemas/firewallRulesetQueryParamLimit" } }, "firewallRulesetListServerFirewallRuleOffset": { "name": "offset", "in": "query", "description": "Offset for retrieved results.", "required": false, "schema": { "$ref": "#/components/schemas/firewallRulesetQueryParamOffset" } }, "firewallRulesetListServerFirewallRuleSort": { "name": "sort", "in": "query", "description": "Order of returned results.", "required": false, "schema": { "$ref": "#/components/schemas/firewallRulesetQueryParamSort" } }, "firewallRulesetCreateMultipleServerFirewallRulesServerUuid": { "name": "server-uuid", "in": "path", "description": "Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "firewallRulesetCreateServerFirewallRuleServerUuid": { "name": "server-uuid", "in": "path", "description": "Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "firewallRulesetGetServerFirewallRuleServerUuid": { "name": "server-uuid", "in": "path", "description": "Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "firewallRulesetGetServerFirewallRulePosition": { "name": "position", "in": "path", "description": "Server firewall rule position", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerFirewallRulePosition" } }, "firewallRulesetDeleteServerFirewallRuleServerUuid": { "name": "server-uuid", "in": "path", "description": "Server UUID", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerUuid" } }, "firewallRulesetDeleteServerFirewallRulePosition": { "name": "position", "in": "path", "description": "Server firewall rule position", "required": true, "schema": { "$ref": "#/components/schemas/firewallRulesetServerFirewallRulePosition" } }, "listZoneVLANsZone": { "name": "zone", "in": "path", "description": "The zone identifier.", "required": true, "schema": { "$ref": "#/components/schemas/zone" } } }, "requestBodies": { "createSubaccount": { "description": "Subaccount details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createSubaccountRequest" } } } }, "kubernetesPostCluster": { "description": "postCluster requestBody", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesCluster" }, "example": { "control_plane_ip_filter": [ "1.2.3.0/24", "1.1.1.1" ], "name": "example-cluster", "network": "33333333-3333-3333-333333333333", "network_cidr": "172.16.0.0/24", "labels": [ { "key": "env", "value": "prod" }, { "key": "app", "value": "cats-dating-app" } ], "node_groups": [ { "count": 4, "kubelet_args": [ { "key": "log-flush-frequency", "value": "5s" } ], "labels": [ { "key": "managedBy", "value": "exampleDevelopmentTeam" }, { "key": "environment", "value": "development" } ], "name": "small", "plan": "K8S-2xCPU-4GB", "ssh_keys": [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV" ], "storage": "01000000-0000-4000-8000-000160010100", "taints": [ { "effect": "NoSchedule", "key": "environment", "value": "development" } ] }, { "count": 8, "kubelet_args": [ { "key": "log-flush-frequency", "value": "15s" } ], "labels": [ { "key": "managedBy", "value": "exampleStagingTeam" }, { "key": "environment", "value": "staging" } ], "name": "medium", "plan": "K8S-4xCPU-8GB", "ssh_keys": [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV" ], "storage": "01000000-0000-4000-8000-000160010100", "taints": [ { "effect": "NoSchedule", "key": "environment", "value": "staging" } ] } ], "zone": "de-fra1" } } } }, "kubernetesPatchCluster": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesClusterPatch" }, "example": { "control_plane_ip_filter": [ "1.2.3.0/24", "1.1.1.1" ], "labels": [ { "key": "env", "value": "prod" }, { "key": "app", "value": "cats-dating-app" } ] } } } }, "kubernetesPatchNodeGroup": { "description": "patchNodeGroup requestBody", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesNodeGroupPatch" }, "example": { "count": 16 } } } }, "kubernetesPostNodeGroup": { "description": "postNodeGroup requestBody", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesNodeGroup" }, "example": { "count": 4, "kubelet_args": [ { "key": "log-flush-frequency", "value": "5s" } ], "labels": [ { "key": "managedBy", "value": "exampleDevelopmentTeam" }, { "key": "environment", "value": "development" } ], "name": "small", "plan": "K8S-2xCPU-4GB", "ssh_keys": [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV" ], "storage": "01000000-0000-4000-8000-000160010100", "taints": [ { "effect": "NoSchedule", "key": "environment", "value": "development" } ] } } } }, "kubernetesPostUpgrade": { "description": "postUpgrade request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesClusterAvailableUpgradesPost" }, "example": { "version": "1.31" } } } }, "kubernetesCreateClusterAuthentication": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesAuthenticationIssuerConfig" } } }, "required": true }, "kubernetesSetClusterAuthentication": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesAuthenticationConfiguration" } } }, "required": true }, "kubernetesImportClusterAuthentication": { "content": { "application/yaml": { "schema": { "$ref": "#/components/schemas/kubernetesAuthenticationConfigurationYAML" } } }, "required": true }, "kubernetesUpdateClusterAuthentication": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kubernetesAuthenticationIssuerConfig" } } }, "required": true }, "addIPAddress": { "description": "Attributes for the new IP address.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addIpAddressRequest" } } } }, "bulkModifyIPAddresses": { "description": "List of IP addresses and their attributes to modify.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulkPatchIpAddressesRequestV1.3" } } } }, "modifyIPAddress": { "description": "Attributes to modify for the IP address.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/modifyIpAddressRequestV1.0" } } } }, "patchModifyIPAddress": { "description": "Attributes to modify for the IP address.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patchIpAddressRequestV1.3" } } } }, "createNetworkPeering": { "description": "Attributes for the new network peering.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkPeeringCreate" } } } }, "modifyNetworkPeering": { "description": "Attributes to modify for the network peering.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkPeeringModify" } } } }, "createNetwork": { "description": "Attributes for the new network.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createNetworkRequest" } } } }, "createNetworkInterface": { "description": "Attributes for the new network interface.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkCreateInterfaceRequest" } } } }, "modifyNetwork": { "description": "Attributes to modify for the network.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/modifyNetworkRequest" } } } }, "createPartnerAccount": { "description": "Account to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerCreateAccount" } } } }, "replacePermissions": { "description": "The new set of permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/permission" } } } }, "grantPermission": { "description": "The permission to be granted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/permission" } } } }, "revokePermission": { "description": "The permission to be revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/permission" } } } }, "createRouter": { "description": "Router creation parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routerCreate" } } } }, "modifyRouter": { "description": "Router modification parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routerModify" } } } }, "createServerGroup": { "description": "The server group to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverGroupModify" } } } }, "modifyServerGroup": { "description": "The server group attributes to modify.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverGroupModify" } } } }, "serverGroupAddServerToGroup": { "description": "The server to add to the group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverGroupServerAdd" } } } }, "createServer": { "description": "Cloud Server to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createServer" } } } }, "modifyServer": { "description": "Cloud Server to modify", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/modifyServer" } } } }, "addServerInterface": { "description": "Network interface to add", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverAddInterface" } } } }, "modifyServerInterface": { "description": "Network interface changes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverModifyInterface" } } } }, "addServerInterfaceIpAddress": { "description": "IP address to add", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverAddIpAddress" } } } }, "rebuildServer": { "description": "Cloud Server rebuild details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverRebuild" } } } }, "relocateServer": { "description": "Zone to relocate the Cloud Server to", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/relocateServer" } } } }, "restartServer": { "description": "Cloud Server restart options", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/restartServer" } } } }, "startServer": { "description": "Cloud Server start options", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/startServer" } } } }, "stopServer": { "description": "Cloud Server to stop", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stopServer" } } } }, "serverAttachPrivateFirewallRuleset": { "description": "Private firewall ruleset to attach", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverAttachPrivateFirewallRuleset" } } } }, "serverLoadCDROM": { "description": "Storage to load into the CD-ROM device", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverLoadCdrom" } } } }, "serverDetachPrivateFirewallRuleset": { "description": "Private firewall ruleset to detach", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverDetachPrivateFirewallRuleset" } } } }, "serverUpdateFirewallRules": { "description": "Firewall rules to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverUpdateFirewallRules" } } } }, "serverCreateFirewallRule": { "description": "Firewall rule to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverCreateFirewallRule" } } } }, "serverAttachStorageDevice": { "description": "Storage device to attach", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverAttachStorage" } } } }, "serverDetachStorageDevice": { "description": "Storage device to detach", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverDetachStorage" } } } }, "createStorage": { "description": "Block storage creation parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createStorageRequest" } } } }, "modifyStorage": { "description": "Block storage modification parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/modifyStorageBody" } } } }, "attachStorageToServer": { "description": "Storage attachment parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachStorageRequest" } } } }, "cloneStorage": { "description": "Block storage clone parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloneStorageRequest" } } } }, "createTemplateFromStorage": { "description": "Template creation parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createStorageTemplateRequest" } } } }, "storageCreateOnDemandBackup": { "description": "On-demand backup creation parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createStorageBackupRequest" } } } }, "createTag": { "description": "Tag to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } } }, "modifyTag": { "description": "Tag to modify", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } } }, "accountTokensCreateToken": { "description": "Parameters for creating a new token.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountTokensCreateTokenRequest" } } }, "required": true }, "objectStorage2CreateObjectStorage": { "description": "Creates a new object storage service.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2ServiceCreate" } } } }, "objectStorage2ReplaceObjectStorage": { "description": "Replaces existing object storage service by given {service_uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2ServiceReplace" } } } }, "objectStorage2ModifyObjectStorage": { "description": "Modifies existing object storage service by given {service_uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2ServiceModify" } } } }, "objectStorage2CreateObjectStorageNetwork": { "description": "Creates a new service network by given {service_uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2NetworkCreate" } } } }, "objectStorage2AttachObjectStorageCustomDomain": { "description": "Attaches a new custom domain to the service identified by {service_uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2CustomDomainCreate" } } } }, "objectStorage2ModifyObjectStorageCustomDomain": { "description": "Modifies existing custom domain by given {service_uuid} and {domain_name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2CustomDomainModify" } } } }, "objectStorage2CreateObjectStorageBucket": { "description": "Creates a new service bucket by the given {service_uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2BucketCreate" } } } }, "objectStorage2CreateObjectStorageLabel": { "description": "Creates a new label by given {service_uuid}. Labels are used for service filtering.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2LabelCreate" } } } }, "objectStorage2ModifyObjectStorageLabel": { "description": "Modifies existing label by given {service_uuid} and {key}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2LabelModify" } } } }, "objectStorage2CreateObjectStorageStaticWebsite": { "description": "Creates a new static website hosting configuration for a domain.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2StaticWebsiteConfigCreate" } } } }, "objectStorage2ModifyObjectStorageStaticWebsite": { "description": "Updates an existing static website configuration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2StaticWebsiteConfigModify" } } } }, "objectStorage2CreateObjectStorageUser": { "description": "Creates a new service user by given {service_uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2UserCreate" } } } }, "objectStorage2ModifyObjectStorageAccessKeyDetails": { "description": "Modifies access key details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2AccessKeyModify" } } } }, "objectStorage2AttachObjectStorageUserPolicy": { "description": "Attach a policy to a user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2PolicyAttachmentCreate" } } } }, "objectStorage2CreateObjectStorageUserInlinePolicy": { "description": "Creates a user inline policy by the given {service_uuid}, and {username}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2InlinePolicyCreate" } } } }, "objectStorage2ReplaceObjectStorageUserTags": { "description": "Replaces a user's tags by the given {service_uuid}, and {username}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2TagListRequest" } } } }, "objectStorage2CreateObjectStorageUserPermissionsBoundary": { "description": "Creates a user's permissions boundary by the given {service_uuid}, and {username}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2PermissionsBoundaryCreate" } } } }, "objectStorage2CreateObjectStoragePolicyVersion": { "description": "Creates a policy version by the given {service_uuid}, and {policy_name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2PolicyVersionCreate" } } } }, "objectStorage2SetObjectStorageDefaultPolicyVersion": { "description": "Sets the default version for a policy. Note: This is mapped from ModifyPolicyVersion handler.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2PolicySetDefaultVersion" } } } }, "objectStorage2CreateObjectStoragePolicy": { "description": "Creates a new service policy by given {service_uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2PolicyCreate" } } } }, "objectStorage2AttachObjectStorageIAMGroupPolicy": { "description": "Attaches a policy to a group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2PolicyAttachmentCreate" } } } }, "objectStorage2CreateObjectStorageGroup": { "description": "Creates an iam group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2GroupCreate" } } } }, "objectStorage2CreateObjectStorageGroupInlinePolicy": { "description": "Creates a group inline policy by the given {service_uuid}, and {group_name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2InlinePolicyCreate" } } } }, "objectStorage2CreateObjectStorageRole": { "description": "Creates a service IAM role.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2RoleCreate" } } } }, "objectStorage2UpdateObjectStorageRole": { "description": "Updates a service's IAM role.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2RoleUpdate" } } } }, "objectStorage2CreateObjectStorageRoleInlinePolicy": { "description": "Creates a role inline policy by the given {service_uuid}, and {role_name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2InlinePolicyCreate" } } } }, "objectStorage2CreateObjectStorageRolePermissionsBoundary": { "description": "Creates a role policy's permissions boundary by the given {service_uuid}, and {role_name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2PermissionsBoundaryCreate" } } } }, "objectStorage2AssumeObjectStorageRolePolicy": { "description": "Assume a role policy by the given {service_uuid}, and {role_name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2AssumeRolePolicyRequest" } } } }, "objectStorage2AttachObjectStoragePolicyToRole": { "description": "Attaches a policy to a service's IAM role.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2PolicyAttachmentCreate" } } } }, "objectStorage2ReplaceObjectStorageRoleTags": { "description": "Replaces a role's tags by the given {service_uuid}, and {role_name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/objectStorage2TagListRequest" } } } }, "createFileStorage": { "description": "Creates a new File Storage service.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageServiceCreate" } } } }, "replaceFileStorage": { "description": "Replaces existing File Storage service by given {service_uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageServiceReplace" } } } }, "modifyFileStorage": { "description": "Modifies existing File Storage service by given {service_uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageServiceModify" } } } }, "createFileStorageNetwork": { "description": "Creates a new service network by given {service_uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageNetworkCreate" } } } }, "modifyFileStorageNetwork": { "description": "Modifies existing service network by given {service_uuid} and {network_name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageNetworkModify" } } } }, "createFileStorageShare": { "description": "Creates a new service share by given {service_uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageShareCreate" } } } }, "modifyFileStorageShare": { "description": "Modifies existing service share by given {service_uuid} and {share_name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageShareModify" } } } }, "createFileStorageAcl": { "description": "Creates a new share ACL by given {service_uuid} and {share_name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageAclCreate" } } } }, "modifyFileStorageAcl": { "description": "Modifies existing ACL by given {service_uuid}, {share_name} and {acl_name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageAclModify" } } } }, "createFileStorageLabel": { "description": "Creates a new label by given {service_uuid}. Labels are used for service filtering.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageLabelCreate" } } } }, "modifyFileStorageLabel": { "description": "Modifies existing label by given {service_uuid} and {key}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileStorageLabelModify" } } } }, "createDatabase": { "description": "Creates a new Managed Database instance. New databases are started by default. An initial backup is created automatically on startup and the API will be fully functional only after this backup has been created. The creation might take a while. Note that different databases have different properties that can be passed on creation. For PostgreSQL and MySQL, select the plan with the plan_compute, plan_node_count, plan_storage_gib and plan_backups fields; the plan name field is deprecated for these engines.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceCreateOpenAPI" } } } }, "modifyDatabase": { "description": "Modifies Managed Database service details by its {uuid} including upgrading plans, migration to other zones and database type-specific configurations. For PostgreSQL and MySQL, change the plan with the plan_compute, plan_node_count, plan_storage_gib and plan_backups fields; the plan name field is deprecated for these engines.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceModifyOpenAPI" } } } }, "modifyDatabaseType": { "description": "Update a service's type by the given {service-uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceTypeModify" } } } }, "cloneDatabase": { "description": "Creates a clone of a Managed Database service based on its {uuid}. It is possible to change location, plans and use the point in time feature to clone your service at a specific time using your backups. For PostgreSQL and MySQL, select the clone's plan with the plan_compute, plan_node_count, plan_storage_gib and plan_backups fields; the plan name field is deprecated for these engines.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceCloneOpenAPI" } } } }, "createDatabaseNetwork": { "description": "Attaches an SDN network to a Managed Database service by its {uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseNetworkCreate" } } } }, "upgradeDatabase": { "description": "Upgrades your PostgreSQL Managed Database service database to a newer major version. Downgrades are not permitted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceUpgrade" } } } }, "createDatabaseLabel": { "description": "Creates a new label by given {service_uuid}. Labels used for service filtering.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseLabelCreate" } } } }, "modifyDatabaseLabel": { "description": "Modifies existing label by given {service_uuid} and {key}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseLabelModify" } } } }, "modifyDatabaseAccessControl": { "description": "Modifies the user {username} access control for the Managed Database service {uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceAclModify" } } } }, "modifyDatabaseSecurityAdmin": { "description": "Modifies Security management admin password for the OpenSearch Managed Database service {uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceSecurityModify" } } } }, "enableDatabaseSecurityAdmin": { "description": "Enables Security management admin for the OpenSearch Managed Database service {uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceSecurityEnable" } } } }, "createDatabaseIntegrationEndpoint": { "description": "Creates a new integration endpoint.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseIntegrationEndpointCreate" } } } }, "modifyDatabaseIntegrationEndpoint": { "description": "Modifies existing integration endpoint by given {integration-uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseIntegrationEndpointModify" } } } }, "createDatabaseConnectionPool": { "description": "Creates a connection pool for the Managed Database service {uuid}. Connection pool endpoints are for PostgreSQL Managed Databases only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseConnectionPoolCreate" } } } }, "modifyDatabaseConnectionPool": { "description": "Modifies the connection pool {pool-name} for the Managed Database service {uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseConnectionPoolModify" } } } }, "createDatabaseIntegration": { "description": "Creates a new integration by given {service-uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceIntegrationCreate" } } } }, "modifyDatabaseIntegration": { "description": "Modifies existing integration by given {service-uuid} and {integration-uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceIntegrationModify" } } } }, "createDatabaseLogicalDatabase": { "description": "Creates a new logical database for the Managed Database service {uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogicalDatabaseCreate" } } } }, "createDatabaseTask": { "description": "Creates a task that checks for potential errors before starting a migration or upgrade for a Managed Database service by its {uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceTaskCreate" } } } }, "createDatabaseUser": { "description": "Creates a new user for the Managed Database service {uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceUserCreate" } } } }, "modifyDatabaseUser": { "description": "Modifies the user {username} details for the Managed Database service {uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceUserModify" } } } }, "modifyDatabaseUserAccessControl": { "description": "Return access controls settings for the OpenSearch Managed Database service {uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseServiceUserAclModify" } } } }, "createGatewayService": { "description": "Create a new service.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayServiceCreateRequest" } } } }, "replaceGatewayService": { "description": "Replace service configuration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayServiceReplaceRequest" } } } }, "modifyGatewayService": { "description": "Modify service configuration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayServiceModifyRequest" } } } }, "createGatewayConnection": { "description": "Create a new connection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayConnectionCreateRequest" } } } }, "modifyGatewayConnection": { "description": "Modify connection configuration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayConnectionModifyRequest" } } } }, "createGatewayTunnel": { "description": "Create a new tunnel.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayTunnelCreateRequest" } } } }, "modifyGatewayTunnel": { "description": "Modify tunnel configuration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayTunnelModifyRequest" } } } }, "createGatewayServiceLabel": { "description": "Create a new service label.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayLabelCreateRequest" } } } }, "modifyGatewayServiceLabel": { "description": "Modify service label configuration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayLabelModifyRequest" } } } }, "modifyGatewayAddress": { "description": "Modify existing service address by given {service-address-identifier}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayAddressModifyRequest" } } } }, "createGatewayServiceLogSession": { "description": "Create a new service log session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gatewayServiceLogSessionCreateRequest" } } } }, "createLoadBalancer": { "description": "Creates a new load balancer service.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerServiceCreate" } } } }, "replaceLoadBalancer": { "description": "Replaces existing load balancer service by given {service-uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerServiceReplace" } } } }, "modifyLoadBalancer": { "description": "Modifies existing load balancer service by given {service-uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerServiceModify" } } } }, "createLoadBalancerFrontend": { "description": "Creates a new service frontend by given {service-uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerFrontendCreate" } } } }, "modifyLoadBalancerFrontend": { "description": "Modifies existing service frontend by given {service-uuid} and {frontend-name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerFrontendModify" } } } }, "createLoadBalancerFrontendTlsConfig": { "description": "Creates a new TLS config by given {service-uuid} and {frontend-name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerTlsConfigCreate" } } } }, "modifyLoadBalancerFrontendTlsConfig": { "description": "Modifies existing TLS config by given {service-uuid}, {frontend-name}, and {tls-config-name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerTlsConfigModify" } } } }, "createLoadBalancerRule": { "description": "Creates a new rule by given {service-uuid} and {frontend-name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerRuleCreate" } } } }, "replaceLoadBalancerRule": { "description": "Replaces existing rule by given {service-uuid}, {frontend-name}, and {rule-name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerRuleCreate" } } } }, "modifyLoadBalancerRule": { "description": "Modifies existing rule by given {service-uuid}, {frontend-name}, and {rule-name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerRuleModify" } } } }, "createLoadBalancerBackend": { "description": "Creates a new backend by given {service-uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerBackendCreate" } } } }, "modifyLoadBalancerBackend": { "description": "Modifies existing backend by given {service-uuid} and {backend-name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerBackendModify" } } } }, "createLoadBalancerMember": { "description": "Creates a new member by given {service-uuid} and {backend-name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerMemberCreate" } } } }, "modifyLoadBalancerMember": { "description": "Modifies existing member by given {service-uuid}, {backend-name} and {member-name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerMemberModify" } } } }, "createLoadBalancerBackendTlsConfig": { "description": "Creates a new TLS config by given {service-uuid} and {backend-name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerTlsConfigCreate" } } } }, "modifyLoadBalancerBackendTlsConfig": { "description": "Modifies existing TLS config by given {service-uuid}, {backend-name}, and {tls-config-name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerTlsConfigModify" } } } }, "modifyLoadBalancerNetwork": { "description": "Modifies existing service network by given {service-uuid} and {network-name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerNetworkModify" } } } }, "createLoadBalancerIpAddress": { "description": "Attach a floating public IPv4 address to the service using the specified {service-uuid}. The number of attachable floating IPv4 addresses is limited to the number of nodes in the plan, and all addresses must be in the same zone as the service and detached.\n\nNote: Floating public IPv4 addresses have configurable release policies. When the service is deleted or an IP address is detached, addresses with the keep policy will be converted to detached floating IPs that remain available in your account. Addresses with the release policy will be automatically deleted. For more details, see IP Addresses.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerIpAddressCreate" } } } }, "createLoadBalancerResolver": { "description": "Creates a new resolver by given {service-uuid}.\n\nResolver is a DNS server usually residing in a user's private network. It's used to resolve IPs for backend members of type dynamic.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerResolverCreate" } } } }, "modifyLoadBalancerResolver": { "description": "Modifies existing resolver by given {service-uuid} and {resolver-name}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerResolverModify" } } } }, "createLoadBalancerLabel": { "description": "Creates a new label by given {service-uuid}.\n\nLabels used for service filtering.\n\nService labels usage examples\nBelow are some examples of what certain GET requests might look like.\n\nexact match: GET /1.3/load-balancer?label=env%3Dstaging\nexistence: GET /1.3/load-balancer?label=env\nmultiple: GET /1.3/load-balancer?label=env&label=foo%3Dbar\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerLabelCreate" } } } }, "modifyLoadBalancerLabel": { "description": "Modifies existing label by given {service-uuid} and {label-key}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerLabelModify" } } } }, "createLoadBalancerCertificateBundle": { "description": "Creates a new certificate bundle.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerCertificateBundleCreate" } } } }, "modifyLoadBalancerCertificateBundle": { "description": "Modifies existing a manual, dynamic or authority certificate bundle by given {bundle-uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerCertificateBundleModify" } } } }, "createLoadBalancerCertificateBundleLabel": { "description": "Creates a new label by given {bundle-uuid}.\n\nLabels used for certificate bundles filtering.\n\nCertificate bundle labels usage examples\nBelow are some examples of what certain GET requests might look like.\n\nexact match: GET /1.3/load-balancer/certificate-bundles?label=env%3Dstaging\nexistence: GET /1.3/load-balancer/certificate-bundles?label=env\nmultiple: GET /1.3/load-balancer/certificate-bundles?label=env&label=foo%3Dbar", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerLabelCreate" } } } }, "modifyLoadBalancerCertificateBundleLabel": { "description": "Modifies existing label by given {bundle-uuid} and {label-key}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loadBalancerLabelModify" } } } }, "createFirewallRuleset": { "description": "Creates a new firewall ruleset.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createFirewallRuleset" } } } }, "modifyFirewallRuleset": { "description": "Modifies existing firewall ruleset by given {ruleset-uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetModify" } } } }, "createMultipleFirewallRulesetRule": { "description": "Creates multiple firewall ruleset rules by the given {ruleset-uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetFirewallMultipleRuleCreate" } } } }, "createFirewallRulesetRule": { "description": "Creates a new firewall ruleset rule by the given {ruleset-uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetFirewallRuleCreate" } } } }, "modifyFirewallRulesetRule": { "description": "Modifies existing firewall ruleset rule by given {ruleset_uuid} and {rule-uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetFirewallRuleModify" } } } }, "createFirewallRulesetLabel": { "description": "Creates a new label by given {ruleset-uuid}. Labels are used for group filtering.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetCreateLabel" } } } }, "modifyFirewallRulesetLabel": { "description": "Modifies existing label by given {ruleset-uuid} and {label-key}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetLabelModify" } } } }, "firewallRulesetCreateMultipleServerFirewallRules": { "description": "Creates multiple server firewall rules by given {server-uuid}.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetServerMultipleFirewallRulesCreate" } } } }, "firewallRulesetCreateServerFirewallRule": { "description": "Creates a new server firewall rule.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewallRulesetServerFirewallRuleCreate" } } } } }, "securitySchemes": { "apiToken": { "type": "http", "description": "UpCloud API uses HTTP Bearer authentication. An API token is required to authenticate. The API token can be created in the UpCloud control panel. Alternatively, you can create an API token using the API directly, or with upctl. Note that if you want to use HTTP Basic authentication on API or with upctl, you will need to enable API access in the UpCloud control panel first.", "scheme": "bearer" } } }, "security": [ { "apiToken": [] } ], "tags": [ { "name": "upcloud", "description": "UpCloud", "x-displayName": "UpCloud" }, { "name": "account", "description": "Account management and authentication", "x-displayName": "Account" }, { "name": "kubernetes", "description": "Kubernetes is a container orchestration system for automating, managing and scaling software deployment.\nManaged Kubernetes allows you to easily create Kubernetes clusters without having to take care about low level details.\n", "x-displayName": "Kubernetes" }, { "name": "currency", "description": "Currency management", "x-displayName": "Currency" }, { "name": "device", "description": "Device management", "x-displayName": "Device" }, { "name": "events", "description": "Event management", "x-displayName": "Events" }, { "name": "ip_address", "description": "\nThe UpCloud network has public and private IP addresses.\n\nPublic IP addresses are used to connect to the server from the Internet.\n\nPrivate Utility network addresses are available for all servers within a\nsingle account, and can communicate with each other globally as long\nas the servers have the utility network interfaces configured. This is\nadded to servers by default.\n\nA server has a minimum of zero and a maximum of five public IPv4 and IPv6\naddresses. Every server can have one utility network IPv4 address only,\nand must have at least one IP address. The UpCloud API assigns the IP addresses\nautomatically in networks configured to use DHCP. IP addresses cannot be\nreserved for later use, except for floating IPs that can be reserved and\nswitched from server to another freely within their specific zone.\n\nThe operating system running on the server will see a separate network interface\nper IP address. On a typical server, there are three network interfaces. The\nfirst network interface is assigned to the public network and the second to the\nUtility network. If the server has an IPv6 address configured it will use the\nthird network interface. DHCP service is provided on all public IPv4 network\ninterfaces and all private DHCP-enabled networks for automatic configuration\nof the correct IP address. IPv6 network interfaces should use stateless\naddress autoconfiguration (SLAAC) with IPv6 privacy extensions disabled.\nOn IPv6-only server DNS parameters can be obtained with stateless DHCPv6.\n\nAdditionally, there are floating IPs: IPv4 addresses that can be\nattached to any IPv4 interface in their specific zone (eg. de-fra1 or fi-hel2).\nFloating IP addresses can be instantly switched from one server to another when\ndoing maintenance or dealing with technical issues. More information on floating\nIPs and their configuration can be found from [our tutorials](https://upcloud.com/community/tutorials/floating-ip-addresses/).\n\n## Release policy\n\nThe release policy defines what happens to an IP address when its dependent resource is deleted, such as a server or service it's attached to. The following values are supported:\n\n`release`: The address is also deleted. This applies to both normal and floating IP addresses.\n\n`keep`: For normal (non-floating) IP addresses, they are converted to detached floating IPs when their dependent resource is deleted. For floating IP addresses, they remain as detached floating IPs that can be reattached elsewhere.\n\nFloating IP addresses are created with `keep` as default policy, ensuring they remain available even after dependency deletion.\n\nThe release policy can be set when creating a new IP address or modified for an existing one through the API.\n\nNote that release policy functionality is currently only supported for public IPv4 addresses.\n\n## Service delegation\n\nAssign existing Floating IPv4 addresses to a service instead of a server. This enables the service to manage the IP address and use your dedicated floating IP address in the service's DNS records.\n\nDelegated IP addresses can be tracked with the `is_delegated` attribute in the API response.\n\nWhen an IP address is delegated to a service, it becomes subject to specific access restrictions. The IP address becomes managed by the service until you explicitly remove it. During the delegation: \n\n* You cannot delete the IP address.\n* You cannot modify its MAC address.\n* You can only update the release policy and PTR record.\n\nThese restrictions ensure service stability and are automatically lifted once the IP address is removed from the service and as long as the release policy is set to `keep` so the IP address remains available in your account.\n\nCurrently only Load Balancer supports IP address delegation.\n", "x-displayName": "IP Address" }, { "name": "network-peering", "description": "Network peering management", "x-displayName": "Network Peering" }, { "name": "network", "description": "\nThe network API calls present the different networks attached to cloud servers and allow the configuration of SDN private networks.\n\nNetworks define a secure connections between attached cloud servers using a specialised network interface. A cloud server may belong to any number of virtual networks at the same time.\nServer interfaces are identified and ordered by their index.\n\n## Network types\n\n### Public networks\n\nPublic networks provide internet connectivity to the cloud servers. Public networks are automatically added as public [IP addresses](https://upcloudltd.github.io/upcloud-openapi-spec/api/ip-address) are attached to cloud servers.\n\n### Utility network\n\nThe Utility network is a simple to use, yet functionally limited network connecting all cloud servers under the same UpCloud account. All cloud servers are connected to the Utility network by default. This way the Utility network forms a secure connection between all servers within one account, no matter where they are located. IP addressing on the Utility network is specified automatically and cannot be changed. The Utility network is limited to one connection per cloud server. SDN private networks are to be used for production workloads and any advanced network setups. The Utility network is added by [adding a utility IP address](https://upcloudltd.github.io/upcloud-openapi-spec/api/ip-address#assign-ip-address).\n\n### Private virtual LAN\n\nSDN private networks provide flexible and customisable network configuration options beyond that of the Utility network and are recommended for production workloads.\n\nThese networks provide secure connections between attached cloud servers using dedicated network interfaces. Servers can be attached and detached from SDN private networks at will using the API commands. SDN private networks allow a practically unlimited number of cloud servers to be attached simultaneously and a cloud server may belong to any number of SDN private networks at the same time. IP addressing may be defined automatically or custom IP addressing may be used. SDN private networks are configured per zone allowing cloud server on the same zone to be attached.\n\n#### Available IP subnets in Private virtual LANs\n\nGenerally, you can use any _global unicast_ address for your subnet address, even public ones. However, we recommend staying with well-known private address ranges.\n\nPrivate address ranges include: **10.0.0.0/8**, **172.16.0.0/12**, **192.168.0.0/16**.\n\nAllowed subnet prefix lengths (sizes): minimum length 8 bits, maximum length 29 bits.\n\nExcluded ranges:\n\n* 100.64.0.0/10 (CGNAT)\n* 127.0.0.0/8 (localhost)\n* 224.0.0.0/4 (IP multicast)\n* 169.254.0.0/16 (link local)\n\nThe above ranges are not available for use in Private virtual LANs.\n\nFor more information on:\n * adding network interfaces to cloud servers [see](https://upcloudltd.github.io/upcloud-openapi-spec/api/server#add-a-network-interface).\n * modifying network interfaces from cloud servers [see](https://upcloudltd.github.io/upcloud-openapi-spec/api/server#modify-a-network-interface).\n * deleting network interfaces from cloud servers [see](https://upcloudltd.github.io/upcloud-openapi-spec/api/server#delete-a-network-interface-2).\n * assigning IP addresses to cloud servers [see](https://upcloudltd.github.io/upcloud-openapi-spec/api/server#add-an-ip-address-to-a-network-interface).\n * deleting addresses from cloud servers [see](https://upcloudltd.github.io/upcloud-openapi-spec/api/server#delete-an-ip-address-from-a-network-interface).\n", "x-displayName": "Network" }, { "name": "audit-logs", "description": "The Audit Log Service API allows customers to query and export their audit logs.\n\t\t\nAudit logs track all actions performed on customer accounts, including resource creation, modification, and deletion. \nThe API provides filtering, pagination, and export capabilities.\n\nAll endpoints require HTTP Basic authentication using UpCloud account credentials.", "x-displayName": "Audit Logs" }, { "name": "partner", "description": "Partner API gives UpCloud partners the ability manage accounts for their customers.\n\nNote that use of this API is available only to accounts provisioned as partner accounts. Please contact your account representative for further details.\n", "x-displayName": "Partner" }, { "name": "permission", "description": "Manage permissions for sub-accounts to access resources owned by the main account.", "x-displayName": "Permission" }, { "name": "plan", "description": "Plans are preconfigured server configurations with fixed price. Each plan includes certain number of CPU cores, memory amount, storage and transfer quota. Most plans also include one public IPv4 address. Utility IPv4 addresses and public IPv6 addresses are currently free of charge, so they are not included in plan.\n\nIn addition to plans available in a zone, there is always possibility for free scaling of CPU, memory and disk resources. In such cases the plan used by server will be reported as \"custom\" by API. It is possible to change existing \"custom\" server to a fixed plan provided that CPU cores and memory amount matches the selected plan.\n\nGPU plans also have additional `gpu_amount` and `gpu_model` attributes, which indicate the number of GPUs and their model included in the plan.\n\nIf server's storage or network resources do not fit to plan's specification, they are billed on an hourly basis. The storage device(s) and IP addresses included in fixed plan price have `part_of_plan` attribute with value \"yes\" in server details response.\n", "x-displayName": "Plan" }, { "name": "price", "description": "Retrieve pricing information for UpCloud resources and services.", "x-displayName": "Price" }, { "name": "router", "description": "Router management", "x-displayName": "Router" }, { "name": "server-group", "description": "Server group management", "x-displayName": "Server Group" }, { "name": "server", "description": "Manages Cloud Servers", "x-displayName": "Server" }, { "name": "server_size", "description": "Server size management", "x-displayName": "Server Size" }, { "name": "storage", "description": "Block Storage is similar to a physical hard disk. It can be used to install an operating system or hold another filesystem for a Cloud Server.\n\nWritable Block Storage and CD-ROM resources can be freely attached to any Cloud Server within the same zone and under the same account. A maximum of 16 storage devices can be attached to a Cloud Server at the same time; however, the combined limit for network interfaces and storage devices is 24.\n\n

Storage resource types

\n\nThere are four different storage resource types: normal, CD-ROM, template, and backup. The normal type represents writable Block Storage.\n", "x-displayName": "Block Storage" }, { "name": "tag", "description": "User can define a set of free-form tags to group and identify a subset\nof their servers. Tags can be for example _webserver_, _database_, _PROD_, _QA_, _DEV_ etc.\n\nA server can have several tags. API can be used to return only servers\nmatching specified tags. Note that all operations changing server's\nstate or attributes must still be done individually for each server\nUUID, tags can be used only to return a list of servers.\n\n__Warning! Consider using labels instead of tags:__ Tags are an access control feature and only available for a limited set of resources. Use labels to describe and filter your resources. Documentation for labels can be found on the resource specific documentation pages.\n\nCreating and modifying tags is allowed **only by main account**. Subaccounts\nhave access only to listing tags and tagged servers they are granted\naccess to.\n", "x-displayName": "Tag" }, { "name": "timezone", "description": "Timezone management", "x-displayName": "Timezone" }, { "name": "account-tokens", "description": "UpCloud API calls can be authenticated with HTTP Bearer (token) authentication. The token API requests below allow creation, management and deletion of bearer tokens.\n\nThe bearer token can be used for authentication by setting the Authorization header of the API request:\n\n`Authorization: Bearer ucat_01DQE3AJDEBFEKECFM558TGH2F`.\n", "x-displayName": "API Tokens" }, { "name": "object-storage-2", "description": "Object Storage is a computer data storage architecture that manages data as objects as opposed to block storage which manages data as blocks within sectors and tracks. Managed Object storage is commonly used to manage large amounts of unstructured data for example storing large datasets like photos, music, or files in online collaboration services. All customers data is encrypted by default using encryption at rest.\n\nManaged Object Storage API commands allow creation, management and deletion of Object Storage devices as well as viewing Object Storage network data usage. Managed Object Storage is fully S3-compliant allowing file and bucket management using existing S3 clients.\n\nAPI follows JSON Merge Patch semantics. Note when modifying nested structures payload should contain entire array, which in a sense is PUT within PATCH for them. JSON Merge Patch uses null to explicitly indicate property deletion while absent properties are ignored, i.e. not modified.", "x-displayName": "Object Storage" }, { "name": "file-storage", "description": "File Storage is a scalable file storage service that provides shared access to files over a network using the NFS protocol.\n\nThe File Storage API allows the creation, configuration, and deletion of file storage service, as well as monitoring of network and storage usage.\n\nAPI follows JSON Merge Patch semantics. Note when modifying nested structures payload should contain entire array, which in a sense is PUT within PATCH for them. JSON Merge Patch uses null to explicitly indicate property deletion while absent properties are ignored, i.e. not modified.", "x-displayName": "File Storage" }, { "name": "database", "description": "A Managed Database is a database-as-a-service that lets customers use a database without setting up servers or database software. The service configuration defines high availability, resources, the database software version, and security parameters.\n\nThe Managed Database API lets you manage instances of supported open-source engines, including MySQL, PostgreSQL, Valkey, and OpenSearch. Managed Databases are available in every UpCloud zone. All request and response payloads are JSON.", "x-displayName": "Database" }, { "name": "gateway", "description": "UpCloud Gateway API. Allows creation, management and deletion of gateways.", "x-displayName": "Gateway" }, { "name": "load-balancer", "description": "A Managed load balancer works as the network level frontend of customer application by directing connections to the backend servers.\n\nThe Managed load balancer API allows customer to manage their services. Managed load balancers are available in every UpCloud zone. The API requests and responses payload are in JSON format only.\n\nAPI follows JSON Merge Patch semantics. Note when modifying nested structures payload should contain entire array, which in a sense is PUT within PATCH for them. JSON Merge Patch uses null to explicitly indicate property deletion while absent properties are ignored, i.e. not modified.\n\nIt is recommended to use the hostnames of your load balancer when directing your domain to it. This ensures utilization of all addresses that the load balancer might possess.\n\nFor the subdomains of your domain, use CNAME. For the primary domain, you might need to use ALIAS, or whatever is supported by your DNS provider.", "x-displayName": "Load Balancer" }, { "name": "firewall-ruleset", "description": "UpCloud SDN Firewall API. Allows creation, management and deletion of Firewall rulesets and Firewall rules.", "x-displayName": "Firewall Ruleset" }, { "name": "vnc_keymap", "description": "VNC keymap management", "x-displayName": "VNC Keymap" }, { "name": "zone", "description": "Operations for managing zones.", "x-displayName": "Zone" } ], "x-upcloud-visibility": "public", "x-tagGroups": [ { "name": "Server", "tags": [ "server", "server-group", "server_size", "plan", "device", "events", "timezone", "vnc_keymap" ] }, { "name": "Network", "tags": [ "network", "network-peering", "ip_address", "router", "gateway", "firewall-ruleset" ] }, { "name": "Account & Access", "tags": [ "account", "audit-logs", "account-tokens", "permission", "tag" ] }, { "name": "Billing", "tags": [ "price", "currency" ] } ] }