platform.json

{
  "openapi": "3.0.3",
  "info": {
    "title": "Unikraft Cloud Platform API",
    "description": "This specification describes the Unikraft Cloud Platform API, which provides mechanisms to interact with Unikraft Cloud metros. It allows you to create, manage, and interact with instances running on the platform.",
    "contact": {
      "name": "Unikraft Support",
      "url": "https://unikraft.com/contact",
      "email": "support@unikraft.com"
    },
    "version": "v1.0.0"
  },
  "servers": [
    {
      "url": "https://api.fra.unikraft.cloud",
      "description": "Frankfurt, DE"
    },
    {
      "url": "https://api.dal.unikraft.cloud",
      "description": "Dallas, TX, USA"
    },
    {
      "url": "https://api.sin.unikraft.cloud",
      "description": "Singapore"
    },
    {
      "url": "https://api.was.unikraft.cloud",
      "description": "Washington, DC, USA"
    },
    {
      "url": "https://api.sfo.unikraft.cloud",
      "description": "San Francisco, CA, USA"
    }
  ],
  "paths": {
    "/v1/certificates": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "summary": "List Certificates",
        "description": "Get one or many certificates with their current status and configuration.\nIt's possible to filter this list by name or UUID.",
        "operationId": "GetCertificates",
        "parameters": [
          {
            "name": "details",
            "in": "query",
            "description": "Whether to include details about the certificate in the response.  By\ndefault this is set to true, meaning that all information about the\ncertificate will be included in the response.  If set to false, only the\nbasic information about the certificate will be included, such as its name\nand UUID.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "count",
            "in": "query",
            "description": "The maximum number of certificates to return.  If set to 0 or not set, all\ncertificates matching filters will be returned.  When filtering by IDs,\nthis should not be set.",
            "schema": {
              "type": "integer",
              "format": "uint32"
            }
          },
          {
            "name": "from",
            "in": "query",
            "description": "If set, the listing starts from the certificate with the given UUID or at\nthe given ISO8601 creation timestamp (inclusive).  When count is 0 or not\nset, a UUID value may be used to match a specific certificate by UUID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "order",
            "in": "query",
            "description": "The sort order for the returned certificates.\n\nValid values are `PAGINATION_ORDER_ASC` (ascending, oldest first) and\n`PAGINATION_ORDER_DESC` (descending, newest first).  Defaults to\n`PAGINATION_ORDER_ASC`.",
            "schema": {
              "$ref": "#/components/schemas/PaginationOrder"
            }
          },
          {
            "name": "sortby",
            "in": "query",
            "description": "The field to sort the certificates by.\n\nCurrently only `PAGINATION_SORT_BY_CREATE_TIME` is supported.  Defaults to\n`PAGINATION_SORT_BY_CREATE_TIME`.",
            "schema": {
              "$ref": "#/components/schemas/PaginationSortBy"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/NameOrUUID"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetCertificatesResponse"
                }
              }
            }
          }
        },
        "x-package": "certificates"
      },
      "put": {
        "tags": [
          "Certificates"
        ],
        "summary": "Update Certificate",
        "description": "Update the specified certificate with a new certificate chain and private\nkey. Only user-uploaded certificates can be updated; system-managed\ncertificates cannot be modified. The new certificate must have the same\ncommon name (CN) as the existing certificate.",
        "operationId": "UpdateCertificate",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateCertificateRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateCertificateResponse"
                }
              }
            }
          }
        },
        "x-package": "certificates"
      },
      "post": {
        "tags": [
          "Certificates"
        ],
        "summary": "Create Certificate",
        "description": "Upload a new certificate with the given configuration.",
        "operationId": "CreateCertificate",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateCertificateRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateCertificateResponse"
                }
              }
            }
          }
        },
        "x-package": "certificates"
      },
      "delete": {
        "tags": [
          "Certificates"
        ],
        "summary": "Delete Certificates",
        "description": "Delete the specified certificate(s).  After this call the name of the\ncertificate(s) are no longer valid.",
        "operationId": "DeleteCertificates",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/NameOrUUID"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeleteCertificatesResponse"
                }
              }
            }
          }
        },
        "x-package": "certificates"
      }
    },
    "/v1/certificates/{uuid}": {
      "get": {
        "tags": [
          "Certificates"
        ],
        "summary": "Get Certificate by UUID",
        "description": "Get a specified certificate by its UUID.",
        "operationId": "GetCertificateByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the certificate.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetCertificatesResponse"
                }
              }
            }
          }
        },
        "x-package": "certificates"
      },
      "put": {
        "tags": [
          "Certificates"
        ],
        "summary": "Update Certificate by UUID",
        "description": "Update a specified certificate by its UUID with a new certificate chain\nand private key.",
        "operationId": "UpdateCertificateByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the certificate to update.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateCertificateByUUIDRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateCertificateResponse"
                }
              }
            }
          }
        },
        "x-package": "certificates"
      },
      "delete": {
        "tags": [
          "Certificates"
        ],
        "summary": "Delete Certificate by UUID",
        "description": "Delete a specified certificate by its UUID.  After this call the UUID of\nthe certificate are no longer valid.",
        "operationId": "DeleteCertificateByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the certificate to delete.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeleteCertificatesResponse"
                }
              }
            }
          }
        },
        "x-package": "certificates"
      }
    },
    "/v1/healthz": {
      "get": {
        "tags": [
          "Node"
        ],
        "summary": "Health Check",
        "description": "Return the status of a full-system health check of the node.",
        "operationId": "Healthz",
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HealthzResponse"
                }
              }
            }
          }
        },
        "x-package": "node"
      }
    },
    "/v1/image-store": {
      "get": {
        "tags": [
          "Images"
        ],
        "summary": "Get Images in Store",
        "description": "Retrieve all images.",
        "operationId": "GetImageStore",
        "parameters": [
          {
            "name": "metro",
            "in": "query",
            "description": "(Only applies when using global control plane).\nThe metro of the image.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "digest",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "tag",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/GetImagesRequestTagOrDigest"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetImagesResponse"
                }
              }
            }
          }
        },
        "x-package": "images"
      }
    },
    "/v1/images": {
      "get": {
        "tags": [
          "Images"
        ],
        "summary": "Get Images",
        "description": "Retrieve all images.",
        "operationId": "GetImages",
        "parameters": [
          {
            "name": "metro",
            "in": "query",
            "description": "(Only applies when using global control plane).\nThe metro of the image.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "digest",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "tag",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/GetImagesRequestTagOrDigest"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetImagesResponse"
                }
              }
            }
          }
        },
        "x-package": "images"
      }
    },
    "/v1/instances": {
      "get": {
        "tags": [
          "Instances"
        ],
        "summary": "List Instances",
        "description": "Get one or many instances with their current status and configuration.\nIt's possible to filter this list by ID(s) (name or UUID).",
        "operationId": "GetInstances",
        "parameters": [
          {
            "name": "details",
            "in": "query",
            "description": "Whether to include details about the instance in the response.  By default\nthis is set to true, meaning that all information about the instance will\nbe included in the response.  If set to false, only the basic information\nabout the instance will be included, such as its name and UUID.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "count",
            "in": "query",
            "description": "The maximum number of instances to return.  If set to 0 or not set, all\ninstances matching filters will be returned.  When filtering by IDs, this\nshould not be set.",
            "schema": {
              "type": "integer",
              "format": "uint32"
            }
          },
          {
            "name": "from",
            "in": "query",
            "description": "If set, the listing starts from the instance with the given UUID or at\nthe given ISO8601 creation timestamp (inclusive).  When count is 0 or not\nset, a UUID value may be used to match a specific instance by UUID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "tags",
            "in": "query",
            "description": "A list of tags to filter the instances by.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "order",
            "in": "query",
            "description": "The sort order for the returned instances.\n\nValid values are `PAGINATION_ORDER_ASC` (ascending, oldest first) and\n`PAGINATION_ORDER_DESC` (descending, newest first).  Defaults to\n`PAGINATION_ORDER_ASC`.",
            "schema": {
              "$ref": "#/components/schemas/PaginationOrder"
            }
          },
          {
            "name": "sortby",
            "in": "query",
            "description": "The field to sort the instances by.\n\nCurrently only `PAGINATION_SORT_BY_CREATE_TIME` is supported.  Defaults to\n`PAGINATION_SORT_BY_CREATE_TIME`.",
            "schema": {
              "$ref": "#/components/schemas/PaginationSortBy"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/NameOrUUID"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetInstancesResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      },
      "post": {
        "tags": [
          "Instances"
        ],
        "summary": "Create Instance",
        "description": "Create an instance in Unikraft Cloud.",
        "operationId": "CreateInstance",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateInstanceRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateInstanceResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      },
      "delete": {
        "tags": [
          "Instances"
        ],
        "summary": "Delete Instances",
        "description": "Delete the specified instance(s) by ID(s) (name or UUID).  After this call\nthe IDs of the instances are no longer valid.  If the instances are\ncurrently running, they are force-stopped.",
        "operationId": "DeleteInstances",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/DeleteInstanceRequestItem"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeleteInstancesResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      },
      "patch": {
        "tags": [
          "Instances"
        ],
        "summary": "Update Instances",
        "description": "Update (modify) one or more instances by ID(s) (name or UUID).  The\ninstances must be in a stopped state for most update operations.",
        "operationId": "UpdateInstances",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/UpdateInstancesRequestItem"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateInstancesResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      }
    },
    "/v1/instances/log": {
      "get": {
        "tags": [
          "Instances"
        ],
        "summary": "Get Instances Logs",
        "description": "Retrieve the logs of one or more instances by ID(s) (name or UUID).",
        "operationId": "GetInstanceLogs",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/GetInstancesLogsRequestItem"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetInstancesLogsResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      }
    },
    "/v1/instances/metrics": {
      "get": {
        "tags": [
          "Instances"
        ],
        "summary": "Get Instances Metrics",
        "description": "Get the metrics of one or more instances by their ID(s) (name or UUID).",
        "operationId": "GetInstanceMetrics",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/NameOrUUID"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetInstancesMetricsResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      }
    },
    "/v1/instances/start": {
      "put": {
        "tags": [
          "Instances"
        ],
        "summary": "Start Instances",
        "description": "Start previously stopped instances by ID(s) (name or UUID) or do\nnothing if the instances are already running.",
        "operationId": "StartInstances",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/StartInstancesRequestItem"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StartInstancesResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      }
    },
    "/v1/instances/stop": {
      "put": {
        "tags": [
          "Instances"
        ],
        "summary": "Stop Instances",
        "description": "Stop one or more running instance by ID(s) (name or UUID) or do\nnothing if the instances are already stopped.",
        "operationId": "StopInstances",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/StopInstancesRequestItem"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StopInstancesResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      }
    },
    "/v1/instances/suspend": {
      "put": {
        "tags": [
          "Instances"
        ],
        "summary": "Suspend Instances",
        "description": "Suspend one or more running instances by ID(s) (name or UUID) or do\nnothing if the instances are already suspended.",
        "operationId": "SuspendInstances",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/SuspendInstancesRequestItem"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SuspendInstancesResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      }
    },
    "/v1/instances/templates": {
      "get": {
        "tags": [
          "Instances"
        ],
        "summary": "List template instances",
        "description": "Get one or more template instances by their UUID(s) or name(s).",
        "operationId": "GetTemplateInstances",
        "parameters": [
          {
            "name": "details",
            "in": "query",
            "description": "Whether to include details about the templates in the response.  By default\nthis is set to true, meaning that all information about the templates will\nbe included in the response.  If set to false, only the basic information\nabout the templates will be included, such as their name and UUID.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "count",
            "in": "query",
            "description": "The maximum number of template instances to return.  If set to 0 or not\nset, all the template instances matching filters will be returned.  When\nfiltering by IDs, this should not be set.",
            "schema": {
              "type": "integer",
              "format": "uint32"
            }
          },
          {
            "name": "tags",
            "in": "query",
            "description": "A list of tags to filter the template instances by.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "from",
            "in": "query",
            "description": "If set, the listing starts from the template with the given UUID or at the\ngiven ISO8601 creation timestamp (inclusive).  When count is 0 or not set,\na UUID value may be used to match a specific template by UUID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "order",
            "in": "query",
            "description": "The sort order for the returned template instances.\n\nValid values are `PAGINATION_ORDER_ASC` (ascending, oldest first) and\n`PAGINATION_ORDER_DESC` (descending, newest first).  Defaults to\n`PAGINATION_ORDER_ASC`.",
            "schema": {
              "$ref": "#/components/schemas/PaginationOrder"
            }
          },
          {
            "name": "sortby",
            "in": "query",
            "description": "The field to sort the template instances by.\n\nCurrently only `PAGINATION_SORT_BY_CREATE_TIME` is supported.  Defaults to\n`PAGINATION_SORT_BY_CREATE_TIME`.",
            "schema": {
              "$ref": "#/components/schemas/PaginationSortBy"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/NameOrUUID"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetTemplateInstancesResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      },
      "post": {
        "tags": [
          "Instances"
        ],
        "summary": "Create template instances from Instances",
        "description": "Convert one or more existing instances by their UUID(s) or name(s) into\ntemplate instances that can be used to create new instances.\n\nThe existing instances must be in the `stopped` state and not have existing\nsnapshots.",
        "operationId": "CreateTemplateInstances",
        "parameters": [
          {
            "name": "timeout_s",
            "in": "query",
            "description": "Timeout in seconds to wait for the template instances to be created.\nA value of -1 means to wait indefinitely until the instance\nreaches the desired state. No wait performed for a value of 0.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "autokill.time_ms",
            "in": "query",
            "description": "Time in milliseconds after the template was last used for cloning\nbefore it is deleted. A value of 0 disables template autokill.",
            "schema": {
              "type": "integer",
              "format": "uint64"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/NameOrUUID"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateTemplateInstancesResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      },
      "delete": {
        "tags": [
          "Instances"
        ],
        "summary": "Delete template instances",
        "description": "Delete the specified template instance(s) by ID(s) (name or UUID).  After\nthis call the IDs of the template instances are no longer valid.",
        "operationId": "DeleteTemplateInstances",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/NameOrUUID"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeleteTemplateInstancesResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      },
      "patch": {
        "tags": [
          "Instances"
        ],
        "summary": "Update template instances",
        "description": "Update (modify) one or more template instances by ID(s) (name or UUID).",
        "operationId": "UpdateTemplateInstances",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/UpdateTemplateInstancesRequestItem"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateTemplateInstancesResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      }
    },
    "/v1/instances/templates/{uuid}": {
      "get": {
        "tags": [
          "Instances"
        ],
        "summary": "Get template instance by UUID",
        "description": "Get a single template instance by its UUID.",
        "operationId": "GetTemplateInstanceByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the template instance to retrieve.",
            "required": true,
            "schema": {
              "example": "123e4567-e89b-12d3-a456-426614174000",
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "details",
            "in": "query",
            "description": "Whether to include details about the templates in the response.  By default\nthis is set to true, meaning that all information about the templates will\nbe included in the response.  If set to false, only the basic information\nabout the templates will be included, such as their name and UUID.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetTemplateInstancesResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      },
      "delete": {
        "tags": [
          "Instances"
        ],
        "summary": "Delete template instance by UUID",
        "description": "Delete a specified template instance by its UUID.  After this call the UUID\nof the template instance is no longer valid.",
        "operationId": "DeleteTemplateInstanceByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the template instance to delete.",
            "required": true,
            "schema": {
              "example": "123e4567-e89b-12d3-a456-426614174000",
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeleteTemplateInstancesResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      },
      "patch": {
        "tags": [
          "Instances"
        ],
        "summary": "Update template instance by UUID",
        "description": "Update (modify) a template instance by its UUID.",
        "operationId": "UpdateTemplateInstanceByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the template instance to update.",
            "required": true,
            "schema": {
              "example": "123e4567-e89b-12d3-a456-426614174000",
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateTemplateInstanceByUUIDRequestBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateTemplateInstancesResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      }
    },
    "/v1/instances/wait": {
      "get": {
        "tags": [
          "Instances"
        ],
        "summary": "Wait for Instances States",
        "description": "Wait for one or more instances to reach certain states by ID(s)\n(name or UUID).\n\nIf the instances are already in the desired states, the request will return\nimmediately.  If the instances are not in the desired state, the request will\nblock until the instances reach the desired state or the timeout is\nreached.  If the timeout is reached, the request will fail with an error.\nIf the timeout is -1, the request will block indefinitely until the\ninstances reach the desired states.",
        "operationId": "WaitInstances",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/WaitInstancesRequestItem"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WaitInstancesResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      }
    },
    "/v1/instances/{uuid}": {
      "get": {
        "tags": [
          "Instances"
        ],
        "summary": "Get Instance by UUID",
        "description": "Get a single instance by its UUID.",
        "operationId": "GetInstanceByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the instance to get.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "details",
            "in": "query",
            "description": "Whether to include details about the instance in the response.  By default\nthis is set to true, meaning that all information about the instance will\nbe included in the response.  If set to false, only the basic information\nabout the instance will be included, such as its name and UUID.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetInstancesResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      },
      "delete": {
        "tags": [
          "Instances"
        ],
        "summary": "Delete Instance by UUID",
        "description": "Delete a specified instance by its UUID.  After this call the UUID of the\ninstance is no longer valid.  If the instance is currently running,\nit is force-stopped.",
        "operationId": "DeleteInstanceByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the instance to delete.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DeleteInstanceByUUIDRequestBody"
              }
            }
          }
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeleteInstancesResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      },
      "patch": {
        "tags": [
          "Instances"
        ],
        "summary": "Update Instance by UUID",
        "description": "Update (modify) an instance by its UUID.  The instance must be in a stopped\nstate for most update operations.",
        "operationId": "UpdateInstanceByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the instance to update.",
            "required": true,
            "schema": {
              "example": "123e4567-e89b-12d3-a456-426614174000",
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateInstanceByUUIDRequestBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateInstancesResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      }
    },
    "/v1/instances/{uuid}/log": {
      "get": {
        "tags": [
          "Instances"
        ],
        "summary": "Get Instance Logs by UUID",
        "description": "Retrieve the logs of an instance by its UUID.",
        "operationId": "GetInstanceLogsByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the instance to retrieve logs for.",
            "required": true,
            "schema": {
              "example": "123e4567-e89b-12d3-a456-426614174000",
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GetInstanceLogsByUUIDRequestBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetInstancesLogsResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      }
    },
    "/v1/instances/{uuid}/metrics": {
      "get": {
        "tags": [
          "Instances"
        ],
        "summary": "Get Instance Metrics by UUID",
        "description": "Get the metrics of an instance by its UUID.",
        "operationId": "GetInstanceMetricsByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the instance to retrieve metrics for.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetInstancesMetricsResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      }
    },
    "/v1/instances/{uuid}/start": {
      "put": {
        "tags": [
          "Instances"
        ],
        "summary": "Start Instance by UUID",
        "description": "Start a previously stopped instance by its UUID or do nothing if the\ninstance is already running.",
        "operationId": "StartInstanceByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the instance to start.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StartInstanceByUUIDRequestBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StartInstancesResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      }
    },
    "/v1/instances/{uuid}/stop": {
      "put": {
        "tags": [
          "Instances"
        ],
        "summary": "Stop Instance by UUID",
        "description": "Stop a running instance by its UUID or do nothing if the instance is\nalready stopped.",
        "operationId": "StopInstanceByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the instance to stop.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StopInstanceByUUIDRequestBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StopInstancesResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      }
    },
    "/v1/instances/{uuid}/suspend": {
      "put": {
        "tags": [
          "Instances"
        ],
        "summary": "Suspend Instance by UUID",
        "description": "Suspend a running instance by its UUID or do nothing if the instance is\nalready suspended.",
        "operationId": "SuspendInstanceByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the instance to suspend.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SuspendInstanceByUUIDRequestBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SuspendInstancesResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      }
    },
    "/v1/instances/{uuid}/wait": {
      "get": {
        "tags": [
          "Instances"
        ],
        "summary": "Wait for Instance State by UUID",
        "description": "Wait for an instance to reach a certain state, by its UUID.\n\nIf the instance is already in the desired state, the request will return\nimmediately.  If the instance is not in the desired state, the request will\nblock until the instance reaches the desired state or the timeout is\nreached.  If the timeout is reached, the request will fail with an error.\nIf the timeout is -1, the request will block indefinitely until the\ninstance reaches the desired state.",
        "operationId": "WaitInstanceByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the instance to wait for.",
            "required": true,
            "schema": {
              "example": "123e4567-e89b-12d3-a456-426614174000",
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WaitInstanceByUUIDRequestBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WaitInstancesResponse"
                }
              }
            }
          }
        },
        "x-package": "instances"
      }
    },
    "/v1/services": {
      "get": {
        "tags": [
          "ServiceGroups"
        ],
        "summary": "List Service Groups",
        "description": "Get one or many service groups with their current status and configuration.\nIt's possible to filter this list by name or UUID.",
        "operationId": "GetServiceGroups",
        "parameters": [
          {
            "name": "details",
            "in": "query",
            "description": "Whether to include details about the service group in the response.  By\ndefault this is set to true, meaning that all information about the service\ngroup will be included in the response.  If set to false, only the basic\ninformation about the service group will be included, such as its name and\nUUID.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "count",
            "in": "query",
            "description": "The maximum number of service groups to return.  If set to 0 or not set,\nall service groups matching filters will be returned.  When filtering by\nIDs, this should not be set.",
            "schema": {
              "type": "integer",
              "format": "uint32"
            }
          },
          {
            "name": "from",
            "in": "query",
            "description": "If set, the listing starts from the service group with the given UUID or\nat the given ISO8601 creation timestamp (inclusive).  When count is 0 or\nnot set, a UUID value may be used to match a specific service group by\nUUID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "order",
            "in": "query",
            "description": "The sort order for the returned service groups.\n\nValid values are `PAGINATION_ORDER_ASC` (ascending, oldest first) and\n`PAGINATION_ORDER_DESC` (descending, newest first).  Defaults to\n`PAGINATION_ORDER_ASC`.",
            "schema": {
              "$ref": "#/components/schemas/PaginationOrder"
            }
          },
          {
            "name": "sortby",
            "in": "query",
            "description": "The field to sort the service groups by.\n\nCurrently only `PAGINATION_SORT_BY_CREATE_TIME` is supported.  Defaults to\n`PAGINATION_SORT_BY_CREATE_TIME`.",
            "schema": {
              "$ref": "#/components/schemas/PaginationSortBy"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/NameOrUUID"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetServiceGroupsResponse"
                }
              }
            }
          }
        },
        "x-package": "services"
      },
      "post": {
        "tags": [
          "ServiceGroups"
        ],
        "summary": "Create Service Group",
        "description": "Create a new service with the given configuration.\n\nNote that the service properties like published ports can only be defined\nduring creation.  They cannot be changed later.  Each port in a service can\nspecify a list of handlers that determine how traffic arriving at the port\nis handled. See Connection Handlers for a complete overview.",
        "operationId": "CreateServiceGroup",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateServiceGroupRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateServiceGroupResponse"
                }
              }
            }
          }
        },
        "x-package": "services"
      },
      "delete": {
        "tags": [
          "ServiceGroups"
        ],
        "summary": "Delete Service Groups",
        "description": "Delete the specified service group(s).  After this call the name of the\nservice group(s) are no longer valid.",
        "operationId": "DeleteServiceGroups",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/NameOrUUID"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeleteServiceGroupsResponse"
                }
              }
            }
          }
        },
        "x-package": "services"
      },
      "patch": {
        "tags": [
          "ServiceGroups"
        ],
        "summary": "Update Service Groups",
        "description": "Update one or more service groups.",
        "operationId": "UpdateServiceGroups",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/UpdateServiceGroupsRequestItem"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateServiceGroupsResponse"
                }
              }
            }
          }
        },
        "x-package": "services"
      }
    },
    "/v1/services/autoscale": {
      "get": {
        "tags": [
          "Autoscale"
        ],
        "summary": "List Autoscale Configurations",
        "description": "Return the current states and configurations of autoscale configurations\nfor a given set of service groups given their UUIDs or names.",
        "operationId": "GetAutoscaleConfigurations",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/NameOrUUID"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetAutoscaleConfigurationsResponse"
                }
              }
            }
          }
        },
        "x-package": "autoscale"
      },
      "post": {
        "tags": [
          "Autoscale"
        ],
        "summary": "Create Autoscale Configurations",
        "description": "Create one or more autoscale configurations for the specified service groups\ngiven their UUIDs or names.",
        "operationId": "CreateAutoscaleConfigurations",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/CreateAutoscaleConfigurationsRequestConfiguration"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateAutoscaleConfigurationsResponse"
                }
              }
            }
          }
        },
        "x-package": "autoscale"
      },
      "delete": {
        "tags": [
          "Autoscale"
        ],
        "summary": "Delete Autoscale Configurations",
        "description": "Delete autoscale configuration for a given set of service groups given\ntheir UUIDs or names.",
        "operationId": "DeleteAutoscaleConfigurations",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/NameOrUUID"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeleteAutoscaleConfigurationsResponse"
                }
              }
            }
          }
        },
        "x-package": "autoscale"
      }
    },
    "/v1/services/{uuid}": {
      "get": {
        "tags": [
          "ServiceGroups"
        ],
        "summary": "Get Service Group by UUID",
        "description": "Get a specified service group by its UUID.",
        "operationId": "GetServiceGroupByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the service group to retrieve.",
            "required": true,
            "schema": {
              "example": "12345678-90ab-cdef-1234-567890abcdef",
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "details",
            "in": "query",
            "description": "Whether to include details about the service group in the response.  By\ndefault this is set to true, meaning that all information about the service\ngroup will be included in the response.  If set to false, only the basic\ninformation about the service group will be included, such as its name and\nUUID.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetServiceGroupsResponse"
                }
              }
            }
          }
        },
        "x-package": "services"
      },
      "delete": {
        "tags": [
          "ServiceGroups"
        ],
        "summary": "Delete Service Group by UUID",
        "description": "Delete a specified service group by its UUID.  After this call the UUID of\nthe service group is no longer valid.",
        "operationId": "DeleteServiceGroupByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the service group to delete.",
            "required": true,
            "schema": {
              "example": "12345678-90ab-cdef-1234-567890abcdef",
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeleteServiceGroupsResponse"
                }
              }
            }
          }
        },
        "x-package": "services"
      },
      "patch": {
        "tags": [
          "ServiceGroups"
        ],
        "summary": "Update Service Group by UUID",
        "description": "Update a service group by its UUID.",
        "operationId": "UpdateServiceGroupByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the service group to update.",
            "required": true,
            "schema": {
              "example": "123e4567-e89b-12d3-a456-426614174000",
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateServiceGroupByUUIDRequestBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateServiceGroupsResponse"
                }
              }
            }
          }
        },
        "x-package": "services"
      }
    },
    "/v1/services/{uuid}/autoscale": {
      "get": {
        "tags": [
          "Autoscale"
        ],
        "summary": "Get Autoscale Configurations by Service Group UUID",
        "description": "Return the current states and configurations of autoscale configurations\ngiven a service group UUID.",
        "operationId": "GetAutoscaleConfigurationsByServiceGroupUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the service group.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetAutoscaleConfigurationsResponse"
                }
              }
            }
          }
        },
        "x-package": "autoscale"
      },
      "post": {
        "tags": [
          "Autoscale"
        ],
        "summary": "Create Autoscale Configuration by Service Group UUID",
        "description": "Create an autoscale configuration for the specified service group given\nits UUID.",
        "operationId": "CreateAutoscaleConfigurationByServiceGroupUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the service to create a configuration for.\nMutually exclusive with name.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateAutoscaleConfigurationByServiceGroupUUIDRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateAutoscaleConfigurationsResponse"
                }
              }
            }
          }
        },
        "x-package": "autoscale"
      },
      "delete": {
        "tags": [
          "Autoscale"
        ],
        "summary": "Delete Autoscale Configurations by Service Group UUID",
        "description": "Delete the autoscale configuration for the service group given its UUID.\n\nUnikraft Cloud will immediately drain all connections from all instances\nthat have been created by autoscale and delete the instances afterwards.\nThe draining phase is allowed to take at most `cooldown_time_ms`\nmilliseconds after which remaining connections are forcefully closed.  The\nmaster instance is never deleted.  However, deleting the autoscale\nconfiguration causes the master instance to start if it is stopped.",
        "operationId": "DeleteAutoscaleConfigurationsByServiceGroupUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the service group.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeleteAutoscaleConfigurationsResponse"
                }
              }
            }
          }
        },
        "x-package": "autoscale"
      }
    },
    "/v1/services/{uuid}/autoscale/policies": {
      "get": {
        "tags": [
          "Autoscale"
        ],
        "summary": "List Autoscale Configuration Policies",
        "description": "List the autoscale policies for a given service group given its UUID.",
        "operationId": "GetAutoscaleConfigurationPolicies",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GetAutoscaleConfigurationPolicyRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetAutoscaleConfigurationPolicyResponse"
                }
              }
            }
          }
        },
        "x-package": "autoscale"
      },
      "post": {
        "tags": [
          "Autoscale"
        ],
        "summary": "Create Autoscale Configuration Policy",
        "description": "Add a new autoscale policy to an autoscale configuration given a service\ngroup UUID.",
        "operationId": "CreateAutoscaleConfigurationPolicy",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateAutoscaleConfigurationPolicyRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateAutoscaleConfigurationPolicyResponse"
                }
              }
            }
          }
        },
        "x-package": "autoscale"
      },
      "delete": {
        "tags": [
          "Autoscale"
        ],
        "summary": "Delete Autoscale Configuration Policies",
        "description": "Delete one or more autoscale policies for a given service group.",
        "operationId": "DeleteAutoscaleConfigurationPolicies",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DeletePolicyRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeleteAutoscaleConfigurationPolicyResponse"
                }
              }
            }
          }
        },
        "x-package": "autoscale"
      }
    },
    "/v1/services/{uuid}/autoscale/policies/{name}": {
      "get": {
        "tags": [
          "Autoscale"
        ],
        "summary": "Get Autoscale Configuration Policy by Name",
        "description": "Return the current state and configuration of an autoscale policy given\nthe service group UUID and the name of the policy.",
        "operationId": "GetAutoscaleConfigurationPolicyByName",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the service group.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "name",
            "in": "path",
            "description": "The name of the policy to get.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetAutoscaleConfigurationPolicyResponse"
                }
              }
            }
          }
        },
        "x-package": "autoscale"
      },
      "delete": {
        "tags": [
          "Autoscale"
        ],
        "summary": "Delete Autoscale Configuration Policy by Name",
        "description": "Delete an autoscale policy by name given the service group UUID.",
        "operationId": "DeleteAutoscaleConfigurationPolicyByName",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the service group.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "name",
            "in": "path",
            "description": "The name of the policy to delete.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeleteAutoscaleConfigurationPolicyResponse"
                }
              }
            }
          }
        },
        "x-package": "autoscale"
      }
    },
    "/v1/users": {
      "post": {
        "tags": [
          "Users"
        ],
        "summary": "Add Users",
        "description": "Create new user accounts. This will return 409 Conflict when any of the\nrequested users already existed on the target.",
        "operationId": "AddUsers",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddUsersRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddUsersResponse"
                }
              }
            }
          }
        },
        "x-package": "users"
      }
    },
    "/v1/users/quotas": {
      "get": {
        "tags": [
          "Users"
        ],
        "summary": "Get Current User Quotas",
        "description": "List quota usage and limits of your user account.\nLimits are hard limits that cannot be exceeded.",
        "operationId": "GetUser",
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/QuotasResponse"
                }
              }
            }
          }
        },
        "x-package": "users"
      }
    },
    "/v1/users/{uuid}/quotas": {
      "get": {
        "tags": [
          "Users"
        ],
        "summary": "Get User Quotas by UUID",
        "description": "List quota usage and limits of a user account by UUID.\nLimits are hard limits that cannot be exceeded.",
        "operationId": "GetUserByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the user to retrieve quotas for.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/QuotasResponse"
                }
              }
            }
          }
        },
        "x-package": "users"
      }
    },
    "/v1/volumes": {
      "get": {
        "tags": [
          "Volumes"
        ],
        "summary": "List Volumes",
        "description": "Return the current status and the configuration of one or more volumes\nspecified by either UUID(s) or name(s).  If no identifier is provided,\nall volumes are returned.",
        "operationId": "GetVolumes",
        "parameters": [
          {
            "name": "details",
            "in": "query",
            "description": "Whether to include details about the volume in the response.  By\ndefault this is set to true, meaning that all information about the\nvolume will be included in the response.  If set to false, only the\nbasic information about the volume will be included, such as its name\nand UUID.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "count",
            "in": "query",
            "description": "The maximum number of volumes to return.  If set to 0 or not set, all\nvolumes matching filters will be returned.  When filtering by IDs, this\nshould not be set.",
            "schema": {
              "type": "integer",
              "format": "uint32"
            }
          },
          {
            "name": "from",
            "in": "query",
            "description": "If set, the listing starts from the volume with the given UUID or at the\ngiven ISO8601 creation timestamp (inclusive).  When count is 0 or not set,\na UUID value may be used to match a specific volume by UUID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "tags",
            "in": "query",
            "description": "A list of tags to filter the volumes by.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "order",
            "in": "query",
            "description": "The sort order for the returned volumes.\n\nValid values are `PAGINATION_ORDER_ASC` (ascending, oldest first) and\n`PAGINATION_ORDER_DESC` (descending, newest first).  Defaults to\n`PAGINATION_ORDER_ASC`.",
            "schema": {
              "$ref": "#/components/schemas/PaginationOrder"
            }
          },
          {
            "name": "sortby",
            "in": "query",
            "description": "The field to sort the volumes by.\n\nCurrently only `PAGINATION_SORT_BY_CREATE_TIME` is supported.  Defaults to\n`PAGINATION_SORT_BY_CREATE_TIME`.",
            "schema": {
              "$ref": "#/components/schemas/PaginationSortBy"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/NameOrUUID"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetVolumesResponse"
                }
              }
            }
          }
        },
        "x-package": "volumes"
      },
      "post": {
        "tags": [
          "Volumes"
        ],
        "summary": "Create Volume",
        "description": "Create a volume given the specified configuration parameters.\nThe volume is automatically initialized with an empty file system.\nAfter initialization, the volume is in the `available` state and can be\nattached to an instance with the `PUT /v1/volumes/attach` endpoint.\nNote that, the size of a volume cannot be changed after creation.",
        "operationId": "CreateVolume",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateVolumeRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateVolumeResponse"
                }
              }
            }
          }
        },
        "x-package": "volumes"
      },
      "delete": {
        "tags": [
          "Volumes"
        ],
        "summary": "Delete Volumes",
        "description": "Delete one or more volumes by their UUID(s) or name(s).  If the volumes are\nstill attached to an instance, the operation fails.  After this call, the\nIDs associated with the volumes are no longer valid.",
        "operationId": "DeleteVolumes",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/NameOrUUID"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeleteVolumesResponse"
                }
              }
            }
          }
        },
        "x-package": "volumes"
      },
      "patch": {
        "tags": [
          "Volumes"
        ],
        "summary": "Update Volumes",
        "description": "Update one or more volumes specified by either UUID(s) or name(s).",
        "operationId": "UpdateVolumes",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/UpdateVolumesRequestItem"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateVolumesResponse"
                }
              }
            }
          }
        },
        "x-package": "volumes"
      }
    },
    "/v1/volumes/attach": {
      "put": {
        "tags": [
          "Volumes"
        ],
        "summary": "Attach Volumes",
        "description": "Attach one or more volumes specified by ID(s) (name or UUID) to instances\nso that the volumes are mounted when the instances start.  The volumes need\nto be in `available` state and the instances must be in `stopped` state.",
        "operationId": "AttachVolumes",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/AttachVolumesRequestItem"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AttachVolumesResponse"
                }
              }
            }
          }
        },
        "x-package": "volumes"
      }
    },
    "/v1/volumes/clone": {
      "post": {
        "tags": [
          "Volumes"
        ],
        "summary": "Clone Volumes",
        "description": "Clone one or more volumes given by their ID(s) (name or UUID).  The\nvolumes to be cloned must not be mounted to any instance or only mounted\nas read-only.  They also need to not be busy or in an error state.  This\noperation is most useful when cloning template volumes.",
        "operationId": "CloneVolumes",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/CloneVolumesRequestItem"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CloneVolumesResponse"
                }
              }
            }
          }
        },
        "x-package": "volumes"
      }
    },
    "/v1/volumes/detach": {
      "put": {
        "tags": [
          "Volumes"
        ],
        "summary": "Detach Volumes",
        "description": "Detach volumes specified by ID(s) (name or UUID) from instances.  If no\nparticular instance is specified the volume is detached from all instances.\nThe instances from which to detach must not have the volumes mounted.  The\nAPI returns an error for each instance from which it was unable to detach\nthe volume.  If the volume has been created together with an instance,\ndetaching the volume will make it persistent (i.e., it survives the\ndeletion of the instance).",
        "operationId": "DetachVolumes",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/DetachVolumesRequestItem"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DetachVolumesResponse"
                }
              }
            }
          }
        },
        "x-package": "volumes"
      }
    },
    "/v1/volumes/templates": {
      "get": {
        "tags": [
          "Volumes"
        ],
        "summary": "List template volumes",
        "description": "Return the current status and the configuration of one or more template\nvolumes specified by either UUID(s) or name(s).  If no identifier is\nprovided, all template volumes are returned.",
        "operationId": "GetTemplateVolumes",
        "parameters": [
          {
            "name": "details",
            "in": "query",
            "description": "Whether to include details about the template volumes in the response.  By\ndefault this is set to true, meaning that all information about the\ntemplates will be included in the response.  If set to false, only the\nbasic information about the templates will be included, such as their name\nand UUID.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "count",
            "in": "query",
            "description": "The maximum number of template volumes to return.  If set to 0 or not set,\nall volumes matching filters will be returned.  When filtering by IDs, this\nshould not be set.",
            "schema": {
              "type": "integer",
              "format": "uint32"
            }
          },
          {
            "name": "from",
            "in": "query",
            "description": "If set, the listing starts from the template with the given UUID or at the\ngiven ISO8601 creation timestamp (inclusive).  When count is 0 or not set,\na UUID value may be used to match a specific template by UUID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "tags",
            "in": "query",
            "description": "A list of tags to filter the template volumes by.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "order",
            "in": "query",
            "description": "The sort order for the returned template volumes.\n\nValid values are `PAGINATION_ORDER_ASC` (ascending, oldest first) and\n`PAGINATION_ORDER_DESC` (descending, newest first).  Defaults to\n`PAGINATION_ORDER_ASC`.",
            "schema": {
              "$ref": "#/components/schemas/PaginationOrder"
            }
          },
          {
            "name": "sortby",
            "in": "query",
            "description": "The field to sort the template volumes by.\n\nCurrently only `PAGINATION_SORT_BY_CREATE_TIME` is supported.  Defaults to\n`PAGINATION_SORT_BY_CREATE_TIME`.",
            "schema": {
              "$ref": "#/components/schemas/PaginationSortBy"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/NameOrUUID"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetTemplateVolumesResponse"
                }
              }
            }
          }
        },
        "x-package": "volumes"
      },
      "post": {
        "tags": [
          "Volumes"
        ],
        "summary": "Create template volume",
        "description": "Converts one or more existing volumes given by their ID(s) (name or UUID)\ninto template volumes.  This operation is irreversible in the sense that a\ntemplate volume cannot be converted back into a regular volume.\n\nThe existing volume(s) must not be attached to any instance and must be in\nthe `available` state.",
        "operationId": "CreateTemplateVolume",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/NameOrUUID"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateTemplateVolumesResponse"
                }
              }
            }
          }
        },
        "x-package": "volumes"
      },
      "delete": {
        "tags": [
          "Volumes"
        ],
        "summary": "Delete template volumes",
        "description": "Delete one or more template volumes by their UUID(s) or name(s).  After this\ncall, the IDs associated with the template volumes are no longer valid.",
        "operationId": "DeleteTemplateVolumes",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/NameOrUUID"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeleteTemplateVolumesResponse"
                }
              }
            }
          }
        },
        "x-package": "volumes"
      },
      "patch": {
        "tags": [
          "Volumes"
        ],
        "summary": "Update template volumes",
        "description": "Update one or more template volumes specified by either UUID(s) or name(s).",
        "operationId": "UpdateTemplateVolumes",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/UpdateTemplateVolumesRequestItem"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateTemplateVolumesResponse"
                }
              }
            }
          }
        },
        "x-package": "volumes"
      }
    },
    "/v1/volumes/templates/{uuid}": {
      "get": {
        "tags": [
          "Volumes"
        ],
        "summary": "Get template volume by UUID",
        "description": "Return the current status and the configuration of a particular template\nvolume by its UUID.",
        "operationId": "GetTemplateVolumeByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the template volume to retrieve.",
            "required": true,
            "schema": {
              "example": "123e4567-e89b-12d3-a456-426614174000",
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "details",
            "in": "query",
            "description": "Whether to include details about the template volume in the response.  By\ndefault this is set to true, meaning that all information about the\ntemplate will be included in the response.  If set to false, only the\nbasic information about the template will be included, such as its name\nand UUID.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetTemplateVolumesResponse"
                }
              }
            }
          }
        },
        "x-package": "volumes"
      },
      "delete": {
        "tags": [
          "Volumes"
        ],
        "summary": "Delete template volume by UUID",
        "description": "Delete the specified template volume by its UUID.  After this call, the IDs\nassociated with the template volume are no longer valid.",
        "operationId": "DeleteTemplateVolumeByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the template volume to delete.",
            "required": true,
            "schema": {
              "example": "123e4567-e89b-12d3-a456-426614174000",
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeleteTemplateVolumesResponse"
                }
              }
            }
          }
        },
        "x-package": "volumes"
      },
      "patch": {
        "tags": [
          "Volumes"
        ],
        "summary": "Update template volume by UUID",
        "description": "Update the specified template volume by its UUID.",
        "operationId": "UpdateTemplateVolumeByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the template volume to update.",
            "required": true,
            "schema": {
              "example": "123e4567-e89b-12d3-a456-426614174000",
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateTemplateVolumeByUUIDRequestBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateTemplateVolumesResponse"
                }
              }
            }
          }
        },
        "x-package": "volumes"
      }
    },
    "/v1/volumes/{uuid}": {
      "get": {
        "tags": [
          "Volumes"
        ],
        "summary": "Get Volume by UUID",
        "description": "Return the current status and the configuration of a particular volume by\nits UUID.",
        "operationId": "GetVolumeByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the volume to retrieve.",
            "required": true,
            "schema": {
              "example": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "details",
            "in": "query",
            "description": "Whether to include details about the volume in the response.  By\ndefault this is set to true, meaning that all information about the\nvolume will be included in the response.  If set to false, only the\nbasic information about the volume will be included, such as its name\nand UUID.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetVolumesResponse"
                }
              }
            }
          }
        },
        "x-package": "volumes"
      },
      "delete": {
        "tags": [
          "Volumes"
        ],
        "summary": "Delete Volume by UUID",
        "description": "Delete the specified volume by its UUID.  If the volume is still attached\nto an instance, the operation fails.  After this call, the IDs associated\nwith the volume are no longer valid.",
        "operationId": "DeleteVolumeByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the volume to delete.",
            "required": true,
            "schema": {
              "example": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeleteVolumesResponse"
                }
              }
            }
          }
        },
        "x-package": "volumes"
      },
      "patch": {
        "tags": [
          "Volumes"
        ],
        "summary": "Update Volume by UUID",
        "description": "Update the specified volume by its UUID.",
        "operationId": "UpdateVolumeByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the volume to update.",
            "required": true,
            "schema": {
              "example": "123e4567-e89b-12d3-a456-426614174000",
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateVolumeByUUIDRequestBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateVolumesResponse"
                }
              }
            }
          }
        },
        "x-package": "volumes"
      }
    },
    "/v1/volumes/{uuid}/attach": {
      "put": {
        "tags": [
          "Volumes"
        ],
        "summary": "Attach Volume by UUID",
        "description": "Attach a volume by UUID to an instance so that the volume is mounted when\nthe instance starts.  The volume needs to be in `available` state and the\ninstance must be in `stopped` state.",
        "operationId": "AttachVolumeByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the volume to attach.",
            "required": true,
            "schema": {
              "example": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AttachVolumeByUUIDRequestBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AttachVolumesResponse"
                }
              }
            }
          }
        },
        "x-package": "volumes"
      }
    },
    "/v1/volumes/{uuid}/clone": {
      "post": {
        "tags": [
          "Volumes"
        ],
        "summary": "Clone Volume by UUID",
        "description": "Clone a volume given by its UUID.  The volume to be cloned must not be\nmounted to any instance or only mounted as read-only.  It also needs to not\nbe busy or in an error state.  This operation is most useful when cloning\ntemplate volumes.",
        "operationId": "CloneVolumeByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the volume to clone.",
            "required": true,
            "schema": {
              "example": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CloneVolumeByUUIDRequestBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CloneVolumesResponse"
                }
              }
            }
          }
        },
        "x-package": "volumes"
      }
    },
    "/v1/volumes/{uuid}/detach": {
      "put": {
        "tags": [
          "Volumes"
        ],
        "summary": "Detach Volume by UUID",
        "description": "Detach a volume by UUID from instances.  If no particular instance is\nspecified the volume is detached from all instances.  The instances from\nwhich to detach must not have the volume mounted.  The API returns an error\nfor each instance from which it was unable to detach the volume.  If the\nvolume has been created together with an instance, detaching the volume\nwill make it persistent (i.e., it survives the deletion of the instance).",
        "operationId": "DetachVolumeByUUID",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "The UUID of the volume to detach.",
            "required": true,
            "schema": {
              "example": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DetachVolumeByUUIDRequestBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "default",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DetachVolumesResponse"
                }
              }
            }
          }
        },
        "x-package": "volumes"
      }
    }
  },
  "components": {
    "schemas": {
      "AddUsersRequest": {
        "required": [
          "users"
        ],
        "type": "object",
        "properties": {
          "users": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/User"
            },
            "format": "users"
          }
        },
        "x-package": "users"
      },
      "AddUsersResponse": {
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AddUsersResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "op_time_us": {
            "example": 46,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "x-package": "users"
      },
      "AddUsersResponseData": {
        "type": "object",
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DataResult"
            },
            "description": "The status of the operation for each user in the request."
          }
        },
        "x-package": "users"
      },
      "AdjustmentType": {
        "enum": [
          "change",
          "exact",
          "percentage"
        ],
        "type": "string",
        "description": "AdjustmentType defines the type of adjustment to be made in an autoscaling\nstep policy.",
        "format": "enum",
        "x-package": "autoscale"
      },
      "AttachVolumeByUUIDRequestBody": {
        "required": [
          "attach_to",
          "at"
        ],
        "type": "object",
        "properties": {
          "attach_to": {
            "allOf": [
              {
                "$ref": "#/components/schemas/NameOrUUID"
              }
            ],
            "description": "UUID or name of the instance to attach the volume to."
          },
          "at": {
            "example": "/mnt/my-volume",
            "pattern": "^/(?!.*\\.\\./|.*\\.$|.*/\\.$)[^:]*$",
            "type": "string",
            "description": "Path of the mountpoint.\n\nThe path must be absolute, not contain `.` and `..` components, and not\ncontain colons (`:`). The path must point to an empty directory. If the\ndirectory does not exist, it is created.",
            "format": "regex"
          },
          "readonly": {
            "example": false,
            "type": "boolean",
            "description": "Whether the volume should be mounted read-only."
          }
        },
        "x-package": "volumes"
      },
      "AttachVolumesRequestItem": {
        "required": [
          "attach_to",
          "at"
        ],
        "type": "object",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "attach_to": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/NameOrUUID"
                  }
                ],
                "description": "UUID or name of the instance to attach the volume to."
              },
              "at": {
                "example": "/mnt/my-volume",
                "pattern": "^/(?!.*\\.\\./|.*\\.$|.*/\\.$)[^:]*$",
                "type": "string",
                "description": "Path of the mountpoint.\n\nThe path must be absolute, not contain `.` and `..` components, and not\ncontain colons (`:`). The path must point to an empty directory. If the\ndirectory does not exist, it is created.",
                "format": "regex"
              },
              "readonly": {
                "example": false,
                "type": "boolean",
                "description": "Whether the volume should be mounted read-only."
              },
              "metro": {
                "example": "fra",
                "type": "string",
                "description": "(Only applies when using global control plane).\nThe metro to route the request to."
              }
            }
          },
          {
            "oneOf": [
              {
                "title": "uuid",
                "required": [
                  "uuid"
                ],
                "type": "object",
                "properties": {
                  "uuid": {
                    "example": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
                    "type": "string",
                    "description": "The UUID of the volume to attach. Mutually exclusive with name.\nExactly one of uuid or name must be provided.",
                    "format": "uuid"
                  }
                }
              },
              {
                "title": "name",
                "required": [
                  "name"
                ],
                "type": "object",
                "properties": {
                  "name": {
                    "example": "funky-vol-g7gum5cj",
                    "type": "string",
                    "description": "The name of the volume to attach. Mutually exclusive with UUID.\nExactly one of uuid or name must be provided."
                  }
                }
              }
            ]
          }
        ],
        "description": "A single request item for attaching a volume to an instance.",
        "x-package": "volumes"
      },
      "AttachVolumesResponse": {
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AttachVolumesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 46,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for attaching one or more volume(s) given their\nUUID(s) or name(s).",
        "x-package": "volumes"
      },
      "AttachVolumesResponseAttachedVolume": {
        "required": [
          "status",
          "uuid",
          "name"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "uuid": {
            "example": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
            "type": "string",
            "description": "The UUID of the volume that was attached.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-vol-g7gum5cj",
            "type": "string",
            "description": "The name of the volume that was attached."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the volume."
          },
          "message": {
            "example": "No volume with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "volumes"
      },
      "AttachVolumesResponseData": {
        "type": "object",
        "properties": {
          "volumes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AttachVolumesResponseAttachedVolume"
            },
            "description": "The volume(s) which were attached by the request."
          }
        },
        "x-package": "volumes"
      },
      "AutoscalePolicy": {
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "name": {
            "example": "funky-policy",
            "type": "string",
            "description": "The name of the policy."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the service group the policy applies to."
          },
          "enabled": {
            "example": true,
            "type": "boolean",
            "description": "If the policy is enabled."
          },
          "metric": {
            "allOf": [
              {
                "$ref": "#/components/schemas/StepPolicyMetric"
              }
            ],
            "description": "Metric to use for the step policy."
          },
          "adjustment_type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AdjustmentType"
              }
            ],
            "description": "The type of adjustment to be made in the step policy."
          },
          "steps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AutoscalePolicyStep"
            },
            "description": "The steps for the step policy.\nEach step defines an adjustment value and optional bounds."
          }
        },
        "description": "AutoscalePolicy defines the autoscale policy for a service.\nRight now it contains fields from both the `ondemand` and `step` policies.\nThey are marked both as optional, so only one of them should be set at a\ntime. This is a current limitation of the API design.",
        "x-package": "autoscale"
      },
      "AutoscalePolicyStep": {
        "required": [
          "adjustment"
        ],
        "type": "object",
        "properties": {
          "adjustment": {
            "example": 50,
            "type": "integer",
            "description": "The adjustment value for the step.",
            "format": "int64"
          },
          "lower_bound": {
            "example": 10,
            "type": "integer",
            "description": "Lower bound for the step.",
            "format": "int64"
          },
          "upper_bound": {
            "example": 500,
            "type": "integer",
            "description": "Upper bound for the step.",
            "format": "int64"
          }
        },
        "x-package": "autoscale"
      },
      "Certificate": {
        "required": [
          "uuid",
          "name",
          "created_at",
          "common_name",
          "state"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the certificate.\n\nThis is a unique identifier for the certificate that is generated when the\ncertificate is created.  The UUID is used to reference the certificate in\nAPI calls and can be used to identify the certificate in all API calls that\nrequire an identifier.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-certificate",
            "type": "string",
            "description": "The name of the certificate.\n\nThis is a human-readable name that can be used to identify the certificate.\nThe name must be unique within the context of your account.  The name can\nalso be used to identify the certificate in API calls."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nWhere the certificate is located."
          },
          "created_at": {
            "example": "2023-10-01T12:00:00Z",
            "type": "string",
            "description": "The time the certificate was created.",
            "format": "date-time"
          },
          "common_name": {
            "example": "my-common-name",
            "type": "string",
            "description": "The common name (CN) field from the certificate's subject.\n\nThis is typically the primary domain name that the certificate is issued\nfor. It represents the main identity that the certificate validates."
          },
          "subject": {
            "example": "example.com",
            "type": "string",
            "description": "The complete subject distinguished name (DN) of the certificate.\n\nThis contains the full subject information from the certificate, including\nthe common name, organization, organizational unit, locality, state, and\ncountry. The subject identifies the entity that the certificate is issued to.\nOnly present when the certificate has been issued."
          },
          "issuer": {
            "example": "CN=R10,O=Let's Encrypt,C=US",
            "type": "string",
            "description": "The complete issuer distinguished name (DN) of the certificate.\n\nThis identifies the Certificate Authority (CA) that issued the certificate.\nIt contains information about the CA including its common name, organization,\nand country.\nOnly present when the certificate has been issued."
          },
          "serial_number": {
            "example": "123456789ABCDEF123456789ABCDEF123456",
            "type": "string",
            "description": "The unique serial number assigned to the certificate by the issuing CA.\n\nThis is a unique identifier within the scope of the issuing CA that can be\nused to identify and track the certificate. Serial numbers are typically\nrepresented as hexadecimal strings.\nOnly present when the certificate has been issued."
          },
          "not_before": {
            "example": "2023-10-01T12:00:00Z",
            "type": "string",
            "description": "The date and time when the certificate becomes valid.\n\nThe certificate should not be trusted before this date. This timestamp\nmarks the beginning of the certificate's validity period.\nOnly present when the certificate has been issued.",
            "format": "date-time"
          },
          "not_after": {
            "example": "2023-10-01T12:00:00Z",
            "type": "string",
            "description": "The date and time when the certificate expires.\n\nThe certificate should not be trusted after this date. This timestamp\nmarks the end of the certificate's validity period. Certificates should\nbe renewed before this date to maintain service availability.\nOnly present when the certificate has been issued.",
            "format": "date-time"
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CertificateState"
              }
            ],
            "description": "The current state of the certificate.\n\nThis indicates whether the certificate is pending issuance, valid and\nready for use, or in an error state. See CertificateState enum for\ndetailed state descriptions."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "An optional field representing the status of the request.  This field is\nonly set when this message object is used as a response message."
          },
          "message": {
            "example": "No certificate with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is only set when this message object is used as a response\nmessage, and is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is only set when this message object is used as a response\nmessage, and is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "certificates"
      },
      "CertificateState": {
        "enum": [
          "pending",
          "valid",
          "error"
        ],
        "type": "string",
        "description": "The current state of a certificate.\n\nThe certificate can be in one of the following states:\n\n| State     | Description |\n|-----------|-------------|\n| `pending` | The certificate request is pending while the certificate is being requested from the certification authority. During this phase any service using this certificate is not available if this is not a renewal. |\n| `valid`   | The certificate is valid and can be used by your services. |\n| `error`   | The certificate request failed after multiple attempts. This can happen, for example, if your DNS configuration is not correct, you run into Let’s Encrypt™ quota limits, or the domain validation process failed for some other reason. There won’t be any further automatic attempts. |",
        "format": "enum",
        "x-package": "certificates"
      },
      "CloneVolumeByUUIDRequestBody": {
        "type": "object",
        "properties": {
          "vol_name": {
            "example": "funky-vol-t7qumh5j",
            "type": "string",
            "description": "The name of the new cloned volume.  If not provided, a random name\nof the form `vol-X` is generated for you, where `X` is a 5 character\nlong random alphanumeric suffix."
          },
          "quota_policy": {
            "example": "static",
            "allOf": [
              {
                "$ref": "#/components/schemas/VolumeQuotaPolicy"
              }
            ],
            "description": "The quota policy for the new cloned volume.  If not provided, the quota\npolicy of the source volume is used."
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "A list of tags to assign to the new cloned volume."
          }
        },
        "x-package": "volumes"
      },
      "CloneVolumesRequestItem": {
        "type": "object",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "metro": {
                "example": "fra",
                "type": "string",
                "description": "(Only applies when using global control plane).\nThe metro to route the request to."
              },
              "vol_name": {
                "example": "funky-vol-t7qumh5j",
                "type": "string",
                "description": "The name of the new cloned volume.  If not provided, a random name\nof the form `vol-X` is generated for you, where `X` is a 5 character\nlong random alphanumeric suffix."
              },
              "quota_policy": {
                "example": "static",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/VolumeQuotaPolicy"
                  }
                ],
                "description": "The quota policy for the new cloned volume.  If not provided, the quota\npolicy of the source volume is used."
              },
              "tags": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "A list of tags to assign to the new cloned volume."
              }
            }
          },
          {
            "oneOf": [
              {
                "title": "uuid",
                "type": "object",
                "properties": {
                  "uuid": {
                    "example": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
                    "type": "string",
                    "description": "The UUID of the volume to clone.  Mutually exclusive with name.",
                    "format": "uuid"
                  }
                }
              },
              {
                "title": "name",
                "type": "object",
                "properties": {
                  "name": {
                    "example": "funky-vol-g7gum5cj",
                    "type": "string",
                    "description": "The name of the volume to clone.  Mutually exclusive with UUID."
                  }
                }
              }
            ]
          }
        ],
        "description": "A single request item describing the volume to clone.",
        "x-package": "volumes"
      },
      "CloneVolumesResponse": {
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CloneVolumesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 46,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for cloning one or more volume(s).",
        "x-package": "volumes"
      },
      "CloneVolumesResponseData": {
        "type": "object",
        "properties": {
          "volumes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CloneVolumesResponseVolume"
            },
            "description": "The volume(s) which were cloned by the request."
          }
        },
        "x-package": "volumes"
      },
      "CloneVolumesResponseVolume": {
        "required": [
          "status",
          "uuid",
          "name",
          "state"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "uuid": {
            "example": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
            "type": "string",
            "description": "The UUID of the newly cloned volume.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-vol-g7gum5cj",
            "type": "string",
            "description": "The name of the newly cloned volume."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the volume."
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/VolumeState"
              }
            ],
            "description": "The state of the volume."
          },
          "message": {
            "example": "No volume with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "volumes"
      },
      "ConfigurationInstanceCreateArgs": {
        "type": "object",
        "allOf": [
          {
            "oneOf": [
              {
                "title": "roms",
                "type": "object",
                "properties": {
                  "roms": {
                    "allOf": [
                      {
                        "$ref": "#/components/schemas/InstanceCreateArgsInstanceCreateRequestRoms"
                      }
                    ],
                    "description": "The ROM to use for the autoscale configuration."
                  }
                }
              },
              {
                "title": "template",
                "type": "object",
                "properties": {
                  "template": {
                    "allOf": [
                      {
                        "$ref": "#/components/schemas/NameOrUUID"
                      }
                    ],
                    "description": "The template to use for the autoscale configuration."
                  }
                }
              }
            ]
          }
        ],
        "x-package": "autoscale"
      },
      "ConnectionHandler": {
        "enum": [
          "tls",
          "http",
          "redirect"
        ],
        "type": "string",
        "description": "Connection handlers to use for the service.  Handlers define how the service\nwill handle incoming connections and forward traffic from the Internet to\nyour application.  For example, a service can be configured to terminate TLS\nconnections, redirect HTTP traffic, or enable HTTP mode for load balancing.\nYou configure the handlers for every published service port individually.\n\nThere are currently 3 supported handlers:\n\n| Handler    | Description |\n|------------|-------------|\n| `tls`      | Terminate the TLS connection at the Unikraft Cloud gateway using our wildcard certificate issued for the kraft.cloud domain. The gateway forwards the unencrypted traffic to your application. |\n| `http`     | Enable HTTP mode on the load balancer to load balance on the level of individual HTTP requests. In this mode, only HTTP connections are accepted. If this option is not set the load balancer works in TCP mode and distributes TCP connections. |\n| `redirect` | Redirect traffic from the source port to the destination port. |\n\nNote that there is a set of constraints when publishing ports:\n- Port 80: MUST have \"http\" and MUST not have \"tls\" set;\n- Port 443: MUST have http and tls set;\n- The `redirect` handler can only be set on port 80 (HTTP) to redirect to\n  port 443 (HTTPS);\n- All other ports MUST have tls and MUST not have http set.",
        "format": "enum",
        "x-package": "services"
      },
      "CreateAutoscaleConfigurationByServiceGroupUUIDRequest": {
        "required": [
          "uuid",
          "create_args"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "description": "The UUID of the service to create a configuration for.\nMutually exclusive with name.",
            "format": "uuid"
          },
          "min_size": {
            "type": "integer",
            "description": "The minimum number of instances to keep running.",
            "format": "int64"
          },
          "max_size": {
            "type": "integer",
            "description": "The maximum number of instances to keep running.",
            "format": "int64"
          },
          "warmup_time_ms": {
            "type": "integer",
            "description": "The warmup time in milliseconds for new instances.",
            "format": "int64"
          },
          "cooldown_time_ms": {
            "type": "integer",
            "description": "The cooldown time in milliseconds for the autoscale configuration.",
            "format": "int64"
          },
          "create_args": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateAutoscaleConfigurationByServiceGroupUUIDRequestInstanceCreateArgs"
              }
            ],
            "description": "The arguments to use when creating the autoscale configuration."
          },
          "policies": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AutoscalePolicy"
            },
            "description": "The policies to apply to the autoscale configuration."
          }
        },
        "description": "The request message to create an autoscale configuration for a service group\nbased on its UUID.",
        "x-package": "autoscale"
      },
      "CreateAutoscaleConfigurationByServiceGroupUUIDRequestInstanceCreateArgs": {
        "type": "object",
        "allOf": [
          {
            "oneOf": [
              {
                "title": "roms",
                "type": "object",
                "properties": {
                  "roms": {
                    "allOf": [
                      {
                        "$ref": "#/components/schemas/InstanceCreateArgsInstanceCreateRequestRoms"
                      }
                    ],
                    "description": "The ROM to use for the autoscale configuration."
                  }
                }
              },
              {
                "title": "template",
                "type": "object",
                "properties": {
                  "template": {
                    "allOf": [
                      {
                        "$ref": "#/components/schemas/NameOrUUID"
                      }
                    ],
                    "description": "The template to use for the autoscale configuration."
                  }
                }
              }
            ]
          }
        ],
        "x-package": "autoscale"
      },
      "CreateAutoscaleConfigurationPolicyRequest": {
        "required": [
          "name",
          "type"
        ],
        "type": "object",
        "properties": {
          "name": {
            "example": "funky-service",
            "type": "string",
            "description": "The Name of the service to add a policy to."
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AutoscalePolicy"
              }
            ],
            "description": "The policy type to add to the autoscale configuration."
          }
        },
        "description": "The request message to create an autoscale configuration policy for a\nservice.",
        "x-package": "autoscale"
      },
      "CreateAutoscaleConfigurationPolicyResponse": {
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateAutoscaleConfigurationPolicyResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 32,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "x-package": "autoscale"
      },
      "CreateAutoscaleConfigurationPolicyResponseData": {
        "type": "object",
        "properties": {
          "policies": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CreateAutoscaleConfigurationPolicyResponsePolicy"
            },
            "description": "The policies which were added by the request."
          }
        },
        "x-package": "autoscale"
      },
      "CreateAutoscaleConfigurationPolicyResponsePolicy": {
        "required": [
          "status",
          "uuid",
          "name"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the service of the added policy.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-policy",
            "type": "string",
            "description": "The name of the service of the added policy."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the resource."
          },
          "message": {
            "example": "No service with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "autoscale"
      },
      "CreateAutoscaleConfigurationsRequestConfiguration": {
        "required": [
          "create_args"
        ],
        "type": "object",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "metro": {
                "example": "fra",
                "type": "string",
                "description": "(Optional, only applies when using global control plane).\nThe metro to route the request to."
              },
              "min_size": {
                "example": 2,
                "type": "integer",
                "description": "The minimum number of instances to keep running.",
                "format": "int64"
              },
              "max_size": {
                "example": 12,
                "type": "integer",
                "description": "The maximum number of instances to keep running.",
                "format": "int64"
              },
              "warmup_time_ms": {
                "example": 100,
                "type": "integer",
                "description": "The warmup time in milliseconds for new instances.",
                "format": "int64"
              },
              "cooldown_time_ms": {
                "example": 100,
                "type": "integer",
                "description": "The cooldown time in milliseconds for the autoscale configuration.",
                "format": "int64"
              },
              "create_args": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/ConfigurationInstanceCreateArgs"
                  }
                ],
                "description": "The arguments to use when creating the autoscale configuration."
              },
              "policies": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/AutoscalePolicy"
                },
                "description": "The policies to apply to the autoscale configuration."
              }
            }
          },
          {
            "oneOf": [
              {
                "title": "uuid",
                "type": "object",
                "properties": {
                  "uuid": {
                    "example": "123e4567-e89b-12d3-a456-426614174000",
                    "type": "string",
                    "description": "The UUID of the service to create a configuration for.\nMutually exclusive with name.",
                    "format": "uuid"
                  }
                }
              },
              {
                "title": "name",
                "type": "object",
                "properties": {
                  "name": {
                    "example": "funky-service",
                    "type": "string",
                    "description": "The name of the service to create a configuration for.\nMutually exclusive with UUID."
                  }
                }
              }
            ]
          }
        ],
        "x-package": "autoscale"
      },
      "CreateAutoscaleConfigurationsResponse": {
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateAutoscaleConfigurationsResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 34,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response to a CreateAutoscaleConfigurationRequest.",
        "x-package": "autoscale"
      },
      "CreateAutoscaleConfigurationsResponseConfigurationsResponse": {
        "required": [
          "status",
          "uuid",
          "name"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the service where the configuration was created.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-instance-template",
            "type": "string",
            "description": "The name of the service where the configuration was created."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the configuration."
          },
          "message": {
            "example": "No service with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "autoscale"
      },
      "CreateAutoscaleConfigurationsResponseData": {
        "type": "object",
        "properties": {
          "service_groups": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CreateAutoscaleConfigurationsResponseConfigurationsResponse"
            },
            "description": "The configuration(s) which were created by the request."
          }
        },
        "x-package": "autoscale"
      },
      "CreateCertificateRequest": {
        "required": [
          "chain",
          "pkey"
        ],
        "type": "object",
        "properties": {
          "name": {
            "example": "funky-certificate",
            "type": "string",
            "description": "The name of the certificate.\n\nThis is a human-readable name that can be used to identify the certificate.\nThe name must be unique within the context of your account.  If no name is\nspecified, a random name is generated for you.  The name can also be used\nto identify the certificate in API calls."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro to route the request to."
          },
          "cn": {
            "example": "funky-town.com",
            "type": "string",
            "description": "The common name (CN) of the certificate.\n\nDeprecated: Use `common_name` instead."
          },
          "common_name": {
            "example": "funky-town.com",
            "type": "string",
            "description": "The common name (CN) of the certificate.\n\nThis must be a fully-qualified domain name (FQDN). Exactly one of `cn`\nor `common_name` must be specified."
          },
          "chain": {
            "example": "-----BEGIN CERTIFICATE----- MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDQ... -----END CERTIFICATE-----",
            "type": "string",
            "description": "The chain of the certificate."
          },
          "pkey": {
            "example": "-----BEGIN PRIVATE KEY----- MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDQ... -----END PRIVATE KEY-----",
            "type": "string",
            "description": "The private key of the certificate."
          }
        },
        "description": "The request message for creating/uploading a new certificate.",
        "x-package": "certificates"
      },
      "CreateCertificateResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateCertificateResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 32,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for creating of a certificate.",
        "x-package": "certificates"
      },
      "CreateCertificateResponseData": {
        "type": "object",
        "properties": {
          "certificates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Certificate"
            },
            "description": "The certificate which was created by this request.\n\nNote: only one certificate can be specified in the request, so this\nwill always contain a single entry."
          }
        },
        "x-package": "certificates"
      },
      "CreateInstanceRequest": {
        "type": "object",
        "properties": {
          "name": {
            "example": "funky-town-g756b5d",
            "type": "string",
            "description": "(Optional).  The name of the instance.\n\nIf not provided, a random name will be generated.  The name must be unique."
          },
          "image": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ImageSpec"
              }
            ],
            "description": "(Optional).  The image to use for the instance.\n\nEither an image or a template must be specified."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro to route the request to."
          },
          "args": {
            "example": "--port=8080 --debug",
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "(Optional).  The arguments to pass to the instance when it starts."
          },
          "env": {
            "example": {
              "ENV_VAR1": "value1",
              "ENV_VAR2": "value2"
            },
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "(Optional).  Environment variables to set for the instance."
          },
          "memory_mb": {
            "example": 256,
            "type": "integer",
            "description": "(Optional).  Memory in MB to allocate for the instance.  Default is 128.",
            "format": "int64"
          },
          "service_group": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateInstanceRequestServiceGroup"
              }
            ],
            "description": "(Optional).  The service group configuration when creating an instance.\n\nWhen creating an instance, either a previously created (persistent) service\ngroup can be referenced (either through its name or UUID), or a new\n(ephemeral) service group can be created for the instance by specifying the\nlist of services it should expose and optionally the domains it should use.\nNot used by template instances."
          },
          "volumes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CreateInstanceRequestVolume"
            },
            "description": "Volumes to attach to the instance.\n\nThis list can contain both existing and new volumes to create as part of\nthe instance creation.  Existing volumes can be referenced by their name or\nUUID.  New volumes can be created by specifying a name, size in MiB, and\nmount point in the instance.  The mount point is the directory in the\ninstance where the volume will be mounted."
          },
          "autostart": {
            "example": true,
            "type": "boolean",
            "description": "Whether the instance should start automatically on creation.\nMust be set to true when `timeout_s` is specified."
          },
          "replicas": {
            "example": 5,
            "type": "integer",
            "description": "(Optional).  Number of additional replicas to create.  The total\nnumber of instances created is `replicas + 1`.  Defaults to 0.",
            "format": "int64"
          },
          "restart_policy": {
            "allOf": [
              {
                "$ref": "#/components/schemas/InstanceRestartPolicy"
              }
            ],
            "description": "Restart policy for the instance.  This defines how the instance\nshould behave when it stops or crashes.  Cannot be combined with\nthe `delete-on-stop` feature."
          },
          "scale_to_zero": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateInstanceScaleToZero"
              }
            ],
            "description": "Scale-to-zero configuration for the instance.  Requires\n`service_group` to be set.  Cannot be combined with the\n`delete-on-stop` feature."
          },
          "vcpus": {
            "example": 1,
            "type": "integer",
            "description": "(Optional).  Number of vCPUs to allocate for the instance.\nDefaults to 1.",
            "format": "int32"
          },
          "wait_timeout_ms": {
            "example": 2000,
            "type": "integer",
            "description": "Deprecated: Use `timeout_s` instead.  Timeout in milliseconds to\nwait for all new instances to reach running state.  Requires\n`autostart` to be set.  If `timeout_s` is not set, this value is\nconverted by rounding up to the next full second.  No wait\nperformed for a value of 0.",
            "format": "int64"
          },
          "features": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InstanceFeature"
            },
            "description": "Features to enable for the instance.  Features are specific\nconfigurations or capabilities that can be enabled for the\ninstance.  The `scale-to-zero` and `delete-on-stop` features are\nmutually exclusive."
          },
          "timeout_s": {
            "example": 2,
            "type": "integer",
            "description": "Timeout in seconds to wait for all new instances to reach running\nstate.  Requires `autostart` to be set.  If you autostart your\nnew instance, you can wait for it to finish starting with a\nblocking API call if you specify a wait timeout greater than\nzero.  No wait performed for a value of 0.",
            "format": "int64"
          },
          "roms": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CreateInstanceRequestRom"
            },
            "description": "Read-Only Memory (ROM) blobs to attach to the instance.\nUnikraft Cloud supports the ability to attach Read-Only Memory (ROM) blobs\nto instances. It allows you to create a general-purpose base image and\nthen customize individual instances by attaching code or data as separate\nROM blobs."
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "(Optional).  Tags to associate with the instance."
          },
          "template": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateInstanceRequestTemplate"
              }
            ],
            "description": "Template instances.\nAn existing instance can be saved as a template. This template is then\nused to create new instances that inherit the exact configuration and\nstate the original instance had when the template was created."
          },
          "sched_priority": {
            "example": "high",
            "allOf": [
              {
                "$ref": "#/components/schemas/SchedPriority"
              }
            ],
            "description": "The scheduling priority for the instance. Only settable by\nusers with scheduling priority override permissions."
          },
          "schedules": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Schedule"
            },
            "description": "(Optional).  Schedules for the instance.  Scheduled operations let you\nautomatically start, stop, delete, or exec a command in the instance on\na calendar-based schedule.  For `exec` schedules, set the `args` field\nto the command and its arguments.  Each instance stores its own\nschedules, and cloning preserves them."
          },
          "autokill": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateInstanceRequestAutokill"
              }
            ],
            "description": "(Optional).  Automatic delete-on-idle/request-limit configuration.\nNot used for template instances."
          },
          "hostname": {
            "example": "my-instance",
            "type": "string",
            "description": "(Optional).  The hostname of the instance.\n\nIf not provided, the hostname will be set to the instance name.  The\nhostname must be a valid DNS label (e.g., \"my-instance\") and is used for\ninternal DNS resolution within the Unikraft Cloud network."
          },
          "dependencies": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/NameOrUUID"
            },
            "description": "(Optional).  Dependencies of the instance.\n\nA list of instance identifiers (name or UUID) that this instance depends\non.  Dependencies define startup ordering and can be used to ensure that\nprerequisite instances are running before this instance starts."
          }
        },
        "description": "The request message for creating a new instance.",
        "x-package": "instances"
      },
      "CreateInstanceRequestAutokill": {
        "type": "object",
        "properties": {
          "time_ms": {
            "type": "integer",
            "description": "Time in milliseconds after the instance was stopped before it is deleted.\nA value of 0 disables time-based autokill.",
            "format": "uint64"
          },
          "num_requests": {
            "type": "integer",
            "description": "Maximum number of requests/connections the instance serves before it is\ndeleted. A value of 0 disables request-based autokill.",
            "format": "uint32"
          }
        },
        "description": "Automatic delete-on-idle/request-limit configuration for non-template\ninstances.",
        "x-package": "instances"
      },
      "CreateInstanceRequestDomain": {
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "name": {
            "example": "funky-town-g756b5d.fra0.unikraft.app.",
            "type": "string",
            "description": "Publicly accessible domain name.\n\nIf this name ends in a period `.` it must be a valid Full Qualified\nDomain Name (FQDN), e.g. `example.com.`; otherwise it will become a\nsubdomain of the target metro, e.g. `example` becomes\n`example.fra0.unikraft.app`."
          },
          "certificate": {
            "allOf": [
              {
                "$ref": "#/components/schemas/NameOrUUID"
              }
            ],
            "description": "A reference to an existing certificate which can be used for the\nspecified domain.  If unspecified, Unikraft Cloud will\nautomatically generate a new certificate for the domain based on Let's\nEncrypt and seek to accomplish a DNS-01 challenge."
          }
        },
        "description": "The domain configuration for the service group.\n\nA domain defines a publicly accessible domain name for the instance.  If\nthe domain name ends with a period `.`, it must be a valid Fully Qualified\nDomain Name (FQDN), otherwise it will become a subdomain of the target\nmetro.  The domain can be associated with an existing certificate by\nspecifying the certificate's name or UUID.  If no certificate is specified\nand a FQDN is provided, Unikraft Cloud will automatically generate a new\ncertificate for the domain based on Let's Encrypt and seek to accomplish a\nDNS-01 challenge.",
        "x-package": "instances"
      },
      "CreateInstanceRequestRom": {
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "name": {
            "example": "funky-rom",
            "type": "string",
            "description": "The name of the ROM to use for the instance configuration."
          },
          "image": {
            "example": "nginx:latest",
            "type": "string",
            "description": "(Optional).  The image of the ROM to use for the instance configuration.\nMutually exclusive with `files`."
          },
          "files": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InlineFile"
            },
            "description": "(Optional).  Inline files to use as the ROM content.  When specified,\nthe platform creates an EROFS image from the provided files.\nMutually exclusive with `image`."
          },
          "at": {
            "example": "/rom0",
            "type": "string",
            "description": "(Optional).  The path at which the ROM should be automatically mounted\ninside the instance.  When set, the platform mounts the ROM device at\nthe specified path so the guest does not need to mount it manually.\nWhen omitted, the ROM is exposed as a raw block device and the guest is\nresponsible for mounting it."
          }
        },
        "description": "Read-Only Memory (ROM) blob to attach to the instance.",
        "x-package": "instances"
      },
      "CreateInstanceRequestServiceGroup": {
        "type": "object",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "domains": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/CreateInstanceRequestDomain"
                },
                "description": "If no existing (persistent) service group is specified via its\nidentifier, a new (ephemeral) service group can be created.  In addition\nto the services it must expose, you can specify which domains it should\nuse too."
              },
              "services": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Service"
                },
                "description": "If no existing service group identifier is provided, one or more new\n(ephemeral, non-persistent) service(s) can be created with the following\ndefinitions."
              },
              "soft_limit": {
                "example": 100,
                "maximum": 65535.0,
                "minimum": 1.0,
                "type": "integer",
                "description": "The soft limit for the number of services that can be created in this\nservice group.",
                "format": "uint32"
              },
              "hard_limit": {
                "example": 200,
                "maximum": 65535.0,
                "minimum": 1.0,
                "type": "integer",
                "description": "The hard limit for the number of services that can be created in this\nservice group.",
                "format": "uint32"
              }
            }
          },
          {
            "oneOf": [
              {
                "title": "uuid",
                "type": "object",
                "properties": {
                  "uuid": {
                    "example": "123e4567-e89b-12d3-a456-426614174000",
                    "type": "string",
                    "description": "(Optional).  Reference an existing (persistent) service group by its\nUUID.  Mutually exclusive with name.",
                    "format": "uuid"
                  }
                }
              },
              {
                "title": "name",
                "type": "object",
                "properties": {
                  "name": {
                    "example": "funky-service-g756b5d",
                    "type": "string",
                    "description": "(Optional).  Reference an existing (persistent) service group by its\nname.  Mutually exclusive with UUID."
                  }
                }
              }
            ]
          }
        ],
        "description": "The service group configuration when creating an instance.\n\nIf no existing (persistent) service group is specified via its identifier,\na new (ephemeral) service group can be created by specifying the services\nit should expose.  A service defines the configuration settings of an\nexposed port by the instance.  A service is a combination of a public port,\nan internal port, and a set of handlers that define how the service will\nhandle incoming connections.",
        "x-package": "instances"
      },
      "CreateInstanceRequestTemplate": {
        "type": "object",
        "properties": {
          "prepare": {
            "example": false,
            "type": "boolean",
            "description": "(Optional).  Whether the instance needs to run in order to reach template state"
          },
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "(Optional).  The UUID of a template instance to create the instance from.\nMutually exclusive with name.",
            "format": "uuid"
          },
          "name": {
            "example": "my-template",
            "type": "string",
            "description": "(Optional).  The name of a template instance to create the instance from.\nMutually exclusive with UUID."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nWhere the volume is located."
          },
          "create_args": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instance"
              }
            ],
            "description": "(Optional). Configuration parameters to apply when building the new instance from the source template."
          },
          "prepare_timeout_s": {
            "example": 30,
            "type": "integer",
            "description": "(Optional). Timeout in seconds for preparing the template before the\npreparation is aborted. Only applies when `prepare` is set. A value of\n0 means no timeout.",
            "format": "int64"
          },
          "autokill": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TemplateAutokill"
              }
            ],
            "description": "(Optional). Automatic delete-on-idle configuration for the template.\nOnly applies when `prepare` is set."
          }
        },
        "description": "Defines the source template used to build a new instance.",
        "x-package": "instances"
      },
      "CreateInstanceRequestVolume": {
        "required": [
          "at"
        ],
        "type": "object",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "uuid": {
                "example": "123e4567-e89b-12d3-a456-426614174000",
                "type": "string",
                "description": "The UUID of an existing volume.\n\nIf this is the only specified field, then it will look up an existing\nvolume by this UUID.",
                "format": "uuid"
              },
              "name": {
                "example": "funky-volume-g756b5d",
                "type": "string",
                "description": "The name of the volume.\n\nIf this is the only specified field, then it will look up an existing\nvolume by this name.  If the volume does not exist, the request will\nfail.  If a new volume is intended to be created, then this field must be\nspecified along with the mount point in the instance and a provisioning\nsource (size_mb or host_path)."
              },
              "at": {
                "example": "/mnt/funky-volume",
                "type": "string",
                "description": "The mount point for the volume in the instance."
              },
              "readonly": {
                "example": false,
                "type": "boolean",
                "description": "Whether the volume is read-only.\n\nIf this field is set to true, the volume will be mounted as read-only in\nthe instance.  This field is optional and defaults to false and is only\napplicable when using an existing volume."
              },
              "quota_policy": {
                "example": "static",
                "type": "string",
                "description": "Quota policy for the volume."
              },
              "filesystem": {
                "example": "ext4",
                "type": "string",
                "description": "Filesystem type to format or configure.\nWithout custom configuration, this is either `ext4` or `virtiofs`."
              },
              "tags": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Tags to assign to the new volume."
              },
              "uid": {
                "type": "integer",
                "description": "Guest UID for managed volumes (host_path mode only).",
                "format": "uint32"
              },
              "gid": {
                "type": "integer",
                "description": "Guest GID for managed volumes (host_path mode only).",
                "format": "uint32"
              },
              "args": {
                "example": {
                  "arg1": "value1",
                  "arg2": "value2"
                },
                "type": "object",
                "additionalProperties": {
                  "type": "string"
                },
                "description": "Script arguments passed to volume initialization scripts."
              },
              "access_mode": {
                "example": "rwo",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/VolumeAccessMode"
                  }
                ],
                "description": "Access mode of the volume, controlling sharing behavior.\nDefaults to read-write by a single instance (RWO)."
              }
            }
          },
          {
            "oneOf": [
              {
                "title": "size_mb",
                "type": "object",
                "properties": {
                  "size_mb": {
                    "example": 32,
                    "type": "integer",
                    "description": "The size of the volume when creating a new volume.\n\nWhen creating a new volume as part of the instance create request,\nspecify the size of the volume in MiB.",
                    "format": "uint64"
                  }
                }
              },
              {
                "title": "host_path",
                "type": "object",
                "properties": {
                  "host_path": {
                    "example": "/srv/data/my-volume",
                    "type": "string",
                    "description": "A host path to create a managed volume from."
                  }
                }
              }
            ]
          }
        ],
        "description": "A volume defines a storage volume that can be attached to the instance.",
        "x-package": "instances"
      },
      "CreateInstanceResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateInstanceResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 875,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for creating a new instance.",
        "x-package": "instances"
      },
      "CreateInstanceResponseData": {
        "type": "object",
        "properties": {
          "instances": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Instance"
            },
            "description": "The instance that was created in this request."
          }
        },
        "x-package": "instances"
      },
      "CreateInstanceScaleToZero": {
        "type": "object",
        "properties": {
          "policy": {
            "allOf": [
              {
                "$ref": "#/components/schemas/InstanceScaleToZeroPolicy"
              }
            ],
            "description": "The specific policy to use for scaling the instance to zero."
          },
          "stateful": {
            "example": true,
            "type": "boolean",
            "description": "Whether the instance should be stateful when scaled to zero. If set to\ntrue, the instance will retain its state (e.g., RAM contents) when scaled\nto zero.  This is useful for instances that need to maintain their state\nacross scale-to-zero operations.  If set to false, the instance will lose\nits state when scaled to zero, and it will be restarted from scratch when\nscaled back up."
          },
          "cooldown_time_ms": {
            "example": 3000,
            "type": "integer",
            "description": "The cooldown time in milliseconds before the instance can be scaled to\nzero again.  This is useful to prevent rapid scaling to zero and back up,\nwhich can lead to performance issues or resource exhaustion.",
            "format": "int32"
          },
          "notify_time_ms": {
            "example": 1000,
            "type": "integer",
            "description": "The notification time in milliseconds before the instance is scaled to\nzero. This allows the instance to perform any necessary cleanup or state\nsaving before being scaled down.",
            "format": "int32"
          }
        },
        "x-package": "instances"
      },
      "CreateServiceGroupRequest": {
        "required": [
          "services"
        ],
        "type": "object",
        "properties": {
          "name": {
            "example": "funky-service-g7gum5cj",
            "type": "string",
            "description": "Name of the service group.  This is a human-readable name that can be used\nto identify the service group.  The name must be unique within the context\nof your account.  If no name is specified, a random name is generated for\nyou.  The name can also be used to identify the service group in API calls."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro to route the request to."
          },
          "services": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Service"
            },
            "description": "Description of exposed services."
          },
          "domains": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CreateServiceGroupRequestDomain"
            },
            "description": "Description of domains associated with the service group."
          },
          "soft_limit": {
            "example": 1,
            "type": "integer",
            "description": "The soft limit is used by the Unikraft Cloud load balancer to decide when\nto wake up another standby instance.\n\nFor example, if the soft limit is set to 5 and the service consists of 2\nstandby instances, one of the instances receives up to 5 concurrent\nrequests.  The 6th parallel requests wakes up the second instance.  If\nthere are no more standby instances to wake up, the number of requests\nassigned to each instance will exceed the soft limit.  The load balancer\nmakes sure that when the number of in-flight requests goes down again,\ninstances are put into standby as fast as possible.",
            "format": "uint64"
          },
          "hard_limit": {
            "example": 100,
            "type": "integer",
            "description": "The hard limit defines the maximum number of concurrent requests that an\ninstance assigned to the this service can handle.\n\nThe load balancer will never assign more requests to a single instance.  In\ncase there are no other instances available, excess requests fail (i.e.,\nthey are blocked and not queued).",
            "format": "uint64"
          },
          "autokill": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateServiceGroupRequestAutokill"
              }
            ],
            "description": "Automatic delete-on-idle configuration."
          }
        },
        "description": "The request message for creating a new service group.",
        "x-package": "services"
      },
      "CreateServiceGroupRequestAutokill": {
        "type": "object",
        "properties": {
          "time_ms": {
            "type": "integer",
            "description": "Time in milliseconds after the service group becomes empty before it is\ndeleted. A value of 0 disables autokill.",
            "format": "uint64"
          }
        },
        "description": "Automatic delete-on-idle configuration for service groups.",
        "x-package": "services"
      },
      "CreateServiceGroupRequestDomain": {
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "name": {
            "example": "example.com.",
            "type": "string",
            "description": "Publicly accessible domain name.  If this name ends in a period `.` it must\nbe a valid Full Qualified Domain Name (FQDN), otherwise it will become a\nsubdomain of the target metro."
          },
          "certificate": {
            "allOf": [
              {
                "$ref": "#/components/schemas/NameOrUUID"
              }
            ],
            "description": "Use an existing certificate for the domain.  If this field is\nspecified, the domain must be associated with a valid certificate."
          }
        },
        "description": "A domain name",
        "x-package": "services"
      },
      "CreateServiceGroupResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateServiceGroupResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 46,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for creating of a service group.",
        "x-package": "services"
      },
      "CreateServiceGroupResponseData": {
        "type": "object",
        "properties": {
          "service_groups": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceGroup"
            },
            "description": "The service group which was created by this request.\n\nNote: only one service group can be specified in the request, so this\nwill always contain a single entry."
          }
        },
        "x-package": "services"
      },
      "CreateTemplateInstancesResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateTemplateInstancesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 76,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for creating one or more template instances.",
        "x-package": "instances"
      },
      "CreateTemplateInstancesResponseData": {
        "type": "object",
        "properties": {
          "instances": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CreateTemplateInstancesResponseTemplateInstance"
            },
            "description": "List of template instances that were created during the operation."
          }
        },
        "x-package": "instances"
      },
      "CreateTemplateInstancesResponseTemplateInstance": {
        "required": [
          "status",
          "uuid",
          "name",
          "state"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of this particular template instance creation operation."
          },
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the template instance that was created.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-town-g756b5d",
            "type": "string",
            "description": "The name of the template instance that was created."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the template instance."
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/InstanceState"
              }
            ],
            "description": "The current state of the instance."
          },
          "message": {
            "example": "No instance with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "instances"
      },
      "CreateTemplateVolumesResponse": {
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CreateTemplateVolumesResponseData"
              }
            ],
            "description": "The response data for this request"
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 46,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for creating one or more template volumes.",
        "x-package": "volumes"
      },
      "CreateTemplateVolumesResponseData": {
        "type": "object",
        "properties": {
          "volumes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CreateTemplateVolumesResponseTemplateVolume"
            },
            "description": "The template volume(s) which were created by the request."
          }
        },
        "x-package": "volumes"
      },
      "CreateTemplateVolumesResponseTemplateVolume": {
        "required": [
          "status",
          "uuid",
          "name",
          "state"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "uuid": {
            "example": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
            "type": "string",
            "description": "The UUID of the volume converted into a template.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-vol-g7gum5cj",
            "type": "string",
            "description": "The name of the volume converted into a template."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the volume."
          },
          "state": {
            "example": "available",
            "allOf": [
              {
                "$ref": "#/components/schemas/VolumeState"
              }
            ],
            "description": "The state of the volume."
          },
          "message": {
            "example": "No volume with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "volumes"
      },
      "CreateVolumeRequest": {
        "type": "object",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "name": {
                "example": "funky-vol-t7qumh5j",
                "type": "string",
                "description": "The name of the volume.\n\nThis is a human-readable name that can be used to identify the volume.\nThe name must be unique within the context of your account.  If no name is\nspecified, a random name of the form `vol-X` is generated for you, where\n`X` is a 5 character long random alphanumeric suffix..  The name can also\nbe used to identify the volume in API calls."
              },
              "metro": {
                "example": "fra",
                "type": "string",
                "description": "(Only applies when using global control plane).\nThe metro to route the request to."
              },
              "quota_policy": {
                "example": "static",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/VolumeQuotaPolicy"
                  }
                ],
                "description": "Quota policy for the volume."
              },
              "filesystem": {
                "example": "ext4",
                "type": "string",
                "description": "Filesystem type to format or configure.\nWithout custom configuration, this is either `ext4` or `virtiofs`."
              },
              "tags": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Tags to assign to the new volume."
              },
              "uid": {
                "type": "integer",
                "description": "Guest UID for managed volumes (host_path mode only).",
                "format": "uint32"
              },
              "gid": {
                "type": "integer",
                "description": "Guest GID for managed volumes (host_path mode only).",
                "format": "uint32"
              },
              "args": {
                "example": {
                  "arg1": "value1",
                  "arg2": "value2"
                },
                "type": "object",
                "additionalProperties": {
                  "type": "string"
                },
                "description": "Script arguments passed to volume initialization scripts."
              },
              "access_mode": {
                "example": "rwo",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/VolumeAccessMode"
                  }
                ],
                "description": "The access mode of the volume, controlling volume sharing behavior.\nDefaults to `rwo` if not specified."
              }
            }
          },
          {
            "oneOf": [
              {
                "title": "size_mb",
                "type": "object",
                "properties": {
                  "size_mb": {
                    "example": 64,
                    "type": "integer",
                    "description": "The size of the volume in megabytes.",
                    "format": "uint64"
                  }
                }
              },
              {
                "title": "host_path",
                "type": "object",
                "properties": {
                  "host_path": {
                    "example": "/srv/data/my-volume",
                    "type": "string",
                    "description": "A host path to create a managed volume from."
                  }
                }
              },
              {
                "title": "template",
                "type": "object",
                "properties": {
                  "template": {
                    "allOf": [
                      {
                        "$ref": "#/components/schemas/NameOrUUID"
                      }
                    ],
                    "description": "Source template volume to clone from."
                  }
                }
              }
            ]
          }
        ],
        "description": "The request message for creating a volume.",
        "x-package": "volumes"
      },
      "CreateVolumeResponse": {
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "$ref": "#/components/schemas/CreateVolumeResponseData"
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 46,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for creating of a volume.",
        "x-package": "volumes"
      },
      "CreateVolumeResponseData": {
        "type": "object",
        "properties": {
          "volumes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CreateVolumeResponseVolume"
            },
            "description": "The volume(s) which were created by the request."
          }
        },
        "x-package": "volumes"
      },
      "CreateVolumeResponseVolume": {
        "required": [
          "status",
          "uuid",
          "name",
          "state"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "uuid": {
            "example": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
            "type": "string",
            "description": "UUID of the newly created volume.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-vol-g7gum5cj",
            "type": "string",
            "description": "The name of the newly created volume."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the volume."
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/VolumeState"
              }
            ],
            "description": "The state of the volume."
          },
          "message": {
            "example": "No volume with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "volumes"
      },
      "DataLicense": {
        "required": [
          "serial",
          "valid"
        ],
        "type": "object",
        "properties": {
          "serial": {
            "type": "string",
            "description": "The serial number of the license certificate, hex-encoded."
          },
          "valid": {
            "type": "boolean",
            "description": "Whether the license is currently valid."
          },
          "features": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of enabled features."
          }
        },
        "description": "License information (admin only).",
        "x-package": "node"
      },
      "DataResult": {
        "required": [
          "uuid",
          "added"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid"
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the user."
          },
          "added": {
            "example": true,
            "type": "boolean"
          }
        },
        "x-package": "users"
      },
      "DeleteAutoscaleConfigurationPolicyResponse": {
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DeleteAutoscaleConfigurationPolicyResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 54,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "x-package": "autoscale"
      },
      "DeleteAutoscaleConfigurationPolicyResponseData": {
        "type": "object",
        "properties": {
          "policies": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DeleteAutoscaleConfigurationPolicyResponsePoliciesResponse"
            },
            "description": "The policies which were deleted by the request."
          }
        },
        "x-package": "autoscale"
      },
      "DeleteAutoscaleConfigurationPolicyResponsePoliciesResponse": {
        "required": [
          "status",
          "name"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "name": {
            "example": "funky-policy",
            "type": "string",
            "description": "The name of the service of the deleted policy."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the resource."
          },
          "message": {
            "example": "No service with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "autoscale"
      },
      "DeleteAutoscaleConfigurationsResponse": {
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DeleteAutoscaleConfigurationsResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 60,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "x-package": "autoscale"
      },
      "DeleteAutoscaleConfigurationsResponseData": {
        "type": "object",
        "properties": {
          "service_groups": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DeleteAutoscaleConfigurationsResponseServiceGroup"
            },
            "description": "The configuration(s) which were deleted by the request."
          }
        },
        "x-package": "autoscale"
      },
      "DeleteAutoscaleConfigurationsResponseServiceGroup": {
        "required": [
          "status",
          "uuid",
          "name"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the service where the configuration was deleted.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-instance-template",
            "type": "string",
            "description": "The name of the service where the configuration was deleted."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the resource."
          },
          "message": {
            "example": "No service with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "autoscale"
      },
      "DeleteCertificatesResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DeleteCertificatesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 42,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for deleting of one or more certificate(s) given their\nUUID(s) or name(s).",
        "x-package": "certificates"
      },
      "DeleteCertificatesResponseData": {
        "type": "object",
        "properties": {
          "certificates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DeleteCertificatesResponseDeletedCertificate"
            },
            "description": "The certificate(s) which were deleted by the request."
          }
        },
        "x-package": "certificates"
      },
      "DeleteCertificatesResponseDeletedCertificate": {
        "required": [
          "status",
          "uuid",
          "name"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "Indicates whether the delete operation was successful or not for this\ncertificate."
          },
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the certificate which was deleted.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-certificate",
            "type": "string",
            "description": "The name of the certificate which was deleted."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the certificate."
          },
          "message": {
            "example": "No certificate with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "description": "Details of the certificate which was deleted by this request.",
        "x-package": "certificates"
      },
      "DeleteInstanceByUUIDRequestBody": {
        "type": "object",
        "properties": {
          "timeout_s": {
            "example": 2,
            "type": "integer",
            "description": "Timeout in seconds to wait for the instance to be deleted.  No wait\nperformed for a value of 0.",
            "format": "int64"
          },
          "dont_retain": {
            "example": false,
            "type": "boolean",
            "description": "Delete immediately without retention.  If the instance is already\nbeing retained, this will force its deletion.  Ignored if retention\nfor instances is not configured."
          }
        },
        "description": "Parameters for deleting the instance by UUID.",
        "x-package": "instances"
      },
      "DeleteInstanceRequestItem": {
        "type": "object",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "metro": {
                "example": "fra",
                "type": "string",
                "description": "(Only applies when using global control plane).\nThe metro of the instance."
              },
              "timeout_s": {
                "example": 2,
                "type": "integer",
                "description": "Timeout in seconds to wait for the instance to be deleted.  No wait\nperformed for a value of 0.",
                "format": "int64"
              },
              "dont_retain": {
                "example": false,
                "type": "boolean",
                "description": "Delete immediately without retention.  If the instance is already\nbeing retained, this will force its deletion.  Ignored if retention\nfor instances is not configured."
              }
            }
          },
          {
            "oneOf": [
              {
                "title": "uuid",
                "required": [
                  "uuid"
                ],
                "type": "object",
                "properties": {
                  "uuid": {
                    "example": "123e4567-e89b-12d3-a456-426614174000",
                    "type": "string",
                    "description": "Mutually exclusive with name.",
                    "format": "uuid"
                  }
                }
              },
              {
                "title": "name",
                "required": [
                  "name"
                ],
                "type": "object",
                "properties": {
                  "name": {
                    "example": "funky-town-g756b5d",
                    "type": "string",
                    "description": "Mutually exclusive with UUID."
                  }
                }
              }
            ]
          }
        ],
        "description": "The request item for deleting an instance by its UUID or name.",
        "x-package": "instances"
      },
      "DeleteInstancesResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DeleteInstancesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 221,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for deleting one or more instance(s) given their UUID(s)\nor name(s).",
        "x-package": "instances"
      },
      "DeleteInstancesResponseData": {
        "type": "object",
        "properties": {
          "instances": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DeleteInstancesResponseInstance"
            },
            "description": "The instance(s) which were deleted by the request."
          }
        },
        "x-package": "instances"
      },
      "DeleteInstancesResponseInstance": {
        "required": [
          "status",
          "uuid",
          "name",
          "previous_state"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "Indicates whether the start operation was successful or not for this\ninstance."
          },
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the instance which was deleted.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-town-g756b5d",
            "type": "string",
            "description": "The name of the instance which was deleted."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the instance."
          },
          "previous_state": {
            "example": "stopped",
            "type": "string",
            "description": "The previous state of the instance before it was deleted."
          },
          "message": {
            "example": "No instance with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "description": "Details of the instance which was deleted by this request.",
        "x-package": "instances"
      },
      "DeletePolicyRequest": {
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "name": {
            "example": "funky-policy",
            "type": "string",
            "description": "The Name of the policy to delete."
          }
        },
        "description": "The request message to delete an autoscale configuration policy by name.",
        "x-package": "autoscale"
      },
      "DeleteServiceGroupsResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DeleteServiceGroupsResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 46,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for deleting of one or more service group(s) given their\nUUID(s) or name(s).",
        "x-package": "services"
      },
      "DeleteServiceGroupsResponseData": {
        "type": "object",
        "properties": {
          "service_groups": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DeleteServiceGroupsResponseDeletedServiceGroup"
            },
            "description": "The service group(s) which were deleted by the request."
          }
        },
        "x-package": "services"
      },
      "DeleteServiceGroupsResponseDeletedServiceGroup": {
        "required": [
          "status",
          "uuid",
          "name"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "Indicates whether the delete operation was successful or not for this\nservice group."
          },
          "uuid": {
            "example": "12345678-90ab-cdef-1234-567890abcdef",
            "type": "string",
            "description": "The UUID of the service group which was deleted.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-service-g7gum5cj",
            "type": "string",
            "description": "The name of the service group which was deleted."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the service group."
          },
          "message": {
            "example": "No service with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is only set when this message object is used as a response\nmessage, and is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is only set when this message object is used as a response\nmessage, and is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "description": "Details of the service group which was deleted by this request.",
        "x-package": "services"
      },
      "DeleteTemplateInstancesResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DeleteTemplateInstancesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 76,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for deleting one or more template instances.",
        "x-package": "instances"
      },
      "DeleteTemplateInstancesResponseData": {
        "type": "object",
        "properties": {
          "instances": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DeleteTemplateInstancesResponseTemplateInstance"
            },
            "description": "List of template instances that were processed during the delete operation."
          }
        },
        "x-package": "instances"
      },
      "DeleteTemplateInstancesResponseTemplateInstance": {
        "required": [
          "uuid",
          "name",
          "status"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the template instance that was deleted.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-town-g756b5d",
            "type": "string",
            "description": "The name of the template instance that was deleted."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the template instance."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of this particular template instance deletion operation."
          },
          "message": {
            "example": "No template instance with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "instances"
      },
      "DeleteTemplateVolumesResponse": {
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DeleteTemplateVolumesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 46,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for deleting one or more template volumes.",
        "x-package": "volumes"
      },
      "DeleteTemplateVolumesResponseData": {
        "type": "object",
        "properties": {
          "volumes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DeleteTemplateVolumesResponseTemplateVolume"
            },
            "description": "The template volume(s) which were deleted by the request."
          }
        },
        "x-package": "volumes"
      },
      "DeleteTemplateVolumesResponseTemplateVolume": {
        "required": [
          "uuid",
          "name",
          "status"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the template volume that was deleted.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-town-g756b5d",
            "type": "string",
            "description": "The name of the template volume that was deleted."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the volume."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of this particular template volume deletion operation."
          },
          "message": {
            "example": "No volume with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "volumes"
      },
      "DeleteVolumesResponse": {
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DeleteVolumesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 46,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "x-package": "volumes"
      },
      "DeleteVolumesResponseData": {
        "type": "object",
        "properties": {
          "volumes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DeleteVolumesResponseDeletedVolume"
            },
            "description": "The volume(s) which were deleted by the request."
          }
        },
        "x-package": "volumes"
      },
      "DeleteVolumesResponseDeletedVolume": {
        "required": [
          "status",
          "uuid",
          "name"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "uuid": {
            "example": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
            "type": "string",
            "description": "The UUID of the volume that was deleted.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-vol-g7gum5cj",
            "type": "string",
            "description": "The name of the volume that was deleted."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the volume."
          },
          "message": {
            "example": "No volume with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "volumes"
      },
      "DetachVolumeByUUIDRequestBody": {
        "type": "object",
        "properties": {
          "from": {
            "allOf": [
              {
                "$ref": "#/components/schemas/NameOrUUID"
              }
            ],
            "description": "(Optional).  UUID or name of the instance to detach the volume from.\nIf not specified, the volume is detached from all instances."
          }
        },
        "x-package": "volumes"
      },
      "DetachVolumesRequestItem": {
        "type": "object",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "metro": {
                "example": "fra",
                "type": "string",
                "description": "(Only applies when using global control plane).\nThe metro to route the request to."
              },
              "from": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/NameOrUUID"
                  }
                ],
                "description": "(Optional).  UUID or name of the instance to detach the volume from.\nIf not specified, the volume is detached from all instances."
              }
            }
          },
          {
            "oneOf": [
              {
                "title": "uuid",
                "required": [
                  "uuid"
                ],
                "type": "object",
                "properties": {
                  "uuid": {
                    "example": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
                    "type": "string",
                    "description": "The UUID of the volume to detach. Mutually exclusive with name.\nExactly one of uuid or name must be provided.",
                    "format": "uuid"
                  }
                }
              },
              {
                "title": "name",
                "required": [
                  "name"
                ],
                "type": "object",
                "properties": {
                  "name": {
                    "example": "funky-town-g7gum5cj",
                    "type": "string",
                    "description": "The name of the volume to detach. Mutually exclusive with UUID.\nExactly one of uuid or name must be provided."
                  }
                }
              }
            ]
          }
        ],
        "description": "A single request of detaching a volume.",
        "x-package": "volumes"
      },
      "DetachVolumesResponse": {
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DetachVolumesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 46,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "x-package": "volumes"
      },
      "DetachVolumesResponseData": {
        "type": "object",
        "properties": {
          "volumes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DetachVolumesResponseDetachedVolume"
            },
            "description": "The volume(s) which were detached by the request."
          }
        },
        "x-package": "volumes"
      },
      "DetachVolumesResponseDetachedVolume": {
        "required": [
          "status",
          "uuid",
          "name"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "uuid": {
            "example": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
            "type": "string",
            "description": "The UUID of the volume that was detached.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-vol-g7gum5cj",
            "type": "string",
            "description": "The name of the volume that was detached."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the volume."
          },
          "message": {
            "example": "No volume with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "volumes"
      },
      "Domain": {
        "required": [
          "fqdn"
        ],
        "type": "object",
        "properties": {
          "fqdn": {
            "example": "example.com.",
            "type": "string",
            "description": "Publicly accessible domain name.  If this name ends in a period `.` it must\nbe a valid Full Qualified Domain Name (FQDN), otherwise it will become a\nsubdomain of the target metro."
          },
          "certificate": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Certificate"
              }
            ],
            "description": "Use an existing certificate for the domain.  If this field is\nspecified, the domain must be associated with a valid certificate."
          }
        },
        "description": "A domain name.\n\nDomain names are completely specified with all labels in the hierarchy of the\nDNS, having no parts omitted.  The domain can be associated with an existing\ncertificate by specifying the certificate's name or UUID.  If no certificate\nis specified and a FQDN is provided, Unikraft Cloud will automatically\ngenerate a new certificate for the domain based on Let's Encrypt and seek to\naccomplish a DNS-01 challenge.",
        "x-package": "services"
      },
      "GetAutoscaleConfigurationPolicyRequest": {
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "name": {
            "example": "funky-policy",
            "type": "string",
            "description": "The Name of the policy to get."
          }
        },
        "description": "The request message to get an autoscale configuration policy by name.",
        "x-package": "autoscale"
      },
      "GetAutoscaleConfigurationPolicyResponse": {
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/GetAutoscaleConfigurationPolicyResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 12,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "x-package": "autoscale"
      },
      "GetAutoscaleConfigurationPolicyResponseData": {
        "type": "object",
        "properties": {
          "policies": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GetAutoscaleConfigurationPolicyResponsePolicyResponse"
            },
            "description": "The policy which was retrieved by the request."
          }
        },
        "x-package": "autoscale"
      },
      "GetAutoscaleConfigurationPolicyResponsePolicyResponse": {
        "required": [
          "status",
          "policy"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "policy": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AutoscalePolicy"
              }
            ],
            "description": "The policy which was retrieved by the request."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the resource."
          },
          "message": {
            "example": "No service with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "autoscale"
      },
      "GetAutoscaleConfigurationsResponse": {
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "enum": [
              "success",
              "error",
              "unconfigured"
            ],
            "type": "string",
            "description": "The status of the response.",
            "format": "enum"
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/GetAutoscaleConfigurationsResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 50,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for a GetAutoscaleConfigurationsRequest.",
        "x-package": "autoscale"
      },
      "GetAutoscaleConfigurationsResponseData": {
        "type": "object",
        "properties": {
          "service_groups": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GetAutoscaleConfigurationsResponseServiceGroup"
            },
            "description": "The configuration(s) which were retrieved by the request."
          }
        },
        "x-package": "autoscale"
      },
      "GetAutoscaleConfigurationsResponseServiceGroup": {
        "required": [
          "status",
          "uuid",
          "name",
          "enabled"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the service where the configuration was created.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-instance-template",
            "type": "string",
            "description": "The name of the service where the configuration was created."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the service group."
          },
          "enabled": {
            "example": true,
            "type": "boolean",
            "description": "If the autoscale configuration is enabled."
          },
          "min_size": {
            "example": 2,
            "type": "integer",
            "description": "The minimum number of instances to keep running.\nOnly if enabled is true.",
            "format": "int64"
          },
          "max_size": {
            "example": 10,
            "type": "integer",
            "description": "The maximum number of instances to keep running.\nOnly if enabled is true.",
            "format": "int64"
          },
          "warmup_time_ms": {
            "example": 3000,
            "type": "integer",
            "description": "The warmup time in seconds for new instances.\nOnly if enabled is true.",
            "format": "int64"
          },
          "cooldown_time_ms": {
            "example": 3000,
            "type": "integer",
            "description": "The cooldown time in seconds for the autoscale configuration.\nOnly if enabled is true.",
            "format": "int64"
          },
          "template": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ServiceGroupTemplate"
              }
            ],
            "description": "The instance template used for the autoscale configuration.\nOnly if enabled is true."
          },
          "policies": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AutoscalePolicy"
            },
            "description": "The policies applied to the autoscale configuration."
          },
          "message": {
            "example": "No service with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "autoscale"
      },
      "GetCertificatesResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/GetCertificatesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 55,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for getting one or more certificate(s) given their\nUUID(s) or name(s).",
        "x-package": "certificates"
      },
      "GetCertificatesResponseData": {
        "type": "object",
        "properties": {
          "certificates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Certificate"
            },
            "description": "The certificate(s) which were retrieved by the request."
          }
        },
        "x-package": "certificates"
      },
      "GetImagesRequestTagOrDigest": {
        "type": "object",
        "allOf": [
          {
            "oneOf": [
              {
                "title": "digest",
                "required": [
                  "digest"
                ],
                "type": "object",
                "properties": {
                  "digest": {
                    "example": "sha256:1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
                    "type": "string"
                  }
                }
              },
              {
                "title": "tag",
                "required": [
                  "tag"
                ],
                "type": "object",
                "properties": {
                  "tag": {
                    "example": "my-image:latest",
                    "type": "string"
                  }
                }
              }
            ]
          }
        ],
        "x-package": "images"
      },
      "GetImagesResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "No images found",
            "type": "string",
            "description": "An optional message providing additional information about the response."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/GetImagesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 123,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "x-package": "images"
      },
      "GetImagesResponseData": {
        "type": "object",
        "properties": {
          "images": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Image"
            },
            "description": "The list of images."
          }
        },
        "x-package": "images"
      },
      "GetInstanceLogsByUUIDRequestBody": {
        "type": "object",
        "properties": {
          "offset": {
            "example": 56000,
            "type": "integer",
            "description": "The byte offset of the log output to receive.  A negative sign makes the\noffset relative to the end of the log.",
            "format": "int64"
          },
          "limit": {
            "example": 1500,
            "type": "integer",
            "description": "The amount of bytes to return at most.",
            "format": "int64"
          }
        },
        "x-package": "instances"
      },
      "GetInstancesLogsRequestItem": {
        "type": "object",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "offset": {
                "example": 450,
                "type": "integer",
                "description": "The byte offset of the log output to receive.  A negative sign makes the\noffset relative to the end of the log.",
                "format": "int64"
              },
              "limit": {
                "example": 3000,
                "type": "integer",
                "description": "The amount of bytes to return at most.",
                "format": "int64"
              }
            }
          },
          {
            "oneOf": [
              {
                "title": "uuid",
                "type": "object",
                "properties": {
                  "uuid": {
                    "example": "123e4567-e89b-12d3-a456-426614174000",
                    "type": "string",
                    "description": "The UUID of the instance to retrieve logs for.  Mutually exclusive with\nname.",
                    "format": "uuid"
                  }
                }
              },
              {
                "title": "name",
                "type": "object",
                "properties": {
                  "name": {
                    "example": "funky-town-g756b5d",
                    "type": "string",
                    "description": "The name of the instance to retrieve logs for.  Mutually exclusive with\nUUID."
                  }
                }
              }
            ]
          }
        ],
        "description": "A single item in the request.",
        "x-package": "instances"
      },
      "GetInstancesLogsResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/GetInstancesLogsResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 47,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for getting the logs of one or more instance(s) by\ntheir UUID(s) or name(s).",
        "x-package": "instances"
      },
      "GetInstancesLogsResponseAvailable": {
        "required": [
          "start",
          "end"
        ],
        "type": "object",
        "properties": {
          "start": {
            "example": 250,
            "type": "integer",
            "description": "The first byte offset that can be retrieved.",
            "format": "int64"
          },
          "end": {
            "example": 2700,
            "type": "integer",
            "description": "The last byte offset that can be retrieved.",
            "format": "int64"
          }
        },
        "x-package": "instances"
      },
      "GetInstancesLogsResponseData": {
        "type": "object",
        "properties": {
          "instances": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GetInstancesLogsResponseLoggedInstance"
            },
            "description": "The instance which this requested waited on.\n\nNote: only one instance can be specified in the request, so this will\nalways contain a single entry."
          }
        },
        "x-package": "instances"
      },
      "GetInstancesLogsResponseLoggedInstance": {
        "required": [
          "uuid",
          "name",
          "output",
          "available",
          "range",
          "state"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the instance.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-town-g756b5d",
            "type": "string",
            "description": "The name of the instance."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the instance."
          },
          "output": {
            "example": "d2h5LWFyZS15b3UtZGVjb2RpbmctdGhpcw==",
            "type": "string",
            "description": "Base64 encoded log output of the instance."
          },
          "available": {
            "allOf": [
              {
                "$ref": "#/components/schemas/GetInstancesLogsResponseAvailable"
              }
            ],
            "description": "Description of the log availability."
          },
          "range": {
            "allOf": [
              {
                "$ref": "#/components/schemas/GetInstancesLogsResponseRange"
              }
            ],
            "description": "Description of the range that was returned.  Useful for requests with\noffset relative to end."
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/InstanceState"
              }
            ],
            "description": "State of the instance when the logs were retrieved."
          },
          "message": {
            "example": "No instance with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          }
        },
        "x-package": "instances"
      },
      "GetInstancesLogsResponseRange": {
        "required": [
          "start",
          "end"
        ],
        "type": "object",
        "properties": {
          "start": {
            "example": 450,
            "type": "integer",
            "description": "The first retrieved byte.",
            "format": "int64"
          },
          "end": {
            "example": "funky-town-g756b5d",
            "type": "integer",
            "description": "The last retrieved byte.",
            "format": "int64"
          }
        },
        "x-package": "instances"
      },
      "GetInstancesMetricsResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/GetInstancesMetricsResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 76,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for getting the metrics of one or more instance(s)\ngiven their UUID(s) or name(s).",
        "x-package": "instances"
      },
      "GetInstancesMetricsResponseData": {
        "type": "object",
        "properties": {
          "instances": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GetInstancesMetricsResponseInstanceMetrics"
            },
            "description": "The instance which this requested metrics for.  Note: only one instance\ncan be specified in the request, so this will always contain a single\nentry."
          }
        },
        "x-package": "instances"
      },
      "GetInstancesMetricsResponseInstanceMetrics": {
        "required": [
          "rss_bytes",
          "cpu_time_ms",
          "boot_time_us",
          "net_time_us",
          "rx_bytes",
          "rx_packets",
          "tx_bytes",
          "tx_packets",
          "nconns",
          "nreqs",
          "nqueued",
          "ntotal"
        ],
        "type": "object",
        "properties": {
          "rss_bytes": {
            "example": 5677765543,
            "type": "integer",
            "description": "Resident set size of the VMM in bytes.\n\nThe resident set size (RSS) specifies the amount of physical memory that\nhas been touched by the instance and is currently reserved for the\ninstance on the Unikraft Cloud server.  The RSS grows until the instance\nhas touched all memory assigned to it via the memory_mb setting and may\nalso exceed this value as supporting services running outside the\ninstance acquire memory.  The RSS is different from the current amount of\nmemory allocated by the application, which is likely to fluctuate over\nthe lifetime of the application.  The RSS is not a cumulative metric.\nWhen the instance is stopped rss goes down to 0.",
            "format": "uint64"
          },
          "cpu_time_ms": {
            "example": 560007005,
            "type": "integer",
            "description": "Consumed CPU time in milliseconds.",
            "format": "uint64"
          },
          "boot_time_us": {
            "example": 560007005,
            "type": "integer",
            "description": "The boot time of the instance in microseconds.  We take a pragmatic\napproach is to define the boot time.  We calculate this as the difference\nin time between the moment the virtualization toolstack is invoked to\nrespond to a VM boot request and the moment the OS starts executing user\ncode (i.e., the end of the guest OS boot process).  This is essentially the\ntime that a user would experience in a deployment, minus the application\ninitialization time, which we leave out since it is independent from the\nOS.",
            "format": "uint64"
          },
          "net_time_us": {
            "example": 560007005,
            "type": "integer",
            "description": "This is the time it took for the user-level application to start listening\non a non-localhost port measured in microseconds.  This is the time from\nwhen the instance started until it reasonably ready to start responding to\nnetwork requests.  This is useful for measuring the time it takes for the\ninstance to become operationally ready.",
            "format": "uint64"
          },
          "rx_bytes": {
            "example": 12312353,
            "type": "integer",
            "description": "Total amount of bytes received from network.",
            "format": "uint64"
          },
          "rx_packets": {
            "example": 43432,
            "type": "integer",
            "description": "Total count of packets received from network.",
            "format": "uint64"
          },
          "tx_bytes": {
            "example": 6565643,
            "type": "integer",
            "description": "Total amount of bytes transmitted over network.",
            "format": "uint64"
          },
          "tx_packets": {
            "example": 54534,
            "type": "integer",
            "description": "Total count of packets transmitted over network.",
            "format": "uint64"
          },
          "nconns": {
            "example": 5,
            "type": "integer",
            "description": "Number of currently established inbound connections (non-HTTP).",
            "format": "uint64"
          },
          "nreqs": {
            "example": 12,
            "type": "integer",
            "description": "Number of in-flight HTTP requests.",
            "format": "uint64"
          },
          "nqueued": {
            "example": 5,
            "type": "integer",
            "description": "Number of queued inbound connections and HTTP requests.",
            "format": "uint64"
          },
          "ntotal": {
            "example": 21,
            "type": "integer",
            "description": "Total number of inbound connections and HTTP requests handled.",
            "format": "uint64"
          },
          "message": {
            "example": "No instance with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the instance."
          }
        },
        "x-package": "instances"
      },
      "GetInstancesResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/GetInstancesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 432,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response after retrieving an instance by its name or UUID.",
        "x-package": "instances"
      },
      "GetInstancesResponseData": {
        "type": "object",
        "properties": {
          "instances": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Instance"
            },
            "description": "The instance(s) that were retrieved by the request."
          }
        },
        "x-package": "instances"
      },
      "GetServiceGroupsResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/GetServiceGroupsResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 46,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for getting one or more service group(s) given their\nUUID(s) or name(s).",
        "x-package": "services"
      },
      "GetServiceGroupsResponseData": {
        "type": "object",
        "properties": {
          "service_groups": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceGroup"
            },
            "description": "The service group(s) which were retrieved by the request."
          }
        },
        "x-package": "services"
      },
      "GetTemplateInstancesResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/GetTemplateInstancesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 76,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for getting one or more template instances.",
        "x-package": "instances"
      },
      "GetTemplateInstancesResponseData": {
        "type": "object",
        "properties": {
          "instances": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Instance"
            },
            "description": "List of template instances that were retrieved during the operation."
          }
        },
        "x-package": "instances"
      },
      "GetTemplateVolumesResponse": {
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Partial success",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/GetTemplateVolumesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 46,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for getting one or more template volumes.",
        "x-package": "volumes"
      },
      "GetTemplateVolumesResponseData": {
        "type": "object",
        "properties": {
          "volumes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Volume"
            },
            "description": "The template volume(s) which were retrieved by the request."
          }
        },
        "x-package": "volumes"
      },
      "GetVolumesResponse": {
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/GetVolumesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 46,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for getting one or more volume(s) given their\nUUID(s) or name(s).",
        "x-package": "volumes"
      },
      "GetVolumesResponseData": {
        "type": "object",
        "properties": {
          "volumes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Volume"
            },
            "description": "The volume(s) which were retrieved by the request."
          }
        },
        "x-package": "volumes"
      },
      "GoogleProtobufValue": {
        "description": "Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values."
      },
      "HealthzResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Invalid name 'non-funky-town'",
            "type": "string",
            "description": "An optional message providing additional information about the response."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nWhere the node is located."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/HealthzResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "op_time_us": {
            "example": 875,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for a health check of the platform.",
        "x-package": "node"
      },
      "HealthzResponseData": {
        "type": "object",
        "properties": {
          "checks": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "versions": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "license": {
            "$ref": "#/components/schemas/DataLicense"
          }
        },
        "description": "Additional data returned by the health check.",
        "x-package": "node"
      },
      "Image": {
        "required": [
          "url",
          "created_at",
          "initrd_or_rom",
          "size_in_bytes"
        ],
        "type": "object",
        "properties": {
          "url": {
            "example": "my-image:latest",
            "type": "string"
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the image."
          },
          "created_at": {
            "example": "2021-01-01T00:00:00Z",
            "type": "string",
            "description": "The time the volume was created.",
            "format": "date-time"
          },
          "initrd_or_rom": {
            "example": true,
            "type": "boolean"
          },
          "size_in_bytes": {
            "example": 10485760,
            "type": "integer",
            "format": "int64"
          },
          "args": {
            "example": [
              "--verbose"
            ],
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "env": {
            "example": {
              "production": "on"
            },
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "tags": {
            "example": [
              "latest"
            ],
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "users": {
            "example": [
              "root"
            ],
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "x-package": "images"
      },
      "ImageSpec": {
        "required": [
          "url"
        ],
        "type": "object",
        "properties": {
          "url": {
            "example": "index.docker.io/library/nginx:latest",
            "type": "string",
            "description": "The image URL"
          },
          "credentials": {
            "example": "dXNlcjpwYXNzd29yZA==",
            "type": "string",
            "description": "Optional credentials for authenticating to an OCI registry.\nOnly valid for OCI registry URLs; the platform rejects this\nfield for non-OCI schemes."
          },
          "headers": {
            "example": {
              "Authorization": "Bearer token123"
            },
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Optional HTTP headers to send when fetching the image."
          },
          "pull_policy": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PullPolicy"
              }
            ],
            "description": "Controls when the image is pulled relative to what is already cached on\nthe node."
          }
        },
        "description": "ImageSpec describes an image to use for an instance.",
        "x-package": "instances"
      },
      "InlineDataEncoding": {
        "enum": [
          "text",
          "base64"
        ],
        "type": "string",
        "description": "Encoding type for inline file data.",
        "format": "enum",
        "x-package": "common"
      },
      "InlineFile": {
        "required": [
          "path",
          "data"
        ],
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "The file path within the image."
          },
          "encoding": {
            "allOf": [
              {
                "$ref": "#/components/schemas/InlineDataEncoding"
              }
            ],
            "description": "(Optional).  The encoding of the data field.  Defaults to \"text\"."
          },
          "data": {
            "type": "string",
            "description": "The file data, encoded according to the encoding field."
          }
        },
        "description": "An inline file entry represents a single file within an image.",
        "x-package": "common"
      },
      "Instance": {
        "required": [
          "uuid",
          "name",
          "created_at",
          "state",
          "image",
          "memory_mb",
          "vcpus",
          "restart_policy"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "description": "The UUID of the instance.\n\nThis is a unique identifier for the instance that is generated when the\ninstance is created.  The UUID is used to reference the instance in API\ncalls and can be used to identify the instance in all API calls that\nrequire an instance identifier.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-town-g756b5d",
            "type": "string",
            "description": "The name of the instance.\n\nThis is a human-readable name that can be used to identify the instance.\nThe name must be unique within the context of your account.  The name can\nalso be used to identify the instance in API calls."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nWhere the instance is located."
          },
          "created_at": {
            "example": "2023-10-01T12:00:00Z",
            "type": "string",
            "description": "The time the instance was created.",
            "format": "date-time"
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/InstanceState"
              }
            ],
            "description": "The state of the instance.  This indicates the current state of the\ninstance, such as whether it is running, stopped, or in an error state."
          },
          "private_fqdn": {
            "example": "funky-town-g756b5d.internal",
            "type": "string",
            "description": "The internal hostname of the instance.  This address can be used privately\nwithin the Unikraft Cloud network to access the instance.  It is not\naccessible from the public Internet."
          },
          "image": {
            "example": "nginx:latest",
            "type": "string",
            "description": "The image used to create the instance.  This is a reference to the\nUnikraft image that was used to create the instance."
          },
          "memory_mb": {
            "example": 1024,
            "type": "integer",
            "description": "The amount of memory in megabytes allocated for the instance.  This is the\ntotal amount of memory that is available to the instance for its\noperations.",
            "format": "uint64"
          },
          "vcpus": {
            "example": 1,
            "type": "integer",
            "description": "The number of vCPUs allocated for the instance.  This is the total\nnumber of virtual CPUs that are available to the instance for its\noperations.",
            "format": "uint32"
          },
          "args": {
            "example": "--port=8080 --debug",
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The arguments passed to the instance when it was started.  This is a\nlist of command-line arguments that were provided to the instance at\nstartup.  These arguments can be used to configure the behavior of the\ninstance and its applications."
          },
          "env": {
            "example": {
              "ENV_VAR": "value"
            },
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Environment variables set for the instance."
          },
          "start_count": {
            "example": 6,
            "type": "integer",
            "description": "The total number of times the instance has been started.  This is a counter\nthat increments each time the instance is started, regardless of whether it\nwas manually stopped or restarted.  This can be useful for tracking the\nusage of the instance over time and/or for debugging purposes.\n\nNot used for template instances.",
            "format": "uint64"
          },
          "restart_count": {
            "example": 1,
            "type": "integer",
            "description": "The total number of times the instance has been restarted. This is a counter\nthat increments each time the instance has been restarted. This can be\nuseful for tracking the usage of the instance over time and/or for\ndebugging purposes.\nNot used for template instances.",
            "format": "uint64"
          },
          "started_at": {
            "example": "2023-10-01T12:00:00Z",
            "type": "string",
            "description": "The time the instance was started.  This is the timestamp when the\ninstance was last started.\nNot used for template instances.",
            "format": "date-time"
          },
          "stopped_at": {
            "example": "2023-10-01T12:00:00Z",
            "type": "string",
            "description": "The time the instance was stopped.  This is the timestamp when the\ninstance was last stopped.  If the instance is currently running, this\nfield will be empty.\nNot used for template instances.",
            "format": "date-time"
          },
          "uptime_ms": {
            "example": 8954050300,
            "type": "integer",
            "description": "The total amount of time the instance has been running in milliseconds.\nNot used for template instances.",
            "format": "uint64"
          },
          "vmm_start_time_us": {
            "example": 70040,
            "type": "integer",
            "description": "(Developer-only).  The time taken between the main controller and the\nbeginning of execution of the VMM (Virtual Machine Monitor) measured in\nmicroseconds.  This field is primarily used for debugging and performance\nanalysis purposes.\nNot used for template instances.",
            "format": "uint64"
          },
          "vmm_load_time_us": {
            "example": 4050,
            "type": "integer",
            "description": "(Developer-only).  The time it took the VMM (Virtual Machine Monitor) to\nload the instance's kernel and initramfs into VM memory measured in\nmicroseconds.  This field is primarily used for debugging and performance\nanalysis purposes.\nNot used for template instances.",
            "format": "uint64"
          },
          "vmm_ready_time_us": {
            "example": 400,
            "type": "integer",
            "description": "(Developer-only).  The time taken for the VMM (Virtual Machine Monitor) to\nbecome ready to execute the instance measured in microseconds.  This is the\ntime from when the VMM started until it was ready to execute the instance's\ncode.  This field is primarily used for debugging and performance analysis\npurposes.\nNot used for template instances.",
            "format": "uint64"
          },
          "boot_time_us": {
            "example": 9000,
            "type": "integer",
            "description": "The boot time of the instance in microseconds.  We take a pragmatic\napproach is to define the boot time.  We calculate this as the difference\nin time between the moment the virtualization toolstack is invoked to\nrespond to a VM boot request and the moment the OS starts executing user\ncode (i.e., the end of the guest OS boot process).  This is essentially the\ntime that a user would experience in a deployment, minus the application\ninitialization time, which we leave out since it is independent from the\nOS.\nNot used for template instances.",
            "format": "uint64"
          },
          "net_time_us": {
            "example": 11000,
            "type": "integer",
            "description": "This is the time it took for the user-level application to start listening\non a non-localhost port measured in microseconds.  This is the time from\nwhen the instance started until it reasonably ready to start responding to\nnetwork requests.  This is useful for measuring the time it takes for the\ninstance to become operationally ready.\nNot used for template instances.",
            "format": "uint64"
          },
          "stop_reason": {
            "example": 15,
            "type": "integer",
            "description": "The instance stop reason.\n\nProvides reason as to why an instance is stopped or in the process of\nshutting down.  The stop reason is a bitmask that tells you the origin of\nthe shutdown:\n\n| Bit     | 4          | 3          | 2          | 1          | 0 (LSB)      |\n|---------|------------|------------|------------|------------|--------------|\n| Purpose | [F]orced   | [U]ser     | [P]latform | [A]pp      | [K]ernel     |\n\n- **Forced**:   This was a force stop.  A forced stop does not give the\n                instance a chance to perform a clean shutdown.  Bits 0\n                (Kernel) and 1 (App) can thus never be set for forced\n                shutdowns.  Consequently, there won't be an `exit_code` or\n                `stop_code`.\n- **User**:     Stop initiated by user, e.g. via an API call.\n- **Platform**: Stop initiated by platform, e.g. an autoscale policy.\n- **App**:      The Application exited.  The `exit_code` field will be set.\n- **Kernel**:   The kernel exited.  The `stop_code` field will be set.\n\nFor example, the stop reason will contain the following values in the given\nscenarios:\n\n| Value | Bitmask | Aliases | Scenario |\n|-------|---------|---------|----------|\n| 28    | `11100` | `FUP--` | Forced user-initiated shutdown. |\n| 15    | `01111` | `-UPAK` | Regular user-initiated shutdown. The application and kernel have exited. The exit_code and stop_code indicate if the application and kernel shut down cleanly. |\n| 13    | `01101` | `-UP-K` | The user initiated a shutdown but the application was forcefully killed by the kernel during shutdown. This can be the case if the image does not support a clean application exit or the application crashed after receiving a termination signal. The exit_code won’t be present in this scenario. |\n| 7     | `00111` | `--PAK` | Unikraft Cloud initiated the shutdown, for example, due to scale-to-zero. The application and kernel have exited. The exit_code and stop_code indicate if the application and kernel shut down cleanly. |\n| 3     | `00011` | `---AK` | The application exited. The exit_code and stop_code indicate if the application and kernel shut down cleanly. |\n| 1     | `00001` | `----K` | The instance likely expierenced a fatal crash and the stop_code contains more information about the cause of the crash. |\n| 0     | `00000` | `-----` | The stop reason is unknown. |\nNot used for template instances.",
            "format": "uint32"
          },
          "exit_code": {
            "example": 137,
            "type": "integer",
            "description": "The application exit code.\n\nThis is the code which the application returns upon leaving its main entry\npoint.  The encoding of the exit code is application specific.  See the\ndocumentation of the application for more details.  Usually, an exit code\nof `0` indicates success / no failure.\nNot used for template instances.",
            "format": "uint32"
          },
          "stop_code": {
            "example": 33024,
            "type": "integer",
            "description": "The kernel stop code.\n\nThis value encodes multiple details about the stop irrespective of the\napplication.\n\n```\nMSB                                                     LSB\n┌──────────────┬──────────┬──────────┬───────────┬────────┐\n│ 31 ────── 24 │ 23 ── 16 │    15    │ 14 ──── 8 │ 7 ── 0 │\n├──────────────┼──────────┼──────────┼───────────┼────────┤\n│ reserved[^1] │ errno    │ shutdown │ initlevel │ reason │\n└──────────────┴──────────┴──────────┴───────────┴────────┘\n```\n\n- **errno**:     The application errno, using Linux's errno.h values.\n                 (Optional, can be 0.)\n- **shutdown**:  Whether the shutdown originated from the inittable (0) or\n                 from the termtable (1).\n- **initlevel**: The initlevel at the time of the stop.\n- **reason**:    The reason for the stop.  See `StopCodeReason`.\n\n[^1]: Reserved for future use.\nNot used for template instances.",
            "format": "uint32"
          },
          "restart_policy": {
            "allOf": [
              {
                "$ref": "#/components/schemas/InstanceRestartPolicy"
              }
            ],
            "description": "The restart configuration for the instance.\n\nWhen an instance stops either because the application exits or the instance\ncrashes, Unikraft Cloud can auto-restart your instance.  Auto-restarts are\nperformed according to the restart policy configured for a particular\ninstance.\n\nThe policy can have the following values:\n\n| Policy       | Description |\n|--------------|-------------|\n| `never`      | Never restart the instance (default). |\n| `always`     | Always restart the instance when the stop is initiated from within the instance (i.e., the application exits or the instance crashes). |\n| `on-failure` | Only restart the instance if it crashes. |\n\nWhen an instance stops, the stop reason and the configured restart policy\nare evaluated to decide if a restart should be performed.  Unikraft Cloud\nuses an exponential back-off delay (immediate, 5s, 10s, 20s, 40s, ..., 5m)\nto slow down restarts in tight crash loops.  If an instance runs without\nproblems for 10s the back-off delay is reset and the restart sequence ends.\n\nThe `restart.attempt` attribute reported in counts the number of restarts\nperformed in the current sequence.  The `restart.next_at` field indicates\nwhen the next restart will take place if a back-off delay is in effect.\n\nA manual start or stop of the instance aborts the restart sequence and\nresets the back-off delay."
          },
          "scale_to_zero": {
            "allOf": [
              {
                "$ref": "#/components/schemas/InstanceScaleToZero"
              }
            ],
            "description": "The scale-to-zero configuration for the instance.\n\nWith conventional cloud platforms you need to keep at least one instance\nrunning at all times to be able to respond to incoming requests. Performing\na just-in-time cold boot is simply too time-consuming and would create a\nresponse latency of multiple seconds.  This is not the case with Unikraft\nCloud.  Instances on Unikraft Cloud are able to cold boot within\nmilliseconds, which allows us to perform low-latency scale-to-zero.\n\nTo enable scale-to-zero for an instance it is sufficient to add a\n`scale_to_zero` configuration block.  Unikraft Cloud will then put the\ninstance into standby if there is no traffic to your service within the\nwindow of a cooldown period.  When there is new traffic coming in, it is\nautomatically started again.\n\nIf you have a heavyweight application that takes long to cold boot or has\nbad first request latency (e.g., with JIT compilation) consider to enable\nstateful scale-to-zero."
          },
          "volumes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InstanceVolume"
            },
            "description": "The list of volumes attached to the instance."
          },
          "service_group": {
            "allOf": [
              {
                "$ref": "#/components/schemas/InstanceServiceGroup"
              }
            ],
            "description": "The service group configuration for the instance."
          },
          "network_interfaces": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InstanceNetworkInterface"
            },
            "description": "The network interfaces of the instance.\nNot used for template instances."
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The tags associated with the instance."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "An optional field representing the status of the request.  This field is\nonly set when this message object is used as a response message."
          },
          "message": {
            "example": "No instance with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is only set when this message object is used as a response\nmessage, and is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is only set when this message object is used as a response\nmessage, and is useful when the status is not `success`.",
            "format": "int32"
          },
          "snapshot": {
            "allOf": [
              {
                "$ref": "#/components/schemas/InstanceSnapshot"
              }
            ],
            "description": "The snapshot of the instance, if exists."
          },
          "delete_lock": {
            "type": "boolean",
            "description": "If set to true, the instance cannot be deleted until the lock is removed."
          },
          "restart": {
            "allOf": [
              {
                "$ref": "#/components/schemas/InstanceRestartAttempt"
              }
            ],
            "description": "The current restart attempt for the instance.\nNot used for template instances."
          },
          "roms": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InstanceRom"
            },
            "description": "Read-Only Memory (ROM) blobs to attach to the instance.\nUnikraft Cloud supports the ability to attach Read-Only Memory (ROM) blobs\nto instances. It allows you to create a general-purpose base image and\nthen customize individual instances by attaching code or data as separate\nROM blobs."
          },
          "schedules": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Schedule"
            },
            "description": "Scheduled operations for this instance.\n\nEach schedule defines a calendar expression and an action (`start`,\n`stop`, `delete`, or `exec`) to perform at matching times.  When the\naction is `exec`, the `args` field of the schedule specifies the command\nto run inside the instance."
          },
          "autokill": {
            "allOf": [
              {
                "$ref": "#/components/schemas/InstanceAutokill"
              }
            ],
            "description": "Automatic delete-on-idle/request-limit configuration.\nNot used for template instances."
          },
          "template_autokill": {
            "allOf": [
              {
                "$ref": "#/components/schemas/InstanceTemplateAutokill"
              }
            ],
            "description": "Template-specific automatic delete-on-idle configuration.\nNot used for non-template instances."
          },
          "updates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InstancePendingUpdate"
            },
            "description": "Queued property changes awaiting application."
          },
          "sched_priority": {
            "example": "high",
            "allOf": [
              {
                "$ref": "#/components/schemas/SchedPriority"
              }
            ],
            "description": "The scheduling priority for the instance. Only present for\nusers with scheduling priority override permissions."
          }
        },
        "description": "An instance is a unikernel virtual machine running an application.",
        "x-package": "instances"
      },
      "InstanceAutokill": {
        "type": "object",
        "properties": {
          "time_ms": {
            "type": "integer",
            "description": "Time in milliseconds after the instance was stopped before it is deleted.\nA value of 0 disables time-based autokill.",
            "format": "uint64"
          },
          "num_requests": {
            "type": "integer",
            "description": "Maximum number of requests/connections the instance serves before it is\ndeleted. A value of 0 disables request-based autokill.",
            "format": "uint32"
          }
        },
        "description": "Automatic delete-on-idle/request-limit configuration for non-template instances.\nNot used for template instances.",
        "x-package": "instances"
      },
      "InstanceCreateArgsInstanceCreateRequestRoms": {
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the ROM to use for the autoscale configuration."
          },
          "image": {
            "type": "string",
            "description": "(Optional).  The image of the ROM to use for the autoscale configuration.\nMutually exclusive with `files`."
          },
          "files": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InlineFile"
            },
            "description": "(Optional).  Inline files to use as the ROM content.  When specified,\nthe platform creates an EROFS image from the provided files.\nMutually exclusive with `image`."
          }
        },
        "x-package": "autoscale"
      },
      "InstanceFeature": {
        "enum": [
          "delete-on-stop"
        ],
        "type": "string",
        "description": "Features are specific configurations or capabilities that can be enabled for\nthe instance.\n\nThe list of available features to enable for the instance:\n\n| Feature          | Description |\n|------------------|-------------|\n| `delete_on_stop` | The instance will be deleted when it is stopped. This is useful for instances that are not needed after they are stopped, such as temporary or ephemeral instances. |",
        "format": "enum",
        "x-package": "instances"
      },
      "InstanceNetworkInterface": {
        "required": [
          "uuid",
          "private_ip",
          "mac",
          "rx_bytes",
          "rx_packets",
          "tx_bytes",
          "tx_packets"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "example": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
            "type": "string",
            "description": "The UUID of the network interface. This is a unique identifier for the\nnetwork interface that is generated when the instance is created.",
            "format": "uuid"
          },
          "private_ip": {
            "example": "10.0.0.61",
            "type": "string",
            "description": "The private IP address of the network interface. This is the internal IP\naddress that is used for communication between instances within the same\nnetwork."
          },
          "mac": {
            "example": "12:b0:a0:00:00:3d",
            "type": "string",
            "description": "The MAC address of the network interface."
          },
          "rx_bytes": {
            "example": 5345,
            "type": "integer",
            "description": "Amount of bytes received from interface.",
            "format": "uint64"
          },
          "rx_packets": {
            "example": 110,
            "type": "integer",
            "description": "Count of packets received from interface",
            "format": "uint64"
          },
          "tx_bytes": {
            "example": 1500,
            "type": "integer",
            "description": "Amount of bytes sent to interface.",
            "format": "uint64"
          },
          "tx_packets": {
            "example": 12,
            "type": "integer",
            "description": "Count of packets sent to interface",
            "format": "uint64"
          }
        },
        "description": "An instance network interface.",
        "x-package": "instances"
      },
      "InstancePendingUpdate": {
        "required": [
          "prop",
          "op",
          "value",
          "status"
        ],
        "type": "object",
        "properties": {
          "prop": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MutableInstanceProperty"
              }
            ],
            "description": "The property being updated."
          },
          "op": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MutableInstanceOperation"
              }
            ],
            "description": "The patch operation type."
          },
          "value": {
            "allOf": [
              {
                "$ref": "#/components/schemas/GoogleProtobufValue"
              }
            ],
            "description": "The new value for the property.  Type depends on the property being\nupdated."
          },
          "status": {
            "enum": [
              "pending",
              "failed"
            ],
            "type": "string",
            "description": "The status of this update.",
            "format": "enum"
          },
          "error": {
            "type": "string",
            "description": "Error message.  Only present when status is \"failed\"."
          }
        },
        "description": "A queued property change awaiting application (typically on next restart).",
        "x-package": "instances"
      },
      "InstanceRestartAttempt": {
        "required": [
          "attempt"
        ],
        "type": "object",
        "properties": {
          "attempt": {
            "example": 1,
            "type": "integer",
            "description": "Current restart attempt number. This is incremented each time the instance\nis restarted automatically by the platform.",
            "format": "uint32"
          },
          "next_at": {
            "example": "2023-10-05T14:48:00Z",
            "type": "string",
            "description": "Timestamp of the next scheduled restart attempt.",
            "format": "date-time"
          }
        },
        "description": "Records the current restart attempt of an instance.",
        "x-package": "instances"
      },
      "InstanceRestartPolicy": {
        "enum": [
          "never",
          "always",
          "on-failure"
        ],
        "type": "string",
        "description": "The restart policy of an instance.\n\nWhen an instance stops either because the application exits or the instance\ncrashes, Unikraft Cloud can auto-restart your instance.  Auto-restarts are\nperformed according to the restart policy configured for a particular\ninstance.\n\nThe policy can have the following values:\n\n| Policy       | Description |\n|--------------|-------------|\n| `never`      | Never restart the instance (default). |\n| `always`     | Always restart the instance when the stop is initiated from within the instance (i.e., the application exits or the instance crashes). |\n| `on-failure` | Only restart the instance if it crashes. |\n\nWhen an instance stops, the stop reason and the configured restart policy are\nevaluated to decide if a restart should be performed.  Unikraft Cloud uses an\nexponential back-off delay (immediate, 5s, 10s, 20s, 40s, ..., 5m) to slow\ndown restarts in tight crash loops. If an instance runs without problems for\n10s the back-off delay is reset and the restart sequence ends.\n\nThe `restart.attempt` attribute reported in counts the number of restarts\nperformed in the current sequence.  The `restart.next_at` field indicates\nwhen the next restart will take place if a back-off delay is in effect.\n\nA manual start or stop of the instance aborts the restart sequence and resets\nthe back-off delay.",
        "format": "enum",
        "x-package": "instances"
      },
      "InstanceRom": {
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "name": {
            "example": "funky-rom",
            "type": "string",
            "description": "The name of the ROM to use for the instance configuration."
          },
          "image": {
            "example": "nginx:latest",
            "type": "string",
            "description": "(Optional).  The image of the ROM to use for the instance configuration.\nMutually exclusive with `files`."
          },
          "at": {
            "example": "/rom0",
            "type": "string",
            "description": "(Optional).  The path at which the ROM should be automatically mounted\ninside the instance.  When set, the platform mounts the ROM device at\nthe specified path so the guest does not need to mount it manually.\nWhen omitted, the ROM is exposed as a raw block device and the guest is\nresponsible for mounting it."
          },
          "files": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InlineFile"
            },
            "description": "(Optional).  Inline files to use as the ROM content.  When specified,\nthe platform creates an EROFS image from the provided files.\nMutually exclusive with `image`."
          }
        },
        "description": "Read-Only Memory (ROM) blob to attach to the instance.",
        "x-package": "instances"
      },
      "InstanceScaleToZero": {
        "type": "object",
        "properties": {
          "enabled": {
            "example": true,
            "type": "boolean",
            "description": "Indicates whether scale-to-zero is enabled for the instance."
          },
          "policy": {
            "allOf": [
              {
                "$ref": "#/components/schemas/InstanceScaleToZeroPolicy"
              }
            ],
            "description": "The specific policy to use for scaling the instance to zero."
          },
          "stateful": {
            "example": true,
            "type": "boolean",
            "description": "Whether the instance should be stateful when scaled to zero. If set to\ntrue, the instance will retain its state (e.g., RAM contents) when scaled\nto zero.  This is useful for instances that need to maintain their state\nacross scale-to-zero operations.  If set to false, the instance will lose\nits state when scaled to zero, and it will be restarted from scratch when\nscaled back up."
          },
          "cooldown_time_ms": {
            "example": 3000,
            "type": "integer",
            "description": "The cooldown time in milliseconds before the instance can be scaled to\nzero again.  This is useful to prevent rapid scaling to zero and back up,\nwhich can lead to performance issues or resource exhaustion.",
            "format": "int32"
          },
          "notify_time_ms": {
            "example": 1000,
            "type": "integer",
            "description": "The notification time in milliseconds before the instance is scaled to\nzero. This allows the instance to perform any necessary cleanup or state\nsaving before being scaled down.",
            "format": "int32"
          }
        },
        "description": "Scale-to-zero defines the configuration for scaling the instance to zero.\nWhen an instance is scaled-to-zero it can be either stopped (and fully\nshutdown) or paused wherein the state of the instance is preserved (e.g., RAM\ncontents) and the instance can be resumed later without losing its state,\ni.e. \"stateful\".",
        "x-package": "instances"
      },
      "InstanceScaleToZeroPolicy": {
        "enum": [
          "off",
          "on",
          "idle"
        ],
        "type": "string",
        "description": "Scale-to-zero policy types to use when creating an instance.\n\nThe policy can be one of the following values:\n\n| Policy | Description |\n|--------|-------------|\n| `on`   | The instance should be scaled-to-zero (when possible). |\n| `off`  | The instance should never be scaled-to-zero. |\n| `idle` | The instance should be scaled-to-zero even with established but idle TCP connections. |",
        "format": "enum",
        "x-package": "instances"
      },
      "InstanceServiceGroup": {
        "required": [
          "uuid",
          "name"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the service group.\n\nThis is a unique identifier for the service group that is generated when\nthe service is created.  The UUID is used to reference the service group\nin API calls and can be used to identify the service in all API calls\nthat require an service identifier.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-service-g756b5d",
            "type": "string",
            "description": "The name of the service group.\n\nThis is a human-readable name that can be used to identify the service\ngroup.  The name is unique within the context of your account.  The name\ncan also be used to identify the service group in API calls."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nWhere the service group is located."
          },
          "domains": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceGroupInstanceDomain"
            },
            "description": "The domain configuration for the service group."
          }
        },
        "description": "The service group configuration for the instance.\n\nThis is a reference to the service group that the instance is part of.  The\nservice group defines the services (e.g. ports, connection handling) that\nthe instance exposes and how they are configured.",
        "x-package": "instances"
      },
      "InstanceSnapshot": {
        "required": [
          "uuid"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "description": "The UUID of the snapshot.",
            "format": "uuid"
          }
        },
        "description": "The snapshot UUID of the instance.",
        "x-package": "instances"
      },
      "InstanceState": {
        "enum": [
          "stopped",
          "starting",
          "running",
          "draining",
          "stopping",
          "template",
          "standby",
          "deleted"
        ],
        "type": "string",
        "description": "The current state of an instance.",
        "format": "enum",
        "x-package": "instances"
      },
      "InstanceTemplateAutokill": {
        "type": "object",
        "properties": {
          "time_ms": {
            "type": "integer",
            "description": "Time in milliseconds after the template was last used for cloning before\nit is deleted. A value of 0 disables template autokill.",
            "format": "uint64"
          }
        },
        "description": "Automatic delete-on-idle configuration for template instances.",
        "x-package": "instances"
      },
      "InstanceVolume": {
        "required": [
          "uuid",
          "name",
          "at",
          "readonly"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the volume.\n\nThis is a unique identifier for the volume that is generated when the\nvolume is created.  The UUID is used to reference the volume in API calls\nand can be used to identify the volume in all API calls that require a\nvolume identifier.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-volume-g756b5d",
            "type": "string",
            "description": "The name of the volume.\n\nThis is a human-readable name that can be used to identify the volume.\nThe name must be unique within the context of your account.  The name can\nalso be used to identify the volume in API calls."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nWhere the volume is located."
          },
          "at": {
            "example": "/mnt/funky-volume",
            "type": "string",
            "description": "The mount point of the volume in the instance.  This is the directory in\nthe instance where the volume will be mounted."
          },
          "readonly": {
            "example": true,
            "type": "boolean",
            "description": "Whether the volume is read-only or not."
          }
        },
        "description": "A volume defines a storage which can be attached to the instance.\n\nVolumes can be used to store persistent data which should remain available\neven if the instance is stopped or restarted.",
        "x-package": "instances"
      },
      "MutableInstanceOperation": {
        "enum": [
          "set",
          "add",
          "del"
        ],
        "type": "string",
        "description": "The operations available on an instance's properties.",
        "format": "enum",
        "x-package": "instances"
      },
      "MutableInstanceProperty": {
        "enum": [
          "image",
          "args",
          "env",
          "memory_mb",
          "vcpus",
          "scale_to_zero",
          "tags",
          "delete_lock",
          "schedules",
          "autokill",
          "hostname",
          "roms",
          "dependencies",
          "sched_priority"
        ],
        "type": "string",
        "description": "The mutable properties of an instance that can be updated.",
        "format": "enum",
        "x-package": "instances"
      },
      "MutableServiceGroupOperation": {
        "enum": [
          "set",
          "add",
          "del"
        ],
        "type": "string",
        "description": "The mutable operations available on a service group's properties.",
        "format": "enum",
        "x-package": "services"
      },
      "MutableServiceGroupProperty": {
        "enum": [
          "services",
          "domains",
          "soft_limit",
          "hard_limit",
          "autokill"
        ],
        "type": "string",
        "description": "The mutable properties of a service group.",
        "format": "enum",
        "x-package": "services"
      },
      "MutableTemplateInstanceOperation": {
        "enum": [
          "set",
          "add",
          "del"
        ],
        "type": "string",
        "description": "The operations available on a template instance's properties.",
        "format": "enum",
        "x-package": "instances"
      },
      "MutableTemplateInstanceProperty": {
        "enum": [
          "tags",
          "delete_lock",
          "autokill"
        ],
        "type": "string",
        "description": "The mutable properties of a template instance that can be updated.",
        "format": "enum",
        "x-package": "instances"
      },
      "MutableTemplateVolumeOperation": {
        "enum": [
          "set",
          "add",
          "del"
        ],
        "type": "string",
        "description": "The operations available on a template volume's properties.",
        "format": "enum",
        "x-package": "volumes"
      },
      "MutableTemplateVolumeProperty": {
        "enum": [
          "tags",
          "delete_lock"
        ],
        "type": "string",
        "description": "The mutable properties of a template volume.",
        "format": "enum",
        "x-package": "volumes"
      },
      "MutableVolumeOperation": {
        "enum": [
          "set",
          "add",
          "del"
        ],
        "type": "string",
        "description": "The operations available on a volume's properties.",
        "format": "enum",
        "x-package": "volumes"
      },
      "MutableVolumeProperty": {
        "enum": [
          "size_mb",
          "tags",
          "quota_policy",
          "delete_lock"
        ],
        "type": "string",
        "description": "The mutable properties of a volume.",
        "format": "enum",
        "x-package": "volumes"
      },
      "NameOrUUID": {
        "type": "object",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "metro": {
                "example": "fra",
                "type": "string",
                "description": "(Only applies when using global control plane).\nThe metro of the resource."
              }
            }
          },
          {
            "oneOf": [
              {
                "title": "uuid",
                "required": [
                  "uuid"
                ],
                "type": "object",
                "properties": {
                  "uuid": {
                    "example": "123e4567-e89b-12d3-a456-426614174000",
                    "type": "string",
                    "description": "Mutually exclusive with name.",
                    "format": "uuid"
                  }
                }
              },
              {
                "title": "name",
                "required": [
                  "name"
                ],
                "type": "object",
                "properties": {
                  "name": {
                    "example": "funky-town-g756b5d",
                    "type": "string",
                    "description": "Mutually exclusive with UUID."
                  }
                }
              }
            ]
          }
        ],
        "description": "An identifier for a resource.  Either a name or a UUID.",
        "x-package": "common"
      },
      "PaginationOrder": {
        "enum": [
          "asc",
          "desc"
        ],
        "type": "string",
        "description": "The sort order used by list endpoints.",
        "format": "enum",
        "x-package": "common"
      },
      "PaginationSortBy": {
        "enum": [
          "create_time"
        ],
        "type": "string",
        "description": "The sort field used by list endpoints.",
        "format": "enum",
        "x-package": "common"
      },
      "PullPolicy": {
        "enum": [
          "always",
          "if_not_present",
          "never"
        ],
        "type": "string",
        "description": "PullPolicy defines when an image should be pulled.",
        "format": "enum",
        "x-package": "instances"
      },
      "Quotas": {
        "required": [
          "uuid",
          "used",
          "hard",
          "limits"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "example": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
            "type": "string",
            "description": "The UUID of the quota.",
            "format": "uuid"
          },
          "used": {
            "allOf": [
              {
                "$ref": "#/components/schemas/QuotasStats"
              }
            ],
            "description": "Used quota"
          },
          "hard": {
            "allOf": [
              {
                "$ref": "#/components/schemas/QuotasStats"
              }
            ],
            "description": "Configured quota limits"
          },
          "limits": {
            "allOf": [
              {
                "$ref": "#/components/schemas/QuotasLimits"
              }
            ],
            "description": "Additional limits"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "An optional field representing the status of the request.  This field is\nonly set when this message object is used as a response message."
          },
          "message": {
            "example": "No user with name 'funky-user'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is only set when this message object is used as a response\nmessage, and is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is only set when this message object is used as a response\nmessage, and is useful when the status is not `success`.",
            "format": "int32"
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the user."
          }
        },
        "x-package": "users"
      },
      "QuotasLimits": {
        "required": [
          "min_memory_mb",
          "max_memory_mb",
          "min_volume_mb",
          "max_volume_mb",
          "min_autoscale_size",
          "max_autoscale_size",
          "min_vcpus",
          "max_vcpus"
        ],
        "type": "object",
        "properties": {
          "min_memory_mb": {
            "example": 16,
            "type": "integer",
            "description": "Minimum amount of memory assigned to live instances in megabytes",
            "format": "int64"
          },
          "max_memory_mb": {
            "example": 2048,
            "type": "integer",
            "description": "Maximum amount of memory assigned to live instances in megabytes",
            "format": "int64"
          },
          "min_volume_mb": {
            "example": 1,
            "type": "integer",
            "description": "Minimum size of a volume in megabytes",
            "format": "int64"
          },
          "max_volume_mb": {
            "example": 1024,
            "type": "integer",
            "description": "Maximum size of a volume in megabytes",
            "format": "int64"
          },
          "min_autoscale_size": {
            "example": 1,
            "type": "integer",
            "description": "Minimum size of an autoscale group",
            "format": "int64"
          },
          "max_autoscale_size": {
            "example": 16,
            "type": "integer",
            "description": "Maximum size of an autoscale group",
            "format": "int64"
          },
          "min_vcpus": {
            "example": 2,
            "type": "integer",
            "description": "Minimum number of vCPUs",
            "format": "int64"
          },
          "max_vcpus": {
            "example": 4,
            "type": "integer",
            "description": "Maximum number of vCPUs",
            "format": "int64"
          }
        },
        "x-package": "users"
      },
      "QuotasResponse": {
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/QuotasResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 46,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for getting the quota of a user given their UUID.",
        "x-package": "users"
      },
      "QuotasResponseData": {
        "type": "object",
        "properties": {
          "quotas": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Quotas"
            },
            "description": "The quota(s) which were retrieved by the request."
          }
        },
        "x-package": "users"
      },
      "QuotasStats": {
        "required": [
          "instances",
          "live_instances",
          "live_vcpus",
          "live_memory_mb",
          "service_groups",
          "services",
          "volumes",
          "total_volume_mb"
        ],
        "type": "object",
        "properties": {
          "instances": {
            "example": 16,
            "type": "integer",
            "description": "Number of instances",
            "format": "int64"
          },
          "live_instances": {
            "example": 4,
            "type": "integer",
            "description": "Number of instances that are not in the `stopped` state",
            "format": "int64"
          },
          "live_vcpus": {
            "example": 4,
            "type": "integer",
            "description": "Number of vCPUs",
            "format": "int64"
          },
          "live_memory_mb": {
            "example": 2048,
            "type": "integer",
            "description": "Amount of memory assigned to instances that are not in the `stopped`\nstate in megabytes",
            "format": "int64"
          },
          "service_groups": {
            "example": 15,
            "type": "integer",
            "description": "Number of services",
            "format": "int64"
          },
          "services": {
            "example": 30,
            "type": "integer",
            "description": "Number of published network ports over all existing services",
            "format": "int64"
          },
          "volumes": {
            "example": 2,
            "type": "integer",
            "description": "Number of volumes",
            "format": "int64"
          },
          "total_volume_mb": {
            "example": 1024,
            "type": "integer",
            "description": "Total size of all volumes in megabytes",
            "format": "int64"
          }
        },
        "x-package": "users"
      },
      "ResponseError": {
        "required": [
          "status"
        ],
        "type": "object",
        "properties": {
          "status": {
            "example": 401,
            "type": "integer",
            "description": "The HTTP status code of the error.",
            "format": "uint64"
          }
        },
        "description": "The error response message for an API request.",
        "x-package": "common"
      },
      "ResponseStatus": {
        "enum": [
          "success",
          "error"
        ],
        "type": "string",
        "description": "The response status of an API request.",
        "format": "enum",
        "x-package": "common"
      },
      "SchedPriority": {
        "enum": [
          "normal",
          "medium",
          "high",
          "admin"
        ],
        "type": "string",
        "description": "SchedPriority defines the scheduling priority for an instance.\nUser requires the `override_vm_priority` permission to change it.\n\nThe list of available scheduling priorities:\n\n| Priority | Description |\n|----------|-------------|\n| `normal` | Default scheduling priority. |\n| `medium` | Medium scheduling priority. |\n| `high`   | High scheduling priority. |\n| `admin`  | Admin scheduling priority. |",
        "format": "enum",
        "x-package": "common"
      },
      "Schedule": {
        "required": [
          "name",
          "when",
          "action",
          "next_at"
        ],
        "type": "object",
        "properties": {
          "name": {
            "example": "daily-stop",
            "type": "string",
            "description": "The name of the schedule.\n\nMust be unique within an instance."
          },
          "when": {
            "example": null,
            "type": "string",
            "description": "The calendar expression specifying when the action should be performed.\n\nUses systemd calendar event syntax.\nSee https://www.man7.org/linux/man-pages/man7/systemd.time.7.html"
          },
          "action": {
            "example": "stop",
            "allOf": [
              {
                "$ref": "#/components/schemas/ScheduleAction"
              }
            ],
            "description": "The action to perform at the scheduled time."
          },
          "next_at": {
            "readOnly": true,
            "example": 1696512000,
            "type": "integer",
            "description": "The timestamp of when the next scheduled action will occur.\n\nThis field is populated only in responses (not settable in requests).\nUnix timestamp in seconds.  Omitted if no next execution is scheduled.",
            "format": "int64"
          },
          "args": {
            "example": [
              "/bin/sh",
              "-c",
              "echo hello"
            ],
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The command to execute when the action is `exec`.\n\nRequired when `action` is `SCHEDULE_ACTION_EXEC`, ignored otherwise.\nEach element is a separate argument; the first element is the executable."
          }
        },
        "description": "A schedule defines when an action should be performed on an instance.\n\nEach schedule specifies a name, a calendar expression following systemd\ncalendar event syntax, and an action (start, stop, delete, or exec).\n\nCalendar expressions format: [weekday] [[year-]month-day] [hour:minute[:second]]\n\nSupported syntax:\n- `*` - Any value\n- `5` - Exact value\n- `1..5` - Range\n- `1..5/2` - Range with step\n- `1,2,5` - Comma-separated list\n\nExample: `*-*-* 09:00:00` - Every day at 09:00 UTC\nExample: `Sat,Sun *-*-* 20:00:00` - Every Saturday and Sunday at 20:00 UTC",
        "x-package": "instances"
      },
      "ScheduleAction": {
        "enum": [
          "start",
          "stop",
          "delete",
          "exec"
        ],
        "type": "string",
        "description": "The action to perform on a scheduled operation.",
        "format": "enum",
        "x-package": "instances"
      },
      "Service": {
        "required": [
          "port"
        ],
        "type": "object",
        "properties": {
          "port": {
            "example": 443,
            "type": "integer",
            "description": "This is the public-facing port that the service will be accessible from\non the Internet.",
            "format": "uint32"
          },
          "destination_port": {
            "example": 8080,
            "type": "integer",
            "description": "The port number that the instance is listening on.  This is the internal\nport which Unikraft Cloud will forward traffic to.",
            "format": "uint32"
          },
          "handlers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ConnectionHandler"
            },
            "description": "Connection handlers to use for the service.  Handlers define how the\nservice will handle incoming connections and forward traffic from the\nInternet to your application.  For example, a service can be configured\nto terminate TLS connections, redirect HTTP traffic, or enable HTTP mode\nfor load balancing.  You configure the handlers for every published\nservice port individually."
          }
        },
        "description": "A service connects a public-facing port to an internal destination port on\nwhich an application instance listens on.  Additional handlers can be defined\nfor each published port in order to define how the service will handle\nincoming connections and forward traffic from the Internet to your\napplication.  For example, a service can be configured to terminate TLS\nconnections, redirect HTTP traffic, or enable HTTP mode for load balancing.",
        "x-package": "services"
      },
      "ServiceGroup": {
        "required": [
          "uuid",
          "name",
          "created_at",
          "persistent",
          "autoscale",
          "soft_limit",
          "hard_limit"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "example": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
            "type": "string",
            "description": "The UUID of the service group.\n\nThis is a unique identifier for the service group that is generated when\nthe service group is created.  The UUID is used to reference the service in\nAPI calls and can be used to identify the service group in all API calls\nthat require an identifier.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-service-g7gum5cj",
            "type": "string",
            "description": "The name of the service group.\n\nThis is a human-readable name that can be used to identify the service\ngroup. The name must be unique within the context of your account.  The\nname can also be used to identify the service in API calls."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nWhere the service group is located."
          },
          "created_at": {
            "example": "2023-10-01T12:00:00Z",
            "type": "string",
            "description": "The time the service was created.",
            "format": "date-time"
          },
          "persistent": {
            "example": true,
            "type": "boolean",
            "description": "Indicates if the service will stay remain even after the last instance\ndetached.  If this is set to false, the service will be deleted when the\nlast instance detached from it.  If this is set to true, the service will\nremain and can be reused by other instances.  This is useful if you want to\nkeep the service configuration, e.g., the published ports, handlers, and\ndomains, even if there are no instances assigned to it."
          },
          "autoscale": {
            "example": true,
            "type": "boolean",
            "description": "Indicates if the service has autoscale enabled.  See the associated\nautoscale documentation for more information about how to set this up.\nAutoscale policies can be set up after the service has been created."
          },
          "soft_limit": {
            "example": 1,
            "type": "integer",
            "description": "The soft limit is used by the Unikraft Cloud load balancer to decide when\nto wake up another standby instance.  For example, if the soft limit is set\nto 5 and the service consists of 2 standby instances, one of the instances\nreceives up to 5 concurrent requests.  The 6th parallel requests wakes up\nthe second instance.  If there are no more standby instances to wake up,\nthe number of requests assigned to each instance will exceed the soft\nlimit.  The load balancer makes sure that when the number of in-flight\nrequests goes down again, instances are put into standby as fast as\npossible.",
            "format": "uint64"
          },
          "hard_limit": {
            "example": 100,
            "type": "integer",
            "description": "The hard limit defines the maximum number of concurrent requests that an\ninstance assigned to the this service can handle.  The load balancer will\nnever assign more requests to a single instance.  In case there are no\nother instances available, excess requests fail (i.e., they are blocked and\nnot queued).",
            "format": "uint64"
          },
          "services": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Service"
            },
            "description": "List of published network ports for this service and the destination port\nto which Unikraft Cloud will forward traffic to.  Additional handlers can\nbe defined for each published port in order to define how the service will\nhandle incoming connections and forward traffic from the Internet to your\napplication.  For example, a service can be configured to terminate TLS\nconnections, redirect HTTP traffic, or enable HTTP mode for load balancing."
          },
          "domains": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Domain"
            },
            "description": "List of domains associated with the service.  Domains are used to access\nthe service over the Internet."
          },
          "instances": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceGroupInstance"
            },
            "description": "List of instances assigned to the service."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "An optional field representing the status of the request.  This field is\nonly set when this message object is used as a response message."
          },
          "message": {
            "example": "No service with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is only set when this message object is used as a response\nmessage, and is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is only set when this message object is used as a response\nmessage, and is useful when the status is not `success`.",
            "format": "int32"
          },
          "autokill": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ServiceGroupAutokill"
              }
            ],
            "description": "Automatic delete-on-idle configuration."
          }
        },
        "description": "A service group on Unikraft Cloud is used to describe how your application\nexposes its functionality to the outside world.  Once defined, assigning an\ninstance to the service will make it accessible from the Internet.\n\nAn application, running as an instance, may expose one or more ports, e.g. it\nlistens on port 80 because your application exposes a HTTP web service. This,\nalong with a set of additional metadata defines how the \"service\" is\nconfigured and accessed.  For example, a service may be configured to use\nTLS, or be bound to a specific domain name.\n\nWhen an instance is assigned to a service group, it immediately becomes\naccessible over the Internet on the exposed public port, using the set DNS\nname, and is routed to the set destination port.\n\nNote: If you do not specify a DNS name when you create a service and you\nindicate that the application exposes some ports, Unikraft Cloud will\ngenerates a random DNS name for you.  Unikraft Cloud also supports custom\ndomains like www.example.com and wildcard domains like *.example.com.",
        "x-package": "services"
      },
      "ServiceGroupAutokill": {
        "type": "object",
        "properties": {
          "time_ms": {
            "type": "integer",
            "description": "Time in milliseconds after the service group becomes empty before it is\ndeleted. A value of 0 disables autokill.",
            "format": "uint64"
          }
        },
        "description": "Automatic delete-on-idle configuration for service groups.",
        "x-package": "services"
      },
      "ServiceGroupInstance": {
        "required": [
          "uuid",
          "name"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "example": "12345678-90ab-cdef-1234-567890abcdef",
            "type": "string",
            "description": "The UUID of the instance.  This is a unique identifier for the instance\nthat is generated when the instance is created.  The UUID is used to\nreference the instance in API calls and can be used to identify the\ninstance in all API calls that require an instance identifier.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-vol-g7gum5cj",
            "type": "string",
            "description": "The name of the instance.  This is a human-readable name that can be used\nto identify the instance.  The name must be unique within the context of\nyour account.  If no name is specified, a random name is generated for\nyou.  The name can also be used to identify the instance in API calls."
          }
        },
        "x-package": "services"
      },
      "ServiceGroupInstanceDomain": {
        "required": [
          "fqdn"
        ],
        "type": "object",
        "properties": {
          "fqdn": {
            "example": "funky-town-g756b5d.fra0.unikraft.app.",
            "type": "string",
            "description": "Publicly accessible domain name.\n\nIf this name ends in a period `.` it must be a valid Full Qualified\nDomain Name (FQDN), otherwise it will become a subdomain of the target\nmetro."
          },
          "certificate": {
            "allOf": [
              {
                "$ref": "#/components/schemas/NameOrUUID"
              }
            ],
            "description": "The certificate associated with the domain.\n\nThe certificate is used to secure the domain with TLS/SSL.  If no\ncertificate is specified, Unikraft Cloud will automatically generate a\nnew certificate for the domain based on Let's Encrypt and seek to\naccomplish a DNS-01 challenge."
          }
        },
        "description": "The domain configuration for the service group.\n\nDomain names are completely specified with all labels in the hierarchy of\nthe DNS, having no parts omitted.  The domain can be associated with an\nexisting certificate by specifying the certificate's name or UUID.  If no\ncertificate is specified and a FQDN is provided, Unikraft Cloud will\nautomatically generate a new certificate for the domain based on Let's\nEncrypt and seek to accomplish a DNS-01 challenge.",
        "x-package": "instances"
      },
      "ServiceGroupTemplate": {
        "required": [
          "name",
          "uuid"
        ],
        "type": "object",
        "properties": {
          "name": {
            "example": "funky-instance-template",
            "type": "string",
            "description": "The name of the template used for the autoscale configuration."
          },
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the template used for the autoscale configuration.",
            "format": "uuid"
          }
        },
        "x-package": "autoscale"
      },
      "StartInstanceByUUIDRequestBody": {
        "type": "object",
        "properties": {
          "wait_timeout_ms": {
            "example": 2000,
            "type": "integer",
            "description": "Deprecated: Use `timeout_s` instead.  Timeout in milliseconds to\nwait for the instance to reach running state.  If `timeout_s` is\nnot set, this value is converted by rounding up to the next full\nsecond.  No wait performed for a value of 0.",
            "format": "int64"
          },
          "timeout_s": {
            "example": 2,
            "type": "integer",
            "description": "Timeout in seconds to wait for the instance to reach running\nstate.  If you start your instance, you can wait for it to\nfinish starting with a blocking API call if you specify a wait\ntimeout greater than zero.  No wait performed for a value of 0.",
            "format": "int64"
          }
        },
        "description": "Parameters for starting the instance.",
        "x-package": "instances"
      },
      "StartInstancesRequestItem": {
        "type": "object",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "metro": {
                "example": "fra",
                "type": "string",
                "description": "(Only applies when using global control plane).\nThe metro to route the request to."
              },
              "wait_timeout_ms": {
                "example": 2000,
                "type": "integer",
                "description": "Deprecated: Use `timeout_s` instead.  Timeout in milliseconds to\nwait for the instance to reach running state.  If `timeout_s` is\nnot set, this value is converted by rounding up to the next full\nsecond.  No wait performed for a value of 0.",
                "format": "int64"
              },
              "timeout_s": {
                "example": 2,
                "type": "integer",
                "description": "Timeout in seconds to wait for the instance to reach running\nstate.  If you start your instance, you can wait for it to\nfinish starting with a blocking API call if you specify a wait\ntimeout greater than zero.  No wait performed for a value of 0.",
                "format": "int64"
              }
            }
          },
          {
            "oneOf": [
              {
                "title": "uuid",
                "type": "object",
                "properties": {
                  "uuid": {
                    "example": "123e4567-e89b-12d3-a456-426614174000",
                    "type": "string",
                    "description": "The UUID of the instance to start.  Mutually exclusive with name.",
                    "format": "uuid"
                  }
                }
              },
              {
                "title": "name",
                "type": "object",
                "properties": {
                  "name": {
                    "example": "funky-town-g756b5d",
                    "type": "string",
                    "description": "The name of the instance to start.  Mutually exclusive with UUID."
                  }
                }
              }
            ]
          }
        ],
        "description": "A single request item to start an instance.",
        "x-package": "instances"
      },
      "StartInstancesResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/StartInstancesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 256,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for starting one or more instance(s) given their UUID(s)\nor name(s).",
        "x-package": "instances"
      },
      "StartInstancesResponseData": {
        "type": "object",
        "properties": {
          "instances": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StartInstancesResponseStartedInstance"
            },
            "description": "The instance(s) which were started by the request."
          }
        },
        "x-package": "instances"
      },
      "StartInstancesResponseStartedInstance": {
        "required": [
          "status",
          "uuid",
          "name",
          "state",
          "previous_state"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "Indicates whether the start operation was successful or not for this\ninstance."
          },
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the instance which was deleted.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-town-g756b5d",
            "type": "string",
            "description": "The name of the instance which was deleted."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the instance."
          },
          "state": {
            "example": "running",
            "type": "string",
            "description": "The current state of the instance after this request."
          },
          "previous_state": {
            "example": "stopped",
            "type": "string",
            "description": "The previous state of the instance before it was deleted."
          },
          "message": {
            "example": "No instance with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "instances"
      },
      "StepPolicyMetric": {
        "enum": [
          "cpu"
        ],
        "type": "string",
        "description": "The step policy is a type of autoscaling policy that scales the number of\ninstances in a service by a fixed number of instances at each step.\nIt uses a metric to determine when to scale up or down.",
        "format": "enum",
        "x-package": "autoscale"
      },
      "StopInstanceByUUIDRequestBody": {
        "type": "object",
        "properties": {
          "force": {
            "example": true,
            "type": "boolean",
            "description": "Whether to immediately force stop the instance."
          },
          "drain_timeout_ms": {
            "example": 550,
            "type": "integer",
            "description": "Timeout for draining connections in milliseconds.\nNo draining will occur if set to 0.  The instance\ndoes not receive new connections in the draining\nphase.  The instance is stopped when the last\nconnection has been closed or the timeout expired.\nThe maximum timeout may vary.  Use -1 for the\nlargest possible value.  Ignored if force is set.\n\nNote: This endpoint does not block.  Use the wait\nendpoint for the instance to reach the stopped\nstate.",
            "format": "uint64"
          },
          "quick": {
            "example": false,
            "type": "boolean",
            "description": "Whether to perform a quick shutdown.  This flag is\noverridden by force."
          },
          "ifstate": {
            "example": "running",
            "type": "string",
            "description": "Only stop the instance if it is in this state."
          },
          "dump": {
            "example": false,
            "type": "boolean",
            "description": "If set, forces the VMM to shutdown immediately and generate a coredump.\nCan only be used in conjunction with force."
          }
        },
        "description": "Parameters for stopping the instance.",
        "x-package": "instances"
      },
      "StopInstancesRequestItem": {
        "type": "object",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "metro": {
                "example": "fra",
                "type": "string",
                "description": "(Only applies when using global control plane).\nThe metro to route the request to."
              },
              "force": {
                "example": false,
                "type": "boolean",
                "description": "Whether to immediately force stop the instance."
              },
              "drain_timeout_ms": {
                "example": 250,
                "type": "integer",
                "description": "Timeout for draining connections in milliseconds.  The instance does not\nreceive new connections in the draining phase.  The instance is stopped\nwhen the last connection has been closed or the timeout expired.  The\nmaximum timeout may vary.  Use -1 for the largest possible value.\n\nNote: This endpoint does not block.  Use the wait endpoint for the\ninstance to reach the stopped state.",
                "format": "uint64"
              },
              "quick": {
                "example": false,
                "type": "boolean",
                "description": "Whether to perform a quick shutdown.  This flag is\noverridden by force."
              },
              "ifstate": {
                "example": "running",
                "type": "string",
                "description": "Only stop the instance if it is in this state."
              },
              "dump": {
                "example": false,
                "type": "boolean",
                "description": "If set, forces the VMM to shutdown immediately and generate a coredump.\nCan only be used in conjunction with force."
              }
            }
          },
          {
            "oneOf": [
              {
                "title": "uuid",
                "type": "object",
                "properties": {
                  "uuid": {
                    "example": "123e4567-e89b-12d3-a456-426614174000",
                    "type": "string",
                    "description": "The UUID of the instance to stop.  Mutually exclusive with name.",
                    "format": "uuid"
                  }
                }
              },
              {
                "title": "name",
                "type": "object",
                "properties": {
                  "name": {
                    "example": "funky-town-g756b5d",
                    "type": "string",
                    "description": "The name of the instance to stop.  Mutually exclusive with UUID."
                  }
                }
              }
            ]
          }
        ],
        "description": "A single request item to stop an instance.",
        "x-package": "instances"
      },
      "StopInstancesResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/StopInstancesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 23,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for stopping one or more instance(s) given their UUID(s)\nor name(s).",
        "x-package": "instances"
      },
      "StopInstancesResponseData": {
        "type": "object",
        "properties": {
          "instances": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StopInstancesResponseStoppedInstance"
            },
            "description": "The instance(s) which were stopped by the request."
          }
        },
        "x-package": "instances"
      },
      "StopInstancesResponseStoppedInstance": {
        "required": [
          "uuid",
          "name",
          "state",
          "previous_state"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the instance.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-town-g756b5d",
            "type": "string",
            "description": "The name of the instance."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the instance."
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/InstanceState"
              }
            ],
            "description": "The current state of the instance."
          },
          "previous_state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/InstanceState"
              }
            ],
            "description": "The previous state of the instance before the stop operation was invoked."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "No instance with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "instances"
      },
      "SuspendInstanceByUUIDRequestBody": {
        "type": "object",
        "properties": {
          "drain_timeout_ms": {
            "example": 550,
            "type": "integer",
            "description": "Timeout for draining connections in milliseconds.  No draining\nwill occur if set to 0.  Use -1 for the largest possible value.",
            "format": "uint64"
          }
        },
        "description": "Parameters for suspending the instance.",
        "x-package": "instances"
      },
      "SuspendInstancesRequestItem": {
        "type": "object",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "metro": {
                "example": "fra",
                "type": "string",
                "description": "(Only applies when using global control plane).\nThe metro to route the request to."
              },
              "drain_timeout_ms": {
                "example": 250,
                "type": "integer",
                "description": "Timeout for draining connections in milliseconds.  No draining\nwill occur if set to 0.  Use -1 for the largest possible value.",
                "format": "uint64"
              }
            }
          },
          {
            "oneOf": [
              {
                "title": "uuid",
                "type": "object",
                "properties": {
                  "uuid": {
                    "example": "123e4567-e89b-12d3-a456-426614174000",
                    "type": "string",
                    "description": "The UUID of the instance to suspend.  Mutually exclusive with name.",
                    "format": "uuid"
                  }
                }
              },
              {
                "title": "name",
                "type": "object",
                "properties": {
                  "name": {
                    "example": "funky-town-g756b5d",
                    "type": "string",
                    "description": "The name of the instance to suspend.  Mutually exclusive with UUID."
                  }
                }
              }
            ]
          }
        ],
        "description": "A single request item to suspend an instance.",
        "x-package": "instances"
      },
      "SuspendInstancesResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SuspendInstancesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 23,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for suspending one or more instance(s) given their UUID(s)\nor name(s).",
        "x-package": "instances"
      },
      "SuspendInstancesResponseData": {
        "type": "object",
        "properties": {
          "instances": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SuspendInstancesResponseSuspendedInstance"
            },
            "description": "The instance(s) which were suspended by the request."
          }
        },
        "x-package": "instances"
      },
      "SuspendInstancesResponseSuspendedInstance": {
        "required": [
          "uuid",
          "name",
          "state",
          "previous_state"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the instance.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-town-g756b5d",
            "type": "string",
            "description": "The name of the instance."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the instance."
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/InstanceState"
              }
            ],
            "description": "The current state of the instance."
          },
          "previous_state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/InstanceState"
              }
            ],
            "description": "The previous state of the instance before the suspend operation was invoked."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "No instance with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "instances"
      },
      "TemplateAutokill": {
        "type": "object",
        "properties": {
          "time_ms": {
            "example": 60000,
            "type": "integer",
            "description": "Time in milliseconds after the template was last used for cloning\nbefore it is deleted. A value of 0 disables template autokill.",
            "format": "uint64"
          }
        },
        "description": "(Optional). Automatic delete-on-idle configuration for the template\ninstance. Only applies when `prepare` is set.",
        "x-package": "instances"
      },
      "UpdateCertificateByUUIDRequest": {
        "required": [
          "uuid",
          "chain",
          "pkey"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "description": "The UUID of the certificate to update.",
            "format": "uuid"
          },
          "chain": {
            "example": "-----BEGIN CERTIFICATE----- MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDQ... -----END CERTIFICATE-----",
            "type": "string",
            "description": "The new certificate chain.\n\nThis is the public chain of the certificate in PEM format. The chain\nshould include the certificate and any intermediate certificates."
          },
          "pkey": {
            "example": "-----BEGIN PRIVATE KEY----- MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDQ... -----END PRIVATE KEY-----",
            "type": "string",
            "description": "The new private key.\n\nThis is the private key of the certificate in PEM format. The private\nkey must match the public key in the certificate chain."
          }
        },
        "description": "The request message for updating a certificate by its UUID.",
        "x-package": "certificates"
      },
      "UpdateCertificateRequest": {
        "required": [
          "id",
          "chain",
          "pkey"
        ],
        "type": "object",
        "properties": {
          "id": {
            "allOf": [
              {
                "$ref": "#/components/schemas/NameOrUUID"
              }
            ],
            "description": "The ID of the certificate to update."
          },
          "chain": {
            "example": "-----BEGIN CERTIFICATE----- MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDQ... -----END CERTIFICATE-----",
            "type": "string",
            "description": "The new certificate chain.\n\nThis is the public chain of the certificate in PEM format. The chain\nshould include the certificate and any intermediate certificates."
          },
          "pkey": {
            "example": "-----BEGIN PRIVATE KEY----- MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDQ... -----END PRIVATE KEY-----",
            "type": "string",
            "description": "The new private key.\n\nThis is the private key of the certificate in PEM format. The private\nkey must match the public key in the certificate chain."
          }
        },
        "description": "The request message for updating one or more certificate(s) by their\nUUID(s) or name(s).",
        "x-package": "certificates"
      },
      "UpdateCertificateResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UpdateCertificateResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 45,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for updating one or more certificate(s).",
        "x-package": "certificates"
      },
      "UpdateCertificateResponseData": {
        "type": "object",
        "properties": {
          "certificates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Certificate"
            },
            "description": "The certificate(s) which were updated by the request."
          }
        },
        "x-package": "certificates"
      },
      "UpdateInstanceByUUIDRequestBody": {
        "required": [
          "prop",
          "op"
        ],
        "type": "object",
        "properties": {
          "id": {
            "example": "op-1",
            "type": "string",
            "description": "(Optional).  A client-provided identifier for tracking this operation in\nthe response."
          },
          "prop": {
            "example": "memory_mb",
            "allOf": [
              {
                "$ref": "#/components/schemas/MutableInstanceProperty"
              }
            ],
            "description": "The property to modify."
          },
          "op": {
            "example": "set",
            "allOf": [
              {
                "$ref": "#/components/schemas/MutableInstanceOperation"
              }
            ],
            "description": "The operation to perform on the property."
          },
          "value": {
            "allOf": [
              {
                "$ref": "#/components/schemas/GoogleProtobufValue"
              }
            ],
            "description": "The value for the update operation. The type depends on the property and operation:\n- For \"image\": object with image url, credentials, headers and pull policy\n- For \"args\": string or array of strings\n- For \"env\": object (for SET/ADD) or string/array of strings (for DEL)\n- For \"memory_mb\": integer\n- For \"vcpus\": integer\n- For \"scale_to_zero\": object with cooldown_time_ms, policy, and stateful fields\n- For \"tags\": array of strings\n- For \"delete_lock\": boolean\n- For \"schedules\": array of schedule objects (with name, when, action, and optional args fields).\n  Use action \"exec\" together with args to execute a command at the scheduled time.\n- For \"autokill\": object with time_ms and num_requests fields\n- For \"hostname\": string (valid DNS label)\n- For \"roms\": array of ROM objects (with name and image fields) for SET/ADD, or array of ROM names for DEL\n- For \"dependencies\": array of instance identifiers (name or UUID)\n- For \"sched_priority\": SchedPriority enum value (\"normal\", \"medium\", \"high\", \"admin\")"
          }
        },
        "x-package": "instances"
      },
      "UpdateInstancesRequestItem": {
        "required": [
          "prop",
          "op"
        ],
        "type": "object",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "example": "op-1",
                "type": "string",
                "description": "(Optional).  A client-provided identifier for tracking this operation in\nthe response."
              },
              "metro": {
                "example": "fra",
                "type": "string",
                "description": "(Only applies when using global control plane).\nThe metro to route the request to."
              },
              "prop": {
                "example": "memory_mb",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MutableInstanceProperty"
                  }
                ],
                "description": "The property to modify."
              },
              "op": {
                "example": "set",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MutableInstanceOperation"
                  }
                ],
                "description": "The operation to perform on the property."
              },
              "value": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/GoogleProtobufValue"
                  }
                ],
                "description": "The value for the update operation. The type depends on the property and operation:\n- For \"image\": object with image url, credentials, headers and pull policy\n- For \"args\": string or array of strings\n- For \"env\": object (for SET/ADD) or string/array of strings (for DEL)\n- For \"memory_mb\": integer\n- For \"vcpus\": integer\n- For \"scale_to_zero\": object with cooldown_time_ms, policy, and stateful fields\n- For \"tags\": array of strings\n- For \"delete_lock\": boolean\n- For \"schedules\": array of schedule objects (with name, when, action, and optional args fields).\n  Use action \"exec\" together with args to execute a command at the scheduled time.\n- For \"autokill\": object with time_ms and num_requests fields\n- For \"hostname\": string (valid DNS label)\n- For \"roms\": array of ROM objects (with name and image fields) for SET/ADD, or array of ROM names for DEL\n- For \"dependencies\": array of instance identifiers (name or UUID)\n- For \"sched_priority\": SchedPriority enum value (\"normal\", \"medium\", \"high\", \"admin\")"
              }
            }
          },
          {
            "oneOf": [
              {
                "title": "uuid",
                "type": "object",
                "properties": {
                  "uuid": {
                    "example": "123e4567-e89b-12d3-a456-426614174000",
                    "type": "string",
                    "description": "The UUID of the instance to update. Mutually exclusive with name.",
                    "format": "uuid"
                  }
                }
              },
              {
                "title": "name",
                "type": "object",
                "properties": {
                  "name": {
                    "example": "funky-town-g756b5d",
                    "type": "string",
                    "description": "The name of the instance to update. Mutually exclusive with UUID."
                  }
                }
              }
            ]
          }
        ],
        "description": "A single update operation to be applied to an instance.",
        "x-package": "instances"
      },
      "UpdateInstancesResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UpdateInstancesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 76,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for updating one or more instances.",
        "x-package": "instances"
      },
      "UpdateInstancesResponseData": {
        "type": "object",
        "properties": {
          "instances": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UpdateInstancesResponseUpdatedInstance"
            },
            "description": "List of instances that were processed during the update operation."
          }
        },
        "x-package": "instances"
      },
      "UpdateInstancesResponseUpdatedInstance": {
        "required": [
          "uuid",
          "name",
          "status"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the instance that was updated.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-town-g756b5d",
            "type": "string",
            "description": "The name of the instance that was updated."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of this particular instance update operation."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the instance."
          },
          "id": {
            "example": "op-1",
            "type": "string",
            "description": "(Optional).  The client-provided ID from the request."
          },
          "message": {
            "example": "No instance with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "instances"
      },
      "UpdateServiceGroupByUUIDRequestBody": {
        "required": [
          "prop",
          "op"
        ],
        "type": "object",
        "properties": {
          "id": {
            "example": "op-1",
            "type": "string",
            "description": "(Optional).  A client-provided identifier for tracking this operation in the response."
          },
          "prop": {
            "example": "services",
            "allOf": [
              {
                "$ref": "#/components/schemas/MutableServiceGroupProperty"
              }
            ],
            "description": "The property to modify."
          },
          "op": {
            "example": "set",
            "allOf": [
              {
                "$ref": "#/components/schemas/MutableServiceGroupOperation"
              }
            ],
            "description": "The operation to perform."
          },
          "value": {
            "allOf": [
              {
                "$ref": "#/components/schemas/GoogleProtobufValue"
              }
            ],
            "description": "The value for the update operation:\n- For \"services\": array of Service objects (same as for creation)\n- For \"domains\": array of Domain objects (same as for creation)\n- For \"soft_limit\": integer (1–65535), must be <= \"hard_limit\"\n- For \"hard_limit\": integer (1–65535), must be >= \"soft_limit\"\n- For \"autokill\": object with time_ms field"
          }
        },
        "x-package": "services"
      },
      "UpdateServiceGroupsRequestItem": {
        "required": [
          "prop",
          "op"
        ],
        "type": "object",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "example": "op-1",
                "type": "string",
                "description": "(Optional).  A client-provided identifier for tracking this operation in the response."
              },
              "prop": {
                "example": "services",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MutableServiceGroupProperty"
                  }
                ],
                "description": "The property to modify."
              },
              "op": {
                "example": "set",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MutableServiceGroupOperation"
                  }
                ],
                "description": "The operation to perform."
              },
              "value": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/GoogleProtobufValue"
                  }
                ],
                "description": "The value for the update operation:\n- For \"services\": array of Service objects (same as for creation)\n- For \"domains\": array of Domain objects (same as for creation)\n- For \"soft_limit\": integer (1–65535), must be <= \"hard_limit\"\n- For \"hard_limit\": integer (1–65535), must be >= \"soft_limit\"\n- For \"autokill\": object with time_ms field"
              }
            }
          },
          {
            "oneOf": [
              {
                "title": "uuid",
                "type": "object",
                "properties": {
                  "uuid": {
                    "example": "123e4567-e89b-12d3-a456-426614174000",
                    "type": "string",
                    "description": "The UUID of the service group to update.  Mutually exclusive with name.",
                    "format": "uuid"
                  }
                }
              },
              {
                "title": "name",
                "type": "object",
                "properties": {
                  "name": {
                    "example": "funky-town-g756b5d",
                    "type": "string",
                    "description": "The name of the service group to update.  Mutually exclusive with UUID."
                  }
                }
              }
            ]
          }
        ],
        "description": "A single update operation to be applied to a service group",
        "x-package": "services"
      },
      "UpdateServiceGroupsResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UpdateServiceGroupsResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 76,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for updating one or more service groups.",
        "x-package": "services"
      },
      "UpdateServiceGroupsResponseData": {
        "type": "object",
        "properties": {
          "service_groups": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UpdateServiceGroupsResponseUpdatedServiceGroup"
            },
            "description": "List of service groups that were processed during the update operation."
          }
        },
        "x-package": "services"
      },
      "UpdateServiceGroupsResponseUpdatedServiceGroup": {
        "required": [
          "uuid",
          "name",
          "status"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the service group that was updated.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-town-g756b5d",
            "type": "string",
            "description": "The name of the service group that was updated."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the service group."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of this particular service group update operation."
          },
          "id": {
            "example": "op-1",
            "type": "string",
            "description": "(Optional).  The client-provided ID from the request."
          },
          "message": {
            "example": "No service with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is only set when this message object is used as a response\nmessage, and is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is only set when this message object is used as a response\nmessage, and is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "services"
      },
      "UpdateTemplateInstanceByUUIDRequestBody": {
        "required": [
          "prop",
          "op"
        ],
        "type": "object",
        "properties": {
          "id": {
            "example": "op-1",
            "type": "string",
            "description": "(Optional).  A client-provided identifier for tracking this operation in\nthe response."
          },
          "prop": {
            "example": "tags",
            "allOf": [
              {
                "$ref": "#/components/schemas/MutableTemplateInstanceProperty"
              }
            ],
            "description": "The property to modify."
          },
          "op": {
            "example": "add",
            "allOf": [
              {
                "$ref": "#/components/schemas/MutableTemplateInstanceOperation"
              }
            ],
            "description": "The operation to perform on the property."
          },
          "value": {
            "allOf": [
              {
                "$ref": "#/components/schemas/GoogleProtobufValue"
              }
            ],
            "description": "The value for the update operation. The type depends on the property and operation:\n- For \"tags\": array of strings\n- For \"delete_lock\": boolean\n- For \"autokill\": object with time_ms field"
          }
        },
        "x-package": "instances"
      },
      "UpdateTemplateInstancesRequestItem": {
        "required": [
          "prop",
          "op"
        ],
        "type": "object",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "example": "op-1",
                "type": "string",
                "description": "(Optional).  A client-provided identifier for tracking this operation in\nthe response."
              },
              "metro": {
                "example": "fra",
                "type": "string",
                "description": "(Only applies when using global control plane).\nThe metro of the template instance."
              },
              "prop": {
                "example": "tags",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MutableTemplateInstanceProperty"
                  }
                ],
                "description": "The property to modify."
              },
              "op": {
                "example": "add",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MutableTemplateInstanceOperation"
                  }
                ],
                "description": "The operation to perform on the property."
              },
              "value": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/GoogleProtobufValue"
                  }
                ],
                "description": "The value for the update operation. The type depends on the property and operation:\n- For \"tags\": array of strings\n- For \"delete_lock\": boolean\n- For \"autokill\": object with time_ms field"
              }
            }
          },
          {
            "oneOf": [
              {
                "title": "uuid",
                "type": "object",
                "properties": {
                  "uuid": {
                    "example": "123e4567-e89b-12d3-a456-426614174000",
                    "type": "string",
                    "description": "The UUID of the template instance to update. Mutually exclusive with name.",
                    "format": "uuid"
                  }
                }
              },
              {
                "title": "name",
                "type": "object",
                "properties": {
                  "name": {
                    "example": "funky-town-g756b5d",
                    "type": "string",
                    "description": "The name of the template instance to update. Mutually exclusive with UUID."
                  }
                }
              }
            ]
          }
        ],
        "description": "A single update operation to be applied to a template instance.",
        "x-package": "instances"
      },
      "UpdateTemplateInstancesResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UpdateTemplateInstancesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 76,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for updating a template instance by its UUID.",
        "x-package": "instances"
      },
      "UpdateTemplateInstancesResponseData": {
        "type": "object",
        "properties": {
          "instances": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UpdateTemplateInstancesResponseTemplateInstance"
            },
            "description": "List of template instances that were processed during the update operation."
          }
        },
        "x-package": "instances"
      },
      "UpdateTemplateInstancesResponseTemplateInstance": {
        "required": [
          "uuid",
          "name",
          "status"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the template instance that was updated.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-town-g756b5d",
            "type": "string",
            "description": "The name of the template instance that was updated."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the template instance."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of this particular template instance update operation."
          },
          "id": {
            "example": "op-1",
            "type": "string",
            "description": "(Optional).  The client-provided ID from the request."
          },
          "message": {
            "example": "No template instance with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "instances"
      },
      "UpdateTemplateVolumeByUUIDRequestBody": {
        "required": [
          "prop",
          "op"
        ],
        "type": "object",
        "properties": {
          "id": {
            "example": "op-1",
            "type": "string",
            "description": "(Optional).  A client-provided identifier for tracking this operation in\nthe response."
          },
          "prop": {
            "example": "tags",
            "allOf": [
              {
                "$ref": "#/components/schemas/MutableTemplateVolumeProperty"
              }
            ],
            "description": "The property to modify."
          },
          "op": {
            "example": "set",
            "allOf": [
              {
                "$ref": "#/components/schemas/MutableTemplateVolumeOperation"
              }
            ],
            "description": "The operation to perform."
          },
          "value": {
            "allOf": [
              {
                "$ref": "#/components/schemas/GoogleProtobufValue"
              }
            ],
            "description": "The value for the update operation. The type depends on the property and operation:\n- For \"tags\": array of Strings\n- For \"delete_lock\": boolean"
          }
        },
        "x-package": "volumes"
      },
      "UpdateTemplateVolumesRequestItem": {
        "required": [
          "prop",
          "op"
        ],
        "type": "object",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "example": "op-1",
                "type": "string",
                "description": "(Optional).  A client-provided identifier for tracking this operation in\nthe response."
              },
              "metro": {
                "example": "fra",
                "type": "string",
                "description": "(Only applies when using global control plane).\nThe metro to route the request to."
              },
              "prop": {
                "example": "tags",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MutableTemplateVolumeProperty"
                  }
                ],
                "description": "The property to modify."
              },
              "op": {
                "example": "add",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MutableTemplateVolumeOperation"
                  }
                ],
                "description": "The operation to perform."
              },
              "value": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/GoogleProtobufValue"
                  }
                ],
                "description": "The value for the update operation. The type depends on the property and operation:\n- For \"tags\": array of Strings\n- For \"delete_lock\": boolean"
              }
            }
          },
          {
            "oneOf": [
              {
                "title": "uuid",
                "type": "object",
                "properties": {
                  "uuid": {
                    "example": "123e4567-e89b-12d3-a456-426614174000",
                    "type": "string",
                    "description": "The UUID of the template volume to update.  Mutually exclusive with\nname.",
                    "format": "uuid"
                  }
                }
              },
              {
                "title": "name",
                "type": "object",
                "properties": {
                  "name": {
                    "example": "funky-vol-g7gum5cj",
                    "type": "string",
                    "description": "The name of the template volume to update.  Mutually exclusive with\nUUID."
                  }
                }
              }
            ]
          }
        ],
        "description": "A single update operation to be applied to a template volume.",
        "x-package": "volumes"
      },
      "UpdateTemplateVolumesResponse": {
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UpdateTemplateVolumesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 46,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for updating one or more template volumes.",
        "x-package": "volumes"
      },
      "UpdateTemplateVolumesResponseData": {
        "type": "object",
        "properties": {
          "volumes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UpdateTemplateVolumesResponseTemplateVolume"
            },
            "description": "The template volume(s) which were updated by the request."
          }
        },
        "x-package": "volumes"
      },
      "UpdateTemplateVolumesResponseTemplateVolume": {
        "required": [
          "uuid",
          "name",
          "status"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the template volume that was updated.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-town-g756b5d",
            "type": "string",
            "description": "The name of the template volume that was updated."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the volume."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of this particular volume update operation."
          },
          "id": {
            "example": "op-1",
            "type": "string",
            "description": "(Optional).  The client-provided ID from the request."
          },
          "message": {
            "example": "No volume with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "volumes"
      },
      "UpdateVolumeByUUIDRequestBody": {
        "required": [
          "prop",
          "op"
        ],
        "type": "object",
        "properties": {
          "id": {
            "example": "op-1",
            "type": "string",
            "description": "(Optional).  A client-provided identifier for tracking this operation in the response."
          },
          "prop": {
            "example": "size_mb",
            "allOf": [
              {
                "$ref": "#/components/schemas/MutableVolumeProperty"
              }
            ],
            "description": "The property to modify."
          },
          "op": {
            "example": "set",
            "allOf": [
              {
                "$ref": "#/components/schemas/MutableVolumeOperation"
              }
            ],
            "description": "The operation to perform."
          },
          "value": {
            "allOf": [
              {
                "$ref": "#/components/schemas/GoogleProtobufValue"
              }
            ],
            "description": "The value for the update operation. The type depends on the property and operation:\n- For \"size_mb\": unsigned integer\n- For \"quota_policy\": \"static\" or \"dynamic\"\n- For \"tags\": array of Strings\n- For \"delete_lock\": boolean"
          }
        },
        "x-package": "volumes"
      },
      "UpdateVolumesRequestItem": {
        "required": [
          "prop",
          "op"
        ],
        "type": "object",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "example": "op-1",
                "type": "string",
                "description": "(Optional).  A client-provided identifier for tracking this operation in the response."
              },
              "metro": {
                "example": "fra",
                "type": "string",
                "description": "(Only applies when using global control plane).\nThe metro to route the request to."
              },
              "prop": {
                "example": "size_mb",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MutableVolumeProperty"
                  }
                ],
                "description": "The property to modify."
              },
              "op": {
                "example": "set",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MutableVolumeOperation"
                  }
                ],
                "description": "The operation to perform."
              },
              "value": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/GoogleProtobufValue"
                  }
                ],
                "description": "The value for the update operation. The type depends on the property and operation:\n- For \"size_mb\": unsigned integer\n- For \"quota_policy\": \"static\" or \"dynamic\"\n- For \"tags\": array of Strings\n- For \"delete_lock\": boolean"
              }
            }
          },
          {
            "oneOf": [
              {
                "title": "uuid",
                "type": "object",
                "properties": {
                  "uuid": {
                    "example": "123e4567-e89b-12d3-a456-426614174000",
                    "type": "string",
                    "description": "The UUID of the volume to update.  Mutually exclusive with name.",
                    "format": "uuid"
                  }
                }
              },
              {
                "title": "name",
                "type": "object",
                "properties": {
                  "name": {
                    "example": "funky-town-g756b5d",
                    "type": "string",
                    "description": "The name of the volume to update.  Mutually exclusive with UUID."
                  }
                }
              }
            ]
          }
        ],
        "description": "A single request item for updating a volume.",
        "x-package": "volumes"
      },
      "UpdateVolumesResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UpdateVolumesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 76,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for updating one or more volume(s).",
        "x-package": "volumes"
      },
      "UpdateVolumesResponseData": {
        "type": "object",
        "properties": {
          "volumes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UpdateVolumesResponseUpdatedVolume"
            },
            "description": "List of volumes that were processed during the update operation."
          }
        },
        "x-package": "volumes"
      },
      "UpdateVolumesResponseUpdatedVolume": {
        "required": [
          "uuid",
          "name",
          "status"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the volume that was updated.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-town-g756b5d",
            "type": "string",
            "description": "The name of the volume that was updated."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the volume."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of this particular volume update operation."
          },
          "id": {
            "example": "op-1",
            "type": "string",
            "description": "(Optional).  The client-provided ID from the request."
          },
          "message": {
            "example": "No volume with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          }
        },
        "x-package": "volumes"
      },
      "User": {
        "required": [
          "uuid",
          "name",
          "auth_token"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "example": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
            "type": "string",
            "description": "The UUID of the user.",
            "format": "uuid"
          },
          "name": {
            "example": "example",
            "maxLength": 64,
            "minLength": 1,
            "type": "string",
            "description": "The name of the user."
          },
          "auth_token": {
            "example": "ZXhhbXBsZS10b2tlbg==",
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Authentication token(s) associated with the user."
          },
          "permissions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UserPermission"
            },
            "description": "The permission level of the user."
          },
          "uid": {
            "example": 1000,
            "type": "integer",
            "description": "The user ID (UID) on the host system.",
            "format": "uint32"
          },
          "disabled": {
            "example": false,
            "type": "boolean",
            "description": "Whether the user account is disabled."
          },
          "vmdb": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UserVmdb"
              }
            ],
            "description": "Per-VM Configuration limits for the user."
          },
          "net": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UserNet"
              }
            ],
            "description": "Network configuration limits for the user."
          },
          "vmm": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UserVmm"
              }
            ],
            "description": "Global VM configuration limits for the user."
          },
          "stor": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UserStor"
              }
            ],
            "description": "Storage configuration limits for the user."
          },
          "autoscale": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UserAutoscale"
              }
            ],
            "description": "Autoscale configuration limits for the user."
          }
        },
        "x-package": "users"
      },
      "UserAutoscale": {
        "type": "object",
        "properties": {
          "min_size": {
            "example": 1,
            "type": "integer",
            "description": "Minimum size of an autoscale group.",
            "format": "int32"
          },
          "max_size": {
            "example": 16,
            "minimum": 1.0,
            "type": "integer",
            "description": "Maximum size of an autoscale group.",
            "format": "int32"
          }
        },
        "x-package": "users"
      },
      "UserNet": {
        "type": "object",
        "properties": {
          "max_service_groups": {
            "example": 16,
            "type": "integer",
            "description": "Maximum number of service groups the user can have at one moment.",
            "format": "int32"
          },
          "max_services": {
            "example": 32,
            "type": "integer",
            "description": "Maximum number of services across all service groups the user can have\nat one moment.",
            "format": "int32"
          },
          "max_certificates": {
            "example": 16,
            "type": "integer",
            "description": "Maximum number of TLS certificates the user can have at one moment.",
            "format": "int32"
          }
        },
        "x-package": "users"
      },
      "UserPermission": {
        "enum": [
          "root",
          "override_edns_blacklist",
          "developer",
          "volume_manager",
          "override_vm_priority"
        ],
        "type": "string",
        "format": "enum",
        "x-package": "users"
      },
      "UserStor": {
        "type": "object",
        "properties": {
          "max_volumes": {
            "example": 8,
            "type": "integer",
            "description": "Maximum number of volumes the user can have at one moment.",
            "format": "int32"
          },
          "min_volume_mb": {
            "example": 1,
            "minimum": 1.0,
            "type": "integer",
            "description": "Minimum size of a volume in MB.",
            "format": "int32"
          },
          "max_volume_mb": {
            "example": 1024,
            "minimum": 1.0,
            "type": "integer",
            "description": "Maximum size of a volume in MB.",
            "format": "int32"
          },
          "max_total_volume_mb": {
            "example": 2048,
            "type": "integer",
            "description": "Maximum total size of all volumes in MB.",
            "format": "int32"
          }
        },
        "x-package": "users"
      },
      "UserVmdb": {
        "type": "object",
        "properties": {
          "max_instances": {
            "example": 16,
            "type": "integer",
            "description": "Maximum number of VM instances the user can have at one moment.",
            "format": "int32"
          },
          "min_memory_mb": {
            "example": 16,
            "minimum": 1.0,
            "type": "integer",
            "description": "Minimum amount of memory assigned to a VM in MB.",
            "format": "int32"
          },
          "def_memory_mb": {
            "example": 512,
            "minimum": 1.0,
            "type": "integer",
            "description": "Default amount of memory assigned to a VM in MB.",
            "format": "int32"
          },
          "max_memory_mb": {
            "example": 2048,
            "minimum": 1.0,
            "type": "integer",
            "description": "Maximum amount of memory assigned to a VM in MB.",
            "format": "int32"
          },
          "min_vcpus": {
            "example": 1,
            "minimum": 1.0,
            "type": "integer",
            "description": "Minimum number of vCPUs assigned to a VM.",
            "format": "int32"
          },
          "max_vcpus": {
            "example": 4,
            "minimum": 1.0,
            "type": "integer",
            "description": "Maximum number of vCPUs assigned to a VM.",
            "format": "int32"
          }
        },
        "x-package": "users"
      },
      "UserVmm": {
        "type": "object",
        "properties": {
          "max_vcpus": {
            "example": 4,
            "type": "integer",
            "description": "Maximum number of vCPUs the user can have assigned to live instances.",
            "format": "int32"
          },
          "max_memory_mb": {
            "example": 2048,
            "type": "integer",
            "description": "Maximum amount of memory in MB the user can have assigned to live\ninstances.",
            "format": "int32"
          }
        },
        "x-package": "users"
      },
      "Volume": {
        "required": [
          "uuid",
          "name",
          "created_at",
          "state",
          "size_mb",
          "persistent",
          "quota_policy"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "example": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
            "type": "string",
            "description": "The UUID of the volume.\n\nThis is a unique identifier for the volume that is generated when the\nvolume is created.  The UUID is used to reference the volume in\nAPI calls and can be used to identify the volume in all API calls that\nrequire an identifier.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-town-g7gum5cj",
            "type": "string",
            "description": "The name of the volume.\n\nThis is a human-readable name that can be used to identify the volume.\nThe name must be unique within the context of your account.  The name can\nalso be used to identify the volume in API calls."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nWhere the volume is located."
          },
          "created_at": {
            "example": "2021-01-01T00:00:00Z",
            "type": "string",
            "description": "The time the volume was created.",
            "format": "date-time"
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/VolumeState"
              }
            ],
            "description": "Current state of the volume."
          },
          "size_mb": {
            "example": 64,
            "type": "integer",
            "description": "The size of the volume in megabytes.",
            "format": "uint64"
          },
          "persistent": {
            "example": true,
            "type": "boolean",
            "description": "Indicates if the volume will stay alive when the last instance is deleted\nthat this volume is attached to."
          },
          "attached_to": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/VolumeInstanceID"
            },
            "description": "List of instances that this volume is attached to."
          },
          "mounted_by": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/VolumeInstanceMount"
            },
            "description": "List of instances that have this volume mounted.\nThis does not apply to template volumes."
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The tags associated with the volume.\nMaximum 16 tags are allowed, and each tag may not be longer than 256 characters."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "An optional field representing the status of the request.  This field is\nonly set when this message object is used as a response message."
          },
          "message": {
            "example": "No volume with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is only set when this message object is used as a response\nmessage, and is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is only set when this message object is used as a response\nmessage, and is useful when the status is not `success`.",
            "format": "int32"
          },
          "quota_policy": {
            "example": "static",
            "allOf": [
              {
                "$ref": "#/components/schemas/VolumeQuotaPolicy"
              }
            ],
            "description": "Either static or dynamic reservation."
          },
          "delete_lock": {
            "example": false,
            "type": "boolean",
            "description": "If set to true, the volume cannot be deleted."
          },
          "free_mb": {
            "example": 32,
            "type": "integer",
            "description": "The amount of free space in the volume in megabytes.",
            "format": "uint32"
          },
          "filesystem": {
            "example": "ext4",
            "type": "string",
            "description": "The filesystem type of this volume.\nWithout custom configuration, this is either `ext4` or `virtiofs`."
          },
          "host_path": {
            "example": "/usr/lib/unikraft/volumes/my-vol",
            "type": "string",
            "description": "Host path backing this managed volume.\nThis field is only available for managed volumes and users with\nappropriate permissions."
          },
          "args": {
            "example": {
              "arg1": "value1",
              "arg2": "value2"
            },
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Optional script arguments that were applied to the custom volume filesystem\ninitialization scripts."
          },
          "access_mode": {
            "example": "rwo",
            "allOf": [
              {
                "$ref": "#/components/schemas/VolumeAccessMode"
              }
            ],
            "description": "The access mode of the volume, controlling volume sharing behavior.\nDefaults to `rwo` if not specified."
          }
        },
        "description": "A volume represents a storage device that can be attached to an instance.",
        "x-package": "volumes"
      },
      "VolumeAccessMode": {
        "enum": [
          "rwo",
          "rox",
          "rwx"
        ],
        "type": "string",
        "description": "VolumeAccessMode defines the access mode of a volume, which controls sharing\nbehavior and caching strategy.",
        "format": "enum",
        "x-package": "volumes"
      },
      "VolumeInstanceID": {
        "required": [
          "uuid"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "example": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
            "type": "string",
            "description": "The UUID of the instance that the volume is attached to.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-town-g7gum5cj",
            "type": "string",
            "description": "The name of the instance that the volume is attached to."
          }
        },
        "description": "Reference to the instance to attach the volume to.",
        "x-package": "volumes"
      },
      "VolumeInstanceMount": {
        "required": [
          "uuid",
          "name",
          "readonly"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "example": "funky-town-g7gum5cj",
            "type": "string",
            "description": "The UUID of the instance that the volume is mounted in.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-town-g7gum5cj",
            "type": "string",
            "description": "The name of the instance that the volume is mounted in."
          },
          "readonly": {
            "example": true,
            "type": "boolean",
            "description": "Whether the volume is mounted read-only or read-write."
          }
        },
        "x-package": "volumes"
      },
      "VolumeQuotaPolicy": {
        "enum": [
          "static",
          "dynamic"
        ],
        "type": "string",
        "description": "VolumeQuotaPolicy defines the quota policy of a volume.",
        "format": "enum",
        "x-package": "volumes"
      },
      "VolumeState": {
        "enum": [
          "uninitialized",
          "initializing",
          "available",
          "idle",
          "mounted",
          "busy",
          "error",
          "template"
        ],
        "type": "string",
        "description": "VolumeState defines the state of a volume at a given moment.",
        "format": "enum",
        "x-package": "volumes"
      },
      "WaitInstanceByUUIDRequestBody": {
        "required": [
          "state"
        ],
        "type": "object",
        "properties": {
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/InstanceState"
              }
            ],
            "description": "The desired state to wait for.  Default is `running`."
          },
          "timeout_ms": {
            "example": 450,
            "type": "integer",
            "description": "Deprecated: Use `timeout_s` instead. Timeout in milliseconds to\nwait for the instance to reach the desired state.  If `timeout_s` is\nnot set, this value is converted by rounding up to the next full\nsecond. A value of -1 means to wait indefinitely.",
            "format": "int64"
          },
          "timeout_s": {
            "example": 2,
            "type": "integer",
            "description": "Timeout in seconds to wait for the instance to reach the desired\nstate. If the timeout is reached, the request will fail with an\nerror. A value of -1 means to wait indefinitely until the instance\nreaches the desired state.  No wait performed for a value of 0.",
            "format": "int64"
          }
        },
        "description": "Wait parameters.",
        "x-package": "instances"
      },
      "WaitInstancesRequestItem": {
        "type": "object",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "state": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/InstanceState"
                  }
                ],
                "description": "The desired state to wait for.  Default is `running`."
              },
              "timeout_ms": {
                "example": 450,
                "type": "integer",
                "description": "Deprecated: Use `timeout_s` instead. Timeout in milliseconds to\nwait for the instance to reach the desired state. If `timeout_s` is\nnot set, this value is converted by rounding up to the next full\nsecond. A value of -1 means to wait indefinitely.",
                "format": "int64"
              },
              "timeout_s": {
                "example": 2,
                "type": "integer",
                "description": "Timeout in seconds to wait for the instance to reach the desired\nstate. If the timeout is reached, the request will fail with an\nerror. A value of -1 means to wait indefinitely until the instance\nreaches the desired state. No wait performed for a value of 0.",
                "format": "int64"
              }
            }
          },
          {
            "oneOf": [
              {
                "title": "uuid",
                "type": "object",
                "properties": {
                  "uuid": {
                    "example": "123e4567-e89b-12d3-a456-426614174000",
                    "type": "string",
                    "description": "The UUID of the instance to wait for.  Mutually exclusive with name.",
                    "format": "uuid"
                  }
                }
              },
              {
                "title": "name",
                "type": "object",
                "properties": {
                  "name": {
                    "example": "funky-town-g756b5d",
                    "type": "string",
                    "description": "The name of the instance to wait for.  Mutually exclusive with UUID."
                  }
                }
              }
            ]
          }
        ],
        "description": "A single wait operation to be applied to an instance.",
        "x-package": "instances"
      },
      "WaitInstancesResponse": {
        "required": [
          "status",
          "op_time_us"
        ],
        "type": "object",
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "example": "Failed to perform all operations",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/WaitInstancesResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "example": 450,
            "type": "integer",
            "description": "The operation time in microseconds.  This is the time it took to process\nthe request and generate the response.",
            "format": "uint64"
          }
        },
        "description": "The response message for waiting for one or more instance(s) to reach a\ncertain state given their UUID(s) or name(s).",
        "x-package": "instances"
      },
      "WaitInstancesResponseData": {
        "type": "object",
        "properties": {
          "instances": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WaitInstancesResponseWaitedInstance"
            },
            "description": "The instance(s) which this requested waited on."
          }
        },
        "x-package": "instances"
      },
      "WaitInstancesResponseWaitedInstance": {
        "required": [
          "uuid",
          "name",
          "state"
        ],
        "type": "object",
        "properties": {
          "uuid": {
            "example": "123e4567-e89b-12d3-a456-426614174000",
            "type": "string",
            "description": "The UUID of the instance.",
            "format": "uuid"
          },
          "name": {
            "example": "funky-town-g756b5d",
            "type": "string",
            "description": "The name of the instance."
          },
          "metro": {
            "example": "fra",
            "type": "string",
            "description": "(Only applies when using global control plane).\nThe metro of the instance."
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/InstanceState"
              }
            ],
            "description": "The current state of the instance."
          },
          "message": {
            "example": "No instance with name 'funky-town-g756b5d'",
            "type": "string",
            "description": "An optional message providing additional information about the status.\nThis field is useful when the status is not `success`."
          },
          "error": {
            "example": 8,
            "type": "integer",
            "description": "An optional error code providing additional information about the status.\nThis field is useful when the status is not `success`.",
            "format": "int32"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ],
            "description": "The status of the response."
          }
        },
        "x-package": "instances"
      }
    },
    "securitySchemes": {
      "bearerToken": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "security": [
    {
      "bearerToken": []
    }
  ],
  "tags": [
    {
      "name": "Autoscale",
      "description": "Services allow you to load balance traffic for an Internet-facing service\nlike a webserver by creating multiple instances within the same service.\nWhile you can add or remove instances to a service to scale your service,\ndoing this manually makes it hard to react to changes in service load. On\nthe other hand, always keeping a large number of instances running to cope\nwith bursts is not an option either. This is where autoscale comes into play.\nWith autoscale enabled, Unikraft Cloud takes the heavy lifting of constantly\nmonitoring the load of your service and automatically creates or deletes\ninstances as needed."
    },
    {
      "name": "Certificates",
      "description": "Unikraft Cloud allows you to host your deployment at subdomains of the\nintended metro and/or use custom domains (e.g., example.com).  Typically,\nUnikraft Cloud will automatically generate a TLS certificate for you based\non Let's Encrypt™ via a DNS-01 challenge.\n\nFor subdomains, your deployment will use the wildcard TLS certificate of the\nrespective Unikraft Cloud metro.\n\nFor wildcard domains you have to supply your own certificate.  If you want to\nuse Let's Encrypt™ you can use their DNS-based challenge and upload the\nresulting certificate to Unikraft Cloud."
    },
    {
      "name": "Images",
      "description": "An image is a collection of objects representing a VM which can be deployed\non Unikraft Cloud.  Its format is based on the OCI Image Specification.\nWithin the context of Unikraft Cloud, these images also include a kernel\ncomponent."
    },
    {
      "name": "Instances",
      "description": "An instance is a unikernel virtual machine running an application."
    },
    {
      "name": "Node"
    },
    {
      "name": "ServiceGroups",
      "description": "A service group on Unikraft Cloud is used to describe how your application\nexposes its functionality to the outside world.  Once defined, assigning an\ninstance to the service will make it accessible from the Internet.\n\nAn application, running as an instance, may expose one or more ports, e.g. it\nlistens on port 80 because your application exposes a HTTP web service. This,\nalong with a set of additional metadata defines how the \"service\" is\nconfigured and accessed.  For example, a service may be configured to use\nTLS, or be bound to a specific domain name.\n\nWhen an instance is assigned to a service group, it immediately becomes\naccessible over the Internet on the exposed public port, using the set DNS\nname, and is routed to the set destination port.\n\nNote: If you do not specify a DNS name when you create a service and you\nindicate that the application exposes some ports, Unikraft Cloud will\ngenerates a random DNS name for you.  Unikraft Cloud also supports custom\ndomains like www.example.com and wildcard domains like *.example.com."
    },
    {
      "name": "Users",
      "description": "Unikraft Cloud user accounts are used to manage resources, grant permissions\nand control usage quotas when interacting with the Unikraft Cloud API."
    },
    {
      "name": "Volumes",
      "description": "Initrd (initial ramdisk) and actual volumes serve different purposes.\nAn initrd is a file system loaded into memory during the boot process of the\ninstance. Any new files created as well as any modifications made to files\nin the initrd are lost when the instance is stopped. In contrast, a volume\nis a persistent storage device that keeps data across restarts. In addition,\nit can be initialized with a set of files with one instance and then be\ndetached and attached to a another one."
    }
  ]
}