{
 "openapi": "3.1.0",
 "info": {
  "title": "IBEE Solutions API",
  "version": "0.5.0",
  "description": "Public API reference for IBEE Solutions.\n\nAuthenticate with a platform API token and pass a `workspace_id` query\nparameter to scope requests to a specific workspace.\n"
 },
 "servers": [
  {
   "url": "https://api.ibee.ai/v1",
   "description": "IBEE production API gateway",
   "x-fern-server-name": "Production"
  },
  {
   "url": "https://api.ibee.co.in/v1",
   "description": "IBEE development API gateway",
   "x-fern-server-name": "Development"
  }
 ],
 "tags": [
  {
   "name": "Secret Store",
   "description": "Manage secret stores, values, versions, application identities, and access scopes inside a workspace."
  },
  {
   "name": "Object Storage",
   "description": "Manage object storage buckets and bucket configuration."
  },
  {
   "name": "Vpcs",
   "description": "Build isolated virtual networks, subnets, NAT gateways, and VM attachments.",
   "x-fern-display-name": "VPCs",
   "x-displayName": "VPCs"
  },
  {
   "name": "ReservedIps",
   "description": "Reserve and attach portable public IPv4 addresses.",
   "x-fern-display-name": "Reserved IPs",
   "x-displayName": "Reserved IPs"
  },
  {
   "name": "Firewalls",
   "description": "Manage stateful firewall groups, rules, and VM attachments."
  },
  {
   "name": "LoadBalancers",
   "description": "Manage L4 and L7 load balancers.",
   "x-fern-display-name": "Load Balancers",
   "x-displayName": "Load Balancers"
  },
  {
   "name": "ComputeCatalog",
   "description": "Discover sites, plans, and images accepted by VM creation.",
   "x-fern-display-name": "Compute Catalog",
   "x-displayName": "Compute Catalog"
  },
  {
   "name": "Billing",
   "description": "Check current billing eligibility for a billable resource."
  },
  {
   "name": "BlockStorage",
   "description": "Manage standalone persistent block-storage volumes using the same product flow as the portal.",
   "x-fern-display-name": "Block Storage",
   "x-displayName": "Block Storage"
  },
  {
   "name": "Cdn",
   "description": "Manage CDN distributions, static websites, custom domains, URLs, and cache purges.",
   "x-fern-display-name": "CDN",
   "x-displayName": "CDN"
  },
  {
   "name": "ContainerRegistry",
   "description": "Manage container registries, storage plans, registry access tokens, repositories, images, vulnerability findings, SBOMs, and usage metrics.",
   "x-fern-display-name": "Container Registry",
   "x-displayName": "Container Registry"
  },
  {
   "name": "CloudVms",
   "description": "Deploy and manage cloud virtual machines.",
   "x-fern-display-name": "Cloud VMs",
   "x-displayName": "Cloud VMs"
  },
  {
   "name": "GpuVms",
   "description": "Deploy and manage GPU-accelerated virtual machines.",
   "x-fern-display-name": "GPU VMs",
   "x-displayName": "GPU VMs"
  },
  {
   "name": "VmConsole",
   "description": "Create and manage short-lived graphical VM console sessions.",
   "x-fern-display-name": "VM Console",
   "x-displayName": "VM Console"
  }
 ],
 "security": [
  {
   "IbeeApiToken": []
  }
 ],
 "paths": {
  "/secret-store/stores": {
   "get": {
    "tags": [
     "Secret Store"
    ],
    "summary": "List secret stores",
    "description": "Lists secret stores in a workspace. Requires scope: secret-store.read.",
    "operationId": "listSecretStores",
    "x-ibee-required-scope": "secret-store.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/Page"
     },
     {
      "$ref": "#/components/parameters/Limit"
     },
     {
      "name": "include_archived",
      "in": "query",
      "required": false,
      "schema": {
       "type": "boolean",
       "default": false
      },
      "description": "Include archived stores in the result."
     }
    ],
    "responses": {
     "200": {
      "description": "Stores returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretStoreList"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "post": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Create secret store",
    "description": "Creates a secret store in a workspace. Requires scope: secret-store.write.",
    "operationId": "createSecretStore",
    "x-ibee-required-scope": "secret-store.write",
    "x-ibee-billing-admission": "required",
    "x-ibee-billing-sku-source": "fixed",
    "x-ibee-billing-sku": "SECRETMA-STD",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/CreateSecretStoreRequest"
       },
       "example": {
        "name": "production-secrets",
        "description": "Secrets for production workloads"
       }
      }
     }
    },
    "responses": {
     "201": {
      "description": "Store created successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretStore"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "402": {
      "$ref": "#/components/responses/PaymentRequired"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/stores/{store_id}": {
   "get": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Get secret store",
    "description": "Gets one secret store. Requires scope: secret-store.read.",
    "operationId": "getSecretStore",
    "x-ibee-required-scope": "secret-store.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/StoreId"
     }
    ],
    "responses": {
     "200": {
      "description": "Store returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretStore"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "patch": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Update secret store",
    "description": "Updates store name or description. Requires scope: secret-store.write.",
    "operationId": "updateSecretStore",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/StoreId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/UpdateSecretStoreRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Store updated successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretStore"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/stores/{store_id}/archive": {
   "post": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Archive secret store",
    "description": "Archives a secret store. Requires scope: secret-store.write.",
    "operationId": "archiveSecretStore",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/StoreId"
     }
    ],
    "responses": {
     "200": {
      "description": "Store archived successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretStore"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/stores/{store_id}/unarchive": {
   "post": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Unarchive secret store",
    "description": "Reactivates an archived secret store. Requires scope: secret-store.write.",
    "operationId": "unarchiveSecretStore",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/StoreId"
     }
    ],
    "responses": {
     "200": {
      "description": "Store reactivated successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretStore"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/stores/{store_id}/permanent": {
   "delete": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Permanently delete secret store",
    "description": "Irreversibly deletes a store and all store-scoped secrets, versions, identities, and policies. Requires scope: secret-store.write.",
    "operationId": "permanentlyDeleteSecretStore",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/StoreId"
     }
    ],
    "responses": {
     "200": {
      "description": "Store and its resources permanently deleted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretLifecycleStatus"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/stores/{store_id}/secrets": {
   "get": {
    "tags": [
     "Secret Store"
    ],
    "summary": "List secrets",
    "description": "Lists secret metadata in a store. Secret values are not returned. Requires scope: secret-store.read.",
    "operationId": "listSecrets",
    "x-ibee-required-scope": "secret-store.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/StoreId"
     },
     {
      "name": "q",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string",
       "maxLength": 128
      },
      "description": "Optional search query."
     },
     {
      "$ref": "#/components/parameters/Page"
     },
     {
      "$ref": "#/components/parameters/Limit"
     }
    ],
    "responses": {
     "200": {
      "description": "Secrets returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretList"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "post": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Create secret",
    "description": "Creates a secret in a store. Requires scope: secret-store.write.",
    "operationId": "createSecret",
    "x-ibee-required-scope": "secret-store.write",
    "x-ibee-billing-admission": "required",
    "x-ibee-billing-sku-source": "fixed",
    "x-ibee-billing-sku": "SECRETMA-STD",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/StoreId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/CreateSecretRequest"
       },
       "example": {
        "secret_name": "database-url",
        "value": {
         "url": "postgres://user:pass@host:5432/mydb"
        }
       }
      }
     }
    },
    "responses": {
     "201": {
      "description": "Secret created successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/Secret"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "402": {
      "$ref": "#/components/responses/PaymentRequired"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/stores/{store_id}/secrets:batchIngest": {
   "post": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Batch-create secrets",
    "description": "Creates up to 500 secrets without overwriting existing names. Requires scope: secret-store.write.",
    "operationId": "batchCreateSecrets",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/StoreId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/BatchCreateSecretsRequest"
       },
       "example": {
        "secrets": [
         {
          "secret_name": "database-url",
          "value": {
           "url": "postgres://user:pass@host:5432/app"
          }
         },
         {
          "secret_name": "api-key",
          "value": {
           "key": "replace-with-your-value"
          }
         }
        ]
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Batch processed; inspect each result for created, skipped, or failed status.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BatchCreateSecretsResponse"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/secrets/{secret_id}": {
   "get": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Get secret metadata",
    "description": "Gets one secret metadata record. Secret value is not returned. Requires scope: secret-store.read.",
    "operationId": "getSecret",
    "x-ibee-required-scope": "secret-store.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/SecretId"
     }
    ],
    "responses": {
     "200": {
      "description": "Secret returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/Secret"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "delete": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Delete secret",
    "description": "Soft-deletes a secret. Requires scope: secret-store.write.",
    "operationId": "deleteSecret",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/SecretId"
     }
    ],
    "responses": {
     "200": {
      "description": "Secret deleted successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/Secret"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/secrets/{secret_id}/value": {
   "get": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Get secret value",
    "description": "Gets the latest value for a secret. Requires scope: secret-store.read.",
    "operationId": "getSecretValue",
    "x-ibee-required-scope": "secret-store.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/SecretId"
     }
    ],
    "responses": {
     "200": {
      "description": "Secret value returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretValue"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "put": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Replace secret value",
    "description": "Creates a new version of the secret value. Requires scope: secret-store.write.",
    "operationId": "updateSecretValue",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/SecretId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/UpdateSecretValueRequest"
       },
       "example": {
        "value": {
         "url": "postgres://user:updated@host:5432/mydb"
        },
        "cas": 1
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Secret value updated successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretValue"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "patch": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Patch secret value",
    "description": "Merges the supplied keys into the current value and creates a new version. Requires scope: secret-store.write.",
    "operationId": "patchSecretValue",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/SecretId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/PatchSecretValueRequest"
       },
       "example": {
        "value": {
         "username": "rotated-user"
        }
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Secret value patched successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretValue"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/secrets/{secret_id}/undelete": {
   "post": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Undelete secret versions",
    "description": "Restores specified soft-deleted versions and reactivates the secret. Requires scope: secret-store.write.",
    "operationId": "undeleteSecret",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/SecretId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/SecretVersionsRequest"
       },
       "example": {
        "versions": [
         2
        ]
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Secret versions restored successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/Secret"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/secrets/{secret_id}/destroy": {
   "post": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Destroy secret versions",
    "description": "Irreversibly destroys specified secret versions. Requires scope: secret-store.write.",
    "operationId": "destroySecretVersions",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/SecretId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/SecretVersionsRequest"
       },
       "example": {
        "versions": [
         1
        ]
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Secret versions permanently destroyed.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretLifecycleStatus"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/secrets/{secret_id}/permanent": {
   "delete": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Permanently delete secret",
    "description": "Irreversibly deletes all versions and metadata for a secret. Requires scope: secret-store.write.",
    "operationId": "permanentlyDeleteSecret",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/SecretId"
     }
    ],
    "responses": {
     "200": {
      "description": "Secret permanently deleted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretLifecycleStatus"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/secrets/{secret_id}/versions": {
   "get": {
    "tags": [
     "Secret Store"
    ],
    "summary": "List secret versions",
    "description": "Returns version metadata without secret values. Requires scope: secret-store.read.",
    "operationId": "listSecretVersions",
    "x-ibee-required-scope": "secret-store.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/SecretId"
     }
    ],
    "responses": {
     "200": {
      "description": "Secret version metadata returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretVersions"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/secrets/{secret_id}/versions/{version}": {
   "get": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Get secret version",
    "description": "Returns the value and metadata for one secret version. Requires scope: secret-store.read.",
    "operationId": "getSecretVersion",
    "x-ibee-required-scope": "secret-store.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/SecretId"
     },
     {
      "$ref": "#/components/parameters/SecretVersion"
     }
    ],
    "responses": {
     "200": {
      "description": "Secret version returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretVersion"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/secrets/{secret_id}/rollback": {
   "post": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Roll back secret value",
    "description": "Copies a previous version into a new current version. Requires scope: secret-store.write.",
    "operationId": "rollbackSecret",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/SecretId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/RollbackSecretRequest"
       },
       "example": {
        "version": 1
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Previous value copied into a new current version.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretValue"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/stores/{store_id}/identities": {
   "get": {
    "tags": [
     "Secret Store"
    ],
    "summary": "List application identities",
    "description": "Lists AppRole and Kubernetes identities bound to a store. Requires scope: secret-store.read.",
    "operationId": "listSecretIdentities",
    "x-ibee-required-scope": "secret-store.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/StoreId"
     }
    ],
    "responses": {
     "200": {
      "description": "Identities returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretIdentityList"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "post": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Create application identity",
    "description": "Creates an AppRole or Kubernetes identity with an initial scope for this store. Requires scope: secret-store.write.",
    "operationId": "createSecretIdentity",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/StoreId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/CreateSecretIdentityRequest"
       },
       "examples": {
        "approle": {
         "summary": "AppRole identity for a VM or script",
         "value": {
          "auth_method": "approle",
          "name": "payments-api",
          "token_policy_mode": "read_only"
         }
        },
        "kubernetes": {
         "summary": "Kubernetes workload identity",
         "value": {
          "auth_method": "kubernetes",
          "name": "payments-worker",
          "token_policy_mode": "read_only",
          "k8s_namespace": "production",
          "k8s_service_account": "payments-worker"
         }
        }
       }
      }
     }
    },
    "responses": {
     "201": {
      "description": "Identity created successfully. Fetch access details separately.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretIdentity"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/identities/{identity_id}": {
   "get": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Get application identity",
    "description": "Gets one application identity without credentials. Requires scope: secret-store.read.",
    "operationId": "getSecretIdentity",
    "x-ibee-required-scope": "secret-store.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/IdentityId"
     }
    ],
    "responses": {
     "200": {
      "description": "Identity returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretIdentity"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "patch": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Update application identity",
    "description": "Updates the token policy mode. Identity names cannot be changed after creation. Requires scope: secret-store.write.",
    "operationId": "updateSecretIdentity",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/IdentityId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/UpdateSecretIdentityRequest"
       },
       "example": {
        "token_policy_mode": "read_write"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Identity updated successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretIdentity"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "delete": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Delete application identity",
    "description": "Permanently removes the identity, its scopes, role, policy, and sessions. Requires scope: secret-store.write.",
    "operationId": "deleteSecretIdentity",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/IdentityId"
     }
    ],
    "responses": {
     "200": {
      "description": "Identity deleted successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretIdentityActionStatus"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/identities/{identity_id}/disable": {
   "post": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Disable application identity",
    "description": "Disables an identity and revokes its active sessions. Requires scope: secret-store.write.",
    "operationId": "disableSecretIdentity",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/IdentityId"
     }
    ],
    "responses": {
     "200": {
      "description": "Identity disabled successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretIdentity"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/identities/{identity_id}/enable": {
   "post": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Enable application identity",
    "description": "Re-enables a disabled identity. Requires scope: secret-store.write.",
    "operationId": "enableSecretIdentity",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/IdentityId"
     }
    ],
    "responses": {
     "200": {
      "description": "Identity enabled successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretIdentity"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/identities/{identity_id}/access": {
   "get": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Get application identity access details",
    "description": "Returns Kubernetes binding details or generates fresh AppRole credentials. Treat secret_id as sensitive. Each call for an AppRole identity mints a new credential, so the gateway treats this GET as a write. Requires scope: secret-store.write.",
    "operationId": "getSecretIdentityAccess",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/IdentityId"
     }
    ],
    "responses": {
     "200": {
      "description": "Access details returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretIdentityAccess"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/identities/{identity_id}/rotate-secret-id": {
   "post": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Rotate AppRole secret ID",
    "description": "Generates fresh AppRole credentials. Available only for AppRole identities. Requires scope: secret-store.write.",
    "operationId": "rotateSecretIdentitySecretId",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/IdentityId"
     }
    ],
    "responses": {
     "200": {
      "description": "Fresh AppRole access details returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretIdentityAccess"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/identities/{identity_id}/revoke": {
   "post": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Revoke application identity sessions",
    "description": "Revokes active sessions without deleting or disabling the identity. Requires scope: secret-store.write.",
    "operationId": "revokeSecretIdentitySessions",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/IdentityId"
     }
    ],
    "responses": {
     "200": {
      "description": "Identity sessions revoked successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretIdentityActionStatus"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/identities/{identity_id}/scopes": {
   "get": {
    "tags": [
     "Secret Store"
    ],
    "summary": "List application identity scopes",
    "description": "Lists the stores and permissions available to an identity. Requires scope: secret-store.read.",
    "operationId": "listSecretIdentityScopes",
    "x-ibee-required-scope": "secret-store.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/IdentityId"
     }
    ],
    "responses": {
     "200": {
      "description": "Scopes returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretIdentityScopeList"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "post": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Add application identity scope",
    "description": "Grants an identity access to another store. Requires scope: secret-store.write.",
    "operationId": "createSecretIdentityScope",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/IdentityId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/CreateSecretIdentityScopeRequest"
       },
       "example": {
        "store_id": "019f1e4b-3edd-72cf-b90e-26864ba2f283",
        "access_mode": "read_only",
        "allow_version_read": true,
        "allow_rollback": false,
        "allow_destroy": false
       }
      }
     }
    },
    "responses": {
     "201": {
      "description": "Scope created successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretIdentityScope"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/secret-store/scopes/{scope_id}": {
   "patch": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Update application identity scope",
    "description": "Updates store access and version permissions for a scope. Requires scope: secret-store.write.",
    "operationId": "updateSecretIdentityScope",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/ScopeId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/UpdateSecretIdentityScopeRequest"
       },
       "example": {
        "access_mode": "read_write",
        "allow_version_read": true,
        "allow_rollback": true,
        "allow_destroy": false
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Scope updated successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretIdentityScope"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "delete": {
    "tags": [
     "Secret Store"
    ],
    "summary": "Delete application identity scope",
    "description": "Removes a store permission from an identity. Requires scope: secret-store.write.",
    "operationId": "deleteSecretIdentityScope",
    "x-ibee-required-scope": "secret-store.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/ScopeId"
     }
    ],
    "responses": {
     "200": {
      "description": "Scope deleted successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SecretIdentityActionStatus"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/object-storage/buckets": {
   "get": {
    "tags": [
     "Object Storage"
    ],
    "summary": "List buckets",
    "description": "Lists object storage buckets in a workspace. Requires scope: object-storage.read.",
    "operationId": "listBuckets",
    "x-ibee-required-scope": "object-storage.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
       "type": "integer",
       "minimum": 1,
       "maximum": 1000,
       "default": 100
      },
      "description": "Maximum number of buckets to return."
     },
     {
      "name": "continuation_token",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string"
      },
      "description": "Pagination token from the previous response."
     }
    ],
    "responses": {
     "200": {
      "description": "Buckets returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BucketList"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "post": {
    "tags": [
     "Object Storage"
    ],
    "summary": "Create bucket",
    "description": "Creates an object storage bucket. `region` is required and must match an Object Storage region identifier configured for the target environment. Do not send a compute `site_id`. Requires scope: object-storage.write.",
    "operationId": "createBucket",
    "x-ibee-required-scope": "object-storage.write",
    "x-ibee-billing-admission": "required",
    "x-ibee-billing-sku-source": "fixed",
    "x-ibee-billing-sku": "OBJECTST-STD",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/CreateBucketRequest"
       },
       "example": {
        "name": "production-assets",
        "region": "in-south-2",
        "is_public": false
       }
      }
     }
    },
    "responses": {
     "201": {
      "description": "Bucket created successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/Bucket"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "402": {
      "$ref": "#/components/responses/PaymentRequired"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/object-storage/buckets/{bucket_name}": {
   "get": {
    "tags": [
     "Object Storage"
    ],
    "summary": "Get bucket",
    "description": "Returns bucket configuration and usage statistics. Requires scope: object-storage.read.",
    "operationId": "getBucket",
    "x-ibee-required-scope": "object-storage.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/BucketName"
     }
    ],
    "responses": {
     "200": {
      "description": "Bucket returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/Bucket"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "patch": {
    "tags": [
     "Object Storage"
    ],
    "summary": "Update bucket settings",
    "description": "Updates mutable bucket settings. Requires scope: object-storage.write.",
    "operationId": "updateBucket",
    "x-ibee-required-scope": "object-storage.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/BucketName"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/UpdateBucketRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Bucket updated successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/Bucket"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "delete": {
    "tags": [
     "Object Storage"
    ],
    "summary": "Delete bucket",
    "description": "Deletes a bucket and all of its contents. Requires scope: object-storage.delete.",
    "operationId": "deleteBucket",
    "x-ibee-required-scope": "object-storage.delete",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/BucketName"
     }
    ],
    "responses": {
     "200": {
      "description": "Bucket deleted successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/DeleteResponse"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/object-storage/credentials": {
   "get": {
    "tags": [
     "Object Storage"
    ],
    "summary": "List S3 credentials",
    "description": "Lists S3-compatible credentials without secret keys. Requires scope: object-storage.read.",
    "operationId": "listS3Credentials",
    "x-ibee-required-scope": "object-storage.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     }
    ],
    "responses": {
     "200": {
      "description": "Credentials returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/S3CredentialList"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "post": {
    "tags": [
     "Object Storage"
    ],
    "summary": "Create S3 credential",
    "description": "Creates an access key pair. The secret is returned only once. Requires scope: object-storage.write.",
    "operationId": "createS3Credential",
    "x-ibee-required-scope": "object-storage.write",
    "x-ibee-billing-admission": "required",
    "x-ibee-billing-sku-source": "fixed",
    "x-ibee-billing-sku": "OBJECTST-STD",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     }
    ],
    "requestBody": {
     "required": false,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/CreateS3CredentialRequest"
       }
      }
     }
    },
    "responses": {
     "201": {
      "description": "Credential created successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/S3CredentialCreated"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "402": {
      "$ref": "#/components/responses/PaymentRequired"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/object-storage/credentials/{access_key_id}": {
   "get": {
    "tags": [
     "Object Storage"
    ],
    "summary": "Get S3 credential",
    "description": "Returns credential metadata without the secret key. Requires scope: object-storage.read.",
    "operationId": "getS3Credential",
    "x-ibee-required-scope": "object-storage.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/AccessKeyId"
     }
    ],
    "responses": {
     "200": {
      "description": "Credential returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/S3Credential"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "delete": {
    "tags": [
     "Object Storage"
    ],
    "summary": "Revoke S3 credential",
    "description": "Revokes a credential so it can no longer authenticate S3 requests. Requires scope: object-storage.write.",
    "operationId": "revokeS3Credential",
    "x-ibee-required-scope": "object-storage.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/AccessKeyId"
     }
    ],
    "responses": {
     "200": {
      "description": "Credential revoked successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/S3CredentialRevoked"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/sites": {
   "get": {
    "tags": [
     "Vpcs"
    ],
    "summary": "List VPC-enabled sites",
    "description": "Lists the site IDs accepted by VPC and Reserved IP creation. Use only entries where `available` is `true`. Requires scope: network.read.",
    "operationId": "listNetworkingSites",
    "x-ibee-required-scope": "network.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     }
    ],
    "responses": {
     "200": {
      "description": "Site availability returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "type": "array",
         "items": {
          "$ref": "#/components/schemas/NetworkingSite"
         }
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/vpcs": {
   "get": {
    "tags": [
     "Vpcs"
    ],
    "summary": "List VPCs",
    "description": "Lists VPCs in the selected workspace. Requires scope: network.read.",
    "operationId": "listVpcs",
    "x-ibee-required-scope": "network.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "name": "site_id",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string"
      },
      "description": "Optional exact site filter. Copy `site_id` from `GET /networking/sites`."
     }
    ],
    "responses": {
     "200": {
      "description": "VPCs returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "type": "array",
         "items": {
          "$ref": "#/components/schemas/VpcSummary"
         }
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "post": {
    "tags": [
     "Vpcs"
    ],
    "summary": "Create a VPC",
    "description": "Creates an isolated virtual network. Requires scope: network.write.",
    "operationId": "createVpc",
    "x-ibee-required-scope": "network.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/CreateVpcRequest"
       }
      }
     }
    },
    "responses": {
     "201": {
      "description": "VPC created successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/VpcDetail"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/vpcs/{vpc_id}": {
   "get": {
    "tags": [
     "Vpcs"
    ],
    "summary": "Get a VPC",
    "description": "Returns a VPC and its subnets, NAT gateways, and attached nodes. Requires scope: network.read.",
    "operationId": "getVpc",
    "x-ibee-required-scope": "network.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VpcId"
     }
    ],
    "responses": {
     "200": {
      "description": "VPC returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/VpcDetail"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "patch": {
    "tags": [
     "Vpcs"
    ],
    "summary": "Update a VPC",
    "description": "Updates mutable VPC metadata. Requires scope: network.write.",
    "operationId": "updateVpc",
    "x-ibee-required-scope": "network.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VpcId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/UpdateVpcRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "VPC updated successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/VpcDetail"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "delete": {
    "tags": [
     "Vpcs"
    ],
    "summary": "Delete a VPC",
    "description": "Deletes an empty VPC. Requires scope: network.write.",
    "operationId": "deleteVpc",
    "x-ibee-required-scope": "network.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VpcId"
     }
    ],
    "responses": {
     "204": {
      "description": "VPC deleted successfully."
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/vpcs/{vpc_id}/subnets": {
   "get": {
    "tags": [
     "Vpcs"
    ],
    "summary": "List VPC subnets",
    "description": "Lists subnets in a VPC. Requires scope: network.read.",
    "operationId": "listVpcSubnets",
    "x-ibee-required-scope": "network.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VpcId"
     }
    ],
    "responses": {
     "200": {
      "description": "Subnets returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "type": "array",
         "items": {
          "$ref": "#/components/schemas/Subnet"
         }
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "post": {
    "tags": [
     "Vpcs"
    ],
    "summary": "Create a VPC subnet",
    "description": "Creates a subnet in a VPC. Requires scope: network.write.",
    "operationId": "createVpcSubnet",
    "x-ibee-required-scope": "network.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VpcId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/CreateSubnetRequest"
       }
      }
     }
    },
    "responses": {
     "201": {
      "description": "Subnet created successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/Subnet"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/vpcs/{vpc_id}/subnets/{subnet_id}": {
   "get": {
    "tags": [
     "Vpcs"
    ],
    "summary": "Get a VPC subnet",
    "description": "Returns one subnet in a VPC, including its CIDR range, gateway, and DNS settings. Requires scope: network.read.",
    "operationId": "getVpcSubnet",
    "x-ibee-required-scope": "network.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VpcId"
     },
     {
      "$ref": "#/components/parameters/SubnetId"
     }
    ],
    "responses": {
     "200": {
      "description": "Subnet returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/Subnet"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "patch": {
    "tags": [
     "Vpcs"
    ],
    "summary": "Update a VPC subnet",
    "description": "Renames a VPC subnet or changes its DNS settings. Requires scope: network.write.",
    "operationId": "updateVpcSubnet",
    "x-ibee-required-scope": "network.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VpcId"
     },
     {
      "$ref": "#/components/parameters/SubnetId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/UpdateSubnetRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Subnet updated successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/Subnet"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "delete": {
    "tags": [
     "Vpcs"
    ],
    "summary": "Delete a VPC subnet",
    "description": "Deletes a subnet from a VPC. Requires scope: network.write.",
    "operationId": "deleteVpcSubnet",
    "x-ibee-required-scope": "network.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VpcId"
     },
     {
      "$ref": "#/components/parameters/SubnetId"
     }
    ],
    "responses": {
     "204": {
      "description": "Subnet deleted successfully."
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/vpcs/{vpc_id}/nodes": {
   "get": {
    "tags": [
     "Vpcs"
    ],
    "summary": "List nodes attached to a VPC",
    "description": "Lists the VMs attached to a VPC. Requires scope: network.read.",
    "operationId": "listVpcNodes",
    "x-ibee-required-scope": "network.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VpcId"
     }
    ],
    "responses": {
     "200": {
      "description": "Attached nodes returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "type": "array",
         "items": {
          "$ref": "#/components/schemas/NetworkAllocation"
         }
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "post": {
    "tags": [
     "Vpcs"
    ],
    "summary": "Attach a node to a VPC",
    "description": "Attaches a VM to a VPC subnet so it can reach other VMs on the private network, optionally with a reserved public IP. Requires scope: network.write.",
    "operationId": "attachVpcNode",
    "x-ibee-required-scope": "network.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VpcId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/AttachVpcNodeRequest"
       }
      }
     }
    },
    "responses": {
     "201": {
      "description": "Node attached successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/NetworkAllocation"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/vpcs/{vpc_id}/nodes/{vm_id}": {
   "delete": {
    "tags": [
     "Vpcs"
    ],
    "summary": "Detach a node from a VPC",
    "description": "Detaches a VM from a VPC. Requires scope: network.write.",
    "operationId": "detachVpcNode",
    "x-ibee-required-scope": "network.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VpcId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "responses": {
     "204": {
      "description": "Node detached successfully."
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/vpcs/{vpc_id}/nat-gateways": {
   "get": {
    "tags": [
     "Vpcs"
    ],
    "summary": "List NAT gateways",
    "description": "Lists the managed NAT gateways in a VPC. Requires scope: network.read.",
    "operationId": "listNatGateways",
    "x-ibee-required-scope": "network.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VpcId"
     }
    ],
    "responses": {
     "200": {
      "description": "NAT gateways returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "type": "array",
         "items": {
          "$ref": "#/components/schemas/NatGateway"
         }
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "post": {
    "tags": [
     "Vpcs"
    ],
    "summary": "Create a NAT gateway",
    "description": "Creates a managed NAT gateway that gives VMs in a VPC outbound internet access without public IPs of their own. Requires scope: network.write.",
    "operationId": "createNatGateway",
    "x-ibee-required-scope": "network.write",
    "x-ibee-billing-admission": "required",
    "x-ibee-billing-sku-source": "product-catalog",
    "x-ibee-billing-sku": "nat-gateway",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VpcId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/CreateNatGatewayRequest"
       }
      }
     }
    },
    "responses": {
     "201": {
      "description": "NAT gateway created successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/NatGateway"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "402": {
      "$ref": "#/components/responses/PaymentRequired"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/vpcs/{vpc_id}/nat-gateways/{nat_gateway_id}": {
   "delete": {
    "tags": [
     "Vpcs"
    ],
    "summary": "Delete a NAT gateway",
    "description": "Deletes a NAT gateway from a VPC. VMs that relied on it lose outbound internet access. Requires scope: network.write.",
    "operationId": "deleteNatGateway",
    "x-ibee-required-scope": "network.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VpcId"
     },
     {
      "$ref": "#/components/parameters/NatGatewayId"
     }
    ],
    "responses": {
     "204": {
      "description": "NAT gateway deleted successfully."
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/vpcs/{vpc_id}/nat-gateways/{nat_gateway_id}/port-forwarding-rules": {
   "get": {
    "tags": [
     "Vpcs"
    ],
    "summary": "List NAT port-forwarding rules",
    "description": "Lists the port-forwarding rules on a NAT gateway. Requires scope: network.read.",
    "operationId": "listNatPortForwardingRules",
    "x-ibee-required-scope": "network.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VpcId"
     },
     {
      "$ref": "#/components/parameters/NatGatewayId"
     }
    ],
    "responses": {
     "200": {
      "description": "Port-forwarding rules returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "type": "array",
         "items": {
          "$ref": "#/components/schemas/NatPortForwardingRule"
         }
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "post": {
    "tags": [
     "Vpcs"
    ],
    "summary": "Create a NAT port-forwarding rule",
    "description": "Adds a port-forwarding rule that sends traffic arriving on a NAT gateway port to a private IP and port inside the VPC. Requires scope: network.write.",
    "operationId": "createNatPortForwardingRule",
    "x-ibee-required-scope": "network.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VpcId"
     },
     {
      "$ref": "#/components/parameters/NatGatewayId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/CreateNatPortForwardingRuleRequest"
       }
      }
     }
    },
    "responses": {
     "201": {
      "description": "Port-forwarding rule created successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/NatPortForwardingRule"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/vpcs/{vpc_id}/nat-gateways/{nat_gateway_id}/port-forwarding-rules/{port_forwarding_rule_id}": {
   "patch": {
    "tags": [
     "Vpcs"
    ],
    "summary": "Update a NAT port-forwarding rule",
    "description": "Changes a NAT port-forwarding rule's ports, target, protocol, or enabled state. Requires scope: network.write.",
    "operationId": "updateNatPortForwardingRule",
    "x-ibee-required-scope": "network.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VpcId"
     },
     {
      "$ref": "#/components/parameters/NatGatewayId"
     },
     {
      "$ref": "#/components/parameters/PortForwardingRuleId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/UpdateNatPortForwardingRuleRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Port-forwarding rule updated successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/NatPortForwardingRule"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "delete": {
    "tags": [
     "Vpcs"
    ],
    "summary": "Delete a NAT port-forwarding rule",
    "description": "Removes a port-forwarding rule from a NAT gateway. Requires scope: network.write.",
    "operationId": "deleteNatPortForwardingRule",
    "x-ibee-required-scope": "network.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VpcId"
     },
     {
      "$ref": "#/components/parameters/NatGatewayId"
     },
     {
      "$ref": "#/components/parameters/PortForwardingRuleId"
     }
    ],
    "responses": {
     "204": {
      "description": "Port-forwarding rule deleted successfully."
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/reserved-ips": {
   "get": {
    "tags": [
     "ReservedIps"
    ],
    "summary": "List Reserved IPs",
    "description": "Lists customer-reserved public IP addresses. Requires scope: network.read.",
    "operationId": "listReservedIps",
    "x-ibee-required-scope": "network.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "name": "site_id",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string"
      },
      "description": "Optional exact site filter. Copy `site_id` from `GET /networking/sites`."
     }
    ],
    "responses": {
     "200": {
      "description": "Reserved IPs returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "type": "array",
         "items": {
          "$ref": "#/components/schemas/ReservedIp"
         }
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "post": {
    "tags": [
     "ReservedIps"
    ],
    "summary": "Reserve a public IP",
    "description": "Reserves an address from a site's public IP pool. Discover an available site with `GET /networking/sites`. Requires scope: network.write.",
    "operationId": "reserveIp",
    "x-ibee-required-scope": "network.write",
    "x-ibee-billing-admission": "required",
    "x-ibee-billing-sku-source": "product-catalog",
    "x-ibee-billing-sku": "reserved-ip",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/ReserveIpRequest"
       }
      }
     }
    },
    "responses": {
     "201": {
      "description": "Public IP reserved successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ReservedIp"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "402": {
      "$ref": "#/components/responses/PaymentRequired"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/reserved-ips/{reserved_ip_id}": {
   "get": {
    "tags": [
     "ReservedIps"
    ],
    "summary": "Get a Reserved IP",
    "description": "Returns a reserved public IPv4 address, including its label, reverse DNS, and the VM it is attached to. Requires scope: network.read.",
    "operationId": "getReservedIp",
    "x-ibee-required-scope": "network.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/ReservedIpId"
     }
    ],
    "responses": {
     "200": {
      "description": "Reserved IP returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ReservedIp"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "patch": {
    "tags": [
     "ReservedIps"
    ],
    "summary": "Update a Reserved IP",
    "description": "Changes a reserved IP's label or reverse DNS (PTR) record. Requires scope: network.write.",
    "operationId": "updateReservedIp",
    "x-ibee-required-scope": "network.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/ReservedIpId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/UpdateReservedIpRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Reserved IP updated successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ReservedIp"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "delete": {
    "tags": [
     "ReservedIps"
    ],
    "summary": "Release a Reserved IP",
    "description": "Releases a reserved public IPv4 address from your workspace. Requires scope: network.write.",
    "operationId": "releaseReservedIp",
    "x-ibee-required-scope": "network.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/ReservedIpId"
     }
    ],
    "responses": {
     "204": {
      "description": "Reserved IP released successfully."
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/reserved-ips/{reserved_ip_id}/attach": {
   "post": {
    "tags": [
     "ReservedIps"
    ],
    "summary": "Attach a Reserved IP",
    "description": "Attaches a reserved public IP to a VM, optionally through a VPC subnet. Requires scope: network.write.",
    "operationId": "attachReservedIp",
    "x-ibee-required-scope": "network.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/ReservedIpId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/AttachReservedIpRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Reserved IP attached successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ReservedIp"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/reserved-ips/{reserved_ip_id}/detach": {
   "post": {
    "tags": [
     "ReservedIps"
    ],
    "summary": "Detach a Reserved IP",
    "description": "Detaches a reserved public IP from its VM. The address stays reserved in your workspace. Requires scope: network.write.",
    "operationId": "detachReservedIp",
    "x-ibee-required-scope": "network.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/ReservedIpId"
     }
    ],
    "responses": {
     "200": {
      "description": "Reserved IP detached successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ReservedIp"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/reserved-ips/{reserved_ip_id}/move": {
   "post": {
    "tags": [
     "ReservedIps"
    ],
    "summary": "Move a Reserved IP",
    "description": "Atomically moves a Reserved IP to another VM attachment.",
    "operationId": "moveReservedIp",
    "x-ibee-required-scope": "network.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/ReservedIpId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/AttachReservedIpRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Reserved IP moved successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ReservedIp"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/firewall-groups": {
   "get": {
    "tags": [
     "Firewalls"
    ],
    "summary": "List firewall groups",
    "description": "Lists one page of the firewall groups in a workspace: 10 by default, at most 100 per page. Use `limit` and `offset` to page through the rest. Requires scope: firewall.read.",
    "operationId": "listFirewallGroups",
    "x-ibee-required-scope": "firewall.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/ListLimit"
     },
     {
      "$ref": "#/components/parameters/ListOffset"
     }
    ],
    "responses": {
     "200": {
      "description": "Firewall groups returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "type": "array",
         "items": {
          "$ref": "#/components/schemas/FirewallGroup"
         }
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "post": {
    "tags": [
     "Firewalls"
    ],
    "summary": "Create a firewall group",
    "description": "Creates a firewall group, a reusable set of inbound and outbound rules you can apply to VMs. Requires scope: firewall.write.",
    "operationId": "createFirewallGroup",
    "x-ibee-required-scope": "firewall.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/CreateFirewallGroupRequest"
       }
      }
     }
    },
    "responses": {
     "201": {
      "description": "Firewall group created successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/FirewallGroup"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/firewall-groups/{firewall_group_id}": {
   "get": {
    "tags": [
     "Firewalls"
    ],
    "summary": "Get a firewall group",
    "description": "Returns a firewall group with its rules. Requires scope: firewall.read.",
    "operationId": "getFirewallGroup",
    "x-ibee-required-scope": "firewall.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/FirewallGroupId"
     }
    ],
    "responses": {
     "200": {
      "description": "Firewall group returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/FirewallGroup"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "delete": {
    "tags": [
     "Firewalls"
    ],
    "summary": "Delete a firewall group",
    "description": "Deletes a firewall group. Requires scope: firewall.write.",
    "operationId": "deleteFirewallGroup",
    "x-ibee-required-scope": "firewall.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/FirewallGroupId"
     }
    ],
    "responses": {
     "204": {
      "description": "Firewall group deleted successfully."
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/firewall-groups/{firewall_group_id}/rules": {
   "post": {
    "tags": [
     "Firewalls"
    ],
    "summary": "Add a firewall rule",
    "description": "Adds a rule to a firewall group, with its direction, protocol, port range, remote targets, action, and priority. Requires scope: firewall.write.",
    "operationId": "createFirewallRule",
    "x-ibee-required-scope": "firewall.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/FirewallGroupId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/CreateFirewallRuleRequest"
       }
      }
     }
    },
    "responses": {
     "201": {
      "description": "Firewall rule added successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/FirewallGroup"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/firewall-groups/{firewall_group_id}/rules/{firewall_rule_id}": {
   "patch": {
    "tags": [
     "Firewalls"
    ],
    "summary": "Update a firewall rule",
    "description": "Changes an existing rule in a firewall group. Requires scope: firewall.write.",
    "operationId": "updateFirewallRule",
    "x-ibee-required-scope": "firewall.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/FirewallGroupId"
     },
     {
      "$ref": "#/components/parameters/FirewallRuleId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/UpdateFirewallRuleRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Firewall rule updated successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/FirewallGroup"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "delete": {
    "tags": [
     "Firewalls"
    ],
    "summary": "Delete a firewall rule",
    "description": "Removes a rule from a firewall group. Requires scope: firewall.write.",
    "operationId": "deleteFirewallRule",
    "x-ibee-required-scope": "firewall.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/FirewallGroupId"
     },
     {
      "$ref": "#/components/parameters/FirewallRuleId"
     }
    ],
    "responses": {
     "200": {
      "description": "Firewall rule deleted successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/FirewallGroup"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/firewall-groups/{firewall_group_id}/attachments": {
   "get": {
    "tags": [
     "Firewalls"
    ],
    "summary": "List firewall group attachments",
    "description": "Lists the VMs a firewall group is applied to. Requires scope: firewall.read.",
    "operationId": "listFirewallGroupAttachments",
    "x-ibee-required-scope": "firewall.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/FirewallGroupId"
     },
     {
      "$ref": "#/components/parameters/Limit"
     },
     {
      "name": "skip",
      "description": "Number of items to skip before the first returned item. Default 0.",
      "in": "query",
      "required": false,
      "schema": {
       "type": "integer",
       "minimum": 0,
       "default": 0
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Firewall attachments returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "type": "array",
         "items": {
          "$ref": "#/components/schemas/FirewallAttachment"
         }
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "post": {
    "tags": [
     "Firewalls"
    ],
    "summary": "Attach a VM to a firewall group",
    "description": "Applies a firewall group's rules to a VM. Requires scope: firewall.write.",
    "operationId": "attachFirewallGroup",
    "x-ibee-required-scope": "firewall.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/FirewallGroupId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/FirewallAttachmentRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "VM attached successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/FirewallGroup"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/firewall-groups/{firewall_group_id}/attachments/{vm_id}": {
   "delete": {
    "tags": [
     "Firewalls"
    ],
    "summary": "Detach a VM from a firewall group",
    "description": "Removes a firewall group from a VM. Its rules no longer apply to that VM. Requires scope: firewall.write.",
    "operationId": "detachFirewallGroup",
    "x-ibee-required-scope": "firewall.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/FirewallGroupId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "responses": {
     "200": {
      "description": "VM detached successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/FirewallGroup"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/load-balancers": {
   "get": {
    "tags": [
     "LoadBalancers"
    ],
    "summary": "List load balancers",
    "description": "Lists the L4 and L7 load balancers in a workspace. Requires scope: load-balancer.read.",
    "operationId": "listLoadBalancers",
    "x-ibee-required-scope": "load-balancer.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "name": "status",
      "description": "Return only load balancers in this status.",
      "in": "query",
      "required": false,
      "schema": {
       "$ref": "#/components/schemas/LoadBalancerStatus"
      }
     },
     {
      "name": "layer",
      "description": "Return only load balancers of this layer.\n- `l4`\n- `l7`",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string",
       "enum": [
        "l4",
        "l7"
       ]
      }
     },
     {
      "name": "protocol",
      "description": "Return only load balancers that accept this protocol.",
      "in": "query",
      "required": false,
      "schema": {
       "$ref": "#/components/schemas/LoadBalancerProtocol"
      }
     },
     {
      "name": "limit",
      "description": "Maximum number of items to return (1-500). Default 100.",
      "in": "query",
      "required": false,
      "schema": {
       "type": "integer",
       "minimum": 1,
       "maximum": 500,
       "default": 100
      }
     },
     {
      "name": "skip",
      "description": "Number of items to skip before the first returned item. Default 0.",
      "in": "query",
      "required": false,
      "schema": {
       "type": "integer",
       "minimum": 0,
       "default": 0
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Load balancers returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "type": "array",
         "items": {
          "$ref": "#/components/schemas/LoadBalancer"
         }
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/load-balancers/l4": {
   "post": {
    "tags": [
     "LoadBalancers"
    ],
    "summary": "Create an L4 load balancer",
    "description": "Creates a layer 4 (TCP/UDP) load balancer that spreads connections across backend VMs, with optional TLS. Requires scope: load-balancer.write.",
    "operationId": "createL4LoadBalancer",
    "x-ibee-required-scope": "load-balancer.write",
    "x-ibee-billing-admission": "required",
    "x-ibee-billing-sku-source": "fixed",
    "x-ibee-billing-sku": "LOADBALA-STD",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/CreateL4LoadBalancerRequest"
       }
      }
     }
    },
    "responses": {
     "201": {
      "description": "L4 load balancer created successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/LoadBalancer"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "402": {
      "$ref": "#/components/responses/PaymentRequired"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/load-balancers/l7": {
   "post": {
    "tags": [
     "LoadBalancers"
    ],
    "summary": "Create an L7 load balancer",
    "description": "Creates a layer 7 (HTTP/HTTPS) load balancer with routing rules, optional TLS, and an optional custom domain. Requires scope: load-balancer.write.",
    "operationId": "createL7LoadBalancer",
    "x-ibee-required-scope": "load-balancer.write",
    "x-ibee-billing-admission": "required",
    "x-ibee-billing-sku-source": "fixed",
    "x-ibee-billing-sku": "LOADBALA-STD",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/CreateL7LoadBalancerRequest"
       }
      }
     }
    },
    "responses": {
     "201": {
      "description": "L7 load balancer created successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/LoadBalancer"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "402": {
      "$ref": "#/components/responses/PaymentRequired"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/load-balancers/{load_balancer_id}": {
   "get": {
    "tags": [
     "LoadBalancers"
    ],
    "summary": "Get a load balancer",
    "description": "Returns a load balancer's configuration, including its backends, routing, and TLS settings. Requires scope: load-balancer.read.",
    "operationId": "getLoadBalancer",
    "x-ibee-required-scope": "load-balancer.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/LoadBalancerId"
     }
    ],
    "responses": {
     "200": {
      "description": "Load balancer returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/LoadBalancer"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "delete": {
    "tags": [
     "LoadBalancers"
    ],
    "summary": "Delete a load balancer",
    "description": "Deletes a load balancer. The backend VMs are not deleted. Requires scope: load-balancer.write.",
    "operationId": "deleteLoadBalancer",
    "x-ibee-required-scope": "load-balancer.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/LoadBalancerId"
     }
    ],
    "responses": {
     "204": {
      "description": "Load balancer deletion accepted."
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/load-balancers/l4/{load_balancer_id}": {
   "patch": {
    "tags": [
     "LoadBalancers"
    ],
    "summary": "Update an L4 load balancer",
    "description": "Changes an L4 load balancer's backends, routing, or TLS settings. Requires scope: load-balancer.write.",
    "operationId": "updateL4LoadBalancer",
    "x-ibee-required-scope": "load-balancer.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/LoadBalancerId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/UpdateL4LoadBalancerRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "L4 load balancer updated successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/LoadBalancer"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/load-balancers/l7/{load_balancer_id}": {
   "patch": {
    "tags": [
     "LoadBalancers"
    ],
    "summary": "Update an L7 load balancer",
    "description": "Changes an L7 load balancer's backends, routing rules, TLS settings, or custom domain. Requires scope: load-balancer.write.",
    "operationId": "updateL7LoadBalancer",
    "x-ibee-required-scope": "load-balancer.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/LoadBalancerId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/UpdateL7LoadBalancerRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "L7 load balancer updated successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/LoadBalancer"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/networking/load-balancers/{load_balancer_id}/status": {
   "get": {
    "tags": [
     "LoadBalancers"
    ],
    "summary": "Get load balancer status",
    "description": "Returns a load balancer's provisioning status, endpoint URL, and any error conditions. Requires scope: load-balancer.read.",
    "operationId": "getLoadBalancerStatus",
    "x-ibee-required-scope": "load-balancer.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/LoadBalancerId"
     }
    ],
    "responses": {
     "200": {
      "description": "Load balancer status returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/LoadBalancerStatusResponse"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/sites": {
   "get": {
    "tags": [
     "ComputeCatalog"
    ],
    "summary": "List compute sites",
    "description": "Lists sites where cloud and GPU VMs can be placed. Requires scope: vm.read.",
    "operationId": "listComputeSites",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     }
    ],
    "responses": {
     "200": {
      "description": "Compute sites returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ComputeSiteList"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/plans": {
   "get": {
    "tags": [
     "ComputeCatalog"
    ],
    "summary": "List compute plans",
    "description": "Lists billable cloud or GPU VM plans. Requires scope: vm.read.",
    "operationId": "listComputePlans",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "name": "vm_type",
      "description": "Kind of VM the plans are for. Required.\n- `cloud`\n- `gpu`",
      "in": "query",
      "required": true,
      "schema": {
       "$ref": "#/components/schemas/VmType"
      }
     },
     {
      "name": "site_id",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string",
       "minLength": 1
      },
      "description": "Optional exact placement filter. Copy `site_id` from `GET /compute/sites`."
     },
     {
      "name": "currency",
      "description": "ISO 4217 code of the currency to quote prices in. Default `INR`.",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string",
       "minLength": 3,
       "maxLength": 3,
       "default": "INR"
      }
     },
     {
      "name": "billing_interval",
      "description": "Billing period to quote prices for.\n- `HOURLY`\n- `MONTHLY` (default)",
      "in": "query",
      "required": false,
      "schema": {
       "$ref": "#/components/schemas/BillingInterval"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Compute plans returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ComputePlanList"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/images": {
   "get": {
    "tags": [
     "ComputeCatalog"
    ],
    "summary": "List compute images",
    "description": "Lists ready public OS images compatible with cloud or GPU VMs. Requires scope: vm.read.",
    "operationId": "listComputeImages",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "name": "vm_type",
      "description": "Kind of VM the images are for. Required.\n- `cloud`\n- `gpu`",
      "in": "query",
      "required": true,
      "schema": {
       "$ref": "#/components/schemas/VmType"
      }
     },
     {
      "name": "site_id",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string",
       "minLength": 1
      },
      "description": "Optional exact placement filter. Copy `site_id` from `GET /compute/sites`."
     }
    ],
    "responses": {
     "200": {
      "description": "Compute images returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ComputeImageList"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms": {
   "get": {
    "tags": [
     "CloudVms"
    ],
    "summary": "List cloud VMs",
    "description": "Returns one page of cloud VMs in the workspace, newest first: 10 by default, at most 100 per page. Use `limit` and `offset` to page through the rest. Requires scope: vm.read.",
    "operationId": "listCloudVms",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/ListLimit"
     },
     {
      "$ref": "#/components/parameters/ListOffset"
     }
    ],
    "responses": {
     "200": {
      "description": "Cloud VMs returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "type": "array",
         "items": {
          "$ref": "#/components/schemas/CloudVm"
         }
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "post": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Create a cloud VM",
    "description": "Creates a cloud VM. Returns an operation you can poll for status. Requires scope: vm.write.",
    "operationId": "createCloudVm",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-billing-admission": "required",
    "x-ibee-billing-sku-source": "compute-plan",
    "x-ibee-billing-sku": "plan_id",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/IdempotencyKey"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/CreateCloudVmRequest"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "VM creation accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationAccepted"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "402": {
      "$ref": "#/components/responses/PaymentRequired"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}": {
   "get": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Get a cloud VM",
    "description": "Returns a single cloud VM. Requires scope: vm.read.",
    "operationId": "getCloudVm",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "responses": {
     "200": {
      "description": "Cloud VM returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/CloudVm"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "delete": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Delete a cloud VM",
    "description": "Deletes a cloud VM. Returns an operation you can poll for status. A VM with an automatically assigned public IP needs `public_ip_action` in the body. Requires scope: vm.write.",
    "operationId": "deleteCloudVm",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/IdempotencyKey"
     }
    ],
    "requestBody": {
     "required": false,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/VmDeleteRequest"
       },
       "example": {
        "public_ip_action": "release"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "VM deletion accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationAccepted"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}/actions/start": {
   "post": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Start a cloud VM",
    "description": "Starts a stopped cloud VM. Requires scope: vm.write.",
    "operationId": "startCloudVm",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/IdempotencyKey"
     }
    ],
    "requestBody": {
     "required": false,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/PowerActionRequest"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "VM start accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationAccepted"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}/actions/stop": {
   "post": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Stop a cloud VM",
    "description": "Stops a running cloud VM. Requires scope: vm.write.",
    "operationId": "stopCloudVm",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/IdempotencyKey"
     }
    ],
    "requestBody": {
     "required": false,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/PowerActionRequest"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "VM stop accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationAccepted"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}/actions/reboot": {
   "post": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Reboot a cloud VM",
    "description": "Reboots a cloud VM. Requires scope: vm.write.",
    "operationId": "rebootCloudVm",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/IdempotencyKey"
     }
    ],
    "requestBody": {
     "required": false,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/PowerActionRequest"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "VM reboot accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationAccepted"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}/metrics": {
   "get": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Get cloud VM metrics",
    "description": "Returns current resource-usage metrics for a cloud VM. Requires scope: vm.read.",
    "operationId": "getCloudVmMetrics",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "responses": {
     "200": {
      "description": "VM metrics returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/VmMetrics"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}/actions/access": {
   "patch": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Update cloud VM access settings",
    "description": "Adds or removes SSH keys, resets the Linux user password, or changes SSH password authentication on a cloud VM without rebooting it. Requires scope: vm.write.",
    "operationId": "updateCloudVmAccess",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/IdempotencyKey"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/VmAccessUpdateRequest"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "Access update accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationAccepted"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}/actions/resize/precheck": {
   "post": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Precheck a cloud VM resize",
    "description": "Checks whether a cloud VM can take a requested CPU, memory, or root-disk change before you start the resize. Requires scope: vm.write.",
    "operationId": "precheckCloudVmResize",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/VmResizeRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Resize decision returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/VmResizePrecheck"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}/actions/resize": {
   "post": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Resize a cloud VM",
    "description": "Changes a cloud VM's CPU and memory, and optionally grows its root disk, after the same precheck the portal runs. Requires scope: vm.write.",
    "operationId": "resizeCloudVm",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/IdempotencyKey"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/VmResizeRequest"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "VM resize accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationAccepted"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}/actions/resize-plan": {
   "patch": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Resize a cloud VM plan",
    "description": "Moves a cloud VM to a different CPU and memory plan. Downgrades require explicit confirmation. Requires scope: vm.write.",
    "operationId": "resizeCloudVmPlan",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/IdempotencyKey"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/VmResizePlanRequest"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "Plan resize accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationAccepted"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}/actions/resize-root-disk": {
   "patch": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Resize a cloud VM root disk",
    "description": "Increases a cloud VM's root disk size. Shrinking a root disk is not supported. Requires scope: vm.write.",
    "operationId": "resizeCloudVmRootDisk",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/IdempotencyKey"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/VmResizeRootDiskRequest"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "Root-disk resize accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationAccepted"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}/actions/attach-volume": {
   "post": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Attach a volume to a cloud VM",
    "description": "Attaches a persistent block storage volume to a cloud VM. Requires scope: vm.write.",
    "operationId": "attachCloudVmVolume",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/IdempotencyKey"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/VmAttachVolumeRequest"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "Volume attachment accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationAccepted"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}/actions/detach-volume": {
   "post": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Detach a volume from a cloud VM",
    "description": "Detaches a persistent block storage volume from a cloud VM. Unmount its filesystem in the guest first unless force is used. Requires scope: vm.write.",
    "operationId": "detachCloudVmVolume",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/IdempotencyKey"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/VmDetachVolumeRequest"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "Volume detachment accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationAccepted"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}/mount-guidance/acknowledge": {
   "post": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Acknowledge cloud VM mount guidance",
    "description": "Records that you have reviewed the guest mount instructions for a data volume attached to a cloud VM. Requires scope: vm.write.",
    "operationId": "acknowledgeCloudVmMountGuidance",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/MountGuidanceAcknowledgeRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Mount guidance acknowledged successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/MountGuidanceAcknowledge"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}/events": {
   "get": {
    "tags": [
     "CloudVms"
    ],
    "summary": "List cloud VM events",
    "description": "Returns a cloud VM's lifecycle and operation event timeline. Requires scope: vm.read.",
    "operationId": "listCloudVmEvents",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "name": "limit",
      "description": "Maximum number of items to return (1-500). Default 100.",
      "in": "query",
      "required": false,
      "schema": {
       "type": "integer",
       "minimum": 1,
       "maximum": 500,
       "default": 100
      }
     }
    ],
    "responses": {
     "200": {
      "description": "VM events returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "type": "array",
         "items": {
          "$ref": "#/components/schemas/VmEvent"
         }
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}/metrics/timeseries": {
   "get": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Get cloud VM metric timeseries",
    "description": "Returns rolled-up CPU, memory, disk, and network metric series for a cloud VM over a supported time range. Requires scope: vm.read.",
    "operationId": "getCloudVmMetricsTimeseries",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "name": "range",
      "description": "Time window to return, ending now.\n- `30m`\n- `1h`\n- `6h`\n- `24h`\n- `7d`\n\nDefault `1h`.",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string",
       "enum": [
        "30m",
        "1h",
        "6h",
        "24h",
        "7d"
       ],
       "default": "1h"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "VM metric timeseries returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/VmMetricsTimeseries"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}/metrics/bandwidth": {
   "get": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Get cloud VM monthly bandwidth",
    "description": "Returns a cloud VM's received and transmitted byte totals for a calendar month. Requires scope: vm.read.",
    "operationId": "getCloudVmBandwidth",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "name": "month",
      "description": "Calendar month to report, as `YYYY-MM` (for example `2026-08`).",
      "in": "query",
      "required": true,
      "schema": {
       "type": "string",
       "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])$",
       "example": "2026-08"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "VM bandwidth summary returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/VmBandwidthSummary"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}/snapshots": {
   "post": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Create a cloud VM snapshot",
    "description": "Creates a recovery snapshot of a cloud VM's root disk, all attached disks, or selected data disks. Requires scope: vm.write.",
    "operationId": "createCloudVmSnapshot",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/SnapshotCreateRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Snapshot created or queued successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SnapshotSet"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "402": {
      "$ref": "#/components/responses/PaymentRequired"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "get": {
    "tags": [
     "CloudVms"
    ],
    "summary": "List cloud VM snapshots",
    "description": "Lists recovery snapshots for one cloud VM. Requires scope: vm.read.",
    "operationId": "listCloudVmSnapshots",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/Limit"
     },
     {
      "name": "offset",
      "description": "Number of items to skip before the first returned item. Default 0.",
      "in": "query",
      "required": false,
      "schema": {
       "type": "integer",
       "minimum": 0,
       "default": 0
      }
     },
     {
      "name": "search",
      "description": "Return only snapshot sets whose name contains this text.",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string",
       "minLength": 1
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Snapshots returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SnapshotSetList"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vm-snapshots/{snapshot_set_id}/actions/restore": {
   "post": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Restore a cloud VM snapshot",
    "description": "Restores a cloud VM snapshot by replacing the VM, creating a new VM, or restoring a single volume. Requires scope: vm.write.",
    "operationId": "restoreCloudVmSnapshot",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/SnapshotSetId"
     },
     {
      "name": "vm_id",
      "in": "query",
      "required": true,
      "schema": {
       "type": "string",
       "minLength": 1
      },
      "description": "Source VM ID for the snapshot."
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/RecoveryRestoreRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Snapshot restore started successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/RecoveryRestore"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vm-snapshots/{snapshot_set_id}": {
   "get": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Get a cloud VM snapshot",
    "description": "Returns one workspace-owned cloud VM snapshot set. Requires scope: vm.read.",
    "operationId": "getCloudVmSnapshot",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/SnapshotSetId"
     }
    ],
    "responses": {
     "200": {
      "description": "Snapshot returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SnapshotSet"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "delete": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Delete a cloud VM snapshot",
    "description": "Deletes a cloud VM snapshot set when no restore is running. Requires scope: vm.write.",
    "operationId": "deleteCloudVmSnapshot",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/SnapshotSetId"
     }
    ],
    "responses": {
     "200": {
      "description": "Snapshot deleted successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SnapshotDeleteResult"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vm-snapshots/restores/{restore_id}": {
   "get": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Get a cloud VM snapshot restore",
    "description": "Returns the current status of a cloud VM snapshot restore. Requires scope: vm.read.",
    "operationId": "getCloudVmSnapshotRestore",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/RestoreId"
     }
    ],
    "responses": {
     "200": {
      "description": "Snapshot restore status returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/RecoveryRestore"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}/backups/policy": {
   "get": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Get a cloud VM backup policy",
    "description": "Returns a cloud VM's effective automated backup policy, including whether backups are disabled. Requires scope: vm.read.",
    "operationId": "getCloudVmBackupPolicy",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "responses": {
     "200": {
      "description": "Backup policy returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BackupPolicy"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "patch": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Update a cloud VM backup policy",
    "description": "Updates a cloud VM's automated backup schedule and retention settings. Requires scope: vm.write.",
    "operationId": "updateCloudVmBackupPolicy",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/BackupPolicyUpdateRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Backup policy updated successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BackupPolicy"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}/backups/enable": {
   "post": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Enable cloud VM backups",
    "description": "Turns on automated backups for a cloud VM and creates its backup policy. Requires scope: vm.write.",
    "operationId": "enableCloudVmBackups",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/BackupPolicyEnableRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Backups enabled successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BackupPolicy"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}/backups/disable": {
   "post": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Disable cloud VM backups",
    "description": "Stops future automated backups for a cloud VM without deleting existing recovery points. Requires scope: vm.write.",
    "operationId": "disableCloudVmBackups",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/BackupPolicyDisableRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Backups disabled successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BackupPolicy"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}/backups/policy/next-run-at": {
   "patch": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Reschedule a cloud VM backup",
    "description": "Sets when a cloud VM's next automated backup runs. Requires scope: vm.write.",
    "operationId": "rescheduleCloudVmBackup",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/BackupPolicyNextRunRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Next backup execution rescheduled successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BackupPolicy"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}/backups/runs": {
   "post": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Run a cloud VM backup",
    "description": "Queues a manual backup of a cloud VM using its backup configuration. Requires scope: vm.write.",
    "operationId": "createCloudVmBackupRun",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/ManualBackupRunRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Backup run queued successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BackupRun"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "get": {
    "tags": [
     "CloudVms"
    ],
    "summary": "List cloud VM recovery points",
    "description": "Lists backup runs and usable recovery points for one cloud VM. Requires scope: vm.read.",
    "operationId": "listCloudVmBackupRuns",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/Limit"
     },
     {
      "name": "offset",
      "description": "Number of items to skip before the first returned item. Default 0.",
      "in": "query",
      "required": false,
      "schema": {
       "type": "integer",
       "minimum": 0,
       "default": 0
      }
     },
     {
      "name": "search",
      "description": "Return only backup runs whose fields contain this text.",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string",
       "minLength": 1
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Backup runs returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BackupRunList"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vms/{vm_id}/backups/actions/restore": {
   "post": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Restore a cloud VM backup",
    "description": "Restores a cloud VM backup recovery point by replacing the VM, creating a new VM, or restoring a single volume. Requires scope: vm.write.",
    "operationId": "restoreCloudVmBackup",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/BackupRestoreRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Backup restore started successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/RecoveryRestore"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vm-backups/runs/{run_id}": {
   "get": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Get a cloud VM backup run",
    "description": "Returns one workspace-owned cloud VM backup run or recovery point. Requires scope: vm.read.",
    "operationId": "getCloudVmBackupRun",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/BackupRunId"
     }
    ],
    "responses": {
     "200": {
      "description": "Backup run returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BackupRun"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/cloud-vm-backups/restores/{restore_id}": {
   "get": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Get a cloud VM backup restore",
    "description": "Returns the current status of a cloud VM backup restore. Requires scope: vm.read.",
    "operationId": "getCloudVmBackupRestore",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/RestoreId"
     }
    ],
    "responses": {
     "200": {
      "description": "Backup restore status returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/RecoveryRestore"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms": {
   "get": {
    "tags": [
     "GpuVms"
    ],
    "summary": "List GPU VMs",
    "description": "Returns one page of GPU VMs in the workspace, newest first: 10 by default, at most 100 per page. Use `limit` and `offset` to page through the rest. Requires scope: vm.read.",
    "operationId": "listGpuVms",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/ListLimit"
     },
     {
      "$ref": "#/components/parameters/ListOffset"
     }
    ],
    "responses": {
     "200": {
      "description": "GPU VMs returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "type": "array",
         "items": {
          "$ref": "#/components/schemas/GpuVm"
         }
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "post": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Create a GPU VM",
    "description": "Creates a GPU VM. Returns an operation you can poll for status. Requires scope: vm.write.",
    "operationId": "createGpuVm",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-billing-admission": "required",
    "x-ibee-billing-sku-source": "compute-plan",
    "x-ibee-billing-sku": "plan_id",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/IdempotencyKey"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/CreateGpuVmRequest"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "VM creation accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationAccepted"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "402": {
      "$ref": "#/components/responses/PaymentRequired"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}": {
   "get": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Get a GPU VM",
    "description": "Returns a single GPU VM. Requires scope: vm.read.",
    "operationId": "getGpuVm",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "responses": {
     "200": {
      "description": "GPU VM returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/GpuVm"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "delete": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Delete a GPU VM",
    "description": "Deletes a GPU VM. Returns an operation you can poll for status. A VM with an automatically assigned public IP needs `public_ip_action` in the body. Requires scope: vm.write.",
    "operationId": "deleteGpuVm",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/IdempotencyKey"
     }
    ],
    "requestBody": {
     "required": false,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/VmDeleteRequest"
       },
       "example": {
        "public_ip_action": "release"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "VM deletion accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationAccepted"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}/actions/start": {
   "post": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Start a GPU VM",
    "description": "Starts a stopped GPU VM. Requires scope: vm.write.",
    "operationId": "startGpuVm",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/IdempotencyKey"
     }
    ],
    "requestBody": {
     "required": false,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/PowerActionRequest"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "VM start accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationAccepted"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}/actions/stop": {
   "post": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Stop a GPU VM",
    "description": "Stops a running GPU VM. Requires scope: vm.write.",
    "operationId": "stopGpuVm",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/IdempotencyKey"
     }
    ],
    "requestBody": {
     "required": false,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/PowerActionRequest"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "VM stop accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationAccepted"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}/actions/reboot": {
   "post": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Reboot a GPU VM",
    "description": "Reboots a GPU VM. Requires scope: vm.write.",
    "operationId": "rebootGpuVm",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/IdempotencyKey"
     }
    ],
    "requestBody": {
     "required": false,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/PowerActionRequest"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "VM reboot accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationAccepted"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}/metrics": {
   "get": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Get GPU VM metrics",
    "description": "Returns current resource-usage metrics for a GPU VM. Requires scope: vm.read.",
    "operationId": "getGpuVmMetrics",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "responses": {
     "200": {
      "description": "VM metrics returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/VmMetrics"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}/actions/access": {
   "patch": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Update GPU VM access settings",
    "description": "Adds or removes SSH keys, resets the Linux user password, or changes SSH password authentication on a GPU VM without rebooting it or interrupting running GPU workloads. Requires scope: vm.write.",
    "operationId": "updateGpuVmAccess",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/IdempotencyKey"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/VmAccessUpdateRequest"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "Access update accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationAccepted"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}/actions/resize/precheck": {
   "post": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Precheck a GPU VM resize",
    "description": "Checks whether a GPU VM can take a requested CPU, memory, or root-disk change before you start the resize. The attached GPU stays the same. Requires scope: vm.write.",
    "operationId": "precheckGpuVmResize",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/VmResizeRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Resize decision returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/VmResizePrecheck"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}/actions/resize": {
   "post": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Resize a GPU VM",
    "description": "Changes a GPU VM's CPU and memory, and optionally grows its root disk, after the same precheck the portal runs. Requires scope: vm.write.",
    "operationId": "resizeGpuVm",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/IdempotencyKey"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/VmResizeRequest"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "VM resize accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationAccepted"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}/actions/resize-plan": {
   "patch": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Resize a GPU VM plan",
    "description": "Moves a GPU VM to a different CPU and memory plan. Downgrades require explicit confirmation. Requires scope: vm.write.",
    "operationId": "resizeGpuVmPlan",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/IdempotencyKey"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/VmResizePlanRequest"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "Plan resize accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationAccepted"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}/actions/resize-root-disk": {
   "patch": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Resize a GPU VM root disk",
    "description": "Increases a GPU VM's root disk size, for example to fit larger models or datasets. Shrinking a root disk is not supported. Requires scope: vm.write.",
    "operationId": "resizeGpuVmRootDisk",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/IdempotencyKey"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/VmResizeRootDiskRequest"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "Root-disk resize accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationAccepted"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}/actions/attach-volume": {
   "post": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Attach a volume to a GPU VM",
    "description": "Attaches a persistent block storage volume to a GPU VM, for datasets, checkpoints, or model weights. Requires scope: vm.write.",
    "operationId": "attachGpuVmVolume",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/IdempotencyKey"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/VmAttachVolumeRequest"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "Volume attachment accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationAccepted"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}/actions/detach-volume": {
   "post": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Detach a volume from a GPU VM",
    "description": "Detaches a persistent block storage volume from a GPU VM. Stop jobs using it and unmount its filesystem in the guest first unless force is used. Requires scope: vm.write.",
    "operationId": "detachGpuVmVolume",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/IdempotencyKey"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/VmDetachVolumeRequest"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "Volume detachment accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationAccepted"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}/mount-guidance/acknowledge": {
   "post": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Acknowledge GPU VM mount guidance",
    "description": "Records that you have reviewed the guest mount instructions for a data volume attached to a GPU VM. Requires scope: vm.write.",
    "operationId": "acknowledgeGpuVmMountGuidance",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/MountGuidanceAcknowledgeRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Mount guidance acknowledged successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/MountGuidanceAcknowledge"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}/events": {
   "get": {
    "tags": [
     "GpuVms"
    ],
    "summary": "List GPU VM events",
    "description": "Returns a GPU VM's lifecycle and operation event timeline. Requires scope: vm.read.",
    "operationId": "listGpuVmEvents",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "name": "limit",
      "description": "Maximum number of items to return (1-500). Default 100.",
      "in": "query",
      "required": false,
      "schema": {
       "type": "integer",
       "minimum": 1,
       "maximum": 500,
       "default": 100
      }
     }
    ],
    "responses": {
     "200": {
      "description": "VM events returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "type": "array",
         "items": {
          "$ref": "#/components/schemas/VmEvent"
         }
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}/metrics/timeseries": {
   "get": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Get GPU VM metric timeseries",
    "description": "Returns rolled-up metric series for a GPU VM over a supported time range. Requires scope: vm.read.",
    "operationId": "getGpuVmMetricsTimeseries",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "name": "range",
      "description": "Time window to return, ending now.\n- `30m`\n- `1h`\n- `6h`\n- `24h`\n- `7d`\n\nDefault `1h`.",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string",
       "enum": [
        "30m",
        "1h",
        "6h",
        "24h",
        "7d"
       ],
       "default": "1h"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "VM metric timeseries returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/VmMetricsTimeseries"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}/metrics/bandwidth": {
   "get": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Get GPU VM monthly bandwidth",
    "description": "Returns a GPU VM's received and transmitted byte totals for a calendar month. Requires scope: vm.read.",
    "operationId": "getGpuVmBandwidth",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "name": "month",
      "description": "Calendar month to report, as `YYYY-MM` (for example `2026-08`).",
      "in": "query",
      "required": true,
      "schema": {
       "type": "string",
       "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])$",
       "example": "2026-08"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "VM bandwidth summary returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/VmBandwidthSummary"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}/snapshots": {
   "post": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Create a GPU VM snapshot",
    "description": "Creates a recovery snapshot of a GPU VM's root disk, all attached disks, or selected data disks. Requires scope: vm.write.",
    "operationId": "createGpuVmSnapshot",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/SnapshotCreateRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Snapshot created or queued successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SnapshotSet"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "402": {
      "$ref": "#/components/responses/PaymentRequired"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "get": {
    "tags": [
     "GpuVms"
    ],
    "summary": "List GPU VM snapshots",
    "description": "Lists recovery snapshots for one GPU VM. Requires scope: vm.read.",
    "operationId": "listGpuVmSnapshots",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/Limit"
     },
     {
      "name": "offset",
      "description": "Number of items to skip before the first returned item. Default 0.",
      "in": "query",
      "required": false,
      "schema": {
       "type": "integer",
       "minimum": 0,
       "default": 0
      }
     },
     {
      "name": "search",
      "description": "Return only snapshot sets whose name contains this text.",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string",
       "minLength": 1
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Snapshots returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SnapshotSetList"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vm-snapshots/{snapshot_set_id}/actions/restore": {
   "post": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Restore a GPU VM snapshot",
    "description": "Restores a GPU VM snapshot by replacing the VM, creating a new GPU VM, or restoring a single volume. Requires scope: vm.write.",
    "operationId": "restoreGpuVmSnapshot",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/SnapshotSetId"
     },
     {
      "name": "vm_id",
      "in": "query",
      "required": true,
      "schema": {
       "type": "string",
       "minLength": 1
      },
      "description": "Source GPU VM ID for the snapshot."
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/RecoveryRestoreRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Snapshot restore started successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/RecoveryRestore"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vm-snapshots/{snapshot_set_id}": {
   "get": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Get a GPU VM snapshot",
    "description": "Returns one workspace-owned GPU VM snapshot set. Requires scope: vm.read.",
    "operationId": "getGpuVmSnapshot",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/SnapshotSetId"
     }
    ],
    "responses": {
     "200": {
      "description": "Snapshot returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SnapshotSet"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "delete": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Delete a GPU VM snapshot",
    "description": "Deletes a GPU VM snapshot set when no restore is running. Requires scope: vm.write.",
    "operationId": "deleteGpuVmSnapshot",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/SnapshotSetId"
     }
    ],
    "responses": {
     "200": {
      "description": "Snapshot deleted successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/SnapshotDeleteResult"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vm-snapshots/restores/{restore_id}": {
   "get": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Get a GPU VM snapshot restore",
    "description": "Returns the current status of a GPU VM snapshot restore. Requires scope: vm.read.",
    "operationId": "getGpuVmSnapshotRestore",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/RestoreId"
     }
    ],
    "responses": {
     "200": {
      "description": "Snapshot restore status returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/RecoveryRestore"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}/backups/policy": {
   "get": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Get a GPU VM backup policy",
    "description": "Returns a GPU VM's effective automated backup policy, including whether backups are disabled. Requires scope: vm.read.",
    "operationId": "getGpuVmBackupPolicy",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "responses": {
     "200": {
      "description": "Backup policy returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BackupPolicy"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "patch": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Update a GPU VM backup policy",
    "description": "Updates a GPU VM's automated backup schedule and retention settings. Requires scope: vm.write.",
    "operationId": "updateGpuVmBackupPolicy",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/BackupPolicyUpdateRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Backup policy updated successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BackupPolicy"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}/backups/enable": {
   "post": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Enable GPU VM backups",
    "description": "Turns on automated backups for a GPU VM and creates its backup policy. Requires scope: vm.write.",
    "operationId": "enableGpuVmBackups",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/BackupPolicyEnableRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Backups enabled successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BackupPolicy"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}/backups/disable": {
   "post": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Disable GPU VM backups",
    "description": "Stops future automated backups for a GPU VM without deleting existing recovery points. Requires scope: vm.write.",
    "operationId": "disableGpuVmBackups",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/BackupPolicyDisableRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Backups disabled successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BackupPolicy"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}/backups/policy/next-run-at": {
   "patch": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Reschedule a GPU VM backup",
    "description": "Sets when a GPU VM's next automated backup runs. Requires scope: vm.write.",
    "operationId": "rescheduleGpuVmBackup",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/BackupPolicyNextRunRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Next backup execution rescheduled successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BackupPolicy"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}/backups/runs": {
   "post": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Run a GPU VM backup",
    "description": "Queues a manual backup of a GPU VM using its backup configuration. Requires scope: vm.write.",
    "operationId": "createGpuVmBackupRun",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/ManualBackupRunRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Backup run queued successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BackupRun"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "get": {
    "tags": [
     "GpuVms"
    ],
    "summary": "List GPU VM recovery points",
    "description": "Lists backup runs and usable recovery points for one GPU VM. Requires scope: vm.read.",
    "operationId": "listGpuVmBackupRuns",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     },
     {
      "$ref": "#/components/parameters/Limit"
     },
     {
      "name": "offset",
      "description": "Number of items to skip before the first returned item. Default 0.",
      "in": "query",
      "required": false,
      "schema": {
       "type": "integer",
       "minimum": 0,
       "default": 0
      }
     },
     {
      "name": "search",
      "description": "Return only backup runs whose fields contain this text.",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string",
       "minLength": 1
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Backup runs returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BackupRunList"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vms/{vm_id}/backups/actions/restore": {
   "post": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Restore a GPU VM backup",
    "description": "Restores a GPU VM backup recovery point by replacing the VM, creating a new GPU VM, or restoring a single volume. Requires scope: vm.write.",
    "operationId": "restoreGpuVmBackup",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/VmId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/BackupRestoreRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Backup restore started successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/RecoveryRestore"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vm-backups/runs/{run_id}": {
   "get": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Get a GPU VM backup run",
    "description": "Returns one workspace-owned GPU VM backup run or recovery point. Requires scope: vm.read.",
    "operationId": "getGpuVmBackupRun",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/BackupRunId"
     }
    ],
    "responses": {
     "200": {
      "description": "Backup run returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BackupRun"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/gpu-vm-backups/restores/{restore_id}": {
   "get": {
    "tags": [
     "GpuVms"
    ],
    "summary": "Get a GPU VM backup restore",
    "description": "Returns the current status of a GPU VM backup restore. Requires scope: vm.read.",
    "operationId": "getGpuVmBackupRestore",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/RestoreId"
     }
    ],
    "responses": {
     "200": {
      "description": "Backup restore status returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/RecoveryRestore"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/console/sessions": {
   "post": {
    "tags": [
     "VmConsole"
    ],
    "summary": "Create a VM console session",
    "description": "Creates a short-lived graphical console session for a cloud or GPU VM. The returned connect URL contains an expiring token; do not log or persist it. Requires scope: vm.write.",
    "operationId": "createVmConsoleSession",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/VmConsoleSessionCreateRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Console session created successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/VmConsoleSession"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "429": {
      "$ref": "#/components/responses/TooManyRequests"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/console/sessions/{session_id}": {
   "get": {
    "tags": [
     "VmConsole"
    ],
    "summary": "Get a VM console session",
    "description": "Returns the status of a workspace-owned console session. Requires scope: vm.read.",
    "operationId": "getVmConsoleSession",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/ConsoleSessionId"
     }
    ],
    "responses": {
     "200": {
      "description": "Console session status returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/VmConsoleSessionStatus"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "delete": {
    "tags": [
     "VmConsole"
    ],
    "summary": "Close a VM console session",
    "description": "Closes a workspace-owned console session and invalidates its connection token. Requires scope: vm.write.",
    "operationId": "closeVmConsoleSession",
    "x-ibee-required-scope": "vm.write",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "$ref": "#/components/parameters/ConsoleSessionId"
     },
     {
      "name": "reason",
      "description": "Reason recorded as the session's `close_reason`. Default `closed_by_user`.",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string",
       "default": "closed_by_user"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Console session closed successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/VmConsoleClose"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/compute/operations/{operation_id}": {
   "get": {
    "tags": [
     "CloudVms"
    ],
    "summary": "Get operation status",
    "description": "Returns the status of an async compute operation (create, delete, start, stop, reboot). Works for both cloud VM and GPU VM operations. Requires scope: vm.read.",
    "operationId": "getComputeOperation",
    "x-ibee-required-scope": "vm.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     },
     {
      "name": "operation_id",
      "in": "path",
      "required": true,
      "schema": {
       "type": "string"
      },
      "description": "Operation ID returned by a create, delete, or power-action request."
     }
    ],
    "responses": {
     "200": {
      "description": "Operation returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/OperationStatus"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/billing/resource-eligibility": {
   "post": {
    "tags": [
     "Billing"
    ],
    "summary": "Check resource billing eligibility",
    "description": "Returns a point-in-time eligibility decision from the same existing billing service used by the portal. Call it before a billable create and continue only when `allowed` is exactly `true`. This check does not reserve funds, create a resource, or guarantee that a later product operation will succeed. Requires scope: billing.read.",
    "operationId": "checkResourceEligibility",
    "x-ibee-required-scope": "billing.read",
    "x-ibee-gateway-status": "ready",
    "parameters": [
     {
      "$ref": "#/components/parameters/WorkspaceId"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/BillingEligibilityRequest"
       },
       "example": {
        "sku_code": "STANDARD-2-8-50"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Billing eligibility decision returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BillingEligibility"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "422": {
      "description": "The eligibility request is invalid.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/Error"
        }
       }
      }
     },
     "502": {
      "description": "Billing returned an invalid or unavailable decision.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/Error"
        }
       }
      }
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     },
     "504": {
      "description": "The billing eligibility request timed out.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/Error"
        }
       }
      }
     }
    }
   }
  },
  "/block-storage/volumes": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    }
   ],
   "get": {
    "tags": [
     "BlockStorage"
    ],
    "summary": "List block-storage volumes",
    "description": "Lists the block storage volumes in a workspace, with their size, status, and attached VM. Requires scope: block-storage.read.",
    "operationId": "listBlockVolumes",
    "x-ibee-required-scope": "block-storage.read",
    "responses": {
     "200": {
      "description": "Volumes returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "type": "array",
         "items": {
          "$ref": "#/components/schemas/BlockVolume"
         }
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "post": {
    "tags": [
     "BlockStorage"
    ],
    "summary": "Create block-storage volume",
    "description": "The public edge resolves authoritative pricing from the server-owned product catalog and validates billing before forwarding this request to the existing portal volume flow. Client-supplied price or billing catalog objects are not accepted.",
    "operationId": "createBlockVolume",
    "x-ibee-required-scope": "block-storage.write",
    "x-ibee-billing-admission": "required",
    "x-ibee-billing-sku-source": "product-catalog",
    "x-ibee-billing-sku": "block-storage",
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/CreateBlockVolumeRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Volume created successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BlockVolumeAction"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "402": {
      "$ref": "#/components/responses/PaymentRequired"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/block-storage/volumes/{volume_id}": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/BlockVolumeId"
    }
   ],
   "get": {
    "tags": [
     "BlockStorage"
    ],
    "summary": "Get block-storage volume",
    "description": "Returns a block storage volume, including its size, status, and the VM it is attached to. Requires scope: block-storage.read.",
    "operationId": "getBlockVolume",
    "x-ibee-required-scope": "block-storage.read",
    "responses": {
     "200": {
      "description": "Volume returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BlockVolume"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "delete": {
    "tags": [
     "BlockStorage"
    ],
    "summary": "Delete block-storage volume",
    "description": "Permanently deletes a block storage volume and its data. Requires scope: block-storage.write.",
    "operationId": "deleteBlockVolume",
    "x-ibee-required-scope": "block-storage.write",
    "parameters": [
     {
      "name": "force",
      "description": "Delete the volume even if it is still attached. Default false.",
      "in": "query",
      "schema": {
       "type": "boolean",
       "default": false
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Volume deletion completed.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BlockVolumeDelete"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/block-storage/volumes/{volume_id}/operations": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/BlockVolumeId"
    }
   ],
   "get": {
    "tags": [
     "BlockStorage"
    ],
    "summary": "List block-volume operations",
    "description": "Lists the operations run on a block storage volume and their status. Requires scope: block-storage.read.",
    "operationId": "listBlockVolumeOperations",
    "x-ibee-required-scope": "block-storage.read",
    "responses": {
     "200": {
      "description": "Operations returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "type": "array",
         "items": {
          "$ref": "#/components/schemas/BlockVolumeOperation"
         }
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/block-storage/volumes/{volume_id}/attachments": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/BlockVolumeId"
    }
   ],
   "post": {
    "tags": [
     "BlockStorage"
    ],
    "summary": "Attach block-storage volume",
    "description": "Attaches a block storage volume to a VM so it can be mounted in the guest. Requires scope: block-storage.write.",
    "operationId": "attachBlockVolume",
    "x-ibee-required-scope": "block-storage.write",
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/AttachBlockVolumeRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Volume attached successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BlockVolumeAction"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/block-storage/volumes/{volume_id}/detach": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/BlockVolumeId"
    }
   ],
   "post": {
    "tags": [
     "BlockStorage"
    ],
    "summary": "Detach block-storage volume",
    "description": "Detaches a block storage volume from its VM. Unmount it in the guest first. Requires scope: block-storage.write.",
    "operationId": "detachBlockVolume",
    "x-ibee-required-scope": "block-storage.write",
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/DetachBlockVolumeRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Volume detached successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BlockVolumeAction"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/block-storage/volumes/{volume_id}/resize": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/BlockVolumeId"
    }
   ],
   "post": {
    "tags": [
     "BlockStorage"
    ],
    "summary": "Resize block-storage volume",
    "description": "Block volumes can only be increased in size.",
    "operationId": "resizeBlockVolume",
    "x-ibee-required-scope": "block-storage.write",
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/ResizeBlockVolumeRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Volume resized successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/BlockVolumeAction"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/cdn/generate-url": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    }
   ],
   "post": {
    "tags": [
     "Cdn"
    ],
    "summary": "Generate CDN object URL",
    "description": "Generates a time-limited CDN URL for an object in an object storage bucket, with optional download disposition. Requires scope: cdn.write.",
    "operationId": "generateCdnUrl",
    "x-ibee-required-scope": "cdn.write",
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/GenerateCdnUrlRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "CDN URL generated successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/GeneratedCdnUrl"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/cdn/distributions": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    }
   ],
   "get": {
    "tags": [
     "Cdn"
    ],
    "summary": "List CDN distributions",
    "description": "Lists the CDN distributions in a workspace. Requires scope: cdn.read.",
    "operationId": "listCdnDistributions",
    "x-ibee-required-scope": "cdn.read",
    "responses": {
     "200": {
      "description": "Distributions returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/CdnDistributionList"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "post": {
    "tags": [
     "Cdn"
    ],
    "summary": "Create CDN distribution",
    "description": "Creates a CDN distribution that caches and serves content from an object storage bucket or other origin through the edge network. Requires scope: cdn.write.",
    "operationId": "createCdnDistribution",
    "x-ibee-required-scope": "cdn.write",
    "x-ibee-billing-admission": "required",
    "x-ibee-billing-sku-source": "product-catalog",
    "x-ibee-billing-sku": "cdn-distribution",
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/CreateCdnDistributionRequest"
       }
      }
     }
    },
    "responses": {
     "201": {
      "description": "Distribution created successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/CdnDistribution"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "402": {
      "$ref": "#/components/responses/PaymentRequired"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/cdn/distributions/{distribution_id}": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/CdnDistributionId"
    }
   ],
   "get": {
    "tags": [
     "Cdn"
    ],
    "summary": "Get CDN distribution",
    "description": "Returns a CDN distribution's origin, cache policy, domains, and status. Requires scope: cdn.read.",
    "operationId": "getCdnDistribution",
    "x-ibee-required-scope": "cdn.read",
    "responses": {
     "200": {
      "description": "Distribution returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/CdnDistribution"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "patch": {
    "tags": [
     "Cdn"
    ],
    "summary": "Update CDN distribution",
    "description": "Changes a CDN distribution's name, origin, or cache policy. Requires scope: cdn.write.",
    "operationId": "updateCdnDistribution",
    "x-ibee-required-scope": "cdn.write",
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/UpdateCdnDistributionRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Distribution updated successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/CdnDistribution"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "delete": {
    "tags": [
     "Cdn"
    ],
    "summary": "Delete CDN distribution",
    "description": "Deletes a CDN distribution. Requires scope: cdn.write.",
    "operationId": "deleteCdnDistribution",
    "x-ibee-required-scope": "cdn.write",
    "responses": {
     "200": {
      "description": "Distribution deleted successfully."
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/cdn/distributions/{distribution_id}/website-config": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/CdnDistributionId"
    }
   ],
   "get": {
    "tags": [
     "Cdn"
    ],
    "summary": "Get static website configuration",
    "description": "Returns a CDN distribution's static website settings, such as its index document. Requires scope: cdn.read.",
    "operationId": "getCdnWebsiteConfig",
    "x-ibee-required-scope": "cdn.read",
    "responses": {
     "200": {
      "description": "Website configuration returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/CdnWebsiteConfig"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "put": {
    "tags": [
     "Cdn"
    ],
    "summary": "Enable or update static website configuration",
    "description": "Turns on static website hosting for a CDN distribution, or changes its index document. Requires scope: cdn.write.",
    "operationId": "updateCdnWebsiteConfig",
    "x-ibee-required-scope": "cdn.write",
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/UpdateCdnWebsiteConfigRequest"
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Website configuration updated successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/CdnWebsiteConfig"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "delete": {
    "tags": [
     "Cdn"
    ],
    "summary": "Disable static website configuration",
    "description": "Turns off static website hosting for a CDN distribution. Requires scope: cdn.write.",
    "operationId": "deleteCdnWebsiteConfig",
    "x-ibee-required-scope": "cdn.write",
    "responses": {
     "200": {
      "description": "Website configuration disabled successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/CdnWebsiteConfig"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/cdn/distributions/{distribution_id}/custom-domains": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/CdnDistributionId"
    }
   ],
   "get": {
    "tags": [
     "Cdn"
    ],
    "summary": "List CDN custom domains",
    "description": "Lists the custom domains on a CDN distribution, with their verification and certificate status. Requires scope: cdn.read.",
    "operationId": "listCdnCustomDomains",
    "x-ibee-required-scope": "cdn.read",
    "responses": {
     "200": {
      "description": "Custom domains returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/CdnCustomDomainList"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "post": {
    "tags": [
     "Cdn"
    ],
    "summary": "Add CDN custom domain",
    "description": "Adds a custom domain to a CDN distribution and returns the DNS records needed to verify it. Requires scope: cdn.write.",
    "operationId": "createCdnCustomDomain",
    "x-ibee-required-scope": "cdn.write",
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/CreateCdnCustomDomainRequest"
       }
      }
     }
    },
    "responses": {
     "201": {
      "description": "Custom domain added successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/CdnCustomDomain"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "402": {
      "$ref": "#/components/responses/PaymentRequired"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/cdn/distributions/{distribution_id}/custom-domains/{domain}": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/CdnDistributionId"
    },
    {
     "$ref": "#/components/parameters/CdnDomain"
    }
   ],
   "get": {
    "tags": [
     "Cdn"
    ],
    "summary": "Get CDN custom domain",
    "description": "Returns a CDN custom domain's verification status, DNS instructions, and TLS certificate status. Requires scope: cdn.read.",
    "operationId": "getCdnCustomDomain",
    "x-ibee-required-scope": "cdn.read",
    "responses": {
     "200": {
      "description": "Custom domain returned successfully.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/CdnCustomDomain"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "delete": {
    "tags": [
     "Cdn"
    ],
    "summary": "Remove CDN custom domain",
    "description": "Removes a custom domain from a CDN distribution. Requires scope: cdn.write.",
    "operationId": "deleteCdnCustomDomain",
    "x-ibee-required-scope": "cdn.write",
    "responses": {
     "200": {
      "description": "Custom domain removed successfully."
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/cdn/distributions/{distribution_id}/custom-domains/{domain}/verify": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/CdnDistributionId"
    },
    {
     "$ref": "#/components/parameters/CdnDomain"
    }
   ],
   "post": {
    "tags": [
     "Cdn"
    ],
    "summary": "Verify CDN custom domain",
    "description": "Checks a CDN custom domain's DNS records and updates its verification status. Requires scope: cdn.write.",
    "operationId": "verifyCdnCustomDomain",
    "x-ibee-required-scope": "cdn.write",
    "responses": {
     "200": {
      "description": "Domain verification completed.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/CdnCustomDomainVerification"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/cdn/distributions/{distribution_id}/purge": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/CdnDistributionId"
    }
   ],
   "post": {
    "tags": [
     "Cdn"
    ],
    "summary": "Purge CDN cache",
    "description": "Purges matching cache content synchronously for a distribution in the\nselected workspace. For a normal single-page application deployment,\nuse `mode: url` with `paths: [\"/index.html\"]`. Do not purge\nfingerprinted assets such as `/assets/app.a91c3.js`; use `paths:\n[\"/*\"]` only for an emergency full-cache invalidation.\n",
    "operationId": "purgeCdnCache",
    "x-ibee-required-scope": "cdn.write",
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/PurgeCdnCacheRequest"
       },
       "example": {
        "mode": "url",
        "paths": [
         "/index.html"
        ]
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Cache purge completed.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/CdnCachePurge"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "423": {
      "$ref": "#/components/responses/Locked"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registry-names/{registry_name}/availability": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "name": "registry_name",
     "in": "path",
     "required": true,
     "schema": {
      "type": "string",
      "minLength": 3,
      "maxLength": 48,
      "pattern": "^[a-z][a-z0-9-]{1,46}[a-z0-9]$"
     },
     "description": "Registry name to check."
    }
   ],
   "get": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "Check registry name availability",
    "description": "Checks whether a registry name is free across IBEE. Names are global and never reassigned; unavailable names come with suggestions. Requires scope: container-registry.read.",
    "operationId": "checkContainerRegistryNameAvailability",
    "x-ibee-required-scope": "container-registry.read",
    "responses": {
     "200": {
      "description": "Availability returned.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistryNameAvailability"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registries": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    }
   ],
   "get": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "List registries",
    "description": "Lists the workspace's registries, newest first. Paged with `page` and `page_size` (at most 100). Requires scope: container-registry.read.",
    "operationId": "listContainerRegistries",
    "x-ibee-required-scope": "container-registry.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/Page"
     },
     {
      "$ref": "#/components/parameters/ContainerRegistryPageSize"
     }
    ],
    "responses": {
     "200": {
      "description": "Registries returned.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistryList"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "post": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "Create registry",
    "description": "Creates a registry with a storage plan (`billing_catalog.sku_code`).\nThe registry service asks Billing whether the workspace may buy that\nplan and refuses with 403 `billing_resource_not_eligible` (and a\n`reason`) when it may not. Returns 201 when the registry is active, or\n202 while provisioning finishes in the background; poll the registry\nuntil `observed_state` is `ACTIVE`. Requires scope:\ncontainer-registry.write.\n",
    "operationId": "createContainerRegistry",
    "x-ibee-required-scope": "container-registry.write",
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/CreateContainerRegistryRequest"
       },
       "example": {
        "registry_name": "acme-apps",
        "confirm_registry_name": "acme-apps",
        "visibility": "PRIVATE",
        "security": {
         "vulnerability_pull_policy": "ALLOW"
        },
        "billing_catalog": {
         "sku_code": "REGISTRY-STORAGE-250GB"
        }
       }
      }
     }
    },
    "responses": {
     "201": {
      "description": "Registry created and active.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistry"
        }
       }
      }
     },
     "202": {
      "description": "Registry accepted; provisioning continues in the background.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistry"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registries/{registry_id}": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryId"
    }
   ],
   "get": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "Get registry",
    "description": "Returns one registry, including its visibility, pull policy and provisioning state. A deleted registry is still returned, with `deleted_at` set. Requires scope: container-registry.read.",
    "operationId": "getContainerRegistry",
    "x-ibee-required-scope": "container-registry.read",
    "responses": {
     "200": {
      "description": "Registry returned.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistry"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "delete": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "Delete registry",
    "description": "Starts deleting a registry; returns 202 with `observed_state: DELETING`. The registry must be empty: 409 with `detail.code: registry_not_empty` otherwise (see Empty registry). The name is never reused. Requires scope: container-registry.write.",
    "operationId": "deleteContainerRegistry",
    "x-ibee-required-scope": "container-registry.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/ContainerRegistryConfirmName"
     }
    ],
    "responses": {
     "202": {
      "description": "Deletion accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistry"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registries/{registry_id}/visibility": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryId"
    }
   ],
   "patch": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "Change registry visibility",
    "description": "Makes a registry private or public. Public requires `acknowledge_public_egress_charges: true`, because anonymous pull bandwidth is billed to the workspace. Returns 202 while the change is applied. Requires scope: container-registry.write.",
    "operationId": "updateContainerRegistryVisibility",
    "x-ibee-required-scope": "container-registry.write",
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/UpdateContainerRegistryVisibilityRequest"
       },
       "example": {
        "visibility": "PUBLIC",
        "acknowledge_public_egress_charges": true
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "Visibility change accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistry"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registries/{registry_id}/reconcile": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryId"
    }
   ],
   "post": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "Retry registry provisioning",
    "description": "Queues the registry's pending change (create, update, upgrade or delete) to run again, for example after `observed_state: ERROR`. Requires scope: container-registry.write.",
    "operationId": "retryContainerRegistryProvisioning",
    "x-ibee-required-scope": "container-registry.write",
    "responses": {
     "202": {
      "description": "Retry queued.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistryReconcile"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registries/{registry_id}/empty": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryId"
    }
   ],
   "post": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "Empty registry",
    "description": "Permanently deletes every repository and image in a registry, so it can be deleted. A bounded run can stop early with 409 `detail.code: registry_empty_incomplete` (`retryable: true`); pause pushes and call again. Requires scope: container-registry.write.",
    "operationId": "emptyContainerRegistry",
    "x-ibee-required-scope": "container-registry.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/ContainerRegistryConfirmName"
     }
    ],
    "responses": {
     "200": {
      "description": "Registry emptied.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistryEmptyResult"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registries/{registry_id}/package": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryId"
    }
   ],
   "get": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "Get registry storage plan",
    "description": "Returns the registry's current storage plan, a pending upgrade if there is one, and the status of the change being applied. Requires scope: container-registry.read.",
    "operationId": "getContainerRegistryPackage",
    "x-ibee-required-scope": "container-registry.read",
    "responses": {
     "200": {
      "description": "Plan returned.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistryPackage"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registries/{registry_id}/upgrade": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryId"
    }
   ],
   "post": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "Upgrade registry storage plan",
    "description": "Moves an active registry to a larger storage plan. Only larger quotas\nare accepted and only one change can be pending (409 otherwise). The\nregistry service asks Billing first and refuses with 403\n`billing_resource_not_eligible` when the plan is not allowed. Send an\n`Idempotency-Key` header: a retry with the same key and plan returns\nthe original operation (202 while pending, 200 once applied); the same\nkey with a different plan returns 409. Requires scope:\ncontainer-registry.write.\n",
    "operationId": "upgradeContainerRegistryPackage",
    "x-ibee-required-scope": "container-registry.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/ContainerRegistryIdempotencyKey"
     }
    ],
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/UpgradeContainerRegistryPackageRequest"
       },
       "example": {
        "billing_catalog": {
         "sku_code": "REGISTRY-STORAGE-500GB"
        }
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Replay of an upgrade that has already been applied.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistryPackageOperation"
        }
       }
      }
     },
     "202": {
      "description": "Upgrade accepted and pending.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistryPackageOperation"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registries/{registry_id}/access-tokens": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryId"
    }
   ],
   "get": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "List registry access tokens",
    "description": "Lists the access tokens that can use this registry, newest first. Secrets are never returned. Requires scope: container-registry.read.",
    "operationId": "listContainerRegistryAccessTokens",
    "x-ibee-required-scope": "container-registry.read",
    "parameters": [
     {
      "name": "include_revoked",
      "in": "query",
      "required": false,
      "schema": {
       "type": "boolean",
       "default": false
      },
      "description": "Include revoked tokens."
     }
    ],
    "responses": {
     "200": {
      "description": "Tokens returned.",
      "content": {
       "application/json": {
        "schema": {
         "type": "array",
         "items": {
          "$ref": "#/components/schemas/ContainerRegistryAccessToken"
         }
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "post": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "Create registry access token",
    "description": "Creates a Docker login credential for the registry. The `username`\nand `secret` are returned once and cannot be read again. The registry\nmust be active, and the registry service asks Billing whether the\nworkspace may create credentials. Requires scope:\ncontainer-registry.write.\n",
    "operationId": "createContainerRegistryAccessToken",
    "x-ibee-required-scope": "container-registry.write",
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/CreateContainerRegistryAccessTokenRequest"
       },
       "example": {
        "token_name": "production-k8s",
        "permission": "PULL",
        "expires_in_days": 90
       }
      }
     }
    },
    "responses": {
     "201": {
      "description": "Token created. Store the secret now.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistryAccessTokenSecret"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registries/{registry_id}/access-tokens/{token_id}/rotate": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryTokenId"
    }
   ],
   "post": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "Rotate registry access token",
    "description": "Issues a new secret for an active token; the old secret stops working immediately. The new secret is returned once. Revoked or expired tokens return 409. Requires scope: container-registry.write.",
    "operationId": "rotateContainerRegistryAccessToken",
    "x-ibee-required-scope": "container-registry.write",
    "responses": {
     "200": {
      "description": "Secret rotated. Store the new secret now.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistryAccessTokenSecret"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registries/{registry_id}/access-tokens/{token_id}": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryTokenId"
    }
   ],
   "delete": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "Revoke registry access token",
    "description": "Revokes a token immediately. Revoking an already revoked token succeeds. Requires scope: container-registry.write.",
    "operationId": "revokeContainerRegistryAccessToken",
    "x-ibee-required-scope": "container-registry.write",
    "responses": {
     "200": {
      "description": "Token revoked.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistryMessage"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registries/{registry_id}/repositories": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryId"
    }
   ],
   "get": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "List repositories",
    "description": "Lists an active registry's repositories. Paged with `page` and `page_size` (at most 100). Requires scope: container-registry.read.",
    "operationId": "listContainerRegistryRepositories",
    "x-ibee-required-scope": "container-registry.read",
    "parameters": [
     {
      "name": "search",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string",
       "minLength": 1,
       "maxLength": 255,
       "pattern": "^[^,%=]+$"
      },
      "description": "Fuzzy match on the repository name."
     },
     {
      "name": "sort",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string",
       "enum": [
        "name",
        "-name",
        "pull_count",
        "-pull_count",
        "creation_time",
        "-creation_time",
        "update_time",
        "-update_time"
       ]
      },
      "description": "Column to sort by; prefix with `-` for descending."
     },
     {
      "$ref": "#/components/parameters/Page"
     },
     {
      "$ref": "#/components/parameters/ContainerRegistryPageSize"
     }
    ],
    "responses": {
     "200": {
      "description": "Repositories returned.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistryRepositoryList"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registries/{registry_id}/repositories/{repository_name}": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryId"
    },
    {
     "name": "repository_name",
     "in": "path",
     "required": true,
     "schema": {
      "type": "string",
      "minLength": 1
     },
     "description": "Repository name inside the registry, for example `api`."
    }
   ],
   "delete": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "Delete repository",
    "description": "Permanently deletes a repository and all of its images. Requires `confirm=true`. Requires scope: container-registry.write.",
    "operationId": "deleteContainerRegistryRepository",
    "x-ibee-required-scope": "container-registry.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/ContainerRegistryConfirm"
     }
    ],
    "responses": {
     "200": {
      "description": "Repository deleted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistryMessage"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registries/{registry_id}/artifacts": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryId"
    }
   ],
   "get": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "List artifacts",
    "description": "Lists the images (artifacts) in one repository with their tags and scan overview. Paged with `page` and `page_size` (at most 100). Requires scope: container-registry.read.",
    "operationId": "listContainerRegistryArtifacts",
    "x-ibee-required-scope": "container-registry.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/ContainerRegistryRepositoryName"
     },
     {
      "$ref": "#/components/parameters/Page"
     },
     {
      "$ref": "#/components/parameters/ContainerRegistryPageSize"
     }
    ],
    "responses": {
     "200": {
      "description": "Artifacts returned.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistryArtifactList"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registries/{registry_id}/artifacts/{reference}": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryArtifactReference"
    }
   ],
   "delete": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "Delete artifact",
    "description": "Permanently deletes one image and every tag that points to it. Requires `confirm=true`. Requires scope: container-registry.write.",
    "operationId": "deleteContainerRegistryArtifact",
    "x-ibee-required-scope": "container-registry.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/ContainerRegistryRepositoryName"
     },
     {
      "$ref": "#/components/parameters/ContainerRegistryConfirm"
     }
    ],
    "responses": {
     "200": {
      "description": "Artifact deleted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistryMessage"
        }
       }
      }
     },
     "400": {
      "$ref": "#/components/responses/BadRequest"
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registries/{registry_id}/artifacts/{reference}/scan": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryArtifactReference"
    }
   ],
   "post": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "Rescan artifact",
    "description": "Queues a new vulnerability scan of one image. Existing results stay visible until it completes. Requires scope: container-registry.write.",
    "operationId": "scanContainerRegistryArtifact",
    "x-ibee-required-scope": "container-registry.write",
    "parameters": [
     {
      "$ref": "#/components/parameters/ContainerRegistryRepositoryName"
     }
    ],
    "responses": {
     "202": {
      "description": "Scan queued.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistryMessage"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registries/{registry_id}/security/settings": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryId"
    }
   ],
   "get": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "Get registry security settings",
    "description": "Returns the vulnerability pull policy. Scanning and SBOM generation always run on push. Requires scope: container-registry.read.",
    "operationId": "getContainerRegistrySecuritySettings",
    "x-ibee-required-scope": "container-registry.read",
    "responses": {
     "200": {
      "description": "Settings returned.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistrySecuritySettingsStatus"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   },
   "patch": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "Update registry security settings",
    "description": "Sets the vulnerability pull policy: `ALLOW`, or block pulls of images with findings at or above `CRITICAL`, `HIGH`, `MEDIUM` or `LOW`. Returns 202 while the change is applied. Requires scope: container-registry.write.",
    "operationId": "updateContainerRegistrySecuritySettings",
    "x-ibee-required-scope": "container-registry.write",
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/UpdateContainerRegistrySecuritySettingsRequest"
       },
       "example": {
        "vulnerability_pull_policy": "BLOCK_CRITICAL"
       }
      }
     }
    },
    "responses": {
     "202": {
      "description": "Settings change accepted.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistrySecuritySettingsStatus"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registries/{registry_id}/security/vulnerabilities/summary": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryId"
    }
   ],
   "get": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "Get vulnerability summary",
    "description": "Returns the number of vulnerability findings in an active registry, by severity. Requires scope: container-registry.read.",
    "operationId": "getContainerRegistryVulnerabilitySummary",
    "x-ibee-required-scope": "container-registry.read",
    "responses": {
     "200": {
      "description": "Summary returned.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistryVulnerabilitySummary"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registries/{registry_id}/security/vulnerabilities": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryId"
    }
   ],
   "get": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "List vulnerabilities",
    "description": "Lists vulnerability findings in an active registry, with optional filters. Paged with `page` and `page_size` (at most 100). Requires scope: container-registry.read.",
    "operationId": "listContainerRegistryVulnerabilities",
    "x-ibee-required-scope": "container-registry.read",
    "parameters": [
     {
      "name": "severity",
      "description": "Return only findings of this severity.\n- `Critical`\n- `High`\n- `Medium`\n- `Low`\n- `Unknown`\n- `None`",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string",
       "enum": [
        "Critical",
        "High",
        "Medium",
        "Low",
        "Unknown",
        "None"
       ]
      }
     },
     {
      "name": "cve_id",
      "description": "Return only findings for this CVE or advisory ID.",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string",
       "minLength": 1,
       "maxLength": 128,
       "pattern": "^[^,%=]+$"
      }
     },
     {
      "name": "repository_name",
      "description": "Return only findings on artifacts in this repository.",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string",
       "minLength": 1,
       "maxLength": 255,
       "pattern": "^[a-z0-9]+(?:[._-][a-z0-9]+)*(?:/[a-z0-9]+(?:[._-][a-z0-9]+)*)*$"
      }
     },
     {
      "name": "digest",
      "description": "Return only findings on the artifact with this digest.",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string",
       "minLength": 1,
       "maxLength": 255,
       "pattern": "^[a-z0-9_+.-]+:[A-Fa-f0-9]+$"
      }
     },
     {
      "name": "tag",
      "description": "Return only findings on artifacts carrying this tag.",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string",
       "minLength": 1,
       "maxLength": 128,
       "pattern": "^[A-Za-z0-9_][A-Za-z0-9_.-]{0,127}$"
      }
     },
     {
      "name": "package",
      "description": "Return only findings in this package.",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string",
       "minLength": 1,
       "maxLength": 255,
       "pattern": "^[^,%=]+$"
      }
     },
     {
      "$ref": "#/components/parameters/Page"
     },
     {
      "$ref": "#/components/parameters/ContainerRegistryPageSize"
     }
    ],
    "responses": {
     "200": {
      "description": "Findings returned.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistryVulnerabilityList"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registries/{registry_id}/security/sboms": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryId"
    }
   ],
   "get": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "List SBOMs",
    "description": "Lists the SBOMs of one repository, one per image digest. Paged with `page` and `page_size` (at most 100). Requires scope: container-registry.read.",
    "operationId": "listContainerRegistrySboms",
    "x-ibee-required-scope": "container-registry.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/ContainerRegistrySbomRepositoryName"
     },
     {
      "$ref": "#/components/parameters/Page"
     },
     {
      "$ref": "#/components/parameters/ContainerRegistryPageSize"
     }
    ],
    "responses": {
     "200": {
      "description": "SBOMs returned.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistrySbomList"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registries/{registry_id}/security/sboms/{artifact_digest}": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryArtifactDigest"
    }
   ],
   "get": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "Get SBOM",
    "description": "Returns one image's SBOM components and their relationships. `q` filters components by name, version, type, license, supplier or package URL. Components are paged with `page` and `page_size` (at most 100). Requires scope: container-registry.read.",
    "operationId": "getContainerRegistrySbom",
    "x-ibee-required-scope": "container-registry.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/ContainerRegistrySbomRepositoryName"
     },
     {
      "name": "q",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string",
       "minLength": 1,
       "maxLength": 200
      },
      "description": "Component search text."
     },
     {
      "$ref": "#/components/parameters/Page"
     },
     {
      "$ref": "#/components/parameters/ContainerRegistryPageSize"
     }
    ],
    "responses": {
     "200": {
      "description": "SBOM returned.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistrySbom"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registries/{registry_id}/security/sboms/{artifact_digest}/download": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryArtifactDigest"
    }
   ],
   "get": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "Download SBOM",
    "description": "Downloads one image's full SBOM document as a JSON attachment (SPDX or CycloneDX). Requires scope: container-registry.read.",
    "operationId": "downloadContainerRegistrySbom",
    "x-ibee-required-scope": "container-registry.read",
    "parameters": [
     {
      "$ref": "#/components/parameters/ContainerRegistrySbomRepositoryName"
     }
    ],
    "responses": {
     "200": {
      "description": "SBOM document.",
      "content": {
       "application/spdx+json": {
        "schema": {
         "type": "string",
         "format": "binary"
        }
       },
       "application/vnd.cyclonedx+json": {
        "schema": {
         "type": "string",
         "format": "binary"
        }
       },
       "application/json": {
        "schema": {
         "type": "string",
         "format": "binary"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  },
  "/container-registry/registries/{registry_id}/metrics": {
   "parameters": [
    {
     "$ref": "#/components/parameters/WorkspaceId"
    },
    {
     "$ref": "#/components/parameters/ContainerRegistryId"
    }
   ],
   "get": {
    "tags": [
     "ContainerRegistry"
    ],
    "summary": "Get registry metrics",
    "description": "Returns storage use against the plan quota and outbound bandwidth over the last 24 hours, 7 days or 30 days. Bytes are decimal (1 GB = 1,000,000,000 bytes). Requires scope: container-registry.read.",
    "operationId": "getContainerRegistryMetrics",
    "x-ibee-required-scope": "container-registry.read",
    "parameters": [
     {
      "name": "range",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string",
       "enum": [
        "24h",
        "7d",
        "30d"
       ],
       "default": "24h"
      },
      "description": "Time window."
     }
    ],
    "responses": {
     "200": {
      "description": "Metrics returned.",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/ContainerRegistryMetrics"
        }
       }
      }
     },
     "401": {
      "$ref": "#/components/responses/Unauthorized"
     },
     "403": {
      "$ref": "#/components/responses/Forbidden"
     },
     "404": {
      "$ref": "#/components/responses/NotFound"
     },
     "409": {
      "$ref": "#/components/responses/Conflict"
     },
     "422": {
      "$ref": "#/components/responses/ContainerRegistryValidationError"
     },
     "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
     }
    }
   }
  }
 },
 "components": {
  "securitySchemes": {
   "IbeeApiToken": {
    "type": "http",
    "scheme": "bearer",
    "bearerFormat": "IBEE platform API token",
    "description": "IBEE platform API token. Production tokens start with `ibee_prod_key_`; development tokens start with `ibee_dev_key_`. Use a token only with its matching gateway environment."
   }
  },
  "parameters": {
   "WorkspaceId": {
    "name": "workspace_id",
    "in": "query",
    "required": true,
    "schema": {
     "type": "string",
     "minLength": 1,
     "pattern": "^[1-9][0-9]*$"
    },
    "description": "The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.",
    "example": "710995"
   },
   "BlockVolumeId": {
    "name": "volume_id",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string",
     "minLength": 1
    },
    "description": "Workspace-owned block-volume ID."
   },
   "CdnDistributionId": {
    "name": "distribution_id",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string",
     "minLength": 1
    },
    "description": "CDN distribution ID."
   },
   "CdnDomain": {
    "name": "domain",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string",
     "minLength": 3,
     "maxLength": 253
    },
    "description": "Fully qualified custom domain."
   },
   "Page": {
    "name": "page",
    "in": "query",
    "required": false,
    "schema": {
     "type": "integer",
     "minimum": 1,
     "default": 1
    },
    "description": "Page number."
   },
   "Limit": {
    "name": "limit",
    "in": "query",
    "required": false,
    "schema": {
     "type": "integer",
     "minimum": 1,
     "maximum": 200,
     "default": 50
    },
    "description": "Maximum number of records to return."
   },
   "ListLimit": {
    "name": "limit",
    "in": "query",
    "required": false,
    "schema": {
     "type": "integer",
     "minimum": 1,
     "maximum": 100,
     "default": 10
    },
    "description": "Maximum number of records to return. The server returns 10 when this is omitted; use `offset` to read further pages."
   },
   "ListOffset": {
    "name": "offset",
    "in": "query",
    "required": false,
    "schema": {
     "type": "integer",
     "minimum": 0,
     "default": 0
    },
    "description": "Number of records to skip before the first one returned."
   },
   "StoreId": {
    "name": "store_id",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string"
    },
    "description": "Secret store ID.",
    "example": "019f1e4b-3edd-72cf-b90e-26864ba2f283"
   },
   "SecretId": {
    "name": "secret_id",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string"
    },
    "description": "Secret ID.",
    "example": "019f1e4b-4a2c-71d0-a8b3-c5f92e7d1a4b"
   },
   "SecretVersion": {
    "name": "version",
    "in": "path",
    "required": true,
    "schema": {
     "type": "integer",
     "minimum": 1
    },
    "description": "Positive secret version number.",
    "example": 1
   },
   "IdentityId": {
    "name": "identity_id",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string"
    },
    "description": "Secret Store application identity ID."
   },
   "ScopeId": {
    "name": "scope_id",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string"
    },
    "description": "Secret Store identity scope ID."
   },
   "BucketName": {
    "name": "bucket_name",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string"
    },
    "description": "Logical bucket name."
   },
   "AccessKeyId": {
    "name": "access_key_id",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string"
    },
    "description": "S3 access key ID."
   },
   "VmId": {
    "name": "vm_id",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string"
    },
    "description": "Virtual machine ID."
   },
   "SnapshotSetId": {
    "name": "snapshot_set_id",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string",
     "minLength": 1
    },
    "description": "VM snapshot-set ID."
   },
   "ConsoleSessionId": {
    "name": "session_id",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string",
     "minLength": 1
    },
    "description": "VM console session ID."
   },
   "RestoreId": {
    "name": "restore_id",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string",
     "minLength": 1
    },
    "description": "Snapshot or backup restore operation ID."
   },
   "BackupRunId": {
    "name": "run_id",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string",
     "minLength": 1
    },
    "description": "Backup run or recovery-point ID."
   },
   "VpcId": {
    "name": "vpc_id",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string"
    },
    "description": "VPC ID."
   },
   "SubnetId": {
    "name": "subnet_id",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string"
    },
    "description": "Subnet ID."
   },
   "NatGatewayId": {
    "name": "nat_gateway_id",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string"
    },
    "description": "NAT gateway ID."
   },
   "ReservedIpId": {
    "name": "reserved_ip_id",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string"
    },
    "description": "Reserved IP ID."
   },
   "PortForwardingRuleId": {
    "name": "port_forwarding_rule_id",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string"
    },
    "description": "NAT port-forwarding rule ID."
   },
   "FirewallGroupId": {
    "name": "firewall_group_id",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string"
    },
    "description": "Firewall group ID."
   },
   "FirewallRuleId": {
    "name": "firewall_rule_id",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string"
    },
    "description": "Firewall rule ID."
   },
   "LoadBalancerId": {
    "name": "load_balancer_id",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string"
    },
    "description": "Load balancer ID."
   },
   "IdempotencyKey": {
    "name": "X-Idempotency-Key",
    "in": "header",
    "required": true,
    "schema": {
     "type": "string"
    },
    "description": "Unique key used to safely retry write operations."
   },
   "ContainerRegistryId": {
    "name": "registry_id",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string",
     "format": "uuid"
    },
    "description": "Registry ID."
   },
   "ContainerRegistryTokenId": {
    "name": "token_id",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string",
     "format": "uuid"
    },
    "description": "Registry access token ID."
   },
   "ContainerRegistryPageSize": {
    "name": "page_size",
    "in": "query",
    "required": false,
    "schema": {
     "type": "integer",
     "minimum": 1,
     "maximum": 100,
     "default": 20
    },
    "description": "Number of records per page."
   },
   "ContainerRegistryConfirmName": {
    "name": "confirm_registry_name",
    "in": "query",
    "required": true,
    "schema": {
     "type": "string",
     "minLength": 3,
     "maxLength": 48
    },
    "description": "The registry's name, repeated to confirm a destructive call."
   },
   "ContainerRegistryConfirm": {
    "name": "confirm",
    "in": "query",
    "required": true,
    "schema": {
     "type": "boolean"
    },
    "description": "Must be `true` to confirm permanent deletion."
   },
   "ContainerRegistryRepositoryName": {
    "name": "repository_name",
    "in": "query",
    "required": true,
    "schema": {
     "type": "string",
     "minLength": 1,
     "maxLength": 255
    },
    "description": "Repository name inside the registry, for example `api` or `team/api`."
   },
   "ContainerRegistrySbomRepositoryName": {
    "name": "repository_name",
    "in": "query",
    "required": true,
    "schema": {
     "type": "string",
     "minLength": 1,
     "maxLength": 255,
     "pattern": "^[a-z0-9]+(?:[._-][a-z0-9]+)*(?:/[a-z0-9]+(?:[._-][a-z0-9]+)*)*$"
    },
    "description": "Repository name inside the registry, for example `api` or `team/api`."
   },
   "ContainerRegistryArtifactReference": {
    "name": "reference",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string",
     "minLength": 1
    },
    "description": "Image digest (`sha256:...`) or tag."
   },
   "ContainerRegistryArtifactDigest": {
    "name": "artifact_digest",
    "in": "path",
    "required": true,
    "schema": {
     "type": "string",
     "pattern": "^[a-z0-9_+.-]+:[A-Fa-f0-9]+$"
    },
    "description": "Image digest, for example `sha256:4f3c...`."
   },
   "ContainerRegistryIdempotencyKey": {
    "name": "Idempotency-Key",
    "in": "header",
    "required": true,
    "schema": {
     "type": "string",
     "minLength": 1,
     "maxLength": 128,
     "pattern": "^[A-Za-z0-9._:-]+$"
    },
    "description": "Unique key for this upgrade. The registry service reads this header (not `X-Idempotency-Key`); a retry with the same key and plan returns the original operation."
   }
  },
  "responses": {
   "BadRequest": {
    "description": "The request is invalid. From the gateway: `workspace_id_required` or `invalid_workspace_id`; on billable creates also `invalid_json_body` and selection codes such as `plan_id_required`, `invalid_site_id`, `compute_billing_term_required` or `invalid_block_storage_selection`. Otherwise the product service's `detail`.",
    "content": {
     "application/json": {
      "schema": {
       "$ref": "#/components/schemas/Error"
      }
     }
    }
   },
   "Unauthorized": {
    "description": "The API token is missing, malformed or unknown (`invalid_api_key`).",
    "content": {
     "application/json": {
      "schema": {
       "$ref": "#/components/schemas/Error"
      }
     }
    }
   },
   "Forbidden": {
    "description": "The token may not make this call. Gateway codes: `insufficient_scope` (with `required_scope`), `key_revoked`, `key_disabled`, `key_inactive`, `key_expired`, `unknown_route`, `workspace_not_allowed`, `principal_inactive`, `principal_not_member` and `principal_permission_denied`. On writes, also `organization_restricted` (an admin restricted the organization) and `verification_required` (the token's user has not completed identity verification). A product service may also refuse with `detail`.",
    "content": {
     "application/json": {
      "schema": {
       "$ref": "#/components/schemas/Error"
      }
     }
    }
   },
   "NotFound": {
    "description": "The requested resource was not found.",
    "content": {
     "application/json": {
      "schema": {
       "$ref": "#/components/schemas/Error"
      }
     }
    }
   },
   "Conflict": {
    "description": "The request conflicts with the current resource state.",
    "content": {
     "application/json": {
      "schema": {
       "$ref": "#/components/schemas/Error"
      }
     }
    }
   },
   "PaymentRequired": {
    "description": "Billing refused the request (`billing_denied`). `billing_reason` carries Billing's reason unchanged, for example `insufficient_balance`, `credit_limit_exceeded`, `initial_topup_required`, `resource_limit_reached` (a plan limit) or `resource_usage_unavailable` (Billing could not count usage). `billing_sku_code`, `billing_evaluated_at` and `admission_context_id` identify the decision. Nothing is provisioned; resolve the reason and retry with the same idempotency key where supported.",
    "content": {
     "application/json": {
      "schema": {
       "$ref": "#/components/schemas/Error"
      }
     }
    }
   },
   "Locked": {
    "description": "The organization is suspended (`organization_suspended`), so writes are refused.",
    "content": {
     "application/json": {
      "schema": {
       "$ref": "#/components/schemas/Error"
      }
     }
    }
   },
   "TooManyRequests": {
    "description": "A concurrency limit was reached. Retry later. For console sessions, `detail.code` is `user_limit` or `workspace_limit` (active sessions per user or per workspace).",
    "content": {
     "application/json": {
      "schema": {
       "$ref": "#/components/schemas/Error"
      }
     }
    }
   },
   "ServiceUnavailable": {
    "description": "A service the request depends on did not answer. Gateway codes: `workspace_verification_unavailable`, `principal_verification_unavailable` and `principal_authorization_unavailable`; on billable creates also `billing_admission_timeout`, `billing_admission_unavailable`, `billing_admission_disabled`, `billing_admission_not_configured` and the catalog codes `compute_catalog_unavailable`, `compute_catalog_not_configured`, `product_catalog_timeout`, `product_catalog_unavailable`, `product_catalog_not_configured` and `unsupported_product_quote`. Otherwise the product service's `detail`.",
    "content": {
     "application/json": {
      "schema": {
       "$ref": "#/components/schemas/Error"
      }
     }
    }
   },
   "ContainerRegistryValidationError": {
    "description": "The registry service rejected a parameter or the body (`detail` lists the invalid fields), or the selected storage plan is not sold here (`detail.code`, for example `billing_sku_unavailable` or `billing_selection_not_found`).",
    "content": {
     "application/json": {
      "schema": {
       "$ref": "#/components/schemas/Error"
      }
     }
    }
   }
  },
  "schemas": {
   "VmType": {
    "description": "Kind of virtual machine.\n- `cloud`: general-purpose cloud VM.\n- `gpu`: VM with attached GPUs.",
    "type": "string",
    "enum": [
     "cloud",
     "gpu"
    ]
   },
   "BillingInterval": {
    "description": "Billing period a price is quoted for.\n- `HOURLY`: price per hour of running time.\n- `MONTHLY`: price per calendar month (default).",
    "type": "string",
    "enum": [
     "HOURLY",
     "MONTHLY"
    ],
    "default": "MONTHLY"
   },
   "ComputeSite": {
    "description": "A placement site (data-centre location) that accepts VM creation.",
    "type": "object",
    "required": [
     "site_id",
     "name"
    ],
    "properties": {
     "site_id": {
      "example": "68b99bd78a8eda32ff3f16ea",
      "type": "string",
      "description": "Canonical opaque placement ID accepted by VM creation. Copy it exactly; do not substitute `site_code`, `region_id`, or `name`."
     },
     "site_code": {
      "description": "Short site code, when the catalog has one.",
      "type": "string",
      "nullable": true
     },
     "name": {
      "description": "Display name of the site.",
      "type": "string"
     },
     "location": {
      "description": "City or location label, as shown in the portal.",
      "type": "string",
      "nullable": true
     },
     "region_id": {
      "description": "ID of the region the site belongs to.",
      "type": "string",
      "nullable": true
     },
     "country_id": {
      "description": "ID of the country the site is in.",
      "type": "string",
      "nullable": true
     },
     "timezone": {
      "description": "IANA time zone of the site.",
      "type": "string",
      "nullable": true
     }
    }
   },
   "ComputeSiteList": {
    "description": "Sites returned by `GET /compute/sites`.",
    "type": "object",
    "required": [
     "sites",
     "count"
    ],
    "properties": {
     "sites": {
      "description": "Available sites.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ComputeSite"
      }
     },
     "count": {
      "description": "Number of items in `sites`.",
      "type": "integer",
      "minimum": 0
     }
    }
   },
   "ComputePlan": {
    "description": "A billable compute plan: the vCPU, memory, root-disk and (for GPU plans) GPU shape, with its catalog price.",
    "type": "object",
    "required": [
     "plan_id",
     "vm_type",
     "name",
     "code",
     "cpu",
     "ram_mb",
     "disk_gb",
     "gpu_count",
     "selectable",
     "pricing_status",
     "currency",
     "billing_interval"
    ],
    "properties": {
     "plan_id": {
      "example": "019f25b7-c1b3-7a9e-bfb9-8c83e323b517",
      "type": "string",
      "description": "Plan ID accepted by VM creation."
     },
     "vm_type": {
      "$ref": "#/components/schemas/VmType"
     },
     "name": {
      "description": "Display name of the plan.",
      "type": "string"
     },
     "code": {
      "description": "Plan SKU code from the billing catalog.",
      "type": "string"
     },
     "cpu": {
      "description": "vCPUs included in the plan.",
      "type": "integer",
      "minimum": 1
     },
     "ram_mb": {
      "description": "Memory included in the plan, in MB.",
      "type": "integer",
      "minimum": 512
     },
     "disk_gb": {
      "description": "Root disk included in the plan, in GB.",
      "type": "integer",
      "minimum": 10
     },
     "gpu_count": {
      "description": "GPUs included in the plan; 0 for cloud plans.",
      "type": "integer",
      "minimum": 0
     },
     "gpu_model": {
      "description": "GPU model for GPU plans, for example `A100`; null for cloud plans.",
      "type": "string",
      "nullable": true
     },
     "gpu_memory_gb": {
      "description": "GPU memory in GB as listed in the catalog; null for cloud plans.",
      "type": "number",
      "minimum": 0,
      "nullable": true
     },
     "selectable": {
      "description": "Whether the plan can be chosen for a new VM right now.",
      "type": "boolean"
     },
     "pricing_status": {
      "description": "- `priced`: the catalog has a price and the plan can be quoted.\n- `unpriced`: no catalog price; the plan cannot be used to create a VM.",
      "type": "string",
      "enum": [
       "priced",
       "unpriced"
      ]
     },
     "currency": {
      "description": "ISO 4217 code of the currency the price fields are in.",
      "type": "string"
     },
     "billing_interval": {
      "$ref": "#/components/schemas/BillingInterval"
     },
     "hourly_price_minor": {
      "description": "Hourly price in the currency's minor unit (for example paise for INR); null when not priced.",
      "type": "integer",
      "minimum": 0,
      "nullable": true
     },
     "monthly_price_minor": {
      "description": "Monthly price in the currency's minor unit; null when not priced.",
      "type": "integer",
      "minimum": 0,
      "nullable": true
     },
     "site_id": {
      "description": "Site the list was filtered by, when a `site_id` was given.",
      "type": "string",
      "nullable": true
     },
     "billing_catalog": {
      "type": "object",
      "additionalProperties": true,
      "nullable": true,
      "description": "Canonical billing SKU reference for this plan. Pass this object unmodified as `billing_catalog` when creating a VM with this plan — the same flow the portal uses. Treat it as opaque; its fields may grow over time. Billing charges are always computed server-side from `plan_id`, not from this echoed copy."
     }
    }
   },
   "ComputePlanList": {
    "description": "Plans returned by `GET /compute/plans`.",
    "type": "object",
    "required": [
     "plans",
     "count",
     "vm_type",
     "currency",
     "billing_interval"
    ],
    "properties": {
     "plans": {
      "description": "Plans matching the request.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ComputePlan"
      }
     },
     "count": {
      "description": "Number of items in `plans`.",
      "type": "integer",
      "minimum": 0
     },
     "vm_type": {
      "$ref": "#/components/schemas/VmType"
     },
     "site_id": {
      "description": "Site filter that was applied, when one was given.",
      "type": "string",
      "nullable": true
     },
     "currency": {
      "description": "ISO 4217 code of the currency the prices are quoted in.",
      "type": "string"
     },
     "billing_interval": {
      "$ref": "#/components/schemas/BillingInterval"
     }
    }
   },
   "ComputeImage": {
    "description": "An OS image (template) that VM creation accepts.",
    "type": "object",
    "required": [
     "template_id",
     "name",
     "os_distro",
     "os_type",
     "architecture",
     "size_bytes",
     "gpu_compatible",
     "compatible_vm_types",
     "site_ids"
    ],
    "properties": {
     "template_id": {
      "example": "tmpl_ubuntu_2204",
      "type": "string",
      "description": "Template ID accepted by VM creation."
     },
     "name": {
      "description": "Display name of the image.",
      "type": "string"
     },
     "description": {
      "description": "Description of the image, when the catalog has one.",
      "type": "string",
      "nullable": true
     },
     "os_distro": {
      "description": "OS distribution, for example `ubuntu`.",
      "type": "string"
     },
     "os_type": {
      "description": "OS family.\n- `linux`\n- `windows`",
      "type": "string",
      "enum": [
       "linux",
       "windows"
      ]
     },
     "distro_version": {
      "description": "Distribution version, for example `22.04`.",
      "type": "string",
      "nullable": true
     },
     "architecture": {
      "description": "CPU architecture, for example `x86_64`.",
      "type": "string"
     },
     "image_format": {
      "description": "Disk image format, for example `qcow2`, when known.",
      "type": "string",
      "nullable": true
     },
     "size_bytes": {
      "description": "Image size in bytes; 0 when unknown.",
      "type": "integer",
      "minimum": 0
     },
     "gpu_compatible": {
      "description": "Whether the image can be used for GPU VMs.",
      "type": "boolean"
     },
     "compatible_vm_types": {
      "description": "VM types the image can be used with.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/VmType"
      }
     },
     "site_ids": {
      "description": "Sites where the image is available.",
      "type": "array",
      "items": {
       "type": "string"
      }
     }
    }
   },
   "ComputeImageList": {
    "description": "Images returned by `GET /compute/images`.",
    "type": "object",
    "required": [
     "images",
     "count",
     "vm_type"
    ],
    "properties": {
     "images": {
      "description": "Images matching the request.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ComputeImage"
      }
     },
     "count": {
      "description": "Number of items in `images`.",
      "type": "integer",
      "minimum": 0
     },
     "vm_type": {
      "$ref": "#/components/schemas/VmType"
     },
     "site_id": {
      "description": "Site filter that was applied, when one was given.",
      "type": "string",
      "nullable": true
     }
    }
   },
   "NetworkingSite": {
    "description": "A site where VPCs and Reserved IPs can be created.",
    "type": "object",
    "required": [
     "site_id",
     "site_name",
     "available"
    ],
    "properties": {
     "site_id": {
      "example": "68b99bd78a8eda32ff3f16ea",
      "type": "string",
      "description": "Canonical opaque site identifier accepted by VPC and Reserved IP creation. Copy it exactly; do not substitute a region or site name."
     },
     "site_name": {
      "description": "Display name of the site.",
      "type": "string"
     },
     "available": {
      "description": "Whether the site currently accepts new VPCs and reservations.",
      "type": "boolean"
     },
     "message": {
      "description": "Why the site is unavailable, when it is.",
      "type": "string",
      "nullable": true
     }
    }
   },
   "CreateVpcRequest": {
    "description": "Body for creating a VPC.",
    "type": "object",
    "required": [
     "name",
     "site_id"
    ],
    "properties": {
     "name": {
      "description": "Display name of the VPC.",
      "type": "string",
      "minLength": 1,
      "maxLength": 80
     },
     "description": {
      "description": "Optional description.",
      "type": "string",
      "maxLength": 500,
      "default": ""
     },
     "site_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120,
      "example": "68b99bd78a8eda32ff3f16ea",
      "description": "Required network placement site. Copy `site_id` from `GET /networking/sites` and choose an entry where `available` is `true`. Do not use a region name."
     },
     "region": {
      "description": "Optional region label stored with the VPC.",
      "type": "string",
      "nullable": true
     },
     "cidr": {
      "type": "string",
      "nullable": true,
      "description": "RFC1918 IPv4 CIDR with a prefix between /22 and /28.",
      "example": "10.144.0.0/22"
     },
     "auto_cidr": {
      "description": "Let the service choose a free CIDR when `cidr` is omitted. Default true.",
      "type": "boolean",
      "default": true
     },
     "create_default_subnet": {
      "description": "Create a first subnet together with the VPC. Default true.",
      "type": "boolean",
      "default": true
     },
     "default_subnet_cidr": {
      "description": "CIDR for that first subnet; chosen automatically when omitted.",
      "type": "string",
      "nullable": true
     },
     "is_default": {
      "description": "Mark the VPC as the workspace's default VPC. Default false.",
      "type": "boolean",
      "default": false
     },
     "connectivity_type": {
      "type": "string",
      "enum": [
       "public",
       "private",
       "nat_gateway"
      ],
      "default": "public",
      "description": "The VPC's internet model; the server uses `public` when this is omitted. `public` keeps dedicated public IPs available to its VMs. `private` has no shared public edge, but a VM can still be given a Reserved IP. `nat_gateway` is a private VPC with managed outbound NAT and refuses dedicated public IPs."
     }
    }
   },
   "UpdateVpcRequest": {
    "description": "Body for renaming a VPC or changing its description.",
    "type": "object",
    "minProperties": 1,
    "properties": {
     "name": {
      "description": "New display name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 80
     },
     "description": {
      "description": "New description.",
      "type": "string",
      "maxLength": 500
     }
    }
   },
   "Vpc": {
    "description": "An isolated virtual network at one site.",
    "type": "object",
    "required": [
     "vpc_id",
     "organization_id",
     "workspace_id",
     "site_id",
     "name",
     "cidr",
     "status",
     "connectivity_type",
     "created_at",
     "updated_at"
    ],
    "properties": {
     "vpc_id": {
      "description": "Unique ID of the VPC.",
      "type": "string"
     },
     "account_id": {
      "description": "Legacy alias of `organization_id`.",
      "type": "string"
     },
     "organization_id": {
      "description": "ID of the owning organization.",
      "type": "string"
     },
     "workspace_id": {
      "description": "ID of the owning workspace.",
      "type": "string"
     },
     "site_id": {
      "description": "Site the VPC lives at.",
      "type": "string"
     },
     "name": {
      "description": "Display name of the VPC.",
      "type": "string"
     },
     "description": {
      "description": "Description of the VPC.",
      "type": "string"
     },
     "region": {
      "description": "Region label stored with the VPC, when set.",
      "type": "string",
      "nullable": true
     },
     "cidr": {
      "description": "IPv4 CIDR of the VPC.",
      "type": "string"
     },
     "status": {
      "$ref": "#/components/schemas/NetworkingResourceStatus"
     },
     "is_default": {
      "description": "Whether this is the workspace's default VPC.",
      "type": "boolean"
     },
     "connectivity_type": {
      "description": "The VPC's internet model.\n- `public`: instances may have dedicated public IPs.\n- `nat_gateway`: private VPC with managed outbound NAT; dedicated public IPs are not allowed.\n- `private`: no managed internet path.",
      "type": "string",
      "enum": [
       "public",
       "private",
       "nat_gateway"
      ]
     },
     "error_message": {
      "description": "Error detail when `status` is `error`.",
      "type": "string",
      "nullable": true
     },
     "created_at": {
      "description": "When the resource was created (ISO 8601).",
      "type": "string",
      "format": "date-time"
     },
     "updated_at": {
      "description": "When the resource was last changed (ISO 8601).",
      "type": "string",
      "format": "date-time"
     }
    }
   },
   "VpcSummary": {
    "description": "A VPC with its attached-node count and NAT gateway pricing.",
    "allOf": [
     {
      "$ref": "#/components/schemas/Vpc"
     },
     {
      "type": "object",
      "properties": {
       "node_count": {
        "description": "Number of VMs attached to the VPC.",
        "type": "integer",
        "minimum": 0
       },
       "nat_pricing": {
        "$ref": "#/components/schemas/NatPricing"
       }
      }
     }
    ]
   },
   "VpcDetail": {
    "description": "A VPC with its subnets, NAT gateways and attached VMs.",
    "allOf": [
     {
      "$ref": "#/components/schemas/VpcSummary"
     },
     {
      "type": "object",
      "properties": {
       "subnets": {
        "description": "Subnets in the VPC.",
        "type": "array",
        "items": {
         "$ref": "#/components/schemas/Subnet"
        }
       },
       "nat_gateways": {
        "description": "NAT gateways in the VPC.",
        "type": "array",
        "items": {
         "$ref": "#/components/schemas/NatGateway"
        }
       },
       "attached_nodes": {
        "description": "VMs attached to the VPC.",
        "type": "array",
        "items": {
         "$ref": "#/components/schemas/VpcAttachedNode"
        }
       }
      }
     }
    ]
   },
   "CreateSubnetRequest": {
    "description": "Body for adding a subnet to a VPC.",
    "type": "object",
    "required": [
     "name"
    ],
    "properties": {
     "name": {
      "description": "Display name of the subnet.",
      "type": "string",
      "minLength": 1,
      "maxLength": 80
     },
     "cidr": {
      "description": "IPv4 CIDR inside the VPC range. Chosen automatically when omitted and `auto_cidr` is true.",
      "type": "string",
      "nullable": true
     },
     "auto_cidr": {
      "description": "Let the service choose a free CIDR when `cidr` is omitted. Default true.",
      "type": "boolean",
      "default": true
     },
     "prefix_length": {
      "description": "Prefix length to use for an automatically chosen CIDR.",
      "type": "integer",
      "minimum": 22,
      "maximum": 29,
      "nullable": true
     },
     "dns": {
      "description": "DNS resolvers handed to instances in the subnet. Default `1.1.1.1` and `8.8.8.8`.",
      "type": "array",
      "items": {
       "type": "string"
      },
      "default": [
       "1.1.1.1",
       "8.8.8.8"
      ]
     }
    }
   },
   "UpdateSubnetRequest": {
    "description": "Body for renaming a subnet or changing its DNS resolvers.",
    "type": "object",
    "minProperties": 1,
    "properties": {
     "name": {
      "description": "New display name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 80
     },
     "dns": {
      "description": "New DNS resolvers handed to instances in the subnet.",
      "type": "array",
      "minItems": 1,
      "items": {
       "type": "string"
      }
     }
    }
   },
   "Subnet": {
    "description": "A subnet of a VPC.",
    "type": "object",
    "required": [
     "subnet_id",
     "vpc_id",
     "site_id",
     "name",
     "cidr",
     "gateway",
     "dns",
     "status",
     "created_at",
     "updated_at"
    ],
    "properties": {
     "subnet_id": {
      "description": "Unique ID of the subnet.",
      "type": "string"
     },
     "vpc_id": {
      "description": "VPC the subnet belongs to.",
      "type": "string"
     },
     "organization_id": {
      "description": "ID of the owning organization.",
      "type": "string"
     },
     "workspace_id": {
      "description": "ID of the owning workspace.",
      "type": "string"
     },
     "site_id": {
      "description": "Site the subnet lives at.",
      "type": "string"
     },
     "name": {
      "description": "Display name of the subnet.",
      "type": "string"
     },
     "cidr": {
      "description": "IPv4 CIDR of the subnet.",
      "type": "string"
     },
     "gateway": {
      "description": "Gateway IPv4 address of the subnet.",
      "type": "string"
     },
     "dns": {
      "description": "DNS resolvers handed to instances in the subnet.",
      "type": "array",
      "items": {
       "type": "string"
      }
     },
     "status": {
      "$ref": "#/components/schemas/NetworkingResourceStatus"
     },
     "error_message": {
      "description": "Error detail when `status` is `error`.",
      "type": "string",
      "nullable": true
     },
     "created_at": {
      "description": "When the resource was created (ISO 8601).",
      "type": "string",
      "format": "date-time"
     },
     "updated_at": {
      "description": "When the resource was last changed (ISO 8601).",
      "type": "string",
      "format": "date-time"
     }
    }
   },
   "AttachVpcNodeRequest": {
    "description": "Body for attaching a VM to a VPC subnet.",
    "type": "object",
    "required": [
     "vm_id",
     "subnet_id"
    ],
    "properties": {
     "vm_id": {
      "description": "ID of the VM to attach.",
      "type": "string"
     },
     "subnet_id": {
      "description": "Subnet of the VPC to attach the VM to.",
      "type": "string"
     },
     "connectivity": {
      "description": "How the VM reaches the internet from this subnet.\n- `private`: no internet path.\n- `public_ip`: a Reserved IP is attached to the allocation.\n- `nat`: outbound traffic goes through the VPC's NAT gateway.\n\nDefault `private`.",
      "type": "string",
      "enum": [
       "private",
       "public_ip",
       "nat"
      ],
      "default": "private"
     },
     "reserved_public_ip_id": {
      "description": "Reserved IP to attach to the VM. Only valid with `public_ip` connectivity.",
      "type": "string",
      "nullable": true
     }
    }
   },
   "NetworkAllocation": {
    "description": "A VM's attachment to a VPC subnet: its private address and how it reaches the internet.",
    "type": "object",
    "required": [
     "allocation_id",
     "vpc_id",
     "subnet_id",
     "vm_id",
     "connectivity",
     "private_ip",
     "prefix_length",
     "subnet_mask",
     "gateway",
     "dns",
     "status"
    ],
    "properties": {
     "allocation_id": {
      "description": "Unique ID of the attachment.",
      "type": "string"
     },
     "vpc_id": {
      "description": "VPC the VM is attached to.",
      "type": "string"
     },
     "subnet_id": {
      "description": "Subnet the VM is attached to.",
      "type": "string"
     },
     "vm_id": {
      "description": "ID of the attached VM.",
      "type": "string"
     },
     "connectivity": {
      "description": "How the VM reaches the internet from this subnet.\n- `private`: no internet path.\n- `public_ip`: a Reserved IP is attached to the allocation.\n- `nat`: outbound traffic goes through the VPC's NAT gateway.",
      "type": "string",
      "enum": [
       "private",
       "public_ip",
       "nat"
      ]
     },
     "private_ip": {
      "description": "Private IPv4 address assigned to the VM.",
      "type": "string"
     },
     "prefix_length": {
      "description": "Prefix length of the subnet.",
      "type": "integer"
     },
     "subnet_mask": {
      "description": "Subnet mask in dotted-decimal form.",
      "type": "string"
     },
     "gateway": {
      "description": "Gateway IPv4 address of the subnet.",
      "type": "string"
     },
     "dns": {
      "description": "DNS resolvers handed to the VM.",
      "type": "array",
      "items": {
       "type": "string"
      }
     },
     "public_ip_id": {
      "description": "Reserved IP attached to the allocation, when `connectivity` is `public_ip`.",
      "type": "string",
      "nullable": true
     },
     "public_ip": {
      "description": "Address of that Reserved IP.",
      "type": "string",
      "nullable": true
     },
     "nat_gateway_id": {
      "description": "NAT gateway used, when `connectivity` is `nat`.",
      "type": "string",
      "nullable": true
     },
     "nat_public_ip": {
      "description": "Public address of that NAT gateway.",
      "type": "string",
      "nullable": true
     },
     "status": {
      "description": "Attachment state: `reserved`, `attaching`, `attached`, `moving`, `detaching` or `releasing`.",
      "type": "string"
     }
    }
   },
   "VpcAttachedNode": {
    "description": "Summary of a VM attached to a VPC.",
    "type": "object",
    "properties": {
     "allocation_id": {
      "description": "ID of the attachment.",
      "type": "string"
     },
     "vm_id": {
      "description": "ID of the attached VM.",
      "type": "string"
     },
     "subnet_id": {
      "description": "Subnet the VM is attached to.",
      "type": "string"
     },
     "private_ip": {
      "description": "Private IPv4 address assigned to the VM.",
      "type": "string"
     },
     "connectivity": {
      "description": "How the VM reaches the internet from this subnet.\n- `private`: no internet path.\n- `public_ip`: a Reserved IP is attached to the allocation.\n- `nat`: outbound traffic goes through the VPC's NAT gateway.",
      "type": "string",
      "enum": [
       "private",
       "public_ip",
       "nat"
      ]
     },
     "public_ip": {
      "description": "Reserved IP address attached to the VM, when `connectivity` is `public_ip`.",
      "type": "string",
      "nullable": true
     },
     "nat_public_ip": {
      "description": "Public address of the NAT gateway used, when `connectivity` is `nat`.",
      "type": "string",
      "nullable": true
     },
     "status": {
      "description": "Attachment state: `reserved`, `attaching`, `attached`, `moving`, `detaching` or `releasing`.",
      "type": "string"
     },
     "attached_at": {
      "description": "When the VM was attached (ISO 8601).",
      "type": "string",
      "format": "date-time"
     }
    }
   },
   "CreateNatGatewayRequest": {
    "description": "Body for adding a NAT gateway to a VPC.",
    "type": "object",
    "properties": {
     "subnet_id": {
      "description": "Subnet the gateway is placed in; chosen by the service when omitted.",
      "type": "string",
      "nullable": true
     },
     "reserved_public_ip_id": {
      "description": "Reserved IP to use as the gateway's public address; a platform-assigned address is used when omitted.",
      "type": "string",
      "nullable": true
     },
     "name": {
      "description": "Display name of the gateway. Default `NAT Gateway`.",
      "type": "string",
      "minLength": 1,
      "maxLength": 80,
      "default": "NAT Gateway"
     }
    }
   },
   "NatPricing": {
    "description": "Price of a NAT gateway as recorded when it was created.",
    "type": "object",
    "properties": {
     "currency": {
      "description": "ISO 4217 code of the currency the prices are in.",
      "type": "string",
      "default": "USD"
     },
     "price_per_hour": {
      "description": "Hourly charge for the gateway.",
      "type": "number",
      "default": 0
     },
     "data_price_per_gb": {
      "description": "Charge per GB of data processed.",
      "type": "number",
      "default": 0
     },
     "billing_enforced": {
      "description": "Whether these charges are being applied.",
      "type": "boolean",
      "default": false
     }
    }
   },
   "NatGateway": {
    "description": "A managed NAT gateway that gives a VPC's VMs outbound internet access through one public address.",
    "type": "object",
    "required": [
     "nat_gateway_id",
     "vpc_id",
     "site_id",
     "name",
     "public_ip_id",
     "public_ip",
     "status"
    ],
    "properties": {
     "nat_gateway_id": {
      "description": "Unique ID of the gateway.",
      "type": "string"
     },
     "vpc_id": {
      "description": "VPC the gateway serves.",
      "type": "string"
     },
     "subnet_id": {
      "description": "Subnet the gateway is placed in.",
      "type": "string",
      "nullable": true
     },
     "organization_id": {
      "description": "ID of the owning organization.",
      "type": "string"
     },
     "workspace_id": {
      "description": "ID of the owning workspace.",
      "type": "string"
     },
     "site_id": {
      "description": "Site the gateway lives at.",
      "type": "string"
     },
     "name": {
      "description": "Display name of the gateway.",
      "type": "string"
     },
     "public_ip_id": {
      "description": "ID of the public IP the gateway uses.",
      "type": "string"
     },
     "public_ip": {
      "description": "Public IPv4 address of the gateway.",
      "type": "string"
     },
     "status": {
      "$ref": "#/components/schemas/NetworkingResourceStatus"
     },
     "pricing": {
      "$ref": "#/components/schemas/NatPricing"
     },
     "error_message": {
      "description": "Error detail when `status` is `error`.",
      "type": "string",
      "nullable": true
     }
    }
   },
   "CreateNatPortForwardingRuleRequest": {
    "description": "Body for forwarding a port on the NAT gateway's public address to a VM in the VPC.",
    "type": "object",
    "required": [
     "name",
     "external_port",
     "internal_ip",
     "internal_port"
    ],
    "properties": {
     "name": {
      "description": "Display name of the rule.",
      "type": "string",
      "minLength": 1,
      "maxLength": 80
     },
     "protocol": {
      "description": "- `tcp` (default)\n- `udp`",
      "type": "string",
      "enum": [
       "tcp",
       "udp"
      ],
      "default": "tcp"
     },
     "external_port": {
      "description": "Port on the gateway's public address (1-65535).",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
     },
     "internal_ip": {
      "description": "Private IPv4 address of the VM inside the VPC that receives the traffic.",
      "type": "string"
     },
     "internal_port": {
      "description": "Port on the VM that receives the traffic (1-65535).",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
     },
     "note": {
      "description": "Free-text note stored with the rule. Default empty.",
      "type": "string",
      "maxLength": 500,
      "default": ""
     },
     "enabled": {
      "description": "Whether the rule is applied. Default true.",
      "type": "boolean",
      "default": true
     }
    }
   },
   "UpdateNatPortForwardingRuleRequest": {
    "description": "Body for changing a port-forwarding rule. Only the fields sent are changed.",
    "type": "object",
    "minProperties": 1,
    "properties": {
     "name": {
      "description": "Display name of the rule.",
      "type": "string",
      "minLength": 1,
      "maxLength": 80
     },
     "protocol": {
      "description": "- `tcp`\n- `udp`",
      "type": "string",
      "enum": [
       "tcp",
       "udp"
      ]
     },
     "external_port": {
      "description": "Port on the gateway's public address (1-65535).",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
     },
     "internal_ip": {
      "description": "Private IPv4 address of the VM inside the VPC that receives the traffic.",
      "type": "string"
     },
     "internal_port": {
      "description": "Port on the VM that receives the traffic (1-65535).",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
     },
     "note": {
      "description": "Free-text note stored with the rule.",
      "type": "string",
      "maxLength": 500
     },
     "enabled": {
      "description": "Whether the rule is applied.",
      "type": "boolean"
     }
    }
   },
   "NatPortForwardingRule": {
    "description": "A port-forwarding rule on a NAT gateway.",
    "allOf": [
     {
      "$ref": "#/components/schemas/CreateNatPortForwardingRuleRequest"
     },
     {
      "type": "object",
      "required": [
       "port_forward_rule_id",
       "vpc_id",
       "nat_gateway_id",
       "status",
       "created_at",
       "updated_at"
      ],
      "properties": {
       "port_forward_rule_id": {
        "description": "Unique ID of the rule.",
        "type": "string"
       },
       "vpc_id": {
        "description": "VPC the rule belongs to.",
        "type": "string"
       },
       "nat_gateway_id": {
        "description": "NAT gateway the rule is configured on.",
        "type": "string"
       },
       "organization_id": {
        "description": "ID of the owning organization.",
        "type": "string"
       },
       "workspace_id": {
        "description": "ID of the owning workspace.",
        "type": "string"
       },
       "site_id": {
        "description": "Site the gateway lives at.",
        "type": "string"
       },
       "status": {
        "$ref": "#/components/schemas/NetworkingResourceStatus"
       },
       "error_message": {
        "description": "Error detail when `status` is `error`.",
        "type": "string",
        "nullable": true
       },
       "created_at": {
        "description": "When the rule was created (ISO 8601).",
        "type": "string",
        "format": "date-time"
       },
       "updated_at": {
        "description": "When the rule was last changed (ISO 8601).",
        "type": "string",
        "format": "date-time"
       }
      }
     }
    ]
   },
   "ReserveIpRequest": {
    "description": "Body for reserving a new public IPv4 address.",
    "type": "object",
    "required": [
     "site_id"
    ],
    "properties": {
     "site_id": {
      "type": "string",
      "example": "68b99bd78a8eda32ff3f16ea",
      "description": "Site whose public IP pool allocates the address. Copy an available `site_id` from `GET /networking/sites`; use the target VM or VPC's site when the address will be attached."
     },
     "label": {
      "description": "Optional label for the address (up to 120 characters), shown as its name in the portal.",
      "type": "string",
      "maxLength": 120,
      "default": ""
     }
    }
   },
   "UpdateReservedIpRequest": {
    "description": "Body for changing a Reserved IP's label or reverse DNS. The address itself does not change.",
    "type": "object",
    "minProperties": 1,
    "properties": {
     "label": {
      "description": "New label (the portal's **Name**).",
      "type": "string",
      "maxLength": 120
     },
     "reverse_dns": {
      "description": "Reverse DNS hostname for the address, as a fully qualified domain name.",
      "type": "string",
      "maxLength": 253
     }
    }
   },
   "AttachReservedIpRequest": {
    "description": "Body for attaching a Reserved IP to a VM, either on the VM's own public network or inside a VPC.",
    "type": "object",
    "required": [
     "vm_id"
    ],
    "properties": {
     "vm_id": {
      "description": "ID of the VM to attach the address to.",
      "type": "string"
     },
     "vpc_id": {
      "description": "VPC of the VM when attaching inside a VPC. Send together with `subnet_id`.",
      "type": "string",
      "nullable": true
     },
     "subnet_id": {
      "description": "Subnet of the VM's VPC attachment. Send together with `vpc_id`.",
      "type": "string",
      "nullable": true
     }
    }
   },
   "ReservedIp": {
    "description": "A portable public IPv4 address reserved by the workspace. It stays allocated until released and can be moved between VMs.",
    "type": "object",
    "required": [
     "public_ip_id",
     "address",
     "site_id",
     "status",
     "created_at",
     "updated_at"
    ],
    "properties": {
     "public_ip_id": {
      "description": "Unique ID of the Reserved IP.",
      "type": "string"
     },
     "address": {
      "description": "The IPv4 address.",
      "type": "string"
     },
     "organization_id": {
      "description": "ID of the owning organization.",
      "type": "string"
     },
     "workspace_id": {
      "description": "ID of the owning workspace.",
      "type": "string"
     },
     "site_id": {
      "description": "Site whose pool the address comes from.",
      "type": "string"
     },
     "label": {
      "description": "Label shown as the address's name in the portal.",
      "type": "string"
     },
     "reverse_dns": {
      "description": "Reverse DNS hostname set on the address; empty when none.",
      "type": "string"
     },
     "status": {
      "description": "`reserved` when not attached, `attached` when in use, `releasing` while being released.",
      "type": "string"
     },
     "reservation_type": {
      "description": "- `user_reserved`: a Reserved IP created by the customer.\n- `platform_assigned`: an address IBEE assigned to an instance or service.\nNull on legacy records whose classification the service infers.",
      "type": "string",
      "enum": [
       "user_reserved",
       "platform_assigned"
      ],
      "nullable": true
     },
     "attached_resource_type": {
      "description": "Kind of resource the address is attached to, for example `vm` or `nat_gateway`; null when not attached.",
      "type": "string",
      "nullable": true
     },
     "attached_resource_id": {
      "description": "ID of that resource; null when not attached.",
      "type": "string",
      "nullable": true
     },
     "attached_vpc_id": {
      "description": "VPC of the attachment, when the address is attached inside a VPC.",
      "type": "string",
      "nullable": true
     },
     "attached_subnet_id": {
      "description": "Subnet of the attachment, when the address is attached inside a VPC.",
      "type": "string",
      "nullable": true
     },
     "created_at": {
      "description": "When the resource was created (ISO 8601).",
      "type": "string",
      "format": "date-time"
     },
     "updated_at": {
      "description": "When the resource was last changed (ISO 8601).",
      "type": "string",
      "format": "date-time"
     }
    }
   },
   "NetworkingResourceStatus": {
    "description": "Lifecycle status of a VPC, subnet, NAT gateway or port-forwarding rule.\n- `provisioning`: being created.\n- `available`: ready for use.\n- `error`: the last change failed; see `error_message`.\n- `deleting`: being removed.",
    "type": "string",
    "enum": [
     "provisioning",
     "available",
     "error",
     "deleting"
    ]
   },
   "CreateFirewallGroupRequest": {
    "description": "Body for creating a firewall group.",
    "type": "object",
    "required": [
     "name"
    ],
    "properties": {
     "name": {
      "description": "Display name of the group.",
      "type": "string",
      "minLength": 1,
      "maxLength": 120
     },
     "description": {
      "description": "Optional description.",
      "type": "string",
      "nullable": true
     },
     "is_default": {
      "description": "Mark the group as the workspace's default group. Default false.",
      "type": "boolean",
      "default": false
     }
    }
   },
   "FirewallRuleFields": {
    "description": "Fields shared by firewall rule create and update bodies.",
    "type": "object",
    "properties": {
     "description": {
      "description": "Optional description of the rule.",
      "type": "string",
      "nullable": true
     },
     "direction": {
      "description": "- `ingress`: traffic into the VM (default).\n- `egress`: traffic out of the VM.",
      "type": "string",
      "enum": [
       "ingress",
       "egress"
      ],
      "default": "ingress"
     },
     "protocol": {
      "description": "- `tcp` (default)\n- `udp`\n- `icmp`\n- `any`: all protocols.",
      "type": "string",
      "enum": [
       "tcp",
       "udp",
       "icmp",
       "any"
      ],
      "default": "tcp"
     },
     "port_start": {
      "description": "First port of the range (1-65535). Required for `tcp` and `udp`; ignored for other protocols.",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535,
      "nullable": true
     },
     "port_end": {
      "description": "Last port of the range (1-65535). Defaults to `port_start`.",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535,
      "nullable": true
     },
     "remote_targets": {
      "description": "Remote IPv4 addresses or CIDRs the rule matches, for example `0.0.0.0/0`.",
      "type": "array",
      "items": {
       "type": "string"
      }
     },
     "action": {
      "description": "- `allow`: let matching traffic through (default).\n- `drop`: discard matching traffic.",
      "type": "string",
      "enum": [
       "allow",
       "drop"
      ],
      "default": "allow"
     },
     "priority": {
      "description": "Evaluation priority of the rule.",
      "type": "integer",
      "nullable": true
     }
    }
   },
   "CreateFirewallRuleRequest": {
    "description": "Body for adding a rule to a firewall group.",
    "allOf": [
     {
      "$ref": "#/components/schemas/FirewallRuleFields"
     }
    ]
   },
   "UpdateFirewallRuleRequest": {
    "description": "Body for changing a firewall rule. Only the fields sent are changed.",
    "allOf": [
     {
      "$ref": "#/components/schemas/FirewallRuleFields"
     },
     {
      "type": "object",
      "minProperties": 1,
      "properties": {
       "enabled": {
        "description": "Whether the rule is applied.",
        "type": "boolean"
       }
      }
     }
    ]
   },
   "FirewallRule": {
    "description": "A rule in a firewall group.",
    "allOf": [
     {
      "$ref": "#/components/schemas/FirewallRuleFields"
     },
     {
      "type": "object",
      "required": [
       "rule_id",
       "direction",
       "protocol",
       "action",
       "enabled",
       "system_managed",
       "created_at",
       "updated_at"
      ],
      "properties": {
       "rule_id": {
        "description": "Unique ID of the rule.",
        "type": "string"
       },
       "enabled": {
        "description": "Whether the rule is applied.",
        "type": "boolean"
       },
       "system_managed": {
        "description": "True for rules the platform manages.",
        "type": "boolean"
       },
       "created_at": {
        "description": "When the rule was created (ISO 8601).",
        "type": "string",
        "format": "date-time"
       },
       "updated_at": {
        "description": "When the rule was last changed (ISO 8601).",
        "type": "string",
        "format": "date-time"
       }
      }
     }
    ]
   },
   "FirewallGroup": {
    "description": "A stateful firewall group: a named set of rules applied to the VMs attached to it.",
    "type": "object",
    "required": [
     "firewall_group_id",
     "organization_id",
     "workspace_id",
     "name",
     "is_default",
     "status",
     "rules",
     "created_at",
     "updated_at"
    ],
    "properties": {
     "firewall_group_id": {
      "description": "Unique ID of the group.",
      "type": "string"
     },
     "organization_id": {
      "description": "ID of the owning organization.",
      "type": "string"
     },
     "workspace_id": {
      "description": "ID of the owning workspace.",
      "type": "string"
     },
     "workspace_name": {
      "description": "Display name of the workspace.",
      "type": "string"
     },
     "name": {
      "description": "Display name of the group.",
      "type": "string"
     },
     "description": {
      "description": "Description of the group.",
      "type": "string",
      "nullable": true
     },
     "is_default": {
      "description": "Whether this is the workspace's default group.",
      "type": "boolean"
     },
     "status": {
      "description": "Status of the group; `active` when usable.",
      "type": "string"
     },
     "linked_instance_count": {
      "description": "Number of VMs the group is attached to.",
      "type": "integer",
      "minimum": 0
     },
     "rules": {
      "description": "Rules in the group.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/FirewallRule"
      }
     },
     "created_at": {
      "description": "When the resource was created (ISO 8601).",
      "type": "string",
      "format": "date-time"
     },
     "updated_at": {
      "description": "When the resource was last changed (ISO 8601).",
      "type": "string",
      "format": "date-time"
     }
    }
   },
   "FirewallAttachmentRequest": {
    "description": "Body for attaching a firewall group to a VM.",
    "type": "object",
    "required": [
     "vm_id"
    ],
    "properties": {
     "vm_id": {
      "description": "ID of the VM.",
      "type": "string"
     }
    }
   },
   "FirewallAttachment": {
    "description": "A VM the firewall group is applied to.",
    "type": "object",
    "required": [
     "network_id",
     "vm_id"
    ],
    "additionalProperties": true,
    "properties": {
     "network_id": {
      "description": "ID of the VM network record the group is attached to.",
      "type": "string"
     },
     "vm_id": {
      "description": "ID of the VM.",
      "type": "string"
     }
    }
   },
   "LoadBalancerProtocol": {
    "description": "Protocol the load balancer accepts.\n- `http`, `https`: L7 load balancers.\n- `tcp`: L4 pass-through of TCP connections.\n- `tls_passthrough`: L4 pass-through of TLS connections without terminating them.",
    "type": "string",
    "enum": [
     "http",
     "https",
     "tcp",
     "tls_passthrough"
    ]
   },
   "LoadBalancerStatus": {
    "description": "Lifecycle status of a load balancer.\n- `provisioning`: being created.\n- `active`: serving traffic.\n- `failed`: provisioning failed; see `error_message` on the status endpoint.\n- `deleting`: being removed.\n- `deleted`: removed.",
    "type": "string",
    "enum": [
     "provisioning",
     "active",
     "failed",
     "deleting",
     "deleted"
    ]
   },
   "LoadBalancerBackend": {
    "description": "A backend the load balancer sends traffic to.",
    "type": "object",
    "required": [
     "target",
     "port"
    ],
    "properties": {
     "type": {
      "description": "- `service`: a Kubernetes service name (default).\n- `ip`: an IP address.\n- `hostname`: a fully qualified domain name.",
      "type": "string",
      "enum": [
       "service",
       "ip",
       "hostname"
      ],
      "default": "service"
     },
     "target": {
      "description": "Backend address: a service name, an IP address or an FQDN, depending on `type`.",
      "type": "string"
     },
     "port": {
      "description": "Backend port (1-65535).",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
     },
     "weight": {
      "description": "Relative weight for traffic distribution (1-1000). Default 100.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000,
      "default": 100
     },
     "tls": {
      "description": "Use TLS between the load balancer and the backend. Default false.",
      "type": "boolean",
      "default": false
     }
    }
   },
   "LoadBalancerRouting": {
    "description": "How requests are distributed across backends.",
    "type": "object",
    "properties": {
     "algorithm": {
      "description": "- `round_robin`: backends in turn (default).\n- `least_request`: the backend with the fewest active requests.\n- `random`: a random backend.\n- `consistent_hash`: the same backend for the same `sticky_header` value.",
      "type": "string",
      "enum": [
       "round_robin",
       "least_request",
       "random",
       "consistent_hash"
      ],
      "default": "round_robin"
     },
     "sticky_header": {
      "description": "Request header whose value selects the backend with `consistent_hash`.",
      "type": "string",
      "nullable": true
     }
    }
   },
   "LoadBalancerTls": {
    "description": "TLS settings for the load balancer's listener.",
    "type": "object",
    "required": [
     "mode"
    ],
    "properties": {
     "mode": {
      "description": "- `terminate`: TLS ends at the load balancer.\n- `passthrough`: TLS is forwarded to the backend unchanged.",
      "type": "string",
      "enum": [
       "terminate",
       "passthrough"
      ]
     },
     "certificate_source": {
      "description": "`managed` for a platform-issued certificate, or `custom` to supply `cert_pem` and `key_pem`. Default `managed`.",
      "type": "string",
      "default": "managed"
     },
     "cert_pem": {
      "description": "PEM-encoded certificate chain; required with `certificate_source: custom`.",
      "type": "string",
      "nullable": true
     },
     "key_pem": {
      "description": "PEM-encoded private key; required with `certificate_source: custom`.",
      "type": "string",
      "nullable": true
     }
    }
   },
   "LoadBalancerRule": {
    "description": "An L7 routing rule.",
    "type": "object",
    "properties": {
     "priority": {
      "description": "Order in which rules are evaluated; lower values first. Default 1.",
      "type": "integer",
      "minimum": 1,
      "default": 1
     },
     "path_prefix": {
      "description": "Request path prefix the rule matches. Default `/`.",
      "type": "string",
      "default": "/"
     },
     "headers": {
      "description": "Header names and values a request must carry to match.",
      "type": "object",
      "additionalProperties": {
       "type": "string"
      },
      "nullable": true
     },
     "backends": {
      "description": "Backends for matching requests; the load balancer's own backends are used when omitted.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/LoadBalancerBackend"
      },
      "nullable": true
     }
    }
   },
   "CreateL4LoadBalancerRequest": {
    "description": "Body for creating an L4 (TCP or TLS pass-through) load balancer.",
    "type": "object",
    "required": [
     "name",
     "protocol",
     "backends"
    ],
    "properties": {
     "name": {
      "description": "Display name of the load balancer.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
     },
     "protocol": {
      "description": "- `tcp`\n- `tls_passthrough`",
      "type": "string",
      "enum": [
       "tcp",
       "tls_passthrough"
      ]
     },
     "backends": {
      "description": "Backends to send traffic to.",
      "type": "array",
      "minItems": 1,
      "items": {
       "$ref": "#/components/schemas/LoadBalancerBackend"
      }
     },
     "routing": {
      "$ref": "#/components/schemas/LoadBalancerRouting"
     },
     "tls": {
      "$ref": "#/components/schemas/LoadBalancerTls"
     }
    }
   },
   "CreateL7LoadBalancerRequest": {
    "description": "Body for creating an L7 (HTTP or HTTPS) load balancer.",
    "type": "object",
    "required": [
     "name",
     "protocol",
     "backends"
    ],
    "properties": {
     "name": {
      "description": "Display name of the load balancer.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
     },
     "protocol": {
      "description": "- `http`\n- `https`",
      "type": "string",
      "enum": [
       "http",
       "https"
      ]
     },
     "backends": {
      "description": "Default backends for requests no rule matches.",
      "type": "array",
      "minItems": 1,
      "items": {
       "$ref": "#/components/schemas/LoadBalancerBackend"
      }
     },
     "routing": {
      "$ref": "#/components/schemas/LoadBalancerRouting"
     },
     "tls": {
      "$ref": "#/components/schemas/LoadBalancerTls"
     },
     "custom_domain": {
      "description": "Custom hostname to serve. Point its DNS CNAME at the load balancer's endpoint host.",
      "type": "object",
      "nullable": true,
      "properties": {
       "hostname": {
        "description": "Fully qualified domain name to serve.",
        "type": "string"
       }
      }
     },
     "rules": {
      "description": "Path- and header-based routing rules.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/LoadBalancerRule"
      }
     }
    }
   },
   "UpdateL4LoadBalancerRequest": {
    "description": "Body for changing an L4 load balancer. Only the fields sent are changed.",
    "type": "object",
    "minProperties": 1,
    "properties": {
     "name": {
      "description": "New display name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
     },
     "backends": {
      "description": "Replacement backend list.",
      "type": "array",
      "minItems": 1,
      "items": {
       "$ref": "#/components/schemas/LoadBalancerBackend"
      }
     },
     "routing": {
      "$ref": "#/components/schemas/LoadBalancerRouting"
     },
     "tls": {
      "$ref": "#/components/schemas/LoadBalancerTls"
     }
    }
   },
   "UpdateL7LoadBalancerRequest": {
    "description": "Body for changing an L7 load balancer. Only the fields sent are changed.",
    "type": "object",
    "minProperties": 1,
    "properties": {
     "name": {
      "description": "New display name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
     },
     "backends": {
      "description": "Replacement default backend list.",
      "type": "array",
      "minItems": 1,
      "items": {
       "$ref": "#/components/schemas/LoadBalancerBackend"
      }
     },
     "routing": {
      "$ref": "#/components/schemas/LoadBalancerRouting"
     },
     "tls": {
      "$ref": "#/components/schemas/LoadBalancerTls"
     },
     "custom_domain": {
      "description": "Custom hostname to serve. Point its DNS CNAME at the load balancer's endpoint host.",
      "type": "object",
      "nullable": true,
      "properties": {
       "hostname": {
        "description": "Fully qualified domain name to serve.",
        "type": "string"
       }
      }
     },
     "rules": {
      "description": "Replacement routing rules.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/LoadBalancerRule"
      }
     }
    }
   },
   "LoadBalancer": {
    "description": "A load balancer.",
    "type": "object",
    "required": [
     "lb_id",
     "organization_id",
     "workspace_id",
     "name",
     "layer",
     "protocol",
     "status",
     "endpoint",
     "url",
     "endpoint_url",
     "backends",
     "created_at",
     "updated_at"
    ],
    "properties": {
     "lb_id": {
      "description": "Unique ID of the load balancer.",
      "type": "string"
     },
     "organization_id": {
      "description": "ID of the owning organization.",
      "type": "string"
     },
     "workspace_id": {
      "description": "ID of the owning workspace.",
      "type": "string"
     },
     "workspace_name": {
      "description": "Display name of the workspace.",
      "type": "string"
     },
     "name": {
      "description": "Display name of the load balancer.",
      "type": "string"
     },
     "layer": {
      "description": "- `l4`: TCP or TLS pass-through.\n- `l7`: HTTP or HTTPS.",
      "type": "string",
      "enum": [
       "l4",
       "l7"
      ]
     },
     "protocol": {
      "$ref": "#/components/schemas/LoadBalancerProtocol"
     },
     "status": {
      "$ref": "#/components/schemas/LoadBalancerStatus"
     },
     "endpoint": {
      "$ref": "#/components/schemas/LoadBalancerEndpoint"
     },
     "url": {
      "description": "Public hostname of the load balancer.",
      "type": "string"
     },
     "endpoint_url": {
      "description": "URL with scheme and, for L4, port: for example `https://host` or `tcp://host:443`.",
      "type": "string"
     },
     "namespace": {
      "description": "Kubernetes namespace the load balancer runs in.",
      "type": "string"
     },
     "backends": {
      "description": "Backends the load balancer sends traffic to.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/LoadBalancerBackend"
      }
     },
     "rules": {
      "description": "L7 routing rules; null for L4 load balancers.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/LoadBalancerRule"
      },
      "nullable": true
     },
     "created_at": {
      "description": "When the resource was created (ISO 8601).",
      "type": "string",
      "format": "date-time"
     },
     "updated_at": {
      "description": "When the resource was last changed (ISO 8601).",
      "type": "string",
      "format": "date-time"
     }
    }
   },
   "LoadBalancerEndpoint": {
    "description": "Where clients connect to the load balancer.",
    "type": "object",
    "required": [
     "host",
     "port"
    ],
    "properties": {
     "host": {
      "description": "Public hostname.",
      "type": "string"
     },
     "port": {
      "description": "Listener port.",
      "type": "integer"
     }
    }
   },
   "LoadBalancerStatusResponse": {
    "description": "Provisioning status of a load balancer.",
    "type": "object",
    "required": [
     "lb_id",
     "status",
     "endpoint",
     "url",
     "endpoint_url",
     "updated_at"
    ],
    "properties": {
     "lb_id": {
      "description": "ID of the load balancer.",
      "type": "string"
     },
     "status": {
      "$ref": "#/components/schemas/LoadBalancerStatus"
     },
     "endpoint": {
      "$ref": "#/components/schemas/LoadBalancerEndpoint"
     },
     "url": {
      "description": "Public hostname of the load balancer.",
      "type": "string"
     },
     "endpoint_url": {
      "description": "URL with scheme and, for L4, port.",
      "type": "string"
     },
     "conditions": {
      "description": "Provisioning conditions reported by the platform, passed through as returned.",
      "type": "array",
      "items": {
       "type": "object",
       "additionalProperties": true
      }
     },
     "error_message": {
      "description": "Error detail when `status` is `failed`.",
      "type": "string",
      "nullable": true
     },
     "updated_at": {
      "description": "When the status last changed (ISO 8601).",
      "type": "string",
      "format": "date-time"
     }
    }
   },
   "CreateSecretStoreRequest": {
    "description": "Body for creating a secret store.",
    "type": "object",
    "required": [
     "name"
    ],
    "properties": {
     "name": {
      "description": "Display name of the store (1-128 characters). Its URL-safe form becomes `store_key`.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "example": "production-secrets"
     },
     "description": {
      "description": "Optional description.",
      "type": "string",
      "example": "Secrets for production workloads"
     }
    }
   },
   "UpdateSecretStoreRequest": {
    "description": "Body for renaming a store or changing its description.",
    "type": "object",
    "properties": {
     "name": {
      "description": "New display name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "example": "production-secrets"
     },
     "description": {
      "description": "New description.",
      "type": "string",
      "example": "Updated description"
     }
    }
   },
   "SecretStore": {
    "description": "A secret store: a named container for secrets inside a workspace.",
    "type": "object",
    "properties": {
     "id": {
      "description": "Unique ID of the store.",
      "type": "string",
      "example": "store_123"
     },
     "organization_id": {
      "description": "ID of the owning organization.",
      "type": "string",
      "example": "250612"
     },
     "workspace_id": {
      "description": "ID of the owning workspace.",
      "type": "string",
      "example": "907479"
     },
     "name": {
      "description": "Display name of the store.",
      "type": "string",
      "example": "production-secrets"
     },
     "store_key": {
      "type": "string",
      "description": "URL-safe slug derived from the store name.",
      "example": "production-secrets"
     },
     "description": {
      "description": "Description of the store.",
      "type": "string",
      "example": "Secrets for production workloads"
     },
     "status": {
      "description": "- `active`: in use.\n- `archived`: archived; can be unarchived.\n- `deleting`: permanent deletion in progress.",
      "type": "string",
      "enum": [
       "active",
       "archived",
       "deleting"
      ],
      "example": "active"
     },
     "created_at": {
      "description": "When the record was created (ISO 8601).",
      "type": "string",
      "format": "date-time"
     },
     "updated_at": {
      "description": "When the record was last changed (ISO 8601).",
      "type": "string",
      "format": "date-time"
     }
    }
   },
   "SecretStoreList": {
    "description": "A page of secret stores.",
    "type": "object",
    "properties": {
     "stores": {
      "description": "Stores on this page.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/SecretStore"
      }
     },
     "total": {
      "description": "Total number of items matching the request.",
      "type": "integer",
      "example": 1
     },
     "page": {
      "description": "Page number returned (1-based).",
      "type": "integer",
      "example": 1
     },
     "limit": {
      "description": "Page size that was applied.",
      "type": "integer",
      "example": 50
     }
    }
   },
   "CreateSecretRequest": {
    "description": "Body for creating a secret in a store.",
    "type": "object",
    "required": [
     "secret_name",
     "value"
    ],
    "properties": {
     "secret_name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[a-z0-9][a-z0-9-]{1,63}$",
      "description": "Unique name for the secret within the store. Lowercase alphanumeric and hyphens only.",
      "example": "database-url"
     },
     "value": {
      "type": "object",
      "additionalProperties": true,
      "description": "Key-value pairs containing the secret data.",
      "example": {
       "url": "postgres://user:pass@host:5432/mydb"
      }
     }
    }
   },
   "UpdateSecretValueRequest": {
    "description": "Body for replacing a secret's value. Creates a new version.",
    "type": "object",
    "required": [
     "value"
    ],
    "properties": {
     "value": {
      "type": "object",
      "additionalProperties": true,
      "description": "Key-value pairs containing the new secret data. Creates a new version."
     },
     "cas": {
      "type": "integer",
      "nullable": true,
      "description": "Check-and-set: only update if the current version matches this number. Prevents overwriting concurrent changes."
     }
    }
   },
   "PatchSecretValueRequest": {
    "description": "Body for merging keys into a secret's current value. Creates a new version.",
    "type": "object",
    "required": [
     "value"
    ],
    "properties": {
     "value": {
      "type": "object",
      "additionalProperties": true,
      "description": "Key-value pairs to merge into the current value. Creates a new version."
     }
    }
   },
   "SecretVersionsRequest": {
    "description": "Body naming the secret versions to act on.",
    "type": "object",
    "required": [
     "versions"
    ],
    "properties": {
     "versions": {
      "type": "array",
      "minItems": 1,
      "maxItems": 100,
      "items": {
       "type": "integer",
       "minimum": 1
      },
      "description": "Secret versions to restore or irreversibly destroy."
     }
    }
   },
   "RollbackSecretRequest": {
    "description": "Body for rolling a secret back to an earlier version.",
    "type": "object",
    "required": [
     "version"
    ],
    "properties": {
     "version": {
      "type": "integer",
      "minimum": 1,
      "description": "Previous version to copy into a new current version."
     }
    }
   },
   "BatchCreateSecretItem": {
    "description": "One secret in a batch create.",
    "type": "object",
    "required": [
     "secret_name",
     "value"
    ],
    "properties": {
     "secret_name": {
      "description": "Unique name for the secret within the store (2-64 characters).",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[a-z0-9][a-z0-9-]{1,63}$"
     },
     "value": {
      "description": "Key-value pairs containing the secret data.",
      "type": "object",
      "additionalProperties": true
     }
    }
   },
   "BatchCreateSecretsRequest": {
    "description": "Body for creating several secrets in one request.",
    "type": "object",
    "required": [
     "secrets"
    ],
    "properties": {
     "secrets": {
      "description": "Secrets to create (1-500).",
      "type": "array",
      "minItems": 1,
      "maxItems": 500,
      "items": {
       "$ref": "#/components/schemas/BatchCreateSecretItem"
      }
     }
    }
   },
   "BatchCreateSecretResult": {
    "description": "Outcome for one secret in a batch create.",
    "type": "object",
    "required": [
     "secret_name",
     "status"
    ],
    "properties": {
     "secret_name": {
      "description": "Name of the secret the result refers to.",
      "type": "string"
     },
     "status": {
      "description": "- `created`: the secret was created.\n- `skipped`: a secret with this name already existed.\n- `failed`: creation failed; see `error`.",
      "type": "string",
      "enum": [
       "created",
       "skipped",
       "failed"
      ]
     },
     "secret": {
      "description": "The created secret, when `status` is `created`.",
      "allOf": [
       {
        "$ref": "#/components/schemas/Secret"
       }
      ],
      "nullable": true
     },
     "error": {
      "description": "Error detail when `status` is `failed`.",
      "type": "string",
      "nullable": true
     }
    }
   },
   "BatchCreateSecretsResponse": {
    "description": "Result of a batch create.",
    "type": "object",
    "required": [
     "results",
     "created_count",
     "skipped_count",
     "failed_count"
    ],
    "properties": {
     "results": {
      "description": "One result per requested secret, in request order.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/BatchCreateSecretResult"
      }
     },
     "created_count": {
      "description": "Number of secrets created.",
      "type": "integer"
     },
     "skipped_count": {
      "description": "Number of secrets skipped because they already existed.",
      "type": "integer"
     },
     "failed_count": {
      "description": "Number of secrets that failed to create.",
      "type": "integer"
     }
    }
   },
   "Secret": {
    "description": "A secret's metadata. Values are returned by the value endpoints only.",
    "type": "object",
    "properties": {
     "id": {
      "description": "Unique ID of the secret.",
      "type": "string",
      "example": "secret_123"
     },
     "organization_id": {
      "description": "ID of the owning organization.",
      "type": "string",
      "example": "250612"
     },
     "workspace_id": {
      "description": "ID of the owning workspace.",
      "type": "string",
      "example": "907479"
     },
     "store_id": {
      "description": "ID of the store that holds the secret.",
      "type": "string",
      "example": "store_123"
     },
     "store_key": {
      "description": "URL-safe key of that store.",
      "type": "string",
      "example": "production-secrets"
     },
     "secret_name": {
      "description": "Name of the secret within the store.",
      "type": "string",
      "example": "database-url"
     },
     "status": {
      "description": "- `active`: readable.\n- `soft_deleted`: deleted but recoverable until permanently deleted.",
      "type": "string",
      "enum": [
       "active",
       "soft_deleted"
      ],
      "example": "active"
     },
     "created_at": {
      "description": "When the record was created (ISO 8601).",
      "type": "string",
      "format": "date-time"
     },
     "updated_at": {
      "description": "When the record was last changed (ISO 8601).",
      "type": "string",
      "format": "date-time"
     }
    }
   },
   "SecretList": {
    "description": "A page of secrets.",
    "type": "object",
    "properties": {
     "secrets": {
      "description": "Secrets on this page.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/Secret"
      }
     },
     "total": {
      "description": "Total number of items matching the request.",
      "type": "integer",
      "example": 1
     },
     "page": {
      "description": "Page number returned (1-based).",
      "type": "integer",
      "example": 1
     },
     "limit": {
      "description": "Page size that was applied.",
      "type": "integer",
      "example": 50
     }
    }
   },
   "SecretValue": {
    "description": "A secret's current value.",
    "type": "object",
    "properties": {
     "id": {
      "description": "Unique ID of the secret.",
      "type": "string",
      "example": "secret_123"
     },
     "secret_name": {
      "description": "Name of the secret within the store.",
      "type": "string",
      "example": "database-url"
     },
     "data": {
      "type": "object",
      "additionalProperties": true,
      "description": "Key-value pairs containing the secret data.",
      "example": {
       "url": "postgres://user:pass@host:5432/mydb"
      }
     },
     "metadata": {
      "description": "Version metadata for the returned value, including `version` and `created_time`.",
      "type": "object",
      "additionalProperties": true,
      "example": {
       "version": 1,
       "created_time": "2026-06-29T00:00:00Z"
      }
     }
    }
   },
   "SecretVersionSummary": {
    "description": "Summary of one version of a secret.",
    "type": "object",
    "required": [
     "version",
     "created_time",
     "deletion_time",
     "destroyed"
    ],
    "properties": {
     "version": {
      "description": "Version number (1-based, increasing).",
      "type": "integer"
     },
     "created_time": {
      "description": "When the version was written (RFC 3339).",
      "type": "string"
     },
     "deletion_time": {
      "description": "When the version was deleted (RFC 3339); empty when it is not deleted.",
      "type": "string"
     },
     "destroyed": {
      "description": "True when the version's data was irreversibly destroyed.",
      "type": "boolean"
     }
    }
   },
   "SecretVersions": {
    "description": "Version history of a secret.",
    "type": "object",
    "required": [
     "secret_id",
     "secret_name",
     "current_version",
     "oldest_version",
     "versions"
    ],
    "properties": {
     "secret_id": {
      "description": "Unique ID of the secret.",
      "type": "string"
     },
     "secret_name": {
      "description": "Name of the secret within the store.",
      "type": "string"
     },
     "current_version": {
      "description": "Version number of the current value.",
      "type": "integer"
     },
     "oldest_version": {
      "description": "Lowest version number still retained.",
      "type": "integer"
     },
     "versions": {
      "description": "Map of version number (as a string) to its summary.",
      "type": "object",
      "additionalProperties": {
       "$ref": "#/components/schemas/SecretVersionSummary"
      }
     }
    }
   },
   "SecretVersion": {
    "description": "One version of a secret, with its data.",
    "type": "object",
    "required": [
     "secret_id",
     "secret_name",
     "version",
     "data",
     "metadata"
    ],
    "properties": {
     "secret_id": {
      "description": "Unique ID of the secret.",
      "type": "string"
     },
     "secret_name": {
      "description": "Name of the secret within the store.",
      "type": "string"
     },
     "version": {
      "description": "Version number.",
      "type": "integer"
     },
     "data": {
      "description": "Key-value pairs stored in this version.",
      "type": "object",
      "additionalProperties": true
     },
     "metadata": {
      "description": "Version metadata, including `version` and `created_time`.",
      "type": "object",
      "additionalProperties": true
     }
    }
   },
   "SecretLifecycleStatus": {
    "description": "Result of a destroy or permanent-delete action.",
    "type": "object",
    "required": [
     "status"
    ],
    "properties": {
     "status": {
      "description": "- `destroyed`: the versions' data was irreversibly destroyed.\n- `permanently_deleted`: the secret and all its versions were removed.",
      "type": "string",
      "enum": [
       "destroyed",
       "permanently_deleted"
      ]
     }
    }
   },
   "CreateSecretIdentityRequest": {
    "description": "Body for creating an application identity that can authenticate to the store.",
    "type": "object",
    "required": [
     "auth_method",
     "name"
    ],
    "properties": {
     "auth_method": {
      "type": "string",
      "enum": [
       "approle",
       "kubernetes"
      ],
      "description": "Authentication method used by the application."
     },
     "name": {
      "description": "Display name of the identity (1-128 characters).",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
     },
     "token_policy_mode": {
      "description": "Default access mode for the identity's tokens.\n- `read_only` (default)\n- `read_write`",
      "type": "string",
      "enum": [
       "read_only",
       "read_write"
      ],
      "default": "read_only"
     },
     "k8s_namespace": {
      "type": "string",
      "nullable": true,
      "description": "Required when auth_method is kubernetes."
     },
     "k8s_service_account": {
      "type": "string",
      "nullable": true,
      "description": "Required when auth_method is kubernetes."
     }
    }
   },
   "UpdateSecretIdentityRequest": {
    "description": "Body for changing an identity.",
    "type": "object",
    "properties": {
     "token_policy_mode": {
      "type": "string",
      "enum": [
       "read_only",
       "read_write"
      ],
      "description": "Updating the mode also aligns every existing scope and revokes active sessions."
     }
    }
   },
   "SecretIdentity": {
    "description": "An application identity that authenticates to Secret Store with AppRole or Kubernetes credentials.",
    "type": "object",
    "required": [
     "id",
     "organization_id",
     "workspace_id",
     "name",
     "auth_method",
     "openbao_role_name",
     "status",
     "token_policy_mode",
     "created_at",
     "updated_at"
    ],
    "properties": {
     "id": {
      "description": "Unique ID of the identity.",
      "type": "string"
     },
     "organization_id": {
      "description": "ID of the owning organization.",
      "type": "string"
     },
     "workspace_id": {
      "description": "ID of the owning workspace.",
      "type": "string"
     },
     "name": {
      "description": "Display name of the identity.",
      "type": "string"
     },
     "auth_method": {
      "description": "- `approle`: authenticates with a role ID and secret ID.\n- `kubernetes`: authenticates with a Kubernetes service account token.",
      "type": "string",
      "enum": [
       "approle",
       "kubernetes"
      ]
     },
     "openbao_role_name": {
      "description": "Name of the backend authentication role created for the identity.",
      "type": "string"
     },
     "status": {
      "description": "- `active`: can authenticate.\n- `disabled`: authentication is refused.",
      "type": "string",
      "enum": [
       "active",
       "disabled"
      ]
     },
     "token_policy_mode": {
      "description": "Access mode of the identity's tokens.\n- `read_only`\n- `read_write`",
      "type": "string",
      "enum": [
       "read_only",
       "read_write"
      ]
     },
     "k8s_namespace": {
      "description": "Kubernetes namespace of the service account, for `kubernetes` identities.",
      "type": "string",
      "nullable": true
     },
     "k8s_service_account": {
      "description": "Kubernetes service account name, for `kubernetes` identities.",
      "type": "string",
      "nullable": true
     },
     "created_at": {
      "description": "When the record was created (ISO 8601).",
      "type": "string",
      "format": "date-time"
     },
     "updated_at": {
      "description": "When the record was last changed (ISO 8601).",
      "type": "string",
      "format": "date-time"
     }
    }
   },
   "SecretIdentityList": {
    "description": "Identities in the workspace.",
    "type": "object",
    "required": [
     "identities",
     "total"
    ],
    "properties": {
     "identities": {
      "description": "Identities returned.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/SecretIdentity"
      }
     },
     "total": {
      "description": "Total number of identities.",
      "type": "integer",
      "minimum": 0
     }
    }
   },
   "SecretIdentityAccess": {
    "description": "Credentials an application uses to authenticate as the identity. Returned once; store them securely.",
    "type": "object",
    "required": [
     "identity_id",
     "auth_method"
    ],
    "properties": {
     "identity_id": {
      "description": "ID of the identity.",
      "type": "string"
     },
     "auth_method": {
      "description": "- `approle`\n- `kubernetes`",
      "type": "string",
      "enum": [
       "approle",
       "kubernetes"
      ]
     },
     "role_id": {
      "type": "string",
      "nullable": true,
      "description": "AppRole role ID."
     },
     "secret_id": {
      "type": "string",
      "nullable": true,
      "description": "Fresh AppRole secret ID. Treat this value as sensitive."
     },
     "secret_id_accessor": {
      "description": "Accessor of the issued AppRole secret ID, usable to revoke it.",
      "type": "string",
      "nullable": true
     },
     "openbao_role_name": {
      "type": "string",
      "nullable": true,
      "description": "Kubernetes authentication role."
     },
     "k8s_namespace": {
      "description": "Kubernetes namespace bound to the identity, for `kubernetes`.",
      "type": "string",
      "nullable": true
     },
     "k8s_service_account": {
      "description": "Kubernetes service account bound to the identity, for `kubernetes`.",
      "type": "string",
      "nullable": true
     }
    }
   },
   "SecretIdentityActionStatus": {
    "description": "Result of deleting an identity or revoking its credentials.",
    "type": "object",
    "required": [
     "status"
    ],
    "properties": {
     "status": {
      "description": "- `deleted`: the identity was removed.\n- `revoked`: its active credentials were revoked.",
      "type": "string",
      "enum": [
       "deleted",
       "revoked"
      ]
     }
    }
   },
   "CreateSecretIdentityScopeRequest": {
    "description": "Body for granting an identity access to a store.",
    "type": "object",
    "required": [
     "store_id"
    ],
    "properties": {
     "store_id": {
      "description": "Store the identity gets access to.",
      "type": "string"
     },
     "access_mode": {
      "description": "- `read_only`: the identity can read secrets in the store.\n- `read_write`: the identity can also create and update them.\nDefault `read_only`.",
      "type": "string",
      "enum": [
       "read_only",
       "read_write"
      ],
      "default": "read_only"
     },
     "allow_version_read": {
      "description": "Whether the identity may read non-current versions of a secret.",
      "type": "boolean",
      "default": true
     },
     "allow_rollback": {
      "description": "Whether the identity may roll a secret back to an earlier version.",
      "type": "boolean",
      "default": false
     },
     "allow_destroy": {
      "description": "Whether the identity may destroy secret versions.",
      "type": "boolean",
      "default": false
     }
    }
   },
   "UpdateSecretIdentityScopeRequest": {
    "description": "Body for changing a scope. Only the fields sent are changed.",
    "type": "object",
    "properties": {
     "access_mode": {
      "description": "- `read_only`: the identity can read secrets in the store.\n- `read_write`: the identity can also create and update them.",
      "type": "string",
      "enum": [
       "read_only",
       "read_write"
      ]
     },
     "allow_version_read": {
      "description": "Whether the identity may read non-current versions of a secret.",
      "type": "boolean"
     },
     "allow_rollback": {
      "description": "Whether the identity may roll a secret back to an earlier version.",
      "type": "boolean"
     },
     "allow_destroy": {
      "description": "Whether the identity may destroy secret versions.",
      "type": "boolean"
     }
    }
   },
   "SecretIdentityScope": {
    "description": "An identity's access grant to one store.",
    "type": "object",
    "required": [
     "id",
     "identity_id",
     "scope_type",
     "store_id",
     "organization_id",
     "workspace_id",
     "access_mode",
     "allow_version_read",
     "allow_rollback",
     "allow_destroy",
     "created_at"
    ],
    "properties": {
     "id": {
      "description": "Unique ID of the scope.",
      "type": "string"
     },
     "identity_id": {
      "description": "Identity the scope belongs to.",
      "type": "string"
     },
     "scope_type": {
      "description": "Always `store`: scopes are granted per store.",
      "type": "string"
     },
     "store_id": {
      "description": "Store the scope grants access to.",
      "type": "string"
     },
     "organization_id": {
      "description": "ID of the owning organization.",
      "type": "string"
     },
     "workspace_id": {
      "description": "ID of the owning workspace.",
      "type": "string"
     },
     "access_mode": {
      "description": "- `read_only`: the identity can read secrets in the store.\n- `read_write`: the identity can also create and update them.",
      "type": "string",
      "enum": [
       "read_only",
       "read_write"
      ]
     },
     "allow_version_read": {
      "description": "Whether the identity may read non-current versions of a secret.",
      "type": "boolean"
     },
     "allow_rollback": {
      "description": "Whether the identity may roll a secret back to an earlier version.",
      "type": "boolean"
     },
     "allow_destroy": {
      "description": "Whether the identity may destroy secret versions.",
      "type": "boolean"
     },
     "created_at": {
      "description": "When the scope was created (ISO 8601).",
      "type": "string",
      "format": "date-time"
     }
    }
   },
   "SecretIdentityScopeList": {
    "description": "Scopes of an identity.",
    "type": "object",
    "required": [
     "scopes",
     "total"
    ],
    "properties": {
     "scopes": {
      "description": "Scopes returned.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/SecretIdentityScope"
      }
     },
     "total": {
      "description": "Total number of scopes.",
      "type": "integer",
      "minimum": 0
     }
    }
   },
   "CreateBucketRequest": {
    "description": "Body for creating an Object Storage bucket.",
    "type": "object",
    "required": [
     "name",
     "region"
    ],
    "properties": {
     "name": {
      "title": "Bucket name",
      "type": "string",
      "minLength": 3,
      "maxLength": 63,
      "example": "production-assets",
      "description": "Unique bucket name within the workspace."
     },
     "region": {
      "title": "Region",
      "type": "string",
      "example": "in-south-2",
      "description": "Required Object Storage region identifier. This must match a region configured for the target environment; it is not a compute `site_id` or display name."
     },
     "is_public": {
      "title": "Public access",
      "type": "boolean",
      "default": false,
      "description": "Whether the bucket allows unauthenticated read access."
     },
     "object_lock_enabled": {
      "type": "boolean",
      "default": false,
      "description": "Must be `true` when `default_retention` is provided."
     },
     "default_retention": {
      "$ref": "#/components/schemas/DefaultRetention"
     },
     "tags": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Optional tags stored alongside bucket metadata."
     }
    },
    "additionalProperties": false
   },
   "DefaultRetention": {
    "type": "object",
    "description": "Optional default object retention. Supply exactly one of `days` or `years`, and set `object_lock_enabled` to `true`.",
    "required": [
     "mode"
    ],
    "properties": {
     "mode": {
      "description": "- `GOVERNANCE`: retention can be overridden by users with the bypass permission.\n- `COMPLIANCE`: retention cannot be shortened or removed until it expires.",
      "type": "string",
      "enum": [
       "GOVERNANCE",
       "COMPLIANCE"
      ]
     },
     "days": {
      "description": "Retention period in days (1-36500). Supply either `days` or `years`.",
      "type": "integer",
      "minimum": 1,
      "maximum": 36500,
      "nullable": true
     },
     "years": {
      "description": "Retention period in years (1-100). Supply either `days` or `years`.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "nullable": true
     }
    },
    "additionalProperties": false
   },
   "UpdateBucketRequest": {
    "description": "Body for changing a bucket's public visibility.",
    "type": "object",
    "required": [
     "is_public"
    ],
    "properties": {
     "is_public": {
      "description": "Whether the bucket allows unauthenticated read access.",
      "type": "boolean"
     }
    }
   },
   "Bucket": {
    "type": "object",
    "description": "An object storage bucket. Read and list responses carry the usage counters `object_count` and `total_size`; the create response omits them because usage is only measured once the bucket exists.",
    "required": [
     "name",
     "is_public",
     "region",
     "plan",
     "status",
     "site_id",
     "site_name",
     "bucket_lock_enabled",
     "created_at",
     "updated_at"
    ],
    "properties": {
     "name": {
      "type": "string",
      "example": "production-assets",
      "description": "Unique bucket name within the workspace."
     },
     "is_public": {
      "type": "boolean",
      "example": false,
      "description": "Whether the bucket allows unauthenticated read access."
     },
     "region": {
      "type": "string",
      "nullable": true,
      "example": "in-south-2",
      "description": "Object storage region the bucket lives in."
     },
     "plan": {
      "type": "string",
      "nullable": true,
      "example": "standard",
      "description": "Storage plan billed for the bucket."
     },
     "status": {
      "type": "string",
      "nullable": true,
      "example": "active",
      "description": "Current bucket status."
     },
     "site_id": {
      "type": "string",
      "nullable": true,
      "example": "3",
      "description": "Identifier of the site holding the bucket. Placement is managed internally."
     },
     "site_name": {
      "type": "string",
      "nullable": true,
      "example": "Hyderabad",
      "description": "Human-readable name of the site holding the bucket."
     },
     "bucket_lock_enabled": {
      "type": "boolean",
      "example": false,
      "description": "Whether object lock is enabled on the bucket."
     },
     "object_count": {
      "type": "integer",
      "example": 42,
      "description": "Number of objects stored in the bucket. Returned by the read and list endpoints only."
     },
     "total_size": {
      "type": "integer",
      "example": 1048576,
      "description": "Total size in bytes of the objects stored in the bucket. Returned by the read and list endpoints only."
     },
     "created_at": {
      "description": "When the bucket was created (ISO 8601).",
      "type": "string",
      "format": "date-time",
      "nullable": true
     },
     "updated_at": {
      "description": "When the bucket settings were last changed (ISO 8601).",
      "type": "string",
      "format": "date-time",
      "nullable": true
     }
    }
   },
   "BucketList": {
    "description": "A page of buckets.",
    "type": "object",
    "properties": {
     "buckets": {
      "description": "Buckets on this page.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/Bucket"
      }
     },
     "is_truncated": {
      "description": "True when more buckets exist beyond this page.",
      "type": "boolean",
      "example": false
     },
     "next_continuation_token": {
      "description": "Token to pass as `continuation_token` to fetch the next page; null on the last page.",
      "type": "string",
      "nullable": true
     }
    }
   },
   "CreateS3CredentialRequest": {
    "description": "Body for creating an S3 access key pair.",
    "type": "object",
    "properties": {
     "name": {
      "description": "Display name of the key pair. Default `Default Key`.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "default": "Default Key"
     },
     "permission_type": {
      "description": "Permission level: `admin_rw`, `admin_ro`, `object_rw` or `object_ro`. Default `admin_rw`.",
      "type": "string",
      "default": "admin_rw"
     },
     "bucket_scope": {
      "description": "- `all`: the key may use every bucket in the workspace (default).\n- `specific`: only the buckets in `allowed_buckets`.",
      "type": "string",
      "enum": [
       "all",
       "specific"
      ],
      "default": "all"
     },
     "allowed_buckets": {
      "description": "Bucket names the key may use when `bucket_scope` is `specific`.",
      "type": "array",
      "items": {
       "type": "string"
      }
     }
    }
   },
   "S3Credential": {
    "description": "An S3 access key pair. The secret key is returned only when the pair is created.",
    "type": "object",
    "required": [
     "access_key_id",
     "name",
     "status",
     "created_at"
    ],
    "properties": {
     "access_key_id": {
      "description": "S3 access key ID.",
      "type": "string"
     },
     "project_id": {
      "description": "Legacy identifier of the owning project.",
      "type": "string"
     },
     "name": {
      "description": "Display name of the key pair.",
      "type": "string"
     },
     "status": {
      "description": "- `active`: usable.\n- `revoked`: no longer accepted.",
      "type": "string",
      "enum": [
       "active",
       "revoked"
      ]
     },
     "created_at": {
      "description": "When the key pair was created (ISO 8601).",
      "type": "string",
      "format": "date-time"
     },
     "last_used_at": {
      "description": "When the key was last used to sign a request (ISO 8601); null if never.",
      "type": "string",
      "format": "date-time",
      "nullable": true
     }
    }
   },
   "S3CredentialCreated": {
    "description": "A newly created S3 access key pair, including its secret key.",
    "allOf": [
     {
      "$ref": "#/components/schemas/S3Credential"
     },
     {
      "type": "object",
      "required": [
       "secret_access_key"
      ],
      "properties": {
       "secret_access_key": {
        "type": "string",
        "description": "Returned once at creation time."
       }
      }
     }
    ]
   },
   "S3CredentialList": {
    "description": "S3 access key pairs in the workspace.",
    "type": "object",
    "required": [
     "credentials"
    ],
    "properties": {
     "credentials": {
      "description": "Key pairs returned.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/S3Credential"
      }
     }
    }
   },
   "S3CredentialRevoked": {
    "description": "Result of revoking an S3 access key pair.",
    "type": "object",
    "required": [
     "success",
     "message"
    ],
    "properties": {
     "success": {
      "description": "True when the key pair was revoked.",
      "type": "boolean"
     },
     "message": {
      "description": "Human-readable result.",
      "type": "string"
     }
    }
   },
   "DeleteResponse": {
    "description": "Confirmation of a delete.",
    "type": "object",
    "properties": {
     "detail": {
      "description": "Human-readable result.",
      "type": "string",
      "example": "Deleted successfully"
     }
    }
   },
   "VmDeleteRequest": {
    "type": "object",
    "description": "Optional VM delete body. A VM whose public IP was assigned automatically is refused with 400 unless `public_ip_action` is set.",
    "properties": {
     "public_ip_action": {
      "type": "string",
      "enum": [
       "reserve",
       "release"
      ],
      "nullable": true,
      "description": "What to do with the VM's automatically assigned public IP. `reserve` converts it to a Reserved IP in this workspace; `release` releases it with the VM. Required when the VM has an automatically assigned public IP. `reserve` on a VM without one is refused with 400."
     },
     "reserved_ip_label": {
      "type": "string",
      "maxLength": 120,
      "nullable": true,
      "description": "Label for the Reserved IP that `reserve` creates. Blank is treated as not set."
     },
     "reserved_ip_billing_catalog": {
      "type": "object",
      "additionalProperties": true,
      "nullable": true,
      "required": [
       "sku_id"
      ],
      "properties": {
       "sku_id": {
        "oneOf": [
         {
          "type": "string"
         },
         {
          "type": "number"
         }
        ],
        "description": "Billing catalog SKU ID of the Reserved IP."
       }
      },
      "description": "Billing catalog identifiers used to bill the Reserved IP that `reserve` creates. Required with `public_ip_action: reserve`, with a non-empty `sku_id`; refused with 400 otherwise."
     }
    }
   },
   "BillingCatalogSelection": {
    "type": "object",
    "description": "A Billing catalog SKU selection as the VM engine accepts it. `sku_id` and `sku_code` are required; other catalog fields are accepted and stored as sent.",
    "required": [
     "sku_id",
     "sku_code"
    ],
    "additionalProperties": true,
    "properties": {
     "sku_id": {
      "oneOf": [
       {
        "type": "string"
       },
       {
        "type": "number"
       }
      ],
      "description": "Billing catalog SKU ID."
     },
     "sku_code": {
      "type": "string",
      "minLength": 1,
      "description": "Billing catalog SKU code. Stored in upper case."
     },
     "product_id": {
      "oneOf": [
       {
        "type": "string"
       },
       {
        "type": "number"
       }
      ],
      "nullable": true,
      "description": "Billing catalog product ID."
     },
     "product_code": {
      "type": "string",
      "nullable": true,
      "description": "Billing catalog product code."
     },
     "display_name": {
      "description": "Display name of the SKU, as listed in the billing catalog.",
      "type": "string",
      "nullable": true
     }
    }
   },
   "CreateCloudVmRequest": {
    "description": "Body for creating a cloud VM. Take `site_id`, `plan_id` and `template_id` from the compute catalog and pass the plan's `billing_catalog` through unchanged.",
    "type": "object",
    "required": [
     "name",
     "plan_id",
     "site_id",
     "template_id",
     "os_distro",
     "os_type",
     "cpu",
     "ram_mb",
     "billing_catalog"
    ],
    "properties": {
     "name": {
      "type": "string",
      "minLength": 1,
      "example": "web-server-01",
      "description": "Display name for the virtual machine."
     },
     "site_id": {
      "example": "68b99bd78a8eda32ff3f16ea",
      "type": "string",
      "minLength": 1,
      "description": "Placement site ID from `GET /compute/sites`. Required: the API refuses a create without it (400 `invalid_site_id`). Use the same value when filtering plans and images."
     },
     "os_distro": {
      "type": "string",
      "example": "ubuntu",
      "description": "Operating system distribution (e.g. ubuntu, centos, debian, rocky, windows)."
     },
     "os_type": {
      "type": "string",
      "enum": [
       "linux",
       "windows"
      ],
      "example": "linux",
      "description": "Operating system family."
     },
     "template_id": {
      "type": "string",
      "example": "tmpl_ubuntu_2204",
      "description": "OS template or image ID returned by the compute catalog."
     },
     "cpu": {
      "type": "integer",
      "minimum": 1,
      "example": 2,
      "description": "Number of vCPUs."
     },
     "ram_mb": {
      "type": "integer",
      "minimum": 512,
      "example": 4096,
      "description": "RAM in megabytes."
     },
     "disk_gb": {
      "type": "integer",
      "minimum": 10,
      "nullable": true,
      "example": 80,
      "description": "Root disk size in gigabytes."
     },
     "plan_id": {
      "example": "019f25b7-c1b3-7a9e-bfb9-8c83e323b517",
      "type": "string",
      "description": "Billable compute plan ID returned by the compute catalog."
     },
     "billing_catalog": {
      "type": "object",
      "additionalProperties": true,
      "description": "The selected plan's `billing_catalog` object from `GET /compute/plans`, passed through unmodified — the same flow the portal uses. Treat it as opaque. Billing charges are always computed server-side from `plan_id`, not from this echoed copy."
     },
     "ssh_key_ids": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "SSH key IDs to inject into the VM."
     },
     "ssh_keys": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Inline public SSH keys to install on the VM, in addition to the keys referenced by `ssh_key_ids`."
     },
     "vpc_id": {
      "type": "string",
      "nullable": true,
      "description": "VPC to launch the VM into. Send it together with `subnet_id`; one without the other is refused. Omit both to launch on the public provider network."
     },
     "subnet_id": {
      "type": "string",
      "nullable": true,
      "description": "Subnet of `vpc_id` for the VM's VPC NIC. Send it together with `vpc_id`."
     },
     "network_connectivity": {
      "type": "string",
      "enum": [
       "private",
       "nat",
       "public_ip"
      ],
      "nullable": true,
      "description": "How the VM reaches the internet. With a VPC it defaults to `private`. Without a VPC it is accepted only as `public_ip` together with `reserved_public_ip_id`, which attaches that Reserved IP on the public provider network. `public_ip` is refused on a `nat_gateway` VPC, and on a `private` VPC it needs `reserved_public_ip_id`."
     },
     "vpc_attachment_mode": {
      "type": "string",
      "enum": [
       "primary",
       "secondary"
      ],
      "default": "primary",
      "description": "With a VPC, `primary` makes the VPC NIC the VM's only NIC. `secondary` keeps the public provider NIC as primary and adds the VPC as a second NIC; it needs `vpc_id` and `subnet_id` and cannot be combined with `reserved_public_ip_id`."
     },
     "reserved_public_ip_id": {
      "type": "string",
      "nullable": true,
      "description": "Reserved IP to attach at launch. Needs `network_connectivity: public_ip` and the `primary` attachment mode. Accepted with a VPC or, without one, on the public provider network."
     },
     "tags": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Arbitrary tags for filtering and organization."
     }
    }
   },
   "CreateGpuVmRequest": {
    "description": "Body for creating a GPU VM. Take `site_id`, `plan_id` and `template_id` from the compute catalog (`vm_type=gpu`) and pass the plan's `billing_catalog` through unchanged.",
    "type": "object",
    "required": [
     "name",
     "plan_id",
     "site_id",
     "template_id",
     "os_distro",
     "os_type",
     "cpu",
     "ram_mb",
     "gpu_count",
     "gpu_model",
     "billing_catalog"
    ],
    "properties": {
     "name": {
      "type": "string",
      "minLength": 1,
      "example": "ml-training-01",
      "description": "Display name for the virtual machine."
     },
     "site_id": {
      "example": "68b99bd78a8eda32ff3f16ea",
      "type": "string",
      "minLength": 1,
      "description": "Placement site ID from `GET /compute/sites`. Required: the API refuses a create without it (400 `invalid_site_id`). Use the same value when filtering plans and images."
     },
     "os_distro": {
      "type": "string",
      "example": "ubuntu",
      "description": "Operating system distribution (e.g. ubuntu, centos, debian, rocky)."
     },
     "os_type": {
      "type": "string",
      "enum": [
       "linux"
      ],
      "example": "linux",
      "description": "Operating system family."
     },
     "template_id": {
      "type": "string",
      "example": "tmpl_ubuntu_2204_cuda",
      "description": "GPU-compatible template ID returned by the compute catalog."
     },
     "cpu": {
      "type": "integer",
      "minimum": 1,
      "example": 8,
      "description": "Number of vCPUs."
     },
     "ram_mb": {
      "type": "integer",
      "minimum": 512,
      "example": 32768,
      "description": "RAM in megabytes."
     },
     "disk_gb": {
      "type": "integer",
      "minimum": 10,
      "nullable": true,
      "example": 200,
      "description": "Root disk size in gigabytes."
     },
     "gpu_count": {
      "type": "integer",
      "minimum": 1,
      "example": 1,
      "description": "Number of GPUs to attach."
     },
     "gpu_model": {
      "type": "string",
      "example": "A100",
      "description": "GPU model (e.g. A100, H100, L40S, RTX4090)."
     },
     "plan_id": {
      "example": "019f25b7-c1b3-7a9e-bfb9-8c83e323b517",
      "type": "string",
      "description": "Billable GPU plan ID returned by the compute catalog."
     },
     "billing_catalog": {
      "type": "object",
      "additionalProperties": true,
      "description": "The selected plan's `billing_catalog` object from `GET /compute/plans?vm_type=gpu`, passed through unmodified — the same flow the portal uses. Treat it as opaque. Billing charges are always computed server-side from `plan_id`, not from this echoed copy."
     },
     "ssh_key_ids": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "SSH key IDs to inject into the VM."
     },
     "ssh_keys": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Inline public SSH keys to install on the VM, in addition to the keys referenced by `ssh_key_ids`."
     },
     "vpc_id": {
      "type": "string",
      "nullable": true,
      "description": "VPC to launch the VM into. Send it together with `subnet_id`; one without the other is refused. Omit both to launch on the public provider network."
     },
     "subnet_id": {
      "type": "string",
      "nullable": true,
      "description": "Subnet of `vpc_id` for the VM's VPC NIC. Send it together with `vpc_id`."
     },
     "network_connectivity": {
      "type": "string",
      "enum": [
       "private",
       "nat",
       "public_ip"
      ],
      "nullable": true,
      "description": "How the VM reaches the internet. With a VPC it defaults to `private`. Without a VPC it is accepted only as `public_ip` together with `reserved_public_ip_id`, which attaches that Reserved IP on the public provider network. `public_ip` is refused on a `nat_gateway` VPC, and on a `private` VPC it needs `reserved_public_ip_id`."
     },
     "vpc_attachment_mode": {
      "type": "string",
      "enum": [
       "primary"
      ],
      "default": "primary",
      "description": "GPU VMs support only `primary`: with a VPC, the VPC NIC is the VM's only NIC. `secondary` is refused with 400."
     },
     "reserved_public_ip_id": {
      "type": "string",
      "nullable": true,
      "description": "Reserved IP to attach at launch. Needs `network_connectivity: public_ip`. Accepted with a VPC or, without one, on the public provider network."
     },
     "tags": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Arbitrary tags for filtering and organization."
     }
    }
   },
   "CloudVm": {
    "description": "A cloud VM.",
    "type": "object",
    "properties": {
     "id": {
      "description": "Unique VM ID.",
      "type": "string",
      "example": "vm_abc123"
     },
     "name": {
      "description": "Display name of the VM.",
      "type": "string",
      "example": "web-server-01"
     },
     "status": {
      "description": "Lifecycle status of the VM.\n- `pending`: create accepted, not started yet.\n- `creating`, `provisioning`: compute, disk and network resources are being allocated.\n- `configuring`: the guest is being configured (keys, network, cloud-init).\n- `running`: powered on.\n- `starting`: a start is in progress.\n- `stopping`: a stop is in progress.\n- `stopped`: powered off.\n- `rebooting`: a reboot is in progress.\n- `resizing`, `resizing_plan`, `resizing_disk`: a CPU/memory or root-disk change is being applied.\n- `attaching_volume`, `detaching_volume`: a block volume is being attached or detached.\n- `deleting`: a delete is in progress.\n- `deleted`: the VM no longer exists.\n- `error`: the last operation failed; see the operation or events for detail.",
      "type": "string",
      "enum": [
       "pending",
       "creating",
       "provisioning",
       "configuring",
       "running",
       "starting",
       "stopping",
       "stopped",
       "rebooting",
       "resizing",
       "attaching_volume",
       "detaching_volume",
       "resizing_plan",
       "resizing_disk",
       "deleting",
       "deleted",
       "error"
      ],
      "example": "running"
     },
     "cpu": {
      "description": "vCPUs.",
      "type": "integer",
      "example": 2
     },
     "ram_mb": {
      "description": "Memory in MB.",
      "type": "integer",
      "example": 4096
     },
     "disk_gb": {
      "description": "Root disk size in GB.",
      "type": "integer",
      "example": 80
     },
     "os_type": {
      "description": "OS family: `linux` or `windows`.",
      "type": "string",
      "example": "linux"
     },
     "os_distro": {
      "description": "OS distribution, for example `ubuntu`.",
      "type": "string",
      "example": "ubuntu"
     },
     "plan_name": {
      "description": "Name of the compute plan the VM runs on.",
      "type": "string",
      "nullable": true,
      "example": "standard-2x4"
     },
     "public_ip": {
      "description": "Public IPv4 address; null when the VM has none.",
      "type": "string",
      "nullable": true,
      "example": "103.149.10.42"
     },
     "private_ip": {
      "description": "Private IPv4 address; null when none is assigned.",
      "type": "string",
      "nullable": true,
      "example": "10.0.1.15"
     },
     "tags": {
      "description": "Tags given at creation.",
      "type": "array",
      "items": {
       "type": "string"
      }
     },
     "created_at": {
      "description": "When the VM was created (ISO 8601).",
      "type": "string",
      "format": "date-time"
     },
     "updated_at": {
      "description": "When the VM record was last changed (ISO 8601).",
      "type": "string",
      "format": "date-time",
      "nullable": true
     }
    }
   },
   "GpuVm": {
    "description": "A GPU VM.",
    "type": "object",
    "properties": {
     "id": {
      "description": "Unique VM ID.",
      "type": "string",
      "example": "vm_gpu_456"
     },
     "name": {
      "description": "Display name of the VM.",
      "type": "string",
      "example": "ml-training-01"
     },
     "status": {
      "description": "Lifecycle status of the VM.\n- `pending`: create accepted, not started yet.\n- `creating`, `provisioning`: compute, disk and network resources are being allocated.\n- `configuring`: the guest is being configured (keys, network, cloud-init).\n- `running`: powered on.\n- `starting`: a start is in progress.\n- `stopping`: a stop is in progress.\n- `stopped`: powered off.\n- `rebooting`: a reboot is in progress.\n- `resizing`, `resizing_plan`, `resizing_disk`: a CPU/memory or root-disk change is being applied.\n- `attaching_volume`, `detaching_volume`: a block volume is being attached or detached.\n- `deleting`: a delete is in progress.\n- `deleted`: the VM no longer exists.\n- `error`: the last operation failed; see the operation or events for detail.",
      "type": "string",
      "enum": [
       "pending",
       "creating",
       "provisioning",
       "configuring",
       "running",
       "starting",
       "stopping",
       "stopped",
       "rebooting",
       "resizing",
       "attaching_volume",
       "detaching_volume",
       "resizing_plan",
       "resizing_disk",
       "deleting",
       "deleted",
       "error"
      ],
      "example": "running"
     },
     "cpu": {
      "description": "vCPUs.",
      "type": "integer",
      "example": 8
     },
     "ram_mb": {
      "description": "Memory in MB.",
      "type": "integer",
      "example": 32768
     },
     "disk_gb": {
      "description": "Root disk size in GB.",
      "type": "integer",
      "example": 200
     },
     "os_type": {
      "description": "OS family: `linux` or `windows`.",
      "type": "string",
      "example": "linux"
     },
     "os_distro": {
      "description": "OS distribution, for example `ubuntu`.",
      "type": "string",
      "example": "ubuntu"
     },
     "gpu_count": {
      "description": "Number of attached GPUs.",
      "type": "integer",
      "example": 1
     },
     "gpu_model": {
      "description": "GPU model, for example `A100`.",
      "type": "string",
      "example": "A100"
     },
     "plan_name": {
      "description": "Name of the compute plan the VM runs on.",
      "type": "string",
      "nullable": true,
      "example": "gpu-a100-1x"
     },
     "public_ip": {
      "description": "Public IPv4 address; null when the VM has none.",
      "type": "string",
      "nullable": true,
      "example": "103.149.10.43"
     },
     "private_ip": {
      "description": "Private IPv4 address; null when none is assigned.",
      "type": "string",
      "nullable": true,
      "example": "10.0.1.20"
     },
     "tags": {
      "description": "Tags given at creation.",
      "type": "array",
      "items": {
       "type": "string"
      }
     },
     "created_at": {
      "description": "When the VM was created (ISO 8601).",
      "type": "string",
      "format": "date-time"
     },
     "updated_at": {
      "description": "When the VM record was last changed (ISO 8601).",
      "type": "string",
      "format": "date-time",
      "nullable": true
     }
    }
   },
   "PowerActionRequest": {
    "description": "Optional body for the start, stop and reboot actions.",
    "type": "object",
    "properties": {
     "force": {
      "type": "boolean",
      "default": false,
      "description": "Force the action even if the VM is in a transitional state."
     }
    }
   },
   "VmAccessUpdateRequest": {
    "type": "object",
    "description": "At least one SSH-key, password, or password-authentication change is required.",
    "properties": {
     "requested_by": {
      "description": "Free-text label for who or what made the request, stored with the operation. Default `api`.",
      "type": "string",
      "default": "api"
     },
     "admin_username": {
      "type": "string",
      "nullable": true,
      "description": "Linux account to update. Defaults to the VM admin user."
     },
     "ssh_key_mode": {
      "description": "- `add`: install the given keys.\n- `remove`: remove the given keys.",
      "type": "string",
      "enum": [
       "add",
       "remove"
      ],
      "nullable": true
     },
     "ssh_keys": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "default": [],
      "description": "Inline public SSH keys to add or remove."
     },
     "ssh_key_ids": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "default": [],
      "description": "Secret Store SSH key IDs to add or remove."
     },
     "ssh_key_secret_refs": {
      "description": "SSH public keys kept in Secret Store, referenced by store key and secret name.",
      "type": "array",
      "default": [],
      "items": {
       "$ref": "#/components/schemas/SshKeySecretRef"
      }
     },
     "new_password": {
      "description": "New password for `admin_username`.",
      "type": "string",
      "minLength": 8,
      "nullable": true,
      "writeOnly": true
     },
     "password_auth_enabled": {
      "description": "Enable (`true`) or disable (`false`) SSH password authentication.",
      "type": "boolean",
      "nullable": true
     },
     "confirm_remove_last_ssh_key": {
      "description": "Must be `true` to remove the VM's last remaining SSH key.",
      "type": "boolean",
      "default": false
     }
    }
   },
   "SshKeySecretRef": {
    "description": "Reference to an SSH public key kept in a Secret Store store.",
    "type": "object",
    "required": [
     "ssh_key_id",
     "secret_name"
    ],
    "properties": {
     "ssh_key_id": {
      "type": "string",
      "minLength": 1,
      "description": "ID of the SSH key."
     },
     "store_key": {
      "type": "string",
      "default": "ssh-keys",
      "description": "Store key of the Secret Store store that holds the key. Default `ssh-keys`."
     },
     "secret_name": {
      "type": "string",
      "minLength": 1,
      "description": "Name of the secret that holds the public key."
     }
    }
   },
   "VmResizeRequest": {
    "type": "object",
    "description": "At least one target value must be supplied.",
    "properties": {
     "cpu": {
      "type": "integer",
      "minimum": 1,
      "maximum": 256,
      "description": "Target vCPUs."
     },
     "ram_mb": {
      "type": "integer",
      "minimum": 257,
      "maximum": 2097152,
      "description": "Target memory in MB."
     },
     "disk_gb": {
      "type": "integer",
      "minimum": 1,
      "maximum": 10000,
      "description": "Target root disk size in GB."
     },
     "requested_by": {
      "type": "string",
      "default": "api",
      "description": "Free-text label for who or what made the request, stored with the operation. Default `api`."
     }
    }
   },
   "VmResizePlanRequest": {
    "description": "Body for changing a VM's vCPUs and memory.",
    "type": "object",
    "required": [
     "cpu",
     "ram_mb"
    ],
    "properties": {
     "cpu": {
      "type": "integer",
      "minimum": 1,
      "maximum": 256,
      "description": "Target vCPUs (1-256)."
     },
     "ram_mb": {
      "type": "integer",
      "minimum": 257,
      "maximum": 2097152,
      "description": "Target memory in MB."
     },
     "allow_online": {
      "type": "boolean",
      "default": false,
      "description": "Permit the change while the VM is running. Default false."
     },
     "confirm_downgrade": {
      "type": "boolean",
      "default": false,
      "description": "Must be `true` when the target shape is smaller than the current one."
     },
     "billing_catalog": {
      "$ref": "#/components/schemas/BillingCatalogSelection",
      "description": "Optional. The target plan's `billing_catalog` from `GET /compute/plans`. The VM engine records it with the resize."
     },
     "requested_by": {
      "type": "string",
      "default": "api",
      "description": "Free-text label for who or what made the request, stored with the operation. Default `api`."
     }
    }
   },
   "VmResizeRootDiskRequest": {
    "description": "Body for changing a VM's root disk size.",
    "type": "object",
    "required": [
     "new_size_gb"
    ],
    "properties": {
     "new_size_gb": {
      "type": "integer",
      "minimum": 1,
      "maximum": 10000,
      "description": "Target root disk size in GB."
     },
     "allow_online": {
      "type": "boolean",
      "default": false,
      "description": "Permit the change while the VM is running. Default false."
     },
     "billing_catalog": {
      "$ref": "#/components/schemas/BillingCatalogSelection",
      "description": "Optional. A Billing catalog selection that the VM engine records with the resize."
     },
     "requested_by": {
      "type": "string",
      "default": "api",
      "description": "Free-text label for who or what made the request, stored with the operation. Default `api`."
     }
    }
   },
   "VmResizeShape": {
    "description": "A VM shape: vCPUs, memory and root disk.",
    "type": "object",
    "required": [
     "cpu",
     "ram_mb",
     "disk_gb"
    ],
    "properties": {
     "cpu": {
      "type": "integer",
      "description": "vCPUs."
     },
     "ram_mb": {
      "type": "integer",
      "description": "Memory in MB."
     },
     "disk_gb": {
      "type": "integer",
      "description": "Root disk size in GB."
     }
    }
   },
   "VmResizePrecheck": {
    "description": "Result of a resize precheck: whether the requested shape can be applied in place, needs a migration, or is blocked.",
    "type": "object",
    "required": [
     "decision",
     "reasons",
     "warnings",
     "migration_checklist",
     "migration_steps",
     "requires_stop",
     "downtime_expected",
     "no_changes",
     "current_state",
     "current",
     "target"
    ],
    "properties": {
     "decision": {
      "type": "string",
      "enum": [
       "in_place",
       "migration_required",
       "blocked"
      ],
      "description": "- `in_place`: the change can be applied on the current host.\n- `migration_required`: the VM must move to another host first.\n- `blocked`: the change cannot be made; see `reasons`."
     },
     "mode": {
      "type": "string",
      "enum": [
       "in_place",
       "migration_required",
       "blocked"
      ],
      "nullable": true,
      "description": "Same values as `decision`; present when the engine reports the mode separately."
     },
     "reasons": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Why the decision was reached."
     },
     "warnings": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Non-blocking warnings about the change."
     },
     "migration_checklist": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Items to confirm before a migration."
     },
     "migration_steps": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Steps a migration would perform."
     },
     "requires_stop": {
      "type": "boolean",
      "description": "Whether the VM must be stopped for the change."
     },
     "downtime_expected": {
      "type": "boolean",
      "description": "Whether the change interrupts the VM."
     },
     "no_changes": {
      "type": "boolean",
      "description": "True when the target shape equals the current one."
     },
     "current_state": {
      "type": "string",
      "description": "VM lifecycle status recorded by the engine."
     },
     "live_state": {
      "type": "string",
      "nullable": true,
      "description": "Power state observed on the host, when available."
     },
     "current": {
      "$ref": "#/components/schemas/VmResizeShape"
     },
     "target": {
      "$ref": "#/components/schemas/VmResizeShape"
     }
    }
   },
   "VmAttachVolumeRequest": {
    "description": "Body for attaching a block storage volume to a VM.",
    "type": "object",
    "required": [
     "volume_id",
     "billing_catalog"
    ],
    "properties": {
     "volume_id": {
      "type": "string",
      "minLength": 1,
      "description": "ID of the block storage volume to attach."
     },
     "mode": {
      "type": "string",
      "enum": [
       "single-writer",
       "multi-writer"
      ],
      "default": "single-writer",
      "description": "- `single-writer`: only this VM may write to the volume (default).\n- `multi-writer`: the volume may be attached to several VMs."
     },
     "billing_catalog": {
      "$ref": "#/components/schemas/BillingCatalogSelection",
      "description": "Required. The Block Storage SKU from the Billing catalog that the VM engine records for this attachment. Copy it from the volume's `metadata.billing_catalog` (`GET /block-storage/volumes/{volume_id}`)."
     },
     "requested_by": {
      "type": "string",
      "default": "api",
      "description": "Free-text label for who or what made the request, stored with the operation. Default `api`."
     }
    }
   },
   "VmDetachVolumeRequest": {
    "description": "Body for detaching a block storage volume from a VM.",
    "type": "object",
    "required": [
     "volume_id"
    ],
    "properties": {
     "volume_id": {
      "type": "string",
      "minLength": 1,
      "description": "ID of the block storage volume to detach."
     },
     "force": {
      "type": "boolean",
      "default": false,
      "description": "Detach even if the volume still appears to be in use. Default false."
     },
     "confirm_unmounted": {
      "type": "boolean",
      "default": false,
      "description": "Confirms the volume was unmounted inside the guest. Default false."
     },
     "requested_by": {
      "type": "string",
      "default": "api",
      "description": "Free-text label for who or what made the request, stored with the operation. Default `api`."
     }
    }
   },
   "MountGuidanceAcknowledgeRequest": {
    "description": "Body for recording that the mount instructions for an attached volume were followed.",
    "type": "object",
    "required": [
     "volume_id"
    ],
    "properties": {
     "volume_id": {
      "type": "string",
      "minLength": 1,
      "description": "ID of the attached block storage volume."
     }
    }
   },
   "MountGuidanceAcknowledge": {
    "description": "Result of acknowledging mount guidance.",
    "type": "object",
    "required": [
     "status",
     "vm_id",
     "volume_id"
    ],
    "properties": {
     "status": {
      "type": "string",
      "default": "ok",
      "description": "Always `ok`."
     },
     "vm_id": {
      "type": "string",
      "description": "ID of the VM."
     },
     "volume_id": {
      "type": "string",
      "description": "ID of the volume."
     },
     "mount_state": {
      "type": "string",
      "nullable": true,
      "description": "Mount state recorded after the acknowledgement, for example `instructions_acknowledged`."
     },
     "instructions_acknowledged_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the acknowledgement was recorded (ISO 8601)."
     }
    }
   },
   "VmEvent": {
    "description": "One entry in a VM's event timeline.",
    "type": "object",
    "required": [
     "organization_id",
     "workspace_id",
     "vm_id",
     "event_type",
     "message",
     "payload",
     "created_at"
    ],
    "properties": {
     "organization_id": {
      "type": "string",
      "description": "ID of the organization that owns the VM."
     },
     "organization_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of the owning organization, when the service has it."
     },
     "workspace_id": {
      "type": "string",
      "description": "ID of the workspace the VM belongs to."
     },
     "workspace_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of the workspace, when the service has it."
     },
     "vm_id": {
      "type": "string",
      "description": "ID of the VM."
     },
     "operation_id": {
      "type": "string",
      "nullable": true,
      "description": "Operation that produced the event, when it belongs to one."
     },
     "event_type": {
      "type": "string",
      "description": "Dotted event name, for example `operation.accepted`, `vm.reboot.succeeded` or `snapshot.restore.failed`."
     },
     "message": {
      "type": "string",
      "description": "Human-readable description of the event."
     },
     "payload": {
      "type": "object",
      "additionalProperties": true,
      "description": "Event-specific key-value details."
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the event was recorded (ISO 8601)."
     }
    }
   },
   "VmMetrics": {
    "description": "Latest resource-usage sample for a VM plus month-to-date traffic. Usage fields are null when no sample is available.",
    "type": "object",
    "required": [
     "vm_id",
     "vm_type",
     "power_state",
     "monitoring_status",
     "month_rx_bytes",
     "month_tx_bytes"
    ],
    "properties": {
     "vm_id": {
      "description": "ID of the VM.",
      "type": "string"
     },
     "vm_type": {
      "description": "- `cloud`\n- `gpu`",
      "type": "string",
      "enum": [
       "cloud",
       "gpu"
      ]
     },
     "power_state": {
      "description": "Power state observed on the host when the sample was taken: `running`, `stopped`, `paused`, `suspended`, `blocked`, `crashed` or `unknown`.",
      "type": "string"
     },
     "monitoring_status": {
      "description": "- `active`: a recent sample exists.\n- `stale`: the last sample is older than the freshness threshold.\n- `unavailable`: no sample has been collected.",
      "type": "string",
      "enum": [
       "active",
       "stale",
       "unavailable"
      ]
     },
     "last_collected_at": {
      "description": "When the sample was collected (ISO 8601).",
      "type": "string",
      "format": "date-time",
      "nullable": true
     },
     "cpu_percent": {
      "description": "CPU utilisation, 0-100.",
      "type": "number",
      "nullable": true,
      "example": 45.2
     },
     "memory_used_bytes": {
      "description": "Memory in use, in bytes.",
      "type": "integer",
      "nullable": true
     },
     "memory_used_percent": {
      "description": "Memory in use as a percentage of the VM's memory, 0-100.",
      "type": "number",
      "nullable": true,
      "example": 67.8
     },
     "storage_used_bytes": {
      "description": "Disk space in use, in bytes.",
      "type": "integer",
      "nullable": true
     },
     "storage_total_bytes": {
      "description": "Disk capacity visible to the guest, in bytes.",
      "type": "integer",
      "nullable": true
     },
     "storage_used_percent": {
      "description": "Disk space in use as a percentage of `storage_total_bytes`, 0-100.",
      "type": "number",
      "nullable": true
     },
     "storage_provisioned_bytes": {
      "description": "Disk capacity provisioned for the VM, in bytes.",
      "type": "integer",
      "nullable": true
     },
     "disk_read_bps": {
      "description": "Disk read throughput in bytes per second.",
      "type": "number",
      "nullable": true
     },
     "disk_write_bps": {
      "description": "Disk write throughput in bytes per second.",
      "type": "number",
      "nullable": true
     },
     "disk_read_iops": {
      "description": "Disk read operations per second.",
      "type": "number",
      "nullable": true
     },
     "disk_write_iops": {
      "description": "Disk write operations per second.",
      "type": "number",
      "nullable": true
     },
     "net_rx_bps": {
      "description": "Network receive rate in bytes per second.",
      "type": "number",
      "nullable": true
     },
     "net_tx_bps": {
      "description": "Network transmit rate in bytes per second.",
      "type": "number",
      "nullable": true
     },
     "month_rx_bytes": {
      "description": "Bytes received so far in the current calendar month.",
      "type": "integer",
      "default": 0
     },
     "month_tx_bytes": {
      "description": "Bytes transmitted so far in the current calendar month.",
      "type": "integer",
      "default": 0
     }
    }
   },
   "VmMetricsTimeseries": {
    "description": "Metric series for a VM over the requested window.",
    "type": "object",
    "required": [
     "range",
     "resolution",
     "from",
     "to",
     "series"
    ],
    "properties": {
     "range": {
      "type": "string",
      "enum": [
       "30m",
       "1h",
       "6h",
       "24h",
       "7d"
      ],
      "description": "Window covered.\n- `30m`\n- `1h`\n- `6h`\n- `24h`\n- `7d`"
     },
     "resolution": {
      "type": "string",
      "enum": [
       "1m",
       "5m",
       "15m",
       "2h"
      ],
      "description": "Spacing between points.\n- `1m`\n- `5m`\n- `15m`\n- `2h`"
     },
     "from": {
      "type": "string",
      "format": "date-time",
      "description": "Start of the window (ISO 8601)."
     },
     "to": {
      "type": "string",
      "format": "date-time",
      "description": "End of the window (ISO 8601)."
     },
     "series": {
      "description": "Map of series name to `[timestamp, value]` pairs; `value` is null where no sample exists. Series: `cpu_percent`, `memory_used_percent`, `storage_used_percent`, `disk_read_bps`, `disk_write_bps`, `disk_read_iops`, `disk_write_iops`, `net_rx_bps`, `net_tx_bps`.",
      "type": "object",
      "additionalProperties": {
       "type": "array",
       "items": {
        "type": "array",
        "minItems": 2,
        "maxItems": 2,
        "prefixItems": [
         {
          "type": "string",
          "format": "date-time"
         },
         {
          "type": "number",
          "nullable": true
         }
        ]
       }
      }
     }
    }
   },
   "VmBandwidthSummary": {
    "description": "Received and transmitted bytes for one calendar month.",
    "type": "object",
    "required": [
     "month",
     "rx_bytes",
     "tx_bytes"
    ],
    "properties": {
     "month": {
      "type": "string",
      "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])$",
      "description": "Month in `YYYY-MM` form."
     },
     "rx_bytes": {
      "type": "integer",
      "default": 0,
      "description": "Bytes received in the month."
     },
     "tx_bytes": {
      "type": "integer",
      "default": 0,
      "description": "Bytes transmitted in the month."
     },
     "last_updated_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the counters were last updated (ISO 8601)."
     }
    }
   },
   "SnapshotCreateRequest": {
    "description": "Body for creating a snapshot set of a VM.",
    "type": "object",
    "required": [
     "name",
     "billing_catalog"
    ],
    "properties": {
     "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Display name for the snapshot set."
     },
     "description": {
      "type": "string",
      "maxLength": 1024,
      "nullable": true,
      "description": "Optional description (up to 1024 characters)."
     },
     "mode": {
      "description": "Which volumes to capture.\n- `root_only`: the root disk only.\n- `all_attached`: the root disk and every attached data volume (default).\n- `selective`: the root disk and the volumes in `selected_data_volume_ids`.",
      "type": "string",
      "enum": [
       "root_only",
       "all_attached",
       "selective"
      ],
      "default": "all_attached"
     },
     "selected_data_volume_ids": {
      "description": "Data volume IDs to include when `mode` is `selective`.",
      "type": "array",
      "items": {
       "type": "string"
      },
      "default": []
     },
     "billing_catalog": {
      "$ref": "#/components/schemas/BillingCatalogSelection",
      "description": "Required. The snapshot storage SKU from the Billing catalog that the VM engine records for this snapshot. No public operation lists it yet."
     },
     "requested_by": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "default": "api",
      "description": "Free-text label for who or what made the request, stored with the record. Default `api`."
     }
    }
   },
   "RecoveryVolumeManifestItem": {
    "description": "One volume captured in a recovery point (backup run or snapshot set): how it was attached at capture time, the stored artifact that holds its data, and where it was restored.",
    "type": "object",
    "required": [
     "source_volume_id"
    ],
    "properties": {
     "source_volume_id": {
      "type": "string",
      "description": "ID of the volume that was captured."
     },
     "source_volume_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of the source volume."
     },
     "resource_name": {
      "type": "string",
      "nullable": true,
      "description": "Backend storage resource name of the source volume."
     },
     "role": {
      "type": "string",
      "enum": [
       "root",
       "data"
      ],
      "default": "data",
      "description": "- `root`: the VM's root disk.\n- `data`: an attached data volume."
     },
     "size_gb": {
      "type": "integer",
      "nullable": true,
      "description": "Provisioned size of the volume in GiB."
     },
     "display_size_gb": {
      "type": "integer",
      "nullable": true,
      "description": "Size in GiB as shown in the portal."
     },
     "device_bus": {
      "type": "string",
      "nullable": true,
      "description": "Virtual disk bus the volume was attached on, for example `virtio`."
     },
     "device_slot": {
      "type": "string",
      "nullable": true,
      "description": "Guest device name of the attachment, for example `vda`."
     },
     "boot_index": {
      "type": "integer",
      "nullable": true,
      "description": "Position in the boot order; 0 for the boot disk, null for volumes not in the boot order."
     },
     "attachment_mode": {
      "type": "string",
      "nullable": true,
      "description": "Attachment mode at capture time, for example `boot` for the root disk or `single-writer` for a data volume."
     },
     "guest_device": {
      "type": "string",
      "nullable": true,
      "description": "Device name as seen inside the guest OS."
     },
     "device_path": {
      "type": "string",
      "nullable": true,
      "description": "Device path inside the guest, for example `/dev/vdb`."
     },
     "filesystem_uuid": {
      "type": "string",
      "nullable": true,
      "description": "Filesystem UUID detected on the volume, when known."
     },
     "filesystem_type": {
      "type": "string",
      "nullable": true,
      "description": "Filesystem type detected on the volume, for example `ext4`, when known."
     },
     "mount_hint": {
      "type": "string",
      "nullable": true,
      "description": "Mount point the volume is expected to use, for example `/` for the root disk."
     },
     "mount_state_at_capture": {
      "type": "string",
      "nullable": true,
      "description": "Mount state recorded at capture time, for example `mounted`, `instructions_pending` or `instructions_acknowledged`."
     },
     "mount_instructions": {
      "type": "string",
      "nullable": true,
      "description": "Human-readable instructions for mounting the volume after a restore."
     },
     "delete_on_termination": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether the source volume was set to be deleted together with its VM."
     },
     "source_attachment_present": {
      "type": "boolean",
      "default": true,
      "description": "Whether the source volume was still attached to the VM when the manifest was last refreshed."
     },
     "artifact_type": {
      "type": "string",
      "nullable": true,
      "description": "Kind of stored artifact that holds this volume's data in the recovery point."
     },
     "artifact_ref": {
      "type": "string",
      "nullable": true,
      "description": "Reference to that artifact in the backup store."
     },
     "artifact_chain_id": {
      "type": "string",
      "nullable": true,
      "description": "Backup chain the artifact belongs to."
     },
     "artifact_backup_type": {
      "type": "string",
      "nullable": true,
      "description": "`full` or `incremental`, for the artifact."
     },
     "artifact_bytes": {
      "type": "integer",
      "nullable": true,
      "description": "Size of the stored artifact in bytes."
     },
     "billing_storage_bytes": {
      "type": "integer",
      "nullable": true,
      "description": "Bytes billed for storing this volume's artifact."
     },
     "storage_usage": {
      "type": "object",
      "nullable": true,
      "additionalProperties": true,
      "description": "Storage usage details reported by the backup store, as key-value data."
     },
     "restored_volume_id": {
      "type": "string",
      "nullable": true,
      "description": "ID of the volume created by the most recent restore of this entry, when one was performed."
     },
     "restored_resource_name": {
      "type": "string",
      "nullable": true,
      "description": "Backend storage resource name of the restored volume."
     },
     "restored_device_path": {
      "type": "string",
      "nullable": true,
      "description": "Device path of the restored volume inside the target VM."
     },
     "restored_target_vm_id": {
      "type": "string",
      "nullable": true,
      "description": "VM the restored volume was attached to."
     },
     "metadata": {
      "type": "object",
      "additionalProperties": true,
      "description": "Additional service-specific key-value data."
     }
    }
   },
   "RecoveryPointSummary": {
    "description": "Short description of the volumes a recovery point contains.",
    "type": "object",
    "properties": {
     "root_only": {
      "type": "boolean",
      "default": true,
      "description": "True when only the root disk was captured."
     },
     "root_volume_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of the captured root disk."
     },
     "data_volume_names": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Display names of the captured data volumes."
     },
     "summary_text": {
      "type": "string",
      "default": "Root",
      "description": "Ready-to-display summary of the captured volumes; `Root` when only the root disk was captured."
     }
    }
   },
   "LiveDriftSummary": {
    "description": "Difference between the volumes in a recovery point and the volumes attached to the VM now.",
    "type": "object",
    "properties": {
     "drifted": {
      "type": "boolean",
      "default": false,
      "description": "True when the VM's current volumes differ from the recovery point."
     },
     "missing_from_live": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Volumes in the recovery point that are no longer attached to the VM."
     },
     "new_live_only": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Volumes attached to the VM now that are not in the recovery point."
     },
     "message": {
      "type": "string",
      "nullable": true,
      "description": "Human-readable description of the drift, when any."
     }
    }
   },
   "SnapshotSet": {
    "description": "A snapshot set: a point-in-time capture of a VM's root disk and, depending on `capture_scope`, its data volumes. It is a recovery point that the snapshot restore action accepts.",
    "type": "object",
    "required": [
     "organization_id",
     "workspace_id",
     "snapshot_set_id",
     "vm_id",
     "name",
     "recovery_point_id",
     "status",
     "created_at",
     "updated_at"
    ],
    "properties": {
     "organization_id": {
      "type": "string",
      "description": "ID of the organization that owns the VM."
     },
     "organization_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of the owning organization, when the service has it."
     },
     "workspace_id": {
      "type": "string",
      "description": "ID of the workspace the VM belongs to."
     },
     "workspace_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of the workspace, when the service has it."
     },
     "snapshot_set_id": {
      "type": "string",
      "description": "Unique ID of the snapshot set."
     },
     "vm_id": {
      "type": "string",
      "description": "ID of the VM the snapshot was taken from."
     },
     "vm_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of the VM at capture time."
     },
     "vm_type": {
      "$ref": "#/components/schemas/VmType"
     },
     "name": {
      "type": "string",
      "description": "Display name of the snapshot set."
     },
     "description": {
      "type": "string",
      "nullable": true,
      "description": "Description given at creation."
     },
     "recovery_point_id": {
      "type": "string",
      "description": "Recovery point ID of this snapshot set."
     },
     "recovery_point_type": {
      "type": "string",
      "enum": [
       "snapshot"
      ],
      "default": "snapshot",
      "description": "Always `snapshot` for a snapshot set."
     },
     "capture_scope": {
      "type": "string",
      "enum": [
       "root_only",
       "all_attached",
       "selective"
      ],
      "default": "all_attached",
      "description": "Which volumes the recovery point contains.\n- `root_only`: the root disk only.\n- `all_attached`: the root disk and every attached data volume.\n- `selective`: the root disk and the data volumes that were selected."
     },
     "status": {
      "$ref": "#/components/schemas/BackupStatus"
     },
     "captured_volume_count": {
      "type": "integer",
      "default": 1,
      "description": "Number of volumes in the snapshot set."
     },
     "root_only": {
      "type": "boolean",
      "default": true,
      "description": "True when only the root disk was captured."
     },
     "size_gb": {
      "type": "integer",
      "nullable": true,
      "description": "Size of the captured data in GiB."
     },
     "source_disk_size_gb": {
      "type": "integer",
      "nullable": true,
      "description": "Provisioned size of the source root disk in GiB at capture time."
     },
     "display_size_gb": {
      "type": "integer",
      "nullable": true,
      "description": "Size in GiB as shown in the portal."
     },
     "display_storage_bytes": {
      "type": "integer",
      "nullable": true,
      "description": "`display_size_gb` expressed in bytes."
     },
     "backend_protected_storage_bytes": {
      "type": "integer",
      "nullable": true,
      "description": "Bytes of protected data as reported by the storage backend."
     },
     "protected_storage_bytes": {
      "type": "integer",
      "nullable": true,
      "description": "Bytes of source data protected by this snapshot set."
     },
     "billing_storage_bytes": {
      "type": "integer",
      "nullable": true,
      "description": "Bytes billed for storing this snapshot set."
     },
     "billing_storage_source": {
      "type": "string",
      "default": "unavailable",
      "description": "How `billing_storage_bytes` was obtained.\n- `metered`: measured in the backup store.\n- `metered_from_manifest`: summed from the volume manifest.\n- `unavailable`: not measured yet."
     },
     "metering_status": {
      "type": "string",
      "default": "unavailable",
      "description": "`metered` once storage has been measured for billing; `unavailable` until then."
     },
     "storage_backend": {
      "type": "string",
      "nullable": true,
      "description": "Identifier of the storage backend that holds the captured data."
     },
     "captured_topology_hash": {
      "type": "string",
      "nullable": true,
      "description": "Hash of the VM's volume layout at capture time; a different hash on the live VM means the layout drifted."
     },
     "root_volume_id": {
      "type": "string",
      "nullable": true,
      "description": "ID of the captured root disk."
     },
     "root_volume_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of the captured root disk."
     },
     "volume_manifest": {
      "description": "One entry per captured volume.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/RecoveryVolumeManifestItem"
      }
     },
     "volume_manifest_summary": {
      "$ref": "#/components/schemas/RecoveryPointSummary"
     },
     "live_drift_summary": {
      "$ref": "#/components/schemas/LiveDriftSummary"
     },
     "metadata": {
      "type": "object",
      "additionalProperties": true,
      "description": "Additional service-specific key-value data."
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the snapshot set was created (ISO 8601)."
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the snapshot set was last updated (ISO 8601)."
     }
    }
   },
   "SnapshotSetList": {
    "description": "Snapshot sets of a VM.",
    "type": "object",
    "required": [
     "snapshots",
     "total"
    ],
    "properties": {
     "snapshots": {
      "description": "Snapshot sets on this page.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/SnapshotSet"
      }
     },
     "total": {
      "type": "integer",
      "default": 0,
      "description": "Total number of snapshot sets matching the request."
     }
    }
   },
   "SnapshotDeleteResult": {
    "description": "Confirmation that a snapshot set was deleted.",
    "type": "object",
    "required": [
     "status",
     "snapshot_set_id"
    ],
    "properties": {
     "status": {
      "type": "string",
      "enum": [
       "deleted"
      ],
      "description": "Always `deleted`."
     },
     "snapshot_set_id": {
      "type": "string",
      "description": "ID of the deleted snapshot set."
     }
    }
   },
   "RecoveryRestoreRequest": {
    "description": "Restore options shared by backup and snapshot restores. With the default `replace` mode only `requested_by` and `auto_start` apply; the `target_*` fields describe the new VM for `new_vm` mode.",
    "type": "object",
    "properties": {
     "target_mode": {
      "type": "string",
      "enum": [
       "replace",
       "new_vm",
       "volume_only"
      ],
      "default": "replace",
      "description": "Where to restore.\n- `replace`: onto the source VM, replacing its current disks (default).\n- `new_vm`: into a new VM described by the `target_*` fields.\n- `volume_only`: only the volume named in `selected_volume_id`."
     },
     "target_vm_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "nullable": true,
      "description": "Name for the new VM (`new_vm` mode)."
     },
     "target_cpu": {
      "type": "integer",
      "minimum": 1,
      "maximum": 256,
      "nullable": true,
      "description": "vCPUs for the new VM (1-256)."
     },
     "target_ram_mb": {
      "type": "integer",
      "minimum": 512,
      "maximum": 2097152,
      "nullable": true,
      "description": "RAM for the new VM in MB (512-2097152)."
     },
     "target_disk_gb": {
      "type": "integer",
      "minimum": 10,
      "maximum": 10000,
      "nullable": true,
      "description": "Root disk for the new VM in GB (10-10000)."
     },
     "target_plan_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "nullable": true,
      "description": "Compute plan for the new VM, from `GET /compute/plans`."
     },
     "target_plan_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "nullable": true,
      "description": "Name of that plan as listed in the compute catalog."
     },
     "target_plan_code": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "nullable": true,
      "description": "SKU code of that plan as listed in the compute catalog."
     },
     "target_plan_type": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "nullable": true,
      "description": "Plan type label as listed in the compute catalog."
     },
     "target_performance_category": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "nullable": true,
      "description": "Performance category of that plan as listed in the compute catalog."
     },
     "target_plan_monthly_rate": {
      "type": "number",
      "minimum": 0,
      "nullable": true,
      "description": "Monthly rate of that plan as listed in the compute catalog."
     },
     "target_plan_hourly_rate": {
      "type": "number",
      "minimum": 0,
      "nullable": true,
      "description": "Hourly rate of that plan as listed in the compute catalog."
     },
     "target_bandwidth_tb": {
      "description": "Included bandwidth of that plan in TB, as a number or a display string.",
      "anyOf": [
       {
        "type": "number"
       },
       {
        "type": "string"
       },
       {
        "type": "null"
       }
      ]
     },
     "target_bandwidth_display": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "nullable": true,
      "description": "Display label for the included bandwidth."
     },
     "target_network_bandwidth": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "nullable": true,
      "description": "Network bandwidth label of that plan."
     },
     "target_compute_node_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "nullable": true,
      "description": "Compute node to place the new VM on; omit to let the service choose."
     },
     "target_gpu_type": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "nullable": true,
      "description": "GPU type for a new GPU VM."
     },
     "target_gpu_model": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "nullable": true,
      "description": "GPU model for a new GPU VM, for example `A100`."
     },
     "target_gpu_count": {
      "type": "integer",
      "minimum": 0,
      "maximum": 16,
      "nullable": true,
      "description": "Number of GPUs for a new GPU VM (0-16)."
     },
     "target_gpu_memory_gb": {
      "type": "number",
      "minimum": 0,
      "nullable": true,
      "description": "GPU memory for a new GPU VM in GB."
     },
     "target_gpu_memory_display": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "nullable": true,
      "description": "Display label for the GPU memory."
     },
     "target_site_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "nullable": true,
      "description": "Site for the new VM, from `GET /compute/sites`."
     },
     "target_site_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "nullable": true,
      "description": "Display name of that site."
     },
     "selected_volume_id": {
      "type": "string",
      "minLength": 1,
      "nullable": true,
      "description": "Volume to restore in `volume_only` mode."
     },
     "requested_by": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "default": "api",
      "description": "Free-text label for who or what made the request, stored with the record. Default `api`."
     },
     "auto_start": {
      "type": "boolean",
      "default": true,
      "description": "Start the VM once the restore completes. Default true."
     }
    }
   },
   "BackupRestoreRequest": {
    "description": "Body for restoring a VM from a backup run.",
    "allOf": [
     {
      "$ref": "#/components/schemas/RecoveryRestoreRequest"
     },
     {
      "type": "object",
      "required": [
       "recovery_point_id"
      ],
      "properties": {
       "recovery_point_id": {
        "type": "string",
        "minLength": 1,
        "description": "Recovery point to restore: the `recovery_point_id` of a succeeded backup run."
       }
      }
     }
    ]
   },
   "BackupFrequency": {
    "description": "How often a backup policy runs.\n- `hourly`: every hour at `minute`.\n- `daily`: every day at `hour`:`minute`.\n- `weekly`: every week on `day_of_week` at `hour`:`minute`.",
    "type": "string",
    "enum": [
     "hourly",
     "daily",
     "weekly"
    ]
   },
   "BackupStatus": {
    "description": "Lifecycle status of a backup run, snapshot set or restore.\n- `queued`: accepted and waiting to start.\n- `running`: in progress.\n- `succeeded`: finished; the recovery point is usable.\n- `failed`: stopped with an error (see `error_message`).\n- `cancelled`: stopped before it completed.",
    "type": "string",
    "enum": [
     "queued",
     "running",
     "succeeded",
     "failed",
     "cancelled"
    ]
   },
   "BackupPolicySchedule": {
    "description": "When a backup policy runs. Times are interpreted in `timezone`.",
    "type": "object",
    "properties": {
     "frequency": {
      "$ref": "#/components/schemas/BackupFrequency"
     },
     "timezone": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "default": "UTC",
      "description": "IANA time zone name used for `hour` and `minute`. Default `UTC`."
     },
     "hour": {
      "type": "integer",
      "minimum": 0,
      "maximum": 23,
      "default": 20,
      "description": "Hour of the day the run is due (0-23). Default 20."
     },
     "minute": {
      "type": "integer",
      "minimum": 0,
      "maximum": 59,
      "default": 0,
      "description": "Minute of the hour the run is due (0-59). Default 0."
     },
     "day_of_week": {
      "type": "integer",
      "minimum": 0,
      "maximum": 6,
      "nullable": true,
      "description": "Day of the week for weekly schedules: 0 = Monday to 6 = Sunday. Required when `frequency` is `weekly`."
     },
     "window_minutes": {
      "type": "integer",
      "minimum": 5,
      "maximum": 180,
      "default": 30,
      "description": "Spread window in minutes (5-180) after the scheduled time within which the run may start, so runs are not all launched at the same instant. Default 30."
     }
    }
   },
   "BackupPolicyEnableRequest": {
    "description": "Body for enabling scheduled backups on a VM.",
    "type": "object",
    "required": [
     "billing_catalog"
    ],
    "properties": {
     "schedule": {
      "$ref": "#/components/schemas/BackupPolicySchedule"
     },
     "retention_days": {
      "type": "integer",
      "minimum": 1,
      "maximum": 365,
      "default": 7,
      "description": "Days a backup run is kept before it is expired (1-365). Default 7."
     },
     "full_backup_interval_days": {
      "type": "integer",
      "minimum": 1,
      "maximum": 30,
      "default": 7,
      "description": "Days between full backups (1-30); when `incremental_enabled` is true the runs in between are incremental. Default 7."
     },
     "incremental_enabled": {
      "type": "boolean",
      "default": true,
      "description": "Whether runs between full backups capture only changes. Default true."
     },
     "billing_catalog": {
      "$ref": "#/components/schemas/BillingCatalogSelection",
      "description": "Required. The backup storage SKU from the Billing catalog that the VM engine records for this policy's backups. No public operation lists it yet."
     },
     "requested_by": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "default": "api",
      "description": "Free-text label for who or what made the request, stored with the record. Default `api`."
     }
    }
   },
   "BackupPolicyUpdateRequest": {
    "description": "Body for changing a backup policy. Only the fields sent are changed.",
    "type": "object",
    "properties": {
     "schedule": {
      "$ref": "#/components/schemas/BackupPolicySchedule"
     },
     "retention_days": {
      "type": "integer",
      "minimum": 1,
      "maximum": 365,
      "nullable": true,
      "description": "Days a backup run is kept before it is expired (1-365)."
     },
     "full_backup_interval_days": {
      "type": "integer",
      "minimum": 1,
      "maximum": 30,
      "nullable": true,
      "description": "Days between full backups (1-30)."
     },
     "incremental_enabled": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether runs between full backups capture only changes."
     },
     "requested_by": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "default": "api",
      "description": "Free-text label for who or what made the request, stored with the record. Default `api`."
     }
    }
   },
   "BackupPolicyDisableRequest": {
    "description": "Optional body for disabling scheduled backups.",
    "type": "object",
    "properties": {
     "requested_by": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "default": "api",
      "description": "Free-text label for who or what made the request, stored with the record. Default `api`."
     }
    }
   },
   "BackupPolicyNextRunRequest": {
    "description": "Body for moving the policy's next scheduled run.",
    "type": "object",
    "required": [
     "next_run_at"
    ],
    "properties": {
     "next_run_at": {
      "type": "string",
      "format": "date-time",
      "description": "New time for the next scheduled run (ISO 8601)."
     },
     "requested_by": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "default": "api",
      "description": "Free-text label for who or what made the request, stored with the record. Default `api`."
     }
    }
   },
   "BackupPolicy": {
    "description": "A VM's scheduled-backup policy and the result of its last run.",
    "type": "object",
    "required": [
     "organization_id",
     "workspace_id",
     "policy_id",
     "vm_id",
     "enabled",
     "schedule",
     "retention_days",
     "full_backup_interval_days",
     "incremental_enabled",
     "storage_backend",
     "created_at",
     "updated_at"
    ],
    "properties": {
     "organization_id": {
      "type": "string",
      "description": "ID of the organization that owns the VM."
     },
     "organization_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of the owning organization, when the service has it."
     },
     "workspace_id": {
      "type": "string",
      "description": "ID of the workspace the VM belongs to."
     },
     "workspace_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of the workspace, when the service has it."
     },
     "policy_id": {
      "type": "string",
      "description": "Unique ID of the backup policy."
     },
     "vm_id": {
      "type": "string",
      "description": "ID of the VM the policy protects."
     },
     "vm_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of the VM, as recorded on the policy."
     },
     "os_type": {
      "type": "string",
      "nullable": true,
      "description": "OS family of the VM (`linux` or `windows`), as recorded on the policy."
     },
     "os_distro": {
      "type": "string",
      "nullable": true,
      "description": "OS distribution of the VM, as recorded on the policy."
     },
     "template_id": {
      "type": "string",
      "nullable": true,
      "description": "Template the VM was created from, as recorded on the policy."
     },
     "enabled": {
      "type": "boolean",
      "description": "Whether scheduled runs are active."
     },
     "schedule": {
      "$ref": "#/components/schemas/BackupPolicySchedule"
     },
     "retention_days": {
      "type": "integer",
      "description": "Days a backup run is kept before it is expired."
     },
     "full_backup_interval_days": {
      "type": "integer",
      "description": "Days between full backups."
     },
     "incremental_enabled": {
      "type": "boolean",
      "description": "Whether runs between full backups capture only changes."
     },
     "storage_backend": {
      "type": "string",
      "description": "Identifier of the storage backend that holds the captured data."
     },
     "next_run_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the next scheduled run is due; null when none is scheduled."
     },
     "last_run_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the most recent run started; null before the first run."
     },
     "last_status": {
      "$ref": "#/components/schemas/BackupStatus"
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the policy was created (ISO 8601)."
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the policy was last changed (ISO 8601)."
     }
    }
   },
   "ManualBackupRunRequest": {
    "description": "Body for starting an on-demand backup run.",
    "type": "object",
    "required": [
     "billing_catalog"
    ],
    "properties": {
     "billing_catalog": {
      "$ref": "#/components/schemas/BillingCatalogSelection",
      "description": "Required. The backup storage SKU from the Billing catalog that the VM engine records for this backup. No public operation lists it yet."
     },
     "requested_by": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "default": "api",
      "description": "Free-text label for who or what made the request, stored with the record. Default `api`."
     },
     "reason": {
      "type": "string",
      "maxLength": 512,
      "nullable": true,
      "description": "Optional free-text reason recorded with the run (up to 512 characters)."
     }
    }
   },
   "BackupRun": {
    "description": "One backup run of a VM. A succeeded run is a recovery point that `POST .../backups/restore` accepts through `recovery_point_id`.",
    "type": "object",
    "required": [
     "organization_id",
     "workspace_id",
     "run_id",
     "vm_id",
     "trigger",
     "backup_type",
     "status"
    ],
    "properties": {
     "organization_id": {
      "type": "string",
      "description": "ID of the organization that owns the VM."
     },
     "organization_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of the owning organization, when the service has it."
     },
     "workspace_id": {
      "type": "string",
      "description": "ID of the workspace the VM belongs to."
     },
     "workspace_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of the workspace, when the service has it."
     },
     "run_id": {
      "type": "string",
      "description": "Unique ID of the backup run."
     },
     "source_run_id": {
      "type": "string",
      "nullable": true,
      "description": "ID of an earlier run this run derives from, when the service records one."
     },
     "vm_backup_id": {
      "type": "string",
      "nullable": true,
      "description": "ID of the backup record in the backup store, when the service records one."
     },
     "vm_id": {
      "type": "string",
      "description": "ID of the VM that was backed up."
     },
     "vm_type": {
      "type": "string",
      "nullable": true,
      "default": "cloud",
      "description": "`cloud` or `gpu`. Default `cloud`."
     },
     "vm_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of the VM at run time."
     },
     "os_type": {
      "type": "string",
      "nullable": true,
      "description": "OS family of the VM (`linux` or `windows`) at run time."
     },
     "os_distro": {
      "type": "string",
      "nullable": true,
      "description": "OS distribution of the VM at run time."
     },
     "template_id": {
      "type": "string",
      "nullable": true,
      "description": "Template the VM was created from."
     },
     "policy_id": {
      "type": "string",
      "nullable": true,
      "description": "Backup policy the run belongs to, when a policy created it."
     },
     "chain_id": {
      "type": "string",
      "nullable": true,
      "description": "ID of the backup chain (a full backup and the incremental runs that follow it) the run belongs to."
     },
     "recovery_point_id": {
      "type": "string",
      "nullable": true,
      "description": "Value to send as `recovery_point_id` when restoring from this run."
     },
     "trigger": {
      "type": "string",
      "enum": [
       "scheduled",
       "manual",
       "api"
      ],
      "description": "What started the run.\n- `scheduled`: the policy schedule.\n- `manual`: an on-demand request from a user.\n- `api`: an on-demand request through the API."
     },
     "backup_type": {
      "type": "string",
      "enum": [
       "full",
       "incremental"
      ],
      "description": "- `full`: a complete copy of the captured volumes.\n- `incremental`: only the changes since the previous run in the chain."
     },
     "status": {
      "$ref": "#/components/schemas/BackupStatus"
     },
     "storage_backend": {
      "type": "string",
      "nullable": true,
      "description": "Identifier of the storage backend that holds the captured data."
     },
     "started_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the run started (ISO 8601); null while queued."
     },
     "completed_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the run finished (ISO 8601); null until it does."
     },
     "size_gb": {
      "type": "integer",
      "nullable": true,
      "description": "Size of the captured data in GiB."
     },
     "source_disk_size_gb": {
      "type": "integer",
      "nullable": true,
      "description": "Provisioned size of the source root disk in GiB at capture time."
     },
     "bytes_transferred": {
      "type": "integer",
      "nullable": true,
      "description": "Bytes transferred to the backup store during the run."
     },
     "backup_stored_size_bytes": {
      "type": "integer",
      "nullable": true,
      "description": "Bytes the backup occupies in the backup store."
     },
     "backup_stored_size_gb": {
      "type": "number",
      "nullable": true,
      "description": "`backup_stored_size_bytes` expressed in GiB."
     },
     "protected_storage_bytes": {
      "type": "integer",
      "nullable": true,
      "description": "Bytes of source data protected by this recovery point."
     },
     "billing_storage_bytes": {
      "type": "integer",
      "nullable": true,
      "description": "Bytes billed for storing this recovery point."
     },
     "billing_storage_source": {
      "type": "string",
      "default": "unavailable",
      "description": "How `billing_storage_bytes` was obtained.\n- `metered`: measured in the backup store.\n- `metered_from_manifest`: summed from the volume manifest.\n- `unavailable`: not measured yet."
     },
     "metering_status": {
      "type": "string",
      "default": "unavailable",
      "description": "`metered` once storage has been measured for billing; `unavailable` until then."
     },
     "captured_volume_count": {
      "type": "integer",
      "default": 1,
      "description": "Number of volumes in the recovery point."
     },
     "root_only": {
      "type": "boolean",
      "default": true,
      "description": "True when only the root disk was captured."
     },
     "captured_topology_hash": {
      "type": "string",
      "nullable": true,
      "description": "Hash of the VM's volume layout at capture time; a different hash on the live VM means the layout drifted."
     },
     "capture_scope": {
      "type": "string",
      "enum": [
       "root_only",
       "all_attached",
       "selective"
      ],
      "nullable": true,
      "description": "Which volumes the recovery point contains.\n- `root_only`: the root disk only.\n- `all_attached`: the root disk and every attached data volume.\n- `selective`: the root disk and the data volumes that were selected."
     },
     "recovery_point_type": {
      "type": "string",
      "enum": [
       "backup"
      ],
      "default": "backup",
      "description": "Always `backup` for a backup run."
     },
     "volume_manifest": {
      "description": "One entry per captured volume.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/RecoveryVolumeManifestItem"
      }
     },
     "volume_manifest_summary": {
      "$ref": "#/components/schemas/RecoveryPointSummary"
     },
     "live_drift_summary": {
      "$ref": "#/components/schemas/LiveDriftSummary"
     },
     "error_message": {
      "type": "string",
      "nullable": true,
      "description": "Error detail when `status` is `failed`."
     },
     "metadata": {
      "type": "object",
      "additionalProperties": true,
      "description": "Additional service-specific key-value data."
     }
    }
   },
   "BackupRunList": {
    "description": "Backup runs of a VM, newest first.",
    "type": "object",
    "required": [
     "runs",
     "total"
    ],
    "properties": {
     "runs": {
      "description": "Backup runs on this page.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/BackupRun"
      }
     },
     "total": {
      "type": "integer",
      "default": 0,
      "description": "Total number of runs matching the request."
     }
    }
   },
   "RecoveryRestore": {
    "description": "A restore job started from a backup run or a snapshot set.",
    "type": "object",
    "required": [
     "organization_id",
     "workspace_id",
     "restore_id",
     "source_vm_id",
     "target_mode",
     "recovery_point_id",
     "status"
    ],
    "properties": {
     "organization_id": {
      "type": "string",
      "description": "ID of the organization that owns the VM."
     },
     "organization_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of the owning organization, when the service has it."
     },
     "workspace_id": {
      "type": "string",
      "description": "ID of the workspace the VM belongs to."
     },
     "workspace_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of the workspace, when the service has it."
     },
     "restore_id": {
      "type": "string",
      "description": "Unique ID of the restore job."
     },
     "source_vm_id": {
      "type": "string",
      "description": "VM the recovery point was taken from."
     },
     "target_mode": {
      "type": "string",
      "enum": [
       "replace",
       "new_vm",
       "volume_only"
      ],
      "description": "- `replace`: restored onto the source VM.\n- `new_vm`: restored into a new VM.\n- `volume_only`: a single volume was restored."
     },
     "target_vm_id": {
      "type": "string",
      "nullable": true,
      "description": "VM that received the restore: the source VM for `replace`, the new VM for `new_vm`."
     },
     "target_vm_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of the target VM."
     },
     "recovery_point_id": {
      "type": "string",
      "description": "Recovery point that was restored."
     },
     "recovery_point_type": {
      "type": "string",
      "enum": [
       "backup",
       "snapshot"
      ],
      "description": "- `backup`: the recovery point is a backup run.\n- `snapshot`: the recovery point is a snapshot set."
     },
     "status": {
      "$ref": "#/components/schemas/BackupStatus"
     },
     "started_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the restore started (ISO 8601); null while queued."
     },
     "completed_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the restore finished (ISO 8601); null until it does."
     },
     "error_message": {
      "type": "string",
      "nullable": true,
      "description": "Error detail when `status` is `failed`."
     },
     "metadata": {
      "type": "object",
      "additionalProperties": true,
      "description": "Additional service-specific key-value data."
     }
    }
   },
   "VmConsoleSessionCreateRequest": {
    "description": "Body for opening a graphical console session on a VM.",
    "type": "object",
    "required": [
     "vm_id"
    ],
    "properties": {
     "vm_id": {
      "type": "string",
      "minLength": 1,
      "description": "ID of the VM."
     },
     "vm_type": {
      "$ref": "#/components/schemas/VmType"
     },
     "console_type": {
      "type": "string",
      "enum": [
       "graphical"
      ],
      "default": "graphical",
      "description": "`graphical` is the only console type."
     },
     "requested_by": {
      "type": "string",
      "nullable": true,
      "default": "portal-client-ui",
      "description": "Label for the client opening the session. Default `portal-client-ui`."
     },
     "user_id": {
      "type": "string",
      "nullable": true,
      "description": "User the session is opened for, when the caller tracks one."
     }
    }
   },
   "VmConsoleSession": {
    "description": "A newly created console session, including its one-time connection URL.",
    "type": "object",
    "required": [
     "session_id",
     "vm_id",
     "vm_type",
     "console_type",
     "connect_url",
     "token_expires_in_seconds",
     "idle_timeout_seconds",
     "max_duration_seconds",
     "state"
    ],
    "properties": {
     "session_id": {
      "type": "string",
      "description": "Unique ID of the session."
     },
     "vm_id": {
      "type": "string",
      "description": "ID of the VM."
     },
     "organization_id": {
      "type": "string",
      "nullable": true,
      "description": "ID of the organization that owns the VM."
     },
     "workspace_id": {
      "type": "string",
      "nullable": true,
      "description": "ID of the workspace the VM belongs to."
     },
     "workspace_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of the workspace, when the service has it."
     },
     "vm_type": {
      "$ref": "#/components/schemas/VmType"
     },
     "console_type": {
      "type": "string",
      "enum": [
       "graphical"
      ],
      "description": "Always `graphical`."
     },
     "connect_url": {
      "type": "string",
      "format": "uri",
      "description": "Sensitive, short-lived console connection URL. Do not log or persist it."
     },
     "token_expires_in_seconds": {
      "type": "integer",
      "description": "Seconds until the token embedded in `connect_url` expires."
     },
     "idle_timeout_seconds": {
      "type": "integer",
      "description": "Seconds of inactivity after which the session is closed."
     },
     "max_duration_seconds": {
      "type": "integer",
      "description": "Maximum lifetime of the session in seconds."
     },
     "state": {
      "$ref": "#/components/schemas/VmConsoleState"
     }
    }
   },
   "VmConsoleSessionStatus": {
    "description": "Current state of a console session.",
    "type": "object",
    "required": [
     "session_id",
     "vm_id",
     "vm_type",
     "console_type",
     "state",
     "host_id",
     "host_mgmt_ip",
     "socket_path",
     "created_at",
     "idle_timeout_seconds",
     "max_duration_seconds"
    ],
    "properties": {
     "session_id": {
      "type": "string",
      "description": "Unique ID of the session."
     },
     "vm_id": {
      "type": "string",
      "description": "ID of the VM."
     },
     "organization_id": {
      "type": "string",
      "nullable": true,
      "description": "ID of the organization that owns the VM."
     },
     "workspace_id": {
      "type": "string",
      "nullable": true,
      "description": "ID of the workspace the VM belongs to."
     },
     "workspace_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of the workspace, when the service has it."
     },
     "vm_type": {
      "$ref": "#/components/schemas/VmType"
     },
     "console_type": {
      "type": "string",
      "enum": [
       "graphical"
      ],
      "description": "Always `graphical`."
     },
     "state": {
      "$ref": "#/components/schemas/VmConsoleState"
     },
     "host_id": {
      "type": "string",
      "description": "ID of the host that serves the console."
     },
     "host_mgmt_ip": {
      "type": "string",
      "description": "Management IP address of that host."
     },
     "socket_path": {
      "type": "string",
      "description": "Console socket path on that host."
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the session was created (ISO 8601)."
     },
     "connected_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the client connected (ISO 8601); null until it does."
     },
     "closed_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the session closed (ISO 8601); null while open."
     },
     "close_reason": {
      "type": "string",
      "nullable": true,
      "description": "Why the session closed, for example `closed_by_user`; null while open."
     },
     "token_expires_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the connection token expires (ISO 8601)."
     },
     "idle_timeout_seconds": {
      "type": "integer",
      "description": "Seconds of inactivity after which the session is closed."
     },
     "max_duration_seconds": {
      "type": "integer",
      "description": "Maximum lifetime of the session in seconds."
     }
    }
   },
   "VmConsoleState": {
    "description": "State of a console session.\n- `issued`: created; no client has connected yet.\n- `active`: a client is connected.\n- `closed`: closed by the client or the API.\n- `failed`: could not be established.\n- `expired`: the token or the maximum duration lapsed.",
    "type": "string",
    "enum": [
     "issued",
     "active",
     "closed",
     "failed",
     "expired"
    ]
   },
   "VmConsoleClose": {
    "description": "Result of closing a console session.",
    "type": "object",
    "required": [
     "session_id",
     "state",
     "close_reason"
    ],
    "properties": {
     "session_id": {
      "type": "string",
      "description": "ID of the closed session."
     },
     "state": {
      "$ref": "#/components/schemas/VmConsoleState"
     },
     "close_reason": {
      "type": "string",
      "description": "Reason recorded for the close."
     }
    }
   },
   "OperationAccepted": {
    "description": "Acknowledgement that an asynchronous VM operation was queued. Poll `GET /compute/operations/{operation_id}` for progress.",
    "type": "object",
    "required": [
     "operation_id",
     "vm_id",
     "status",
     "submitted_at"
    ],
    "properties": {
     "operation_id": {
      "description": "ID of the queued operation.",
      "type": "string",
      "example": "op_123"
     },
     "vm_id": {
      "description": "ID of the VM the operation acts on.",
      "type": "string",
      "example": "vm_abc123"
     },
     "status": {
      "description": "Always `accepted`.",
      "type": "string",
      "example": "accepted"
     },
     "submitted_at": {
      "description": "When the operation was accepted (ISO 8601).",
      "type": "string",
      "format": "date-time"
     }
    }
   },
   "OperationStatus": {
    "description": "Progress of an asynchronous VM operation.",
    "type": "object",
    "required": [
     "operation_id",
     "vm_id",
     "action",
     "status",
     "submitted_at",
     "updated_at"
    ],
    "properties": {
     "operation_id": {
      "description": "ID of the operation.",
      "type": "string",
      "example": "op_123"
     },
     "vm_id": {
      "description": "ID of the VM the operation acts on.",
      "type": "string",
      "example": "vm_abc123"
     },
     "action": {
      "description": "What the operation does.\n- `create`, `delete`: create or delete the VM.\n- `start`, `stop`, `reboot`: power actions.\n- `resize`, `resize_plan`, `resize_root_disk`: change the shape or the root disk.\n- `attach_volume`, `detach_volume`: block volume attachment.\n- `update_access`: SSH key or password change.\n- `snapshot`, `restore`: snapshot or restore.\n- `rebuild`, `rescue`: rebuild the VM or boot it into rescue mode.",
      "type": "string",
      "enum": [
       "create",
       "start",
       "stop",
       "reboot",
       "delete",
       "resize",
       "attach_volume",
       "detach_volume",
       "resize_plan",
       "resize_root_disk",
       "update_access",
       "snapshot",
       "restore",
       "rebuild",
       "rescue"
      ],
      "example": "create"
     },
     "status": {
      "description": "- `accepted`: queued, not started.\n- `running`: in progress.\n- `waiting`: paused until an external step completes.\n- `compensating`: rolling back after a failure.\n- `succeeded`: finished successfully.\n- `failed`: finished with an error; see `error_code` and `error_message`.\n- `cancelled`: stopped before completion.\n- `timed_out`: did not finish within the allowed time.",
      "type": "string",
      "enum": [
       "accepted",
       "running",
       "waiting",
       "compensating",
       "succeeded",
       "failed",
       "cancelled",
       "timed_out"
      ],
      "example": "running"
     },
     "current_step": {
      "description": "Name of the step currently running, when the workflow reports one.",
      "type": "string",
      "nullable": true,
      "example": "provisioning_network"
     },
     "error_code": {
      "description": "Machine-readable error code when `status` is `failed`.",
      "type": "string",
      "nullable": true
     },
     "error_message": {
      "description": "Human-readable error detail when `status` is `failed`.",
      "type": "string",
      "nullable": true
     },
     "submitted_at": {
      "description": "When the operation was accepted (ISO 8601).",
      "type": "string",
      "format": "date-time"
     },
     "updated_at": {
      "description": "When the status last changed (ISO 8601).",
      "type": "string",
      "format": "date-time"
     }
    }
   },
   "CreateBlockVolumeRequest": {
    "description": "Body for creating a standalone block storage volume.",
    "type": "object",
    "additionalProperties": false,
    "required": [
     "name",
     "size_gb",
     "site_id"
    ],
    "properties": {
     "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Display name of the volume (1-255 characters)."
     },
     "size_gb": {
      "type": "integer",
      "minimum": 1,
      "maximum": 10000,
      "description": "Size in GB (1-10000)."
     },
     "site_id": {
      "example": "68b99bd78a8eda32ff3f16ea",
      "type": "string",
      "minLength": 1,
      "description": "Site to create the volume at."
     },
     "site_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of that site, as shown in the portal."
     },
     "sku_code": {
      "type": "string",
      "nullable": true,
      "description": "Optional public selector returned by the server-owned Block Storage catalog. The edge resolves all price and catalog metadata; callers cannot submit pricing."
     },
     "volume_class": {
      "type": "string",
      "enum": [
       "capacity",
       "balanced",
       "performance"
      ],
      "default": "balanced",
      "description": "Performance class of the volume.\n- `capacity`: lowest cost per GB.\n- `balanced`: general purpose.\n- `performance`: highest throughput and IOPS.\nDefault `balanced`."
     },
     "replica_count": {
      "type": "integer",
      "minimum": 1,
      "maximum": 5,
      "default": 2,
      "description": "Number of synchronous replicas kept for the volume (1-5). Default 2."
     },
     "backup_enabled": {
      "type": "boolean",
      "default": true,
      "description": "Whether volume backups are enabled. Default true."
     },
     "idempotency_key": {
      "type": "string",
      "nullable": true,
      "description": "Caller-chosen key that makes a retried request return the original operation instead of starting a new one."
     }
    }
   },
   "BlockVolumeAttachment": {
    "description": "An active attachment of a volume to a compute node and, when known, the VM on it.",
    "type": "object",
    "required": [
     "node_name",
     "mode",
     "device_path",
     "attached_at"
    ],
    "properties": {
     "node_name": {
      "type": "string",
      "description": "Compute node the volume is attached to."
     },
     "mode": {
      "type": "string",
      "enum": [
       "single-writer",
       "multi-writer"
      ],
      "description": "- `single-writer`: only this node may write to the volume.\n- `multi-writer`: the volume may be attached to several nodes."
     },
     "device_path": {
      "type": "string",
      "description": "Device path on the node, for example `/dev/drbd1000`."
     },
     "vm_id": {
      "type": "string",
      "nullable": true,
      "description": "ID of the VM the volume is attached to, when known."
     },
     "vm_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of that VM."
     },
     "attached_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the attachment was made (ISO 8601)."
     }
    }
   },
   "BlockVolume": {
    "description": "A block storage volume.",
    "type": "object",
    "required": [
     "id",
     "name",
     "size_gb",
     "state",
     "volume_class",
     "replica_count",
     "attachments",
     "created_at",
     "updated_at"
    ],
    "properties": {
     "id": {
      "type": "string",
      "description": "Unique ID of the volume."
     },
     "organization_id": {
      "type": "string",
      "description": "ID of the owning organization."
     },
     "workspace_id": {
      "type": "string",
      "description": "ID of the owning workspace."
     },
     "workspace_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of the workspace."
     },
     "site_id": {
      "type": "string",
      "nullable": true,
      "description": "Site the volume lives at."
     },
     "site_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of that site."
     },
     "name": {
      "type": "string",
      "description": "Display name of the volume."
     },
     "size_gb": {
      "type": "integer",
      "description": "Size in GB."
     },
     "state": {
      "type": "string",
      "enum": [
       "creating",
       "ready",
       "in-use",
       "attaching",
       "detaching",
       "resizing",
       "deleting",
       "error"
      ],
      "description": "Lifecycle state of the volume.\n- `creating`: being provisioned.\n- `ready`: provisioned and detached.\n- `in-use`: attached to a node.\n- `attaching`, `detaching`: an attachment change is in progress.\n- `resizing`: a resize is in progress.\n- `deleting`: being removed.\n- `error`: the last operation failed; see its `error`."
     },
     "volume_class": {
      "type": "string",
      "enum": [
       "capacity",
       "balanced",
       "performance"
      ],
      "description": "Performance class of the volume.\n- `capacity`: lowest cost per GB.\n- `balanced`: general purpose.\n- `performance`: highest throughput and IOPS."
     },
     "replica_count": {
      "type": "integer",
      "description": "Number of synchronous replicas kept for the volume."
     },
     "attachments": {
      "description": "Current attachments; empty when detached.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/BlockVolumeAttachment"
      }
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the volume was created (ISO 8601)."
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the volume was last changed (ISO 8601)."
     },
     "metadata": {
      "description": "Additional key-value data, including the `billing_catalog` the volume was created with.",
      "type": "object",
      "additionalProperties": true,
      "properties": {
       "billing_catalog": {
        "$ref": "#/components/schemas/BillingCatalogSelection",
        "description": "The Block Storage SKU this volume is billed under. Pass it as `billing_catalog` when attaching the volume to a VM."
       }
      }
     }
    }
   },
   "BlockVolumeOperation": {
    "description": "One operation run on a volume.",
    "type": "object",
    "required": [
     "id",
     "volume_id",
     "operation",
     "status",
     "created_at",
     "started_at"
    ],
    "properties": {
     "id": {
      "type": "string",
      "description": "Unique ID of the operation."
     },
     "volume_id": {
      "type": "string",
      "description": "Volume the operation acts on."
     },
     "operation": {
      "type": "string",
      "enum": [
       "create",
       "attach",
       "detach",
       "resize",
       "delete"
      ],
      "description": "- `create`\n- `attach`\n- `detach`\n- `resize`\n- `delete`"
     },
     "status": {
      "type": "string",
      "enum": [
       "in-progress",
       "succeeded",
       "failed"
      ],
      "description": "- `in-progress`: running.\n- `succeeded`: finished successfully.\n- `failed`: finished with an error; see `error`."
     },
     "idempotency_key": {
      "type": "string",
      "nullable": true,
      "description": "Idempotency key the request was made with, when one was given."
     },
     "result": {
      "type": "object",
      "additionalProperties": true,
      "description": "Operation-specific result details as key-value data."
     },
     "error": {
      "type": "string",
      "nullable": true,
      "description": "Error detail when `status` is `failed`."
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the operation was accepted (ISO 8601)."
     },
     "started_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the operation started (ISO 8601)."
     },
     "completed_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the operation finished (ISO 8601); null while running."
     }
    }
   },
   "BlockVolumeAction": {
    "description": "The volume after an action, together with the operation the action created.",
    "type": "object",
    "required": [
     "volume",
     "operation"
    ],
    "properties": {
     "volume": {
      "$ref": "#/components/schemas/BlockVolume"
     },
     "operation": {
      "$ref": "#/components/schemas/BlockVolumeOperation"
     }
    }
   },
   "BlockVolumeDelete": {
    "description": "Confirmation that a volume delete was started.",
    "type": "object",
    "required": [
     "status",
     "id",
     "operation_id"
    ],
    "properties": {
     "status": {
      "type": "string",
      "enum": [
       "deleted"
      ],
      "description": "Always `deleted`."
     },
     "id": {
      "type": "string",
      "description": "ID of the deleted volume."
     },
     "operation_id": {
      "type": "string",
      "description": "ID of the delete operation."
     }
    }
   },
   "AttachBlockVolumeRequest": {
    "description": "Body for attaching a volume to a compute node, optionally recording the VM it serves.",
    "type": "object",
    "required": [
     "node_name"
    ],
    "properties": {
     "node_name": {
      "type": "string",
      "minLength": 1,
      "description": "Compute node to attach the volume to."
     },
     "mode": {
      "type": "string",
      "enum": [
       "single-writer",
       "multi-writer"
      ],
      "default": "single-writer",
      "description": "- `single-writer`: only this node may write to the volume.\n- `multi-writer`: the volume may be attached to several nodes.\nDefault `single-writer`."
     },
     "vm_id": {
      "type": "string",
      "nullable": true,
      "description": "ID of the VM that will use the volume."
     },
     "vm_name": {
      "type": "string",
      "nullable": true,
      "description": "Display name of that VM."
     },
     "vm_state": {
      "type": "string",
      "enum": [
       "running",
       "stopped",
       "suspended"
      ],
      "nullable": true,
      "description": "Current power state of the VM, when the caller knows it.\n- `running`\n- `stopped`\n- `suspended`"
     },
     "vm_site_id": {
      "type": "string",
      "nullable": true,
      "description": "Site of that VM."
     },
     "vm_type": {
      "type": "string",
      "enum": [
       "cloud",
       "gpu"
      ],
      "default": "cloud",
      "description": "Kind of VM the volume is used with.\n- `cloud` (default)\n- `gpu`"
     },
     "idempotency_key": {
      "type": "string",
      "nullable": true,
      "description": "Caller-chosen key that makes a retried request return the original operation instead of starting a new one."
     }
    }
   },
   "DetachBlockVolumeRequest": {
    "description": "Body for detaching a volume from a compute node.",
    "type": "object",
    "required": [
     "node_name"
    ],
    "properties": {
     "node_name": {
      "type": "string",
      "minLength": 1,
      "description": "Compute node to detach the volume from."
     },
     "force": {
      "type": "boolean",
      "default": false,
      "description": "Detach even if the volume still appears to be in use. Default false."
     },
     "confirm_unmounted": {
      "type": "boolean",
      "default": false,
      "description": "Confirms the volume was unmounted inside the guest. Default false."
     },
     "vm_state": {
      "type": "string",
      "enum": [
       "running",
       "stopped",
       "suspended"
      ],
      "nullable": true,
      "description": "Current power state of the VM, when the caller knows it.\n- `running`\n- `stopped`\n- `suspended`"
     },
     "vm_type": {
      "type": "string",
      "enum": [
       "cloud",
       "gpu"
      ],
      "default": "cloud",
      "description": "Kind of VM the volume is used with.\n- `cloud` (default)\n- `gpu`"
     },
     "reason": {
      "type": "string",
      "nullable": true,
      "description": "Optional free-text reason recorded with the operation."
     },
     "idempotency_key": {
      "type": "string",
      "nullable": true,
      "description": "Caller-chosen key that makes a retried request return the original operation instead of starting a new one."
     }
    }
   },
   "ResizeBlockVolumeRequest": {
    "description": "Body for growing a volume.",
    "type": "object",
    "required": [
     "new_size_gb"
    ],
    "properties": {
     "new_size_gb": {
      "type": "integer",
      "minimum": 1,
      "maximum": 10000,
      "description": "New size in GB."
     },
     "vm_state": {
      "type": "string",
      "enum": [
       "running",
       "stopped",
       "suspended"
      ],
      "nullable": true,
      "description": "Current power state of the VM, when the caller knows it.\n- `running`\n- `stopped`\n- `suspended`"
     },
     "allow_online": {
      "type": "boolean",
      "default": false,
      "description": "Permit the resize while the volume is attached to a running VM. Default false."
     },
     "idempotency_key": {
      "type": "string",
      "nullable": true,
      "description": "Caller-chosen key that makes a retried request return the original operation instead of starting a new one."
     }
    }
   },
   "GenerateCdnUrlRequest": {
    "description": "Body for generating a CDN URL for one object in a bucket.",
    "type": "object",
    "required": [
     "bucket_name",
     "object_key"
    ],
    "properties": {
     "bucket_name": {
      "type": "string",
      "minLength": 1,
      "description": "Name of the bucket."
     },
     "object_key": {
      "type": "string",
      "minLength": 1,
      "description": "Object key (path) inside the bucket."
     },
     "expires_in": {
      "type": "integer",
      "minimum": 1,
      "nullable": true,
      "description": "Lifetime of the URL in seconds. Omit for a URL that does not expire."
     },
     "disposition": {
      "type": "string",
      "enum": [
       "inline",
       "attachment"
      ],
      "nullable": true,
      "description": "- `inline`: the browser displays the object.\n- `attachment`: the browser downloads it."
     }
    }
   },
   "GeneratedCdnUrl": {
    "description": "A CDN URL for an object.",
    "type": "object",
    "required": [
     "cdn_url"
    ],
    "properties": {
     "cdn_url": {
      "type": "string",
      "format": "uri",
      "description": "The generated URL."
     },
     "expires_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the URL stops working (ISO 8601); null when it does not expire."
     }
    }
   },
   "CreateCdnDistributionRequest": {
    "description": "Body for creating a CDN distribution.",
    "type": "object",
    "required": [
     "name",
     "origin_id"
    ],
    "properties": {
     "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "description": "Display name of the distribution (1-128 characters)."
     },
     "origin_type": {
      "type": "string",
      "enum": [
       "bucket",
       "custom"
      ],
      "default": "bucket",
      "description": "- `bucket`: serve an Object Storage bucket (default).\n- `custom`: serve a custom origin."
     },
     "origin_id": {
      "type": "string",
      "minLength": 1,
      "description": "Bucket name for `bucket` origins, or the custom origin's ID."
     },
     "cache_policy": {
      "type": "string",
      "enum": [
       "static-assets",
       "media",
       "short",
       "no-cache"
      ],
      "default": "static-assets",
      "description": "Caching behaviour. Default `static-assets`.\n- `static-assets`: long-term caching for immutable assets; 1 year at the CDN, browsers revalidate.\n- `media`: medium-term caching for video and audio; 30 days at the CDN.\n- `short`: short-term caching for frequently changing content; 1 hour at the CDN.\n- `no-cache`: no caching, for dynamic responses."
     }
    }
   },
   "UpdateCdnDistributionRequest": {
    "description": "Body for changing a distribution. Only the fields sent are changed.",
    "type": "object",
    "minProperties": 1,
    "properties": {
     "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "description": "New display name."
     },
     "cache_policy": {
      "type": "string",
      "enum": [
       "static-assets",
       "media",
       "short",
       "no-cache"
      ],
      "description": "New caching behaviour.\n- `static-assets`: long-term caching for immutable assets; 1 year at the CDN, browsers revalidate.\n- `media`: medium-term caching for video and audio; 30 days at the CDN.\n- `short`: short-term caching for frequently changing content; 1 hour at the CDN.\n- `no-cache`: no caching, for dynamic responses."
     },
     "enabled": {
      "type": "boolean",
      "description": "Whether the distribution serves traffic."
     }
    }
   },
   "CdnDistribution": {
    "description": "A CDN distribution in front of a bucket or custom origin.",
    "type": "object",
    "required": [
     "id",
     "name",
     "origin_type",
     "origin_id",
     "cache_policy",
     "enabled",
     "status",
     "default_domain",
     "default_url",
     "custom_domains",
     "created_at"
    ],
    "properties": {
     "id": {
      "type": "string",
      "description": "Unique ID of the distribution."
     },
     "name": {
      "type": "string",
      "description": "Display name of the distribution."
     },
     "origin_type": {
      "type": "string",
      "enum": [
       "bucket",
       "custom"
      ],
      "description": "- `bucket`: an Object Storage bucket.\n- `custom`: a custom origin."
     },
     "origin_id": {
      "type": "string",
      "description": "Bucket name or custom origin ID."
     },
     "cache_policy": {
      "type": "string",
      "description": "Caching behaviour in effect.\n- `static-assets`: long-term caching for immutable assets; 1 year at the CDN, browsers revalidate.\n- `media`: medium-term caching for video and audio; 30 days at the CDN.\n- `short`: short-term caching for frequently changing content; 1 hour at the CDN.\n- `no-cache`: no caching, for dynamic responses."
     },
     "enabled": {
      "type": "boolean",
      "description": "Whether the distribution serves traffic."
     },
     "status": {
      "type": "string",
      "enum": [
       "active",
       "deploying",
       "disabled",
       "failed",
       "deleted"
      ],
      "description": "- `active`: serving.\n- `deploying`: configuration is being rolled out to the edge.\n- `disabled`: turned off.\n- `failed`: deployment failed.\n- `deleted`: removed."
     },
     "default_domain": {
      "type": "string",
      "description": "Hostname IBEE assigned to the distribution, for example `dl-abc123.cdn.ibee.ai`."
     },
     "default_url": {
      "type": "string",
      "format": "uri",
      "description": "`https://` URL of `default_domain`."
     },
     "custom_domains": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Custom hostnames attached to the distribution."
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the distribution was created (ISO 8601)."
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the distribution was last changed (ISO 8601)."
     }
    }
   },
   "CdnDistributionList": {
    "description": "Distributions in the workspace.",
    "type": "object",
    "required": [
     "distributions",
     "count"
    ],
    "properties": {
     "distributions": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/CdnDistribution"
      },
      "description": "Distributions returned."
     },
     "count": {
      "type": "integer",
      "minimum": 0,
      "description": "Number of items in `distributions`."
     }
    }
   },
   "UpdateCdnWebsiteConfigRequest": {
    "description": "Body for enabling static-website serving on a distribution.",
    "type": "object",
    "properties": {
     "index_document": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1024,
      "default": "index.html",
      "description": "Object served for directory requests. Default `index.html`."
     }
    }
   },
   "CdnWebsiteConfig": {
    "description": "Static-website settings of a distribution.",
    "type": "object",
    "required": [
     "distribution_id",
     "enabled",
     "index_document"
    ],
    "properties": {
     "distribution_id": {
      "type": "string",
      "description": "ID of the distribution."
     },
     "enabled": {
      "type": "boolean",
      "description": "Whether static-website serving is on."
     },
     "index_document": {
      "type": "string",
      "default": "index.html",
      "description": "Object served for directory requests."
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the settings were created (ISO 8601)."
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the settings were last changed (ISO 8601)."
     }
    }
   },
   "CreateCdnCustomDomainRequest": {
    "description": "Body for adding a custom hostname to a distribution.",
    "type": "object",
    "required": [
     "domain"
    ],
    "properties": {
     "domain": {
      "type": "string",
      "minLength": 3,
      "maxLength": 253,
      "description": "Fully qualified hostname to serve, for example `cdn.example.com`."
     }
    }
   },
   "CdnCustomDomain": {
    "description": "A custom hostname on a distribution.",
    "type": "object",
    "required": [
     "domain",
     "status",
     "created_at"
    ],
    "properties": {
     "domain": {
      "type": "string",
      "description": "The hostname."
     },
     "status": {
      "type": "string",
      "enum": [
       "pending_validation",
       "pending_tls",
       "active",
       "failed"
      ],
      "description": "- `pending_validation`: waiting for the DNS CNAME to be detected.\n- `pending_tls`: validated; the certificate is being issued.\n- `active`: certificate issued; the domain serves traffic.\n- `failed`: validation or certificate issuance failed."
     },
     "tls_status": {
      "type": "string",
      "nullable": true,
      "description": "Certificate status reported by the edge provider, when available."
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the hostname was added (ISO 8601)."
     },
     "instructions": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "nullable": true,
      "description": "Steps to complete setup, such as the CNAME record to create."
     }
    }
   },
   "CdnCustomDomainList": {
    "description": "Custom hostnames of a distribution.",
    "type": "object",
    "required": [
     "distribution_id",
     "default_domain",
     "custom_domains"
    ],
    "properties": {
     "distribution_id": {
      "type": "string",
      "description": "ID of the distribution."
     },
     "default_domain": {
      "type": "string",
      "description": "Hostname IBEE assigned to the distribution; the CNAME target for custom hostnames."
     },
     "custom_domains": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/CdnCustomDomain"
      },
      "description": "Custom hostnames returned."
     }
    }
   },
   "CdnCustomDomainVerification": {
    "description": "Result of re-checking a custom hostname.",
    "type": "object",
    "required": [
     "domain",
     "status",
     "message"
    ],
    "properties": {
     "domain": {
      "type": "string",
      "description": "The hostname."
     },
     "status": {
      "type": "string",
      "enum": [
       "pending_validation",
       "pending_tls",
       "active",
       "failed"
      ],
      "description": "- `pending_validation`: waiting for the DNS CNAME to be detected.\n- `pending_tls`: validated; the certificate is being issued.\n- `active`: certificate issued; the domain serves traffic.\n- `failed`: validation or certificate issuance failed."
     },
     "tls_status": {
      "type": "string",
      "nullable": true,
      "description": "Certificate status reported by the edge provider, when available."
     },
     "message": {
      "type": "string",
      "description": "Human-readable result."
     }
    }
   },
   "PurgeCdnCacheRequest": {
    "description": "Body for purging cached content. Supply the list that matches `mode`.",
    "type": "object",
    "required": [
     "mode"
    ],
    "properties": {
     "mode": {
      "type": "string",
      "enum": [
       "url",
       "hostname",
       "tag",
       "prefix",
       "all"
      ],
      "description": "- `url`: purge the paths in `paths`.\n- `hostname`: purge everything for the hostnames in `hostnames`.\n- `tag`: purge content tagged with `tags`.\n- `prefix`: purge paths starting with `prefixes`.\n- `all`: purge the whole distribution."
     },
     "paths": {
      "type": "array",
      "maxItems": 30,
      "items": {
       "type": "string"
      },
      "description": "Paths to purge, for `url` mode."
     },
     "hostnames": {
      "type": "array",
      "maxItems": 100,
      "items": {
       "type": "string"
      },
      "description": "Hostnames to purge, for `hostname` mode."
     },
     "tags": {
      "type": "array",
      "maxItems": 100,
      "items": {
       "type": "string"
      },
      "description": "Cache tags to purge, for `tag` mode."
     },
     "prefixes": {
      "type": "array",
      "maxItems": 100,
      "items": {
       "type": "string"
      },
      "description": "Path prefixes to purge, for `prefix` mode."
     }
    }
   },
   "CdnCachePurge": {
    "description": "Result of a cache purge.",
    "type": "object",
    "required": [
     "success",
     "mode"
    ],
    "properties": {
     "success": {
      "type": "boolean",
      "description": "True when the purge was accepted."
     },
     "mode": {
      "type": "string",
      "enum": [
       "url",
       "hostname",
       "tag",
       "prefix",
       "all"
      ],
      "description": "Purge mode that was applied.\n- `url`\n- `hostname`\n- `tag`\n- `prefix`\n- `all`"
     },
     "purged": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "nullable": true,
      "description": "Items that were purged, when the mode lists them."
     },
     "message": {
      "type": "string",
      "nullable": true,
      "description": "Human-readable result."
     }
    }
   },
   "BillingEligibilityRequest": {
    "description": "Body for asking Billing whether the organization may perform an action, before you call the product endpoint.",
    "type": "object",
    "properties": {
     "sku_code": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "Billing catalog SKU for the intended resource. Unknown or unavailable SKUs may be denied.",
      "example": "STANDARD-2-8-50"
     },
     "estimated_cost_minor": {
      "type": "integer",
      "minimum": 0,
      "description": "Optional estimated cost expressed in the organization's currency minor unit. Use a value from a trusted catalog.",
      "example": 120000
     },
     "operation": {
      "type": "string",
      "enum": [
       "CREATE_RESOURCE",
       "CREATE_CREDENTIAL",
       "INCREASE_CAPACITY",
       "MUTATE_RESOURCE",
       "READ_RESOURCE",
       "DELETE_RESOURCE",
       "REVOKE_CREDENTIAL",
       "SECURITY_RECOVERY"
      ],
      "default": "CREATE_RESOURCE",
      "description": "The kind of action Billing should decide on."
     },
     "resource_type": {
      "type": "string",
      "enum": [
       "cpu_vm",
       "gpu_vm",
       "block_volume",
       "snapshot",
       "cdn_zone",
       "load_balancer",
       "public_ipv4",
       "bucket",
       "secret_store",
       "secret"
      ],
      "nullable": true,
      "description": "What the request would create, so Billing also checks the plan's resource limit for it. Omit it for a money check only. `bucket`, `secret_store` and `secret` have no limit and get the money check only."
     },
     "quantity": {
      "type": "integer",
      "minimum": 0,
      "maximum": 100000,
      "default": 1,
      "description": "How many resources would be created at once; 0 for a resize, which adds size only."
     },
     "size_gb": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000000,
      "nullable": true,
      "description": "GiB being added (a new volume's size, a resize's increase, or the disks a snapshot will capture), checked against the size limit of that kind."
     }
    }
   },
   "BillingEligibility": {
    "description": "Billing's decision for the requested action. The same check runs at the gateway on every billable request.",
    "type": "object",
    "required": [
     "organization_id",
     "allowed",
     "reason",
     "billing_mode",
     "billing_state",
     "currency",
     "evaluated_at"
    ],
    "properties": {
     "organization_id": {
      "description": "Organization the decision is for.",
      "type": "string"
     },
     "allowed": {
      "type": "boolean",
      "description": "Continue only when this value is exactly true."
     },
     "reason": {
      "type": "string",
      "description": "Machine-readable decision reason. A refusal for a plan limit is `resource_limit_reached`, with the `resource_limit_*` fields set; `resource_usage_unavailable` means Billing could not count usage.",
      "example": "ok"
     },
     "billing_mode": {
      "description": "- `PREPAID`: usage is paid from a wallet balance.\n- `POSTPAID`: usage is invoiced against a credit limit.",
      "type": "string",
      "enum": [
       "PREPAID",
       "POSTPAID"
      ]
     },
     "billing_state": {
      "description": "Payment standing of the organization.\n- `CURRENT`: in good standing.\n- `PAYMENT_DUE`: an invoice is open.\n- `PAST_DUE`: an invoice is overdue.\n- `SOFT_SUSPENDED`: new purchases are blocked.\n- `HARD_SUSPENDED`: service is suspended.",
      "type": "string",
      "enum": [
       "CURRENT",
       "PAYMENT_DUE",
       "PAST_DUE",
       "SOFT_SUSPENDED",
       "HARD_SUSPENDED"
      ]
     },
     "currency": {
      "description": "ISO 4217 code of the organization's billing currency; the `*_minor` amounts are in its minor unit.",
      "type": "string",
      "example": "INR"
     },
     "sku_code": {
      "description": "SKU the decision was evaluated for, when one was given.",
      "type": "string",
      "nullable": true
     },
     "estimated_cost_minor": {
      "description": "Estimated cost that was evaluated, in the currency's minor unit.",
      "type": "integer",
      "nullable": true
     },
     "effective_balance_minor": {
      "description": "Balance available to spend, in the currency's minor unit; null when not applicable.",
      "type": "integer",
      "nullable": true
     },
     "credit_headroom_minor": {
      "description": "Remaining credit before the organization's limit, in the currency's minor unit; null when not applicable.",
      "type": "integer",
      "nullable": true
     },
     "resource_limits": {
      "type": "object",
      "additionalProperties": {
       "type": "integer"
      },
      "description": "How many of each resource the organization's plan allows, keyed by limit (for example `cpu_vm` or `block_storage_gb`). A missing key or `-1` means unlimited."
     },
     "resource_limit_key": {
      "type": "string",
      "nullable": true,
      "description": "The limit that refused the request, when a resource limit decided it."
     },
     "resource_limit": {
      "type": "integer",
      "nullable": true,
      "description": "The value of that limit."
     },
     "resource_usage": {
      "type": "number",
      "nullable": true,
      "description": "Current usage counted against that limit (a count, or GiB for a size limit)."
     },
     "evaluated_at": {
      "description": "When Billing made the decision (ISO 8601).",
      "type": "string",
      "format": "date-time"
     }
    }
   },
   "Error": {
    "type": "object",
    "description": "Error body. A refusal from the gateway's authorization step (auth-service ext-authz) carries `error` and the other fields below except `detail`; each of them is present, null when it does not apply. A refusal from the product service behind the gateway carries `detail` instead.",
    "properties": {
     "error": {
      "type": "string",
      "nullable": true,
      "description": "Machine-readable code from the gateway's authorization step, for example `invalid_api_key`, `insufficient_scope`, `organization_restricted`, `organization_suspended`, `verification_required` or `billing_denied`. The response descriptions list the codes for each status.",
      "example": "insufficient_scope"
     },
     "required_scope": {
      "type": "string",
      "nullable": true,
      "description": "The scope the token lacks, with `insufficient_scope`.",
      "example": "vm.write"
     },
     "billing_reason": {
      "type": "string",
      "nullable": true,
      "description": "Billing's reason with `billing_denied`, passed through unchanged: for example `insufficient_balance`, `credit_limit_exceeded`, `initial_topup_required`, `resource_limit_reached` or `resource_usage_unavailable`."
     },
     "billing_sku_code": {
      "type": "string",
      "nullable": true,
      "description": "The SKU the billing admission checked, when there was one."
     },
     "billing_evaluated_at": {
      "type": "string",
      "nullable": true,
      "description": "When Billing made the decision, as Billing returned it."
     },
     "admission_context_id": {
      "type": "string",
      "nullable": true,
      "description": "Billing admission context for this request, derived from the token, workspace, route and `X-Idempotency-Key`, so a retry with the same key gets the same id."
     },
     "detail": {
      "oneOf": [
       {
        "type": "string"
       },
       {
        "type": "object",
        "additionalProperties": true
       },
       {
        "type": "array",
        "items": {}
       }
      ],
      "description": "Error detail from the product service.",
      "example": "Forbidden"
     }
    }
   },
   "ContainerRegistryVisibility": {
    "type": "string",
    "enum": [
     "PRIVATE",
     "PUBLIC"
    ],
    "description": "`PRIVATE` registries need a registry access token to pull. `PUBLIC` registries allow anonymous pulls, whose outbound bandwidth is billed to the workspace. Pushing always needs a token with push permission."
   },
   "ContainerRegistryPullPolicy": {
    "type": "string",
    "enum": [
     "ALLOW",
     "BLOCK_CRITICAL",
     "BLOCK_HIGH",
     "BLOCK_MEDIUM",
     "BLOCK_LOW"
    ],
    "description": "`ALLOW` pulls every image. `BLOCK_<SEVERITY>` refuses pulls of images with a finding at or above that severity."
   },
   "ContainerRegistryObservedState": {
    "description": "State the registry service has actually reached.\n- `PROVISIONING`: being created.\n- `UPDATING`: a change is being applied.\n- `DELETING`: being removed.\n- `ACTIVE`: ready.\n- `ERROR`: the last change failed.\n- `DELETED`: removed.",
    "type": "string",
    "enum": [
     "PROVISIONING",
     "UPDATING",
     "DELETING",
     "ACTIVE",
     "ERROR",
     "DELETED"
    ]
   },
   "ContainerRegistryJobStatus": {
    "description": "Status of a reconcile job.\n- `PENDING`: queued.\n- `PROCESSING`: running.\n- `COMPLETE`: finished.\n- `FAILED`: finished with an error.",
    "type": "string",
    "enum": [
     "PENDING",
     "PROCESSING",
     "COMPLETE",
     "FAILED"
    ]
   },
   "ContainerRegistryAccessTokenPermission": {
    "description": "What a registry access token may do.\n- `PULL`: pull images.\n- `PULL_PUSH`: pull and push images.",
    "type": "string",
    "enum": [
     "PULL",
     "PULL_PUSH"
    ]
   },
   "ContainerRegistryNameAvailability": {
    "description": "Whether a registry name can be used.",
    "type": "object",
    "required": [
     "registry_name",
     "available",
     "suggestions"
    ],
    "properties": {
     "registry_name": {
      "type": "string",
      "description": "Name that was checked."
     },
     "available": {
      "type": "boolean",
      "description": "True when the name is free."
     },
     "suggestions": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Free names close to the requested one, when it is taken."
     }
    }
   },
   "ContainerRegistryBillingCatalog": {
    "description": "The storage plan to bill the registry against, identified by SKU.",
    "type": "object",
    "additionalProperties": false,
    "required": [
     "sku_code"
    ],
    "properties": {
     "sku_code": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "Storage plan SKU, for example `REGISTRY-STORAGE-250GB`. The service trims and upper-cases it, then requires `^[A-Z0-9][A-Z0-9_.-]*$`. Capacity and price come from Billing."
     }
    }
   },
   "ContainerRegistrySecuritySettings": {
    "description": "Security settings of a registry.",
    "type": "object",
    "properties": {
     "vulnerability_pull_policy": {
      "$ref": "#/components/schemas/ContainerRegistryPullPolicy"
     }
    }
   },
   "CreateContainerRegistryRequest": {
    "description": "Body for creating a registry.",
    "type": "object",
    "required": [
     "registry_name",
     "confirm_registry_name",
     "billing_catalog"
    ],
    "properties": {
     "registry_name": {
      "type": "string",
      "minLength": 3,
      "maxLength": 48,
      "pattern": "^[a-z][a-z0-9-]{1,46}[a-z0-9]$",
      "description": "Globally unique name; it cannot be changed or reused."
     },
     "confirm_registry_name": {
      "type": "string",
      "minLength": 3,
      "maxLength": 48,
      "description": "Must equal `registry_name`."
     },
     "visibility": {
      "description": "- `PRIVATE`: pulls need an access token (default).\n- `PUBLIC`: anonymous pulls are allowed; egress is charged.",
      "allOf": [
       {
        "$ref": "#/components/schemas/ContainerRegistryVisibility"
       }
      ],
      "default": "PRIVATE"
     },
     "acknowledge_public_egress_charges": {
      "type": "boolean",
      "default": false,
      "description": "Required to be `true` when `visibility` is `PUBLIC`."
     },
     "security": {
      "$ref": "#/components/schemas/ContainerRegistrySecuritySettings"
     },
     "billing_catalog": {
      "$ref": "#/components/schemas/ContainerRegistryBillingCatalog"
     }
    }
   },
   "UpdateContainerRegistryVisibilityRequest": {
    "description": "Body for switching a registry between private and public.",
    "type": "object",
    "required": [
     "visibility"
    ],
    "properties": {
     "visibility": {
      "$ref": "#/components/schemas/ContainerRegistryVisibility"
     },
     "acknowledge_public_egress_charges": {
      "type": "boolean",
      "default": false,
      "description": "Required to be `true` when `visibility` is `PUBLIC`."
     }
    }
   },
   "ContainerRegistry": {
    "description": "A container registry. Images are pushed to and pulled from `registry.ibee.ai/<registry_name>/<repository>:<tag>`.",
    "type": "object",
    "required": [
     "registry_id",
     "registry_name",
     "registry_kind",
     "organization_id",
     "workspace_id",
     "visibility",
     "security",
     "desired_state",
     "observed_state",
     "generation",
     "observed_generation",
     "created_at",
     "updated_at",
     "deleted_at"
    ],
    "properties": {
     "registry_id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique ID of the registry."
     },
     "registry_name": {
      "type": "string",
      "description": "Registry name. Images live at `registry.ibee.ai/<registry_name>/<repository>:<tag>`."
     },
     "registry_kind": {
      "type": "string",
      "enum": [
       "CUSTOMER"
      ],
      "description": "Always `CUSTOMER` for registries created through the API."
     },
     "organization_id": {
      "type": "string",
      "description": "ID of the owning organization."
     },
     "workspace_id": {
      "type": "string",
      "description": "ID of the owning workspace."
     },
     "visibility": {
      "$ref": "#/components/schemas/ContainerRegistryVisibility"
     },
     "security": {
      "$ref": "#/components/schemas/ContainerRegistrySecuritySettings"
     },
     "desired_state": {
      "type": "string",
      "enum": [
       "ACTIVE",
       "DELETED"
      ],
      "description": "State requested by the caller.\n- `ACTIVE`\n- `DELETED`"
     },
     "observed_state": {
      "$ref": "#/components/schemas/ContainerRegistryObservedState"
     },
     "generation": {
      "type": "integer",
      "description": "Incremented by every accepted change."
     },
     "observed_generation": {
      "type": "integer",
      "description": "The last generation applied; equal to `generation` when settled."
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the registry was created (ISO 8601)."
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the registry was last changed (ISO 8601)."
     },
     "deleted_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When deletion was requested (ISO 8601); null while the registry exists."
     }
    }
   },
   "ContainerRegistryList": {
    "description": "A page of registries.",
    "type": "object",
    "required": [
     "items",
     "total",
     "page",
     "page_size"
    ],
    "properties": {
     "items": {
      "description": "Registries on this page.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ContainerRegistry"
      }
     },
     "total": {
      "type": "integer",
      "description": "Total number of items matching the request."
     },
     "page": {
      "type": "integer",
      "description": "Page number returned (1-based)."
     },
     "page_size": {
      "type": "integer",
      "description": "Page size that was applied."
     }
    }
   },
   "ContainerRegistryReconcile": {
    "description": "Acknowledgement that a reconcile of the registry's settings was queued.",
    "type": "object",
    "required": [
     "registry_id",
     "generation",
     "status"
    ],
    "properties": {
     "registry_id": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the registry."
     },
     "generation": {
      "type": "integer",
      "description": "Generation the reconcile will apply."
     },
     "status": {
      "$ref": "#/components/schemas/ContainerRegistryJobStatus"
     }
    }
   },
   "ContainerRegistryEmptyResult": {
    "description": "Result of emptying a registry.",
    "type": "object",
    "required": [
     "registry_id",
     "registry_name",
     "deleted_repository_count"
    ],
    "properties": {
     "registry_id": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the registry."
     },
     "registry_name": {
      "type": "string",
      "description": "Name of the registry."
     },
     "deleted_repository_count": {
      "type": "integer",
      "description": "Number of repositories that were deleted."
     }
    }
   },
   "ContainerRegistryPackageAssignment": {
    "description": "A storage plan assigned to the registry for a period.",
    "type": "object",
    "required": [
     "assignment_id",
     "sku_id",
     "sku_code",
     "quota_bytes",
     "quota_gb",
     "effective_from",
     "effective_to"
    ],
    "properties": {
     "assignment_id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique ID of the assignment."
     },
     "sku_id": {
      "type": "string",
      "description": "Billing catalog SKU ID of the plan."
     },
     "sku_code": {
      "type": "string",
      "description": "Storage plan SKU code."
     },
     "quota_bytes": {
      "type": "integer",
      "description": "Storage quota of the plan in bytes (decimal GB)."
     },
     "quota_gb": {
      "type": "number",
      "description": "Decimal GB (1 GB = 1,000,000,000 bytes)."
     },
     "effective_from": {
      "type": "string",
      "format": "date-time",
      "description": "When the plan took effect (ISO 8601)."
     },
     "effective_to": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the plan stopped applying (ISO 8601); null while current."
     }
    }
   },
   "ContainerRegistryPackageOperation": {
    "description": "A plan change requested for the registry.",
    "type": "object",
    "required": [
     "operation_id",
     "registry_id",
     "kind",
     "status",
     "sku_code",
     "quota_bytes",
     "quota_gb",
     "created_at",
     "effective_at"
    ],
    "properties": {
     "operation_id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique ID of the operation."
     },
     "registry_id": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the registry."
     },
     "kind": {
      "type": "string",
      "enum": [
       "CREATE",
       "UPGRADE"
      ],
      "description": "- `CREATE`: the plan chosen at registry creation.\n- `UPGRADE`: a move to a larger plan."
     },
     "status": {
      "type": "string",
      "enum": [
       "PENDING",
       "APPLIED",
       "CANCELLED"
      ],
      "description": "- `PENDING`: not applied yet.\n- `APPLIED`: in effect.\n- `CANCELLED`: withdrawn before it was applied."
     },
     "sku_code": {
      "type": "string",
      "description": "Storage plan SKU code."
     },
     "quota_bytes": {
      "type": "integer",
      "description": "Storage quota of the plan in bytes (decimal GB)."
     },
     "quota_gb": {
      "type": "number",
      "description": "Decimal GB (1 GB = 1,000,000,000 bytes)."
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the operation was requested (ISO 8601)."
     },
     "effective_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the operation took or will take effect (ISO 8601); null when not yet scheduled."
     }
    }
   },
   "ContainerRegistryPackage": {
    "description": "The registry's storage plan: the plan in effect and any pending change.",
    "type": "object",
    "required": [
     "registry_id",
     "current",
     "pending",
     "reconciliation_status"
    ],
    "properties": {
     "registry_id": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the registry."
     },
     "current": {
      "allOf": [
       {
        "$ref": "#/components/schemas/ContainerRegistryPackageAssignment"
       }
      ],
      "nullable": true,
      "description": "The plan in effect."
     },
     "pending": {
      "allOf": [
       {
        "$ref": "#/components/schemas/ContainerRegistryPackageOperation"
       }
      ],
      "nullable": true,
      "description": "A plan change that has not been applied yet."
     },
     "reconciliation_status": {
      "description": "Status of the job applying the pending change, when one is running.",
      "allOf": [
       {
        "$ref": "#/components/schemas/ContainerRegistryJobStatus"
       }
      ],
      "nullable": true
     }
    }
   },
   "UpgradeContainerRegistryPackageRequest": {
    "description": "Body for moving the registry to another storage plan.",
    "type": "object",
    "additionalProperties": false,
    "required": [
     "billing_catalog"
    ],
    "properties": {
     "billing_catalog": {
      "$ref": "#/components/schemas/ContainerRegistryBillingCatalog"
     }
    }
   },
   "CreateContainerRegistryAccessTokenRequest": {
    "description": "Body for creating a registry access token. The secret is returned once, in the response.",
    "type": "object",
    "required": [
     "token_name"
    ],
    "properties": {
     "token_name": {
      "type": "string",
      "minLength": 3,
      "maxLength": 64,
      "pattern": "^[a-z][a-z0-9-]{1,62}[a-z0-9]$",
      "description": "Unique among the organization's active tokens."
     },
     "permission": {
      "description": "- `PULL`: pull only (default).\n- `PULL_PUSH`: pull and push.",
      "allOf": [
       {
        "$ref": "#/components/schemas/ContainerRegistryAccessTokenPermission"
       }
      ],
      "default": "PULL"
     },
     "expires_in_days": {
      "type": "integer",
      "default": 90,
      "description": "1 to 365, or -1 for a token that does not expire."
     },
     "description": {
      "description": "Optional description (up to 255 characters).",
      "type": "string",
      "maxLength": 255,
      "default": ""
     },
     "registry_ids": {
      "type": "array",
      "maxItems": 100,
      "uniqueItems": true,
      "items": {
       "type": "string",
       "format": "uuid"
      },
      "description": "Other registries in the same workspace the token may also use. The registry in the path is always included."
     }
    }
   },
   "ContainerRegistryAccessTokenSecret": {
    "description": "A newly created or rotated access token, including the Docker login secret. The secret is not retrievable later.",
    "type": "object",
    "required": [
     "token_id",
     "token_name",
     "username",
     "secret",
     "permission",
     "registry_ids",
     "expires_at",
     "created_at"
    ],
    "properties": {
     "token_id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique ID of the token."
     },
     "token_name": {
      "type": "string",
      "description": "Name of the token."
     },
     "username": {
      "type": "string",
      "description": "Docker login username. It contains `$`, so quote it in shells."
     },
     "secret": {
      "type": "string",
      "description": "Docker login password. Returned only by create and rotate."
     },
     "permission": {
      "$ref": "#/components/schemas/ContainerRegistryAccessTokenPermission"
     },
     "registry_ids": {
      "description": "Registries the token may use.",
      "type": "array",
      "items": {
       "type": "string",
       "format": "uuid"
      }
     },
     "expires_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the token expires (ISO 8601); null for a token that does not expire."
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the token was created (ISO 8601)."
     }
    }
   },
   "ContainerRegistryAccessToken": {
    "description": "A registry access token without its secret.",
    "type": "object",
    "required": [
     "token_id",
     "token_name",
     "harbor_username",
     "permission",
     "registry_ids",
     "disabled",
     "expires_at",
     "created_by_user_id",
     "created_at",
     "revoked_at"
    ],
    "properties": {
     "token_id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique ID of the token."
     },
     "token_name": {
      "type": "string",
      "description": "Name of the token."
     },
     "harbor_username": {
      "type": "string",
      "description": "Docker login username (the `username` returned at creation)."
     },
     "permission": {
      "$ref": "#/components/schemas/ContainerRegistryAccessTokenPermission"
     },
     "registry_ids": {
      "description": "Registries the token may use.",
      "type": "array",
      "items": {
       "type": "string",
       "format": "uuid"
      }
     },
     "disabled": {
      "type": "boolean",
      "description": "True when the token has been revoked or disabled and no longer authenticates."
     },
     "expires_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the token expires (ISO 8601); null for a token that does not expire."
     },
     "created_by_user_id": {
      "type": "string",
      "nullable": true,
      "description": "User who created the token, when it was created by a user."
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the token was created (ISO 8601)."
     },
     "revoked_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the token was revoked (ISO 8601); null while valid."
     }
    }
   },
   "ContainerRegistryMessage": {
    "description": "A plain confirmation message.",
    "type": "object",
    "required": [
     "detail"
    ],
    "properties": {
     "detail": {
      "type": "string",
      "description": "Human-readable result."
     }
    }
   },
   "ContainerRegistryRepository": {
    "description": "A repository (image name) inside a registry.",
    "type": "object",
    "required": [
     "id",
     "name"
    ],
    "properties": {
     "id": {
      "type": "integer",
      "description": "Repository ID in the registry backend."
     },
     "name": {
      "type": "string",
      "description": "Repository name, for example `web/api`."
     },
     "description": {
      "type": "string",
      "description": "Description of the repository; empty when none."
     },
     "artifact_count": {
      "type": "integer",
      "description": "Number of artifacts (image manifests and indexes) in the repository."
     },
     "pull_count": {
      "type": "integer",
      "description": "Number of pulls recorded for the repository."
     },
     "creation_time": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the repository was created (ISO 8601)."
     },
     "update_time": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the repository last changed (ISO 8601)."
     }
    }
   },
   "ContainerRegistryRepositoryList": {
    "description": "A page of repositories.",
    "type": "object",
    "required": [
     "items",
     "total",
     "page",
     "page_size"
    ],
    "properties": {
     "items": {
      "description": "Repositories on this page.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ContainerRegistryRepository"
      }
     },
     "total": {
      "type": "integer",
      "description": "Total number of items matching the request."
     },
     "page": {
      "type": "integer",
      "description": "Page number returned (1-based)."
     },
     "page_size": {
      "type": "integer",
      "description": "Page size that was applied."
     }
    }
   },
   "ContainerRegistryTag": {
    "description": "A tag on an artifact.",
    "type": "object",
    "required": [
     "name"
    ],
    "properties": {
     "id": {
      "type": "integer",
      "nullable": true,
      "description": "Tag ID in the registry backend."
     },
     "name": {
      "type": "string",
      "description": "Tag name, for example `latest`."
     },
     "push_time": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the tag was last pushed (ISO 8601)."
     },
     "pull_time": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the tag was last pulled (ISO 8601)."
     },
     "immutable": {
      "type": "boolean",
      "nullable": true,
      "description": "True when the tag is protected from being overwritten."
     }
    }
   },
   "ContainerRegistryArtifact": {
    "description": "An artifact (image manifest or manifest index) in a repository.",
    "type": "object",
    "required": [
     "id",
     "digest"
    ],
    "properties": {
     "id": {
      "type": "integer",
      "description": "Artifact ID in the registry backend."
     },
     "type": {
      "type": "string",
      "nullable": true,
      "description": "Artifact type reported by the registry, for example `IMAGE`."
     },
     "media_type": {
      "type": "string",
      "nullable": true,
      "description": "OCI or Docker media type of the manifest."
     },
     "digest": {
      "type": "string",
      "description": "Content digest, for example `sha256:...`."
     },
     "size": {
      "type": "integer",
      "description": "Size of the artifact in bytes."
     },
     "push_time": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the artifact was pushed (ISO 8601)."
     },
     "pull_time": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the artifact was last pulled (ISO 8601)."
     },
     "tags": {
      "description": "Tags pointing at the artifact; null when untagged.",
      "type": "array",
      "nullable": true,
      "items": {
       "$ref": "#/components/schemas/ContainerRegistryTag"
      }
     },
     "scan_overview": {
      "type": "object",
      "nullable": true,
      "additionalProperties": true,
      "description": "Scanner summary keyed by report media type, as the scanner returns it."
     }
    }
   },
   "ContainerRegistryArtifactList": {
    "description": "A page of artifacts.",
    "type": "object",
    "required": [
     "items",
     "total",
     "page",
     "page_size"
    ],
    "properties": {
     "items": {
      "description": "Artifacts on this page.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ContainerRegistryArtifact"
      }
     },
     "total": {
      "type": "integer",
      "description": "Total number of items matching the request."
     },
     "page": {
      "type": "integer",
      "description": "Page number returned (1-based)."
     },
     "page_size": {
      "type": "integer",
      "description": "Page size that was applied."
     }
    }
   },
   "UpdateContainerRegistrySecuritySettingsRequest": {
    "description": "Body for changing the registry's vulnerability pull policy.",
    "type": "object",
    "required": [
     "vulnerability_pull_policy"
    ],
    "properties": {
     "vulnerability_pull_policy": {
      "$ref": "#/components/schemas/ContainerRegistryPullPolicy"
     }
    }
   },
   "ContainerRegistrySecuritySettingsStatus": {
    "description": "Security settings of a registry and whether they have been applied.",
    "type": "object",
    "required": [
     "vulnerability_pull_policy",
     "scan_on_push",
     "sbom_generation_on_push",
     "observed_state",
     "generation",
     "observed_generation"
    ],
    "properties": {
     "vulnerability_pull_policy": {
      "$ref": "#/components/schemas/ContainerRegistryPullPolicy"
     },
     "scan_on_push": {
      "type": "boolean",
      "description": "Whether pushed images are scanned for vulnerabilities automatically."
     },
     "sbom_generation_on_push": {
      "type": "boolean",
      "description": "Whether an SBOM is generated for pushed images automatically."
     },
     "observed_state": {
      "$ref": "#/components/schemas/ContainerRegistryObservedState"
     },
     "generation": {
      "type": "integer",
      "description": "Incremented by every accepted settings change."
     },
     "observed_generation": {
      "type": "integer",
      "description": "The last generation applied; equal to `generation` when settled."
     }
    }
   },
   "ContainerRegistryVulnerabilitySummary": {
    "description": "Vulnerability counts across the registry, by severity.",
    "type": "object",
    "required": [
     "total",
     "critical",
     "high",
     "medium",
     "low",
     "unknown",
     "none",
     "refreshed_at"
    ],
    "properties": {
     "total": {
      "type": "integer",
      "description": "Findings in total."
     },
     "critical": {
      "type": "integer",
      "description": "Findings of severity `Critical`."
     },
     "high": {
      "type": "integer",
      "description": "Findings of severity `High`."
     },
     "medium": {
      "type": "integer",
      "description": "Findings of severity `Medium`."
     },
     "low": {
      "type": "integer",
      "description": "Findings of severity `Low`."
     },
     "unknown": {
      "type": "integer",
      "description": "Findings whose severity is unknown."
     },
     "none": {
      "type": "integer",
      "description": "Findings rated `None`."
     },
     "refreshed_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the counts were last computed (ISO 8601)."
     }
    }
   },
   "ContainerRegistryVulnerability": {
    "description": "One vulnerability finding on an artifact.",
    "type": "object",
    "required": [
     "repository_name",
     "digest",
     "tags",
     "cve_id",
     "severity",
     "status",
     "cvss_v3_score",
     "package",
     "version",
     "fixed_version",
     "description",
     "links",
     "scan_status",
     "scanned_at"
    ],
    "properties": {
     "repository_name": {
      "type": "string",
      "description": "Repository the affected artifact is in."
     },
     "digest": {
      "type": "string",
      "description": "Digest of the affected artifact."
     },
     "tags": {
      "description": "Tags pointing at the affected artifact.",
      "type": "array",
      "items": {
       "type": "string"
      }
     },
     "cve_id": {
      "type": "string",
      "description": "CVE or advisory identifier."
     },
     "severity": {
      "type": "string",
      "description": "Severity as reported by the scanner: `Critical`, `High`, `Medium`, `Low`, `Unknown` or `None`."
     },
     "status": {
      "type": "string",
      "description": "The finding's disposition from the scanner, for example `fixed`."
     },
     "cvss_v3_score": {
      "type": "number",
      "nullable": true,
      "description": "CVSS v3 base score (0-10), when the scanner provides one."
     },
     "package": {
      "type": "string",
      "description": "Affected package name."
     },
     "version": {
      "type": "string",
      "description": "Installed version of the affected package."
     },
     "fixed_version": {
      "type": "string",
      "description": "Version that fixes the finding; empty when none is known."
     },
     "description": {
      "type": "string",
      "description": "Description of the vulnerability from the scanner."
     },
     "links": {
      "description": "Reference URLs for the vulnerability.",
      "type": "array",
      "items": {
       "type": "string"
      }
     },
     "scan_status": {
      "description": "Lifecycle of the scan that produced the finding, when the registry reports it.\n- `queued`\n- `scanning`\n- `completed`\n- `failed`",
      "type": "string",
      "nullable": true,
      "enum": [
       "queued",
       "scanning",
       "completed",
       "failed",
       null
      ]
     },
     "scanned_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the artifact was scanned (ISO 8601), when the registry reports it."
     }
    }
   },
   "ContainerRegistryVulnerabilityList": {
    "description": "A page of vulnerability findings.",
    "type": "object",
    "required": [
     "items",
     "total",
     "page",
     "page_size"
    ],
    "properties": {
     "items": {
      "description": "Findings on this page.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ContainerRegistryVulnerability"
      }
     },
     "total": {
      "type": "integer",
      "description": "Total number of items matching the request."
     },
     "page": {
      "type": "integer",
      "description": "Page number returned (1-based)."
     },
     "page_size": {
      "type": "integer",
      "description": "Page size that was applied."
     }
    }
   },
   "ContainerRegistryScanner": {
    "description": "The scanner that produced a report.",
    "type": "object",
    "properties": {
     "name": {
      "type": "string",
      "description": "Scanner name."
     },
     "vendor": {
      "type": "string",
      "description": "Scanner vendor."
     },
     "version": {
      "type": "string",
      "description": "Scanner version."
     }
    }
   },
   "ContainerRegistryArtifactPlatform": {
    "description": "One platform of a multi-platform image.",
    "type": "object",
    "required": [
     "digest"
    ],
    "properties": {
     "digest": {
      "type": "string",
      "description": "Digest of the platform-specific manifest."
     },
     "architecture": {
      "type": "string",
      "nullable": true,
      "description": "CPU architecture, for example `amd64`."
     },
     "os": {
      "type": "string",
      "nullable": true,
      "description": "Operating system, for example `linux`."
     },
     "variant": {
      "type": "string",
      "nullable": true,
      "description": "Architecture variant, for example `v8`, when present."
     }
    }
   },
   "ContainerRegistrySbomSummary": {
    "description": "SBOM status of one artifact.",
    "type": "object",
    "required": [
     "repository_name",
     "artifact_digest",
     "tags",
     "status",
     "artifact_kind",
     "platforms"
    ],
    "properties": {
     "repository_name": {
      "type": "string",
      "description": "Repository the artifact is in."
     },
     "artifact_digest": {
      "type": "string",
      "description": "Digest of the artifact."
     },
     "tags": {
      "description": "Tags pointing at the artifact.",
      "type": "array",
      "items": {
       "type": "string"
      }
     },
     "status": {
      "type": "string",
      "enum": [
       "GENERATED",
       "PROCESSING",
       "FAILED",
       "NOT_GENERATED",
       "UNKNOWN"
      ],
      "description": "- `GENERATED`: an SBOM exists for the artifact.\n- `PROCESSING`: generation is running.\n- `FAILED`: generation failed.\n- `NOT_GENERATED`: no SBOM has been requested or produced.\n- `UNKNOWN`: the registry did not report a status."
     },
     "start_time": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When SBOM generation started (ISO 8601)."
     },
     "end_time": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When SBOM generation finished (ISO 8601)."
     },
     "duration": {
      "type": "integer",
      "nullable": true,
      "description": "Generation time in seconds."
     },
     "sbom_digest": {
      "type": "string",
      "nullable": true,
      "description": "Digest of the generated SBOM."
     },
     "report_id": {
      "type": "string",
      "nullable": true,
      "description": "Report ID in the registry backend."
     },
     "scanner": {
      "description": "Scanner that generated the SBOM.",
      "allOf": [
       {
        "$ref": "#/components/schemas/ContainerRegistryScanner"
       }
      ],
      "nullable": true
     },
     "format": {
      "type": "string",
      "nullable": true,
      "enum": [
       "SPDX",
       "CycloneDX",
       null
      ],
      "description": "SBOM format.\n- `SPDX`\n- `CycloneDX`"
     },
     "package_count": {
      "type": "integer",
      "minimum": 0,
      "nullable": true,
      "description": "Number of packages listed in the SBOM."
     },
     "artifact_kind": {
      "type": "string",
      "enum": [
       "image",
       "index"
      ],
      "description": "- `image`: a single-platform image.\n- `index`: a multi-platform manifest index; see `platforms`."
     },
     "platform": {
      "description": "Platform of a single-platform image.",
      "allOf": [
       {
        "$ref": "#/components/schemas/ContainerRegistryArtifactPlatform"
       }
      ],
      "nullable": true
     },
     "platforms": {
      "description": "Platforms of a multi-platform index.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ContainerRegistryArtifactPlatform"
      }
     }
    }
   },
   "ContainerRegistrySbomList": {
    "description": "A page of artifacts with their SBOM status.",
    "type": "object",
    "required": [
     "items",
     "page_summary",
     "total",
     "page",
     "page_size"
    ],
    "properties": {
     "items": {
      "description": "Artifacts on this page.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ContainerRegistrySbomSummary"
      }
     },
     "page_summary": {
      "type": "object",
      "description": "SBOM status counts for the items on this page.",
      "properties": {
       "generated": {
        "type": "integer",
        "description": "Items with status `GENERATED`."
       },
       "processing": {
        "type": "integer",
        "description": "Items with status `PROCESSING`."
       },
       "failed": {
        "type": "integer",
        "description": "Items with status `FAILED`."
       },
       "not_generated": {
        "type": "integer",
        "description": "Items with status `NOT_GENERATED`."
       },
       "unknown": {
        "type": "integer",
        "description": "Items with status `UNKNOWN`."
       }
      }
     },
     "total": {
      "type": "integer",
      "description": "Total number of items matching the request."
     },
     "page": {
      "type": "integer",
      "description": "Page number returned (1-based)."
     },
     "page_size": {
      "type": "integer",
      "description": "Page size that was applied."
     }
    }
   },
   "ContainerRegistrySbomComponent": {
    "description": "One component listed in an SBOM.",
    "type": "object",
    "required": [
     "component_id",
     "name",
     "version",
     "component_type",
     "licenses",
     "supplier"
    ],
    "properties": {
     "component_id": {
      "type": "string",
      "description": "Component identifier inside the SBOM document."
     },
     "name": {
      "type": "string",
      "description": "Component name."
     },
     "version": {
      "type": "string",
      "description": "Component version; empty when unknown."
     },
     "component_type": {
      "type": "string",
      "description": "Component type as recorded in the SBOM, for example `library`."
     },
     "licenses": {
      "description": "License identifiers recorded for the component.",
      "type": "array",
      "items": {
       "type": "string"
      }
     },
     "supplier": {
      "type": "string",
      "description": "Supplier recorded for the component; empty when unknown."
     },
     "purl": {
      "type": "string",
      "nullable": true,
      "description": "Package URL (purl) of the component, when recorded."
     }
    }
   },
   "ContainerRegistrySbom": {
    "description": "An artifact's SBOM, paged by component.",
    "type": "object",
    "required": [
     "repository_name",
     "artifact_digest",
     "media_type",
     "components",
     "relationships",
     "total_components",
     "page",
     "page_size"
    ],
    "properties": {
     "repository_name": {
      "type": "string",
      "description": "Repository the artifact is in."
     },
     "artifact_digest": {
      "type": "string",
      "description": "Digest of the artifact."
     },
     "generated_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "When the SBOM was generated (ISO 8601)."
     },
     "media_type": {
      "type": "string",
      "description": "Media type of the SBOM document, which identifies its format."
     },
     "scanner": {
      "description": "Scanner that generated the SBOM.",
      "allOf": [
       {
        "$ref": "#/components/schemas/ContainerRegistryScanner"
       }
      ],
      "nullable": true
     },
     "components": {
      "description": "Components on this page.",
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ContainerRegistrySbomComponent"
      }
     },
     "relationships": {
      "type": "array",
      "description": "Relationships that touch a component on this page.",
      "items": {
       "type": "object",
       "required": [
        "source",
        "target",
        "relationship"
       ],
       "properties": {
        "source": {
         "type": "string",
         "description": "Component ID the relationship starts from."
        },
        "target": {
         "type": "string",
         "description": "Component ID the relationship points to."
        },
        "relationship": {
         "type": "string",
         "description": "Relationship type as recorded in the SBOM, for example `DEPENDS_ON`."
        }
       }
      }
     },
     "total_components": {
      "type": "integer",
      "description": "Total number of components in the SBOM."
     },
     "page": {
      "type": "integer",
      "description": "Page number returned (1-based)."
     },
     "page_size": {
      "type": "integer",
      "description": "Page size that was applied."
     }
    }
   },
   "ContainerRegistryMetrics": {
    "description": "Storage use against the plan quota and outbound bandwidth over the requested window. Bytes are decimal (1 GB = 1,000,000,000 bytes).",
    "type": "object",
    "required": [
     "registry_id",
     "range",
     "granularity",
     "range_start",
     "range_end",
     "generated_at",
     "storage",
     "bandwidth",
     "bandwidth_points",
     "coverage"
    ],
    "properties": {
     "registry_id": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the registry."
     },
     "range": {
      "type": "string",
      "enum": [
       "24h",
       "7d",
       "30d"
      ],
      "description": "Window covered.\n- `24h`\n- `7d`\n- `30d`"
     },
     "granularity": {
      "type": "string",
      "enum": [
       "15m",
       "1h",
       "1d"
      ],
      "description": "Spacing of `bandwidth_points`.\n- `15m`\n- `1h`\n- `1d`"
     },
     "range_start": {
      "type": "string",
      "format": "date-time",
      "description": "Start of the window (ISO 8601)."
     },
     "range_end": {
      "type": "string",
      "format": "date-time",
      "description": "End of the window (ISO 8601)."
     },
     "generated_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the metrics were computed (ISO 8601)."
     },
     "storage": {
      "description": "Storage use against the plan quota.",
      "type": "object",
      "required": [
       "used_bytes",
       "quota_bytes",
       "remaining_bytes",
       "utilization_percent",
       "measured_at",
       "gb_definition_bytes",
       "used_gb",
       "quota_gb",
       "remaining_gb"
      ],
      "properties": {
       "used_bytes": {
        "type": "integer",
        "description": "Bytes stored."
       },
       "quota_bytes": {
        "type": "integer",
        "description": "Plan quota in bytes."
       },
       "remaining_bytes": {
        "type": "integer",
        "description": "Bytes left before the quota is reached."
       },
       "utilization_percent": {
        "type": "number",
        "description": "`used_bytes` as a percentage of `quota_bytes`."
       },
       "measured_at": {
        "type": "string",
        "format": "date-time",
        "description": "When storage use was measured (ISO 8601)."
       },
       "gb_definition_bytes": {
        "type": "integer",
        "description": "Always 1000000000."
       },
       "used_gb": {
        "type": "number",
        "description": "`used_bytes` in decimal GB."
       },
       "quota_gb": {
        "type": "number",
        "description": "`quota_bytes` in decimal GB."
       },
       "remaining_gb": {
        "type": "number",
        "description": "`remaining_bytes` in decimal GB."
       }
      }
     },
     "bandwidth": {
      "description": "Outbound bandwidth over the window.",
      "type": "object",
      "required": [
       "used_bytes"
      ],
      "properties": {
       "used_bytes": {
        "type": "integer",
        "description": "Outbound bytes in the range."
       }
      }
     },
     "bandwidth_points": {
      "description": "Outbound bytes per interval across the window.",
      "type": "array",
      "items": {
       "type": "object",
       "required": [
        "timestamp",
        "used_bytes"
       ],
       "properties": {
        "timestamp": {
         "type": "string",
         "format": "date-time",
         "description": "Start of the interval (ISO 8601)."
        },
        "used_bytes": {
         "type": "integer",
         "description": "Outbound bytes in the interval."
        }
       }
      }
     },
     "coverage": {
      "description": "How complete the bandwidth data is for the window.",
      "type": "object",
      "required": [
       "status",
       "data_available_from",
       "data_through"
      ],
      "properties": {
       "status": {
        "type": "string",
        "enum": [
         "provisional"
        ],
        "description": "`provisional`: bandwidth data is still being accumulated and may not cover the whole window."
       },
       "data_available_from": {
        "type": "string",
        "format": "date-time",
        "nullable": true,
        "description": "Earliest time bandwidth data exists for (ISO 8601)."
       },
       "data_through": {
        "type": "string",
        "format": "date-time",
        "nullable": true,
        "description": "Latest time bandwidth data exists for (ISO 8601)."
       }
      }
     }
    }
   }
  }
 }
}