{ "openapi": "3.1.0", "info": { "title": "Belune API", "version": "1.0.0", "description": "Generated from the running API by probing every registered route with a personal access token and statically resolving every request/response Go type — not hand-written, and not a reading of routes.go. See the API Access guide for how to authenticate and the scope model.\n\n**\"required\" is intentionally omitted from every request schema.** Field optionality in this codebase is enforced imperatively (e.g. `if req.Name == \"\" { ... }`), not type-encoded — most optional fields aren't even pointers. Inferring \"required\" from arbitrary validation code is a fundamentally fuzzier problem than the static type resolution the rest of this spec relies on, so it is left honestly unspecified rather than risked wrong.\n\n**Project-pinning has no OpenAPI representation** — a token pinned to a set of projects, rejected on any project outside that set, is noted in the affected operations' descriptions, not encoded structurally." }, "servers": [ { "url": "https://belune.example.com", "description": "Replace with your own Belune instance's origin." } ], "tags": [ { "name": "Profile" }, { "name": "Notifications" }, { "name": "Projects" }, { "name": "Project Environment Variables" }, { "name": "Backup Destinations" }, { "name": "App Templates" }, { "name": "Applications" }, { "name": "Application Environment Variables" }, { "name": "Application Domains \u0026 TLS" }, { "name": "Application Actions" }, { "name": "Application Deployments" }, { "name": "Application Preview Environments" }, { "name": "Application Metrics \u0026 Logs" }, { "name": "Application Volumes \u0026 Backups" }, { "name": "Application File Mounts" }, { "name": "Application Resources" }, { "name": "Databases" }, { "name": "Database Actions" }, { "name": "Database Logs" }, { "name": "Database Volumes \u0026 Backups" }, { "name": "Platform" }, { "name": "Requests (Admin)" }, { "name": "Git Integrations" }, { "name": "Git Providers (Admin)" }, { "name": "Certificates (Admin)" }, { "name": "Notification Channels (Admin)" }, { "name": "Users (Admin)" }, { "name": "Quotas (Admin)" }, { "name": "Audit Logs (Admin)" }, { "name": "Docker (Admin)" }, { "name": "Metrics (Admin)" }, { "name": "Backups (Admin)" }, { "name": "Maintenance (Admin)" }, { "name": "Terminal Access" }, { "name": "Personal Access Tokens" } ], "paths": { "/api/account/alert-preferences": { "get": { "operationId": "GetAlertPreferences", "summary": "Get Alert Preferences", "tags": [ "Profile" ], "x-belune-order": 2, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alertPreferencesResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "put": { "operationId": "UpdateAlertPreferences", "summary": "Update Alert Preferences", "tags": [ "Profile" ], "x-belune-order": 3, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateAlertPreferencesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alertPreferencesResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/audit-logs": { "get": { "operationId": "ListAuditLogs", "summary": "Get Logs", "description": "A project-pinned token cannot use this endpoint at all, even for a project inside its pin set. Requires the Admin role.", "tags": [ "Audit Logs (Admin)" ], "x-belune-order": 1, "x-belune-roles": [ "admin" ], "parameters": [ { "name": "action", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "resource_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "resource_type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/auditLogDTO" }, "type": "array" }, "total": { "type": "integer" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/audit-logs/actions": { "get": { "operationId": "ListAuditActions", "summary": "Get Actions", "description": "A project-pinned token cannot use this endpoint at all, even for a project inside its pin set. Requires the Admin role.", "tags": [ "Audit Logs (Admin)" ], "x-belune-order": 2, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/audit-logs/export": { "get": { "operationId": "ExportAuditLogs", "summary": "Export Logs", "description": "A project-pinned token cannot use this endpoint at all, even for a project inside its pin set. Requires the Admin role.", "tags": [ "Audit Logs (Admin)" ], "x-belune-order": 3, "x-belune-roles": [ "admin" ], "parameters": [ { "name": "action", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "resource_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "resource_type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Not resolved by static extraction — see the handler for the exact response." } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/auth/logout": { "post": { "operationId": "Logout", "summary": "Logout", "tags": [ "Profile" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/auth/me": { "get": { "operationId": "Me", "summary": "Get Profile", "tags": [ "Profile" ], "x-belune-order": 1, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "email": { "type": "string" }, "first_name": { "type": "string" }, "id": { "type": "string" }, "last_name": { "type": "string" }, "role": { "type": "string" }, "username": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/auth/password": { "put": { "operationId": "ChangeOwnPassword", "summary": "Change Own Password", "tags": [ "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/changePasswordRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/auth/profile": { "put": { "operationId": "UpdateProfile", "summary": "Update Profile", "tags": [ "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateProfileRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserProfileRow" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/auth/totp": { "get": { "operationId": "GetTOTPStatus", "summary": "Get TOTP Status", "tags": [ "Profile" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "enabled": { "type": "boolean" }, "enabled_at": { "format": "date-time", "type": [ "string", "null" ] }, "recovery_codes_remaining": { "type": "integer" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/auth/totp/disable": { "post": { "operationId": "DisableTOTP", "summary": "Disable TOTP", "tags": [ "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/disableTOTPRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "session": { "anyOf": [ { "$ref": "#/components/schemas/LoginResult" }, { "type": "null" } ] }, "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/auth/totp/enroll": { "post": { "operationId": "EnrollTOTP", "summary": "Enroll TOTP", "tags": [ "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/enrollRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Enrollment" }, { "type": "null" } ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/auth/totp/enroll/verify": { "post": { "operationId": "VerifyTOTPEnrollment", "summary": "Verify TOTP Enrollment", "tags": [ "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/verifyEnrollmentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "recovery_codes": { "items": { "type": "string" }, "type": "array" }, "session": { "anyOf": [ { "$ref": "#/components/schemas/LoginResult" }, { "type": "null" } ] } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/auth/totp/recovery-codes": { "post": { "operationId": "RegenerateRecoveryCodes", "summary": "Regenerate Recovery Codes", "tags": [ "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/regenerateCodesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "recovery_codes": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/backups": { "get": { "operationId": "ListBackupRuns", "summary": "Get Runs", "description": "Requires the Admin role.", "tags": [ "Backups (Admin)" ], "x-belune-order": 1, "x-belune-roles": [ "admin" ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/backupRunView" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/backups/remote": { "put": { "operationId": "UpdateBackupRemote", "summary": "Update Remote", "description": "Requires the Admin role.", "tags": [ "Backups (Admin)" ], "x-belune-order": 5, "x-belune-roles": [ "admin" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateBackupRemoteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "remote": { "$ref": "#/components/schemas/backupRemoteView" }, "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/backups/remote/test": { "post": { "operationId": "TestBackupRemoteParams", "summary": "Test Remote Configs", "description": "Requires the Admin role.", "tags": [ "Backups (Admin)" ], "x-belune-order": 6, "x-belune-roles": [ "admin" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateBackupRemoteRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/backups/run": { "post": { "operationId": "TriggerBackupRun", "summary": "Trigger Run", "description": "Requires the Admin role.", "tags": [ "Backups (Admin)" ], "x-belune-order": 3, "x-belune-roles": [ "admin" ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/backups/status": { "get": { "operationId": "GetBackupStatus", "summary": "Get Remote Status", "description": "Requires the Admin role.", "tags": [ "Backups (Admin)" ], "x-belune-order": 2, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/backupStatusView" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/backups/test": { "post": { "operationId": "TestBackupRemote", "summary": "Test Remote", "description": "Requires the Admin role.", "tags": [ "Backups (Admin)" ], "x-belune-order": 4, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/certificates": { "get": { "operationId": "ListCertificates", "summary": "Get Certificates", "description": "Requires the Admin role.", "tags": [ "Certificates (Admin)" ], "x-belune-order": 1, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/CertificateMetadata" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "post": { "operationId": "UploadCertificate", "summary": "Upload Certificate", "description": "Requires the Admin role.", "tags": [ "Certificates (Admin)" ], "x-belune-order": 2, "x-belune-roles": [ "admin" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/uploadCertificateRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertificateMetadata" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/certificates/usable": { "get": { "operationId": "ListUsableCertificates", "summary": "Find Certificates for a Hostname", "description": "Certificates that can serve one hostname, including a wildcard covering it. Takes a required `hostname` query parameter and returns 400 without it. Available to any authenticated caller, unlike the full certificate list: the response names only the certificate and its expiry, never the other hostnames it covers.", "tags": [ "Application Domains \u0026 TLS" ], "x-belune-order": 6, "parameters": [ { "name": "hostname", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/UsableCertificate" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/certificates/{certificateId}": { "delete": { "operationId": "DeleteCertificate", "summary": "Delete Certificate", "description": "Requires the Admin role.", "tags": [ "Certificates (Admin)" ], "x-belune-order": 3, "x-belune-roles": [ "admin" ], "parameters": [ { "name": "certificateId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Not resolved by static extraction — see the handler for the exact response." } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/deployments": { "get": { "operationId": "GetGlobalDeployments", "summary": "Get All Deployments", "description": "Deployments across every application. An admin sees all of them; a member sees only their own projects and any shared with them. Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Platform" ], "x-belune-order": 2, "parameters": [ { "name": "application_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ListGlobalDeploymentsFilteredRow" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/docker/containers": { "get": { "operationId": "ListDockerContainers", "summary": "Get Containers", "description": "Requires the Admin role.", "tags": [ "Docker (Admin)" ], "x-belune-order": 2, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dockerContainerResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/docker/images": { "get": { "operationId": "ListDockerImages", "summary": "Get Images", "description": "Requires the Admin role.", "tags": [ "Docker (Admin)" ], "x-belune-order": 3, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dockerImageResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/docker/networks": { "get": { "operationId": "ListDockerNetworks", "summary": "Get Networks", "description": "Requires the Admin role.", "tags": [ "Docker (Admin)" ], "x-belune-order": 5, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dockerNetworkResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/docker/overview": { "get": { "operationId": "GetDockerOverview", "summary": "Get Overview", "description": "Requires the Admin role.", "tags": [ "Docker (Admin)" ], "x-belune-order": 1, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dockerOverviewResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/docker/volumes": { "get": { "operationId": "ListDockerVolumes", "summary": "Get Volumes", "description": "Requires the Admin role.", "tags": [ "Docker (Admin)" ], "x-belune-order": 4, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dockerVolumeResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/domains/tls": { "get": { "operationId": "ListDomainTLSStatus", "summary": "Get Domain TLS Status", "description": "Every domain's observed TLS state, with the name of the certificate it serves. An admin sees every domain on the install; a member sees only domains in their own projects and any shared with them. Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Platform" ], "x-belune-order": 3, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/domainTLSStatus" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/git/integrations": { "get": { "operationId": "ListGitIntegrations", "summary": "Get Integrations", "tags": [ "Git Integrations" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/gitIntegrationResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/git/integrations/available": { "get": { "operationId": "ListAvailableProviders", "summary": "Get Available Providers", "tags": [ "Git Integrations" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/availableProviderResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/git/integrations/connect": { "get": { "operationId": "StartGitIntegrationConnect", "summary": "Start Git Integration Connect", "tags": [ "Git Integrations" ], "parameters": [ { "name": "base_url", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "provider", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "auth_url": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/git/integrations/{integrationId}": { "delete": { "operationId": "DeleteGitIntegration", "summary": "Delete Integration", "tags": [ "Git Integrations" ], "parameters": [ { "name": "integrationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/git/integrations/{integrationId}/branches": { "get": { "operationId": "ListIntegrationBranches", "summary": "Get Repo Branches", "tags": [ "Git Integrations" ], "parameters": [ { "name": "integrationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "repo", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Branch" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/git/integrations/{integrationId}/repos": { "get": { "operationId": "ListIntegrationRepos", "summary": "Get Repos", "tags": [ "Git Integrations" ], "parameters": [ { "name": "integrationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Repo" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/git/providers": { "get": { "operationId": "ListGitProviderConfigs", "summary": "Get Providers", "description": "Requires the Admin role.", "tags": [ "Git Providers (Admin)" ], "x-belune-order": 1, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/providerConfigResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "put": { "operationId": "SaveGitProviderConfig", "summary": "Update Provider", "description": "Requires the Admin role.", "tags": [ "Git Providers (Admin)" ], "x-belune-order": 2, "x-belune-roles": [ "admin" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/saveGitProviderConfigRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/providerConfigResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/git/providers/github/manifest": { "get": { "operationId": "GetGitHubAppManifest", "summary": "Get GitHub Manifest", "description": "Requires the Admin role.", "tags": [ "Git Providers (Admin)" ], "x-belune-order": 4, "x-belune-roles": [ "admin" ], "parameters": [ { "name": "org", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "public", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "manifest": { "additionalProperties": {}, "type": "object" }, "post_url": { "type": "string" }, "state": { "type": "string" }, "webhook_configured": { "type": "boolean" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/git/providers/{configId}": { "delete": { "operationId": "DeleteGitProviderConfig", "summary": "Delete Provider", "description": "Requires the Admin role.", "tags": [ "Git Providers (Admin)" ], "x-belune-order": 3, "x-belune-roles": [ "admin" ], "parameters": [ { "name": "configId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/maintenance/cleanup": { "post": { "operationId": "TriggerCleanup", "summary": "Trigger Cleanup", "description": "Requires the Admin role.", "tags": [ "Maintenance (Admin)" ], "x-belune-order": 5, "x-belune-roles": [ "admin" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cleanupRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/maintenance/host-shell": { "post": { "operationId": "CreateHostShellSession", "summary": "Create Host Shell Session", "description": "Requires the Admin role.", "tags": [ "Maintenance (Admin)" ], "x-belune-roles": [ "admin" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "method": { "type": "string" }, "password": { "type": "string" } }, "type": "object" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "properties": { "session_id": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/maintenance/logs": { "get": { "operationId": "GetPlatformLogs", "summary": "Get Logs", "description": "Requires the Admin role.", "tags": [ "Maintenance (Admin)" ], "x-belune-order": 4, "x-belune-roles": [ "admin" ], "parameters": [ { "name": "service", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/platformLogsResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/maintenance/proxy": { "get": { "operationId": "GetProxyReconcilerStatus", "summary": "Get Proxy Status", "description": "Requires the Admin role.", "tags": [ "Maintenance (Admin)" ], "x-belune-order": 6, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReconcilerStatus" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/maintenance/proxy/reconcile": { "post": { "operationId": "ReconcileProxy", "summary": "Reconcile Proxy", "description": "Requires the Admin role.", "tags": [ "Maintenance (Admin)" ], "x-belune-order": 7, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReconcilerStatus" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/maintenance/queue": { "get": { "operationId": "GetQueueStatus", "summary": "Get Queue Status", "description": "Requires the Admin role.", "tags": [ "Maintenance (Admin)" ], "x-belune-order": 8, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/queueStatusResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/maintenance/queue/clear": { "post": { "operationId": "ClearQueue", "summary": "Clear Queue", "description": "Requires the Admin role.", "tags": [ "Maintenance (Admin)" ], "x-belune-order": 10, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "cleared": { "type": "integer" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/maintenance/queue/clear-pending": { "post": { "operationId": "ClearPendingQueue", "summary": "Clear Pending Queue", "description": "Requires the Admin role.", "tags": [ "Maintenance (Admin)" ], "x-belune-order": 9, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "cleared": { "type": "integer" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/maintenance/restart": { "post": { "operationId": "RestartService", "summary": "Restart Service", "description": "Requires the Admin role.", "tags": [ "Maintenance (Admin)" ], "x-belune-roles": [ "admin" ], "parameters": [ { "name": "service", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "service": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/maintenance/server-ip": { "get": { "operationId": "GetServerIP", "summary": "Get Server IP", "description": "Requires the Admin role.", "tags": [ "Maintenance (Admin)" ], "x-belune-order": 1, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverIPResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/maintenance/update": { "post": { "operationId": "TriggerSelfUpdate", "summary": "Trigger Self Update", "description": "Requires the Admin role.", "tags": [ "Maintenance (Admin)" ], "x-belune-roles": [ "admin" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "method": { "type": "string" }, "password": { "type": "string" } }, "type": "object" } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "target": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/maintenance/update/check": { "post": { "operationId": "TriggerUpdateCheck", "summary": "Check For Updates", "description": "Requires the Admin role.", "tags": [ "Maintenance (Admin)" ], "x-belune-roles": [ "admin" ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/maintenance/update/status": { "get": { "operationId": "GetSelfUpdateStatus", "summary": "Get Update Status", "description": "Requires the Admin role.", "tags": [ "Maintenance (Admin)" ], "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/metrics/host": { "get": { "operationId": "GetHostHistoricalMetrics", "summary": "Get Metrics", "description": "Requires the Admin role.", "tags": [ "Metrics (Admin)" ], "x-belune-order": 2, "x-belune-roles": [ "admin" ], "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "range", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/hostMetricPoint" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "metrics": [] }, { "session": [] } ] } }, "/api/metrics/host/stream": { "get": { "operationId": "StreamHostMetrics", "summary": "Stream Host Metrics", "description": "Requires the Admin role.", "tags": [ "Metrics (Admin)" ], "x-belune-order": 3, "x-belune-roles": [ "admin" ], "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Not resolved by static extraction — see the handler for the exact response." } }, "security": [ { "metrics": [] }, { "session": [] } ] } }, "/api/notification-channels": { "get": { "operationId": "ListNotificationChannels", "summary": "Get Channels", "description": "Requires the Admin role.", "tags": [ "Notification Channels (Admin)" ], "x-belune-order": 1, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/notificationChannelResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "post": { "operationId": "CreateNotificationChannel", "summary": "Create Channel", "description": "Requires the Admin role.", "tags": [ "Notification Channels (Admin)" ], "x-belune-order": 2, "x-belune-roles": [ "admin" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notificationChannelRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notificationChannelResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/notification-channels/test": { "post": { "operationId": "TestNotificationChannelParams", "summary": "Test Configs", "description": "Requires the Admin role.", "tags": [ "Notification Channels (Admin)" ], "x-belune-order": 8, "x-belune-roles": [ "admin" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/testChannelParamsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/notification-channels/{channelId}": { "delete": { "operationId": "DeleteNotificationChannel", "summary": "Delete Channel", "description": "Requires the Admin role.", "tags": [ "Notification Channels (Admin)" ], "x-belune-order": 5, "x-belune-roles": [ "admin" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] }, "patch": { "operationId": "SetNotificationChannelEnabled", "summary": "Toggle Channel", "description": "Requires the Admin role.", "tags": [ "Notification Channels (Admin)" ], "x-belune-order": 4, "x-belune-roles": [ "admin" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setChannelEnabledRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notificationChannelResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] }, "put": { "operationId": "UpdateNotificationChannel", "summary": "Update Channel", "description": "Requires the Admin role.", "tags": [ "Notification Channels (Admin)" ], "x-belune-order": 3, "x-belune-roles": [ "admin" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notificationChannelRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notificationChannelResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/notification-channels/{channelId}/test": { "post": { "operationId": "TestNotificationChannel", "summary": "Test Channel", "description": "Requires the Admin role.", "tags": [ "Notification Channels (Admin)" ], "x-belune-order": 6, "x-belune-roles": [ "admin" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/notification-events": { "get": { "operationId": "ListNotificationEvents", "summary": "Get Events", "description": "Requires the Admin role.", "tags": [ "Notification Channels (Admin)" ], "x-belune-order": 9, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/EventDef" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/notifications": { "get": { "operationId": "ListNotifications", "summary": "Get Notifications", "tags": [ "Notifications" ], "x-belune-order": 1, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Notification" }, "type": "array" }, "unread": { "type": "integer" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/notifications/read-all": { "post": { "operationId": "MarkAllNotificationsRead", "summary": "Mark Notifications Read", "tags": [ "Notifications" ], "x-belune-order": 4, "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Not resolved by static extraction — see the handler for the exact response." } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/notifications/stream": { "get": { "operationId": "StreamNotifications", "summary": "Stream Notifications", "tags": [ "Notifications" ], "x-belune-order": 5, "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Not resolved by static extraction — see the handler for the exact response." } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/notifications/unread-count": { "get": { "operationId": "UnreadNotificationCount", "summary": "Get Unread Count", "tags": [ "Notifications" ], "x-belune-order": 2, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "unread": { "type": "integer" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/notifications/{notificationId}/read": { "post": { "operationId": "MarkNotificationRead", "summary": "Mark Notification Read", "tags": [ "Notifications" ], "x-belune-order": 3, "parameters": [ { "name": "notificationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects": { "get": { "operationId": "ListProjects", "summary": "Get Projects", "description": "An admin sees every project on the install; a member sees only their own projects and any shared with them. Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Projects" ], "x-belune-order": 1, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ListProjectsByUserRow" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "post": { "operationId": "CreateProject", "summary": "Create Project", "description": "A project-pinned token cannot use this endpoint at all, even for a project inside its pin set.", "tags": [ "Projects" ], "x-belune-order": 3, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createProjectRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}": { "delete": { "operationId": "DeleteProject", "summary": "Delete Project", "tags": [ "Projects" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] }, "get": { "operationId": "GetProject", "summary": "Get Project", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Projects" ], "x-belune-order": 2, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "put": { "operationId": "UpdateProject", "summary": "Update Project", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Projects" ], "x-belune-order": 4, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateProjectRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications": { "get": { "operationId": "ListApplications", "summary": "Get Applications", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Applications" ], "x-belune-order": 1, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/applicationResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "post": { "operationId": "CreateApplication", "summary": "Create Application", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Applications" ], "x-belune-order": 3, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createApplicationRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/applicationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}": { "delete": { "operationId": "DeleteApplication", "summary": "Delete Application", "tags": [ "Applications" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] }, "get": { "operationId": "GetApplication", "summary": "Get Application", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Applications" ], "x-belune-order": 2, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/applicationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "put": { "operationId": "UpdateApplication", "summary": "Update Application", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Applications" ], "x-belune-order": 4, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateApplicationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/applicationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/build": { "post": { "operationId": "BuildApplication", "summary": "Build App", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Actions" ], "x-belune-order": 1, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deployment" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "deploy": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/cache": { "delete": { "operationId": "ClearBuildCache", "summary": "Clear Build Cache", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Resources" ], "x-belune-order": 6, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] }, "get": { "operationId": "GetBuildCache", "summary": "Get Build Cache", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Resources" ], "x-belune-order": 5, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "build_cache_bytes": { "type": "integer" }, "launch_cache_bytes": { "type": "integer" }, "total_bytes": { "type": "integer" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/change-source": { "post": { "operationId": "ChangeApplicationSource", "summary": "Change Application Source", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Applications" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/changeSourceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/applicationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/deploy": { "post": { "operationId": "DeployApplication", "summary": "Deploy App", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Deployments" ], "x-belune-order": 1, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deployment" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "deploy": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/deploy-hook": { "delete": { "operationId": "DeleteDeployHook", "summary": "Delete Deploy Hook", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Deployments" ], "x-belune-order": 8, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deployHookResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] }, "get": { "operationId": "GetDeployHook", "summary": "Get Deploy Hook", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Deployments" ], "x-belune-order": 6, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deployHookResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "post": { "operationId": "GenerateDeployHook", "summary": "Generate Deploy Hook", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Deployments" ], "x-belune-order": 7, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deployHookResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/deploy-hook/reveal": { "get": { "operationId": "RevealDeployHook", "summary": "Reveal Deploy Hook", "tags": [ "Application Deployments" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deployHookResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/deployments": { "get": { "operationId": "ListDeployments", "summary": "Get Deployments", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Deployments" ], "x-belune-order": 2, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Deployment" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/deployments/{deploymentId}": { "get": { "operationId": "GetDeployment", "summary": "Get Deployment", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Deployments" ], "x-belune-order": 3, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "deploymentId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deployment" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/deployments/{deploymentId}/build-logs": { "get": { "operationId": "StreamBuildLogs", "summary": "Stream Build Logs", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Deployments" ], "x-belune-order": 5, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "deploymentId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Not resolved by static extraction — see the handler for the exact response." } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/domains": { "get": { "operationId": "ListDomains", "summary": "Get Domains", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Domains \u0026 TLS" ], "x-belune-order": 1, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ListDomainsByApplicationWithFeaturesRow" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "post": { "operationId": "AddDomain", "summary": "Create Domain", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Domains \u0026 TLS" ], "x-belune-order": 3, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addDomainRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domain" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/domains/{domainId}": { "delete": { "operationId": "RemoveDomain", "summary": "Remove Domain", "tags": [ "Application Domains \u0026 TLS" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] }, "get": { "operationId": "GetDomain", "summary": "Get Domain", "description": "One domain, in the shape the list returns. Useful for polling `tls_status`, which moves from `pending` to `active` on its own once a certificate issues. Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Domains \u0026 TLS" ], "x-belune-order": 2, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDomainWithFeaturesRow" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "put": { "operationId": "UpdateDomain", "summary": "Update Domain", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Domains \u0026 TLS" ], "x-belune-order": 4, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateDomainRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domain" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/domains/{domainId}/features": { "get": { "operationId": "ListRouteFeatures", "summary": "Get Route Features", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Domains \u0026 TLS" ], "x-belune-order": 6, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DomainRouteFeature" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "put": { "operationId": "UpsertRouteFeature", "summary": "Upsert Route Feature", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Domains \u0026 TLS" ], "x-belune-order": 7, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upsertRouteFeatureRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainRouteFeature" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/domains/{domainId}/features/{featureId}": { "delete": { "operationId": "DeleteRouteFeature", "summary": "Delete Route Feature", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Domains \u0026 TLS" ], "x-belune-order": 8, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "featureId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/domains/{domainId}/tls/recheck": { "post": { "operationId": "RecheckDomainTLS", "summary": "Recheck Domain TLS", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Domains \u0026 TLS" ], "x-belune-order": 5, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Not resolved by static extraction — see the handler for the exact response." } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/env": { "get": { "operationId": "ListEnvVars", "summary": "Get Variables", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Environment Variables" ], "x-belune-order": 1, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/envVarResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "put": { "operationId": "UpdateEnvVars", "summary": "Update Variables", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Environment Variables" ], "x-belune-order": 2, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateEnvVarsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/env/{envVarId}/reveal": { "get": { "operationId": "RevealEnvVar", "summary": "Reveal Env Var", "tags": [ "Application Environment Variables" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "envVarId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "value": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/file-mounts": { "get": { "operationId": "ListFileMounts", "summary": "Get Mounts", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application File Mounts" ], "x-belune-order": 1, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/fileMountResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "post": { "operationId": "CreateFileMount", "summary": "Create Mount", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application File Mounts" ], "x-belune-order": 2, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createFileMountRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileMountResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/file-mounts/{fileMountId}": { "delete": { "operationId": "DeleteFileMount", "summary": "Delete Mount", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application File Mounts" ], "x-belune-order": 4, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "fileMountId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] }, "put": { "operationId": "UpdateFileMount", "summary": "Update Mount", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application File Mounts" ], "x-belune-order": 3, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "fileMountId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateFileMountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fileMountResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/file-mounts/{fileMountId}/reveal": { "get": { "operationId": "RevealFileMount", "summary": "Reveal File Mount", "tags": [ "Application File Mounts" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "fileMountId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "content": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/health": { "get": { "operationId": "GetApplicationHealth", "summary": "Get Health", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Resources" ], "x-belune-order": 2, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/health-check": { "put": { "operationId": "SetHealthCheck", "summary": "Set Health Check", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Resources" ], "x-belune-order": 3, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/healthCheckRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/applicationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/logs": { "get": { "operationId": "StreamLogs", "summary": "Stream Logs", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Metrics \u0026 Logs" ], "x-belune-order": 4, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "follow", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Not resolved by static extraction — see the handler for the exact response." } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/logs/history": { "get": { "operationId": "ListApplicationLogs", "summary": "Get Logs", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Metrics \u0026 Logs" ], "x-belune-order": 3, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "level", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "session", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "stream", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ContainerLog" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/logs/sessions": { "get": { "operationId": "ListApplicationLogSessions", "summary": "Get Sessions", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Metrics \u0026 Logs" ], "x-belune-order": 2, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ListContainerLogSessionsRow" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/metrics/stream": { "get": { "operationId": "StreamApplicationMetrics", "summary": "Stream Metrics", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Metrics \u0026 Logs" ], "x-belune-order": 1, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Not resolved by static extraction — see the handler for the exact response." } }, "security": [ { "metrics": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/previews": { "get": { "operationId": "ListPreviews", "summary": "Get Previews", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Preview Environments" ], "x-belune-order": 2, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "previews": { "items": { "$ref": "#/components/schemas/previewView" }, "type": "array" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/previews/config": { "put": { "operationId": "UpdatePreviewConfig", "summary": "Update Config", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Preview Environments" ], "x-belune-order": 1, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/previewConfigRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/previewConfigResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/previews/{previewId}": { "delete": { "operationId": "DeletePreview", "summary": "Delete Preview", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Preview Environments" ], "x-belune-order": 4, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "previewId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] }, "get": { "operationId": "GetPreview", "summary": "Get Preview", "description": "One preview environment. Useful for polling `status` while a preview builds. Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Preview Environments" ], "x-belune-order": 3, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "previewId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/previewView" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/rebuild": { "post": { "operationId": "RebuildApplication", "summary": "Rebuild App", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Actions" ], "x-belune-order": 2, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deployment" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "deploy": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/reload": { "post": { "operationId": "ReloadApplication", "summary": "Reload App", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Actions" ], "x-belune-order": 6, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deployment" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "deploy": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/requests": { "get": { "operationId": "ListRequestLogs", "summary": "Get Request Logs", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Metrics \u0026 Logs" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RequestLog" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/requests/stream": { "get": { "operationId": "StreamRequestLogs", "summary": "Stream Request Logs", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Metrics \u0026 Logs" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Not resolved by static extraction — see the handler for the exact response." } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/resources": { "put": { "operationId": "SetResources", "summary": "Set Resources", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Resources" ], "x-belune-order": 1, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setResourcesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/applicationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/restart": { "post": { "operationId": "RestartApplication", "summary": "Restart App", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Actions" ], "x-belune-order": 5, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/applicationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "deploy": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/rollback": { "post": { "operationId": "RollbackDeployment", "summary": "Rollback Deployment", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Deployments" ], "x-belune-order": 4, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rollbackRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deployment" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "deploy": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/runtime": { "put": { "operationId": "UpdateApplicationRuntime", "summary": "Update Runtime", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Resources" ], "x-belune-order": 4, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateRuntimeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "container_caps": { "type": "string" }, "readonly_rootfs": { "type": "boolean" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/start": { "post": { "operationId": "StartApplication", "summary": "Start App", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Actions" ], "x-belune-order": 3, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/applicationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "deploy": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/stop": { "post": { "operationId": "StopApplication", "summary": "Stop App", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Actions" ], "x-belune-order": 4, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/applicationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "deploy": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/terminal": { "post": { "operationId": "CreateTerminalSession", "summary": "Create Terminal Session", "tags": [ "Terminal Access" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "shell": { "type": "string" } }, "type": "object" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "properties": { "session_id": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/volume-backup-configs": { "get": { "operationId": "ListBackupConfigsForApplication", "summary": "Get Configs for an App", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Volumes \u0026 Backups" ], "x-belune-order": 3, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/appVolumeBackupConfigResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/volumes": { "get": { "operationId": "ListApplicationVolumes", "summary": "Get Volumes", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Volumes \u0026 Backups" ], "x-belune-order": 1, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/applicationVolumeResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "post": { "operationId": "CreateApplicationVolume", "summary": "Create Volume", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Volumes \u0026 Backups" ], "x-belune-order": 2, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createVolumeRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/applicationVolumeResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/volumes/{volumeId}": { "delete": { "operationId": "DeleteApplicationVolume", "summary": "Delete Application Volume", "tags": [ "Application Volumes \u0026 Backups" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "volumeId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "delete_data", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/volumes/{volumeId}/backup-configs": { "get": { "operationId": "ListBackupConfigsForVolume", "summary": "Get Configs for a Volume", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Volumes \u0026 Backups" ], "x-belune-order": 4, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "volumeId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/volumeBackupConfigResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "post": { "operationId": "CreateVolumeBackupConfig", "summary": "Create Config", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Volumes \u0026 Backups" ], "x-belune-order": 4, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "volumeId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/volumeBackupConfigRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/volumeBackupConfigResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/volumes/{volumeId}/backup-configs/{configId}": { "delete": { "operationId": "DeleteVolumeBackupConfig", "summary": "Delete Config", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Volumes \u0026 Backups" ], "x-belune-order": 6, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "volumeId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "configId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] }, "put": { "operationId": "UpdateVolumeBackupConfig", "summary": "Update Config", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Volumes \u0026 Backups" ], "x-belune-order": 5, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "volumeId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "configId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/volumeBackupConfigRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/volumeBackupConfigResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/volumes/{volumeId}/backup-configs/{configId}/run": { "post": { "operationId": "RunVolumeBackupConfig", "summary": "Run Config Backup", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Volumes \u0026 Backups" ], "x-belune-order": 8, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "volumeId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "configId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/volumes/{volumeId}/backups": { "get": { "operationId": "ListVolumeBackups", "summary": "Get Backups", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Volumes \u0026 Backups" ], "x-belune-order": 9, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "volumeId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/volumeBackupResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/volumes/{volumeId}/backups/{backupId}/restore": { "post": { "operationId": "RestoreVolumeBackup", "summary": "Restore Volume Backup", "tags": [ "Application Volumes \u0026 Backups" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "volumeId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "backupId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/volumes/{volumeId}/restores": { "get": { "operationId": "ListVolumeRestores", "summary": "Get Restores", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Volumes \u0026 Backups" ], "x-belune-order": 10, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "volumeId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/volumeRestoreResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/webhook": { "put": { "operationId": "UpdateApplicationWebhook", "summary": "Update Webhook", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Application Deployments" ], "x-belune-order": 9, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateWebhookRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/applicationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/applications/{applicationId}/webhook/reveal": { "get": { "operationId": "RevealWebhookSecret", "summary": "Reveal Webhook Secret", "tags": [ "Application Deployments" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "applicationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "webhook_secret": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/projects/{projectId}/backup-destinations": { "get": { "operationId": "ListBackupDestinations", "summary": "Get Destinations", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Backup Destinations" ], "x-belune-order": 1, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/backupDestinationResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "post": { "operationId": "CreateBackupDestination", "summary": "Create Destination", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Backup Destinations" ], "x-belune-order": 2, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/backupDestinationRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/backupDestinationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/backup-destinations/test": { "post": { "operationId": "TestBackupDestinationParams", "summary": "Test Configs", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Backup Destinations" ], "x-belune-order": 6, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/backupDestinationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/backup-destinations/{destId}": { "delete": { "operationId": "DeleteBackupDestination", "summary": "Delete Destination", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Backup Destinations" ], "x-belune-order": 4, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "destId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] }, "put": { "operationId": "UpdateBackupDestination", "summary": "Update Destination", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Backup Destinations" ], "x-belune-order": 3, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "destId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/backupDestinationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/backupDestinationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/backup-destinations/{destId}/test": { "post": { "operationId": "TestBackupDestination", "summary": "Test Destination", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Backup Destinations" ], "x-belune-order": 5, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "destId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/backups": { "get": { "operationId": "ListProjectBackups", "summary": "Get Recent Backups", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Backup Destinations" ], "x-belune-order": 7, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/projectBackupActivityResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/databases": { "get": { "operationId": "ListDatabases", "summary": "Get Databases", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Databases" ], "x-belune-order": 1, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/databaseResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "post": { "operationId": "CreateDatabase", "summary": "Create Database", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Databases" ], "x-belune-order": 3, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createDatabaseRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Database" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/databases/{databaseId}": { "delete": { "operationId": "DeleteDatabase", "summary": "Delete Database", "tags": [ "Databases" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "delete_backups", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] }, "get": { "operationId": "GetDatabase", "summary": "Get Database", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Databases" ], "x-belune-order": 2, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/databases/{databaseId}/backup-configs": { "get": { "operationId": "ListDatabaseBackupConfigs", "summary": "Get Configs", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Database Volumes \u0026 Backups" ], "x-belune-order": 2, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/databaseBackupConfigResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "post": { "operationId": "CreateDatabaseBackupConfig", "summary": "Create Config", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Database Volumes \u0026 Backups" ], "x-belune-order": 3, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseBackupConfigRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseBackupConfigResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/databases/{databaseId}/backup-configs/{configId}": { "delete": { "operationId": "DeleteDatabaseBackupConfig", "summary": "Delete Config", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Database Volumes \u0026 Backups" ], "x-belune-order": 5, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "configId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] }, "put": { "operationId": "UpdateDatabaseBackupConfig", "summary": "Update Config", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Database Volumes \u0026 Backups" ], "x-belune-order": 4, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "configId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseBackupConfigRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseBackupConfigResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/databases/{databaseId}/backup-configs/{configId}/run": { "post": { "operationId": "RunDatabaseBackupConfig", "summary": "Run Config Backup", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Database Volumes \u0026 Backups" ], "x-belune-order": 6, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "configId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/databases/{databaseId}/backups": { "get": { "operationId": "ListDatabaseBackups", "summary": "Get Backups", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Database Volumes \u0026 Backups" ], "x-belune-order": 7, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/databaseBackupResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "post": { "operationId": "BackupDatabase", "summary": "Backup Database", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Database Volumes \u0026 Backups" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/databases/{databaseId}/backups/{backupId}": { "delete": { "operationId": "DeleteDatabaseBackup", "summary": "Delete Database Backup", "tags": [ "Database Volumes \u0026 Backups" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "backupId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/projects/{projectId}/databases/{databaseId}/credentials/reveal": { "get": { "operationId": "RevealDatabaseCredentials", "summary": "Reveal Database Credentials", "tags": [ "Databases" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseCredentialsResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/projects/{projectId}/databases/{databaseId}/deletion-impact": { "get": { "operationId": "GetDatabaseDeletionImpact", "summary": "Get Deletion Impact", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Databases" ], "x-belune-order": 5, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "backup_count": { "type": "integer" }, "backup_destinations": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/databases/{databaseId}/external-access": { "post": { "operationId": "SetDatabaseExternalAccess", "summary": "Set External Access", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Databases" ], "x-belune-order": 7, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/externalAccessRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/databases/{databaseId}/logs/history": { "get": { "operationId": "ListDatabaseLogs", "summary": "Get Logs", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Database Logs" ], "x-belune-order": 2, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "level", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "session", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "stream", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ContainerLog" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/databases/{databaseId}/logs/sessions": { "get": { "operationId": "ListDatabaseLogSessions", "summary": "Get Sessions", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Database Logs" ], "x-belune-order": 1, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ListContainerLogSessionsRow" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/databases/{databaseId}/reload": { "post": { "operationId": "ReloadDatabase", "summary": "Reload Database", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Database Actions" ], "x-belune-order": 4, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "deploy": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/databases/{databaseId}/resources": { "put": { "operationId": "SetDatabaseResources", "summary": "Set Resources", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Databases" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateDatabaseRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Database" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/databases/{databaseId}/restart": { "post": { "operationId": "RestartDatabase", "summary": "Restart Database", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Database Actions" ], "x-belune-order": 3, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "deploy": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/databases/{databaseId}/restore": { "post": { "operationId": "RestoreDatabase", "summary": "Restore Database", "tags": [ "Database Volumes \u0026 Backups" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/restoreDatabaseRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/projects/{projectId}/databases/{databaseId}/restores": { "get": { "operationId": "ListDatabaseRestores", "summary": "Get Restores", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Database Volumes \u0026 Backups" ], "x-belune-order": 8, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/databaseRestoreResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/databases/{databaseId}/start": { "post": { "operationId": "StartDatabase", "summary": "Start Database", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Database Actions" ], "x-belune-order": 1, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "deploy": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/databases/{databaseId}/stop": { "post": { "operationId": "StopDatabase", "summary": "Stop Database", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Database Actions" ], "x-belune-order": 2, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "deploy": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/databases/{databaseId}/upgrade": { "post": { "operationId": "UpgradeDatabase", "summary": "Upgrade Version", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Databases" ], "x-belune-order": 6, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upgradeDatabaseRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/databases/{databaseId}/volume": { "get": { "operationId": "GetDatabaseVolume", "summary": "Get Volume", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Database Volumes \u0026 Backups" ], "x-belune-order": 1, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "databaseId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseVolumeResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/env": { "get": { "operationId": "ListProjectEnvVars", "summary": "Get Variables", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Project Environment Variables" ], "x-belune-order": 1, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/envVarResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "put": { "operationId": "UpdateProjectEnvVars", "summary": "Update Variables", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Project Environment Variables" ], "x-belune-order": 2, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateEnvVarsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/env/{envVarId}/reveal": { "get": { "operationId": "RevealProjectEnvVar", "summary": "Reveal Project Env Var", "tags": [ "Project Environment Variables" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "envVarId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "value": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/projects/{projectId}/metrics": { "get": { "operationId": "GetProjectMetrics", "summary": "Get Metrics", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Projects" ], "x-belune-order": 5, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "additionalProperties": { "$ref": "#/components/schemas/serviceMetrics" }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "metrics": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/orphaned-backups": { "get": { "operationId": "ListProjectOrphanedDatabaseBackups", "summary": "Get Orphaned Database Backups", "description": "Backups whose database has been deleted but which were kept, listed against the tombstone that now parents them. Database backups only — an application's volume backups are erased with the application and can never reach this state. Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "Database Volumes \u0026 Backups" ], "x-belune-order": 10, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/orphanedBackupResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/projects/{projectId}/orphaned-backups/{backupId}": { "delete": { "operationId": "DeleteOrphanedDatabaseBackup", "summary": "Delete Orphaned Database Backup", "tags": [ "Database Volumes \u0026 Backups" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "backupId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/projects/{projectId}/orphaned-backups/{backupId}/restore": { "post": { "operationId": "RestoreDatabaseFromTombstone", "summary": "Restore Database From Tombstone", "tags": [ "Database Volumes \u0026 Backups" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "backupId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/databaseResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/projects/{projectId}/sharing": { "put": { "operationId": "UpdateProjectSharing", "summary": "Update Project Sharing", "tags": [ "Projects" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateProjectSharingRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/projects/{projectId}/transfer": { "put": { "operationId": "TransferProject", "summary": "Transfer Project", "description": "Requires the Admin role.", "tags": [ "Projects" ], "x-belune-roles": [ "admin" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transferProjectRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/quotas": { "get": { "operationId": "ListQuotas", "summary": "Get Quotas", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope. Requires the Admin role.", "tags": [ "Quotas (Admin)" ], "x-belune-order": 1, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/quotaView" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/quotas/{scope}/{scopeId}": { "delete": { "operationId": "DeleteQuota", "summary": "Delete Quota", "description": "Requires the Admin role.", "tags": [ "Quotas (Admin)" ], "x-belune-order": 4, "x-belune-roles": [ "admin" ], "parameters": [ { "name": "scope", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "scopeId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] }, "get": { "operationId": "GetQuota", "summary": "Get Quota", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope. Requires the Admin role.", "tags": [ "Quotas (Admin)" ], "x-belune-order": 2, "x-belune-roles": [ "admin" ], "parameters": [ { "name": "scope", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "scopeId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quotaView" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "put": { "operationId": "UpsertQuota", "summary": "Upsert Quota", "description": "Requires the Admin role.", "tags": [ "Quotas (Admin)" ], "x-belune-order": 3, "x-belune-roles": [ "admin" ], "parameters": [ { "name": "scope", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "name": "scopeId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upsertQuotaRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quotaView" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/requests": { "get": { "operationId": "ListAllRequestLogs", "summary": "Get Logs", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope. Requires the Admin role.", "tags": [ "Requests (Admin)" ], "x-belune-order": 2, "x-belune-roles": [ "admin" ], "parameters": [ { "name": "application_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status_max", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status_min", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RequestLog" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/requests/stream": { "get": { "operationId": "StreamAllRequestLogs", "summary": "Stream Logs", "description": "A project-pinned token cannot use this endpoint at all, even for a project inside its pin set. Requires the Admin role.", "tags": [ "Requests (Admin)" ], "x-belune-order": 3, "x-belune-roles": [ "admin" ], "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Not resolved by static extraction — see the handler for the exact response." } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/requests/summary": { "get": { "operationId": "GetAllRequestsSummary", "summary": "Get Summary", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope. Requires the Admin role.", "tags": [ "Requests (Admin)" ], "x-belune-order": 1, "x-belune-roles": [ "admin" ], "parameters": [ { "name": "application_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status_max", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status_min", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestSummaryResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/server/dashboard-tls": { "get": { "operationId": "GetDashboardTLS", "summary": "Get LTS Status", "description": "Requires the Admin role.", "tags": [ "Maintenance (Admin)" ], "x-belune-order": 2, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dashboardTLSResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/server/services": { "get": { "operationId": "GetServerServices", "summary": "Get Server Services", "description": "Requires the Admin role.", "tags": [ "Maintenance (Admin)" ], "x-belune-order": 3, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverServicesResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/settings": { "get": { "operationId": "ListSettings", "summary": "List Settings", "description": "Requires the Admin role.", "tags": [ "Maintenance (Admin)" ], "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/settingResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] }, "put": { "operationId": "UpdateSettings", "summary": "Update Settings", "description": "Requires the Admin role.", "tags": [ "Maintenance (Admin)" ], "x-belune-roles": [ "admin" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/settingResponse" }, "type": "array" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/settings/smtp": { "get": { "operationId": "GetSMTPSettings", "summary": "Get SMTP Settings", "description": "Requires the Admin role.", "tags": [ "Maintenance (Admin)" ], "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SMTPView" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] }, "put": { "operationId": "UpdateSMTPSettings", "summary": "Update SMTP Settings", "description": "Requires the Admin role.", "tags": [ "Maintenance (Admin)" ], "x-belune-roles": [ "admin" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/smtpSettingsRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/settings/smtp/test": { "post": { "operationId": "TestSMTPSettings", "summary": "Test SMTP Settings", "description": "Requires the Admin role.", "tags": [ "Maintenance (Admin)" ], "x-belune-roles": [ "admin" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/testSMTPRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/stats": { "get": { "operationId": "GetStats", "summary": "Get Stats", "description": "Operator-health summary in one call. An admin sees every project plus host resources and failed backups; a member sees only their own projects and any shared with them, without the host and backup signals.", "tags": [ "Platform" ], "x-belune-order": 1, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/statsResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/summary": { "get": { "operationId": "GetSummary", "summary": "Get Summary", "description": "Resource counts for the dashboard overview — project, application, database and deployment totals plus a container census. Not time-series data: see `/api/metrics/host` for that, and `/metrics` for the Prometheus scrape endpoint. Requires the Admin role.", "tags": [ "Metrics (Admin)" ], "x-belune-order": 1, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/metricsResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "metrics": [] }, { "session": [] } ] } }, "/api/templates": { "get": { "operationId": "ListTemplates", "summary": "Get Templates", "tags": [ "App Templates" ], "x-belune-order": 1, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/templateSummary" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/templates/{templateId}": { "get": { "operationId": "GetTemplate", "summary": "Get Template", "tags": [ "App Templates" ], "x-belune-order": 2, "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/templateDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/templates/{templateId}/instantiate": { "post": { "operationId": "InstantiateTemplate", "summary": "Init Template", "description": "Scoped to a project-pinned token's pin set — a project outside it is rejected, regardless of scope.", "tags": [ "App Templates" ], "x-belune-order": 2, "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/instantiateTemplateRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/instantiateTemplateResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/tokens": { "get": { "operationId": "ListAPITokens", "summary": "List API Tokens", "tags": [ "Personal Access Tokens" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/apiTokenDTO" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] }, "post": { "operationId": "CreateAPIToken", "summary": "Create API Token", "tags": [ "Personal Access Tokens" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createTokenRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "properties": { "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "expires_at": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "type": "string" }, "name": { "type": "string" }, "pinned": { "type": "boolean" }, "project_ids": { "items": { "type": "string" }, "type": "array" }, "role_at_issue": { "type": "string" }, "scopes": { "items": { "type": "string" }, "type": "array" }, "token": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/tokens/{tokenId}": { "delete": { "operationId": "DeleteAPIToken", "summary": "Delete API Token", "tags": [ "Personal Access Tokens" ], "parameters": [ { "name": "tokenId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/users": { "get": { "operationId": "ListUsers", "summary": "Get Users", "description": "Requires the Admin role.", "tags": [ "Users (Admin)" ], "x-belune-order": 1, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ListUsersRow" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] }, "post": { "operationId": "CreateUser", "summary": "Create User", "description": "Requires the Admin role.", "tags": [ "Users (Admin)" ], "x-belune-roles": [ "admin" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createUserRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListUsersRow" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/users/invitations": { "get": { "operationId": "ListPendingInvitations", "summary": "Get Invitations", "description": "Requires the Admin role.", "tags": [ "Users (Admin)" ], "x-belune-order": 2, "x-belune-roles": [ "admin" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/invitationResponse" }, "type": "array" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/users/invitations/{invitationId}": { "delete": { "operationId": "RevokeInvitation", "summary": "Revoke Invitation", "description": "Requires the Admin role.", "tags": [ "Users (Admin)" ], "x-belune-order": 3, "x-belune-roles": [ "admin" ], "parameters": [ { "name": "invitationId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Not resolved by static extraction — see the handler for the exact response." } }, "security": [ { "write": [] }, { "session": [] } ] } }, "/api/users/invite": { "post": { "operationId": "InviteUser", "summary": "Invite User", "description": "Requires the Admin role.", "tags": [ "Users (Admin)" ], "x-belune-roles": [ "admin" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inviteUserRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invitationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/users/{userId}": { "delete": { "operationId": "DeleteUser", "summary": "Delete User", "description": "Requires the Admin role.", "tags": [ "Users (Admin)" ], "x-belune-roles": [ "admin" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/users/{userId}/password": { "put": { "operationId": "ResetUserPassword", "summary": "Reset User Password", "description": "Requires the Admin role.", "tags": [ "Users (Admin)" ], "x-belune-roles": [ "admin" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resetUserPasswordRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/users/{userId}/role": { "put": { "operationId": "UpdateUserRole", "summary": "Update User Role", "description": "Requires the Admin role.", "tags": [ "Users (Admin)" ], "x-belune-roles": [ "admin" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateUserRoleRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserRoleRow" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/users/{userId}/totp/reset": { "post": { "operationId": "AdminResetUserTOTP", "summary": "Admin Reset User TOTP", "description": "Requires the Admin role.", "tags": [ "Users (Admin)" ], "x-belune-roles": [ "admin" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adminResetUserTOTPRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [] } ] } }, "/api/ws": { "get": { "operationId": "HandleWebSocket", "summary": "Open the Live Updates Socket", "description": "Subscribe to live metrics, logs, request traces and container status over one socket. OpenAPI cannot describe a WebSocket protocol, so the frames, the channel list and the connection limits are documented in the [WebSockets guide](/docs/api/overview/websockets).", "tags": [ "Platform" ], "x-belune-order": 4, "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Not resolved by static extraction — see the handler for the exact response." } }, "security": [ { "read": [] }, { "session": [] } ] } }, "/api/ws/terminal/{sessionId}": { "get": { "operationId": "HandleTerminalWebSocket", "summary": "Handle Terminal Web Socket", "tags": [ "Terminal Access" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Not resolved by static extraction — see the handler for the exact response." } }, "security": [ { "session": [] } ] } }, "/metrics": { "get": { "operationId": "ServeMetrics", "summary": "Scrape Prometheus Metrics", "description": "The Prometheus scrape endpoint at `GET /metrics`, a passthrough to the registry's own promhttp handler. Unrelated to `GET /api/summary`, which returns resource counts. Requires the Admin role.", "tags": [ "Metrics (Admin)" ], "x-belune-order": 4, "x-belune-roles": [ "admin" ], "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Not resolved by static extraction — see the handler for the exact response." } }, "security": [ { "metrics": [] }, { "session": [] } ] } } }, "components": { "schemas": { "AuthUserResult": { "properties": { "email": { "type": "string" }, "first_name": { "type": "string" }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "last_name": { "type": "string" }, "role": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "Branch": { "properties": { "name": { "type": "string" } }, "type": "object" }, "CertificateMetadata": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "domain_count": { "type": "integer" }, "id": { "type": "string" }, "issuer": { "type": "string" }, "name": { "type": "string" }, "not_after": { "format": "date-time", "type": [ "string", "null" ] }, "not_before": { "format": "date-time", "type": [ "string", "null" ] }, "subjects": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "ContainerLog": { "properties": { "container_id": { "type": [ "string", "null" ] }, "deployment_id": { "format": "uuid", "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "level": { "type": "string" }, "message": { "type": "string" }, "recorded_at": { "format": "date-time", "type": [ "string", "null" ] }, "source_id": { "format": "uuid", "type": [ "string", "null" ] }, "source_type": { "type": "string" }, "stream": { "type": "string" } }, "type": "object" }, "Database": { "properties": { "backup_command": { "type": [ "string", "null" ] }, "backup_mode": { "type": "string" }, "container_port": { "type": [ "integer", "null" ] }, "cpu_limit": { "type": "number" }, "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "credentials_encrypted": { "format": "byte", "type": "string" }, "data_dir": { "type": [ "string", "null" ] }, "host_port": { "type": [ "integer", "null" ] }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "image": { "type": [ "string", "null" ] }, "image_digest": { "type": [ "string", "null" ] }, "internal_host": { "type": [ "string", "null" ] }, "internal_port": { "type": [ "integer", "null" ] }, "memory_limit": { "type": "integer" }, "name": { "type": "string" }, "project_id": { "format": "uuid", "type": [ "string", "null" ] }, "restore_command": { "type": [ "string", "null" ] }, "slug": { "type": "string" }, "source_kind": { "type": [ "string", "null" ] }, "source_ref": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "Deployment": { "properties": { "application_id": { "format": "uuid", "type": [ "string", "null" ] }, "build_ended_at": { "format": "date-time", "type": [ "string", "null" ] }, "build_logs": { "type": [ "string", "null" ] }, "build_started_at": { "format": "date-time", "type": [ "string", "null" ] }, "commit_author": { "type": [ "string", "null" ] }, "commit_message": { "type": [ "string", "null" ] }, "commit_sha": { "type": [ "string", "null" ] }, "deploy_started_at": { "format": "date-time", "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "finished_at": { "format": "date-time", "type": [ "string", "null" ] }, "health_checked_at": { "format": "date-time", "type": [ "string", "null" ] }, "health_message": { "type": [ "string", "null" ] }, "health_status": { "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "idempotency_key": { "type": [ "string", "null" ] }, "image_tag": { "type": [ "string", "null" ] }, "started_at": { "format": "date-time", "type": [ "string", "null" ] }, "status": { "type": "string" }, "triggered_by": { "type": "string" } }, "type": "object" }, "DiskUsageEntry": { "properties": { "count": { "type": "integer" }, "reclaimable": { "type": "integer" }, "size": { "type": "integer" } }, "type": "object" }, "DockerDiskUsage": { "properties": { "build_cache": { "$ref": "#/components/schemas/DiskUsageEntry" }, "containers": { "$ref": "#/components/schemas/DiskUsageEntry" }, "images": { "$ref": "#/components/schemas/DiskUsageEntry" }, "layers_size": { "type": "integer" }, "volumes": { "$ref": "#/components/schemas/DiskUsageEntry" } }, "type": "object" }, "DockerSystemInfo": { "properties": { "architecture": { "type": "string" }, "cgroup_driver": { "type": "string" }, "containers": { "type": "integer" }, "containers_paused": { "type": "integer" }, "containers_running": { "type": "integer" }, "containers_stopped": { "type": "integer" }, "docker_root_dir": { "type": "string" }, "images": { "type": "integer" }, "kernel_version": { "type": "string" }, "logging_driver": { "type": "string" }, "mem_total": { "type": "integer" }, "name": { "type": "string" }, "ncpu": { "type": "integer" }, "operating_system": { "type": "string" }, "os_type": { "type": "string" }, "server_version": { "type": "string" }, "storage_driver": { "type": "string" } }, "type": "object" }, "Domain": { "properties": { "advanced_config": { "format": "byte", "type": "string" }, "application_id": { "format": "uuid", "type": [ "string", "null" ] }, "caddy_config_id": { "type": [ "string", "null" ] }, "certificate_id": { "format": "uuid", "type": [ "string", "null" ] }, "container_port": { "type": [ "integer", "null" ] }, "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "force_https": { "type": "boolean" }, "hostname": { "type": "string" }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "internal_path": { "type": "string" }, "path": { "type": "string" }, "ssl_credentials_encrypted": { "format": "byte", "type": "string" }, "ssl_enabled": { "type": "boolean" }, "ssl_mode": { "type": "string" }, "ssl_provider": { "type": [ "string", "null" ] }, "strip_path": { "type": "boolean" }, "tls_advisory": { "type": [ "string", "null" ] }, "tls_error": { "type": [ "string", "null" ] }, "tls_issuer": { "type": [ "string", "null" ] }, "tls_last_checked_at": { "format": "date-time", "type": [ "string", "null" ] }, "tls_not_after": { "format": "date-time", "type": [ "string", "null" ] }, "tls_status": { "type": "string" }, "verified_at": { "format": "date-time", "type": [ "string", "null" ] } }, "type": "object" }, "DomainRouteFeature": { "properties": { "config": { "format": "byte", "type": "string" }, "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "domain_id": { "format": "uuid", "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "feature_type": { "type": "string" }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "updated_at": { "format": "date-time", "type": [ "string", "null" ] } }, "type": "object" }, "Enrollment": { "properties": { "qr_code": { "type": "string" }, "secret": { "type": "string" }, "uri": { "type": "string" } }, "type": "object" }, "Error": { "properties": { "error": { "type": "string" } }, "type": "object" }, "EventDef": { "properties": { "description": { "type": "string" }, "group": { "type": "string" }, "label": { "type": "string" }, "severity": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "GetDomainWithFeaturesRow": { "properties": { "advanced_config": { "format": "byte", "type": "string" }, "application_id": { "format": "uuid", "type": [ "string", "null" ] }, "caddy_config_id": { "type": [ "string", "null" ] }, "certificate_id": { "format": "uuid", "type": [ "string", "null" ] }, "container_port": { "type": [ "integer", "null" ] }, "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "force_https": { "type": "boolean" }, "hostname": { "type": "string" }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "internal_path": { "type": "string" }, "path": { "type": "string" }, "route_features": {}, "ssl_credentials_encrypted": { "format": "byte", "type": "string" }, "ssl_enabled": { "type": "boolean" }, "ssl_mode": { "type": "string" }, "ssl_provider": { "type": [ "string", "null" ] }, "strip_path": { "type": "boolean" }, "tls_advisory": { "type": [ "string", "null" ] }, "tls_error": { "type": [ "string", "null" ] }, "tls_issuer": { "type": [ "string", "null" ] }, "tls_last_checked_at": { "format": "date-time", "type": [ "string", "null" ] }, "tls_not_after": { "format": "date-time", "type": [ "string", "null" ] }, "tls_status": { "type": "string" }, "verified_at": { "format": "date-time", "type": [ "string", "null" ] } }, "type": "object" }, "HostMetricPoint": { "properties": { "cpu_percent": { "type": "number" }, "disk_total": { "type": "integer" }, "disk_used": { "type": "integer" }, "memory_total": { "type": "integer" }, "memory_used": { "type": "integer" }, "recorded_at": { "type": "string" }, "swap_total": { "type": "integer" }, "swap_used": { "type": "integer" } }, "type": "object" }, "Input": { "properties": { "default": { "type": "string" }, "description": { "type": "string" }, "key": { "type": "string" }, "label": { "type": "string" }, "required": { "type": "boolean" }, "validation": { "type": "string" } }, "type": "object" }, "Limits": { "properties": { "max_applications": { "type": [ "integer", "null" ] }, "max_cpu": { "type": [ "number", "null" ] }, "max_memory_mb": { "type": [ "integer", "null" ] } }, "type": "object" }, "ListAllProjectsRow": { "properties": { "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "last_deployed_at": {}, "name": { "type": "string" }, "server_id": { "format": "uuid", "type": [ "string", "null" ] }, "shared": { "type": "boolean" }, "slug": { "type": "string" }, "updated_at": { "format": "date-time", "type": [ "string", "null" ] }, "user_id": { "format": "uuid", "type": [ "string", "null" ] } }, "type": "object" }, "ListAuditLogsFilteredRow": { "properties": { "action": { "type": "string" }, "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "details": { "format": "byte", "type": "string" }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "ip_address": { "type": [ "string", "null" ] }, "resource_id": { "type": [ "string", "null" ] }, "resource_name": { "type": "string" }, "resource_type": { "type": "string" }, "token_id": { "format": "uuid", "type": [ "string", "null" ] }, "token_name": { "type": "string" }, "user_email": { "type": [ "string", "null" ] }, "user_id": { "format": "uuid", "type": [ "string", "null" ] }, "user_username": { "type": [ "string", "null" ] } }, "type": "object" }, "ListContainerLogSessionsRow": { "properties": { "commit_sha": { "type": [ "string", "null" ] }, "container_id": { "type": [ "string", "null" ] }, "deployment_id": { "format": "uuid", "type": [ "string", "null" ] }, "first_at": { "format": "date-time", "type": [ "string", "null" ] }, "last_at": { "format": "date-time", "type": [ "string", "null" ] }, "line_count": { "type": "integer" }, "started_at": { "format": "date-time", "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "triggered_by": { "type": [ "string", "null" ] } }, "type": "object" }, "ListDomainsByApplicationWithFeaturesRow": { "properties": { "advanced_config": { "format": "byte", "type": "string" }, "application_id": { "format": "uuid", "type": [ "string", "null" ] }, "caddy_config_id": { "type": [ "string", "null" ] }, "certificate_id": { "format": "uuid", "type": [ "string", "null" ] }, "container_port": { "type": [ "integer", "null" ] }, "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "force_https": { "type": "boolean" }, "hostname": { "type": "string" }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "internal_path": { "type": "string" }, "path": { "type": "string" }, "route_features": {}, "ssl_credentials_encrypted": { "format": "byte", "type": "string" }, "ssl_enabled": { "type": "boolean" }, "ssl_mode": { "type": "string" }, "ssl_provider": { "type": [ "string", "null" ] }, "strip_path": { "type": "boolean" }, "tls_advisory": { "type": [ "string", "null" ] }, "tls_error": { "type": [ "string", "null" ] }, "tls_issuer": { "type": [ "string", "null" ] }, "tls_last_checked_at": { "format": "date-time", "type": [ "string", "null" ] }, "tls_not_after": { "format": "date-time", "type": [ "string", "null" ] }, "tls_status": { "type": "string" }, "verified_at": { "format": "date-time", "type": [ "string", "null" ] } }, "type": "object" }, "ListGlobalDeploymentsFilteredRow": { "properties": { "application_id": { "format": "uuid", "type": [ "string", "null" ] }, "application_name": { "type": "string" }, "application_slug": { "type": "string" }, "build_logs": { "type": [ "string", "null" ] }, "commit_author": { "type": [ "string", "null" ] }, "commit_message": { "type": [ "string", "null" ] }, "commit_sha": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "finished_at": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "image_tag": { "type": [ "string", "null" ] }, "project_id": { "format": "uuid", "type": [ "string", "null" ] }, "project_name": { "type": "string" }, "started_at": { "format": "date-time", "type": [ "string", "null" ] }, "status": { "type": "string" }, "triggered_by": { "type": "string" } }, "type": "object" }, "ListProjectsByUserRow": { "properties": { "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "last_deployed_at": {}, "name": { "type": "string" }, "server_id": { "format": "uuid", "type": [ "string", "null" ] }, "shared": { "type": "boolean" }, "slug": { "type": "string" }, "updated_at": { "format": "date-time", "type": [ "string", "null" ] }, "user_id": { "format": "uuid", "type": [ "string", "null" ] } }, "type": "object" }, "ListUsersRow": { "properties": { "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "email": { "type": "string" }, "first_name": { "type": "string" }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "last_active_at": {}, "last_name": { "type": "string" }, "role": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "LoginChallenge": { "properties": { "challenge": { "type": "string" }, "expires_in": { "type": "integer" }, "methods": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "LoginResult": { "properties": { "expires_in": { "type": "integer" }, "refresh_token": { "type": "string" }, "token": { "type": "string" }, "user": { "$ref": "#/components/schemas/AuthUserResult" } }, "type": "object" }, "Notification": { "properties": { "body": { "type": "string" }, "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "link": { "type": [ "string", "null" ] }, "read": { "type": "boolean" }, "title": { "type": "string" }, "type": { "type": "string" }, "user_id": { "format": "uuid", "type": [ "string", "null" ] } }, "type": "object" }, "Project": { "properties": { "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "name": { "type": "string" }, "server_id": { "format": "uuid", "type": [ "string", "null" ] }, "shared": { "type": "boolean" }, "slug": { "type": "string" }, "updated_at": { "format": "date-time", "type": [ "string", "null" ] }, "user_id": { "format": "uuid", "type": [ "string", "null" ] } }, "type": "object" }, "ReconcilerStatus": { "properties": { "interval_seconds": { "type": "integer" }, "last_added": { "type": "integer" }, "last_duration_ms": { "type": "integer" }, "last_error": { "type": "string" }, "last_removed": { "type": "integer" }, "last_run_at": { "format": "date-time", "type": "string" }, "last_updated": { "type": "integer" }, "run_count": { "type": "integer" }, "total_drift": { "type": "integer" } }, "type": "object" }, "Repo": { "properties": { "clone_url": { "type": "string" }, "default_branch": { "type": "string" }, "full_name": { "type": "string" }, "private": { "type": "boolean" } }, "type": "object" }, "RequestLog": { "properties": { "application_id": { "format": "uuid", "type": [ "string", "null" ] }, "client_ip": { "type": [ "string", "null" ] }, "hostname": { "type": "string" }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "latency_ms": { "type": "integer" }, "method": { "type": "string" }, "path": { "type": "string" }, "recorded_at": { "format": "date-time", "type": [ "string", "null" ] }, "request_size": { "type": [ "integer", "null" ] }, "response_size": { "type": [ "integer", "null" ] }, "status_code": { "type": "integer" }, "user_agent": { "type": [ "string", "null" ] } }, "type": "object" }, "SMTPView": { "properties": { "from_email": { "type": "string" }, "from_name": { "type": "string" }, "host": { "type": "string" }, "password_set": { "type": "boolean" }, "port": { "type": "integer" }, "tls_mode": { "type": "string" }, "user": { "type": "string" } }, "type": "object" }, "UpdateUserProfileRow": { "properties": { "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "email": { "type": "string" }, "first_name": { "type": "string" }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "last_name": { "type": "string" }, "role": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "UpdateUserRoleRow": { "properties": { "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "email": { "type": "string" }, "first_name": { "type": "string" }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "last_name": { "type": "string" }, "role": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "UsableCertificate": { "properties": { "id": { "type": "string" }, "issuer": { "type": "string" }, "name": { "type": "string" }, "not_after": { "format": "date-time", "type": [ "string", "null" ] } }, "type": "object" }, "Usage": { "properties": { "applications": { "type": "integer" }, "cpu": { "type": "number" }, "memory_bytes": { "type": "integer" } }, "type": "object" }, "Warning": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "remedy": { "type": "string" } }, "type": "object" }, "acceptInvitationRequest": { "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "password": { "type": "string" }, "token": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "addDomainRequest": { "properties": { "advanced_config": { "description": "arbitrary JSON — see the handler for the exact shape" }, "certificate_id": { "type": "string" }, "container_port": { "type": [ "integer", "null" ] }, "force_https": { "type": [ "boolean", "null" ] }, "hostname": { "type": "string" }, "internal_path": { "type": "string" }, "path": { "type": "string" }, "ssl_enabled": { "type": "boolean" }, "ssl_mode": { "type": "string" }, "ssl_provider": { "type": "string" }, "strip_path": { "type": "boolean" } }, "type": "object" }, "adminResetUserTOTPRequest": { "properties": { "code": { "type": "string" }, "current_password": { "type": "string" }, "method": { "type": "string" } }, "type": "object" }, "alertPreferencesResponse": { "properties": { "build_failures": { "type": "boolean" }, "deploy_failures": { "type": "boolean" }, "deploy_success": { "type": "boolean" }, "quota_threshold": { "type": "boolean" }, "quota_threshold_percent": { "type": "integer" } }, "type": "object" }, "apiTokenDTO": { "properties": { "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "expires_at": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "type": "string" }, "last_used_at": { "format": "date-time", "type": [ "string", "null" ] }, "name": { "type": "string" }, "pinned": { "type": "boolean" }, "project_ids": { "items": { "type": "string" }, "type": "array" }, "role_at_issue": { "type": "string" }, "scopes": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "appVolumeBackupConfigResponse": { "properties": { "application_volume_id": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "destination_id": { "type": "string" }, "enabled": { "type": "boolean" }, "id": { "type": "string" }, "keep_latest": { "type": [ "integer", "null" ] }, "last_run_at": { "format": "date-time", "type": [ "string", "null" ] }, "mount_path": { "type": "string" }, "prefix": { "type": "string" }, "quiesce": { "type": "boolean" }, "schedule": { "type": "string" }, "volume_name": { "type": "string" } }, "type": "object" }, "applicationResponse": { "properties": { "auto_deploy_branch": { "type": [ "string", "null" ] }, "branch": { "type": [ "string", "null" ] }, "build_type": { "type": "string" }, "build_type_override": { "type": [ "string", "null" ] }, "builder_image": { "type": [ "string", "null" ] }, "config_changed_at": { "format": "date-time", "type": [ "string", "null" ] }, "container_caps": { "type": "string" }, "container_port": { "type": [ "integer", "null" ] }, "cpu_limit": { "type": "number" }, "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "custom_buildpacks": { "format": "byte", "type": "string" }, "deploy_hook_enabled": { "type": "boolean" }, "dockerfile_path": { "type": [ "string", "null" ] }, "git_integration_id": { "format": "uuid", "type": [ "string", "null" ] }, "has_git_credentials": { "type": "boolean" }, "has_webhook_secret": { "type": "boolean" }, "health_check_command": { "type": [ "string", "null" ] }, "health_check_expect_status": { "type": [ "integer", "null" ] }, "health_check_interval_seconds": { "type": [ "integer", "null" ] }, "health_check_path": { "type": [ "string", "null" ] }, "health_check_retries": { "type": [ "integer", "null" ] }, "health_check_start_period_seconds": { "type": [ "integer", "null" ] }, "health_check_timeout_seconds": { "type": [ "integer", "null" ] }, "health_check_type": { "type": "string" }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "last_activity_at": { "format": "date-time", "type": [ "string", "null" ] }, "last_deployed_at": { "format": "date-time", "type": [ "string", "null" ] }, "memory_limit": { "type": "integer" }, "name": { "type": "string" }, "parent_application_id": { "format": "uuid", "type": [ "string", "null" ] }, "pending_change": { "type": "string" }, "preview_branch_pattern": { "type": [ "string", "null" ] }, "preview_domain_template": { "type": [ "string", "null" ] }, "project_id": { "format": "uuid", "type": [ "string", "null" ] }, "readonly_rootfs": { "type": "boolean" }, "root_directory": { "type": [ "string", "null" ] }, "slug": { "type": "string" }, "source_changed_at": { "format": "date-time", "type": [ "string", "null" ] }, "source_image": { "type": [ "string", "null" ] }, "source_kind": { "type": [ "string", "null" ] }, "source_ref": { "type": [ "string", "null" ] }, "source_repo": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": [ "string", "null" ] } }, "type": "object" }, "applicationVolumeResponse": { "properties": { "created_at": { "type": "string" }, "id": { "type": "string" }, "mount_path": { "type": "string" }, "name": { "type": "string" }, "size_bytes": { "type": "integer" } }, "type": "object" }, "auditLogDTO": { "properties": { "action": { "type": "string" }, "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "details": { "description": "arbitrary JSON — see the handler for the exact shape" }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "ip_address": { "type": [ "string", "null" ] }, "resource_id": { "type": [ "string", "null" ] }, "resource_name": { "type": "string" }, "resource_type": { "type": "string" }, "token_id": { "format": "uuid", "type": [ "string", "null" ] }, "token_name": { "type": "string" }, "user_email": { "type": [ "string", "null" ] }, "user_id": { "format": "uuid", "type": [ "string", "null" ] }, "user_username": { "type": [ "string", "null" ] } }, "type": "object" }, "availableProviderResponse": { "properties": { "app_slug": { "type": "string" }, "base_url": { "type": "string" }, "provider": { "type": "string" } }, "type": "object" }, "backupDestinationRequest": { "properties": { "access_key": { "type": "string" }, "bucket": { "type": "string" }, "endpoint": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "prefix": { "type": "string" }, "provider": { "type": "string" }, "region": { "type": "string" }, "secret_key": { "type": "string" }, "use_ssl": { "type": [ "boolean", "null" ] } }, "type": "object" }, "backupDestinationResponse": { "properties": { "bucket": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "endpoint": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "prefix": { "type": "string" }, "project_id": { "type": "string" }, "provider": { "type": "string" }, "region": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "use_ssl": { "type": "boolean" } }, "type": "object" }, "backupRemoteView": { "properties": { "bucket": { "type": "string" }, "endpoint": { "type": "string" }, "prefix": { "type": "string" }, "region": { "type": "string" }, "use_ssl": { "type": "boolean" } }, "type": "object" }, "backupRunView": { "properties": { "encrypted": { "type": "boolean" }, "error": { "type": [ "string", "null" ] }, "finished_at": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "log": { "type": "string" }, "remote_key": { "type": [ "string", "null" ] }, "size_bytes": { "type": "integer" }, "started_at": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "backupStatusView": { "properties": { "encryption_enabled": { "type": "boolean" }, "encryption_recipient": { "type": [ "string", "null" ] }, "last_attempted_at": { "type": [ "string", "null" ] }, "last_error": { "type": [ "string", "null" ] }, "last_succeeded_at": { "type": [ "string", "null" ] }, "remote": { "anyOf": [ { "$ref": "#/components/schemas/backupRemoteView" }, { "type": "null" } ] }, "remote_enabled": { "type": "boolean" }, "retention": { "additionalProperties": {}, "type": "object" } }, "type": "object" }, "changePasswordRequest": { "properties": { "current_password": { "type": "string" }, "new_password": { "type": "string" } }, "type": "object" }, "changeSourceRequest": { "properties": { "branch": { "type": "string" }, "build_type": { "type": "string" }, "dockerfile_path": { "type": "string" }, "git_integration_id": { "type": "string" }, "git_token": { "type": "string" }, "root_directory": { "type": "string" }, "source_image": { "type": "string" }, "source_repo": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "cleanupRequest": { "properties": { "actions": { "items": { "type": "string" }, "type": "array" }, "retain_count": { "type": "integer" } }, "type": "object" }, "containerStats": { "properties": { "by_type": { "additionalProperties": { "$ref": "#/components/schemas/containerTypeCount" }, "type": "object" }, "error": { "type": "integer" }, "running": { "type": "integer" }, "stopped": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" }, "containerTypeCount": { "properties": { "running": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" }, "createApplicationRequest": { "properties": { "branch": { "type": "string" }, "build_type": { "type": "string" }, "cpu_limit": { "type": "number" }, "dockerfile_path": { "type": "string" }, "git_integration_id": { "type": "string" }, "git_token": { "type": "string" }, "health_check_path": { "type": "string" }, "memory_limit": { "type": "integer" }, "name": { "type": "string" }, "root_directory": { "type": "string" }, "slug": { "type": "string" }, "source_image": { "type": "string" }, "source_repo": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "createDatabaseCredentials": { "properties": { "database_name": { "type": "string" }, "password": { "type": "string" }, "root_password": { "type": "string" }, "user": { "type": "string" } }, "type": "object" }, "createDatabaseRequest": { "properties": { "backup_command": { "type": "string" }, "backup_mode": { "type": "string" }, "container_port": { "type": "integer" }, "credentials": { "anyOf": [ { "$ref": "#/components/schemas/createDatabaseCredentials" }, { "type": "null" } ] }, "data_dir": { "type": "string" }, "env": { "additionalProperties": { "type": "string" }, "type": "object" }, "image": { "type": "string" }, "name": { "type": "string" }, "restore_command": { "type": "string" }, "slug": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "createFileMountRequest": { "properties": { "content": { "type": "string" }, "file_mode": { "type": "string" }, "is_secret": { "type": "boolean" }, "mount_path": { "type": "string" } }, "type": "object" }, "createProjectRequest": { "properties": { "name": { "type": "string" }, "slug": { "type": "string" } }, "type": "object" }, "createTokenRequest": { "properties": { "expires_in_days": { "type": [ "integer", "null" ] }, "name": { "type": "string" }, "project_ids": { "items": { "type": "string" }, "type": "array" }, "scopes": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "createUserRequest": { "properties": { "email": { "type": "string" }, "password": { "type": "string" }, "role": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "createVolumeRequest": { "properties": { "mount_path": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "dashboardTLSResponse": { "properties": { "domain": { "type": "string" }, "ssl_mode": { "type": "string" }, "tls_error": { "type": "string" }, "tls_issuer": { "type": "string" }, "tls_not_after": { "format": "date-time", "type": [ "string", "null" ] }, "tls_status": { "type": "string" } }, "type": "object" }, "databaseBackupConfigRequest": { "properties": { "databases": { "items": { "type": "string" }, "type": "array" }, "destination_id": { "type": "string" }, "enabled": { "type": [ "boolean", "null" ] }, "keep_latest": { "type": [ "integer", "null" ] }, "prefix": { "type": "string" }, "schedule": { "type": "string" } }, "type": "object" }, "databaseBackupConfigResponse": { "properties": { "all_databases": { "type": "boolean" }, "created_at": { "format": "date-time", "type": "string" }, "database_id": { "type": "string" }, "databases": { "items": { "type": "string" }, "type": "array" }, "destination_id": { "type": "string" }, "enabled": { "type": "boolean" }, "id": { "type": "string" }, "keep_latest": { "type": [ "integer", "null" ] }, "last_run_at": { "format": "date-time", "type": [ "string", "null" ] }, "prefix": { "type": "string" }, "schedule": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "type": "object" }, "databaseBackupResponse": { "properties": { "config_id": { "type": [ "string", "null" ] }, "error": { "type": "string" }, "finished_at": { "format": "date-time", "type": [ "string", "null" ] }, "has_remote": { "type": "boolean" }, "id": { "type": "string" }, "log": { "type": "string" }, "remote_key": { "type": "string" }, "size_bytes": { "type": "integer" }, "started_at": { "format": "date-time", "type": "string" }, "status": { "type": "string" }, "target_database": { "type": "string" } }, "type": "object" }, "databaseCredentialsResponse": { "properties": { "connection_string": { "type": "string" }, "credentials": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object" }, "databaseResponse": { "properties": { "backup_command": { "type": [ "string", "null" ] }, "backup_mode": { "type": "string" }, "container_missing": { "type": "boolean" }, "container_port": { "type": [ "integer", "null" ] }, "cpu_limit": { "type": "number" }, "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "credentials_encrypted": { "format": "byte", "type": "string" }, "data_dir": { "type": [ "string", "null" ] }, "external_access": { "anyOf": [ { "$ref": "#/components/schemas/externalAccessInfo" }, { "type": "null" } ] }, "host_port": { "type": [ "integer", "null" ] }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "image": { "type": [ "string", "null" ] }, "image_digest": { "type": [ "string", "null" ] }, "internal_host": { "type": [ "string", "null" ] }, "internal_port": { "type": [ "integer", "null" ] }, "memory_limit": { "type": "integer" }, "name": { "type": "string" }, "project_id": { "format": "uuid", "type": [ "string", "null" ] }, "restore_command": { "type": [ "string", "null" ] }, "slug": { "type": "string" }, "source_kind": { "type": [ "string", "null" ] }, "source_ref": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "type": { "type": "string" }, "version": { "type": "string" }, "volume": { "anyOf": [ { "$ref": "#/components/schemas/volumeInfo" }, { "type": "null" } ] } }, "type": "object" }, "databaseRestoreResponse": { "properties": { "backup_id": { "type": "string" }, "error": { "type": "string" }, "finished_at": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "type": "string" }, "log": { "type": "string" }, "started_at": { "format": "date-time", "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "databaseVolumeResponse": { "properties": { "name": { "type": "string" }, "size_bytes": { "type": [ "integer", "null" ] } }, "type": "object" }, "dbSpec": { "properties": { "engine": { "type": "string" }, "name": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "deploy7dStats": { "properties": { "failed": { "type": "integer" }, "median_build_ms": { "type": "number" }, "succeeded": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" }, "deployHookResponse": { "properties": { "enabled": { "type": "boolean" }, "path": { "type": "string" }, "token": { "type": "string" } }, "type": "object" }, "disableTOTPRequest": { "properties": { "code": { "type": "string" }, "method": { "type": "string" }, "password": { "type": "string" } }, "type": "object" }, "dockerContainerResponse": { "properties": { "created_at": { "type": "string" }, "id": { "type": "string" }, "image": { "type": "string" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "owner": { "anyOf": [ { "$ref": "#/components/schemas/dockerOwner" }, { "type": "null" } ] }, "ports": { "additionalProperties": { "type": "string" }, "type": "object" }, "status": { "type": "string" } }, "type": "object" }, "dockerCounts": { "properties": { "containers_running": { "type": "integer" }, "containers_total": { "type": "integer" }, "images": { "type": "integer" }, "volumes": { "type": "integer" } }, "type": "object" }, "dockerImageResponse": { "properties": { "containers": { "type": "integer" }, "created_at": { "type": "string" }, "dangling": { "type": "boolean" }, "id": { "type": "string" }, "managed": { "type": "boolean" }, "owner": { "anyOf": [ { "$ref": "#/components/schemas/dockerOwner" }, { "type": "null" } ] }, "repo_tags": { "items": { "type": "string" }, "type": "array" }, "shared_size": { "type": "integer" }, "size": { "type": "integer" } }, "type": "object" }, "dockerNetworkContainerResponse": { "properties": { "id": { "type": "string" }, "ipv4_address": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "dockerNetworkResponse": { "properties": { "containers": { "items": { "$ref": "#/components/schemas/dockerNetworkContainerResponse" }, "type": "array" }, "created_at": { "type": "string" }, "driver": { "type": "string" }, "id": { "type": "string" }, "internal": { "type": "boolean" }, "managed": { "type": "boolean" }, "name": { "type": "string" }, "scope": { "type": "string" } }, "type": "object" }, "dockerOverviewResponse": { "properties": { "counts": { "$ref": "#/components/schemas/dockerCounts" }, "disk_usage": { "anyOf": [ { "$ref": "#/components/schemas/DockerDiskUsage" }, { "type": "null" } ] }, "info": { "anyOf": [ { "$ref": "#/components/schemas/DockerSystemInfo" }, { "type": "null" } ] } }, "type": "object" }, "dockerOwner": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "project_id": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "dockerVolumeResponse": { "properties": { "created_at": { "type": "string" }, "driver": { "type": "string" }, "kind": { "type": "string" }, "managed": { "type": "boolean" }, "mountpoint": { "type": "string" }, "name": { "type": "string" }, "owner": { "anyOf": [ { "$ref": "#/components/schemas/dockerOwner" }, { "type": "null" } ] }, "ref_count": { "type": "integer" }, "scope": { "type": "string" }, "size": { "type": "integer" } }, "type": "object" }, "domainTLSStatus": { "properties": { "application_id": { "type": "string" }, "application_name": { "type": "string" }, "certificate_name": { "type": "string" }, "hostname": { "type": "string" }, "id": { "type": "string" }, "project_id": { "type": "string" }, "ssl_mode": { "type": "string" }, "tls_advisory": { "type": "string" }, "tls_error": { "type": "string" }, "tls_issuer": { "type": "string" }, "tls_last_checked_at": { "format": "date-time", "type": [ "string", "null" ] }, "tls_not_after": { "format": "date-time", "type": [ "string", "null" ] }, "tls_status": { "type": "string" } }, "type": "object" }, "enrollRequest": { "properties": { "password": { "type": "string" } }, "type": "object" }, "envVarInput": { "properties": { "is_secret": { "type": "boolean" }, "key": { "type": "string" }, "unchanged": { "type": "boolean" }, "value": { "type": "string" } }, "type": "object" }, "envVarResponse": { "properties": { "created_at": { "type": "string" }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "is_secret": { "type": "boolean" }, "key": { "type": "string" }, "updated_at": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "externalAccessInfo": { "properties": { "enabled": { "type": "boolean" }, "host_port": { "type": "integer" }, "ssh_host": { "type": "string" }, "ssh_user": { "type": "string" } }, "type": "object" }, "externalAccessRequest": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" }, "fileMountResponse": { "properties": { "content": { "type": "string" }, "content_masked": { "type": "boolean" }, "created_at": { "type": "string" }, "file_mode": { "type": "string" }, "id": { "type": "string" }, "is_secret": { "type": "boolean" }, "mount_path": { "type": "string" } }, "type": "object" }, "forgotPasswordRequest": { "properties": { "email": { "type": "string" } }, "type": "object" }, "gitIntegrationResponse": { "properties": { "account_login": { "type": "string" }, "base_url": { "type": "string" }, "created_at": { "type": "string" }, "id": { "type": "string" }, "provider": { "type": "string" } }, "type": "object" }, "healthCheckRequest": { "properties": { "command": { "type": "string" }, "expect_status": { "type": "integer" }, "interval_seconds": { "type": "integer" }, "path": { "type": "string" }, "retries": { "type": "integer" }, "start_period_seconds": { "type": "integer" }, "timeout_seconds": { "type": "integer" }, "type": { "type": "string" } }, "type": "object" }, "healthRatio": { "properties": { "busy": { "type": "integer" }, "errored": { "type": "integer" }, "inactive": { "type": "integer" }, "running": { "type": "integer" }, "stopped": { "type": "integer" }, "total": { "type": "integer" }, "unhealthy": { "type": "integer" } }, "type": "object" }, "hostMetricPoint": { "properties": { "cpu_percent": { "type": [ "number", "null" ] }, "disk_total": { "type": [ "integer", "null" ] }, "disk_used": { "type": [ "integer", "null" ] }, "memory_total": { "type": [ "integer", "null" ] }, "memory_used": { "type": [ "integer", "null" ] }, "recorded_at": { "type": "string" } }, "type": "object" }, "instantiateTemplateRequest": { "properties": { "hostname": { "type": "string" }, "inputs": { "additionalProperties": { "type": "string" }, "type": "object" }, "new_project_name": { "type": "string" }, "project_id": { "type": "string" } }, "type": "object" }, "instantiateTemplateResponse": { "properties": { "notes": { "type": "string" }, "project_id": { "type": "string" }, "project_slug": { "type": "string" } }, "type": "object" }, "invitationResponse": { "properties": { "accepted_at": { "format": "date-time", "type": [ "string", "null" ] }, "created_at": { "format": "date-time", "type": [ "string", "null" ] }, "email": { "type": "string" }, "expires_at": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "invited_by_user_id": { "format": "uuid", "type": [ "string", "null" ] }, "role": { "type": "string" } }, "type": "object" }, "inviteUserRequest": { "properties": { "email": { "type": "string" }, "role": { "type": "string" } }, "type": "object" }, "loginRequest": { "properties": { "email": { "type": "string" }, "password": { "type": "string" } }, "type": "object" }, "loginVerifyRequest": { "properties": { "challenge": { "type": "string" }, "code": { "type": "string" }, "method": { "type": "string" } }, "type": "object" }, "metricsResponse": { "properties": { "applications": { "type": "integer" }, "containers": { "$ref": "#/components/schemas/containerStats" }, "databases": { "type": "integer" }, "deployments": { "type": "integer" }, "projects": { "type": "integer" } }, "type": "object" }, "needsAttention": { "properties": { "error_services": { "type": "integer" }, "failed_backups": { "type": "integer" }, "failed_deploys": { "type": "integer" }, "total": { "type": "integer" }, "unhealthy_services": { "type": "integer" } }, "type": "object" }, "notificationChannelRequest": { "properties": { "config": { "description": "arbitrary JSON — see the handler for the exact shape" }, "enabled": { "type": [ "boolean", "null" ] }, "events": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "notificationChannelResponse": { "properties": { "config": { "description": "arbitrary JSON — see the handler for the exact shape" }, "created_at": { "type": "string" }, "enabled": { "type": "boolean" }, "events": { "items": { "type": "string" }, "type": "array" }, "id": { "type": "string" }, "last_error": { "type": [ "string", "null" ] }, "last_event": { "type": [ "string", "null" ] }, "last_sent_at": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "orphanedBackupResponse": { "properties": { "config_id": { "type": [ "string", "null" ] }, "database_deleted_at": { "format": "date-time", "type": "string" }, "database_name": { "type": "string" }, "database_slug": { "type": "string" }, "database_type": { "type": "string" }, "error": { "type": "string" }, "finished_at": { "format": "date-time", "type": [ "string", "null" ] }, "has_remote": { "type": "boolean" }, "id": { "type": "string" }, "log": { "type": "string" }, "remote_key": { "type": "string" }, "size_bytes": { "type": "integer" }, "started_at": { "format": "date-time", "type": "string" }, "status": { "type": "string" }, "target_database": { "type": "string" }, "tombstone_id": { "type": "string" } }, "type": "object" }, "platformLogsResponse": { "properties": { "content": { "type": "string" }, "service": { "type": "string" } }, "type": "object" }, "previewConfigRequest": { "properties": { "preview_branch_pattern": { "type": [ "string", "null" ] }, "preview_domain_template": { "type": [ "string", "null" ] } }, "type": "object" }, "previewConfigResponse": { "properties": { "preview_branch_pattern": { "type": "string" }, "preview_domain_template": { "type": "string" } }, "type": "object" }, "previewView": { "properties": { "branch": { "type": "string" }, "hostname": { "type": "string" }, "id": { "type": "string" }, "last_activity_at": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "projectBackupActivityResponse": { "properties": { "app_name": { "type": [ "string", "null" ] }, "config_id": { "type": [ "string", "null" ] }, "error": { "type": "string" }, "finished_at": { "format": "date-time", "type": [ "string", "null" ] }, "has_remote": { "type": "boolean" }, "id": { "type": "string" }, "kind": { "type": "string" }, "log": { "type": "string" }, "remote_key": { "type": "string" }, "resource_id": { "type": "string" }, "resource_name": { "type": "string" }, "size_bytes": { "type": "integer" }, "started_at": { "format": "date-time", "type": "string" }, "status": { "type": "string" }, "target_database": { "type": "string" } }, "type": "object" }, "providerConfigResponse": { "properties": { "app_id": { "type": "string" }, "app_slug": { "type": "string" }, "base_url": { "type": "string" }, "client_id": { "type": "string" }, "has_secret": { "type": "boolean" }, "id": { "type": "string" }, "is_owner": { "type": "boolean" }, "is_public": { "type": "boolean" }, "provider": { "type": "string" } }, "type": "object" }, "queueDepth": { "properties": { "active": { "type": "integer" }, "archived": { "type": "integer" }, "pending": { "type": "integer" }, "queue": { "type": "string" }, "retry": { "type": "integer" } }, "type": "object" }, "queueStatusResponse": { "properties": { "queues": { "items": { "$ref": "#/components/schemas/queueDepth" }, "type": "array" }, "total_stuck": { "type": "integer" } }, "type": "object" }, "quotaView": { "properties": { "limits": { "$ref": "#/components/schemas/Limits" }, "meta": { "additionalProperties": {}, "type": "object" }, "scope": { "type": "string" }, "scope_id": { "type": "string" }, "usage": { "$ref": "#/components/schemas/Usage" } }, "type": "object" }, "regenerateCodesRequest": { "properties": { "code": { "type": "string" }, "method": { "type": "string" }, "password": { "type": "string" } }, "type": "object" }, "requestClassCounts": { "properties": { "c2xx": { "type": "integer" }, "c3xx": { "type": "integer" }, "c4xx": { "type": "integer" }, "c5xx": { "type": "integer" } }, "type": "object" }, "requestPerMinutePoint": { "properties": { "count": { "type": "integer" }, "ts": { "type": "string" } }, "type": "object" }, "requestSummaryResponse": { "properties": { "class_counts": { "$ref": "#/components/schemas/requestClassCounts" }, "error_rate": { "type": "number" }, "p50_ms": { "type": "number" }, "p95_ms": { "type": "number" }, "per_minute": { "items": { "$ref": "#/components/schemas/requestPerMinutePoint" }, "type": "array" }, "total": { "type": "integer" } }, "type": "object" }, "resetPasswordRequest": { "properties": { "new_password": { "type": "string" }, "token": { "type": "string" } }, "type": "object" }, "resetUserPasswordRequest": { "properties": { "current_password": { "type": "string" }, "password": { "type": "string" } }, "type": "object" }, "restoreDatabaseRequest": { "properties": { "backup_id": { "type": "string" } }, "type": "object" }, "rollbackRequest": { "properties": { "deployment_id": { "type": "string" } }, "type": "object" }, "saveGitProviderConfigRequest": { "properties": { "app_id": { "type": "string" }, "app_slug": { "type": "string" }, "base_url": { "type": "string" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "is_public": { "type": "boolean" }, "private_key": { "type": "string" }, "provider": { "type": "string" }, "webhook_secret": { "type": "string" } }, "type": "object" }, "serverIPResponse": { "properties": { "effective": { "type": "string" }, "source": { "type": "string" } }, "type": "object" }, "serverService": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "serverServicesResponse": { "properties": { "healthy": { "type": "integer" }, "services": { "items": { "$ref": "#/components/schemas/serverService" }, "type": "array" }, "total": { "type": "integer" } }, "type": "object" }, "serviceMetrics": { "properties": { "cpu_percent": { "type": "number" }, "domain": { "type": "string" }, "memory_limit": { "type": "integer" }, "memory_used": { "type": "integer" }, "port": { "type": "integer" }, "status": { "type": "string" }, "uptime_seconds": { "type": "integer" } }, "type": "object" }, "setChannelEnabledRequest": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" }, "setResourcesRequest": { "properties": { "cpu_limit": { "type": "number" }, "memory_limit": { "type": "integer" } }, "type": "object" }, "settingResponse": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "setupRequest": { "properties": { "email": { "type": "string" }, "instance_name": { "type": "string" }, "password": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "smtpSettingsRequest": { "properties": { "from_email": { "type": "string" }, "from_name": { "type": "string" }, "host": { "type": "string" }, "password": { "type": "string" }, "port": { "type": "integer" }, "tls_mode": { "type": "string" }, "user": { "type": "string" } }, "type": "object" }, "statsResponse": { "properties": { "app_health": { "$ref": "#/components/schemas/healthRatio" }, "config_warnings": { "items": { "$ref": "#/components/schemas/Warning" }, "type": "array" }, "deploy_7d": { "$ref": "#/components/schemas/deploy7dStats" }, "host": { "anyOf": [ { "$ref": "#/components/schemas/HostMetricPoint" }, { "type": "null" } ] }, "is_admin": { "type": "boolean" }, "needs_attention": { "$ref": "#/components/schemas/needsAttention" } }, "type": "object" }, "templateDetail": { "properties": { "category": { "type": "string" }, "database_specs": { "items": { "$ref": "#/components/schemas/dbSpec" }, "type": "array" }, "databases": { "type": "integer" }, "description": { "type": "string" }, "docs_url": { "type": "string" }, "id": { "type": "string" }, "inputs": { "items": { "$ref": "#/components/schemas/Input" }, "type": "array" }, "logo_url": { "type": "string" }, "name": { "type": "string" }, "needs_hostname": { "type": "boolean" }, "notes": { "type": "string" }, "service_names": { "items": { "type": "string" }, "type": "array" }, "services": { "type": "integer" }, "tags": { "items": { "type": "string" }, "type": "array" }, "version": { "type": "string" }, "website": { "type": "string" } }, "type": "object" }, "templateSummary": { "properties": { "category": { "type": "string" }, "databases": { "type": "integer" }, "description": { "type": "string" }, "docs_url": { "type": "string" }, "id": { "type": "string" }, "logo_url": { "type": "string" }, "name": { "type": "string" }, "services": { "type": "integer" }, "tags": { "items": { "type": "string" }, "type": "array" }, "version": { "type": "string" }, "website": { "type": "string" } }, "type": "object" }, "testChannelParamsRequest": { "properties": { "config": { "description": "arbitrary JSON — see the handler for the exact shape" }, "id": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "testSMTPRequest": { "properties": { "from_email": { "type": "string" }, "from_name": { "type": "string" }, "host": { "type": "string" }, "password": { "type": "string" }, "port": { "type": "integer" }, "tls_mode": { "type": "string" }, "to": { "type": "string" }, "user": { "type": "string" } }, "type": "object" }, "transferProjectRequest": { "properties": { "user_id": { "type": "string" } }, "type": "object" }, "updateAlertPreferencesRequest": { "properties": { "build_failures": { "type": "boolean" }, "deploy_failures": { "type": "boolean" }, "deploy_success": { "type": "boolean" }, "quota_threshold": { "type": "boolean" }, "quota_threshold_percent": { "type": "integer" } }, "type": "object" }, "updateApplicationRequest": { "properties": { "branch": { "type": [ "string", "null" ] }, "build_type_override": { "type": [ "string", "null" ] }, "builder_image": { "type": [ "string", "null" ] }, "cpu_limit": { "type": "number" }, "dockerfile_path": { "type": [ "string", "null" ] }, "git_integration_id": { "type": [ "string", "null" ] }, "git_token": { "type": "string" }, "health_check_path": { "type": "string" }, "memory_limit": { "type": "integer" }, "name": { "type": "string" }, "root_directory": { "type": [ "string", "null" ] }, "source_image": { "type": [ "string", "null" ] }, "source_repo": { "type": [ "string", "null" ] } }, "type": "object" }, "updateBackupRemoteRequest": { "properties": { "access_key": { "type": "string" }, "bucket": { "type": "string" }, "enabled": { "type": [ "boolean", "null" ] }, "endpoint": { "type": "string" }, "prefix": { "type": "string" }, "region": { "type": "string" }, "secret_key": { "type": "string" }, "use_ssl": { "type": [ "boolean", "null" ] } }, "type": "object" }, "updateDatabaseRequest": { "properties": { "cpu_limit": { "type": "number" }, "memory_limit": { "type": "integer" } }, "type": "object" }, "updateDomainRequest": { "properties": { "advanced_config": { "description": "arbitrary JSON — see the handler for the exact shape" }, "certificate_id": { "type": "string" }, "container_port": { "type": [ "integer", "null" ] }, "force_https": { "type": "boolean" }, "hostname": { "type": "string" }, "internal_path": { "type": [ "string", "null" ] }, "path": { "type": [ "string", "null" ] }, "ssl_enabled": { "type": "boolean" }, "ssl_mode": { "type": "string" }, "ssl_provider": { "type": "string" }, "strip_path": { "type": [ "boolean", "null" ] } }, "type": "object" }, "updateEnvVarsRequest": { "properties": { "vars": { "items": { "$ref": "#/components/schemas/envVarInput" }, "type": "array" } }, "type": "object" }, "updateFileMountRequest": { "properties": { "content": { "type": [ "string", "null" ] }, "file_mode": { "type": "string" }, "is_secret": { "type": "boolean" } }, "type": "object" }, "updateProfileRequest": { "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "updateProjectRequest": { "properties": { "name": { "type": "string" } }, "type": "object" }, "updateProjectSharingRequest": { "properties": { "shared": { "type": "boolean" } }, "type": "object" }, "updateRuntimeRequest": { "properties": { "container_caps": { "type": "string" }, "readonly_rootfs": { "type": "boolean" } }, "type": "object" }, "updateUserRoleRequest": { "properties": { "role": { "type": "string" } }, "type": "object" }, "updateWebhookRequest": { "properties": { "auto_deploy_branch": { "type": [ "string", "null" ] }, "webhook_secret": { "type": [ "string", "null" ] } }, "type": "object" }, "upgradeDatabaseRequest": { "properties": { "target_version": { "type": "string" } }, "type": "object" }, "uploadCertificateRequest": { "properties": { "cert_pem": { "type": "string" }, "key_pem": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "upsertQuotaRequest": { "properties": { "max_applications": { "type": [ "integer", "null" ] }, "max_cpu": { "type": [ "number", "null" ] }, "max_memory_mb": { "type": [ "integer", "null" ] } }, "type": "object" }, "upsertRouteFeatureRequest": { "properties": { "config": { "description": "arbitrary JSON — see the handler for the exact shape" }, "enabled": { "type": "boolean" }, "feature_type": { "type": "string" } }, "type": "object" }, "verifyEnrollmentRequest": { "properties": { "code": { "type": "string" } }, "type": "object" }, "versionResponse": { "properties": { "updating": { "type": "boolean" }, "updating_for": { "type": "integer" }, "version": { "type": "string" } }, "type": "object" }, "volumeBackupConfigRequest": { "properties": { "destination_id": { "type": "string" }, "enabled": { "type": [ "boolean", "null" ] }, "keep_latest": { "type": [ "integer", "null" ] }, "prefix": { "type": "string" }, "quiesce": { "type": "boolean" }, "schedule": { "type": "string" } }, "type": "object" }, "volumeBackupConfigResponse": { "properties": { "application_volume_id": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "destination_id": { "type": "string" }, "enabled": { "type": "boolean" }, "id": { "type": "string" }, "keep_latest": { "type": [ "integer", "null" ] }, "last_run_at": { "format": "date-time", "type": [ "string", "null" ] }, "prefix": { "type": "string" }, "quiesce": { "type": "boolean" }, "schedule": { "type": "string" } }, "type": "object" }, "volumeBackupResponse": { "properties": { "config_id": { "type": "string" }, "error": { "type": "string" }, "finished_at": { "format": "date-time", "type": [ "string", "null" ] }, "has_remote": { "type": "boolean" }, "id": { "type": "string" }, "log": { "type": "string" }, "size_bytes": { "type": "integer" }, "started_at": { "format": "date-time", "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "volumeInfo": { "properties": { "name": { "type": "string" }, "size_bytes": { "type": "integer" } }, "type": "object" }, "volumeRestoreResponse": { "properties": { "backup_id": { "type": "string" }, "error": { "type": "string" }, "finished_at": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "type": "string" }, "log": { "type": "string" }, "started_at": { "format": "date-time", "type": "string" }, "status": { "type": "string" } }, "type": "object" } }, "securitySchemes": { "deploy": { "type": "http", "scheme": "bearer", "description": "Personal access token whose scope satisfies `deploy` — deploy or write qualify." }, "metrics": { "type": "http", "scheme": "bearer", "description": "Personal access token whose scope satisfies `metrics` — metrics, read, deploy, or write all qualify (Belune's scopes form a total order)." }, "read": { "type": "http", "scheme": "bearer", "description": "Personal access token whose scope satisfies `read` — read, deploy, or write all qualify." }, "session": { "type": "http", "scheme": "bearer", "description": "Dashboard session JWT — satisfies every scope requirement unconditionally." }, "write": { "type": "http", "scheme": "bearer", "description": "Personal access token whose scope satisfies `write`." } } } }