platform.json

{
  "openapi": "3.0.0",
  "info": {
    "title": "Unikraft Cloud Platform API",
    "version": "v1.0.0",
    "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."
  },
  "tags": [
    {
      "name": "audit",
      "x-displayName": "Audit",
      "description": "Audit events attribute state changes to the operation that caused them.\nEvents are emitted to the controller's configured log sinks and are not\nstored or queryable here; this API subscribes to them live."
    },
    {
      "name": "node",
      "x-displayName": "Node"
    },
    {
      "name": "users",
      "x-displayName": "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": "images",
      "x-displayName": "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": "certificates",
      "x-displayName": "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": "autoscale",
      "x-displayName": "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": "volumes",
      "x-displayName": "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."
    },
    {
      "name": "services",
      "x-displayName": "Service Groups",
      "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": "instances",
      "x-displayName": "Instances",
      "description": "An instance is a micro vm running an application."
    }
  ],
  "paths": {
    "/v1/audit": {
      "get": {
        "operationId": "SubscribeAuditEvents",
        "summary": "Subscribe to Audit Events",
        "description": "Subscribe to audit events as they are raised.",
        "parameters": [
          {
            "name": "events",
            "in": "query",
            "required": false,
            "description": "Deliver only these event types.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/Audit.AuditEventType"
              }
            },
            "explode": false
          },
          {
            "name": "uuid",
            "in": "query",
            "required": false,
            "description": "Deliver only events about these object UUIDs.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "explode": false
          },
          {
            "name": "tags",
            "in": "query",
            "required": false,
            "description": "Deliver only events about objects carrying all of these tags.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "explode": false
          }
        ],
        "responses": {
          "default": {
            "description": "The audit event stream.\n\nThe default response rather than 200 because that is what marks an operation\nas streaming: a status-coded response describes one body, this describes every\nmessage on an open connection.",
            "content": {
              "text/event-stream": {
                "schema": {
                  "$ref": "#/components/schemas/Audit.AuditEvent"
                }
              }
            }
          }
        },
        "tags": [
          "audit"
        ]
      }
    },
    "/v1/certificates": {
      "post": {
        "operationId": "CreateCertificate",
        "summary": "Create Certificate",
        "description": "Upload a new certificate.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Certificates.CreateCertificateResponse"
                }
              }
            }
          }
        },
        "tags": [
          "certificates"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Certificates.CreateCertificateRequest"
              }
            }
          }
        }
      },
      "get": {
        "operationId": "GetCertificates",
        "summary": "List Certificates",
        "description": "List certificates.",
        "parameters": [
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.uuid"
          },
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.name"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.details"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.count"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.from"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.order"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.sortby"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Certificates.GetCertificatesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "certificates"
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Common.NameOrUUID"
                }
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "DeleteCertificates",
        "summary": "Delete Certificates",
        "description": "Delete certificates by ID(s).",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Certificates.DeleteCertificatesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "certificates"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Common.NameOrUUID"
                }
              }
            }
          }
        }
      },
      "put": {
        "operationId": "UpdateCertificates",
        "summary": "Update Certificates",
        "description": "Update certificates.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Certificates.UpdateCertificatesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "certificates"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Certificates.UpdateCertificatesRequestItem"
                }
              }
            }
          }
        }
      }
    },
    "/v1/certificates/{uuid}": {
      "get": {
        "operationId": "GetCertificateByUUID",
        "summary": "Get Certificate by UUID",
        "description": "Get a certificate by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Certificates.GetCertificatesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "certificates"
        ]
      },
      "delete": {
        "operationId": "DeleteCertificateByUUID",
        "summary": "Delete Certificate by UUID",
        "description": "Delete a certificate by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Certificates.DeleteCertificatesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "certificates"
        ]
      },
      "put": {
        "operationId": "UpdateCertificateByUUID",
        "summary": "Update Certificate by UUID",
        "description": "Update a certificate by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Certificates.UpdateCertificatesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "certificates"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Certificates.UpdateCertificateByUUIDRequestBody"
              }
            }
          }
        }
      }
    },
    "/v1/healthz": {
      "get": {
        "operationId": "Healthz",
        "summary": "Health Check",
        "description": "Return the status of a full-system health check.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Node.HealthzResponse"
                }
              }
            }
          }
        },
        "tags": [
          "node"
        ]
      }
    },
    "/v1/image-store": {
      "get": {
        "operationId": "GetImageStore",
        "summary": "Get Images in Store",
        "description": "Retrieve all images in store.",
        "parameters": [
          {
            "name": "digest",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "explode": false
          },
          {
            "name": "tag",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "explode": false
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Images.GetImagesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "images"
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Images.GetImagesRequestTagOrDigest"
                }
              }
            }
          }
        }
      }
    },
    "/v1/images": {
      "get": {
        "operationId": "GetImages",
        "summary": "Get Images",
        "description": "Retrieve all images.",
        "parameters": [
          {
            "name": "digest",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "explode": false
          },
          {
            "name": "tag",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "explode": false
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Images.GetImagesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "images"
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Images.GetImagesRequestTagOrDigest"
                }
              }
            }
          }
        }
      },
      "post": {
        "operationId": "PinImages",
        "summary": "Pin Images",
        "description": "Pull and pin one or more images so they stay cached and are never\nevicted, without relying on an on-demand pull to succeed at instance\nstart. If a pull fails, the agent's error is returned in the entry's\n`message` field.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Images.PinImagesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "images"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Images.PinImageRequestItem"
                }
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "UnpinImages",
        "summary": "Unpin Images",
        "description": "Unpin one or more images by UUID, making them eligible for normal\ncache eviction again. This does not delete the image.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Images.UnpinImagesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "images"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Images.UnpinImageRequestItem"
                }
              }
            }
          }
        }
      }
    },
    "/v1/instances": {
      "post": {
        "operationId": "CreateInstance",
        "summary": "Create Instance",
        "description": "Create an instance in Unikraft Cloud.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.CreateInstanceResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Instances.CreateInstanceRequest"
              }
            }
          }
        }
      },
      "get": {
        "operationId": "GetInstances",
        "summary": "List Instances",
        "description": "Get one or many instances with their current status and configuration.",
        "parameters": [
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.uuid"
          },
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.name"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.details"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.count"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.from"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.order"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.sortby"
          },
          {
            "name": "tags",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "explode": false
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.GetInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Common.NameOrUUID"
                }
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "DeleteInstances",
        "summary": "Delete Instances",
        "description": "Delete instances by ID(s).",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.DeleteInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.DeleteInstanceRequestItem"
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "UpdateInstances",
        "summary": "Update Instances",
        "description": "Update instances by ID(s).",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.UpdateInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.UpdateInstancesRequestItem"
                }
              }
            }
          }
        }
      }
    },
    "/v1/instances/checkpoints": {
      "get": {
        "operationId": "GetCheckpointInstances",
        "summary": "List Checkpoint Instances",
        "description": "Get one or more checkpoint instances by their UUID(s) or name(s).",
        "parameters": [
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.uuid"
          },
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.name"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.details"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.count"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.from"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.order"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.sortby"
          },
          {
            "name": "tags",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "explode": false
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.GetCheckpointInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Common.NameOrUUID"
                }
              }
            }
          }
        }
      },
      "post": {
        "operationId": "CreateCheckpointInstances",
        "summary": "Create Checkpoint Instances",
        "description": "Create a checkpoint from an existing instance. A checkpoint captures the\nstate of an instance at a specific point in time. Checkpoints can be\ncreated from running, stopped, or standby instances.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.CreateCheckpointInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.CreateCheckpointInstancesRequestItem"
                }
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "DeleteCheckpointInstances",
        "summary": "Delete Checkpoint Instances",
        "description": "Delete the specified checkpoint instance(s) by ID(s) (name or UUID).\nAfter this call the IDs of the checkpoint instances are no longer valid.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.DeleteCheckpointInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Common.NameOrUUID"
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "UpdateCheckpointInstances",
        "summary": "Update Checkpoint Instances",
        "description": "Update (modify) one or more checkpoint instances by ID(s) (name or UUID).",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.UpdateCheckpointInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.UpdateCheckpointInstancesRequestItem"
                }
              }
            }
          }
        }
      }
    },
    "/v1/instances/checkpoints/history": {
      "get": {
        "operationId": "GetCheckpointHistory",
        "summary": "Get Checkpoint History",
        "description": "Get the checkpoint history of one or more checkpoint instances.\nReturns the ordered list of checkpoints in each checkpoint's history.",
        "parameters": [
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.uuid"
          },
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.name"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.GetCheckpointHistoryResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Common.NameOrUUID"
                }
              }
            }
          }
        }
      }
    },
    "/v1/instances/checkpoints/{uuid}": {
      "get": {
        "operationId": "GetCheckpointInstanceByUUID",
        "summary": "Get Checkpoint Instance by UUID",
        "description": "Get a single checkpoint instance by its UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "details",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "explode": false
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.GetCheckpointInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ]
      },
      "delete": {
        "operationId": "DeleteCheckpointInstanceByUUID",
        "summary": "Delete Checkpoint Instance by UUID",
        "description": "Delete a specified checkpoint instance by its UUID. After this call the\nUUID of the checkpoint instance is no longer valid.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.DeleteCheckpointInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ]
      },
      "patch": {
        "operationId": "UpdateCheckpointInstanceByUUID",
        "summary": "Update Checkpoint Instance by UUID",
        "description": "Update (modify) a checkpoint instance by its UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.UpdateCheckpointInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Instances.UpdateCheckpointInstanceByUUIDRequestBody"
              }
            }
          }
        }
      }
    },
    "/v1/instances/checkpoints/{uuid}/history": {
      "get": {
        "operationId": "GetCheckpointHistoryByUUID",
        "summary": "Get Checkpoint History by UUID",
        "description": "Get the checkpoint history of a checkpoint instance by its UUID.\nReturns the ordered list of checkpoints in the checkpoint's history.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.GetCheckpointHistoryResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ]
      }
    },
    "/v1/instances/history": {
      "get": {
        "operationId": "GetInstanceHistory",
        "summary": "Get Instances Checkpoint History",
        "description": "Get the checkpoint history of one or more instances.\nReturns the ordered list of checkpoints associated with each instance.",
        "parameters": [
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.uuid"
          },
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.name"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.GetCheckpointHistoryResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Common.NameOrUUID"
                }
              }
            }
          }
        }
      }
    },
    "/v1/instances/log": {
      "get": {
        "operationId": "GetInstanceLogs",
        "summary": "Get Instances Logs",
        "description": "Get instances logs.",
        "parameters": [
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.uuid"
          },
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.name"
          },
          {
            "name": "offset",
            "in": "query",
            "required": false,
            "description": "The byte offset of the log output to receive. A negative sign makes the\noffset relative to the end of the log.",
            "schema": {
              "type": "array",
              "items": {
                "type": "integer",
                "format": "int64"
              }
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "The amount of bytes to return at most.",
            "schema": {
              "type": "array",
              "items": {
                "type": "integer",
                "format": "int64"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.GetInstancesLogsResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.GetInstancesLogsRequestItem"
                }
              }
            }
          }
        }
      }
    },
    "/v1/instances/metrics": {
      "get": {
        "operationId": "GetInstanceMetrics",
        "summary": "Get Instances Metrics",
        "description": "Get instances metrics.",
        "parameters": [
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.uuid"
          },
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.name"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.GetInstancesMetricsResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Common.NameOrUUID"
                }
              }
            }
          }
        }
      }
    },
    "/v1/instances/start": {
      "put": {
        "operationId": "StartInstances",
        "summary": "Start Instances",
        "description": "Start instances by ID(s).",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.StartInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.StartInstancesRequestItem"
                }
              }
            }
          }
        }
      }
    },
    "/v1/instances/stop": {
      "put": {
        "operationId": "StopInstances",
        "summary": "Stop Instances",
        "description": "Stop instances by ID(s).",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.StopInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.StopInstancesRequestItem"
                }
              }
            }
          }
        }
      }
    },
    "/v1/instances/suspend": {
      "put": {
        "operationId": "SuspendInstances",
        "summary": "Suspend Instances",
        "description": "Suspend instances by ID(s).",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.SuspendInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.SuspendInstancesRequestItem"
                }
              }
            }
          }
        }
      }
    },
    "/v1/instances/templates": {
      "post": {
        "operationId": "CreateTemplateInstances",
        "summary": "Create template instances from Instances",
        "description": "Convert instances to template instances.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.CreateTemplateInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.CreateTemplateInstancesRequestItem"
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "GetTemplateInstances",
        "summary": "List template instances",
        "description": "Get one or more template instances.",
        "parameters": [
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.uuid"
          },
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.name"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.details"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.count"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.from"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.order"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.sortby"
          },
          {
            "name": "tags",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "explode": false
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.GetTemplateInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Common.NameOrUUID"
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "UpdateTemplateInstances",
        "summary": "Update template instances",
        "description": "Update template instances by ID(s).",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.UpdateTemplateInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.UpdateTemplateInstancesRequestItem"
                }
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "DeleteTemplateInstances",
        "summary": "Delete template instances",
        "description": "Delete template instances by ID(s).",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.DeleteTemplateInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Common.NameOrUUID"
                }
              }
            }
          }
        }
      }
    },
    "/v1/instances/templates/{uuid}": {
      "get": {
        "operationId": "GetTemplateInstanceByUUID",
        "summary": "Get template instance by UUID",
        "description": "Get a single template instance by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "details",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "explode": false
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.GetTemplateInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ]
      },
      "patch": {
        "operationId": "UpdateTemplateInstanceByUUID",
        "summary": "Update template instance by UUID",
        "description": "Update a template instance by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.UpdateTemplateInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Instances.UpdateTemplateInstanceByUUIDRequestBody"
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "DeleteTemplateInstanceByUUID",
        "summary": "Delete template instance by UUID",
        "description": "Delete a template instance by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.DeleteTemplateInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ]
      }
    },
    "/v1/instances/wait": {
      "get": {
        "operationId": "WaitInstances",
        "summary": "Wait for Instances States",
        "description": "Wait for instances to reach states.",
        "parameters": [
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.uuid"
          },
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.name"
          },
          {
            "name": "state",
            "in": "query",
            "required": false,
            "description": "The desired state to wait for. Default is `running`.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/Instances.InstanceState"
              }
            }
          },
          {
            "name": "timeout_ms",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "integer",
                "format": "int64"
              }
            },
            "deprecated": true
          },
          {
            "name": "timeout_s",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "integer",
                "format": "int64"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.WaitInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.WaitInstancesRequestItem"
                }
              }
            }
          }
        }
      }
    },
    "/v1/instances/{uuid}": {
      "get": {
        "operationId": "GetInstanceByUUID",
        "summary": "Get Instance by UUID",
        "description": "Get a single instance by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "details",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "explode": false
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.GetInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ]
      },
      "delete": {
        "operationId": "DeleteInstanceByUUID",
        "summary": "Delete Instance by UUID",
        "description": "Delete instance by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.DeleteInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Instances.DeleteInstanceByUUIDRequestBody"
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "UpdateInstanceByUUID",
        "summary": "Update Instance by UUID",
        "description": "Update instance by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.UpdateInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Instances.UpdateInstanceByUUIDRequestBody"
              }
            }
          }
        }
      }
    },
    "/v1/instances/{uuid}/history": {
      "get": {
        "operationId": "GetInstanceHistoryByUUID",
        "summary": "Get Instance Checkpoint History by UUID",
        "description": "Get the checkpoint history of an instance by its UUID.\nReturns the ordered list of checkpoints associated with the instance.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.GetCheckpointHistoryResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ]
      }
    },
    "/v1/instances/{uuid}/log": {
      "get": {
        "operationId": "GetInstanceLogsByUUID",
        "summary": "Get Instance Logs by UUID",
        "description": "Get instance logs by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.GetInstancesLogsResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Instances.GetInstanceLogsByUUIDRequestBody"
              }
            }
          }
        }
      }
    },
    "/v1/instances/{uuid}/metrics": {
      "get": {
        "operationId": "GetInstanceMetricsByUUID",
        "summary": "Get Instance Metrics by UUID",
        "description": "Get instance metrics by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.GetInstancesMetricsResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ]
      }
    },
    "/v1/instances/{uuid}/start": {
      "put": {
        "operationId": "StartInstanceByUUID",
        "summary": "Start Instance by UUID",
        "description": "Start instance by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.StartInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Instances.StartInstanceByUUIDRequestBody"
              }
            }
          }
        }
      }
    },
    "/v1/instances/{uuid}/stop": {
      "put": {
        "operationId": "StopInstanceByUUID",
        "summary": "Stop Instance by UUID",
        "description": "Stop instance by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.StopInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Instances.StopInstanceByUUIDRequestBody"
              }
            }
          }
        }
      }
    },
    "/v1/instances/{uuid}/suspend": {
      "put": {
        "operationId": "SuspendInstanceByUUID",
        "summary": "Suspend Instance by UUID",
        "description": "Suspend instance by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.SuspendInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Instances.SuspendInstanceByUUIDRequestBody"
              }
            }
          }
        }
      }
    },
    "/v1/instances/{uuid}/wait": {
      "get": {
        "operationId": "WaitInstanceByUUID",
        "summary": "Wait for Instance State by UUID",
        "description": "Wait for instance state by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Instances.WaitInstancesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "instances"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Instances.WaitInstanceByUUIDRequestBody"
              }
            }
          }
        }
      }
    },
    "/v1/services": {
      "post": {
        "operationId": "CreateServiceGroup",
        "summary": "Create Service Group",
        "description": "Create a new service group.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Services.CreateServiceGroupResponse"
                }
              }
            }
          }
        },
        "tags": [
          "services"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Services.CreateServiceGroupRequest"
              }
            }
          }
        }
      },
      "get": {
        "operationId": "GetServiceGroups",
        "summary": "List Service Groups",
        "description": "List service groups.",
        "parameters": [
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.uuid"
          },
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.name"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.details"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.count"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.from"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.order"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.sortby"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Services.GetServiceGroupsResponse"
                }
              }
            }
          }
        },
        "tags": [
          "services"
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Common.NameOrUUID"
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "UpdateServiceGroups",
        "summary": "Update Service Groups",
        "description": "Update service groups.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Services.UpdateServiceGroupsResponse"
                }
              }
            }
          }
        },
        "tags": [
          "services"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Services.UpdateServiceGroupsRequestItem"
                }
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "DeleteServiceGroups",
        "summary": "Delete Service Groups",
        "description": "Delete service groups by ID(s).",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Services.DeleteServiceGroupsResponse"
                }
              }
            }
          }
        },
        "tags": [
          "services"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Common.NameOrUUID"
                }
              }
            }
          }
        }
      }
    },
    "/v1/services/autoscale": {
      "post": {
        "operationId": "CreateAutoscaleConfigurations",
        "summary": "Create Autoscale Configurations",
        "description": "Create one or more autoscale configurations for the specified service groups.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Autoscale.CreateAutoscaleConfigurationsResponse"
                }
              }
            }
          }
        },
        "tags": [
          "autoscale"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Autoscale.CreateAutoscaleConfigurationsRequestConfiguration"
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "GetAutoscaleConfigurations",
        "summary": "List Autoscale Configurations",
        "description": "List autoscale configurations for the specified service groups.",
        "parameters": [
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.uuid"
          },
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.name"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Autoscale.GetAutoscaleConfigurationsResponse"
                }
              }
            }
          }
        },
        "tags": [
          "autoscale"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Common.NameOrUUID"
                }
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "DeleteAutoscaleConfigurations",
        "summary": "Delete Autoscale Configurations",
        "description": "Delete autoscale configurations for the specified service groups.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Autoscale.DeleteAutoscaleConfigurationsResponse"
                }
              }
            }
          }
        },
        "tags": [
          "autoscale"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Common.NameOrUUID"
                }
              }
            }
          }
        }
      }
    },
    "/v1/services/{uuid}": {
      "get": {
        "operationId": "GetServiceGroupByUUID",
        "summary": "Get Service Group by UUID",
        "description": "Get a service group by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "details",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "explode": false
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Services.GetServiceGroupsResponse"
                }
              }
            }
          }
        },
        "tags": [
          "services"
        ]
      },
      "patch": {
        "operationId": "UpdateServiceGroupByUUID",
        "summary": "Update Service Group by UUID",
        "description": "Update a service group by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Services.UpdateServiceGroupsResponse"
                }
              }
            }
          }
        },
        "tags": [
          "services"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Services.UpdateServiceGroupByUUIDRequestBody"
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "DeleteServiceGroupByUUID",
        "summary": "Delete Service Group by UUID",
        "description": "Delete a service group by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Services.DeleteServiceGroupsResponse"
                }
              }
            }
          }
        },
        "tags": [
          "services"
        ]
      }
    },
    "/v1/services/{uuid}/autoscale": {
      "post": {
        "operationId": "CreateAutoscaleConfigurationByServiceGroupUUID",
        "summary": "Create Autoscale Configuration by Service Group UUID",
        "description": "Create an autoscale configuration for a service group by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Autoscale.CreateAutoscaleConfigurationsResponse"
                }
              }
            }
          }
        },
        "tags": [
          "autoscale"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Autoscale.CreateAutoscaleConfigurationByServiceGroupUUIDRequest"
              }
            }
          }
        }
      },
      "get": {
        "operationId": "GetAutoscaleConfigurationsByServiceGroupUUID",
        "summary": "Get Autoscale Configurations by Service Group UUID",
        "description": "Get autoscale configurations for a service group by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Autoscale.GetAutoscaleConfigurationsResponse"
                }
              }
            }
          }
        },
        "tags": [
          "autoscale"
        ]
      },
      "delete": {
        "operationId": "DeleteAutoscaleConfigurationsByServiceGroupUUID",
        "summary": "Delete Autoscale Configurations by Service Group UUID",
        "description": "Delete the autoscale configuration for a service group by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Autoscale.DeleteAutoscaleConfigurationsResponse"
                }
              }
            }
          }
        },
        "tags": [
          "autoscale"
        ]
      }
    },
    "/v1/services/{uuid}/autoscale/policies": {
      "post": {
        "operationId": "CreateAutoscaleConfigurationPolicy",
        "summary": "Create Autoscale Configuration Policy",
        "description": "Add a new autoscale policy to a service group by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Autoscale.CreateAutoscaleConfigurationPolicyResponse"
                }
              }
            }
          }
        },
        "tags": [
          "autoscale"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Autoscale.CreateAutoscaleConfigurationPolicyRequest"
              }
            }
          }
        }
      },
      "get": {
        "operationId": "GetAutoscaleConfigurationPolicies",
        "summary": "List Autoscale Configuration Policies",
        "description": "List autoscale policies for a service group by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Autoscale.GetAutoscaleConfigurationPolicyResponse"
                }
              }
            }
          }
        },
        "tags": [
          "autoscale"
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Autoscale.GetAutoscaleConfigurationPolicyRequest"
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "DeleteAutoscaleConfigurationPolicies",
        "summary": "Delete Autoscale Configuration Policies",
        "description": "Delete autoscale policies for a service group by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Autoscale.DeleteAutoscaleConfigurationPolicyResponse"
                }
              }
            }
          }
        },
        "tags": [
          "autoscale"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Autoscale.DeletePolicyRequest"
              }
            }
          }
        }
      }
    },
    "/v1/services/{uuid}/autoscale/policies/{name}": {
      "get": {
        "operationId": "GetAutoscaleConfigurationPolicyByName",
        "summary": "Get Autoscale Configuration Policy by Name",
        "description": "Get an autoscale policy by name for a service group by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "name",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Autoscale.GetAutoscaleConfigurationPolicyResponse"
                }
              }
            }
          }
        },
        "tags": [
          "autoscale"
        ]
      },
      "delete": {
        "operationId": "DeleteAutoscaleConfigurationPolicyByName",
        "summary": "Delete Autoscale Configuration Policy by Name",
        "description": "Delete an autoscale policy by name for a service group by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "name",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Autoscale.DeleteAutoscaleConfigurationPolicyResponse"
                }
              }
            }
          }
        },
        "tags": [
          "autoscale"
        ]
      }
    },
    "/v1/users/quotas": {
      "get": {
        "operationId": "GetUser",
        "summary": "Get Current User Quotas",
        "description": "List quota usage and limits of your user account.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Users.QuotasResponse"
                }
              }
            }
          }
        },
        "tags": [
          "users"
        ]
      }
    },
    "/v1/users/{uuid}/quotas": {
      "get": {
        "operationId": "GetUserByUUID",
        "summary": "Get User Quotas by UUID",
        "description": "List quota usage and limits of a user account by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Users.QuotasResponse"
                }
              }
            }
          }
        },
        "tags": [
          "users"
        ]
      }
    },
    "/v1/volumes": {
      "post": {
        "operationId": "CreateVolume",
        "summary": "Create Volume",
        "description": "Create a new volume.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Volumes.CreateVolumeResponse"
                }
              }
            }
          }
        },
        "tags": [
          "volumes"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Volumes.CreateVolumeRequest"
              }
            }
          }
        }
      },
      "get": {
        "operationId": "GetVolumes",
        "summary": "List Volumes",
        "description": "List volumes.",
        "parameters": [
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.uuid"
          },
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.name"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.details"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.count"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.from"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.order"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.sortby"
          },
          {
            "name": "tags",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "explode": false
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Volumes.GetVolumesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "volumes"
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Common.NameOrUUID"
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "UpdateVolumes",
        "summary": "Update Volumes",
        "description": "Update volumes.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Volumes.UpdateVolumesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "volumes"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Volumes.UpdateVolumesRequestItem"
                }
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "DeleteVolumes",
        "summary": "Delete Volumes",
        "description": "Delete volumes by ID(s).",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Volumes.DeleteVolumesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "volumes"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Common.NameOrUUID"
                }
              }
            }
          }
        }
      }
    },
    "/v1/volumes/attach": {
      "put": {
        "operationId": "AttachVolumes",
        "summary": "Attach Volumes",
        "description": "Attach volumes to instances.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Volumes.AttachVolumesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "volumes"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Volumes.AttachVolumesRequestItem"
                }
              }
            }
          }
        }
      }
    },
    "/v1/volumes/clone": {
      "post": {
        "operationId": "CloneVolumes",
        "summary": "Clone Volumes",
        "description": "Clone volumes.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Volumes.CloneVolumesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "volumes"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Volumes.CloneVolumesRequestItem"
                }
              }
            }
          }
        }
      }
    },
    "/v1/volumes/detach": {
      "put": {
        "operationId": "DetachVolumes",
        "summary": "Detach Volumes",
        "description": "Detach volumes from instances.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Volumes.DetachVolumesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "volumes"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Volumes.DetachVolumesRequestItem"
                }
              }
            }
          }
        }
      }
    },
    "/v1/volumes/templates": {
      "post": {
        "operationId": "CreateTemplateVolume",
        "summary": "Create Template Volume",
        "description": "Create a template volume.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Volumes.CreateTemplateVolumesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "volumes"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Common.NameOrUUID"
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "GetTemplateVolumes",
        "summary": "List Template Volumes",
        "description": "List template volumes.",
        "parameters": [
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.uuid"
          },
          {
            "$ref": "#/components/parameters/Common.NameOrUUIDQueryParams.name"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.details"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.count"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.from"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.order"
          },
          {
            "$ref": "#/components/parameters/Common.ListQueryParams.sortby"
          },
          {
            "name": "tags",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "explode": false
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Volumes.GetTemplateVolumesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "volumes"
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Common.NameOrUUID"
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "UpdateTemplateVolumes",
        "summary": "Update Template Volumes",
        "description": "Update template volumes.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Volumes.UpdateTemplateVolumesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "volumes"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Volumes.UpdateTemplateVolumesRequestItem"
                }
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "DeleteTemplateVolumes",
        "summary": "Delete Template Volumes",
        "description": "Delete template volumes by ID(s).",
        "parameters": [],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Volumes.DeleteTemplateVolumesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "volumes"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Common.NameOrUUID"
                }
              }
            }
          }
        }
      }
    },
    "/v1/volumes/templates/{uuid}": {
      "get": {
        "operationId": "GetTemplateVolumeByUUID",
        "summary": "Get Template Volume by UUID",
        "description": "Get a template volume by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "details",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "explode": false
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Volumes.GetTemplateVolumesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "volumes"
        ]
      },
      "patch": {
        "operationId": "UpdateTemplateVolumeByUUID",
        "summary": "Update Template Volume by UUID",
        "description": "Update a template volume by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Volumes.UpdateTemplateVolumesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "volumes"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Volumes.UpdateTemplateVolumeByUUIDRequestBody"
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "DeleteTemplateVolumeByUUID",
        "summary": "Delete Template Volume by UUID",
        "description": "Delete a template volume by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Volumes.DeleteTemplateVolumesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "volumes"
        ]
      }
    },
    "/v1/volumes/{uuid}": {
      "get": {
        "operationId": "GetVolumeByUUID",
        "summary": "Get Volume by UUID",
        "description": "Get a volume by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "details",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "explode": false
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Volumes.GetVolumesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "volumes"
        ]
      },
      "patch": {
        "operationId": "UpdateVolumeByUUID",
        "summary": "Update Volume by UUID",
        "description": "Update a volume by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Volumes.UpdateVolumesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "volumes"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Volumes.UpdateVolumeByUUIDRequestBody"
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "DeleteVolumeByUUID",
        "summary": "Delete Volume by UUID",
        "description": "Delete a volume by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Volumes.DeleteVolumesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "volumes"
        ]
      }
    },
    "/v1/volumes/{uuid}/attach": {
      "put": {
        "operationId": "AttachVolumeByUUID",
        "summary": "Attach Volume by UUID",
        "description": "Attach a volume by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Volumes.AttachVolumesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "volumes"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Volumes.AttachVolumeByUUIDRequestBody"
              }
            }
          }
        }
      }
    },
    "/v1/volumes/{uuid}/clone": {
      "post": {
        "operationId": "CloneVolumeByUUID",
        "summary": "Clone Volume by UUID",
        "description": "Clone a volume by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Volumes.CloneVolumesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "volumes"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Volumes.CloneVolumeByUUIDRequestBody"
              }
            }
          }
        }
      }
    },
    "/v1/volumes/{uuid}/detach": {
      "put": {
        "operationId": "DetachVolumeByUUID",
        "summary": "Detach Volume by UUID",
        "description": "Detach a volume by UUID.",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Volumes.DetachVolumesResponse"
                }
              }
            }
          }
        },
        "tags": [
          "volumes"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Volumes.DetachVolumeByUUIDRequestBody"
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "bearerToken": []
    }
  ],
  "components": {
    "parameters": {
      "Common.ListQueryParams.count": {
        "name": "count",
        "in": "query",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "uint32"
        },
        "explode": false
      },
      "Common.ListQueryParams.details": {
        "name": "details",
        "in": "query",
        "required": false,
        "schema": {
          "type": "boolean"
        },
        "explode": false
      },
      "Common.ListQueryParams.from": {
        "name": "from",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        },
        "explode": false
      },
      "Common.ListQueryParams.order": {
        "name": "order",
        "in": "query",
        "required": false,
        "schema": {
          "$ref": "#/components/schemas/Common.PaginationOrder"
        },
        "explode": false
      },
      "Common.ListQueryParams.sortby": {
        "name": "sortby",
        "in": "query",
        "required": false,
        "schema": {
          "$ref": "#/components/schemas/Common.PaginationSortBy"
        },
        "explode": false
      },
      "Common.NameOrUUIDQueryParams.name": {
        "name": "name",
        "in": "query",
        "required": false,
        "description": "The name of the resource.",
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "Common.NameOrUUIDQueryParams.uuid": {
        "name": "uuid",
        "in": "query",
        "required": false,
        "description": "The UUID of the resource.",
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "schemas": {
      "Audit.AuditAttribution": {
        "type": "object",
        "required": [
          "operation",
          "kind",
          "trigger",
          "origin"
        ],
        "properties": {
          "operation": {
            "type": "string",
            "format": "uuid",
            "description": "UUID shared by every event belonging to the same operation."
          },
          "kind": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Audit.AuditOperationKind"
              }
            ],
            "description": "What was performed on the object."
          },
          "trigger": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Audit.AuditTrigger"
              }
            ],
            "description": "Whether this event was raised by the operation or observed after it."
          },
          "origin": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Audit.AuditOrigin"
              }
            ],
            "description": "What caused the operation."
          },
          "user": {
            "type": "string",
            "format": "uuid",
            "description": "The user that caused the operation, when one did."
          }
        },
        "description": "The operation an event belongs to.\n\nEvents sharing an `operation` describe one overarching action, which is what\nmakes a state transition attributable to the thing that caused it rather than\nonly observable after the fact."
      },
      "Audit.AuditEvent": {
        "type": "object",
        "required": [
          "type",
          "timestamp",
          "object"
        ],
        "properties": {
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Audit.AuditEventType"
              }
            ],
            "description": "The type of event."
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "description": "When the event was raised."
          },
          "object": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Audit.AuditObject"
              }
            ],
            "description": "The object the event is about."
          },
          "attribution": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Audit.AuditAttribution"
              }
            ],
            "description": "The operation the event belongs to."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Audit.AuditEventData"
              }
            ],
            "description": "The event payload. Its fields depend on `type`."
          }
        },
        "description": "One audit event."
      },
      "Audit.AuditEventData": {
        "type": "object",
        "properties": {
          "prev": {
            "type": "string",
            "description": "The state before the transition."
          },
          "new": {
            "type": "string",
            "description": "The state after the transition."
          },
          "state": {
            "type": "string",
            "description": "The state the instance was left in after a failed start."
          },
          "error": {
            "type": "string",
            "description": "The error that failed the start, as an errno name such as `EDQUOT`."
          },
          "stop": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Audit.AuditStop"
              }
            ],
            "description": "Why the instance stopped."
          }
        },
        "description": "The payload of an audit event.\n\nWhich fields are present depends on the event type:\n\n- `vm.state_change`\n- `vm.start_failed`"
      },
      "Audit.AuditEventType": {
        "type": "string",
        "enum": [
          "vm.state_change",
          "vm.start_failed"
        ],
        "description": "The type of an audit event.\n\nAn enum rather than an open union because this is also a query parameter, and\nan open union generates as an interface that a client cannot serialise into a\nfilter. Further event types are added here; a Go client decodes one it does\nnot know as its plain string value rather than failing."
      },
      "Audit.AuditObject": {
        "type": "object",
        "required": [
          "type",
          "uuid"
        ],
        "properties": {
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Audit.AuditObjectType"
              }
            ],
            "description": "The kind of object."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The object's UUID."
          },
          "owner": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the user the object belongs to."
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The tags set on the object."
          }
        },
        "description": "The object an audit event is about."
      },
      "Audit.AuditObjectType": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "i",
              "v"
            ]
          },
          {
            "type": "string"
          }
        ],
        "description": "The kind of object an audit event is about.\n\nOpen: the controller emits the ukpd object prefixes, and events for further\nobject kinds are added without a breaking change."
      },
      "Audit.AuditOperationKind": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "start",
              "stop",
              "drain",
              "suspend",
              "restart"
            ]
          },
          {
            "type": "string"
          }
        ],
        "description": "What an operation was performed on the object.\n\nOpen: the set depends on the object type, and instances carry\n`start`, `stop`, `drain`, `suspend` and `restart`."
      },
      "Audit.AuditOrigin": {
        "type": "string",
        "enum": [
          "unknown",
          "api",
          "guest",
          "proxy",
          "autoscale",
          "scale-to-zero",
          "scheduled-op",
          "restart",
          "update",
          "system",
          "network",
          "autokill",
          "mtss"
        ],
        "description": "What caused the operation."
      },
      "Audit.AuditStop": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The origins that contributed to the stop."
          },
          "code": {
            "type": "integer",
            "format": "uint32",
            "description": "The kernel stop code."
          },
          "cause": {
            "type": "string",
            "description": "The stop cause."
          }
        },
        "description": "Why an instance stopped."
      },
      "Audit.AuditTrigger": {
        "type": "string",
        "enum": [
          "requested",
          "observed"
        ],
        "description": "Whether the event was raised by the operation or observed as a result of it."
      },
      "Autoscale.AdjustmentType": {
        "type": "string",
        "enum": [
          "change",
          "exact",
          "percentage"
        ],
        "description": "AdjustmentType defines the type of adjustment to be made in an autoscaling\nstep policy."
      },
      "Autoscale.AutoscalePolicy": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the policy."
          },
          "enabled": {
            "type": "boolean",
            "description": "Whether the policy is enabled."
          },
          "metric": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Autoscale.StepPolicyMetric"
              }
            ],
            "description": "Metric to use for the step policy (only for step policies)."
          },
          "adjustment_type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Autoscale.AdjustmentType"
              }
            ],
            "description": "The type of adjustment to be made in the step policy (only for step policies)."
          },
          "steps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Autoscale.AutoscalePolicyStep"
            },
            "description": "The steps for the step policy. Each step defines an adjustment value and\noptional bounds."
          }
        },
        "description": "AutoscalePolicy defines the autoscale policy for a service. Right now it\ncontains fields from both the `ondemand` and `step` policies. They are\nmarked both as optional, so only one of them should be set at a time. This\nis a current limitation of the API design."
      },
      "Autoscale.AutoscalePolicyStep": {
        "type": "object",
        "required": [
          "adjustment"
        ],
        "properties": {
          "adjustment": {
            "type": "integer",
            "format": "int64",
            "description": "The adjustment value for the step."
          },
          "lower_bound": {
            "type": "integer",
            "format": "int64",
            "description": "Lower bound for the step."
          },
          "upper_bound": {
            "type": "integer",
            "format": "int64",
            "description": "Upper bound for the step."
          }
        },
        "description": "A single step in a step autoscaling policy."
      },
      "Autoscale.ConfigurationInstanceCreateArgs": {
        "type": "object",
        "properties": {
          "roms": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Autoscale.InstanceCreateArgsInstanceCreateRequestRoms"
              }
            ],
            "description": "The ROM to use for the autoscale configuration."
          },
          "template": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.NameOrUUID"
              }
            ],
            "description": "The template to use for the autoscale configuration."
          }
        },
        "oneOf": [
          {
            "required": [
              "roms"
            ]
          },
          {
            "required": [
              "template"
            ]
          }
        ]
      },
      "Autoscale.CreateAutoscaleConfigurationByServiceGroupUUIDRequest": {
        "type": "object",
        "required": [
          "uuid",
          "create_args"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the service to create a configuration for."
          },
          "min_size": {
            "type": "integer",
            "format": "int64",
            "description": "The minimum number of instances to keep running."
          },
          "max_size": {
            "type": "integer",
            "format": "int64",
            "description": "The maximum number of instances to keep running."
          },
          "warmup_time_ms": {
            "type": "integer",
            "format": "int64",
            "description": "The warmup time in milliseconds for new instances."
          },
          "cooldown_time_ms": {
            "type": "integer",
            "format": "int64",
            "description": "The cooldown time in milliseconds for the autoscale configuration."
          },
          "create_args": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Autoscale.CreateAutoscaleConfigurationByServiceGroupUUIDRequestInstanceCreateArgs"
              }
            ],
            "description": "The arguments to use when creating instances."
          },
          "policies": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Autoscale.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."
      },
      "Autoscale.CreateAutoscaleConfigurationByServiceGroupUUIDRequestInstanceCreateArgs": {
        "type": "object",
        "properties": {
          "roms": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Autoscale.InstanceCreateArgsInstanceCreateRequestRoms"
              }
            ],
            "description": "The ROM to use for the autoscale configuration."
          },
          "template": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.NameOrUUID"
              }
            ],
            "description": "The template to use for the autoscale configuration."
          }
        },
        "oneOf": [
          {
            "required": [
              "roms"
            ]
          },
          {
            "required": [
              "template"
            ]
          }
        ]
      },
      "Autoscale.CreateAutoscaleConfigurationPolicyRequest": {
        "type": "object",
        "required": [
          "name",
          "type"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the policy."
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Autoscale.AutoscalePolicy"
              }
            ],
            "description": "The policy type to add to the autoscale configuration."
          }
        },
        "description": "The request message to create an autoscale configuration policy for a\nservice."
      },
      "Autoscale.CreateAutoscaleConfigurationPolicyResponse": {
        "type": "object",
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "policies": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Autoscale.CreateAutoscaleConfigurationPolicyResponsePolicy"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        }
      },
      "Autoscale.CreateAutoscaleConfigurationPolicyResponsePolicy": {
        "type": "object",
        "required": [
          "uuid",
          "name",
          "status"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code providing additional information about the status."
          }
        },
        "description": "Per-item result for a create autoscale configuration policy operation."
      },
      "Autoscale.CreateAutoscaleConfigurationsRequestConfiguration": {
        "type": "object",
        "required": [
          "create_args"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          },
          "min_size": {
            "type": "integer",
            "format": "int64",
            "description": "The minimum number of instances to keep running."
          },
          "max_size": {
            "type": "integer",
            "format": "int64",
            "description": "The maximum number of instances to keep running."
          },
          "warmup_time_ms": {
            "type": "integer",
            "format": "int64",
            "description": "The warmup time in milliseconds for new instances."
          },
          "cooldown_time_ms": {
            "type": "integer",
            "format": "int64",
            "description": "The cooldown time in milliseconds for the autoscale configuration."
          },
          "create_args": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Autoscale.ConfigurationInstanceCreateArgs"
              }
            ],
            "description": "The arguments to use when creating instances."
          },
          "policies": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Autoscale.AutoscalePolicy"
            },
            "description": "The policies to apply to the autoscale configuration."
          }
        },
        "oneOf": [
          {
            "required": [
              "uuid"
            ]
          },
          {
            "required": [
              "name"
            ]
          }
        ]
      },
      "Autoscale.CreateAutoscaleConfigurationsResponse": {
        "type": "object",
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "service_groups": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Autoscale.CreateAutoscaleConfigurationsResponseConfigurationsResponse"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response to a CreateAutoscaleConfigurationRequest."
      },
      "Autoscale.CreateAutoscaleConfigurationsResponseConfigurationsResponse": {
        "type": "object",
        "required": [
          "uuid",
          "name",
          "status"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code providing additional information about the status."
          }
        },
        "description": "Per-item result for a create autoscale configurations operation."
      },
      "Autoscale.DeleteAutoscaleConfigurationPolicyResponse": {
        "type": "object",
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "policies": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Autoscale.DeleteAutoscaleConfigurationPolicyResponsePoliciesResponse"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        }
      },
      "Autoscale.DeleteAutoscaleConfigurationPolicyResponsePoliciesResponse": {
        "type": "object",
        "required": [
          "name",
          "status"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the deleted policy."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code providing additional information about the status."
          }
        },
        "description": "Per-item result for a delete autoscale configuration policy operation."
      },
      "Autoscale.DeleteAutoscaleConfigurationsResponse": {
        "type": "object",
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "service_groups": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Autoscale.DeleteAutoscaleConfigurationsResponseServiceGroup"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        }
      },
      "Autoscale.DeleteAutoscaleConfigurationsResponseServiceGroup": {
        "type": "object",
        "required": [
          "uuid",
          "name",
          "status"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code providing additional information about the status."
          }
        },
        "description": "Per-item result for a delete autoscale configurations operation."
      },
      "Autoscale.DeletePolicyRequest": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the policy to delete."
          }
        },
        "description": "The request message to delete an autoscale configuration policy by name."
      },
      "Autoscale.GetAutoscaleConfigurationPolicyRequest": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The Name of the policy to get.",
            "example": "funky-policy"
          }
        },
        "description": "The request message to get an autoscale configuration policy by name."
      },
      "Autoscale.GetAutoscaleConfigurationPolicyResponse": {
        "type": "object",
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "policies": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Autoscale.GetAutoscaleConfigurationPolicyResponsePolicyResponse"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        }
      },
      "Autoscale.GetAutoscaleConfigurationPolicyResponsePolicyResponse": {
        "type": "object",
        "required": [
          "policy",
          "status"
        ],
        "properties": {
          "policy": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Autoscale.AutoscalePolicy"
              }
            ],
            "description": "The policy which was retrieved by the request."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code providing additional information about the status."
          }
        },
        "description": "Per-item result for a get autoscale configuration policy operation."
      },
      "Autoscale.GetAutoscaleConfigurationsResponse": {
        "type": "object",
        "required": [
          "status",
          "data",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "success",
              "error",
              "unconfigured"
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "service_groups": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Autoscale.GetAutoscaleConfigurationsResponseServiceGroup"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for a GetAutoscaleConfigurationsRequest."
      },
      "Autoscale.GetAutoscaleConfigurationsResponseServiceGroup": {
        "type": "object",
        "required": [
          "uuid",
          "name",
          "enabled",
          "status"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "enabled": {
            "type": "boolean",
            "description": "If the autoscale configuration is enabled."
          },
          "min_size": {
            "type": "integer",
            "format": "int64",
            "description": "The minimum number of instances to keep running. Only if enabled is true."
          },
          "max_size": {
            "type": "integer",
            "format": "int64",
            "description": "The maximum number of instances to keep running. Only if enabled is true."
          },
          "warmup_time_ms": {
            "type": "integer",
            "format": "int64",
            "description": "The warmup time in seconds for new instances. Only if enabled is true."
          },
          "cooldown_time_ms": {
            "type": "integer",
            "format": "int64",
            "description": "The cooldown time in seconds for the autoscale configuration. Only if\nenabled is true."
          },
          "template": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Autoscale.ServiceGroupTemplate"
              }
            ],
            "description": "The instance template used for the autoscale configuration. Only if\nenabled is true."
          },
          "policies": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Autoscale.AutoscalePolicy"
            },
            "description": "The policies applied to the autoscale configuration."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code providing additional information about the status."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          }
        },
        "description": "Per-item result for a get autoscale configurations operation."
      },
      "Autoscale.InstanceCreateArgsInstanceCreateRequestRoms": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the ROM."
          },
          "image": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/Instances.ImageSpec"
              }
            ],
            "description": "The image of the ROM to use for the autoscale configuration. Mutually\nexclusive with `files`. Accepts either a plain image reference string\n(`\"nginx:latest\"`) or an object carrying additional pull configuration\n(`{\"url\": \"nginx:latest\", \"pull_policy\": \"always\"}`).",
            "example": "nginx:latest"
          },
          "files": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.InlineFile"
            },
            "description": "Inline files to use as the ROM content. When specified, the platform\ncreates an EROFS image from the provided files. Mutually exclusive with\n`image`."
          }
        },
        "description": "A ROM to use for an autoscale instance create configuration."
      },
      "Autoscale.ServiceGroupTemplate": {
        "type": "object",
        "required": [
          "uuid",
          "name"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the template used for the autoscale configuration."
          },
          "name": {
            "type": "string",
            "description": "The name of the template used for the autoscale configuration."
          }
        },
        "description": "The instance template used for an autoscale configuration."
      },
      "Autoscale.StepPolicyMetric": {
        "type": "string",
        "enum": [
          "cpu"
        ],
        "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. It uses\na metric to determine when to scale up or down."
      },
      "Certificates.Certificate": {
        "type": "object",
        "required": [
          "uuid",
          "name",
          "created_at",
          "common_name",
          "state"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "The time the certificate was created."
          },
          "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.",
            "example": "my-common-name"
          },
          "subject": {
            "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.",
            "example": "example.com"
          },
          "issuer": {
            "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.",
            "example": "CN=R10,O=Let's Encrypt,C=US"
          },
          "serial_number": {
            "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.",
            "example": "123456789ABCDEF123456789ABCDEF123456"
          },
          "not_before": {
            "type": "string",
            "format": "date-time",
            "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."
          },
          "not_after": {
            "type": "string",
            "format": "date-time",
            "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."
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Certificates.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."
          },
          "validation": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Certificates.CertificateValidation"
              }
            ],
            "description": "Validation status when state is pending."
          },
          "service_groups": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ID"
            },
            "description": "Service groups using this certificate."
          }
        },
        "description": "Certificate with per-item response envelope fields merged in."
      },
      "Certificates.CertificateState": {
        "type": "string",
        "enum": [
          "pending",
          "valid",
          "error"
        ],
        "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. |"
      },
      "Certificates.CertificateValidation": {
        "type": "object",
        "required": [
          "attempt",
          "next"
        ],
        "properties": {
          "attempt": {
            "type": "integer",
            "format": "int32",
            "description": "The current validation attempt number."
          },
          "next": {
            "type": "string",
            "format": "date-time",
            "description": "The next validation attempt time."
          }
        },
        "description": "Validation status for a pending certificate."
      },
      "Certificates.CreateCertificateRequest": {
        "type": "object",
        "required": [
          "chain",
          "pkey"
        ],
        "properties": {
          "name": {
            "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.",
            "example": "funky-certificate"
          },
          "cn": {
            "type": "string",
            "description": "The common name (CN) of the certificate.\n\nDeprecated: Use `common_name` instead.",
            "deprecated": true,
            "example": "funky-town.com"
          },
          "common_name": {
            "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.",
            "example": "funky-town.com"
          },
          "chain": {
            "type": "string",
            "description": "The certificate chain in PEM format. Required for user-uploaded certificates."
          },
          "pkey": {
            "type": "string",
            "description": "The private key in PEM format. Required for user-uploaded certificates."
          }
        },
        "description": "The request message for creating/uploading a new certificate."
      },
      "Certificates.CreateCertificateResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "certificates": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Certificates.Certificate"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for creating a new certificate."
      },
      "Certificates.DeleteCertificatesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "certificates": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Certificates.DeleteCertificatesResponseDeletedCertificate"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for deleting of one or more certificate(s) given their\nUUID(s) or name(s)."
      },
      "Certificates.DeleteCertificatesResponseDeletedCertificate": {
        "type": "object",
        "required": [
          "status",
          "uuid",
          "name"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          }
        },
        "description": "Per-item result for a delete certificates operation."
      },
      "Certificates.GetCertificatesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "certificates": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Certificates.Certificate"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for getting one or more certificate(s) given their\nUUID(s) or name(s)."
      },
      "Certificates.UpdateCertificateByUUIDRequestBody": {
        "type": "object",
        "required": [
          "chain",
          "pkey"
        ],
        "properties": {
          "chain": {
            "type": "string",
            "description": "The new certificate chain. This is the public chain of the certificate in\nPEM format. The chain should include the certificate and any intermediate\ncertificates."
          },
          "pkey": {
            "type": "string",
            "description": "The new private key. This is the private key of the certificate in PEM\nformat. The private key must match the public key in the certificate\nchain."
          }
        },
        "description": "The request body for updating a certificate by its UUID or name."
      },
      "Certificates.UpdateCertificatesRequestItem": {
        "type": "object",
        "required": [
          "chain",
          "pkey"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          },
          "chain": {
            "type": "string",
            "description": "The new certificate chain. This is the public chain of the certificate in\nPEM format. The chain should include the certificate and any intermediate\ncertificates."
          },
          "pkey": {
            "type": "string",
            "description": "The new private key. This is the private key of the certificate in PEM\nformat. The private key must match the public key in the certificate\nchain."
          }
        },
        "description": "A single update operation to be applied to a certificate."
      },
      "Certificates.UpdateCertificatesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "certificates": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Certificates.Certificate"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for updating one or more certificate(s) given their\nUUID(s) or name(s)."
      },
      "Common.ID": {
        "type": "object",
        "required": [
          "uuid",
          "name"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          }
        },
        "description": "Common identity fields for a resource."
      },
      "Common.InlineDataEncoding": {
        "type": "string",
        "enum": [
          "text",
          "base64"
        ],
        "description": "Encoding type for inline file data."
      },
      "Common.InlineFile": {
        "type": "object",
        "required": [
          "path",
          "data"
        ],
        "properties": {
          "path": {
            "type": "string",
            "description": "The file path within the image."
          },
          "encoding": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.InlineDataEncoding"
              }
            ],
            "description": "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."
      },
      "Common.NameOrUUID": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          }
        },
        "description": "An identifier for a resource — either a name or a UUID, but not both.",
        "oneOf": [
          {
            "required": [
              "uuid"
            ],
            "not": {
              "required": [
                "name"
              ]
            }
          },
          {
            "required": [
              "name"
            ],
            "not": {
              "required": [
                "uuid"
              ]
            }
          }
        ]
      },
      "Common.PaginationOrder": {
        "type": "string",
        "enum": [
          "asc",
          "desc"
        ],
        "description": "The sort order used by list endpoints."
      },
      "Common.PaginationSortBy": {
        "type": "string",
        "enum": [
          "create_time"
        ],
        "description": "The sort field used by list endpoints."
      },
      "Common.ResponseError": {
        "type": "object",
        "required": [
          "status"
        ],
        "properties": {
          "status": {
            "type": "integer",
            "format": "uint64",
            "description": "The HTTP status code of the error."
          }
        },
        "description": "The error response message for an API request."
      },
      "Common.ResponseStatus": {
        "type": "string",
        "enum": [
          "success",
          "error",
          "partial_success"
        ],
        "description": "The response status of an API request."
      },
      "Common.SchedPriority": {
        "type": "string",
        "enum": [
          "normal",
          "medium",
          "high",
          "admin"
        ],
        "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. |"
      },
      "Images.GetImagesRequestTagOrDigest": {
        "type": "object",
        "properties": {
          "digest": {
            "type": "string"
          },
          "tag": {
            "type": "string"
          }
        },
        "oneOf": [
          {
            "required": [
              "digest"
            ]
          },
          {
            "required": [
              "tag"
            ]
          }
        ]
      },
      "Images.GetImagesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "images": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Images.Image"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for getting one or more image(s)."
      },
      "Images.Image": {
        "type": "object",
        "required": [
          "url",
          "created_at",
          "initrd_or_rom",
          "size_in_bytes"
        ],
        "properties": {
          "url": {
            "type": "string",
            "description": "The image URL."
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "The time the image was created."
          },
          "initrd_or_rom": {
            "type": "boolean",
            "description": "Whether the image is an initrd or ROM."
          },
          "size_in_bytes": {
            "type": "integer",
            "format": "int64",
            "description": "The size of the image in bytes."
          },
          "args": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Command-line arguments for the image."
          },
          "env": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Environment variables for the image."
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Tags associated with the image."
          },
          "users": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Users associated with the image."
          },
          "persistent": {
            "type": "boolean",
            "description": "Whether the image is pinned and exempt from cache eviction. Only\npopulated (and only ever `true`) for callers with image manager\npermissions; omitted otherwise, including when the image is not pinned.",
            "example": true
          }
        },
        "description": "An image representing a VM which can be deployed on Unikraft Cloud."
      },
      "Images.PinImageRequestItem": {
        "type": "object",
        "required": [
          "url",
          "timeout_s"
        ],
        "properties": {
          "url": {
            "type": "string",
            "description": "The image URL to pull and pin.",
            "example": "user/image:latest"
          },
          "credentials": {
            "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.",
            "example": "dXNlcjpwYXNzd29yZA=="
          },
          "headers": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Optional HTTP headers to send when fetching the image.",
            "example": {
              "Authorization": "Bearer token123"
            }
          },
          "pull_policy": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.PullPolicy"
              }
            ],
            "description": "Controls when the image is pulled relative to what is already cached on\nthe node. If unset, this is inferred from the URL."
          },
          "timeout_s": {
            "type": "integer",
            "format": "int64",
            "description": "Number of seconds to wait for the pull to complete. Required and must\nbe non-zero; `-1` waits up to the platform's maximum timeout.",
            "example": 30
          },
          "merge_requests": {
            "type": "boolean",
            "description": "Avoid duplicate pulls by merging with any in-flight request for the\nsame image. Defaults to `true`.",
            "example": true
          },
          "autokill": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Images.PinImageRequestItemAutokill"
              }
            ],
            "description": "Automatically unpin the image after a period of inactivity."
          }
        },
        "description": "The request item for pinning a single image."
      },
      "Images.PinImageRequestItemAutokill": {
        "type": "object",
        "required": [
          "time_ms"
        ],
        "properties": {
          "time_ms": {
            "type": "integer",
            "format": "uint64",
            "description": "Automatically unpin the image after this many milliseconds of\ninactivity. `0` (the default) disables this.",
            "example": 60000
          }
        },
        "description": "Automatically unpin the image after a period of inactivity."
      },
      "Images.PinImagesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "images": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Images.PinImagesResponseImage"
                },
                "description": "The result of pinning each requested image."
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for pinning one or more images."
      },
      "Images.PinImagesResponseImage": {
        "type": "object",
        "required": [
          "status"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the image. Only set on success."
          },
          "name": {
            "type": "string",
            "description": "The name of the image. Only set on success."
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "The time the image was created. Only set on success.",
            "example": "2021-01-01T00:00:00Z"
          },
          "state": {
            "type": "string",
            "description": "The current state of the image (e.g. `ready`). Only set on success.",
            "example": "ready"
          },
          "url": {
            "type": "string",
            "description": "The image URL. Only set on success.",
            "example": "user/image:latest"
          },
          "persistent": {
            "type": "boolean",
            "description": "Whether the image is pinned and exempt from cache eviction. Only set\non success, where it is always `true`.",
            "example": true
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The tags associated with the image. Only set on success."
          }
        },
        "description": "The result of pinning a single image. On success, `uuid` through `tags`\nare set; on failure, only `message` and `error` are set (the image\nbeing pulled is not otherwise identified in the response)."
      },
      "Images.UnpinImageRequestItem": {
        "type": "object",
        "required": [
          "uuid"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the image to unpin. Only UUID is supported; name, URL,\ntag, and digest are not."
          }
        },
        "description": "The request item for unpinning a single image."
      },
      "Images.UnpinImagesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "images": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Images.UnpinImagesResponseImage"
                },
                "description": "The result of unpinning each requested image."
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for unpinning one or more images."
      },
      "Images.UnpinImagesResponseImage": {
        "type": "object",
        "required": [
          "status",
          "uuid"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the image."
          },
          "name": {
            "type": "string",
            "description": "The name of the image. Only set on success, and only if the image\nhas a name."
          }
        },
        "description": "The result of unpinning a single image."
      },
      "Instances.CheckpointAutokill": {
        "type": "object",
        "properties": {
          "time_ms": {
            "type": "integer",
            "format": "uint64",
            "description": "Time in milliseconds after the checkpoint was last used for restoring\nbefore it is deleted. A value of 0 disables checkpoint autokill.",
            "example": 60000
          }
        },
        "description": "Automatic delete-on-idle configuration for the checkpoint instance."
      },
      "Instances.CheckpointHistoryEntry": {
        "type": "object",
        "required": [
          "uuid",
          "name",
          "created_at"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the checkpoint."
          },
          "name": {
            "type": "string",
            "description": "The name of the checkpoint.",
            "example": "my-checkpoint"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "The time the checkpoint was created."
          }
        },
        "description": "A checkpoint history entry, representing a single checkpoint in the history of an instance."
      },
      "Instances.CreateCheckpointInstancesRequestItem": {
        "type": "object",
        "required": [
          "from"
        ],
        "properties": {
          "from": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.NameOrUUID"
              }
            ],
            "description": "The source instance to create a checkpoint from (by name or UUID)."
          },
          "name": {
            "type": "string",
            "description": "The name of the checkpoint. If not provided, a name will be generated.",
            "example": "my-checkpoint"
          },
          "timeout_s": {
            "type": "integer",
            "format": "int64",
            "description": "Timeout in seconds to wait for the checkpoint to be created.\nNo wait performed for a value of 0.",
            "example": 10
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Tags to associate with the checkpoint."
          },
          "autokill": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.CheckpointAutokill"
              }
            ],
            "description": "Automatic delete-on-idle configuration for the new checkpoint."
          }
        },
        "description": "A single checkpoint creation request."
      },
      "Instances.CreateCheckpointInstancesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "instances": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.CreateCheckpointInstancesResponseCheckpointInstance"
                },
                "description": "List of checkpoint instances that were created during the operation."
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for creating one or more checkpoint(s) from existing\ninstance(s)."
      },
      "Instances.CreateCheckpointInstancesResponseCheckpointInstance": {
        "type": "object",
        "required": [
          "status",
          "uuid",
          "name",
          "state"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.InstanceState"
              }
            ],
            "description": "The current state of the checkpoint."
          }
        },
        "description": "Per-item result for a create checkpoint instances operation."
      },
      "Instances.CreateInstanceRequest": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the instance.\n\nIf not provided, a random name will be generated. The name must be\nunique.",
            "example": "funky-town-g756b5d"
          },
          "image": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/Instances.ImageSpec"
              }
            ],
            "description": "The image to use for the instance.\n\nEither an image or a template must be specified. Accepts either a plain\nimage reference string (`\"nginx:latest\"`) or an object carrying additional\npull configuration (`{\"url\": \"nginx:latest\", \"pull_policy\": \"always\"}`)."
          },
          "args": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The arguments to pass to the instance when it starts."
          },
          "env": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Environment variables to set for the instance.",
            "example": {
              "ENV_VAR1": "value1",
              "ENV_VAR2": "value2"
            }
          },
          "memory_mb": {
            "type": "integer",
            "format": "int64",
            "description": "Memory in MB to allocate for the instance. Default is 128.",
            "example": 256
          },
          "service_group": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.CreateInstanceRequestServiceGroup"
              }
            ],
            "description": "The service group configuration when creating an instance.\n\nWhen creating an instance, either a previously created (persistent)\nservice group can be referenced (either through its name or UUID), or a\nnew (ephemeral) service group can be created for the instance by\nspecifying the list of services it should expose and optionally the\ndomains it should use. Not used by template instances."
          },
          "volumes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Instances.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": {
            "type": "boolean",
            "description": "Whether the instance should start automatically on creation.\nMust be set to true when `timeout_s` is specified.",
            "example": true
          },
          "replicas": {
            "type": "integer",
            "format": "int64",
            "description": "Number of additional replicas to create. The total number of instances\ncreated is `replicas + 1`. Defaults to 0.",
            "example": 5
          },
          "restart_policy": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.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/Instances.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": {
            "type": "integer",
            "format": "int32",
            "description": "Number of vCPUs to allocate for the instance. Defaults to 1.",
            "example": 1
          },
          "wait_timeout_ms": {
            "type": "integer",
            "format": "int64",
            "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.",
            "deprecated": true,
            "example": 2000
          },
          "features": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Instances.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": {
            "type": "integer",
            "format": "int64",
            "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.",
            "example": 2
          },
          "roms": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Instances.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."
          },
          "plugins": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Instances.CreateInstanceRequestPlugin"
            },
            "description": "Plugins to attach to the instance. Plugins let you attach small helper\nprograms to an instance and reach each one over a direct, authenticated\nHTTP endpoint. Each plugin loads from its own ROM image, mounts at\n`/uk/plugins/<plugin_name>`, and is reachable at\n`.../v1/instances/<uuid>/plugins/<plugin_name>/<path>`. At most 8 plugins\nmay be attached to an instance."
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Tags to associate with the instance."
          },
          "annotations": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Annotations to associate with the instance.\n\nUnlike tags, annotations also reach the guest: they are included in the\ninstance's startdata, and selected keys can be injected into the console\nlog output.\n\nKeys follow the Kubernetes annotation key syntax, `[<prefix>/]<name>`:\nthe optional prefix is a non-wildcard DNS subdomain of at most 253\ncharacters, and the name is at most 63 characters of `[-_.a-zA-Z0-9]`\nstarting and ending with an alphanumeric. Values are unconstrained apart\nfrom ASCII control characters. An instance holds at most 256 annotations.\n\nWhen the instance inherits annotations from a template, branch, or\ncheckpoint, the given annotations are merged into them rather than\nreplacing them. On a key clash the value given here wins.",
            "example": {
              "my-key": "value1",
              "example.com/annotation2": "value2"
            }
          },
          "template": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.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": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.SchedPriority"
              }
            ],
            "description": "The scheduling priority for the instance. Only settable by\nusers with scheduling priority override permissions.",
            "example": "high"
          },
          "schedules": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Instances.Schedule"
            },
            "description": "Schedules for the instance. Scheduled operations let you automatically\nstart, stop, delete, or exec a command in the instance on a calendar-\nbased schedule. For `exec` schedules, set the `args` field to the command\nand its arguments. Each instance stores its own schedules, and cloning\npreserves them."
          },
          "autokill": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.CreateInstanceRequestAutokill"
              }
            ],
            "description": "Automatic delete-on-idle/request-limit configuration. Not used for\ntemplate instances."
          },
          "hostname": {
            "type": "string",
            "description": "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.",
            "example": "my-instance"
          },
          "dependencies": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.NameOrUUID"
            },
            "description": "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."
          },
          "branch_from": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.NameOrUUID"
              }
            ],
            "description": "Reference to an existing instance to branch from. The instance can be\nrunning or stopped. If the source instance is running, a snapshot will be\ntaken asynchronously and the new instance will wait for it to complete\nbefore starting. Mutually exclusive with `image` and `template`."
          },
          "checkpoint": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.NameOrUUID"
              }
            ],
            "description": "Reference to an existing checkpoint to create the instance from. The\ncheckpoint must be in the `checkpoint` state. The new instance will be\ncreated with the same configuration and state as the checkpoint. Mutually\nexclusive with `image`, `template`, and `branch_from`."
          },
          "gateway": {
            "type": "string",
            "description": "The default gateway to configure inside the guest.",
            "example": "10.0.0.1"
          },
          "nameserver": {
            "type": "string",
            "description": "The DNS resolver to configure inside the guest.",
            "example": "8.8.8.8"
          },
          "network_interfaces": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Instances.CreateInstanceRequestNetworkInterface"
            },
            "description": "Network interfaces to attach to the instance."
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.InstanceType"
              }
            ],
            "description": "The type of virtual machine to use for the instance. Defaults to `micro`,\nwhich runs on Firecracker. `full` runs on QEMU instead and is required\nfor GPU passthrough (see `gpus`) and, in the future, Windows VMs. QEMU-\nbacked instances currently do not support scale-to-zero, templates,\nbranching, or checkpointing, and only support block-based volumes (no\nvirtiofs). Requires a plan with full VM support and cannot be combined\nwith `template`, `branch_from`, or `checkpoint`.",
            "example": "full"
          },
          "gpus": {
            "type": "integer",
            "format": "int32",
            "minimum": 0,
            "maximum": 1,
            "description": "Number of GPUs to attach to the instance. Currently restricted to at most\n1. Requires `type` to be `full` and a plan with GPU support. A GPU stays\nassigned to the instance, even while stopped, until the instance is\ndeleted. Cannot be combined with `template`, `branch_from`, or\n`checkpoint`.",
            "example": 1
          }
        },
        "description": "The request message for creating a new instance."
      },
      "Instances.CreateInstanceRequestAutokill": {
        "type": "object",
        "properties": {
          "time_ms": {
            "type": "integer",
            "format": "uint64",
            "description": "Time in milliseconds after the instance was stopped before it is deleted.\nA value of 0 disables time-based autokill."
          },
          "num_requests": {
            "type": "integer",
            "format": "uint32",
            "description": "Maximum number of requests/connections the instance serves before it is\ndeleted. A value of 0 disables request-based autokill."
          }
        },
        "description": "Automatic delete-on-idle/request-limit configuration for non-template instances."
      },
      "Instances.CreateInstanceRequestDomain": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "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`.",
            "example": "funky-town-g756b5d.fra0.unikraft.app."
          },
          "certificate": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.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. A domain defines a publicly\naccessible domain name for the instance. If the domain name ends with a\nperiod `.`, it must be a valid Fully Qualified Domain Name (FQDN), otherwise\nit will become a subdomain of the target metro. The domain can be associated\nwith an existing certificate by specifying the certificate's name or UUID.\nIf no certificate 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."
      },
      "Instances.CreateInstanceRequestNetworkInterface": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The interface name. If omitted, Unikraft Cloud generates one as\n<instance-name>-ethX, falling back to eth-<suffix> when the\ninstance name is too long.",
            "example": "eth0"
          },
          "tap_name": {
            "type": "string",
            "description": "The TAP device to attach the interface to. Provide it together\nwith ip.",
            "example": "tap0"
          },
          "ip": {
            "type": "string",
            "description": "The interface IP address in CIDR notation. Provide it together\nwith tap_name to bring your own interface.",
            "example": "10.0.0.5/24"
          },
          "mac": {
            "type": "string",
            "description": "The interface MAC address. Provide it together with tap_name. Must be\na unicast address outside the platform's address pool.",
            "example": "02:00:00:00:00:01"
          },
          "autoconfig": {
            "type": "boolean",
            "description": "Whether the guest configures the interface itself. Defaults to true.",
            "example": true
          },
          "relay": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.NetworkInterfaceRelay"
              }
            ],
            "description": "Relay configuration for this interface."
          }
        },
        "description": "Network interface configuration for a new instance."
      },
      "Instances.CreateInstanceRequestPlugin": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The plugin name. It becomes the `<plugin_name>` segment in the plugin\nendpoint (`.../plugins/<plugin_name>/<path>`). A plugin name has a\nmaximum length of 63 characters and contains only letters (`a`-`z`,\n`A`-`Z`), digits (`0`-`9`), hyphen (`-`), and underscore (`_`).",
            "example": "my-plugin"
          },
          "image": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/Instances.ImageSpec"
              }
            ],
            "description": "The plugin's image. The platform loads the image, mounts it at\n`/uk/plugins/<plugin_name>`, and runs its `init` program when the plugin\nstarts. Accepts either a plain image reference string\n(`\"user/myplugin:latest\"`) or an object carrying additional pull\nconfiguration (`{\"url\": \"user/myplugin:latest\", \"pull_policy\": \"always\"}`).\nExactly one of `image` and `rom` must be set.",
            "example": "user/myplugin:latest"
          },
          "rom": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/Instances.ImageSpec"
              }
            ],
            "description": "The plugin's image, under its former name. The platform still accepts\nit and adds a deprecation warning to the response. Exactly one of\n`image` and `rom` must be set.\n\nDeprecated: Use `image` instead.",
            "deprecated": true,
            "example": "user/myplugin:latest"
          },
          "config": {
            "description": "Arbitrary JSON configuration that the platform passes to the plugin's\n`init` program on `STDIN`. Any JSON value works, including a string, a\nnumber, or an object."
          }
        },
        "description": "A helper program attached to the instance and reachable over a direct,\nauthenticated HTTP endpoint. A plugin runs inside the instance next to\nthe main application, loads from its own ROM image, and answers requests\nthat the Unikraft Cloud API forwards to it.",
        "oneOf": [
          {
            "required": [
              "image"
            ]
          },
          {
            "required": [
              "rom"
            ]
          }
        ]
      },
      "Instances.CreateInstanceRequestRom": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the ROM to use for the instance configuration.",
            "example": "funky-rom"
          },
          "image": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/Instances.ImageSpec"
              }
            ],
            "description": "The image of the ROM to use for the instance configuration. Mutually\nexclusive with `files`. Accepts either a plain image reference string\n(`\"nginx:latest\"`) or an object carrying additional pull configuration\n(`{\"url\": \"nginx:latest\", \"pull_policy\": \"always\"}`).",
            "example": "nginx:latest"
          },
          "at": {
            "type": "string",
            "description": "The path at which the ROM should be automatically mounted inside the\ninstance. When set, the platform mounts the ROM device at the specified\npath so the guest does not need to mount it manually. When omitted, the\nROM is exposed as a raw block device and the guest is responsible for\nmounting it.",
            "example": "/rom0"
          },
          "files": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.InlineFile"
            },
            "description": "Inline files to use as the ROM content. When specified, the platform\ncreates an EROFS image from the provided files. Mutually exclusive with\n`image`."
          }
        },
        "description": "A ROM to attach when creating an instance."
      },
      "Instances.CreateInstanceRequestServiceGroup": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          },
          "domains": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Instances.CreateInstanceRequestDomain"
            }
          },
          "services": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Services.Service"
            }
          },
          "soft_limit": {
            "type": "integer",
            "format": "uint32"
          },
          "hard_limit": {
            "type": "integer",
            "format": "uint32"
          }
        },
        "description": "The service group configuration when creating an instance. If no existing\n(persistent) service group is specified via its identifier, a new\n(ephemeral) service group can be created by specifying the services it\nshould expose. A service defines the configuration settings of an exposed\nport by the instance. A service is a combination of a public port, an\ninternal port, and a set of handlers that define how the service will handle\nincoming connections.",
        "oneOf": [
          {
            "required": [
              "uuid"
            ]
          },
          {
            "required": [
              "name"
            ]
          }
        ]
      },
      "Instances.CreateInstanceRequestTemplate": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          },
          "prepare": {
            "type": "boolean",
            "description": "Whether the instance needs to run in order to reach template state",
            "example": false
          },
          "create_args": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.Instance"
              }
            ],
            "description": "Configuration parameters to apply when building the new instance from the\nsource template."
          },
          "prepare_timeout_s": {
            "type": "integer",
            "format": "int64",
            "description": "Timeout in seconds for preparing the template before the preparation is\naborted. Only applies when `prepare` is set. A value of 0 means no\ntimeout.",
            "example": 30
          },
          "autokill": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.TemplateAutokill"
              }
            ],
            "description": "Automatic delete-on-idle configuration for the template. Only applies\nwhen `prepare` is set."
          }
        },
        "description": "Template configuration when creating an instance."
      },
      "Instances.CreateInstanceRequestVolume": {
        "type": "object",
        "required": [
          "at"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          },
          "size_mb": {
            "type": "integer",
            "format": "uint64"
          },
          "host_path": {
            "type": "string"
          },
          "at": {
            "type": "string"
          },
          "readonly": {
            "type": "boolean"
          },
          "quota_policy": {
            "type": "string"
          },
          "filesystem": {
            "type": "string"
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "uid": {
            "type": "integer",
            "format": "uint32"
          },
          "gid": {
            "type": "integer",
            "format": "uint32"
          },
          "access_mode": {
            "$ref": "#/components/schemas/Volumes.VolumeAccessMode"
          },
          "args": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "description": "A volume defines a storage volume that can be attached to the instance.",
        "oneOf": [
          {
            "required": [
              "size_mb"
            ]
          },
          {
            "required": [
              "host_path"
            ]
          }
        ]
      },
      "Instances.CreateInstanceResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "instances": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.Instance"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for creating a new instance."
      },
      "Instances.CreateInstanceScaleToZero": {
        "type": "object",
        "properties": {
          "policy": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.InstanceScaleToZeroPolicy"
              }
            ],
            "description": "The specific policy to use for scaling the instance to zero."
          },
          "stateful": {
            "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.",
            "example": true
          },
          "cooldown_time_ms": {
            "type": "integer",
            "format": "int32",
            "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.",
            "example": 3000
          },
          "notify_time_ms": {
            "type": "integer",
            "format": "int32",
            "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.",
            "example": 1000
          }
        },
        "description": "Scale-to-zero configuration when creating an instance."
      },
      "Instances.CreateTemplateInstancesRequestItem": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          },
          "timeout_s": {
            "type": "integer",
            "format": "int64",
            "description": "Timeout in seconds to wait for the template instances to be created.\nA value of -1 means to wait indefinitely until the instance reaches the\ndesired state. No wait performed for a value of 0.",
            "example": 2
          },
          "autokill": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.ItemAutokill"
              }
            ],
            "description": "Automatic delete-on-idle configuration for the new template."
          }
        },
        "description": "A single template instance to be created."
      },
      "Instances.CreateTemplateInstancesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "instances": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.CreateTemplateInstancesResponseTemplateInstance"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for converting one or more instance(s) to templates."
      },
      "Instances.CreateTemplateInstancesResponseTemplateInstance": {
        "type": "object",
        "required": [
          "status",
          "uuid",
          "name",
          "state"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.InstanceState"
              }
            ],
            "description": "The current state of the instance."
          }
        },
        "description": "Per-item result for a create template instances operation."
      },
      "Instances.DeleteCheckpointInstancesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "instances": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.DeleteCheckpointInstancesResponseCheckpointInstance"
                },
                "description": "List of checkpoint instances that were processed during the delete operation."
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for deleting one or more checkpoint instance(s) given\ntheir UUID(s) or name(s)."
      },
      "Instances.DeleteCheckpointInstancesResponseCheckpointInstance": {
        "type": "object",
        "required": [
          "status",
          "uuid",
          "name"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          }
        },
        "description": "Per-item result for a delete checkpoint instances operation."
      },
      "Instances.DeleteInstanceByUUIDRequestBody": {
        "type": "object",
        "properties": {
          "timeout_s": {
            "type": "integer",
            "format": "int64",
            "description": "Timeout in seconds to wait for the instance to be deleted. No wait\nperformed for a value of 0.",
            "example": 2
          },
          "dont_retain": {
            "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.",
            "example": false
          }
        },
        "description": "Parameters for deleting the instance by UUID."
      },
      "Instances.DeleteInstanceRequestItem": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          },
          "timeout_s": {
            "type": "integer",
            "format": "int64",
            "description": "Timeout in seconds to wait for the instance to be deleted. No wait\nperformed for a value of 0.",
            "example": 2
          },
          "dont_retain": {
            "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.",
            "example": false
          }
        },
        "description": "The request item for deleting an instance by its UUID or name."
      },
      "Instances.DeleteInstancesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "instances": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.DeleteInstancesResponseInstance"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for deleting one or more instance(s) given their\nUUID(s) or name(s)."
      },
      "Instances.DeleteInstancesResponseInstance": {
        "type": "object",
        "required": [
          "status",
          "uuid",
          "name",
          "previous_state"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "previous_state": {
            "type": "string",
            "description": "The previous state of the instance before it was deleted."
          }
        },
        "description": "Per-item result for a delete instances operation."
      },
      "Instances.DeleteTemplateInstancesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "instances": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.DeleteTemplateInstancesResponseTemplateInstance"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for deleting one or more template instance(s) given\ntheir UUID(s) or name(s)."
      },
      "Instances.DeleteTemplateInstancesResponseTemplateInstance": {
        "type": "object",
        "required": [
          "status",
          "uuid",
          "name"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          }
        },
        "description": "Per-item result for a delete template instances operation."
      },
      "Instances.GetCheckpointHistoryResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "instances": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.GetCheckpointHistoryResponseInstanceHistory"
                },
                "description": "The checkpoint histories for the requested instances."
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for getting the checkpoint history of one or more\ninstance(s) given their UUID(s) or name(s)."
      },
      "Instances.GetCheckpointHistoryResponseInstanceHistory": {
        "type": "object",
        "required": [
          "uuid",
          "name"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "history": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Instances.CheckpointHistoryEntry"
            },
            "description": "The checkpoint history entries."
          }
        },
        "description": "Per-item result for a get checkpoint/instance history operation."
      },
      "Instances.GetCheckpointInstancesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "instances": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.Instance"
                },
                "description": "List of checkpoint instances that were retrieved during the operation."
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for getting one or more checkpoint instance(s) given\ntheir UUID(s) or name(s)."
      },
      "Instances.GetInstanceLogsByUUIDRequestBody": {
        "type": "object",
        "properties": {
          "offset": {
            "type": "integer",
            "format": "int64",
            "description": "The byte offset of the log output to receive. A negative sign makes the\noffset relative to the end of the log.",
            "example": 56000
          },
          "limit": {
            "type": "integer",
            "format": "int64",
            "description": "The amount of bytes to return at most.",
            "example": 1500
          }
        }
      },
      "Instances.GetInstancesLogsRequestItem": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          },
          "offset": {
            "type": "integer",
            "format": "int64",
            "description": "The byte offset of the log output to receive. A negative sign makes the\noffset relative to the end of the log.",
            "example": 56000
          },
          "limit": {
            "type": "integer",
            "format": "int64",
            "description": "The amount of bytes to return at most.",
            "example": 1500
          }
        },
        "description": "A single request item to get an instance's logs."
      },
      "Instances.GetInstancesLogsResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "instances": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.GetInstancesLogsResponseLoggedInstance"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for getting the logs of one or more instance(s) by\ntheir UUID(s) or name(s)."
      },
      "Instances.GetInstancesLogsResponseAvailable": {
        "type": "object",
        "required": [
          "start",
          "end"
        ],
        "properties": {
          "start": {
            "type": "integer",
            "format": "int64",
            "description": "The first byte offset that can be retrieved.",
            "example": 250
          },
          "end": {
            "type": "integer",
            "format": "int64",
            "description": "The last byte offset that can be retrieved.",
            "example": 2700
          }
        },
        "description": "Per-item result for a get instances logs operation."
      },
      "Instances.GetInstancesLogsResponseLoggedInstance": {
        "type": "object",
        "required": [
          "uuid",
          "name",
          "output",
          "available",
          "range",
          "state"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "output": {
            "type": "string",
            "description": "Base64 encoded log output of the instance."
          },
          "available": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.GetInstancesLogsResponseAvailable"
              }
            ],
            "description": "Description of the log availability."
          },
          "range": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.GetInstancesLogsResponseRange"
              }
            ],
            "description": "Description of the range that was returned. Useful for requests with\noffset relative to end."
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.InstanceState"
              }
            ],
            "description": "State of the instance when the logs were retrieved."
          }
        },
        "description": "Per-item result for a get instances logs operation."
      },
      "Instances.GetInstancesLogsResponseRange": {
        "type": "object",
        "required": [
          "start",
          "end"
        ],
        "properties": {
          "start": {
            "type": "integer",
            "format": "int64",
            "description": "The first retrieved byte.",
            "example": 450
          },
          "end": {
            "type": "integer",
            "format": "int64",
            "description": "The last retrieved byte.",
            "example": 900
          }
        }
      },
      "Instances.GetInstancesMetricsResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "instances": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.GetInstancesMetricsResponseInstanceMetrics"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for getting the metrics of one or more instance(s) by\ntheir UUID(s) or name(s)."
      },
      "Instances.GetInstancesMetricsResponseInstanceMetrics": {
        "type": "object",
        "required": [
          "uuid",
          "name",
          "rss_bytes",
          "cpu_time_ms",
          "boot_time_us",
          "net_time_us",
          "rx_bytes",
          "rx_packets",
          "tx_bytes",
          "tx_packets",
          "nconns",
          "nreqs",
          "nqueued",
          "ntotal"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "rss_bytes": {
            "type": "integer",
            "format": "uint64",
            "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.",
            "example": 5677765543
          },
          "cpu_time_ms": {
            "type": "integer",
            "format": "uint64",
            "description": "Consumed CPU time in milliseconds.",
            "example": 560007005
          },
          "boot_time_us": {
            "type": "integer",
            "format": "uint64",
            "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.",
            "example": 560007005
          },
          "net_time_us": {
            "type": "integer",
            "format": "uint64",
            "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.",
            "example": 560007005
          },
          "rx_bytes": {
            "type": "integer",
            "format": "uint64",
            "description": "Total amount of bytes received from network.",
            "example": 12312353
          },
          "rx_packets": {
            "type": "integer",
            "format": "uint64",
            "description": "Total count of packets received from network.",
            "example": 43432
          },
          "tx_bytes": {
            "type": "integer",
            "format": "uint64",
            "description": "Total amount of bytes transmitted over network.",
            "example": 6565643
          },
          "tx_packets": {
            "type": "integer",
            "format": "uint64",
            "description": "Total count of packets transmitted over network.",
            "example": 54534
          },
          "nconns": {
            "type": "integer",
            "format": "uint64",
            "description": "Number of currently established inbound connections (non-HTTP).",
            "example": 5
          },
          "nreqs": {
            "type": "integer",
            "format": "uint64",
            "description": "Number of in-flight HTTP requests.",
            "example": 12
          },
          "nqueued": {
            "type": "integer",
            "format": "uint64",
            "description": "Number of queued inbound connections and HTTP requests.",
            "example": 5
          },
          "ntotal": {
            "type": "integer",
            "format": "uint64",
            "description": "Total number of inbound connections and HTTP requests handled.",
            "example": 21
          }
        },
        "description": "Per-item result for a get instances metrics operation."
      },
      "Instances.GetInstancesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "instances": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.Instance"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for getting one or more instance(s) given their\nUUID(s) or name(s)."
      },
      "Instances.GetTemplateInstancesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "instances": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.Instance"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for getting one or more template instance(s) given\ntheir UUID(s) or name(s)."
      },
      "Instances.ImageSpec": {
        "type": "object",
        "required": [
          "url"
        ],
        "properties": {
          "url": {
            "type": "string",
            "description": "The image URL",
            "example": "index.docker.io/library/nginx:latest"
          },
          "credentials": {
            "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.",
            "example": "dXNlcjpwYXNzd29yZA=="
          },
          "headers": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Optional HTTP headers to send when fetching the image.",
            "example": {
              "Authorization": "Bearer token123"
            }
          },
          "pull_policy": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.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."
      },
      "Instances.Instance": {
        "type": "object",
        "required": [
          "uuid",
          "name",
          "created_at",
          "state",
          "image",
          "memory_mb",
          "vcpus",
          "restart_policy",
          "type"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "The time the instance was created."
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.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": {
            "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.",
            "example": "funky-town-g756b5d.internal"
          },
          "image": {
            "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.",
            "example": "nginx:latest"
          },
          "memory_mb": {
            "type": "integer",
            "format": "uint64",
            "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.",
            "example": 1024
          },
          "vcpus": {
            "type": "integer",
            "format": "uint32",
            "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.",
            "example": 1
          },
          "args": {
            "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": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Environment variables set for the instance.",
            "example": {
              "ENV_VAR": "value"
            }
          },
          "start_count": {
            "type": "integer",
            "format": "uint64",
            "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.",
            "example": 6
          },
          "restart_count": {
            "type": "integer",
            "format": "uint64",
            "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.",
            "example": 1
          },
          "started_at": {
            "type": "string",
            "format": "date-time",
            "description": "The time the instance was started. This is the timestamp when the\ninstance was last started.\nNot used for template instances."
          },
          "stopped_at": {
            "type": "string",
            "format": "date-time",
            "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."
          },
          "uptime_ms": {
            "type": "integer",
            "format": "uint64",
            "description": "The total amount of time the instance has been running in milliseconds.\nNot used for template instances.",
            "example": 8954050300
          },
          "retained_until": {
            "type": "string",
            "format": "date-time",
            "description": "Time when the instance will be permanently deleted (for deleted instances)."
          },
          "vmm_start_time_us": {
            "type": "integer",
            "format": "uint64",
            "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.",
            "example": 70040
          },
          "vmm_load_time_us": {
            "type": "integer",
            "format": "uint64",
            "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.",
            "example": 4050
          },
          "vmm_ready_time_us": {
            "type": "integer",
            "format": "uint64",
            "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.",
            "example": 400
          },
          "boot_time_us": {
            "type": "integer",
            "format": "uint64",
            "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.",
            "example": 9000
          },
          "net_time_us": {
            "type": "integer",
            "format": "uint64",
            "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.",
            "example": 11000
          },
          "template_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "Template creation time in microseconds."
          },
          "stop_reason": {
            "type": "integer",
            "format": "uint32",
            "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\ninstance a chance to perform a clean shutdown. Bits 0\n(Kernel) and 1 (App) can thus never be set for forced\nshutdowns. 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.",
            "example": 15
          },
          "exit_code": {
            "type": "integer",
            "format": "uint32",
            "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.",
            "example": 137
          },
          "stop_code": {
            "type": "integer",
            "format": "uint32",
            "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\nfrom 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.",
            "example": 33024
          },
          "restart_policy": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.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/Instances.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."
          },
          "service_group": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.InstanceServiceGroup"
              }
            ],
            "description": "The service group configuration for the instance."
          },
          "services": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Services exposed by this instance (format: \"protocol:port\")."
          },
          "volumes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Instances.InstanceVolume"
            },
            "description": "The list of volumes attached to the instance."
          },
          "network_interfaces": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Instances.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."
          },
          "annotations": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "The annotations associated with the instance.\n\nKeys follow the Kubernetes annotation key syntax, `[<prefix>/]<name>`: the\noptional prefix is a non-wildcard DNS subdomain of at most 253 characters,\nand the name is at most 63 characters of `[-_.a-zA-Z0-9]` starting and\nending with an alphanumeric. Values are unconstrained apart from ASCII\ncontrol characters, which are rejected because they would corrupt the\nconsole log output annotations can be forwarded to.\n\nAn instance holds at most 256 annotations.",
            "example": {
              "my-key": "value1",
              "example.com/annotation2": "value2"
            }
          },
          "snapshot": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.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."
          },
          "features": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Instances.InstanceFeature"
            }
          },
          "restart": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.InstanceRestartAttempt"
              }
            ],
            "description": "The current restart attempt for the instance.\nNot used for template instances."
          },
          "roms": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Instances.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."
          },
          "plugins": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Instances.InstancePlugin"
            },
            "description": "Plugins attached to the instance. Plugins let you attach small helper\nprograms to an instance and reach each one over a direct, authenticated\nHTTP endpoint. Each plugin loads from its own ROM image, mounts at\n`/uk/plugins/<plugin_name>`, and is reachable at\n`.../v1/instances/<uuid>/plugins/<plugin_name>/<path>`. At most 8\nplugins may be attached to an instance."
          },
          "schedules": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Instances.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/Instances.InstanceAutokill"
              }
            ],
            "description": "Automatic delete-on-idle/request-limit configuration.\nNot used for template instances."
          },
          "updates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Instances.InstancePendingUpdate"
            },
            "description": "Queued property changes awaiting application."
          },
          "sched_priority": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.SchedPriority"
              }
            ],
            "description": "The scheduling priority for the instance. Only present for\nusers with scheduling priority override permissions.",
            "example": "high"
          },
          "template_autokill": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.InstanceTemplateAutokill"
              }
            ],
            "description": "Template-specific automatic delete-on-idle configuration.\nNot used for non-template instances."
          },
          "checkpoint_autokill": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.InstanceTemplateAutokill"
              }
            ],
            "description": "Checkpoint-specific automatic delete-on-idle configuration.\nOnly used for checkpoint instances."
          },
          "private_ip": {
            "type": "string",
            "description": "The private IP address of the instance.",
            "example": "10.0.0.5"
          },
          "gateway": {
            "type": "string",
            "description": "The default gateway configured inside the guest.",
            "example": "10.0.0.1"
          },
          "nameserver": {
            "type": "string",
            "description": "The DNS resolver configured inside the guest.",
            "example": "8.8.8.8"
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.InstanceType"
              }
            ],
            "description": "The type of virtual machine used to run the instance."
          },
          "gpus": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Instances.InstanceGpu"
            },
            "description": "GPUs attached to the instance. Only present for instances of type\n`full`."
          }
        },
        "description": "Instance with per-item response envelope fields merged in."
      },
      "Instances.InstanceAutokill": {
        "type": "object",
        "properties": {
          "time_ms": {
            "type": "integer",
            "format": "uint64",
            "description": "Time in milliseconds after the instance was stopped before it is deleted.\nA value of 0 disables time-based autokill."
          },
          "num_requests": {
            "type": "integer",
            "format": "uint32",
            "description": "Maximum number of requests/connections the instance serves before it is\ndeleted. A value of 0 disables request-based autokill."
          }
        },
        "description": "Automatic delete-on-idle/request-limit configuration for non-template\ninstances. Not used for template instances."
      },
      "Instances.InstanceFeature": {
        "type": "string",
        "enum": [
          "delete-on-stop",
          "nested-virt"
        ],
        "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. Cannot be combined with a `restart_policy` other than `never`. |\n| `nested-virt`      | Expose virtualization extensions to the guest, so that it can run virtual machines of its own. Requires the `nested_virt` permission. |"
      },
      "Instances.InstanceGpu": {
        "type": "object",
        "required": [
          "uuid",
          "model"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the GPU."
          },
          "model": {
            "type": "string",
            "description": "The GPU model, given as its PCI vendor and device ID in the form\n`<vendor>:<device>`.",
            "example": "10de:1eb8"
          }
        },
        "description": "A GPU attached to the instance."
      },
      "Instances.InstanceNetworkInterface": {
        "type": "object",
        "required": [
          "uuid",
          "private_ip",
          "mac"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid"
          },
          "private_ip": {
            "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.",
            "example": "10.0.0.61"
          },
          "mac": {
            "type": "string",
            "description": "The MAC address of the network interface.",
            "example": "12:b0:a0:00:00:3d"
          },
          "name": {
            "type": "string",
            "description": "The interface name. If omitted, Unikraft Cloud generates one as\n<instance-name>-ethX, falling back to eth-<suffix> when the\ninstance name is too long.",
            "example": "eth0"
          },
          "tap_name": {
            "type": "string",
            "description": "The TAP device to attach the interface. Provide it together with ip.",
            "example": "tap0"
          },
          "autoconfig": {
            "type": "boolean",
            "description": "Whether the interface is automatically configured inside the guest\n(IP address, routes, etc.). When absent or true, autoconfiguration\nis enabled. Present and false when the guest is expected to\nconfigure the interface manually.",
            "example": false
          },
          "relay": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.InstanceNetworkInterfaceRelay"
              }
            ],
            "description": "Relay configuration for this interface."
          }
        },
        "description": "A network interface attached to an instance."
      },
      "Instances.InstanceNetworkInterfaceRelay": {
        "type": "object",
        "required": [
          "uuid",
          "name",
          "relay_dns"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "UUID of the relay interface."
          },
          "name": {
            "type": "string",
            "description": "Name of the relay interface.",
            "example": "eth-relay"
          },
          "relay_dns": {
            "type": "boolean",
            "description": "Whether DNS traffic is relayed through this interface.\nDefaults to true.",
            "example": true
          }
        },
        "description": "An object that routes all traffic through another interface."
      },
      "Instances.InstancePendingUpdate": {
        "type": "object",
        "required": [
          "prop",
          "op",
          "value",
          "status"
        ],
        "properties": {
          "prop": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.MutableInstanceProperty"
              }
            ],
            "description": "The property being updated."
          },
          "op": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.MutableInstanceOperation"
              }
            ],
            "description": "The patch operation type."
          },
          "value": {
            "description": "The new value for the property. Type depends on the property being updated."
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "failed"
            ],
            "description": "The status of this update."
          },
          "error": {
            "type": "string",
            "description": "Error message. Only present when status is \"failed\"."
          }
        },
        "description": "A queued property change awaiting application on an instance."
      },
      "Instances.InstancePlugin": {
        "type": "object",
        "required": [
          "name",
          "image"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The plugin name. It becomes the `<plugin_name>` segment in the plugin\nendpoint (`.../plugins/<plugin_name>/<path>`). A plugin name has a\nmaximum length of 63 characters and contains only letters (`a`-`z`,\n`A`-`Z`), digits (`0`-`9`), hyphen (`-`), and underscore (`_`).",
            "example": "my-plugin"
          },
          "image": {
            "type": "string",
            "description": "The plugin's image, given as an image reference string such as\n`user/myplugin:latest`. The platform loads the image, mounts it at\n`/uk/plugins/<plugin_name>`, and runs its `init` program when the\nplugin starts.",
            "example": "user/myplugin:latest"
          },
          "config": {
            "description": "Arbitrary JSON configuration that the platform passes to the plugin's\n`init` program on `STDIN`. Any JSON value works, including a string, a\nnumber, or an object."
          }
        },
        "description": "A helper program attached to the instance and reachable over a direct,\nauthenticated HTTP endpoint. A plugin runs inside the instance next to\nthe main application, loads from its own ROM image, and answers requests\nthat the Unikraft Cloud API forwards to it."
      },
      "Instances.InstanceRestartAttempt": {
        "type": "object",
        "required": [
          "attempt"
        ],
        "properties": {
          "attempt": {
            "type": "integer",
            "format": "uint32",
            "description": "Current restart attempt number. This is incremented each time the instance\nis restarted automatically by the platform.",
            "example": 1
          },
          "next_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp of the next scheduled restart attempt."
          }
        },
        "description": "Restart attempt information for an instance."
      },
      "Instances.InstanceRestartPolicy": {
        "type": "string",
        "enum": [
          "never",
          "always",
          "on-failure"
        ],
        "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. The 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.\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. A\nmanual start or stop of the instance aborts the restart sequence and resets\nthe back-off delay."
      },
      "Instances.InstanceRom": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the ROM to use for the instance configuration.",
            "example": "funky-rom"
          },
          "image": {
            "type": "string",
            "description": "The image of the ROM to use for the instance configuration. Mutually\nexclusive with `files`.",
            "example": "nginx:latest"
          },
          "at": {
            "type": "string",
            "description": "The path at which the ROM should be automatically mounted inside the\ninstance. When set, the platform mounts the ROM device at the specified\npath so the guest does not need to mount it manually. When omitted, the\nROM is exposed as a raw block device and the guest is responsible for\nmounting it.",
            "example": "/rom0"
          },
          "files": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.InlineFile"
            },
            "description": "Inline files to use as the ROM content. When specified, the platform\ncreates an EROFS image from the provided files. Mutually exclusive with\n`image`."
          }
        },
        "description": "A ROM attached to an instance."
      },
      "Instances.InstanceScaleToZero": {
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean",
            "description": "Indicates whether scale-to-zero is enabled for the instance.",
            "example": true
          },
          "policy": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.InstanceScaleToZeroPolicy"
              }
            ],
            "description": "The specific policy to use for scaling the instance to zero."
          },
          "stateful": {
            "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.",
            "example": true
          },
          "cooldown_time_ms": {
            "type": "integer",
            "format": "int32",
            "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.",
            "example": 3000
          },
          "notify_time_ms": {
            "type": "integer",
            "format": "int32",
            "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.",
            "example": 1000
          }
        },
        "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.,\nRAM contents) and the instance can be resumed later without losing its\nstate, i.e. \"stateful\"."
      },
      "Instances.InstanceScaleToZeroPolicy": {
        "type": "string",
        "enum": [
          "off",
          "on",
          "idle"
        ],
        "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. |"
      },
      "Instances.InstanceServiceGroup": {
        "type": "object",
        "required": [
          "uuid",
          "name"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "domains": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Instances.ServiceGroupInstanceDomain"
            },
            "description": "The domain configuration for the service group."
          }
        },
        "description": "The service group configuration for the instance. This is a reference to the\nservice group that the instance is part of. The service group defines the\nservices (e.g. ports, connection handling) that the instance exposes and how\nthey are configured."
      },
      "Instances.InstanceSnapshot": {
        "type": "object",
        "required": [
          "uuid"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid"
          }
        },
        "description": "A snapshot reference for an instance."
      },
      "Instances.InstanceState": {
        "type": "string",
        "enum": [
          "stopped",
          "starting",
          "running",
          "draining",
          "stopping",
          "template",
          "standby",
          "deleted",
          "checkpoint"
        ],
        "description": "The current state of an instance."
      },
      "Instances.InstanceTemplateAutokill": {
        "type": "object",
        "properties": {
          "time_ms": {
            "type": "integer",
            "format": "uint64",
            "description": "Time in milliseconds after the template was last used for cloning before\nit is deleted. A value of 0 disables template autokill."
          }
        },
        "description": "Autokill configuration for a template instance."
      },
      "Instances.InstanceType": {
        "type": "string",
        "enum": [
          "micro",
          "full"
        ],
        "description": "The type of virtual machine used to run an instance.\n\n| Type    | Description |\n|---------|-------------|\n| `micro` | A lightweight microVM (default). Boots in milliseconds and is suitable for most workloads. |\n| `full`  | A full virtual machine with broader hardware support, such as GPU passthrough. Requires a plan with full VM support. |"
      },
      "Instances.InstanceVolume": {
        "type": "object",
        "required": [
          "uuid",
          "name",
          "at",
          "readonly"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "at": {
            "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.",
            "example": "/mnt/funky-volume"
          },
          "readonly": {
            "type": "boolean",
            "description": "Whether the volume is read-only or not.",
            "example": true
          }
        },
        "description": "A volume defines a storage which can be attached to the instance. Volumes\ncan be used to store persistent data which should remain available even if\nthe instance is stopped or restarted."
      },
      "Instances.ItemAutokill": {
        "type": "object",
        "properties": {
          "time_ms": {
            "type": "integer",
            "format": "uint64",
            "description": "Time in milliseconds after the template was last used for cloning before\nit is deleted. A value of 0 disables template autokill.",
            "example": 60000
          }
        },
        "description": "Automatic delete-on-idle configuration for the template instance."
      },
      "Instances.MutableCheckpointInstanceOperation": {
        "type": "string",
        "enum": [
          "set",
          "add",
          "del"
        ],
        "description": "The operations available on a checkpoint instance's properties."
      },
      "Instances.MutableCheckpointInstanceProperty": {
        "type": "string",
        "enum": [
          "tags",
          "delete_lock",
          "autokill"
        ],
        "description": "The mutable properties of a checkpoint instance that can be updated."
      },
      "Instances.MutableInstanceOperation": {
        "type": "string",
        "enum": [
          "set",
          "add",
          "del"
        ],
        "description": "Mutable instance operations."
      },
      "Instances.MutableInstanceProperty": {
        "type": "string",
        "enum": [
          "image",
          "args",
          "env",
          "memory_mb",
          "vcpus",
          "scale_to_zero",
          "tags",
          "delete_lock",
          "schedules",
          "autokill",
          "hostname",
          "roms",
          "dependencies",
          "sched_priority",
          "plugins",
          "annotations"
        ],
        "description": "The mutable properties of an instance that can be updated."
      },
      "Instances.MutableTemplateInstanceOperation": {
        "type": "string",
        "enum": [
          "set",
          "add",
          "del"
        ],
        "description": "Mutable template instance operations."
      },
      "Instances.MutableTemplateInstanceProperty": {
        "type": "string",
        "enum": [
          "tags",
          "delete_lock",
          "autokill"
        ],
        "description": "The mutable properties of a template instance that can be updated."
      },
      "Instances.NetworkInterfaceRelay": {
        "type": "object",
        "properties": {
          "relay_dns": {
            "type": "boolean",
            "description": "Whether the relay forwards DNS requests. Set to false\nto let the default DNS server handle them instead.\nDefaults to true.",
            "example": true
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          }
        },
        "description": "An object that routes all traffic through another interface.",
        "oneOf": [
          {
            "required": [
              "uuid"
            ]
          },
          {
            "required": [
              "name"
            ]
          }
        ]
      },
      "Instances.PullPolicy": {
        "type": "string",
        "enum": [
          "always",
          "if_not_present",
          "never"
        ],
        "description": "PullPolicy defines when an image should be pulled."
      },
      "Instances.Schedule": {
        "type": "object",
        "required": [
          "name",
          "when",
          "action"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the schedule.\n\nMust be unique within an instance.",
            "example": "daily-stop"
          },
          "when": {
            "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": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.ScheduleAction"
              }
            ],
            "description": "The action to perform at the scheduled time."
          },
          "next_at": {
            "type": "string",
            "format": "date-time",
            "description": "The timestamp of when the next scheduled action will occur.\n\nThis field is populated only in responses (not settable in requests).\nOmitted if no next execution is scheduled.",
            "readOnly": true
          },
          "args": {
            "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.",
            "example": [
              "/bin/sh",
              "-c",
              "echo hello"
            ]
          }
        },
        "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:\n\n[weekday] [[year-]month-day] [hour:minute[:second]]\n\nSupported syntax:\n\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"
      },
      "Instances.ScheduleAction": {
        "type": "string",
        "enum": [
          "start",
          "stop",
          "delete",
          "exec"
        ],
        "description": "The action to perform on a scheduled operation."
      },
      "Instances.ServiceGroupInstanceDomain": {
        "type": "object",
        "required": [
          "fqdn"
        ],
        "properties": {
          "fqdn": {
            "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.",
            "example": "funky-town-g756b5d.fra0.unikraft.app."
          },
          "certificate": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.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. Domain names are completely\nspecified with all labels in the hierarchy of the DNS, having no parts\nomitted. 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."
      },
      "Instances.StartInstanceByUUIDRequestBody": {
        "type": "object",
        "properties": {
          "wait_timeout_ms": {
            "type": "integer",
            "format": "int64",
            "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.",
            "deprecated": true,
            "example": 2000
          },
          "timeout_s": {
            "type": "integer",
            "format": "int64",
            "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.",
            "example": 2
          }
        },
        "description": "Parameters for starting the instance."
      },
      "Instances.StartInstancesRequestItem": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          },
          "wait_timeout_ms": {
            "type": "integer",
            "format": "int64",
            "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.",
            "deprecated": true,
            "example": 2000
          },
          "timeout_s": {
            "type": "integer",
            "format": "int64",
            "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.",
            "example": 2
          }
        },
        "description": "A single request item to start an instance."
      },
      "Instances.StartInstancesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "instances": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.StartInstancesResponseStartedInstance"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for starting one or more instance(s) given their\nUUID(s) or name(s)."
      },
      "Instances.StartInstancesResponseStartedInstance": {
        "type": "object",
        "required": [
          "status",
          "uuid",
          "name",
          "state",
          "previous_state"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "state": {
            "type": "string",
            "description": "The current state of the instance after this request."
          },
          "previous_state": {
            "type": "string",
            "description": "The previous state of the instance before it was started."
          }
        },
        "description": "Per-item result for a start instances operation."
      },
      "Instances.StopInstanceByUUIDRequestBody": {
        "type": "object",
        "properties": {
          "force": {
            "type": "boolean",
            "description": "Whether to immediately force stop the instance.",
            "example": true
          },
          "drain_timeout_ms": {
            "type": "integer",
            "format": "uint64",
            "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.",
            "example": 550
          },
          "quick": {
            "type": "boolean",
            "description": "Whether to perform a quick shutdown. This flag is\noverridden by force.",
            "example": false
          },
          "ifstate": {
            "type": "string",
            "description": "Only stop the instance if it is in this state.",
            "example": "running"
          },
          "dump": {
            "type": "boolean",
            "description": "If set, forces the VMM to shutdown immediately and generate a coredump.\nCan only be used in conjunction with force.",
            "example": false
          }
        },
        "description": "Parameters for stopping the instance."
      },
      "Instances.StopInstancesRequestItem": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          },
          "force": {
            "type": "boolean",
            "description": "Whether to immediately force stop the instance.",
            "example": true
          },
          "drain_timeout_ms": {
            "type": "integer",
            "format": "uint64",
            "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.",
            "example": 550
          },
          "quick": {
            "type": "boolean",
            "description": "Whether to perform a quick shutdown. This flag is\noverridden by force.",
            "example": false
          },
          "ifstate": {
            "type": "string",
            "description": "Only stop the instance if it is in this state.",
            "example": "running"
          },
          "dump": {
            "type": "boolean",
            "description": "If set, forces the VMM to shutdown immediately and generate a coredump.\nCan only be used in conjunction with force.",
            "example": false
          }
        },
        "description": "A single request item to stop an instance."
      },
      "Instances.StopInstancesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "instances": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.StopInstancesResponseStoppedInstance"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for stopping one or more instance(s) given their\nUUID(s) or name(s)."
      },
      "Instances.StopInstancesResponseStoppedInstance": {
        "type": "object",
        "required": [
          "uuid",
          "name",
          "state",
          "previous_state"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.InstanceState"
              }
            ],
            "description": "The current state of the instance."
          },
          "previous_state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.InstanceState"
              }
            ],
            "description": "The previous state of the instance before the stop operation was\ninvoked."
          }
        },
        "description": "Per-item result for a stop instances operation."
      },
      "Instances.SuspendInstanceByUUIDRequestBody": {
        "type": "object",
        "properties": {
          "drain_timeout_ms": {
            "type": "integer",
            "format": "uint64",
            "description": "Timeout for draining connections in milliseconds. No draining\nwill occur if set to 0. Use -1 for the largest possible value.",
            "example": 550
          }
        },
        "description": "Parameters for suspending the instance."
      },
      "Instances.SuspendInstancesRequestItem": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          },
          "drain_timeout_ms": {
            "type": "integer",
            "format": "uint64",
            "description": "Timeout for draining connections in milliseconds. No draining\nwill occur if set to 0. Use -1 for the largest possible value.",
            "example": 550
          }
        },
        "description": "A single request item to suspend an instance."
      },
      "Instances.SuspendInstancesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "instances": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.SuspendInstancesResponseSuspendedInstance"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for suspending one or more instance(s) given their\nUUID(s) or name(s)."
      },
      "Instances.SuspendInstancesResponseSuspendedInstance": {
        "type": "object",
        "required": [
          "uuid",
          "name",
          "state",
          "previous_state"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.InstanceState"
              }
            ],
            "description": "The current state of the instance."
          },
          "previous_state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.InstanceState"
              }
            ],
            "description": "The previous state of the instance before the suspend operation was\ninvoked."
          }
        },
        "description": "Per-item result for a suspend instances operation."
      },
      "Instances.TemplateAutokill": {
        "type": "object",
        "properties": {
          "time_ms": {
            "type": "integer",
            "format": "uint64",
            "description": "Time in milliseconds after the template was last used for cloning before\nit is deleted. A value of 0 disables template autokill.",
            "example": 60000
          }
        },
        "description": "Automatic delete-on-idle configuration for the template instance. Only\napplies when `prepare` is set."
      },
      "Instances.UpdateCheckpointInstanceByUUIDRequestBody": {
        "type": "object",
        "required": [
          "prop",
          "op"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "A client-provided identifier for tracking this operation in the response.",
            "example": "op-1"
          },
          "prop": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.MutableCheckpointInstanceProperty"
              }
            ],
            "description": "The property to modify.",
            "example": "tags"
          },
          "op": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.MutableCheckpointInstanceOperation"
              }
            ],
            "description": "The operation to perform on the property.",
            "example": "add"
          },
          "value": {
            "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"
          }
        },
        "description": "Request body for updating a single checkpoint instance by UUID."
      },
      "Instances.UpdateCheckpointInstancesRequestItem": {
        "type": "object",
        "required": [
          "prop",
          "op"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          },
          "id": {
            "type": "string",
            "description": "A client-provided identifier for tracking this operation in the response.",
            "example": "op-1"
          },
          "prop": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.MutableCheckpointInstanceProperty"
              }
            ],
            "description": "The property to modify.",
            "example": "tags"
          },
          "op": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.MutableCheckpointInstanceOperation"
              }
            ],
            "description": "The operation to perform on the property.",
            "example": "add"
          },
          "value": {
            "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"
          }
        },
        "description": "A single update operation to be applied to a checkpoint instance."
      },
      "Instances.UpdateCheckpointInstancesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "instances": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.UpdateCheckpointInstancesResponseCheckpointInstance"
                },
                "description": "List of checkpoint instances that were processed during the update operation."
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for updating one or more checkpoint instance(s) given\ntheir UUID(s) or name(s)."
      },
      "Instances.UpdateCheckpointInstancesResponseCheckpointInstance": {
        "type": "object",
        "required": [
          "status",
          "uuid",
          "name"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "id": {
            "type": "string",
            "description": "The client-provided ID from the request."
          }
        },
        "description": "Per-item result for an update checkpoint instances operation."
      },
      "Instances.UpdateInstanceByUUIDRequestBody": {
        "type": "object",
        "required": [
          "prop",
          "op"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "A client-provided identifier for tracking this operation in the response.",
            "example": "op-1"
          },
          "prop": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.MutableInstanceProperty"
              }
            ],
            "description": "The property to modify."
          },
          "op": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.MutableInstanceOperation"
              }
            ],
            "description": "The operation to perform on the property."
          },
          "value": {
            "description": "The value for the update operation. The type depends on the property and operation:\n- For \"image\": image reference string, or object with image url,\ncredentials, 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)\nfor SET/ADD, or array of schedule names for DEL. Use action \"exec\" together with args to\nexecute 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 \"plugins\": array of plugin objects (with name, image, and optional config fields)\nfor SET/ADD. The deprecated `rom` field is accepted in place of `image`.\n- For \"dependencies\": array of instance identifiers (name or UUID)\n- For \"sched_priority\": SchedPriority enum value (\"normal\", \"medium\", \"high\", \"admin\")\n- For \"annotations\": object (for SET/ADD) or string/array of strings (for DEL)"
          }
        }
      },
      "Instances.UpdateInstancesRequestItem": {
        "type": "object",
        "required": [
          "prop",
          "op"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          },
          "id": {
            "type": "string",
            "description": "A client-provided identifier for tracking this operation in the response.",
            "example": "op-1"
          },
          "prop": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.MutableInstanceProperty"
              }
            ],
            "description": "The property to modify."
          },
          "op": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.MutableInstanceOperation"
              }
            ],
            "description": "The operation to perform on the property."
          },
          "value": {
            "description": "The value for the update operation. The type depends on the property and operation:\n- For \"image\": image reference string, or object with image url,\ncredentials, 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)\nfor SET/ADD, or array of schedule names for DEL. Use action \"exec\" together with args to\nexecute 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 \"plugins\": array of plugin objects (with name, image, and optional config fields)\nfor SET/ADD. The deprecated `rom` field is accepted in place of `image`.\n- For \"dependencies\": array of instance identifiers (name or UUID)\n- For \"sched_priority\": SchedPriority enum value (\"normal\", \"medium\", \"high\", \"admin\")\n- For \"annotations\": object (for SET/ADD) or string/array of strings (for DEL)"
          }
        },
        "description": "A single update operation to be applied to an instance."
      },
      "Instances.UpdateInstancesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "instances": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.UpdateInstancesResponseUpdatedInstance"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for updating one or more instance(s) given their\nUUID(s) or name(s)."
      },
      "Instances.UpdateInstancesResponseUpdatedInstance": {
        "type": "object",
        "required": [
          "status",
          "uuid",
          "name"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "id": {
            "type": "string",
            "description": "The client-provided ID from the request."
          }
        },
        "description": "Per-item result for an update instances operation."
      },
      "Instances.UpdateTemplateInstanceByUUIDRequestBody": {
        "type": "object",
        "required": [
          "prop",
          "op"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "A client-provided identifier for tracking this operation in the response."
          },
          "prop": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.MutableTemplateInstanceProperty"
              }
            ],
            "description": "The property to modify."
          },
          "op": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.MutableTemplateInstanceOperation"
              }
            ],
            "description": "The operation to perform."
          },
          "value": {
            "description": "The value for the update operation. The type depends on the property and\noperation:\n- For \"tags\": array of strings\n- For \"delete_lock\": boolean\n- For \"autokill\": object with time_ms field"
          }
        }
      },
      "Instances.UpdateTemplateInstancesRequestItem": {
        "type": "object",
        "required": [
          "prop",
          "op"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          },
          "id": {
            "type": "string",
            "description": "A client-provided identifier for tracking this operation in the response."
          },
          "prop": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.MutableTemplateInstanceProperty"
              }
            ],
            "description": "The property to modify."
          },
          "op": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.MutableTemplateInstanceOperation"
              }
            ],
            "description": "The operation to perform."
          },
          "value": {
            "description": "The value for the update operation. The type depends on the property and\noperation:\n- For \"tags\": array of strings\n- For \"delete_lock\": boolean\n- For \"autokill\": object with time_ms field"
          }
        },
        "description": "A single template instance update request item."
      },
      "Instances.UpdateTemplateInstancesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "instances": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.UpdateTemplateInstancesResponseTemplateInstance"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for updating one or more template instance(s) given\ntheir UUID(s) or name(s)."
      },
      "Instances.UpdateTemplateInstancesResponseTemplateInstance": {
        "type": "object",
        "required": [
          "status",
          "uuid",
          "name"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "id": {
            "type": "string",
            "description": "Client-provided operation ID."
          }
        },
        "description": "Per-item result for an update template instances operation."
      },
      "Instances.WaitInstanceByUUIDRequestBody": {
        "type": "object",
        "required": [
          "state"
        ],
        "properties": {
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.InstanceState"
              }
            ],
            "description": "The desired state to wait for. Default is `running`."
          },
          "timeout_ms": {
            "type": "integer",
            "format": "int64",
            "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.",
            "deprecated": true,
            "example": 450
          },
          "timeout_s": {
            "type": "integer",
            "format": "int64",
            "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.",
            "example": 2
          }
        },
        "description": "Wait parameters."
      },
      "Instances.WaitInstancesRequestItem": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.InstanceState"
              }
            ],
            "description": "The desired state to wait for. Default is `running`."
          },
          "timeout_ms": {
            "type": "integer",
            "format": "int64",
            "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.",
            "deprecated": true,
            "example": 450
          },
          "timeout_s": {
            "type": "integer",
            "format": "int64",
            "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.",
            "example": 2
          }
        },
        "description": "A single request item to wait for an instance's state."
      },
      "Instances.WaitInstancesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "instances": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Instances.WaitInstancesResponseWaitedInstance"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for waiting for one or more instance(s) to reach a\ncertain state given their UUID(s) or name(s)."
      },
      "Instances.WaitInstancesResponseWaitedInstance": {
        "type": "object",
        "required": [
          "uuid",
          "name",
          "state"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Instances.InstanceState"
              }
            ],
            "description": "The current state of the instance."
          }
        },
        "description": "Per-item result for a wait instances operation."
      },
      "Node.DataLicense": {
        "type": "object",
        "required": [
          "serial",
          "valid"
        ],
        "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)."
      },
      "Node.HealthState": {
        "type": "string",
        "enum": [
          "unknown",
          "healthy",
          "degraded"
        ],
        "description": "The health state reported by a single health checker."
      },
      "Node.HealthzResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Node.HealthzResponseData"
              }
            ],
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "Standard response envelope wrapping all API responses."
      },
      "Node.HealthzResponseData": {
        "type": "object",
        "properties": {
          "checks": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/Node.HealthState"
            },
            "description": "The health state of each registered checker, keyed by checker name.\nValid keys are \"images\", \"systemd\", and \"user-defined\"; a checker's\nkey is only present if it is enabled. Checkers report only their\naggregate state; per-check detail (e.g. which default image is\nmissing, or which user-defined script failed) is not exposed here."
          },
          "versions": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "license": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Node.DataLicense"
              }
            ],
            "description": "License information (admin only)."
          }
        },
        "description": "Additional data returned by the health check."
      },
      "Services.ConnectionHandler": {
        "type": "string",
        "enum": [
          "tls",
          "http",
          "redirect"
        ],
        "description": "Connection handlers to use for the service.\n\nHandlers define how the service will handle incoming connections and\nforward traffic from the Internet to your application. For example, a\nservice can be configured to terminate TLS connections, redirect HTTP\ntraffic, or enable HTTP mode for load balancing. You configure the handlers\nfor 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\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\nport 443 (HTTPS);\n- All other ports MUST have tls and MUST not have http set."
      },
      "Services.CreateServiceGroupRequest": {
        "type": "object",
        "required": [
          "services"
        ],
        "properties": {
          "name": {
            "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.",
            "example": "funky-service-g7gum5cj"
          },
          "services": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Services.Service"
            },
            "description": "Services to expose. At least one service is required."
          },
          "domains": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Services.CreateServiceGroupRequestDomain"
            },
            "description": "Description of domains associated with the service group."
          },
          "soft_limit": {
            "type": "integer",
            "format": "uint64",
            "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.",
            "example": 1
          },
          "hard_limit": {
            "type": "integer",
            "format": "uint64",
            "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).",
            "example": 100
          },
          "autokill": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Services.CreateServiceGroupRequestAutokill"
              }
            ],
            "description": "Automatic delete-on-idle configuration."
          }
        },
        "description": "The request message for creating a new service group."
      },
      "Services.CreateServiceGroupRequestAutokill": {
        "type": "object",
        "properties": {
          "time_ms": {
            "type": "integer",
            "format": "uint64",
            "description": "Time in milliseconds after the service group becomes empty before it is\ndeleted. A value of 0 disables autokill."
          }
        },
        "description": "Autokill configuration when creating a service group."
      },
      "Services.CreateServiceGroupRequestDomain": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "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.",
            "example": "example.com."
          },
          "certificate": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.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 to attach when creating a service group."
      },
      "Services.CreateServiceGroupResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "service_groups": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Services.ServiceGroup"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for creating a new service group."
      },
      "Services.DeleteServiceGroupsResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "service_groups": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Services.DeleteServiceGroupsResponseDeletedServiceGroup"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for deleting of one or more service group(s) given\ntheir UUID(s) or name(s)."
      },
      "Services.DeleteServiceGroupsResponseDeletedServiceGroup": {
        "type": "object",
        "required": [
          "uuid",
          "name",
          "status"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code providing additional information about the status."
          }
        },
        "description": "Per-item result for a delete service groups operation."
      },
      "Services.Domain": {
        "type": "object",
        "required": [
          "fqdn"
        ],
        "properties": {
          "fqdn": {
            "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.",
            "example": "example.com."
          },
          "certificate": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Certificates.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. Domain names are completely specified with all labels in the\nhierarchy of the DNS, having no parts omitted. The domain can be associated\nwith an existing certificate by specifying the certificate's name or UUID.\nIf no certificate 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."
      },
      "Services.GetServiceGroupsResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "service_groups": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Services.ServiceGroup"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for getting one or more service group(s) given their\nUUID(s) or name(s)."
      },
      "Services.MutableServiceGroupOperation": {
        "type": "string",
        "enum": [
          "set",
          "add",
          "del"
        ],
        "description": "The mutable operations available on a service group's properties."
      },
      "Services.MutableServiceGroupProperty": {
        "type": "string",
        "enum": [
          "services",
          "domains",
          "soft_limit",
          "hard_limit",
          "autokill"
        ],
        "description": "Mutable service group properties."
      },
      "Services.Service": {
        "type": "object",
        "required": [
          "port"
        ],
        "properties": {
          "port": {
            "type": "integer",
            "format": "uint32",
            "description": "This is the public-facing port that the service will be accessible from\non the Internet.",
            "example": 443
          },
          "destination_port": {
            "type": "integer",
            "format": "uint32",
            "description": "The port number that the instance is listening on. This is the internal\nport which Unikraft Cloud will forward traffic to.",
            "example": 8080
          },
          "protocol": {
            "$ref": "#/components/schemas/Services.ServiceProtocol"
          },
          "ip": {
            "type": "string"
          },
          "handlers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Services.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\ndefined 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."
      },
      "Services.ServiceGroup": {
        "type": "object",
        "required": [
          "uuid",
          "name",
          "created_at",
          "persistent",
          "autoscale",
          "soft_limit",
          "hard_limit"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "The time the service was created."
          },
          "persistent": {
            "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.",
            "example": true
          },
          "autoscale": {
            "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.",
            "example": true
          },
          "soft_limit": {
            "type": "integer",
            "format": "uint64",
            "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.",
            "example": 1
          },
          "hard_limit": {
            "type": "integer",
            "format": "uint64",
            "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).",
            "example": 100
          },
          "services": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Services.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/Services.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/Services.ServiceGroupInstance"
            },
            "description": "List of instances assigned to the service."
          },
          "autokill": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Services.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.\nit listens on port 80 because your application exposes a HTTP web service.\nThis, along 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."
      },
      "Services.ServiceGroupAutokill": {
        "type": "object",
        "properties": {
          "time_ms": {
            "type": "integer",
            "format": "uint64",
            "description": "Time in milliseconds after the service group becomes empty before it is\ndeleted. A value of 0 disables autokill."
          }
        },
        "description": "Autokill configuration for a service group."
      },
      "Services.ServiceGroupInstance": {
        "type": "object",
        "required": [
          "uuid",
          "name"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          }
        },
        "description": "An instance belonging to a service group."
      },
      "Services.ServiceProtocol": {
        "type": "string",
        "enum": [
          "tcp",
          "udp"
        ],
        "description": "Protocol for a service."
      },
      "Services.UpdateServiceGroupByUUIDRequestBody": {
        "type": "object",
        "required": [
          "prop",
          "op"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "A client-provided identifier for tracking this operation in the response.",
            "example": "op-1"
          },
          "prop": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Services.MutableServiceGroupProperty"
              }
            ],
            "description": "The property to modify."
          },
          "op": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Services.MutableServiceGroupOperation"
              }
            ],
            "description": "The operation to perform."
          },
          "value": {
            "description": "The value for the update operation. The type depends on the property and operation:\n- For \"image\": string\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).\nUse 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\")"
          }
        }
      },
      "Services.UpdateServiceGroupsRequestItem": {
        "type": "object",
        "required": [
          "prop",
          "op"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          },
          "id": {
            "type": "string",
            "description": "A client-provided identifier for tracking this operation in the response.",
            "example": "op-1"
          },
          "prop": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Services.MutableServiceGroupProperty"
              }
            ],
            "description": "The property to modify."
          },
          "op": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Services.MutableServiceGroupOperation"
              }
            ],
            "description": "The operation to perform."
          },
          "value": {
            "description": "The value for the update operation. The type depends on the property and operation:\n- For \"image\": string\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).\nUse 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\")"
          }
        },
        "description": "A single update operation to be applied to a service group."
      },
      "Services.UpdateServiceGroupsResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "service_groups": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Services.UpdateServiceGroupsResponseUpdatedServiceGroup"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for updating one or more service group(s) given their\nUUID(s) or name(s)."
      },
      "Services.UpdateServiceGroupsResponseUpdatedServiceGroup": {
        "type": "object",
        "required": [
          "uuid",
          "name",
          "status"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "id": {
            "type": "string",
            "description": "The client-provided ID from the request."
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code providing additional information about the status."
          }
        },
        "description": "Per-item result for an update service groups operation."
      },
      "Users.Quotas": {
        "type": "object",
        "required": [
          "uuid",
          "used",
          "hard",
          "limits"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the quota."
          },
          "used": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Users.QuotasStats"
              }
            ],
            "description": "Used quota."
          },
          "hard": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Users.QuotasStats"
              }
            ],
            "description": "Configured quota limits."
          },
          "limits": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Users.QuotasLimits"
              }
            ],
            "description": "Additional limits."
          }
        },
        "description": "Quotas with per-item response envelope fields merged in."
      },
      "Users.QuotasLimits": {
        "type": "object",
        "required": [
          "min_memory_mb",
          "max_memory_mb",
          "min_volume_mb",
          "max_volume_mb",
          "min_autoscale_size",
          "max_autoscale_size",
          "min_vcpus",
          "max_vcpus"
        ],
        "properties": {
          "min_memory_mb": {
            "type": "integer",
            "format": "int64",
            "description": "Minimum amount of memory assigned to live instances in megabytes",
            "example": 16
          },
          "max_memory_mb": {
            "type": "integer",
            "format": "int64",
            "description": "Maximum amount of memory assigned to live instances in megabytes",
            "example": 2048
          },
          "min_volume_mb": {
            "type": "integer",
            "format": "int64",
            "description": "Minimum size of a volume in megabytes",
            "example": 1
          },
          "max_volume_mb": {
            "type": "integer",
            "format": "int64",
            "description": "Maximum size of a volume in megabytes",
            "example": 1024
          },
          "min_autoscale_size": {
            "type": "integer",
            "format": "int64",
            "description": "Minimum size of an autoscale group",
            "example": 1
          },
          "max_autoscale_size": {
            "type": "integer",
            "format": "int64",
            "description": "Maximum size of an autoscale group",
            "example": 16
          },
          "min_vcpus": {
            "type": "integer",
            "format": "int64",
            "description": "Minimum number of vCPUs",
            "example": 2
          },
          "max_vcpus": {
            "type": "integer",
            "format": "int64",
            "description": "Maximum number of vCPUs",
            "example": 4
          }
        },
        "description": "Additional resource limits."
      },
      "Users.QuotasResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "quotas": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Users.Quotas"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for getting the quota of a user given their UUID."
      },
      "Users.QuotasStats": {
        "type": "object",
        "required": [
          "instances",
          "live_instances",
          "live_vcpus",
          "live_memory_mb",
          "service_groups",
          "services",
          "volumes",
          "total_volume_mb"
        ],
        "properties": {
          "instances": {
            "type": "integer",
            "format": "int64",
            "description": "Number of instances."
          },
          "live_instances": {
            "type": "integer",
            "format": "int64",
            "description": "Number of instances that are not in the stopped state."
          },
          "live_vcpus": {
            "type": "integer",
            "format": "int64",
            "description": "Number of vCPUs."
          },
          "live_memory_mb": {
            "type": "integer",
            "format": "int64",
            "description": "Amount of memory assigned to instances that are not in the `stopped` state\nin megabytes."
          },
          "service_groups": {
            "type": "integer",
            "format": "int64",
            "description": "Number of service groups."
          },
          "services": {
            "type": "integer",
            "format": "int64",
            "description": "Number of published network ports over all existing services."
          },
          "volumes": {
            "type": "integer",
            "format": "int64",
            "description": "Number of volumes."
          },
          "total_volume_mb": {
            "type": "integer",
            "format": "int64",
            "description": "Total size of all volumes in megabytes."
          }
        },
        "description": "Quota statistics for resource usage."
      },
      "Volumes.AttachVolumeByUUIDRequestBody": {
        "type": "object",
        "required": [
          "attach_to",
          "at"
        ],
        "properties": {
          "attach_to": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.NameOrUUID"
              }
            ],
            "description": "UUID or name of the instance to attach the volume to."
          },
          "at": {
            "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.",
            "example": "/mnt/my-volume"
          },
          "readonly": {
            "type": "boolean",
            "description": "Whether the volume should be mounted read-only.",
            "example": false
          }
        }
      },
      "Volumes.AttachVolumesRequestItem": {
        "type": "object",
        "required": [
          "attach_to",
          "at"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          },
          "attach_to": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.NameOrUUID"
              }
            ],
            "description": "UUID or name of the instance to attach the volume to."
          },
          "at": {
            "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.",
            "example": "/mnt/my-volume"
          },
          "readonly": {
            "type": "boolean",
            "description": "Whether the volume should be mounted read-only.",
            "example": false
          }
        },
        "description": "A single request item to attach a volume to an instance."
      },
      "Volumes.AttachVolumesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "volumes": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Volumes.AttachVolumesResponseAttachedVolume"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for attaching one or more volume(s) given their\nUUID(s) or name(s)."
      },
      "Volumes.AttachVolumesResponseAttachedVolume": {
        "type": "object",
        "required": [
          "status",
          "uuid",
          "name"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          }
        },
        "description": "Per-item result for an attach volumes operation."
      },
      "Volumes.CloneVolumeByUUIDRequestBody": {
        "type": "object",
        "properties": {
          "vol_name": {
            "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.",
            "example": "funky-vol-t7qumh5j"
          },
          "quota_policy": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Volumes.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."
          },
          "access_mode": {
            "$ref": "#/components/schemas/Volumes.VolumeAccessMode"
          }
        }
      },
      "Volumes.CloneVolumesRequestItem": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          },
          "vol_name": {
            "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.",
            "example": "funky-vol-t7qumh5j"
          },
          "quota_policy": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Volumes.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."
          },
          "access_mode": {
            "$ref": "#/components/schemas/Volumes.VolumeAccessMode"
          }
        },
        "description": "A single request item to clone a volume."
      },
      "Volumes.CloneVolumesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "volumes": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Volumes.CloneVolumesResponseVolume"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for cloning one or more volume(s) given their UUID(s)\nor name(s)."
      },
      "Volumes.CloneVolumesResponseVolume": {
        "type": "object",
        "required": [
          "status",
          "uuid",
          "name",
          "state"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Volumes.VolumeState"
              }
            ],
            "description": "The state of the volume."
          }
        },
        "description": "Per-item result for a clone volumes operation."
      },
      "Volumes.CreateTemplateVolumesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "volumes": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Volumes.CreateTemplateVolumesResponseTemplateVolume"
                },
                "description": "The volume(s) which were attached by the request."
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for converting one or more volume(s) to templates."
      },
      "Volumes.CreateTemplateVolumesResponseTemplateVolume": {
        "type": "object",
        "required": [
          "status",
          "uuid",
          "name",
          "state"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Volumes.VolumeState"
              }
            ],
            "description": "The state of the volume."
          }
        },
        "description": "Per-item result for a create template volume operation."
      },
      "Volumes.CreateVolumeRequest": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "size_mb": {
            "type": "integer",
            "format": "uint64"
          },
          "host_path": {
            "type": "string"
          },
          "template": {
            "$ref": "#/components/schemas/Common.NameOrUUID"
          },
          "quota_policy": {
            "$ref": "#/components/schemas/Volumes.VolumeQuotaPolicy"
          },
          "filesystem": {
            "type": "string"
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "uid": {
            "type": "integer",
            "format": "uint32"
          },
          "gid": {
            "type": "integer",
            "format": "uint32"
          },
          "access_mode": {
            "$ref": "#/components/schemas/Volumes.VolumeAccessMode"
          },
          "args": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "description": "The request message for creating a volume.",
        "oneOf": [
          {
            "required": [
              "size_mb"
            ]
          },
          {
            "required": [
              "host_path"
            ]
          },
          {
            "required": [
              "template"
            ]
          }
        ]
      },
      "Volumes.CreateVolumeResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "volumes": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Volumes.CreateVolumeResponseVolume"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for creating a volume."
      },
      "Volumes.CreateVolumeResponseVolume": {
        "type": "object",
        "required": [
          "status",
          "uuid",
          "name",
          "state"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Volumes.VolumeState"
              }
            ],
            "description": "The state of the volume."
          }
        },
        "description": "Per-item result for a create volume operation."
      },
      "Volumes.DeleteTemplateVolumesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "volumes": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Volumes.DeleteTemplateVolumesResponseTemplateVolume"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for deleting one or more template volume(s) given\ntheir UUID(s) or name(s)."
      },
      "Volumes.DeleteTemplateVolumesResponseTemplateVolume": {
        "type": "object",
        "required": [
          "status",
          "uuid",
          "name"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          }
        },
        "description": "Per-item result for a delete template volumes operation."
      },
      "Volumes.DeleteVolumesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "volumes": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Volumes.DeleteVolumesResponseDeletedVolume"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for deleting one or more volume(s) given their\nUUID(s) or name(s)."
      },
      "Volumes.DeleteVolumesResponseDeletedVolume": {
        "type": "object",
        "required": [
          "status",
          "uuid",
          "name"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          }
        },
        "description": "Per-item result for a delete volumes operation."
      },
      "Volumes.DetachVolumeByUUIDRequestBody": {
        "type": "object",
        "properties": {
          "from": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.NameOrUUID"
              }
            ],
            "description": "UUID or name of the instance to detach the volume from. If not specified,\nthe volume is detached from all instances."
          }
        }
      },
      "Volumes.DetachVolumesRequestItem": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          },
          "from": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.NameOrUUID"
              }
            ],
            "description": "UUID or name of the instance to detach the volume from. If not specified,\nthe volume is detached from all instances."
          }
        },
        "description": "A single request item to detach a volume from an instance."
      },
      "Volumes.DetachVolumesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "volumes": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Volumes.DetachVolumesResponseDetachedVolume"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for detaching one or more volume(s) given their\nUUID(s) or name(s)."
      },
      "Volumes.DetachVolumesResponseDetachedVolume": {
        "type": "object",
        "required": [
          "status",
          "uuid",
          "name"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          }
        },
        "description": "Per-item result for a detach volumes operation."
      },
      "Volumes.GetTemplateVolumesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "volumes": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Volumes.Volume"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for getting one or more template volume(s) given their\nUUID(s) or name(s)."
      },
      "Volumes.GetVolumesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "volumes": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Volumes.Volume"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for getting one or more volume(s) given their UUID(s)\nor name(s)."
      },
      "Volumes.MutableTemplateVolumeOperation": {
        "type": "string",
        "enum": [
          "set",
          "add",
          "del"
        ],
        "description": "Mutable template volume operations."
      },
      "Volumes.MutableTemplateVolumeProperty": {
        "type": "string",
        "enum": [
          "tags",
          "delete_lock"
        ],
        "description": "Mutable template volume properties."
      },
      "Volumes.MutableVolumeOperation": {
        "type": "string",
        "enum": [
          "set",
          "add",
          "del"
        ],
        "description": "Mutable volume operations."
      },
      "Volumes.MutableVolumeProperty": {
        "type": "string",
        "enum": [
          "size_mb",
          "tags",
          "quota_policy",
          "delete_lock"
        ],
        "description": "Mutable volume properties."
      },
      "Volumes.UpdateTemplateVolumeByUUIDRequestBody": {
        "type": "object",
        "required": [
          "prop",
          "op"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "A client-provided identifier for tracking this operation in the response.",
            "example": "op-1"
          },
          "prop": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Volumes.MutableTemplateVolumeProperty"
              }
            ],
            "description": "The property to modify."
          },
          "op": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Volumes.MutableTemplateVolumeOperation"
              }
            ],
            "description": "The operation to perform."
          },
          "value": {
            "description": "The value for the update operation. The type depends on the property and operation:\n- For \"image\": string\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).\nUse 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\")"
          }
        }
      },
      "Volumes.UpdateTemplateVolumesRequestItem": {
        "type": "object",
        "required": [
          "prop",
          "op"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          },
          "id": {
            "type": "string",
            "description": "A client-provided identifier for tracking this operation in the response.",
            "example": "op-1"
          },
          "prop": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Volumes.MutableTemplateVolumeProperty"
              }
            ],
            "description": "The property to modify."
          },
          "op": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Volumes.MutableTemplateVolumeOperation"
              }
            ],
            "description": "The operation to perform."
          },
          "value": {
            "description": "The value for the update operation. The type depends on the property and operation:\n- For \"image\": string\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).\nUse 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\")"
          }
        },
        "description": "A single update operation to be applied to a template volume."
      },
      "Volumes.UpdateTemplateVolumesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "volumes": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Volumes.UpdateTemplateVolumesResponseTemplateVolume"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for updating one or more template volume(s) given\ntheir UUID(s) or name(s)."
      },
      "Volumes.UpdateTemplateVolumesResponseTemplateVolume": {
        "type": "object",
        "required": [
          "status",
          "uuid",
          "name"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "id": {
            "type": "string",
            "description": "The client-provided ID from the request."
          }
        },
        "description": "Per-item result for an update template volumes operation."
      },
      "Volumes.UpdateVolumeByUUIDRequestBody": {
        "type": "object",
        "required": [
          "prop",
          "op"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "A client-provided identifier for tracking this operation in the response.",
            "example": "op-1"
          },
          "prop": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Volumes.MutableVolumeProperty"
              }
            ],
            "description": "The property to modify."
          },
          "op": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Volumes.MutableVolumeOperation"
              }
            ],
            "description": "The operation to perform."
          },
          "value": {
            "description": "The value for the update operation. The type depends on the property and operation:\n- For \"image\": string\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).\nUse 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\")"
          }
        }
      },
      "Volumes.UpdateVolumesRequestItem": {
        "type": "object",
        "required": [
          "prop",
          "op"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The name of the resource."
          },
          "id": {
            "type": "string",
            "description": "A client-provided identifier for tracking this operation in the response.",
            "example": "op-1"
          },
          "prop": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Volumes.MutableVolumeProperty"
              }
            ],
            "description": "The property to modify."
          },
          "op": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Volumes.MutableVolumeOperation"
              }
            ],
            "description": "The operation to perform."
          },
          "value": {
            "description": "The value for the update operation. The type depends on the property and operation:\n- For \"image\": string\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).\nUse 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\")"
          }
        },
        "description": "A single update operation to be applied to a volume."
      },
      "Volumes.UpdateVolumesResponse": {
        "type": "object",
        "required": [
          "status",
          "op_time_us"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "The status of the response."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information about the status."
          },
          "data": {
            "type": "object",
            "properties": {
              "volumes": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Volumes.UpdateVolumesResponseUpdatedVolume"
                }
              }
            },
            "description": "The response data for this request."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Common.ResponseError"
            },
            "description": "A list of errors which may have occurred during the request."
          },
          "op_time_us": {
            "type": "integer",
            "format": "uint64",
            "description": "The operation time in microseconds."
          }
        },
        "description": "The response message for updating one or more volume(s) given their\nUUID(s) or name(s)."
      },
      "Volumes.UpdateVolumesResponseUpdatedVolume": {
        "type": "object",
        "required": [
          "status",
          "uuid",
          "name"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "id": {
            "type": "string",
            "description": "The client-provided ID from the request."
          }
        },
        "description": "Per-item result for an update volumes operation."
      },
      "Volumes.Volume": {
        "type": "object",
        "required": [
          "uuid",
          "name",
          "created_at",
          "state",
          "size_mb",
          "persistent",
          "quota_policy"
        ],
        "properties": {
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Common.ResponseStatus"
              }
            ],
            "description": "Indicates whether the operation was successful for this item."
          },
          "message": {
            "type": "string",
            "description": "An optional message providing additional information."
          },
          "error": {
            "type": "integer",
            "format": "int32",
            "description": "An optional error code."
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the resource."
          },
          "name": {
            "type": "string",
            "description": "The human-readable name of the resource."
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "The time the volume was created."
          },
          "state": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Volumes.VolumeState"
              }
            ],
            "description": "Current state of the volume."
          },
          "size_mb": {
            "type": "integer",
            "format": "uint64",
            "description": "The size of the volume in megabytes.",
            "example": 64
          },
          "persistent": {
            "type": "boolean",
            "description": "Indicates if the volume will stay alive when the last instance is deleted\nthat this volume is attached to.",
            "example": true
          },
          "attached_to": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Volumes.VolumeInstanceID"
            },
            "description": "List of instances that this volume is attached to."
          },
          "mounted_by": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Volumes.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."
          },
          "quota_policy": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Volumes.VolumeQuotaPolicy"
              }
            ],
            "description": "Either static or dynamic reservation."
          },
          "delete_lock": {
            "type": "boolean",
            "description": "If set to true, the volume cannot be deleted.",
            "example": false
          },
          "free_mb": {
            "type": "integer",
            "format": "uint32",
            "description": "The amount of free space in the volume in megabytes.",
            "example": 32
          },
          "filesystem": {
            "type": "string",
            "description": "The filesystem type of this volume.\nWithout custom configuration, this is either `ext4` or `virtiofs`.",
            "example": "ext4"
          },
          "host_path": {
            "type": "string",
            "description": "Host path backing this managed volume.\nThis field is only available for managed volumes and users with\nappropriate permissions.",
            "example": "/usr/lib/unikraft/volumes/my-vol"
          },
          "access_mode": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Volumes.VolumeAccessMode"
              }
            ],
            "description": "The access mode of the volume, controlling volume sharing behavior.\nDefaults to `rwo` if not specified."
          },
          "uid": {
            "type": "integer",
            "format": "uint32",
            "description": "Guest UID for managed volumes (host_path mode only)."
          },
          "gid": {
            "type": "integer",
            "format": "uint32",
            "description": "Guest GID for managed volumes (host_path mode only)."
          },
          "args": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Optional script arguments that were applied to the custom volume filesystem\ninitialization scripts.",
            "example": {
              "arg1": "value1",
              "arg2": "value2"
            }
          }
        },
        "description": "A volume represents a storage device that can be attached to an instance."
      },
      "Volumes.VolumeAccessMode": {
        "type": "string",
        "enum": [
          "rwo",
          "rox",
          "rwx"
        ],
        "description": "VolumeAccessMode defines the access mode of a volume, which controls sharing\nbehavior and caching strategy."
      },
      "Volumes.VolumeInstanceID": {
        "type": "object",
        "required": [
          "uuid"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "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.",
            "example": "12345678-90ab-cdef-1234-567890abcdef"
          },
          "name": {
            "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.",
            "example": "funky-vol-g7gum5cj"
          }
        },
        "description": "An instance a volume is attached to."
      },
      "Volumes.VolumeInstanceMount": {
        "type": "object",
        "required": [
          "uuid",
          "name",
          "readonly"
        ],
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the instance that the volume is mounted in."
          },
          "name": {
            "type": "string",
            "description": "The name of the instance that the volume is mounted in."
          },
          "readonly": {
            "type": "boolean",
            "description": "Whether the volume is mounted read-only or read-write."
          }
        },
        "description": "An instance mount of a volume."
      },
      "Volumes.VolumeQuotaPolicy": {
        "type": "string",
        "enum": [
          "static",
          "dynamic"
        ],
        "description": "Quota policy for a volume."
      },
      "Volumes.VolumeState": {
        "type": "string",
        "enum": [
          "uninitialized",
          "initializing",
          "available",
          "idle",
          "mounted",
          "busy",
          "error",
          "template"
        ],
        "description": "VolumeState defines the state of a volume at a given moment."
      }
    },
    "securitySchemes": {
      "bearerToken": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "servers": [
    {
      "url": "https://api.sfo.unikraft.cloud",
      "description": "San Francisco, CA, USA",
      "variables": {}
    },
    {
      "url": "https://api.was.unikraft.cloud",
      "description": "Washington, DC, USA",
      "variables": {}
    },
    {
      "url": "https://api.sin.unikraft.cloud",
      "description": "Singapore",
      "variables": {}
    },
    {
      "url": "https://api.dal.unikraft.cloud",
      "description": "Dallas, TX, USA",
      "variables": {}
    },
    {
      "url": "https://api.fra.unikraft.cloud",
      "description": "Frankfurt, DE",
      "variables": {}
    }
  ]
}