{ "openapi": "3.0.3", "info": { "title": "CloudAuro API", "version": "0.1.0", "description": "Secure static hosting MVP. Cookie mutations require a CSRF token from /api/auth/csrf. /api/data requires scoped bearer tokens, never session authentication. Billing activates only after signed Stripe events and current paid invoice checks. Lists use page and limit, default 25 and maximum 100. Error envelope includes error.code and error.message." }, "servers": [ { "url": "https://cloudauro.com" }, { "url": "http://localhost:5000" } ], "paths": { "/api/auth/csrf": { "get": { "operationId": "get_api_auth_csrf", "summary": "GET /api/auth/csrf", "tags": [ "auth" ], "security": [], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } } }, "/api/auth/register": { "post": { "operationId": "post_api_auth_register", "summary": "POST /api/auth/register", "tags": [ "auth" ], "security": [ { "csrfHeader": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "name": { "type": "string", "maxLength": 100 }, "password": { "type": "string", "minLength": 12, "maxLength": 128 }, "plan": { "type": "string", "enum": [ "free", "basic", "pro", "business" ] } } } } } } } }, "/api/auth/login": { "post": { "operationId": "post_api_auth_login", "summary": "POST /api/auth/login", "tags": [ "auth" ], "security": [ { "csrfHeader": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string" } } } } } } } }, "/api/auth/logout": { "post": { "operationId": "post_api_auth_logout", "summary": "POST /api/auth/logout", "tags": [ "auth" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/api/auth/verify-request": { "post": { "operationId": "post_api_auth_verify-request", "summary": "POST /api/auth/verify-request", "tags": [ "auth" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/api/auth/reset-request": { "post": { "operationId": "post_api_auth_reset-request", "summary": "POST /api/auth/reset-request", "tags": [ "auth" ], "security": [ { "csrfHeader": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" } } } } } } } }, "/api/auth/verify": { "post": { "operationId": "post_api_auth_verify", "summary": "POST /api/auth/verify", "tags": [ "auth" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[0-9]{6}$", "description": "Six-digit email code. Requires the matching signed-in account; expires after 10 minutes." } } } } } } } }, "/api/auth/reset": { "post": { "operationId": "post_api_auth_reset", "summary": "POST /api/auth/reset", "tags": [ "auth" ], "security": [ { "csrfHeader": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" }, "password": { "type": "string", "minLength": 12, "maxLength": 128 } } } } } } } }, "/api/profile": { "delete": { "operationId": "delete_api_profile", "summary": "DELETE /api/profile", "tags": [ "profile" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "currentPassword": { "type": "string" }, "newPassword": { "type": "string", "minLength": 12 }, "confirmation": { "type": "string" }, "password": { "type": "string" } } } } } } }, "get": { "operationId": "get_api_profile", "summary": "GET /api/profile", "tags": [ "profile" ], "security": [ { "cookieSession": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } }, "patch": { "operationId": "patch_api_profile", "summary": "PATCH /api/profile", "tags": [ "profile" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "currentPassword": { "type": "string" }, "newPassword": { "type": "string", "minLength": 12 }, "confirmation": { "type": "string" }, "password": { "type": "string" } } } } } } } }, "/api/plans": { "get": { "operationId": "get_api_plans", "summary": "GET /api/plans", "tags": [ "plans" ], "security": [], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } } }, "/api/usage": { "get": { "operationId": "get_api_usage", "summary": "GET /api/usage", "tags": [ "usage" ], "security": [ { "cookieSession": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } } }, "/api/dashboard": { "get": { "operationId": "get_api_dashboard", "summary": "GET /api/dashboard", "tags": [ "dashboard" ], "security": [ { "cookieSession": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } } }, "/api/websites": { "get": { "operationId": "get_api_websites", "summary": "GET /api/websites", "tags": [ "websites" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } }, "post": { "operationId": "post_api_websites", "summary": "POST /api/websites", "tags": [ "websites" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 } } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "name", "files" ], "properties": { "assetFolder": { "type": "string", "maxLength": 200, "description": "Optional destination prefix for individual non-HTML files. HTML stays at its original path. Leave blank for ZIP archives." }, "name": { "type": "string", "maxLength": 100 }, "files": { "type": "array", "items": { "type": "string", "format": "binary" } } } } } } } } }, "/api/websites/{site_id}": { "delete": { "operationId": "delete_api_websites_site_id", "summary": "DELETE /api/websites/{site_id}", "tags": [ "websites" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "site_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "PATCH false to take offline; true to restore a ready deployment with an active hosting entitlement. Files and database remain stored; billing continues." }, "name": { "type": "string" }, "confirmation": { "type": "string", "enum": [ "DELETE" ] } } } } } } }, "get": { "operationId": "get_api_websites_site_id", "summary": "GET /api/websites/{site_id}", "tags": [ "websites" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "site_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } }, "patch": { "operationId": "patch_api_websites_site_id", "summary": "PATCH /api/websites/{site_id}", "tags": [ "websites" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "site_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "PATCH false to take offline; true to restore a ready deployment with an active hosting entitlement. Files and database remain stored; billing continues." }, "name": { "type": "string" }, "confirmation": { "type": "string", "enum": [ "DELETE" ] } } } } } } } }, "/api/websites/{site_id}/uploads": { "post": { "operationId": "post_api_websites_site_id_uploads", "summary": "POST /api/websites/{site_id}/uploads", "tags": [ "websites" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "site_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "files" ], "properties": { "files": { "type": "array", "items": { "type": "string", "format": "binary" } }, "mode": { "type": "string", "enum": [ "replace", "merge" ], "default": "replace" }, "baseDeployment": { "type": "string", "description": "Required in merge mode; must match the published deployment UUID." } } } } } } } }, "/api/websites/{site_id}/files": { "delete": { "operationId": "delete_api_websites_site_id_files", "summary": "DELETE /api/websites/{site_id}/files", "tags": [ "websites" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "site_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "paths": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "Published file paths to delete. index.html cannot be deleted." }, "baseDeployment": { "type": "string", "format": "uuid", "description": "Required published deployment ID; stale edits are rejected." } } } } } } } }, "/api/websites/{site_id}/routes": { "get": { "operationId": "get_api_websites_site_id_routes", "summary": "GET /api/websites/{site_id}/routes", "tags": [ "websites" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "site_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } } }, "/api/websites/{site_id}/guardian/check": { "post": { "operationId": "post_api_websites_site_id_guardian_check", "summary": "POST /api/websites/{site_id}/guardian/check", "tags": [ "websites" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "site_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "description": "On-demand static inspection of the owned current ready deployment. Requires a verified account with active hosting and CSRF. Limited to 10 checks/account/hour, 200 HTML pages, 2 MB/page, 8 MB total and 100 findings. Returns deploymentId, status, findings and coverageComplete. Persists up to 20 bounded reports per project with release comparisons. No network requests, script execution, form submission or browser-journey verification. Automatic checks are queued after publication; email alerts are opt-in.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/api/websites/{site_id}/guardian/settings": { "get": { "operationId": "get_api_websites_site_id_guardian_settings", "summary": "GET /api/websites/{site_id}/guardian/settings", "tags": [ "websites" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "site_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } }, "patch": { "operationId": "patch_api_websites_site_id_guardian_settings", "summary": "PATCH /api/websites/{site_id}/guardian/settings", "tags": [ "websites" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "site_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "automatic": { "type": "boolean" }, "emailAlerts": { "type": "boolean" }, "protectedPages": { "type": "array", "maxItems": 20, "items": { "type": "object", "required": [ "path", "text" ], "properties": { "path": { "type": "string", "maxLength": 240 }, "text": { "type": "string", "minLength": 1, "maxLength": 200 } } } } } } } } } } }, "/api/websites/{site_id}/guardian/reports": { "get": { "operationId": "get_api_websites_site_id_guardian_reports", "summary": "GET /api/websites/{site_id}/guardian/reports", "tags": [ "websites" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "site_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } } }, "/api/websites/{site_id}/guardian/reports/{run_id}/export": { "get": { "operationId": "get_api_websites_site_id_guardian_reports_run_id_export", "summary": "GET /api/websites/{site_id}/guardian/reports/{run_id}/export", "tags": [ "websites" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "site_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } } }, "/api/websites/{site_id}/guardian/reports/{run_id}": { "get": { "operationId": "get_api_websites_site_id_guardian_reports_run_id", "summary": "GET /api/websites/{site_id}/guardian/reports/{run_id}", "tags": [ "websites" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "site_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } } }, "/api/websites/{site_id}/deployments": { "get": { "operationId": "get_api_websites_site_id_deployments", "summary": "GET /api/websites/{site_id}/deployments", "tags": [ "websites" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "site_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } } }, "/api/deployments/{deployment_id}": { "delete": { "operationId": "delete_api_deployments_deployment_id", "summary": "DELETE /api/deployments/{deployment_id}", "tags": [ "deployments" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "deployment_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/api/backups": { "get": { "operationId": "get_api_backups", "summary": "GET /api/backups", "tags": [ "backups" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } } }, "/api/backups/{day}": { "get": { "operationId": "get_api_backups_day", "summary": "GET /api/backups/{day}", "tags": [ "backups" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "day", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Private backup attachment", "content": { "application/gzip": { "schema": { "type": "string", "format": "binary" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } } }, "/api/websites/{site_id}/rollback": { "post": { "operationId": "post_api_websites_site_id_rollback", "summary": "POST /api/websites/{site_id}/rollback", "tags": [ "websites" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "site_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deploymentId": { "type": "string", "format": "uuid" } } } } } } } }, "/api/websites/{site_id}/domains": { "get": { "operationId": "get_api_websites_site_id_domains", "summary": "GET /api/websites/{site_id}/domains", "tags": [ "websites" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "site_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } }, "post": { "operationId": "post_api_websites_site_id_domains", "summary": "POST /api/websites/{site_id}/domains", "tags": [ "websites" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "site_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "hostname": { "type": "string", "example": "www.example.com" } } } } } } } }, "/api/domains/{domain_id}": { "delete": { "operationId": "delete_api_domains_domain_id", "summary": "DELETE /api/domains/{domain_id}", "tags": [ "domains" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } }, "post": { "operationId": "post_api_domains_domain_id", "summary": "POST /api/domains/{domain_id}", "tags": [ "domains" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/api/domains/{domain_id}/checks": { "get": { "operationId": "get_api_domains_domain_id_checks", "summary": "GET /api/domains/{domain_id}/checks", "tags": [ "domains" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } } }, "/api/admin/{resource}": { "get": { "operationId": "get_api_admin_resource", "summary": "GET /api/admin/{resource}", "tags": [ "admin" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "resource", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } } }, "/api/admin/users/{user_id}/suspend": { "post": { "operationId": "post_api_admin_users_user_id_suspend", "summary": "POST /api/admin/users/{user_id}/suspend", "tags": [ "admin" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/api/admin/websites/{site_id}": { "delete": { "operationId": "delete_api_admin_websites_site_id", "summary": "DELETE /api/admin/websites/{site_id}", "tags": [ "admin" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "site_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/api/subscription": { "get": { "operationId": "get_api_subscription", "summary": "GET /api/subscription", "tags": [ "subscription" ], "security": [ { "cookieSession": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } } }, "/api/billing/free": { "post": { "operationId": "post_api_billing_free", "summary": "POST /api/billing/free", "tags": [ "billing" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/api/billing/checkout": { "post": { "operationId": "post_api_billing_checkout", "summary": "POST /api/billing/checkout", "tags": [ "billing" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "planId": { "type": "string", "enum": [ "basic", "pro", "business" ] } } } } } } } }, "/api/billing/checkout/expire": { "post": { "operationId": "post_api_billing_checkout_expire", "summary": "POST /api/billing/checkout/expire", "tags": [ "billing" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/api/billing/portal": { "post": { "operationId": "post_api_billing_portal", "summary": "POST /api/billing/portal", "tags": [ "billing" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/api/billing/cancel": { "post": { "operationId": "post_api_billing_cancel", "summary": "POST /api/billing/cancel", "tags": [ "billing" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/api/billing/webhook": { "post": { "operationId": "post_api_billing_webhook", "summary": "POST /api/billing/webhook", "tags": [ "billing" ], "security": [], "parameters": [ { "name": "Stripe-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "Raw Stripe event payload. Signed with the webhook endpoint secret." } } } } } }, "/api/databases": { "get": { "operationId": "get_api_databases", "summary": "GET /api/databases", "tags": [ "databases" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } }, "post": { "operationId": "post_api_databases", "summary": "POST /api/databases", "tags": [ "databases" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "siteId": { "type": "string", "format": "uuid", "description": "Required: the website this database belongs to." }, "template": { "type": "string", "enum": [ "empty", "contacts", "newsletter" ] }, "tables": { "type": "array", "maxItems": 20, "description": "With template empty, atomically create named tables with columns and optional access mode.", "items": { "type": "object" } } } } } } } } }, "/api/websites/{site_id}/database": { "get": { "operationId": "get_api_websites_site_id_database", "summary": "GET /api/websites/{site_id}/database", "tags": [ "websites" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "site_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } }, "post": { "operationId": "post_api_websites_site_id_database", "summary": "POST /api/websites/{site_id}/database", "tags": [ "websites" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "site_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "template": { "type": "string", "enum": [ "empty", "contacts", "newsletter" ] }, "name": { "type": "string", "maxLength": 100 }, "databaseId": { "type": "string", "format": "uuid", "description": "Instead of name, link an existing unassigned database owned by this account." }, "tables": { "type": "array", "maxItems": 20, "description": "With template empty, atomically create named tables with columns and optional access mode.", "items": { "type": "object" } } } } } } } } }, "/api/databases/{database_id}/schema": { "get": { "operationId": "get_api_databases_database_id_schema", "summary": "GET /api/databases/{database_id}/schema", "tags": [ "databases" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } } }, "/api/databases/{database_id}": { "delete": { "operationId": "delete_api_databases_database_id", "summary": "DELETE /api/databases/{database_id}", "tags": [ "databases" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "confirmation": { "type": "string", "enum": [ "DELETE" ] } } } } } } } }, "/api/databases/{database_id}/tables": { "get": { "operationId": "get_api_databases_database_id_tables", "summary": "GET /api/databases/{database_id}/tables", "tags": [ "databases" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } }, "post": { "operationId": "post_api_databases_database_id_tables", "summary": "POST /api/databases/{database_id}/tables", "tags": [ "databases" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "columns": { "type": "object", "description": "1\u201320 custom fields: text, email, url, integer, number, boolean, date, datetime, json. Values are type strings or {type,required,default,maxLength}." }, "access": { "type": "string", "enum": [ "private", "public_read", "public_submit" ], "default": "private" } }, "required": [ "name", "columns" ] } } } } } }, "/api/databases/{database_id}/tokens": { "post": { "operationId": "post_api_databases_database_id_tokens", "summary": "POST /api/databases/{database_id}/tokens", "tags": [ "databases" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "string", "enum": [ "read", "write", "delete" ] } } } } } } } } }, "/api/databases/{database_id}/tokens/{token_id}": { "delete": { "operationId": "delete_api_databases_database_id_tokens_token_id", "summary": "DELETE /api/databases/{database_id}/tokens/{token_id}", "tags": [ "databases" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "token_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/api/databases/{database_id}/tables/{table_id}": { "delete": { "operationId": "delete_api_databases_database_id_tables_table_id", "summary": "DELETE /api/databases/{database_id}/tables/{table_id}", "tags": [ "databases" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "table_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "columns": { "type": "object", "description": "Field map: legacy type strings or {type,required,default,maxLength}. Populated tables allow additive optional/default fields only; online additions support up to 1000 existing rows." }, "access": { "type": "string", "enum": [ "private", "public_read", "public_submit" ] }, "confirmation": { "type": "string", "enum": [ "DELETE" ] } }, "required": [ "confirmation" ] } } } } }, "get": { "operationId": "get_api_databases_database_id_tables_table_id", "summary": "GET /api/databases/{database_id}/tables/{table_id}", "tags": [ "databases" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "table_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } }, "patch": { "operationId": "patch_api_databases_database_id_tables_table_id", "summary": "PATCH /api/databases/{database_id}/tables/{table_id}", "tags": [ "databases" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "table_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "columns": { "type": "object", "description": "Field map: legacy type strings or {type,required,default,maxLength}. Populated tables allow additive optional/default fields only; online additions support up to 1000 existing rows." }, "access": { "type": "string", "enum": [ "private", "public_read", "public_submit" ] }, "confirmation": { "type": "string", "enum": [ "DELETE" ] } }, "required": [] } } } } } }, "/api/data/{database_id}/tables/{table_id}/rows": { "get": { "operationId": "get_api_data_database_id_tables_table_id_rows", "summary": "GET /api/data/{database_id}/tables/{table_id}/rows", "tags": [ "data" ], "security": [ { "bearerToken": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "table_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } }, "post": { "operationId": "post_api_data_database_id_tables_table_id_rows", "summary": "POST /api/data/{database_id}/tables/{table_id}/rows", "tags": [ "data" ], "security": [ { "bearerToken": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "table_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "values": { "type": "object", "additionalProperties": true, "description": "Exactly the declared table columns with matching scalar types." } } } } } } } }, "/api/databases/{database_id}/tables/{table_id}/rows": { "get": { "operationId": "get_api_databases_database_id_tables_table_id_rows", "summary": "GET /api/databases/{database_id}/tables/{table_id}/rows", "tags": [ "databases" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "table_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } }, "post": { "operationId": "post_api_databases_database_id_tables_table_id_rows", "summary": "POST /api/databases/{database_id}/tables/{table_id}/rows", "tags": [ "databases" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "table_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "values": { "type": "object", "additionalProperties": true, "description": "Exactly the declared table columns with matching scalar types." } } } } } } } }, "/api/data/{database_id}/tables/{table_id}/rows/{row_id}": { "delete": { "operationId": "delete_api_data_database_id_tables_table_id_rows_row_id", "summary": "DELETE /api/data/{database_id}/tables/{table_id}/rows/{row_id}", "tags": [ "data" ], "security": [ { "bearerToken": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "row_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "table_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } }, "get": { "operationId": "get_api_data_database_id_tables_table_id_rows_row_id", "summary": "GET /api/data/{database_id}/tables/{table_id}/rows/{row_id}", "tags": [ "data" ], "security": [ { "bearerToken": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "row_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "table_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } }, "patch": { "operationId": "patch_api_data_database_id_tables_table_id_rows_row_id", "summary": "PATCH /api/data/{database_id}/tables/{table_id}/rows/{row_id}", "tags": [ "data" ], "security": [ { "bearerToken": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "row_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "table_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "values": { "type": "object", "additionalProperties": true, "description": "Exactly the declared table columns with matching scalar types." } } } } } } } }, "/api/databases/{database_id}/tables/{table_id}/rows/{row_id}": { "delete": { "operationId": "delete_api_databases_database_id_tables_table_id_rows_row_id", "summary": "DELETE /api/databases/{database_id}/tables/{table_id}/rows/{row_id}", "tags": [ "databases" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "row_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "table_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } }, "get": { "operationId": "get_api_databases_database_id_tables_table_id_rows_row_id", "summary": "GET /api/databases/{database_id}/tables/{table_id}/rows/{row_id}", "tags": [ "databases" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "row_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "table_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } }, "patch": { "operationId": "patch_api_databases_database_id_tables_table_id_rows_row_id", "summary": "PATCH /api/databases/{database_id}/tables/{table_id}/rows/{row_id}", "tags": [ "databases" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "row_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "table_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "values": { "type": "object", "additionalProperties": true, "description": "Exactly the declared table columns with matching scalar types." } } } } } } } }, "/api/databases/{database_id}/tables/{table_id}/staff-logins": { "get": { "operationId": "get_api_databases_database_id_tables_table_id_staff-logins", "summary": "GET /api/databases/{database_id}/tables/{table_id}/staff-logins", "tags": [ "databases" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "table_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "description": "Project manager only, CSRF protected. Password inputs are write-only Argon2id hashes at rest, never returned. Staff logins are scoped to the linked website/database and this Form inbox. POST requires name/email/password; PATCH accepts active and/or password and revokes sessions. Maximum 20 logins per database." }, "post": { "operationId": "post_api_databases_database_id_tables_table_id_staff-logins", "summary": "POST /api/databases/{database_id}/tables/{table_id}/staff-logins", "tags": [ "databases" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "table_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "email": { "type": "string", "format": "email" }, "password": { "type": "string", "minLength": 12, "maxLength": 128, "writeOnly": true } }, "required": [ "name", "email", "password" ] } } } }, "description": "Project manager only, CSRF protected. Password inputs are write-only Argon2id hashes at rest, never returned. Staff logins are scoped to the linked website/database and this Form inbox. POST requires name/email/password; PATCH accepts active and/or password and revokes sessions. Maximum 20 logins per database." } }, "/api/databases/{database_id}/tables/{table_id}/staff-logins/{login_id}": { "patch": { "operationId": "patch_api_databases_database_id_tables_table_id_staff-logins_login_id", "summary": "PATCH /api/databases/{database_id}/tables/{table_id}/staff-logins/{login_id}", "tags": [ "databases" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "database_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "login_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "table_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "active": { "type": "boolean" }, "password": { "type": "string", "minLength": 12, "maxLength": 128, "writeOnly": true } } } } } }, "description": "Project manager only, CSRF protected. Password inputs are write-only Argon2id hashes at rest, never returned. Staff logins are scoped to the linked website/database and this Form inbox. POST requires name/email/password; PATCH accepts active and/or password and revokes sessions. Maximum 20 logins per database." } }, "/api/docs/{slug}": { "put": { "operationId": "put_api_docs_slug", "summary": "PUT /api/docs/{slug}", "tags": [ "docs" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 150 }, "category": { "type": "string", "maxLength": 60 }, "body": { "type": "string", "maxLength": 40000 }, "version": { "type": "integer", "minimum": 0, "description": "0 for a new/default guide; current article version for updates. Requires verified developer access." } } } } } } } }, "/api/support/staff": { "get": { "operationId": "get_api_support_staff", "summary": "GET /api/support/staff", "tags": [ "support" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "description": "POST /api/support/tickets accepts public contact submissions with CSRF and rate limits. Other ticket operations require an authorized developer, verified admin, or support role. Staff list/grant/revoke require an authorized developer or administrator; support staff cannot manage roles. No ticket read access is granted by knowing a ticket ID. Replies are persisted and queued to SMTP; inbound email replies are not imported." }, "post": { "operationId": "post_api_support_staff", "summary": "POST /api/support/staff", "tags": [ "support" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "description": "POST /api/support/tickets accepts public contact submissions with CSRF and rate limits. Other ticket operations require an authorized developer, verified admin, or support role. Staff list/grant/revoke require an authorized developer or administrator; support staff cannot manage roles. No ticket read access is granted by knowing a ticket ID. Replies are persisted and queued to SMTP; inbound email replies are not imported.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "description": "Existing verified customer account to grant support-only access. Requires verified operator-configured developer or administrator." } } } } } } } }, "/api/support/staff/{user_id}": { "delete": { "operationId": "delete_api_support_staff_user_id", "summary": "DELETE /api/support/staff/{user_id}", "tags": [ "support" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "description": "POST /api/support/tickets accepts public contact submissions with CSRF and rate limits. Other ticket operations require an authorized developer, verified admin, or support role. Staff list/grant/revoke require an authorized developer or administrator; support staff cannot manage roles. No ticket read access is granted by knowing a ticket ID. Replies are persisted and queued to SMTP; inbound email replies are not imported.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "confirmation": { "type": "string", "enum": [ "REVOKE" ] } } } } } } } }, "/api/support/tickets": { "post": { "operationId": "post_api_support_tickets", "summary": "POST /api/support/tickets", "tags": [ "support" ], "security": [ { "csrfHeader": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "description": "POST /api/support/tickets accepts public contact submissions with CSRF and rate limits. Other ticket operations require an authorized developer, verified admin, or support role. Staff list/grant/revoke require an authorized developer or administrator; support staff cannot manage roles. No ticket read access is granted by knowing a ticket ID. Replies are persisted and queued to SMTP; inbound email replies are not imported.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "email": { "type": "string", "format": "email" }, "subject": { "type": "string", "maxLength": 150 }, "message": { "type": "string", "maxLength": 8000 }, "requestId": { "type": "string", "format": "uuid", "description": "Client-generated idempotency key; not a ticket-access credential." } } } } } } }, "get": { "operationId": "get_api_support_tickets", "summary": "GET /api/support/tickets", "tags": [ "support" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "description": "POST /api/support/tickets accepts public contact submissions with CSRF and rate limits. Other ticket operations require an authorized developer, verified admin, or support role. Staff list/grant/revoke require an authorized developer or administrator; support staff cannot manage roles. No ticket read access is granted by knowing a ticket ID. Replies are persisted and queued to SMTP; inbound email replies are not imported." } }, "/api/support/tickets/{ticket_id}": { "get": { "operationId": "get_api_support_tickets_ticket_id", "summary": "GET /api/support/tickets/{ticket_id}", "tags": [ "support" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "ticket_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "description": "POST /api/support/tickets accepts public contact submissions with CSRF and rate limits. Other ticket operations require an authorized developer, verified admin, or support role. Staff list/grant/revoke require an authorized developer or administrator; support staff cannot manage roles. No ticket read access is granted by knowing a ticket ID. Replies are persisted and queued to SMTP; inbound email replies are not imported." }, "patch": { "operationId": "patch_api_support_tickets_ticket_id", "summary": "PATCH /api/support/tickets/{ticket_id}", "tags": [ "support" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "ticket_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "description": "POST /api/support/tickets accepts public contact submissions with CSRF and rate limits. Other ticket operations require an authorized developer, verified admin, or support role. Staff list/grant/revoke require an authorized developer or administrator; support staff cannot manage roles. No ticket read access is granted by knowing a ticket ID. Replies are persisted and queued to SMTP; inbound email replies are not imported.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "open", "closed" ] } } } } } } } }, "/api/support/tickets/{ticket_id}/messages": { "get": { "operationId": "get_api_support_tickets_ticket_id_messages", "summary": "GET /api/support/tickets/{ticket_id}/messages", "tags": [ "support" ], "security": [ { "cookieSession": [] } ], "parameters": [ { "name": "ticket_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "description": "POST /api/support/tickets accepts public contact submissions with CSRF and rate limits. Other ticket operations require an authorized developer, verified admin, or support role. Staff list/grant/revoke require an authorized developer or administrator; support staff cannot manage roles. No ticket read access is granted by knowing a ticket ID. Replies are persisted and queued to SMTP; inbound email replies are not imported." } }, "/api/support/tickets/{ticket_id}/replies": { "post": { "operationId": "post_api_support_tickets_ticket_id_replies", "summary": "POST /api/support/tickets/{ticket_id}/replies", "tags": [ "support" ], "security": [ { "cookieSession": [], "csrfHeader": [] } ], "parameters": [ { "name": "ticket_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "202": { "description": "Queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "402": { "description": "Subscription required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "403": { "description": "Permission or CSRF denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "409": { "description": "Conflict or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "413": { "description": "Upload limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "503": { "description": "Service not configured", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } }, "description": "POST /api/support/tickets accepts public contact submissions with CSRF and rate limits. Other ticket operations require an authorized developer, verified admin, or support role. Staff list/grant/revoke require an authorized developer or administrator; support staff cannot manage roles. No ticket read access is granted by knowing a ticket ID. Replies are persisted and queued to SMTP; inbound email replies are not imported.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "maxLength": 8000 }, "requestId": { "type": "string", "format": "uuid" } } } } } } } }, "/__cloudauro/data/{table_name}/rows": { "get": { "summary": "Website table records", "description": "Call on the published website origin, never the management host. private denies all visitor access; public_read permits GET; public_submit permits POST, plus GET for an active staff login scoped to that inbox. No bearer token is accepted or needed. Limits: 120 requests/IP/site/minute; public submissions 20/IP/hour and 300/site/hour.", "servers": [ { "url": "https://your-published-website.example" } ], "parameters": [ { "name": "table_name", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" } }, { "name": "page", "in": "query", "schema": { "type": "string" }, "description": "equals is JSON; sort may start with - for descending." }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "description": "equals is JSON; sort may start with - for descending." }, { "name": "field", "in": "query", "schema": { "type": "string" }, "description": "equals is JSON; sort may start with - for descending." }, { "name": "equals", "in": "query", "schema": { "type": "string" }, "description": "equals is JSON; sort may start with - for descending." }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "description": "equals is JSON; sort may start with - for descending." } ], "security": [], "responses": { "200": { "description": "Success" }, "201": { "description": "Created" }, "400": { "description": "Validation failed" }, "401": { "description": "Website sign-in required" }, "403": { "description": "Access or origin denied" }, "404": { "description": "Table or owned row missing" }, "413": { "description": "Size/storage exceeded" }, "429": { "description": "Rate limited" } }, "operationId": "get___cloudauro_data_table_name_rows" }, "post": { "summary": "Website table records", "description": "Call on the published website origin, never the management host. private denies all visitor access; public_read permits GET; public_submit permits POST, plus GET for an active staff login scoped to that inbox. No bearer token is accepted or needed. Limits: 120 requests/IP/site/minute; public submissions 20/IP/hour and 300/site/hour.", "servers": [ { "url": "https://your-published-website.example" } ], "parameters": [ { "name": "table_name", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" } }, { "name": "X-CloudAuro-Data", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "1" ] } } ], "security": [], "responses": { "200": { "description": "Success" }, "201": { "description": "Created" }, "400": { "description": "Validation failed" }, "401": { "description": "Website sign-in required" }, "403": { "description": "Access or origin denied" }, "404": { "description": "Table or owned row missing" }, "413": { "description": "Size/storage exceeded" }, "429": { "description": "Rate limited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "values": { "type": "object" } }, "description": "POST supplies values; PATCH merges provided values; DELETE supplies {}. Browser Origin must match the website." } } } }, "operationId": "post___cloudauro_data_table_name_rows" } }, "/__cloudauro/data/{table_name}/rows/{row_id}": { "get": { "summary": "Website table records", "description": "Call on the published website origin, never the management host. private denies all visitor access; public_read permits GET; public_submit permits POST, plus GET for an active staff login scoped to that inbox. No bearer token is accepted or needed. Limits: 120 requests/IP/site/minute; public submissions 20/IP/hour and 300/site/hour.", "servers": [ { "url": "https://your-published-website.example" } ], "parameters": [ { "name": "table_name", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" } }, { "name": "row_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [], "responses": { "200": { "description": "Success" }, "201": { "description": "Created" }, "400": { "description": "Validation failed" }, "401": { "description": "Website sign-in required" }, "403": { "description": "Access or origin denied" }, "404": { "description": "Table or owned row missing" }, "413": { "description": "Size/storage exceeded" }, "429": { "description": "Rate limited" } }, "operationId": "get___cloudauro_data_table_name_rows_row_id" }, "patch": { "summary": "Website table records", "description": "Call on the published website origin, never the management host. private denies all visitor access; public_read permits GET; public_submit permits POST, plus GET for an active staff login scoped to that inbox. No bearer token is accepted or needed. Limits: 120 requests/IP/site/minute; public submissions 20/IP/hour and 300/site/hour.", "servers": [ { "url": "https://your-published-website.example" } ], "parameters": [ { "name": "table_name", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" } }, { "name": "row_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "X-CloudAuro-Data", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "1" ] } } ], "security": [], "responses": { "200": { "description": "Success" }, "201": { "description": "Created" }, "400": { "description": "Validation failed" }, "401": { "description": "Website sign-in required" }, "403": { "description": "Access or origin denied" }, "404": { "description": "Table or owned row missing" }, "413": { "description": "Size/storage exceeded" }, "429": { "description": "Rate limited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "values": { "type": "object" } }, "description": "POST supplies values; PATCH merges provided values; DELETE supplies {}. Browser Origin must match the website." } } } }, "operationId": "patch___cloudauro_data_table_name_rows_row_id" }, "delete": { "summary": "Website table records", "description": "Call on the published website origin, never the management host. private denies all visitor access; public_read permits GET; public_submit permits POST, plus GET for an active staff login scoped to that inbox. No bearer token is accepted or needed. Limits: 120 requests/IP/site/minute; public submissions 20/IP/hour and 300/site/hour.", "servers": [ { "url": "https://your-published-website.example" } ], "parameters": [ { "name": "table_name", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" } }, { "name": "row_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "X-CloudAuro-Data", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "1" ] } } ], "security": [], "responses": { "200": { "description": "Success" }, "201": { "description": "Created" }, "400": { "description": "Validation failed" }, "401": { "description": "Website sign-in required" }, "403": { "description": "Access or origin denied" }, "404": { "description": "Table or owned row missing" }, "413": { "description": "Size/storage exceeded" }, "429": { "description": "Rate limited" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "values": { "type": "object" } }, "description": "POST supplies values; PATCH merges provided values; DELETE supplies {}. Browser Origin must match the website." } } } }, "operationId": "delete___cloudauro_data_table_name_rows_row_id" } }, "/__cloudauro/staff/login": { "post": { "summary": "Staff login", "description": "Published website origin only. Manager-created staff logins protect assigned form inboxes. Server checks the current site/database, active login, and Form inbox binding. Sessions last 12 hours; disable/reset revokes sessions. No public staff signup.", "servers": [ { "url": "https://your-published-website.example" } ], "security": [], "responses": { "200": { "description": "Success" }, "400": { "description": "Invalid fields" }, "401": { "description": "Wrong credentials or signed out" }, "403": { "description": "Origin or inbox denied" }, "404": { "description": "Database or endpoint missing" }, "429": { "description": "Rate limited" } }, "parameters": [ { "name": "X-CloudAuro-Staff", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "1" ] } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string", "writeOnly": true } }, "required": [ "email", "password" ], "additionalProperties": false } } } }, "operationId": "post___cloudauro_staff_login" } }, "/__cloudauro/staff/me": { "get": { "summary": "Staff me", "description": "Published website origin only. Manager-created staff logins protect assigned form inboxes. Server checks the current site/database, active login, and Form inbox binding. Sessions last 12 hours; disable/reset revokes sessions. No public staff signup.", "servers": [ { "url": "https://your-published-website.example" } ], "security": [ { "staffSession": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Invalid fields" }, "401": { "description": "Wrong credentials or signed out" }, "403": { "description": "Origin or inbox denied" }, "404": { "description": "Database or endpoint missing" }, "429": { "description": "Rate limited" } }, "operationId": "get___cloudauro_staff_me" } }, "/__cloudauro/staff/logout": { "post": { "summary": "Staff logout", "description": "Published website origin only. Manager-created staff logins protect assigned form inboxes. Server checks the current site/database, active login, and Form inbox binding. Sessions last 12 hours; disable/reset revokes sessions. No public staff signup.", "servers": [ { "url": "https://your-published-website.example" } ], "security": [ { "staffSession": [] } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Invalid fields" }, "401": { "description": "Wrong credentials or signed out" }, "403": { "description": "Origin or inbox denied" }, "404": { "description": "Database or endpoint missing" }, "429": { "description": "Rate limited" } }, "parameters": [ { "name": "X-CloudAuro-Staff", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "1" ] } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": false } } } }, "operationId": "post___cloudauro_staff_logout" } } }, "components": { "securitySchemes": { "cookieSession": { "type": "apiKey", "in": "cookie", "name": "__Host-cloudauro", "description": "Local development uses cloudauro_dev; login creates a revocable server session." }, "csrfHeader": { "type": "apiKey", "in": "header", "name": "X-CSRF-Token" }, "bearerToken": { "type": "http", "scheme": "bearer", "description": "Database-scoped server-only token. Never embed it in public HTML or browser JavaScript. The website SDK uses explicit table rules and staff cookies instead." }, "staffSession": { "type": "apiKey", "in": "cookie", "name": "__Host-cauro_staff_", "description": "Host-only HttpOnly SameSite=Strict staff session. Manager-created logins; no signup endpoint." } }, "schemas": { "Envelope": { "type": "object", "required": [ "data", "error" ], "properties": { "data": { "nullable": true }, "error": { "type": "object", "nullable": true, "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }