{ "openapi": "3.0.2", "info": { "title": "REST API", "description": "Last modification: 2025-11-10\n\n## Changelog\n### v3.1.1 (2025-11-10)\n- [`GET \/customers\/{id}\/domains`](#get-\/customers\/-id-\/domains): added documentation (API endpoint not modified)\n- [`POST \/customers\/{id}\/domains`](#post-\/customers\/-id-\/domains): added documentation (API endpoint not modified)\n- [`GET \/customers\/{id}\/domains\/{domain}`](#get-\/customers\/-id-\/domains\/-domain-): added documentation (API endpoint not modified)\n- [`PATCH \/customers\/{id}\/domains\/{domain}`](#patch-\/customers\/-id-\/domains\/-domain-): added documentation (API endpoint not modified)\n- [`DELETE \/customers\/{id}\/domains\/{domain}`](#delete-\/customers\/-id-\/domains\/-domain-): added documentation (API endpoint not modified)\n\n### v3.0.8 (2025-10-13)\n- [`POST \/domains\/{domain}\/{host}\/dyndns`](#post-\/domains\/-domain-\/-host-\/dyndns): relaxed constraints for dynamic DNS user name (1-40 ASCII characters)\n\n### v3.0.0 (2025-07-28)\n- [`GET \/servers\/{id}`](#get-\/servers\/-id-): moved `lcLicenseSerial` to `license.serial`, added `license.trial`\n\n### v3.0.0-rc12 (2025-07-16)\n- added option `show=short` to [`GET \/accounts`](#get-\/accounts)\n- removed endpoint `GET \/servers\/{id}\/web\/{software}\/ipgroups` (data is already returned by [`GET \/servers\/{id}\/web`](#get-\/servers\/-id-\/web))\n- modified endpoint [`GET \/servers\/{id}\/web`](#get-\/servers\/-id-\/web) (property `ipGroups` now assigned to respective software)\n", "version": "3.0.0" }, "servers": [ { "url": "https:\/\/{hostname}:{port}\/api\/v1", "description": "LiveConfig server", "variables": { "hostname": { "default": "localhost" }, "port": { "enum": [ 443, 8443 ], "default": 8443 } } } ], "paths": { "\/accounts": { "get": { "tags": [ "Accounts" ], "summary": "Get account list", "description": "This method returns a list of all accounts. \nIf the query parameter `show=new` is set, instead a list of templates and ressources for new accounts is returned. \nIf `show=new-db` is set, a list of accounts for creating a new database is returned.\n", "parameters": [ { "name": "count", "in": "query", "description": "number of results to return", "schema": { "minimum": 1, "type": "integer" } }, { "name": "page", "in": "query", "description": "page to return (offset), starting with `1`", "schema": { "minimum": 1, "type": "integer" } }, { "name": "search", "in": "query", "description": "search phrase (is matched against account data)", "schema": { "type": "string" } }, { "name": "show", "in": "query", "description": "- `new`: return data for new accounts (list of available features, templates, resources, etc.)\n- `new-db`: return list of accounts for creating a new database\n- `new-domain`: return list of accounts for adding a new domain\n- `short`: return compact list of accounts (currently only containing account name)\n", "schema": { "enum": [ "new", "new-db", "new-domain", "short" ], "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 1 }, "data": { "type": "array", "items": { "allOf": [ { "allOf": [ { "type": "object", "properties": { "api": { "type": "boolean", "description": "Account has API access", "example": false }, "apps": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web applications installed via AppInstaller (`-1`: unlimited)", "example": 5 }, "backup": { "type": "object", "properties": { "plans": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "backup plan ID", "example": "a1b2c3" }, "keep": { "maximum": 999, "minimum": 1, "type": "number", "description": "number of backups to keep", "example": 5 } } } }, "count": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of manually triggered backups allowed (`-1`: unlimited)", "example": 5 }, "wait": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Minimum time to wait between two manual backups (in minutes)", "example": 15 } } }, "cgi": { "type": "boolean", "description": "Permission for CGI scripts", "example": false }, "cronjobs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of cron jobs (`-1`: unlimited)", "example": 20 }, "customers": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of customers (`-1`: unlimited)", "example": 100 }, "databases": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of databases (`-1`: unlimited)", "example": 10 }, "dbExtAccess": { "type": "boolean", "description": "Allow enabling external database access", "example": false }, "dns": { "type": "boolean", "description": "Permission to edit DNS entries", "example": true }, "dynDns": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of subdomains with dynamic DNS feature", "example": 10 }, "extDomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed external domains (`-1`: unlimited)", "example": 5 }, "ftpAccounts": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of FTP accounts (`-1`: unlimited)", "example": 5 }, "lac": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true }, "memMax": { "minimum": -1, "type": "integer", "description": "maximum memory (RAM) in MB", "example": 2048 }, "tasksMax": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of processes & threads", "example": 2000 } }, "description": "LiveConfig Account Container (LAC) settings - only available with appropriate license. Currently these settings are only available for hosting accounts, not with hosting templates!" }, "logrotate": { "type": "object", "properties": { "compress": { "type": "boolean", "description": "Compress rotated log files", "example": true }, "filterIPv4": { "maximum": 4, "minimum": 0, "type": "number", "description": "number of bytes to filter from IPv4 addresses in access.log", "example": 1 }, "filterIPv6": { "maximum": 4, "minimum": 0, "type": "number", "description": "filter IPv6 addresses in access.log (0=no filtering, 1= filter last 32 bit, 2 = filter last 64 bit, 3 = filter last 96 bit, 4 = filter whole address)", "example": 2 }, "rotateInterval": { "enum": [ "hour", "day", "week", "month" ], "type": "string", "description": "Rotation interval (mutually exclusive with `rotateSize`)", "example": "week" }, "rotateSize": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Rotation size in MB (mutually exclusive with `rotateInterval`)", "example": 1024 }, "keepCount": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of rotated log files to keep (mutually exclusive with `keepDays`)", "example": 5 }, "keepDays": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of days to keep rotated log files (mutually exclusive with `keepCount`)", "example": 100 } }, "description": "Log rotation settings" }, "mailaddrs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of e-mail addresses (`-1`: unlimited)", "example": 250 }, "mailboxes": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of mailboxes (`-1`: unlimited)", "example": 50 }, "mailquota": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "E-mail storage quota (MiB, `-1`: unlimited)", "example": 10240 }, "php": { "enum": [ "no", "suPHP", "FastCGI", "mod_php", "FPM" ], "type": "string", "description": "PHP support (`suPHP` is deprecated, not available for new templates, `mod_php` is highly disregarded for security reasons).", "example": "FPM" }, "resaleable": { "type": "boolean", "description": "Permission to create subordinated resellers", "example": false }, "shell": { "enum": [ "no", "scponly", "shell", "webShell" ], "type": "string", "description": "Shell access (no, SFTP only, bash, web shell (implies bash))", "example": "no" }, "ssi": { "type": "boolean", "description": "Permission for server-side includes (SSI)", "example": true }, "subdomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed subdomains (`-1`: unlimited; `www` subdomain is not counted)", "example": 5 }, "tls": { "type": "boolean", "description": "Support for TLS\/SSL (https)", "example": true }, "tlsManagement": { "type": "boolean", "description": "allow management of TLS\/SSL certificates (requires `tls=true`)", "example": false }, "users": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web interface users (`-1`: unlimited)", "example": 5 }, "webspace": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Webspace (MiB) (`-1`: unlimited)", "example": 10240 } } }, { "type": "object", "properties": { "comment": { "type": "string", "description": "comment for this account" }, "name": { "type": "string", "description": "account name", "example": "web1" }, "path": { "type": "string", "description": "account path", "readOnly": true, "example": "\/var\/www\/web1" }, "flags": { "type": "array", "items": { "enum": [ "ftp", "cron", "term" ], "type": "string" }, "readOnly": true }, "resellerAccount": { "type": "string", "description": "name of the reseller account, with which this account was created", "example": "res1" }, "templateName": { "type": "string", "description": "template name where this account is based on (use either this or templateId for account creation)", "nullable": true, "example": "Wordpress Hosting" }, "templateId": { "type": "string", "description": "id of the template this account is based on (use either this or templateName for account creation)", "nullable": true, "example": "bIAzOg" }, "editable": { "type": "boolean", "description": "current user may edit this account", "readOnly": true, "example": true } } } ] }, { "type": "object", "properties": { "dbserver": { "type": "object", "properties": { "id": { "type": "string", "description": "host ID", "example": "localhost" }, "hostname": { "type": "string", "description": "database server name", "example": "web01.example.org" }, "description": { "type": "string", "description": "optional server description" }, "flags": { "type": "array", "items": { "enum": [ "offline" ], "type": "string" }, "description": "list of server flags" } }, "description": "database server details" }, "mailserver": { "type": "object", "properties": { "id": { "type": "string", "description": "host ID", "example": "localhost" }, "hostname": { "type": "string", "description": "mail server name", "example": "web01.example.org" }, "description": { "type": "string", "description": "optional server description" }, "flags": { "type": "array", "items": { "enum": [ "offline" ], "type": "string" }, "description": "list of server flags" } }, "description": "mail server details" }, "webserver": { "type": "object", "properties": { "id": { "type": "string", "description": "host ID", "example": "localhost" }, "hostname": { "type": "string", "description": "web server name", "example": "web01.example.org" }, "description": { "type": "string", "description": "optional server description" }, "flags": { "type": "array", "items": { "enum": [ "offline" ], "type": "string" }, "description": "list of server flags" } }, "description": "web server details" }, "override": { "type": "array", "items": { "enum": [ "users", "api", "webspace", "ftpAccounts", "php", "cgi", "ssi", "cronjobs", "shell", "databases", "subdomains", "dns", "dynDns", "extDomains", "mailaddrs", "mailboxes", "mailquota", "logRotate", "compress", "logKeep", "filterIPv4", "filterIPv6", "backupCount", "backupWait" ], "type": "string" }, "description": "List of properties with custom values (overriding values from template)" }, "usage": { "type": "object", "properties": { "customers": { "type": "number", "description": "only with reseller accounts: number of customers created", "example": 2 }, "databases": { "type": "number", "description": "number of databases created", "example": 3 }, "mailaddrs": { "type": "number", "description": "number of existing e-mail addresses", "example": 23 }, "mailaddrsAssigned": { "type": "number", "description": "only with reseller accounts: number of e-mail addresses assigned to accounts", "example": 200 }, "mailboxes": { "type": "number", "description": "number of existing mailboxes (POP3\/IMAP)", "example": 12 }, "mailboxesAssigned": { "type": "number", "description": "only with reseller accounts: number of mailboxes (POP3\/IMAP) assigned to accounts", "example": 150 }, "mailquota": { "type": "number", "description": "actual mailbox storage in use (MiB)", "example": 124 }, "mailquotaAssigned": { "type": "number", "description": "mailbox storage assigned to mailboxes (MiB)", "example": 2048 }, "webspaceFiles": { "type": "number", "description": "number of files in webspace", "example": 123 }, "webspaceUsed": { "type": "number", "description": "webspace usage (bytes)", "example": 10231035 }, "webspaceTs": { "type": "string", "description": "timestamp of last webspace usage update", "format": "date-time", "example": "2022-09-01T09:00:22+05" } }, "description": "current usage statistics" }, "primaryDomain": { "type": "object", "properties": { "name": { "type": "string", "description": "primary (sub)domain name" }, "link": { "enum": [ "", "http", "https" ], "type": "string", "description": "hint, if domain is available via _http_ or _https_" } } }, "stats": { "type": "object", "properties": { "software": { "enum": [ "AWStats", "Webalizer" ], "type": "string", "description": "webstatistics software", "example": "AWStats" }, "subdomain": { "type": "string", "description": "domain for webstatistics", "example": "stats.example.com" }, "user": { "type": "string", "description": "user name for webstatistics", "example": "user" }, "lang": { "type": "string", "description": "language for webstatistics", "example": "de" } }, "description": "webstatistics details" }, "status": { "type": "object", "properties": { "email": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of email", "example": "active" }, "webspace": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of webspace", "example": "suspended" }, "ftp": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of ftp", "example": "locked" } }, "description": "account status" }, "deleted": { "type": "boolean", "description": "is `true` if account is being deleted", "example": "true" }, "traffic": { "type": "object", "properties": { "currentMonth": { "type": "object", "properties": { "hits": { "type": "integer", "description": "website hits", "readOnly": true, "example": 12 }, "in": { "type": "integer", "description": "bytes received", "readOnly": true, "example": 78943532 }, "out": { "type": "integer", "description": "bytes sent", "readOnly": true, "example": 2536543542 }, "ts": { "type": "string", "description": "timestamp of last update", "format": "date", "readOnly": true, "example": "2025-04-15T00:00:00Z" } }, "description": "traffic summary for current month", "readOnly": true }, "lastMonth": { "type": "object", "properties": { "hits": { "type": "integer", "description": "website hits", "readOnly": true, "example": 12 }, "in": { "type": "integer", "description": "bytes received", "readOnly": true, "example": 78943532 }, "out": { "type": "integer", "description": "bytes sent", "readOnly": true, "example": 2536543542 }, "ts": { "type": "string", "description": "timestamp of last update", "format": "date", "readOnly": true, "example": "2025-04-15T00:00:00Z" } }, "description": "traffic summary for last month", "readOnly": true } }, "description": "traffic summary for this account", "readOnly": true } } } ] } } }, "description": "a list of all accounts" }, { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "features": { "type": "object", "properties": { "api": { "type": "boolean", "description": "API available", "example": false }, "apps": { "type": "boolean", "description": "application installer available", "example": false }, "backupPlans": { "type": "array", "items": { "type": "string" }, "description": "list of available automated backup plans" }, "cgi": { "type": "boolean", "description": "CGI scripts allowed", "example": false }, "cron": { "type": "boolean", "description": "cron jobs available", "example": false }, "databases": { "type": "boolean", "description": "databases available", "example": false }, "dns": { "type": "boolean", "description": "DNS available (custom DNS records)", "example": false }, "dynDns": { "type": "boolean", "description": "Dynamic DNS available", "example": false }, "extDomains": { "type": "boolean", "description": "external domains allowed", "example": false }, "mail": { "type": "boolean", "description": "e-mail available", "example": false }, "manualBackup": { "type": "boolean", "description": "manual backups available", "example": false }, "php": { "type": "boolean", "description": "PHP available", "example": false }, "phpRestricted": { "type": "boolean", "description": "may use restricted PHP versions", "example": false }, "resale": { "type": "boolean", "description": "may create reseller accounts", "example": false }, "ssi": { "type": "boolean", "description": "SSI (server-side includes) available", "example": false }, "subdomains": { "type": "boolean", "description": "subdomains available", "example": false }, "tls": { "type": "boolean", "description": "TLS encryption (HTTPS) available", "example": false }, "tlsManagement": { "type": "boolean", "description": "allowed to manage own TLS certificates", "example": false }, "webspace": { "type": "boolean", "description": "webspace available", "example": false } }, "description": "maximum available features" }, "resellerAccounts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "reseller account ID", "example": "OVDd7g" }, "name": { "type": "string", "description": "reseller account name", "example": "res1" } } }, "description": "list of available reseller accounts" }, "servers": { "type": "array", "items": { "type": "object", "properties": { "connected": { "type": "boolean", "description": "whether the server is currently connected with LiveConfig", "example": true }, "hostname": { "type": "string", "description": "hostname", "example": "www.example.org" }, "id": { "type": "string", "description": "server ID", "example": "localhost" }, "services": { "type": "array", "items": { "enum": [ "db | dns | mail | web" ], "type": "string" }, "example": [ "db", "mail", "web" ] } } }, "description": "list of available servers" }, "templates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "template ID", "example": "Gu2EgQ" }, "name": { "type": "string", "description": "template name", "example": "Wordpress Hosting" }, "resale": { "type": "boolean", "description": "whether this is a reseller template", "example": false } } }, "description": "list of available templates" } } } }, "description": "details for creating new accounts" }, { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object", "properties": { "comment": { "type": "string", "description": "Account comment", "example": "Wordpress website" }, "created": { "type": "number", "description": "number of databases created within this account", "example": 4 }, "limit": { "type": "number", "description": "allowed number of databases for this account (`-1`: unlimited)", "example": 10 }, "name": { "type": "string", "description": "account name", "example": "web1" }, "prefix": { "type": "string", "description": "prefix for database name and user name (automatically prepended when creating a database)", "example": "web1db" }, "servers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "database service name", "example": "mysql" }, "sso": { "type": "boolean", "description": "Single Sign-On (SSO) supported", "example": true } } }, "description": "list of available RDBMS (database services)" } } } } }, "description": "list of accounts for creating a new database (`show=new-db`)" }, { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "account name", "example": "web1" }, "comment": { "type": "string", "description": "account comment", "example": "Wordpress website" }, "dnsTemplates": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "dnssec": { "type": "boolean" } } }, "description": "list of available DNS templates" }, "domainCount": { "type": "number", "description": "number of already existing domains (managed and external domains)" }, "extDomainCount": { "type": "number", "description": "number of already existing external domains" }, "domainLimit": { "type": "number", "description": "limit of external domains" }, "email": { "type": "object" }, "web": { "type": "array", "items": { "type": "object" } }, "tls": { "type": "boolean" } } }, "description": "list of available accounts" }, "tlsProducts": { "type": "array", "items": { "type": "object" } } } } }, "description": "list of accounts for adding a new domain (`show=new-domain`)" } ] } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Accounts" ], "summary": "Create new hosting account", "description": "This method is used for adding a new hosting account", "requestBody": { "description": "Data of new account", "content": { "application\/json": { "schema": { "allOf": [ { "allOf": [ { "type": "object", "properties": { "api": { "type": "boolean", "description": "Account has API access", "example": false }, "apps": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web applications installed via AppInstaller (`-1`: unlimited)", "example": 5 }, "backup": { "type": "object", "properties": { "plans": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "backup plan ID", "example": "a1b2c3" }, "keep": { "maximum": 999, "minimum": 1, "type": "number", "description": "number of backups to keep", "example": 5 } } } }, "count": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of manually triggered backups allowed (`-1`: unlimited)", "example": 5 }, "wait": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Minimum time to wait between two manual backups (in minutes)", "example": 15 } } }, "cgi": { "type": "boolean", "description": "Permission for CGI scripts", "example": false }, "cronjobs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of cron jobs (`-1`: unlimited)", "example": 20 }, "customers": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of customers (`-1`: unlimited)", "example": 100 }, "databases": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of databases (`-1`: unlimited)", "example": 10 }, "dbExtAccess": { "type": "boolean", "description": "Allow enabling external database access", "example": false }, "dns": { "type": "boolean", "description": "Permission to edit DNS entries", "example": true }, "dynDns": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of subdomains with dynamic DNS feature", "example": 10 }, "extDomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed external domains (`-1`: unlimited)", "example": 5 }, "ftpAccounts": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of FTP accounts (`-1`: unlimited)", "example": 5 }, "lac": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true }, "memMax": { "minimum": -1, "type": "integer", "description": "maximum memory (RAM) in MB", "example": 2048 }, "tasksMax": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of processes & threads", "example": 2000 } }, "description": "LiveConfig Account Container (LAC) settings - only available with appropriate license. Currently these settings are only available for hosting accounts, not with hosting templates!" }, "logrotate": { "type": "object", "properties": { "compress": { "type": "boolean", "description": "Compress rotated log files", "example": true }, "filterIPv4": { "maximum": 4, "minimum": 0, "type": "number", "description": "number of bytes to filter from IPv4 addresses in access.log", "example": 1 }, "filterIPv6": { "maximum": 4, "minimum": 0, "type": "number", "description": "filter IPv6 addresses in access.log (0=no filtering, 1= filter last 32 bit, 2 = filter last 64 bit, 3 = filter last 96 bit, 4 = filter whole address)", "example": 2 }, "rotateInterval": { "enum": [ "hour", "day", "week", "month" ], "type": "string", "description": "Rotation interval (mutually exclusive with `rotateSize`)", "example": "week" }, "rotateSize": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Rotation size in MB (mutually exclusive with `rotateInterval`)", "example": 1024 }, "keepCount": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of rotated log files to keep (mutually exclusive with `keepDays`)", "example": 5 }, "keepDays": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of days to keep rotated log files (mutually exclusive with `keepCount`)", "example": 100 } }, "description": "Log rotation settings" }, "mailaddrs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of e-mail addresses (`-1`: unlimited)", "example": 250 }, "mailboxes": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of mailboxes (`-1`: unlimited)", "example": 50 }, "mailquota": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "E-mail storage quota (MiB, `-1`: unlimited)", "example": 10240 }, "php": { "enum": [ "no", "suPHP", "FastCGI", "mod_php", "FPM" ], "type": "string", "description": "PHP support (`suPHP` is deprecated, not available for new templates, `mod_php` is highly disregarded for security reasons).", "example": "FPM" }, "resaleable": { "type": "boolean", "description": "Permission to create subordinated resellers", "example": false }, "shell": { "enum": [ "no", "scponly", "shell", "webShell" ], "type": "string", "description": "Shell access (no, SFTP only, bash, web shell (implies bash))", "example": "no" }, "ssi": { "type": "boolean", "description": "Permission for server-side includes (SSI)", "example": true }, "subdomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed subdomains (`-1`: unlimited; `www` subdomain is not counted)", "example": 5 }, "tls": { "type": "boolean", "description": "Support for TLS\/SSL (https)", "example": true }, "tlsManagement": { "type": "boolean", "description": "allow management of TLS\/SSL certificates (requires `tls=true`)", "example": false }, "users": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web interface users (`-1`: unlimited)", "example": 5 }, "webspace": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Webspace (MiB) (`-1`: unlimited)", "example": 10240 } } }, { "type": "object", "properties": { "comment": { "type": "string", "description": "comment for this account" }, "name": { "type": "string", "description": "account name", "example": "web1" }, "path": { "type": "string", "description": "account path", "readOnly": true, "example": "\/var\/www\/web1" }, "flags": { "type": "array", "items": { "enum": [ "ftp", "cron", "term" ], "type": "string" }, "readOnly": true }, "resellerAccount": { "type": "string", "description": "name of the reseller account, with which this account was created", "example": "res1" }, "templateName": { "type": "string", "description": "template name where this account is based on (use either this or templateId for account creation)", "nullable": true, "example": "Wordpress Hosting" }, "templateId": { "type": "string", "description": "id of the template this account is based on (use either this or templateName for account creation)", "nullable": true, "example": "bIAzOg" }, "editable": { "type": "boolean", "description": "current user may edit this account", "readOnly": true, "example": true } } } ] }, { "type": "object", "properties": { "dbserver": { "type": "string", "description": "host ID of the database server", "example": "localhost" }, "mailserver": { "type": "string", "description": "host ID of the mail server", "example": "localhost" }, "webserver": { "type": "string", "description": "host ID of the web server", "example": "localhost" }, "primaryDomain": { "type": "string", "description": "primary (sub)domain name for this account", "example": "www.example.org" }, "stats": { "type": "object", "properties": { "software": { "enum": [ "AWStats", "Webalizer" ], "type": "string", "description": "webstatistics software", "nullable": true, "example": "AWStats" }, "subdomain": { "type": "string", "description": "domain for webstatistics", "example": "stats.example.com" }, "user": { "type": "string", "description": "user name for webstatistics", "example": "user" }, "lang": { "type": "string", "description": "language for webstatistics", "example": "de" }, "password": { "type": "string", "description": "password for webstatistics", "writeOnly": true, "example": "SeCrEt" } }, "description": "webstatistics details" }, "status": { "type": "object", "properties": { "email": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of email", "example": "active" }, "webspace": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of webspace", "example": "suspended" }, "ftp": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of ftp", "example": "locked" } }, "description": "account status" } } } ] } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "409": { "description": "Conflict", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/accounts\/{account}": { "get": { "tags": [ "Accounts" ], "summary": "Get account details", "description": "This method returns the details of an account", "parameters": [ { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } }, { "name": "show", "in": "query", "description": "comma-separated list of additional data to show (`override`: list of overridden values, `template`: template object)\n", "style": "form", "explode": false, "schema": { "type": "array", "items": { "enum": [ "override", "template", "phpSettings" ], "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "allOf": [ { "allOf": [ { "type": "object", "properties": { "api": { "type": "boolean", "description": "Account has API access", "example": false }, "apps": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web applications installed via AppInstaller (`-1`: unlimited)", "example": 5 }, "backup": { "type": "object", "properties": { "plans": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "backup plan ID", "example": "a1b2c3" }, "keep": { "maximum": 999, "minimum": 1, "type": "number", "description": "number of backups to keep", "example": 5 } } } }, "count": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of manually triggered backups allowed (`-1`: unlimited)", "example": 5 }, "wait": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Minimum time to wait between two manual backups (in minutes)", "example": 15 } } }, "cgi": { "type": "boolean", "description": "Permission for CGI scripts", "example": false }, "cronjobs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of cron jobs (`-1`: unlimited)", "example": 20 }, "customers": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of customers (`-1`: unlimited)", "example": 100 }, "databases": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of databases (`-1`: unlimited)", "example": 10 }, "dbExtAccess": { "type": "boolean", "description": "Allow enabling external database access", "example": false }, "dns": { "type": "boolean", "description": "Permission to edit DNS entries", "example": true }, "dynDns": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of subdomains with dynamic DNS feature", "example": 10 }, "extDomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed external domains (`-1`: unlimited)", "example": 5 }, "ftpAccounts": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of FTP accounts (`-1`: unlimited)", "example": 5 }, "lac": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true }, "memMax": { "minimum": -1, "type": "integer", "description": "maximum memory (RAM) in MB", "example": 2048 }, "tasksMax": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of processes & threads", "example": 2000 } }, "description": "LiveConfig Account Container (LAC) settings - only available with appropriate license. Currently these settings are only available for hosting accounts, not with hosting templates!" }, "logrotate": { "type": "object", "properties": { "compress": { "type": "boolean", "description": "Compress rotated log files", "example": true }, "filterIPv4": { "maximum": 4, "minimum": 0, "type": "number", "description": "number of bytes to filter from IPv4 addresses in access.log", "example": 1 }, "filterIPv6": { "maximum": 4, "minimum": 0, "type": "number", "description": "filter IPv6 addresses in access.log (0=no filtering, 1= filter last 32 bit, 2 = filter last 64 bit, 3 = filter last 96 bit, 4 = filter whole address)", "example": 2 }, "rotateInterval": { "enum": [ "hour", "day", "week", "month" ], "type": "string", "description": "Rotation interval (mutually exclusive with `rotateSize`)", "example": "week" }, "rotateSize": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Rotation size in MB (mutually exclusive with `rotateInterval`)", "example": 1024 }, "keepCount": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of rotated log files to keep (mutually exclusive with `keepDays`)", "example": 5 }, "keepDays": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of days to keep rotated log files (mutually exclusive with `keepCount`)", "example": 100 } }, "description": "Log rotation settings" }, "mailaddrs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of e-mail addresses (`-1`: unlimited)", "example": 250 }, "mailboxes": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of mailboxes (`-1`: unlimited)", "example": 50 }, "mailquota": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "E-mail storage quota (MiB, `-1`: unlimited)", "example": 10240 }, "php": { "enum": [ "no", "suPHP", "FastCGI", "mod_php", "FPM" ], "type": "string", "description": "PHP support (`suPHP` is deprecated, not available for new templates, `mod_php` is highly disregarded for security reasons).", "example": "FPM" }, "resaleable": { "type": "boolean", "description": "Permission to create subordinated resellers", "example": false }, "shell": { "enum": [ "no", "scponly", "shell", "webShell" ], "type": "string", "description": "Shell access (no, SFTP only, bash, web shell (implies bash))", "example": "no" }, "ssi": { "type": "boolean", "description": "Permission for server-side includes (SSI)", "example": true }, "subdomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed subdomains (`-1`: unlimited; `www` subdomain is not counted)", "example": 5 }, "tls": { "type": "boolean", "description": "Support for TLS\/SSL (https)", "example": true }, "tlsManagement": { "type": "boolean", "description": "allow management of TLS\/SSL certificates (requires `tls=true`)", "example": false }, "users": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web interface users (`-1`: unlimited)", "example": 5 }, "webspace": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Webspace (MiB) (`-1`: unlimited)", "example": 10240 } } }, { "type": "object", "properties": { "comment": { "type": "string", "description": "comment for this account" }, "name": { "type": "string", "description": "account name", "example": "web1" }, "path": { "type": "string", "description": "account path", "readOnly": true, "example": "\/var\/www\/web1" }, "flags": { "type": "array", "items": { "enum": [ "ftp", "cron", "term" ], "type": "string" }, "readOnly": true }, "resellerAccount": { "type": "string", "description": "name of the reseller account, with which this account was created", "example": "res1" }, "templateName": { "type": "string", "description": "template name where this account is based on (use either this or templateId for account creation)", "nullable": true, "example": "Wordpress Hosting" }, "templateId": { "type": "string", "description": "id of the template this account is based on (use either this or templateName for account creation)", "nullable": true, "example": "bIAzOg" }, "editable": { "type": "boolean", "description": "current user may edit this account", "readOnly": true, "example": true } } } ] }, { "type": "object", "properties": { "dbserver": { "type": "object", "properties": { "id": { "type": "string", "description": "host ID", "example": "localhost" }, "hostname": { "type": "string", "description": "database server name", "example": "web01.example.org" }, "description": { "type": "string", "description": "optional server description" }, "flags": { "type": "array", "items": { "enum": [ "offline" ], "type": "string" }, "description": "list of server flags" } }, "description": "database server details" }, "mailserver": { "type": "object", "properties": { "id": { "type": "string", "description": "host ID", "example": "localhost" }, "hostname": { "type": "string", "description": "mail server name", "example": "web01.example.org" }, "description": { "type": "string", "description": "optional server description" }, "flags": { "type": "array", "items": { "enum": [ "offline" ], "type": "string" }, "description": "list of server flags" } }, "description": "mail server details" }, "webserver": { "type": "object", "properties": { "id": { "type": "string", "description": "host ID", "example": "localhost" }, "hostname": { "type": "string", "description": "web server name", "example": "web01.example.org" }, "description": { "type": "string", "description": "optional server description" }, "flags": { "type": "array", "items": { "enum": [ "offline" ], "type": "string" }, "description": "list of server flags" } }, "description": "web server details" }, "override": { "type": "array", "items": { "enum": [ "users", "api", "webspace", "ftpAccounts", "php", "cgi", "ssi", "cronjobs", "shell", "databases", "subdomains", "dns", "dynDns", "extDomains", "mailaddrs", "mailboxes", "mailquota", "logRotate", "compress", "logKeep", "filterIPv4", "filterIPv6", "backupCount", "backupWait" ], "type": "string" }, "description": "List of properties with custom values (overriding values from template)" }, "usage": { "type": "object", "properties": { "customers": { "type": "number", "description": "only with reseller accounts: number of customers created", "example": 2 }, "databases": { "type": "number", "description": "number of databases created", "example": 3 }, "mailaddrs": { "type": "number", "description": "number of existing e-mail addresses", "example": 23 }, "mailaddrsAssigned": { "type": "number", "description": "only with reseller accounts: number of e-mail addresses assigned to accounts", "example": 200 }, "mailboxes": { "type": "number", "description": "number of existing mailboxes (POP3\/IMAP)", "example": 12 }, "mailboxesAssigned": { "type": "number", "description": "only with reseller accounts: number of mailboxes (POP3\/IMAP) assigned to accounts", "example": 150 }, "mailquota": { "type": "number", "description": "actual mailbox storage in use (MiB)", "example": 124 }, "mailquotaAssigned": { "type": "number", "description": "mailbox storage assigned to mailboxes (MiB)", "example": 2048 }, "webspaceFiles": { "type": "number", "description": "number of files in webspace", "example": 123 }, "webspaceUsed": { "type": "number", "description": "webspace usage (bytes)", "example": 10231035 }, "webspaceTs": { "type": "string", "description": "timestamp of last webspace usage update", "format": "date-time", "example": "2022-09-01T09:00:22+05" } }, "description": "current usage statistics" }, "primaryDomain": { "type": "object", "properties": { "name": { "type": "string", "description": "primary (sub)domain name" }, "link": { "enum": [ "", "http", "https" ], "type": "string", "description": "hint, if domain is available via _http_ or _https_" } } }, "stats": { "type": "object", "properties": { "software": { "enum": [ "AWStats", "Webalizer" ], "type": "string", "description": "webstatistics software", "example": "AWStats" }, "subdomain": { "type": "string", "description": "domain for webstatistics", "example": "stats.example.com" }, "user": { "type": "string", "description": "user name for webstatistics", "example": "user" }, "lang": { "type": "string", "description": "language for webstatistics", "example": "de" } }, "description": "webstatistics details" }, "status": { "type": "object", "properties": { "email": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of email", "example": "active" }, "webspace": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of webspace", "example": "suspended" }, "ftp": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of ftp", "example": "locked" } }, "description": "account status" }, "deleted": { "type": "boolean", "description": "is `true` if account is being deleted", "example": "true" }, "traffic": { "type": "object", "properties": { "currentMonth": { "type": "object", "properties": { "hits": { "type": "integer", "description": "website hits", "readOnly": true, "example": 12 }, "in": { "type": "integer", "description": "bytes received", "readOnly": true, "example": 78943532 }, "out": { "type": "integer", "description": "bytes sent", "readOnly": true, "example": 2536543542 }, "ts": { "type": "string", "description": "timestamp of last update", "format": "date", "readOnly": true, "example": "2025-04-15T00:00:00Z" } }, "description": "traffic summary for current month", "readOnly": true }, "lastMonth": { "type": "object", "properties": { "hits": { "type": "integer", "description": "website hits", "readOnly": true, "example": 12 }, "in": { "type": "integer", "description": "bytes received", "readOnly": true, "example": 78943532 }, "out": { "type": "integer", "description": "bytes sent", "readOnly": true, "example": 2536543542 }, "ts": { "type": "string", "description": "timestamp of last update", "format": "date", "readOnly": true, "example": "2025-04-15T00:00:00Z" } }, "description": "traffic summary for last month", "readOnly": true } }, "description": "traffic summary for this account", "readOnly": true } } }, { "type": "object", "properties": { "phpSettings": { "type": "array", "items": { "required": [ "type", "name", "value", "differing" ], "type": "object", "properties": { "type": { "enum": [ "string", "boolean", "integer", "expression", "extension", "zend_extension" ], "type": "string", "description": "type of the settings value", "readOnly": true, "example": "boolean" }, "name": { "type": "string", "description": "name of the setting. for php ini sections write `
.`", "example": "memory_limit" }, "minVersion": { "type": "string", "description": "the minimum version number (including (>=)) for which this setting is used for (`null` if applied to all)", "format": "version number", "nullable": true, "example": "7.4.0" }, "maxVersion": { "type": "string", "description": "the maximum version number (excluding (<)) for which this setting is used for (`null` if applied to all)", "format": "version number", "nullable": true, "example": "7.4.0" }, "value": { "type": "string", "description": "value of the setting. the Placeholders '%HOME%', '%PHP%' and '%USER%' will be replaced accordingly. Set to `null` to revert to default value. For type `extension` or `zend_extension` this is read only!", "example": "32" }, "unit": { "enum": [ "kilo", "mega", "giga", "" ], "type": "string", "description": "for type `integer` there may be a unit qualification needed (example for memory_limit: 64M)", "example": "mega" }, "enabled": { "type": "boolean", "description": "if type is `extension` or `zend_extension` this is required and specifies if the extension is enabled by default. Set to `null` to revert to default value.", "example": false }, "differing": { "type": "boolean", "description": "flag if this setting overwrites the default", "readOnly": true, "example": false }, "default": { "type": "object", "properties": { "unit": { "enum": [ "kilo", "mega", "giga", "" ], "type": "string", "description": "default unit for type `integer`", "readOnly": true, "example": "kilo" }, "value": { "type": "string", "description": "default value of the setting.", "readOnly": true, "example": "64" }, "enabled": { "type": "boolean", "description": "if type is `extension` or `zend_extension` this specifies the default of the `enabled` flag", "readOnly": true, "example": false } }, "description": "default values for changeable entities", "readOnly": true } }, "description": "PHP account setting" }, "description": "if `show` parameter includes `phpSettings` this list of php settings for the account are included" } } } ] } }, "description": "Account details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Accounts" ], "summary": "Remove an account", "description": "When an account is deleted, all objects linked to it (domains, mailboxes, databases, etc.) are also automatically deleted. To prevent the unintentional removal of such objects, the query parameter `confirm=true` must always be set for the `DELETE` call.\nIf this parameter is not present, the `DELETE` request is answered with the HTTP status `409` (_Conflict_) and a list of all objects\/resources to be deleted is returned (see schema for response with status 409).\n", "parameters": [ { "name": "account", "in": "path", "description": "Name of the account", "required": true, "schema": { "type": "string" }, "example": "web1" }, { "name": "confirm", "in": "query", "description": "confirm deletion of this and all associated objects", "schema": { "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "409": { "description": "Conflict (confirmation required)", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "title": { "type": "string", "example": "Confirmation required" }, "detail": { "type": "string", "example": "Deletion of this object requires confirmation" }, "resolve": { "type": "string", "description": "Hint how to resolve this conflict (`confirm`: explicitly confirm deletion of this object)", "example": "confirm" }, "data": { "type": "object", "properties": { "databases": { "type": "array", "items": { "type": "string" }, "description": "List of databases which will be deleted", "example": [ "web1db1", "web1db-wordpress" ] }, "domains": { "type": "array", "items": { "type": "string" }, "description": "List of domains which will be deleted", "example": [ "example.net", "example.org" ] }, "email": { "type": "array", "items": { "type": "string" }, "description": "List of mailboxes and e-mail addresses which will be deleted", "example": [ "info@exampe.org", "john.doe@example.net" ] }, "ftpAccounts": { "type": "array", "items": { "type": "string" }, "description": "List of FTP accounts which will be deleted", "example": [ "web1ftp1", "web1ftp2" ] } } } }, "description": "Deletion of this object must be confirmed (with `confirm=true`)" } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Accounts" ], "summary": "Edit account details", "description": "This method edits an existing account", "parameters": [ { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } } ], "requestBody": { "description": "Account data to be modified", "content": { "application\/json": { "schema": { "allOf": [ { "allOf": [ { "type": "object", "properties": { "api": { "type": "boolean", "description": "Account has API access", "example": false }, "apps": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web applications installed via AppInstaller (`-1`: unlimited)", "example": 5 }, "backup": { "type": "object", "properties": { "plans": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "backup plan ID", "example": "a1b2c3" }, "keep": { "maximum": 999, "minimum": 1, "type": "number", "description": "number of backups to keep", "example": 5 } } } }, "count": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of manually triggered backups allowed (`-1`: unlimited)", "example": 5 }, "wait": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Minimum time to wait between two manual backups (in minutes)", "example": 15 } } }, "cgi": { "type": "boolean", "description": "Permission for CGI scripts", "example": false }, "cronjobs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of cron jobs (`-1`: unlimited)", "example": 20 }, "customers": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of customers (`-1`: unlimited)", "example": 100 }, "databases": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of databases (`-1`: unlimited)", "example": 10 }, "dbExtAccess": { "type": "boolean", "description": "Allow enabling external database access", "example": false }, "dns": { "type": "boolean", "description": "Permission to edit DNS entries", "example": true }, "dynDns": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of subdomains with dynamic DNS feature", "example": 10 }, "extDomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed external domains (`-1`: unlimited)", "example": 5 }, "ftpAccounts": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of FTP accounts (`-1`: unlimited)", "example": 5 }, "lac": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true }, "memMax": { "minimum": -1, "type": "integer", "description": "maximum memory (RAM) in MB", "example": 2048 }, "tasksMax": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of processes & threads", "example": 2000 } }, "description": "LiveConfig Account Container (LAC) settings - only available with appropriate license. Currently these settings are only available for hosting accounts, not with hosting templates!" }, "logrotate": { "type": "object", "properties": { "compress": { "type": "boolean", "description": "Compress rotated log files", "example": true }, "filterIPv4": { "maximum": 4, "minimum": 0, "type": "number", "description": "number of bytes to filter from IPv4 addresses in access.log", "example": 1 }, "filterIPv6": { "maximum": 4, "minimum": 0, "type": "number", "description": "filter IPv6 addresses in access.log (0=no filtering, 1= filter last 32 bit, 2 = filter last 64 bit, 3 = filter last 96 bit, 4 = filter whole address)", "example": 2 }, "rotateInterval": { "enum": [ "hour", "day", "week", "month" ], "type": "string", "description": "Rotation interval (mutually exclusive with `rotateSize`)", "example": "week" }, "rotateSize": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Rotation size in MB (mutually exclusive with `rotateInterval`)", "example": 1024 }, "keepCount": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of rotated log files to keep (mutually exclusive with `keepDays`)", "example": 5 }, "keepDays": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of days to keep rotated log files (mutually exclusive with `keepCount`)", "example": 100 } }, "description": "Log rotation settings" }, "mailaddrs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of e-mail addresses (`-1`: unlimited)", "example": 250 }, "mailboxes": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of mailboxes (`-1`: unlimited)", "example": 50 }, "mailquota": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "E-mail storage quota (MiB, `-1`: unlimited)", "example": 10240 }, "php": { "enum": [ "no", "suPHP", "FastCGI", "mod_php", "FPM" ], "type": "string", "description": "PHP support (`suPHP` is deprecated, not available for new templates, `mod_php` is highly disregarded for security reasons).", "example": "FPM" }, "resaleable": { "type": "boolean", "description": "Permission to create subordinated resellers", "example": false }, "shell": { "enum": [ "no", "scponly", "shell", "webShell" ], "type": "string", "description": "Shell access (no, SFTP only, bash, web shell (implies bash))", "example": "no" }, "ssi": { "type": "boolean", "description": "Permission for server-side includes (SSI)", "example": true }, "subdomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed subdomains (`-1`: unlimited; `www` subdomain is not counted)", "example": 5 }, "tls": { "type": "boolean", "description": "Support for TLS\/SSL (https)", "example": true }, "tlsManagement": { "type": "boolean", "description": "allow management of TLS\/SSL certificates (requires `tls=true`)", "example": false }, "users": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web interface users (`-1`: unlimited)", "example": 5 }, "webspace": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Webspace (MiB) (`-1`: unlimited)", "example": 10240 } } }, { "type": "object", "properties": { "comment": { "type": "string", "description": "comment for this account" }, "name": { "type": "string", "description": "account name", "example": "web1" }, "path": { "type": "string", "description": "account path", "readOnly": true, "example": "\/var\/www\/web1" }, "flags": { "type": "array", "items": { "enum": [ "ftp", "cron", "term" ], "type": "string" }, "readOnly": true }, "resellerAccount": { "type": "string", "description": "name of the reseller account, with which this account was created", "example": "res1" }, "templateName": { "type": "string", "description": "template name where this account is based on (use either this or templateId for account creation)", "nullable": true, "example": "Wordpress Hosting" }, "templateId": { "type": "string", "description": "id of the template this account is based on (use either this or templateName for account creation)", "nullable": true, "example": "bIAzOg" }, "editable": { "type": "boolean", "description": "current user may edit this account", "readOnly": true, "example": true } } } ] }, { "type": "object", "properties": { "dbserver": { "type": "string", "description": "host ID of the database server", "example": "localhost" }, "mailserver": { "type": "string", "description": "host ID of the mail server", "example": "localhost" }, "webserver": { "type": "string", "description": "host ID of the web server", "example": "localhost" }, "primaryDomain": { "type": "string", "description": "primary (sub)domain name for this account", "example": "www.example.org" }, "stats": { "type": "object", "properties": { "software": { "enum": [ "AWStats", "Webalizer" ], "type": "string", "description": "webstatistics software", "nullable": true, "example": "AWStats" }, "subdomain": { "type": "string", "description": "domain for webstatistics", "example": "stats.example.com" }, "user": { "type": "string", "description": "user name for webstatistics", "example": "user" }, "lang": { "type": "string", "description": "language for webstatistics", "example": "de" }, "password": { "type": "string", "description": "password for webstatistics", "writeOnly": true, "example": "SeCrEt" } }, "description": "webstatistics details" }, "status": { "type": "object", "properties": { "email": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of email", "example": "active" }, "webspace": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of webspace", "example": "suspended" }, "ftp": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of ftp", "example": "locked" } }, "description": "account status" } } }, { "type": "object", "properties": { "phpSettings": { "type": "array", "items": { "required": [ "type", "name", "value", "differing" ], "type": "object", "properties": { "type": { "enum": [ "string", "boolean", "integer", "expression", "extension", "zend_extension" ], "type": "string", "description": "type of the settings value", "readOnly": true, "example": "boolean" }, "name": { "type": "string", "description": "name of the setting. for php ini sections write `
.`", "example": "memory_limit" }, "minVersion": { "type": "string", "description": "the minimum version number (including (>=)) for which this setting is used for (`null` if applied to all)", "format": "version number", "nullable": true, "example": "7.4.0" }, "maxVersion": { "type": "string", "description": "the maximum version number (excluding (<)) for which this setting is used for (`null` if applied to all)", "format": "version number", "nullable": true, "example": "7.4.0" }, "value": { "type": "string", "description": "value of the setting. the Placeholders '%HOME%', '%PHP%' and '%USER%' will be replaced accordingly. Set to `null` to revert to default value. For type `extension` or `zend_extension` this is read only!", "example": "32" }, "unit": { "enum": [ "kilo", "mega", "giga", "" ], "type": "string", "description": "for type `integer` there may be a unit qualification needed (example for memory_limit: 64M)", "example": "mega" }, "enabled": { "type": "boolean", "description": "if type is `extension` or `zend_extension` this is required and specifies if the extension is enabled by default. Set to `null` to revert to default value.", "example": false }, "differing": { "type": "boolean", "description": "flag if this setting overwrites the default", "readOnly": true, "example": false }, "default": { "type": "object", "properties": { "unit": { "enum": [ "kilo", "mega", "giga", "" ], "type": "string", "description": "default unit for type `integer`", "readOnly": true, "example": "kilo" }, "value": { "type": "string", "description": "default value of the setting.", "readOnly": true, "example": "64" }, "enabled": { "type": "boolean", "description": "if type is `extension` or `zend_extension` this specifies the default of the `enabled` flag", "readOnly": true, "example": false } }, "description": "default values for changeable entities", "readOnly": true } }, "description": "PHP account setting" }, "description": "if `show` parameter includes `phpSettings` this list of php settings for the account are included" } } } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "Array of warnings" } }, "description": "Operation status" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/accounts\/{account}\/move": { "patch": { "tags": [ "Accounts" ], "summary": "Move account", "description": "This method allows moving an account to another customer.", "parameters": [ { "name": "account", "in": "path", "description": "name of the account", "schema": { "type": "string" } } ], "requestBody": { "description": "where to move the account to", "content": { "application\/json": { "object": { "properties": { "target": { "type": "string", "example": "own", "enum": [ "own", "customer", "admin" ], "description": "target type to which the account will be moved: `own` = move to _own accounts_, `customer` = move to given customer (see parameter `customer`), `admin` = move to admin (only available to admin users)" }, "required": true, "customer": { "type": "string", "example": "c0001", "description": "if target is `customer`, this is the customer ID to which the account will be moved", "required": false }, "resellerAccount": { "type": "string", "example": "res1", "description": "if the target has one or more reseller accounts, you can optionally move the account into the specified reseller account", "required": false } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "Array of warnings" } }, "description": "Operation status" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/accounts\/{account}\/apps": { "get": { "tags": [ "Accounts" ], "summary": "Get installed web application list", "description": "This method returns the list of installed web applications of an account", "parameters": [ { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "required": [ "status", "language", "installUrl", "adminUrl", "vars", "name", "domain" ], "type": "object", "properties": { "status": { "enum": [ "none", "downloading", "creating database", "installing", "done", "error", "uninstalling", "removing database" ], "type": "string", "description": "the current status of the installation process", "readOnly": true, "example": "done" }, "language": { "type": "string", "description": "the language used to install the application", "readOnly": true, "example": "de" }, "installUrl": { "type": "string", "description": "URL used to forward the user to continue the installation process", "readOnly": true, "example": "\/install.php" }, "adminUrl": { "type": "string", "description": "URL used to forward the user to the administration interface of the application", "readOnly": true, "example": "\/admin.php" }, "vars": { "type": "object", "description": "variables (requested by the installer of the application) used for the installation", "example": { "LC_SITENAME": "Test website", "LC_ADMINUSER": "admin" }, "additionalProperties": { "type": "string" } }, "name": { "type": "string", "description": "name of the application installation", "example": "my webapp" }, "domain": { "type": "string", "description": "the domainname used for the installation", "example": "webapp.example.org" } } } } }, "description": "web application list" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/accounts\/{account}\/apps\/{name}": { "get": { "tags": [ "Accounts" ], "summary": "Get installed web details", "description": "This method returns the details of a installed web application of an account", "parameters": [ { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "Name of the web appication installation", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "required": [ "status", "language", "installUrl", "adminUrl", "vars", "name", "domain" ], "type": "object", "properties": { "status": { "enum": [ "none", "downloading", "creating database", "installing", "done", "error", "uninstalling", "removing database" ], "type": "string", "description": "the current status of the installation process", "readOnly": true, "example": "done" }, "language": { "type": "string", "description": "the language used to install the application", "readOnly": true, "example": "de" }, "installUrl": { "type": "string", "description": "URL used to forward the user to continue the installation process", "readOnly": true, "example": "\/install.php" }, "adminUrl": { "type": "string", "description": "URL used to forward the user to the administration interface of the application", "readOnly": true, "example": "\/admin.php" }, "vars": { "type": "object", "description": "variables (requested by the installer of the application) used for the installation", "example": { "LC_SITENAME": "Test website", "LC_ADMINUSER": "admin" }, "additionalProperties": { "type": "string" } }, "name": { "type": "string", "description": "name of the application installation", "example": "my webapp" }, "domain": { "type": "string", "description": "the domainname used for the installation", "example": "webapp.example.org" } } } }, "description": "web application details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Accounts" ], "summary": "Remove a web application", "parameters": [ { "name": "account", "in": "path", "description": "Name of the account", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "Name of the web application installation", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/accounts\/{account}\/buildersites": { "get": { "tags": [ "Accounts" ], "summary": "Get site builder websites", "description": "This method returns the list of websites created with the site builder", "parameters": [ { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "required": [ "domain", "status" ], "type": "object", "properties": { "domain": { "type": "string", "description": "name of domain used for websitebuilder", "example": "www.example.org" }, "status": { "enum": [ "Ok", "Error", "Creating", "Updating", "Deleting" ], "type": "string", "description": "status of the website" }, "statusMsg": { "type": "string", "description": "message describing the status", "example": "Error while executing extension" } } } } }, "description": "list of websites" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Accounts" ], "summary": "create website with site builder", "description": "This method creates a new website with the site builder", "parameters": [ { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object with data of new website", "content": { "application\/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "domain name for site builder (must be exist in LiveConfig)", "example": "www.example.org" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true } }, "description": "Site created" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/accounts\/{account}\/buildersites\/{site}": { "get": { "tags": [ "Accounts" ], "summary": "Get site builder website details", "description": "This method returns details of a website created with the site builder", "parameters": [ { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } }, { "name": "site", "in": "path", "description": "Domain of the website", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "required": [ "domain", "status" ], "type": "object", "properties": { "domain": { "type": "string", "description": "name of domain used for websitebuilder", "example": "www.example.org" }, "status": { "enum": [ "Ok", "Error", "Creating", "Updating", "Deleting" ], "type": "string", "description": "status of the website" }, "statusMsg": { "type": "string", "description": "message describing the status", "example": "Error while executing extension" } } } }, "description": "Site builder website details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Accounts" ], "summary": "Delete site builder website", "description": "This method deletes a website created with the website builder", "parameters": [ { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } }, { "name": "site", "in": "path", "description": "Domain of the website", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true } }, "description": "Site deleted" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Accounts" ], "summary": "modify site builder website", "description": "This method modifies properties of a site builder website", "parameters": [ { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } }, { "name": "site", "in": "path", "description": "Domain of the website", "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object with data to modify", "content": { "application\/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "description": "domain name for the website (must exist in LiveConfig)", "example": "www.example.org" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true } }, "description": "Site created" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/accounts\/{account}\/buildersites\/{site}\/open": { "get": { "tags": [ "Accounts" ], "summary": "Get site builder redirect url", "description": "This method redirects the caller to the site builder session for the requested website", "parameters": [ { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } }, { "name": "site", "in": "path", "description": "Domain of the site builder website", "schema": { "type": "string" } } ], "responses": { "302": { "description": "Found. see header `Location` for new target" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/apps": { "get": { "tags": [ "Apps" ], "summary": "Get available web application list", "description": "This method returns the list of available web applications", "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "encoded id of the app", "example": "gUAbaA" }, "name": { "type": "string", "description": "name of the app", "example": "WordPress" }, "title": { "type": "string", "description": "Title of the app", "example": "WordPress" }, "descriptionShort": { "type": "string", "description": "a short description of the app", "example": "Blog\/CMS" }, "descriptionLong": { "type": "string", "description": "a longer more detailed description of the app", "example": "WordPress is a simple to use and flexible software to manage website contents. Mostly it is used for weblogs (blogs), but also \"normal\" websites can be built with WordPress fast and easily." }, "vendorUrl": { "type": "string", "description": "the url of the app homepage", "example": "http:\/\/www.wordpress.org" }, "icon": { "type": "string", "description": "the name of the app icon", "example": "ico-wordpress.svg" }, "releaseDate": { "type": "string", "description": "release date", "format": "date", "example": "2025-02-08" }, "version": { "type": "string", "description": "application version", "example": "6.7.2" } } } } }, "description": "web application list" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/apps\/{id}": { "get": { "tags": [ "Apps" ], "summary": "Get details of selected web application", "description": "This method returns the details of the selected web applications", "parameters": [ { "name": "id", "in": "path", "description": "Id of the app", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "encoded id of the app", "example": "gUAbaA" }, "name": { "type": "string", "description": "name of the app", "example": "WordPress" }, "title": { "type": "string", "description": "Title of the app", "example": "WordPress" }, "descriptionShort": { "type": "string", "description": "a short description of the app", "example": "Blog\/CMS" }, "descriptionLong": { "type": "string", "description": "a longer more detailed description of the app", "example": "WordPress is a simple to use and flexible software to manage website contents. Mostly it is used for weblogs (blogs), but also \"normal\" websites can be built with WordPress fast and easily." }, "vendorUrl": { "type": "string", "description": "the url of the app homepage", "example": "http:\/\/www.wordpress.org" }, "icon": { "type": "string", "description": "the name of the app icon", "example": "ico-wordpress.svg" }, "releaseDate": { "type": "string", "description": "release date", "format": "date", "example": "2025-02-08" }, "version": { "type": "string", "description": "application version", "example": "6.7.2" } } } }, "description": "web application details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/apps\/{id}\/install\/{account}": { "get": { "tags": [ "Apps" ], "summary": "Get web application variables list", "description": "This method returns the list required variables for installing the selected app", "parameters": [ { "name": "id", "in": "path", "description": "Id of the app", "schema": { "type": "string" } }, { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "required": [ "name", "title", "type", "regex", "description" ], "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "variable name", "example": "LC_SITENAME" }, "title": { "type": "string", "description": "User readable name of the variable", "example": "Site name" }, "type": { "type": "string", "description": "type of the variable value", "example": "text" }, "regex": { "type": "string", "description": "regular expression to validate the user input value against", "example": "^[^\\'\\\\]{1,30}$" }, "description": { "type": "string", "description": "a user readable description what the variable is about", "example": "The name of the new web site." }, "default": { "type": "string", "description": "the default value used when not submitted", "example": "New Website" } } } } }, "description": "required variables for web application installation" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Apps" ], "summary": "Create new app installation", "description": "This method is used for starting a new app installation", "parameters": [ { "name": "id", "in": "path", "description": "Id of the app", "schema": { "type": "string" } }, { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } } ], "requestBody": { "description": "Data of new app installation", "content": { "application\/json": { "schema": { "required": [ "status", "language", "installUrl", "adminUrl", "vars", "name", "domain" ], "type": "object", "properties": { "status": { "enum": [ "none", "downloading", "creating database", "installing", "done", "error", "uninstalling", "removing database" ], "type": "string", "description": "the current status of the installation process", "readOnly": true, "example": "done" }, "language": { "type": "string", "description": "the language used to install the application", "readOnly": true, "example": "de" }, "installUrl": { "type": "string", "description": "URL used to forward the user to continue the installation process", "readOnly": true, "example": "\/install.php" }, "adminUrl": { "type": "string", "description": "URL used to forward the user to the administration interface of the application", "readOnly": true, "example": "\/admin.php" }, "vars": { "type": "object", "description": "variables (requested by the installer of the application) used for the installation", "example": { "LC_SITENAME": "Test website", "LC_ADMINUSER": "admin" }, "additionalProperties": { "type": "string" } }, "name": { "type": "string", "description": "name of the application installation", "example": "my webapp" }, "domain": { "type": "string", "description": "the domainname used for the installation", "example": "webapp.example.org" } } } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/backup\/schedules": { "get": { "tags": [ "Backup" ], "summary": "Get list of backup schedules", "description": "This method returns a list of all backup schedules.", "parameters": [ { "name": "count", "in": "query", "description": "number of results to return", "schema": { "minimum": 1, "type": "integer" } }, { "name": "page", "in": "query", "description": "page to return (offset), starting with `1`", "schema": { "minimum": 1, "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 1 }, "data": { "type": "array", "items": { "required": [ "name", "interval", "time" ], "type": "object", "properties": { "name": { "type": "string", "description": "Schedule name", "example": "daily backup" }, "intervals": { "maxItems": 24, "type": "array", "items": { "required": [ "day", "time" ], "type": "object", "properties": { "day": { "enum": [ "daily", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "type": "string", "description": "Backup interval", "default": "daily", "example": "daily" }, "time": { "pattern": "^\\d{2}:\\d{2}$", "type": "string", "description": "Time when the backup jobs are started at", "example": "15:00" } } } }, "coverage": { "type": "array", "items": { "enum": [ "web", "mail", "db" ], "type": "string" }, "description": "Data to back up" }, "accounts": { "type": "integer", "description": "Number of accounts where this backup schedule is active", "readOnly": true, "example": 142 } } } } }, "description": "List of configured backup schedules" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Backup" ], "summary": "Add new backup schedule", "description": "This method adds a new backup schedule.", "requestBody": { "description": "Data of new backup schedule", "content": { "application\/json": { "schema": { "required": [ "name", "interval", "time" ], "type": "object", "properties": { "name": { "type": "string", "description": "Schedule name", "example": "daily backup" }, "intervals": { "maxItems": 24, "type": "array", "items": { "required": [ "day", "time" ], "type": "object", "properties": { "day": { "enum": [ "daily", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "type": "string", "description": "Backup interval", "default": "daily", "example": "daily" }, "time": { "pattern": "^\\d{2}:\\d{2}$", "type": "string", "description": "Time when the backup jobs are started at", "example": "15:00" } } } }, "coverage": { "type": "array", "items": { "enum": [ "web", "mail", "db" ], "type": "string" }, "description": "Data to back up" }, "accounts": { "type": "integer", "description": "Number of accounts where this backup schedule is active", "readOnly": true, "example": 142 } } } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/backup\/schedules\/{id}": { "get": { "tags": [ "Backup" ], "summary": "Get backup schedule details", "description": "This method returns the details of a backup schedule.", "parameters": [ { "name": "id", "in": "path", "description": "Backup schedule id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "required": [ "name", "interval", "time" ], "type": "object", "properties": { "name": { "type": "string", "description": "Schedule name", "example": "daily backup" }, "intervals": { "maxItems": 24, "type": "array", "items": { "required": [ "day", "time" ], "type": "object", "properties": { "day": { "enum": [ "daily", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "type": "string", "description": "Backup interval", "default": "daily", "example": "daily" }, "time": { "pattern": "^\\d{2}:\\d{2}$", "type": "string", "description": "Time when the backup jobs are started at", "example": "15:00" } } } }, "coverage": { "type": "array", "items": { "enum": [ "web", "mail", "db" ], "type": "string" }, "description": "Data to back up" }, "accounts": { "type": "integer", "description": "Number of accounts where this backup schedule is active", "readOnly": true, "example": 142 } } } }, "description": "Backup schedule details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Backup" ], "summary": "Delete a backup schedule", "parameters": [ { "name": "id", "in": "path", "description": "the id of the backup schedule", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Backup" ], "summary": "Edit backup schedule details", "description": "This method modifies the details for a certain backup schedule", "parameters": [ { "name": "id", "in": "path", "description": "the id of the backup schedule", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Backup schedule data to be modified", "content": { "application\/json": { "schema": { "required": [ "name", "interval", "time" ], "type": "object", "properties": { "name": { "type": "string", "description": "Schedule name", "example": "daily backup" }, "intervals": { "maxItems": 24, "type": "array", "items": { "required": [ "day", "time" ], "type": "object", "properties": { "day": { "enum": [ "daily", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "type": "string", "description": "Backup interval", "default": "daily", "example": "daily" }, "time": { "pattern": "^\\d{2}:\\d{2}$", "type": "string", "description": "Time when the backup jobs are started at", "example": "15:00" } } } }, "coverage": { "type": "array", "items": { "enum": [ "web", "mail", "db" ], "type": "string" }, "description": "Data to back up" }, "accounts": { "type": "integer", "description": "Number of accounts where this backup schedule is active", "readOnly": true, "example": 142 } } } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/backup\/web\/{account}": { "get": { "tags": [ "Backup" ], "summary": "Get list of backups", "description": "This method returns a list of all backups for the given object.", "parameters": [ { "name": "account", "in": "path", "description": "name of the account", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 1 }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the backup", "readOnly": true, "example": "bIAzOg" }, "objectName": { "type": "string", "description": "name of the backuped object", "readOnly": true, "example": "web123@example.org" }, "archiveSize": { "type": "integer", "description": "size of the backuped archive in bytes", "readOnly": true, "example": 1258 }, "size": { "type": "integer", "description": "size of the backuped data in bytes", "readOnly": true, "example": 4082 }, "type": { "enum": [ "web", "db", "mail" ], "type": "string", "description": "type of the backuped object", "readOnly": true, "example": "mail" }, "started": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z" }, "finished": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:35:28Z" }, "status": { "enum": [ "none", "submitted", "inPreparation", "running", "finished", "error" ], "type": "string", "description": "status of the backup", "readOnly": true, "example": "finished" }, "statusMsg": { "type": "string", "description": "human readable status message", "readOnly": true, "example": "Job finished successful" }, "storage": { "type": "string", "description": "backup-storage id", "readOnly": true, "example": "bIAzOg" } }, "required": null } } }, "description": "List of backups" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Backup" ], "summary": "create new backup", "description": "This method creates a new backup", "parameters": [ { "name": "account", "in": "path", "description": "name of the account", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Data of new backup", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the backup", "readOnly": true, "example": "bIAzOg" }, "objectName": { "type": "string", "description": "name of the backuped object", "readOnly": true, "example": "web123@example.org" }, "archiveSize": { "type": "integer", "description": "size of the backuped archive in bytes", "readOnly": true, "example": 1258 }, "size": { "type": "integer", "description": "size of the backuped data in bytes", "readOnly": true, "example": 4082 }, "type": { "enum": [ "web", "db", "mail" ], "type": "string", "description": "type of the backuped object", "readOnly": true, "example": "mail" }, "started": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z" }, "finished": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:35:28Z" }, "status": { "enum": [ "none", "submitted", "inPreparation", "running", "finished", "error" ], "type": "string", "description": "status of the backup", "readOnly": true, "example": "finished" }, "statusMsg": { "type": "string", "description": "human readable status message", "readOnly": true, "example": "Job finished successful" }, "storage": { "type": "string", "description": "backup-storage id", "readOnly": true, "example": "bIAzOg" } }, "required": null } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/backup\/mail\/{account}": { "get": { "tags": [ "Backup" ], "summary": "Get list of backups", "description": "This method returns a list of all backups for the given object.", "parameters": [ { "name": "account", "in": "path", "description": "name of the account", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 1 }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the backup", "readOnly": true, "example": "bIAzOg" }, "objectName": { "type": "string", "description": "name of the backuped object", "readOnly": true, "example": "web123@example.org" }, "archiveSize": { "type": "integer", "description": "size of the backuped archive in bytes", "readOnly": true, "example": 1258 }, "size": { "type": "integer", "description": "size of the backuped data in bytes", "readOnly": true, "example": 4082 }, "type": { "enum": [ "web", "db", "mail" ], "type": "string", "description": "type of the backuped object", "readOnly": true, "example": "mail" }, "started": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z" }, "finished": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:35:28Z" }, "status": { "enum": [ "none", "submitted", "inPreparation", "running", "finished", "error" ], "type": "string", "description": "status of the backup", "readOnly": true, "example": "finished" }, "statusMsg": { "type": "string", "description": "human readable status message", "readOnly": true, "example": "Job finished successful" }, "storage": { "type": "string", "description": "backup-storage id", "readOnly": true, "example": "bIAzOg" } }, "required": null } } }, "description": "List of backups" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/backup\/db\/{account}": { "get": { "tags": [ "Backup" ], "summary": "Get list of backups", "description": "This method returns a list of all backups for the given object.", "parameters": [ { "name": "account", "in": "path", "description": "name of the account", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 1 }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the backup", "readOnly": true, "example": "bIAzOg" }, "objectName": { "type": "string", "description": "name of the backuped object", "readOnly": true, "example": "web123@example.org" }, "archiveSize": { "type": "integer", "description": "size of the backuped archive in bytes", "readOnly": true, "example": 1258 }, "size": { "type": "integer", "description": "size of the backuped data in bytes", "readOnly": true, "example": 4082 }, "type": { "enum": [ "web", "db", "mail" ], "type": "string", "description": "type of the backuped object", "readOnly": true, "example": "mail" }, "started": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z" }, "finished": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:35:28Z" }, "status": { "enum": [ "none", "submitted", "inPreparation", "running", "finished", "error" ], "type": "string", "description": "status of the backup", "readOnly": true, "example": "finished" }, "statusMsg": { "type": "string", "description": "human readable status message", "readOnly": true, "example": "Job finished successful" }, "storage": { "type": "string", "description": "backup-storage id", "readOnly": true, "example": "bIAzOg" } }, "required": null } } }, "description": "List of backups" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/backup\/mail\/{account}\/{object}": { "get": { "tags": [ "Backup" ], "summary": "Get list of backups", "description": "This method returns a list of all backups for the given object.", "parameters": [ { "name": "account", "in": "path", "description": "name of the account", "required": true, "schema": { "type": "string" } }, { "name": "object", "in": "path", "description": "backuped object", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 1 }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the backup", "readOnly": true, "example": "bIAzOg" }, "objectName": { "type": "string", "description": "name of the backuped object", "readOnly": true, "example": "web123@example.org" }, "archiveSize": { "type": "integer", "description": "size of the backuped archive in bytes", "readOnly": true, "example": 1258 }, "size": { "type": "integer", "description": "size of the backuped data in bytes", "readOnly": true, "example": 4082 }, "type": { "enum": [ "web", "db", "mail" ], "type": "string", "description": "type of the backuped object", "readOnly": true, "example": "mail" }, "started": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z" }, "finished": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:35:28Z" }, "status": { "enum": [ "none", "submitted", "inPreparation", "running", "finished", "error" ], "type": "string", "description": "status of the backup", "readOnly": true, "example": "finished" }, "statusMsg": { "type": "string", "description": "human readable status message", "readOnly": true, "example": "Job finished successful" }, "storage": { "type": "string", "description": "backup-storage id", "readOnly": true, "example": "bIAzOg" } }, "required": null } } }, "description": "List of backups" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Backup" ], "summary": "create new backup", "description": "This method creates a new backup", "parameters": [ { "name": "account", "in": "path", "description": "name of the account", "required": true, "schema": { "type": "string" } }, { "name": "object", "in": "path", "description": "to be backuped object", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Data of new backup", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the backup", "readOnly": true, "example": "bIAzOg" }, "objectName": { "type": "string", "description": "name of the backuped object", "readOnly": true, "example": "web123@example.org" }, "archiveSize": { "type": "integer", "description": "size of the backuped archive in bytes", "readOnly": true, "example": 1258 }, "size": { "type": "integer", "description": "size of the backuped data in bytes", "readOnly": true, "example": 4082 }, "type": { "enum": [ "web", "db", "mail" ], "type": "string", "description": "type of the backuped object", "readOnly": true, "example": "mail" }, "started": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z" }, "finished": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:35:28Z" }, "status": { "enum": [ "none", "submitted", "inPreparation", "running", "finished", "error" ], "type": "string", "description": "status of the backup", "readOnly": true, "example": "finished" }, "statusMsg": { "type": "string", "description": "human readable status message", "readOnly": true, "example": "Job finished successful" }, "storage": { "type": "string", "description": "backup-storage id", "readOnly": true, "example": "bIAzOg" } }, "required": null } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/backup\/db\/{account}\/{object}": { "get": { "tags": [ "Backup" ], "summary": "Get list of backups", "description": "This method returns a list of all backups for the given object.", "parameters": [ { "name": "account", "in": "path", "description": "name of the account", "required": true, "schema": { "type": "string" } }, { "name": "object", "in": "path", "description": "backuped object", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 1 }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the backup", "readOnly": true, "example": "bIAzOg" }, "objectName": { "type": "string", "description": "name of the backuped object", "readOnly": true, "example": "web123@example.org" }, "archiveSize": { "type": "integer", "description": "size of the backuped archive in bytes", "readOnly": true, "example": 1258 }, "size": { "type": "integer", "description": "size of the backuped data in bytes", "readOnly": true, "example": 4082 }, "type": { "enum": [ "web", "db", "mail" ], "type": "string", "description": "type of the backuped object", "readOnly": true, "example": "mail" }, "started": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z" }, "finished": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:35:28Z" }, "status": { "enum": [ "none", "submitted", "inPreparation", "running", "finished", "error" ], "type": "string", "description": "status of the backup", "readOnly": true, "example": "finished" }, "statusMsg": { "type": "string", "description": "human readable status message", "readOnly": true, "example": "Job finished successful" }, "storage": { "type": "string", "description": "backup-storage id", "readOnly": true, "example": "bIAzOg" } }, "required": null } } }, "description": "List of backups" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Backup" ], "summary": "create new backup", "description": "This method creates a new backup", "parameters": [ { "name": "account", "in": "path", "description": "name of the account", "required": true, "schema": { "type": "string" } }, { "name": "object", "in": "path", "description": "to be backuped object", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Data of new backup", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the backup", "readOnly": true, "example": "bIAzOg" }, "objectName": { "type": "string", "description": "name of the backuped object", "readOnly": true, "example": "web123@example.org" }, "archiveSize": { "type": "integer", "description": "size of the backuped archive in bytes", "readOnly": true, "example": 1258 }, "size": { "type": "integer", "description": "size of the backuped data in bytes", "readOnly": true, "example": 4082 }, "type": { "enum": [ "web", "db", "mail" ], "type": "string", "description": "type of the backuped object", "readOnly": true, "example": "mail" }, "started": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z" }, "finished": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:35:28Z" }, "status": { "enum": [ "none", "submitted", "inPreparation", "running", "finished", "error" ], "type": "string", "description": "status of the backup", "readOnly": true, "example": "finished" }, "statusMsg": { "type": "string", "description": "human readable status message", "readOnly": true, "example": "Job finished successful" }, "storage": { "type": "string", "description": "backup-storage id", "readOnly": true, "example": "bIAzOg" } }, "required": null } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/backup\/jobs\/web\/{id}": { "get": { "tags": [ "Backup" ], "summary": "Get details of a backup", "description": "This method returns the details of a backup.", "parameters": [ { "name": "id", "in": "path", "description": "id of the backup", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the backup", "readOnly": true, "example": "bIAzOg" }, "objectName": { "type": "string", "description": "name of the backuped object", "readOnly": true, "example": "web123@example.org" }, "archiveSize": { "type": "integer", "description": "size of the backuped archive in bytes", "readOnly": true, "example": 1258 }, "size": { "type": "integer", "description": "size of the backuped data in bytes", "readOnly": true, "example": 4082 }, "type": { "enum": [ "web", "db", "mail" ], "type": "string", "description": "type of the backuped object", "readOnly": true, "example": "mail" }, "started": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z" }, "finished": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:35:28Z" }, "status": { "enum": [ "none", "submitted", "inPreparation", "running", "finished", "error" ], "type": "string", "description": "status of the backup", "readOnly": true, "example": "finished" }, "statusMsg": { "type": "string", "description": "human readable status message", "readOnly": true, "example": "Job finished successful" }, "storage": { "type": "string", "description": "backup-storage id", "readOnly": true, "example": "bIAzOg" } }, "required": null } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Backup" ], "summary": "restore a backup", "description": "This method creates a new restore", "parameters": [ { "name": "id", "in": "path", "description": "id of the backup", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Data of new restore", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the restore", "readOnly": true, "example": "bIAzOg" }, "backupType": { "enum": [ "web", "mail", "db" ], "type": "string", "description": "type of the backup", "readOnly": true, "example": "mail" }, "created": { "type": "string", "description": "timestamp of creation", "format": "datetime", "readOnly": true, "example": "2020-07-24T18:40:28Z" }, "started": { "type": "string", "description": "timestamp start of processing", "format": "datetime", "readOnly": true, "example": "2020-07-24T18:40:30Z" }, "finished": { "type": "string", "description": "timestamp restore finished", "format": "datetime", "readOnly": true, "example": "2020-07-24T18:44:28Z" }, "status": { "enum": [ "New", "Creating Temp Database User", "Temp Database User created", "Submitted", "Started", "Running", "Finished", "Error" ], "type": "string", "description": "status of the restore", "readOnly": true, "example": "finished" }, "statusMsg": { "type": "string", "description": "Human readable status message", "readOnly": true, "example": "Process finished successful" }, "destination": { "type": "string", "description": "restore destination", "example": "othermail@example.org" } } } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Backup" ], "summary": "Remove a backup", "parameters": [ { "name": "id", "in": "path", "description": "the id of the backup", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/backup\/jobs\/mail\/{id}": { "get": { "tags": [ "Backup" ], "summary": "Get details of a backup", "description": "This method returns the details of a backup.", "parameters": [ { "name": "id", "in": "path", "description": "id of the backup", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the backup", "readOnly": true, "example": "bIAzOg" }, "objectName": { "type": "string", "description": "name of the backuped object", "readOnly": true, "example": "web123@example.org" }, "archiveSize": { "type": "integer", "description": "size of the backuped archive in bytes", "readOnly": true, "example": 1258 }, "size": { "type": "integer", "description": "size of the backuped data in bytes", "readOnly": true, "example": 4082 }, "type": { "enum": [ "web", "db", "mail" ], "type": "string", "description": "type of the backuped object", "readOnly": true, "example": "mail" }, "started": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z" }, "finished": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:35:28Z" }, "status": { "enum": [ "none", "submitted", "inPreparation", "running", "finished", "error" ], "type": "string", "description": "status of the backup", "readOnly": true, "example": "finished" }, "statusMsg": { "type": "string", "description": "human readable status message", "readOnly": true, "example": "Job finished successful" }, "storage": { "type": "string", "description": "backup-storage id", "readOnly": true, "example": "bIAzOg" } }, "required": null } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Backup" ], "summary": "restore a backup", "description": "This method creates a new restore", "parameters": [ { "name": "id", "in": "path", "description": "id of the backup", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Data of new restore", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the restore", "readOnly": true, "example": "bIAzOg" }, "backupType": { "enum": [ "web", "mail", "db" ], "type": "string", "description": "type of the backup", "readOnly": true, "example": "mail" }, "created": { "type": "string", "description": "timestamp of creation", "format": "datetime", "readOnly": true, "example": "2020-07-24T18:40:28Z" }, "started": { "type": "string", "description": "timestamp start of processing", "format": "datetime", "readOnly": true, "example": "2020-07-24T18:40:30Z" }, "finished": { "type": "string", "description": "timestamp restore finished", "format": "datetime", "readOnly": true, "example": "2020-07-24T18:44:28Z" }, "status": { "enum": [ "New", "Creating Temp Database User", "Temp Database User created", "Submitted", "Started", "Running", "Finished", "Error" ], "type": "string", "description": "status of the restore", "readOnly": true, "example": "finished" }, "statusMsg": { "type": "string", "description": "Human readable status message", "readOnly": true, "example": "Process finished successful" }, "destination": { "type": "string", "description": "restore destination", "example": "othermail@example.org" } } } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Backup" ], "summary": "Remove a backup", "parameters": [ { "name": "id", "in": "path", "description": "the id of the backup", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/backup\/jobs\/db\/{id}": { "get": { "tags": [ "Backup" ], "summary": "Get details of a backup", "description": "This method returns the details of a backup.", "parameters": [ { "name": "id", "in": "path", "description": "id of the backup", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the backup", "readOnly": true, "example": "bIAzOg" }, "objectName": { "type": "string", "description": "name of the backuped object", "readOnly": true, "example": "web123@example.org" }, "archiveSize": { "type": "integer", "description": "size of the backuped archive in bytes", "readOnly": true, "example": 1258 }, "size": { "type": "integer", "description": "size of the backuped data in bytes", "readOnly": true, "example": 4082 }, "type": { "enum": [ "web", "db", "mail" ], "type": "string", "description": "type of the backuped object", "readOnly": true, "example": "mail" }, "started": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z" }, "finished": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:35:28Z" }, "status": { "enum": [ "none", "submitted", "inPreparation", "running", "finished", "error" ], "type": "string", "description": "status of the backup", "readOnly": true, "example": "finished" }, "statusMsg": { "type": "string", "description": "human readable status message", "readOnly": true, "example": "Job finished successful" }, "storage": { "type": "string", "description": "backup-storage id", "readOnly": true, "example": "bIAzOg" } }, "required": null } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Backup" ], "summary": "restore a backup", "description": "This method creates a new restore", "parameters": [ { "name": "id", "in": "path", "description": "id of the backup", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Data of new restore", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the restore", "readOnly": true, "example": "bIAzOg" }, "backupType": { "enum": [ "web", "mail", "db" ], "type": "string", "description": "type of the backup", "readOnly": true, "example": "mail" }, "created": { "type": "string", "description": "timestamp of creation", "format": "datetime", "readOnly": true, "example": "2020-07-24T18:40:28Z" }, "started": { "type": "string", "description": "timestamp start of processing", "format": "datetime", "readOnly": true, "example": "2020-07-24T18:40:30Z" }, "finished": { "type": "string", "description": "timestamp restore finished", "format": "datetime", "readOnly": true, "example": "2020-07-24T18:44:28Z" }, "status": { "enum": [ "New", "Creating Temp Database User", "Temp Database User created", "Submitted", "Started", "Running", "Finished", "Error" ], "type": "string", "description": "status of the restore", "readOnly": true, "example": "finished" }, "statusMsg": { "type": "string", "description": "Human readable status message", "readOnly": true, "example": "Process finished successful" }, "destination": { "type": "string", "description": "restore destination", "example": "othermail@example.org" } } } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Backup" ], "summary": "Remove a backup", "parameters": [ { "name": "id", "in": "path", "description": "the id of the backup", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/backup\/jobs\/restore\/{id}": { "get": { "tags": [ "Backup" ], "summary": "Get details of a restore", "description": "This method returns the details of a restore.", "parameters": [ { "name": "id", "in": "path", "description": "id of the restore", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the restore", "readOnly": true, "example": "bIAzOg" }, "backupType": { "enum": [ "web", "mail", "db" ], "type": "string", "description": "type of the backup", "readOnly": true, "example": "mail" }, "created": { "type": "string", "description": "timestamp of creation", "format": "datetime", "readOnly": true, "example": "2020-07-24T18:40:28Z" }, "started": { "type": "string", "description": "timestamp start of processing", "format": "datetime", "readOnly": true, "example": "2020-07-24T18:40:30Z" }, "finished": { "type": "string", "description": "timestamp restore finished", "format": "datetime", "readOnly": true, "example": "2020-07-24T18:44:28Z" }, "status": { "enum": [ "New", "Creating Temp Database User", "Temp Database User created", "Submitted", "Started", "Running", "Finished", "Error" ], "type": "string", "description": "status of the restore", "readOnly": true, "example": "finished" }, "statusMsg": { "type": "string", "description": "Human readable status message", "readOnly": true, "example": "Process finished successful" }, "destination": { "type": "string", "description": "restore destination", "example": "othermail@example.org" } } } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/backup\/jobs\/web\/{id}\/restores": { "get": { "tags": [ "Backup" ], "summary": "Get list of restores for backup", "description": "This method returns a list of restores.", "parameters": [ { "name": "id", "in": "path", "description": "id of the backup", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 1 }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the restore", "readOnly": true, "example": "bIAzOg" }, "backupType": { "enum": [ "web", "mail", "db" ], "type": "string", "description": "type of the backup", "readOnly": true, "example": "mail" }, "created": { "type": "string", "description": "timestamp of creation", "format": "datetime", "readOnly": true, "example": "2020-07-24T18:40:28Z" }, "started": { "type": "string", "description": "timestamp start of processing", "format": "datetime", "readOnly": true, "example": "2020-07-24T18:40:30Z" }, "finished": { "type": "string", "description": "timestamp restore finished", "format": "datetime", "readOnly": true, "example": "2020-07-24T18:44:28Z" }, "status": { "enum": [ "New", "Creating Temp Database User", "Temp Database User created", "Submitted", "Started", "Running", "Finished", "Error" ], "type": "string", "description": "status of the restore", "readOnly": true, "example": "finished" }, "statusMsg": { "type": "string", "description": "Human readable status message", "readOnly": true, "example": "Process finished successful" }, "destination": { "type": "string", "description": "restore destination", "example": "othermail@example.org" } } } } }, "description": "List of restores" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/backup\/jobs\/mail\/{id}\/restores": { "get": { "tags": [ "Backup" ], "summary": "Get list of restores for backup", "description": "This method returns a list of restores.", "parameters": [ { "name": "id", "in": "path", "description": "id of the backup", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 1 }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the restore", "readOnly": true, "example": "bIAzOg" }, "backupType": { "enum": [ "web", "mail", "db" ], "type": "string", "description": "type of the backup", "readOnly": true, "example": "mail" }, "created": { "type": "string", "description": "timestamp of creation", "format": "datetime", "readOnly": true, "example": "2020-07-24T18:40:28Z" }, "started": { "type": "string", "description": "timestamp start of processing", "format": "datetime", "readOnly": true, "example": "2020-07-24T18:40:30Z" }, "finished": { "type": "string", "description": "timestamp restore finished", "format": "datetime", "readOnly": true, "example": "2020-07-24T18:44:28Z" }, "status": { "enum": [ "New", "Creating Temp Database User", "Temp Database User created", "Submitted", "Started", "Running", "Finished", "Error" ], "type": "string", "description": "status of the restore", "readOnly": true, "example": "finished" }, "statusMsg": { "type": "string", "description": "Human readable status message", "readOnly": true, "example": "Process finished successful" }, "destination": { "type": "string", "description": "restore destination", "example": "othermail@example.org" } } } } }, "description": "List of restores" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/backup\/jobs\/db\/{id}\/restores": { "get": { "tags": [ "Backup" ], "summary": "Get list of restores for backup", "description": "This method returns a list of restores.", "parameters": [ { "name": "id", "in": "path", "description": "id of the backup", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 1 }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the restore", "readOnly": true, "example": "bIAzOg" }, "backupType": { "enum": [ "web", "mail", "db" ], "type": "string", "description": "type of the backup", "readOnly": true, "example": "mail" }, "created": { "type": "string", "description": "timestamp of creation", "format": "datetime", "readOnly": true, "example": "2020-07-24T18:40:28Z" }, "started": { "type": "string", "description": "timestamp start of processing", "format": "datetime", "readOnly": true, "example": "2020-07-24T18:40:30Z" }, "finished": { "type": "string", "description": "timestamp restore finished", "format": "datetime", "readOnly": true, "example": "2020-07-24T18:44:28Z" }, "status": { "enum": [ "New", "Creating Temp Database User", "Temp Database User created", "Submitted", "Started", "Running", "Finished", "Error" ], "type": "string", "description": "status of the restore", "readOnly": true, "example": "finished" }, "statusMsg": { "type": "string", "description": "Human readable status message", "readOnly": true, "example": "Process finished successful" }, "destination": { "type": "string", "description": "restore destination", "example": "othermail@example.org" } } } } }, "description": "List of restores" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/contacts": { "get": { "tags": [ "Contacts" ], "summary": "Get contacts list", "description": "This method returns a list of all contacts", "parameters": [ { "name": "count", "in": "query", "description": "number of results to return", "schema": { "minimum": 1, "type": "integer" } }, { "name": "page", "in": "query", "description": "page to return (offset), starting with `1`", "schema": { "minimum": 1, "type": "integer" } }, { "name": "search", "in": "query", "description": "search phrase (is matched against contact data)", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "sort results by given column (default: `lastName`)", "schema": { "enum": [ "type", "title", "firstName", "lastName", "company", "address1", "address2", "zipCode", "city", "country", "countryCode", "phone", "fax", "mobile", "email", "website", "useCount" ], "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 1 }, "data": { "type": "array", "items": { "allOf": [ { "required": [ "id", "type", "countryCode" ], "type": "object", "properties": { "id": { "type": "string", "description": "Encoded contact id", "readOnly": true, "example": "bIAzOg" }, "type": { "enum": [ "org", "person" ], "type": "string", "description": "Type of the contact. For `type == org` the field `company` is required. For `type == person` the fields `firstName` and `lastName` are required." }, "title": { "type": "string", "description": "title", "example": "Prof." }, "firstName": { "type": "string", "description": "First name", "example": "John" }, "lastName": { "type": "string", "description": "Last name", "example": "Doe" }, "company": { "type": "string", "description": "Company name", "example": "ACME Inc." }, "address1": { "type": "string", "description": "Address" }, "address2": { "type": "string", "description": "Address (2nd line)" }, "zipCode": { "type": "string", "description": "ZIP code" }, "city": { "type": "string", "description": "City name" }, "country": { "type": "string", "description": "Country name (localized)", "readOnly": true, "example": "Germany" }, "countryCode": { "type": "string", "description": "CountryCode in ISO 3166-1 Alpha 2", "example": "DE" }, "phone": { "type": "string", "description": "phone number" }, "fax": { "type": "string", "description": "fax number" }, "mobile": { "type": "string", "description": "mobile number" }, "email": { "type": "string", "description": "email address", "format": "email" }, "website": { "type": "string", "description": "website address" } } }, { "required": [ "useCount" ], "type": "object", "properties": { "useCount": { "type": "integer", "description": "Number of objects using this contact record", "example": 2 } } } ] } } }, "description": "a list of all contacts" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Contacts" ], "summary": "Add new contact", "description": "This method adds a new contact.", "requestBody": { "description": "Data of new contact", "content": { "application\/json": { "schema": { "required": [ "id", "type", "countryCode" ], "type": "object", "properties": { "id": { "type": "string", "description": "Encoded contact id", "readOnly": true, "example": "bIAzOg" }, "type": { "enum": [ "org", "person" ], "type": "string", "description": "Type of the contact. For `type == org` the field `company` is required. For `type == person` the fields `firstName` and `lastName` are required." }, "title": { "type": "string", "description": "title", "example": "Prof." }, "firstName": { "type": "string", "description": "First name", "example": "John" }, "lastName": { "type": "string", "description": "Last name", "example": "Doe" }, "company": { "type": "string", "description": "Company name", "example": "ACME Inc." }, "address1": { "type": "string", "description": "Address" }, "address2": { "type": "string", "description": "Address (2nd line)" }, "zipCode": { "type": "string", "description": "ZIP code" }, "city": { "type": "string", "description": "City name" }, "country": { "type": "string", "description": "Country name (localized)", "readOnly": true, "example": "Germany" }, "countryCode": { "type": "string", "description": "CountryCode in ISO 3166-1 Alpha 2", "example": "DE" }, "phone": { "type": "string", "description": "phone number" }, "fax": { "type": "string", "description": "fax number" }, "mobile": { "type": "string", "description": "mobile number" }, "email": { "type": "string", "description": "email address", "format": "email" }, "website": { "type": "string", "description": "website address" } } } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of new contact.", "example": "A1b2C3e4" } } } } } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/contacts\/{id}": { "get": { "tags": [ "Contacts" ], "summary": "Get contacts details", "description": "This method returns the detailed contact data", "parameters": [ { "name": "id", "in": "path", "description": "Contact id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "required": [ "id", "type", "countryCode" ], "type": "object", "properties": { "id": { "type": "string", "description": "Encoded contact id", "readOnly": true, "example": "bIAzOg" }, "type": { "enum": [ "org", "person" ], "type": "string", "description": "Type of the contact. For `type == org` the field `company` is required. For `type == person` the fields `firstName` and `lastName` are required." }, "title": { "type": "string", "description": "title", "example": "Prof." }, "firstName": { "type": "string", "description": "First name", "example": "John" }, "lastName": { "type": "string", "description": "Last name", "example": "Doe" }, "company": { "type": "string", "description": "Company name", "example": "ACME Inc." }, "address1": { "type": "string", "description": "Address" }, "address2": { "type": "string", "description": "Address (2nd line)" }, "zipCode": { "type": "string", "description": "ZIP code" }, "city": { "type": "string", "description": "City name" }, "country": { "type": "string", "description": "Country name (localized)", "readOnly": true, "example": "Germany" }, "countryCode": { "type": "string", "description": "CountryCode in ISO 3166-1 Alpha 2", "example": "DE" }, "phone": { "type": "string", "description": "phone number" }, "fax": { "type": "string", "description": "fax number" }, "mobile": { "type": "string", "description": "mobile number" }, "email": { "type": "string", "description": "email address", "format": "email" }, "website": { "type": "string", "description": "website address" } } } }, "description": "Contact details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Contacts" ], "summary": "Remove a contact", "parameters": [ { "name": "id", "in": "path", "description": "the id of the contact", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Contacts" ], "summary": "Edit a contact", "description": "This method edits a contact.", "parameters": [ { "name": "id", "in": "path", "description": "encoded id of the contact", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Contact data to be modified", "content": { "application\/json": { "schema": { "required": [ "id", "type", "countryCode" ], "type": "object", "properties": { "id": { "type": "string", "description": "Encoded contact id", "readOnly": true, "example": "bIAzOg" }, "type": { "enum": [ "org", "person" ], "type": "string", "description": "Type of the contact. For `type == org` the field `company` is required. For `type == person` the fields `firstName` and `lastName` are required." }, "title": { "type": "string", "description": "title", "example": "Prof." }, "firstName": { "type": "string", "description": "First name", "example": "John" }, "lastName": { "type": "string", "description": "Last name", "example": "Doe" }, "company": { "type": "string", "description": "Company name", "example": "ACME Inc." }, "address1": { "type": "string", "description": "Address" }, "address2": { "type": "string", "description": "Address (2nd line)" }, "zipCode": { "type": "string", "description": "ZIP code" }, "city": { "type": "string", "description": "City name" }, "country": { "type": "string", "description": "Country name (localized)", "readOnly": true, "example": "Germany" }, "countryCode": { "type": "string", "description": "CountryCode in ISO 3166-1 Alpha 2", "example": "DE" }, "phone": { "type": "string", "description": "phone number" }, "fax": { "type": "string", "description": "fax number" }, "mobile": { "type": "string", "description": "mobile number" }, "email": { "type": "string", "description": "email address", "format": "email" }, "website": { "type": "string", "description": "website address" } } } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/countries": { "get": { "tags": [ "Contacts" ], "summary": "Get list of countries", "description": "This method returns a list of all countries (country code is used by contacts)", "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Country code", "example": "DE" }, "name": { "type": "string", "description": "Country name", "example": "Germany" } } } } }, "description": "a list of all countries" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/customers": { "get": { "tags": [ "Customers" ], "summary": "Get customer list", "description": "This method returns a list of all customers", "parameters": [ { "name": "count", "in": "query", "description": "number of results to return", "schema": { "minimum": 1, "type": "integer" } }, { "name": "page", "in": "query", "description": "page to return (offset), starting with `1`", "schema": { "minimum": 1, "type": "integer" } }, { "name": "search", "in": "query", "description": "search phrase (is matched against `cid` and contact data)", "schema": { "type": "string" } }, { "name": "show", "in": "query", "description": "comma-separated list of additional data to show (`accounts`: add account overview list, `users`: show list of users for each customer)\n", "style": "form", "explode": false, "schema": { "type": "array", "items": { "enum": [ "accounts", "users" ], "type": "string" } } }, { "name": "sort", "in": "query", "description": "sort results by given column (default: `id`)", "schema": { "enum": [ "id", "firstname", "lastname", "company", "city", "accounts" ], "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 1 }, "data": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Customer id", "example": "C12345" }, "status": { "enum": [ "active", "locked", "disabled" ], "type": "string", "description": "current state of the customer" }, "contact": { "required": [ "id", "type", "countryCode" ], "type": "object", "properties": { "id": { "type": "string", "description": "Encoded contact id", "readOnly": true, "example": "bIAzOg" }, "type": { "enum": [ "org", "person" ], "type": "string", "description": "Type of the contact. For `type == org` the field `company` is required. For `type == person` the fields `firstName` and `lastName` are required." }, "title": { "type": "string", "description": "title", "example": "Prof." }, "firstName": { "type": "string", "description": "First name", "example": "John" }, "lastName": { "type": "string", "description": "Last name", "example": "Doe" }, "company": { "type": "string", "description": "Company name", "example": "ACME Inc." }, "address1": { "type": "string", "description": "Address" }, "address2": { "type": "string", "description": "Address (2nd line)" }, "zipCode": { "type": "string", "description": "ZIP code" }, "city": { "type": "string", "description": "City name" }, "country": { "type": "string", "description": "Country name (localized)", "readOnly": true, "example": "Germany" }, "countryCode": { "type": "string", "description": "CountryCode in ISO 3166-1 Alpha 2", "example": "DE" }, "phone": { "type": "string", "description": "phone number" }, "fax": { "type": "string", "description": "fax number" }, "mobile": { "type": "string", "description": "mobile number" }, "email": { "type": "string", "description": "email address", "format": "email" }, "website": { "type": "string", "description": "website address" } } }, "accounts": { "required": [ "count" ], "type": "object", "properties": { "count": { "type": "number", "description": "Number of accounts associated with this customer", "readOnly": true, "example": 3 }, "hasMail": { "type": "boolean", "description": "Customer has at least one account with e-mail enabled", "readOnly": true, "example": false }, "hasWebspace": { "type": "boolean", "description": "Customer has at least one account with webspace enabled", "readOnly": true, "example": true } }, "description": "Information on customers' accounts", "readOnly": true } } }, { "required": [ "cid", "contact", "status" ], "type": "object", "properties": { "users": { "type": "array", "items": { "type": "object", "properties": { "login": { "type": "string", "description": "User name (login)", "example": "foobar" }, "password": { "type": "string", "description": "Password of the user", "writeOnly": true, "example": "$ecr\u20act" }, "status": { "enum": [ "active", "locked" ], "type": "string", "description": "current state of the login" }, "forcePasswordChange": { "type": "boolean", "description": "flag if the user is forced to change his password after the next login", "writeOnly": true, "example": false }, "language": { "type": "string", "description": "language set for the login", "example": "de" }, "timezone": { "type": "string", "description": "name of the timezone set for the login", "default": "UTC", "example": "Europe\/Berlin" }, "otp": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "flag if OTP is enabled on this login", "example": false }, "description": { "type": "string", "description": "description of the OTP device", "example": "OTP Token used by John Doe" }, "secret": { "type": "string", "description": "initialization string of the OTP generator", "writeOnly": true, "example": "SfkbxvzhVozILu4Wyhyt" } }, "description": "OTP Settings of the login" }, "webauthn": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Login with Passkey or WebAuthn enabled", "example": false }, "devices": { "type": "number", "description": "Number of registered Passkey\/WebAuthn devices", "readOnly": true, "example": 2 } }, "description": "WebAuthn settings" }, "lastLoginIp": { "type": "string", "description": "IP address of last login", "readOnly": true }, "lastLoginTime": { "type": "string", "description": "Timestamp of last login", "format": "date-time", "readOnly": true }, "mainUser": { "type": "boolean", "description": "Is `true` if this is the main user of that customer", "readOnly": true, "example": true } } }, "description": "Array of LiveConfig users" } } }, { "type": "object", "properties": { "accounts": { "type": "object", "properties": { "list": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "account name", "example": "web1" }, "status": { "type": "object", "properties": { "email": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of email", "example": "active" }, "webspace": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of webspace", "example": "suspended" }, "ftp": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of ftp", "example": "locked" } }, "description": "account status" }, "template": { "type": "string", "description": "name of account template", "example": "WordPress Hosting Plan" } } }, "description": "list with account overview (only with `show=accounts`)" } } } } } ] } } }, "description": "a list of all customers" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Customers" ], "summary": "Add new customer", "description": "This method adds a new customer.", "requestBody": { "description": "Data of new customer", "content": { "application\/json": { "schema": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Customer id", "example": "C12345" }, "status": { "enum": [ "active", "locked", "disabled" ], "type": "string", "description": "current state of the customer" }, "contact": { "required": [ "id", "type", "countryCode" ], "type": "object", "properties": { "id": { "type": "string", "description": "Encoded contact id", "readOnly": true, "example": "bIAzOg" }, "type": { "enum": [ "org", "person" ], "type": "string", "description": "Type of the contact. For `type == org` the field `company` is required. For `type == person` the fields `firstName` and `lastName` are required." }, "title": { "type": "string", "description": "title", "example": "Prof." }, "firstName": { "type": "string", "description": "First name", "example": "John" }, "lastName": { "type": "string", "description": "Last name", "example": "Doe" }, "company": { "type": "string", "description": "Company name", "example": "ACME Inc." }, "address1": { "type": "string", "description": "Address" }, "address2": { "type": "string", "description": "Address (2nd line)" }, "zipCode": { "type": "string", "description": "ZIP code" }, "city": { "type": "string", "description": "City name" }, "country": { "type": "string", "description": "Country name (localized)", "readOnly": true, "example": "Germany" }, "countryCode": { "type": "string", "description": "CountryCode in ISO 3166-1 Alpha 2", "example": "DE" }, "phone": { "type": "string", "description": "phone number" }, "fax": { "type": "string", "description": "fax number" }, "mobile": { "type": "string", "description": "mobile number" }, "email": { "type": "string", "description": "email address", "format": "email" }, "website": { "type": "string", "description": "website address" } } }, "accounts": { "required": [ "count" ], "type": "object", "properties": { "count": { "type": "number", "description": "Number of accounts associated with this customer", "readOnly": true, "example": 3 }, "hasMail": { "type": "boolean", "description": "Customer has at least one account with e-mail enabled", "readOnly": true, "example": false }, "hasWebspace": { "type": "boolean", "description": "Customer has at least one account with webspace enabled", "readOnly": true, "example": true } }, "description": "Information on customers' accounts", "readOnly": true } } }, { "required": [ "id", "contact", "user" ], "type": "object", "properties": { "contact": { "type": "string", "description": "id of contact", "example": "bIAzOg" }, "user": { "allOf": [ { "type": "object", "properties": { "login": { "type": "string", "description": "User name (login)", "example": "foobar" }, "password": { "type": "string", "description": "Password of the user", "writeOnly": true, "example": "$ecr\u20act" }, "status": { "enum": [ "active", "locked" ], "type": "string", "description": "current state of the login" }, "forcePasswordChange": { "type": "boolean", "description": "flag if the user is forced to change his password after the next login", "writeOnly": true, "example": false }, "language": { "type": "string", "description": "language set for the login", "example": "de" }, "timezone": { "type": "string", "description": "name of the timezone set for the login", "default": "UTC", "example": "Europe\/Berlin" }, "otp": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "flag if OTP is enabled on this login", "example": false }, "description": { "type": "string", "description": "description of the OTP device", "example": "OTP Token used by John Doe" }, "secret": { "type": "string", "description": "initialization string of the OTP generator", "writeOnly": true, "example": "SfkbxvzhVozILu4Wyhyt" } }, "description": "OTP Settings of the login" }, "webauthn": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Login with Passkey or WebAuthn enabled", "example": false }, "devices": { "type": "number", "description": "Number of registered Passkey\/WebAuthn devices", "readOnly": true, "example": 2 } }, "description": "WebAuthn settings" }, "lastLoginIp": { "type": "string", "description": "IP address of last login", "readOnly": true }, "lastLoginTime": { "type": "string", "description": "Timestamp of last login", "format": "date-time", "readOnly": true }, "mainUser": { "type": "boolean", "description": "Is `true` if this is the main user of that customer", "readOnly": true, "example": true } } }, { "type": "object", "properties": { "contact": { "type": "string", "description": "id of contact", "example": "bIAzOg" } } } ] } } } ] } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/customers\/{id}": { "get": { "tags": [ "Customers" ], "summary": "Get customer details", "description": "Get detailed customer informations", "parameters": [ { "name": "id", "in": "path", "description": "Customer id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Customer id", "example": "C12345" }, "status": { "enum": [ "active", "locked", "disabled" ], "type": "string", "description": "current state of the customer" }, "contact": { "required": [ "id", "type", "countryCode" ], "type": "object", "properties": { "id": { "type": "string", "description": "Encoded contact id", "readOnly": true, "example": "bIAzOg" }, "type": { "enum": [ "org", "person" ], "type": "string", "description": "Type of the contact. For `type == org` the field `company` is required. For `type == person` the fields `firstName` and `lastName` are required." }, "title": { "type": "string", "description": "title", "example": "Prof." }, "firstName": { "type": "string", "description": "First name", "example": "John" }, "lastName": { "type": "string", "description": "Last name", "example": "Doe" }, "company": { "type": "string", "description": "Company name", "example": "ACME Inc." }, "address1": { "type": "string", "description": "Address" }, "address2": { "type": "string", "description": "Address (2nd line)" }, "zipCode": { "type": "string", "description": "ZIP code" }, "city": { "type": "string", "description": "City name" }, "country": { "type": "string", "description": "Country name (localized)", "readOnly": true, "example": "Germany" }, "countryCode": { "type": "string", "description": "CountryCode in ISO 3166-1 Alpha 2", "example": "DE" }, "phone": { "type": "string", "description": "phone number" }, "fax": { "type": "string", "description": "fax number" }, "mobile": { "type": "string", "description": "mobile number" }, "email": { "type": "string", "description": "email address", "format": "email" }, "website": { "type": "string", "description": "website address" } } }, "accounts": { "required": [ "count" ], "type": "object", "properties": { "count": { "type": "number", "description": "Number of accounts associated with this customer", "readOnly": true, "example": 3 }, "hasMail": { "type": "boolean", "description": "Customer has at least one account with e-mail enabled", "readOnly": true, "example": false }, "hasWebspace": { "type": "boolean", "description": "Customer has at least one account with webspace enabled", "readOnly": true, "example": true } }, "description": "Information on customers' accounts", "readOnly": true } } }, { "required": [ "id", "contact", "status" ], "type": "object", "properties": { "users": { "type": "array", "items": { "type": "object", "properties": { "login": { "type": "string", "description": "User name (login)", "example": "foobar" }, "password": { "type": "string", "description": "Password of the user", "writeOnly": true, "example": "$ecr\u20act" }, "status": { "enum": [ "active", "locked" ], "type": "string", "description": "current state of the login" }, "forcePasswordChange": { "type": "boolean", "description": "flag if the user is forced to change his password after the next login", "writeOnly": true, "example": false }, "language": { "type": "string", "description": "language set for the login", "example": "de" }, "timezone": { "type": "string", "description": "name of the timezone set for the login", "default": "UTC", "example": "Europe\/Berlin" }, "otp": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "flag if OTP is enabled on this login", "example": false }, "description": { "type": "string", "description": "description of the OTP device", "example": "OTP Token used by John Doe" }, "secret": { "type": "string", "description": "initialization string of the OTP generator", "writeOnly": true, "example": "SfkbxvzhVozILu4Wyhyt" } }, "description": "OTP Settings of the login" }, "webauthn": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Login with Passkey or WebAuthn enabled", "example": false }, "devices": { "type": "number", "description": "Number of registered Passkey\/WebAuthn devices", "readOnly": true, "example": 2 } }, "description": "WebAuthn settings" }, "lastLoginIp": { "type": "string", "description": "IP address of last login", "readOnly": true }, "lastLoginTime": { "type": "string", "description": "Timestamp of last login", "format": "date-time", "readOnly": true }, "mainUser": { "type": "boolean", "description": "Is `true` if this is the main user of that customer", "readOnly": true, "example": true } } }, "description": "Array of LiveConfig users" } } } ] } }, "description": "Customer details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Customers" ], "summary": "Remove a customer", "parameters": [ { "name": "id", "in": "path", "description": "Customer id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Customers" ], "summary": "Edit a customer", "description": "This method edits a customer", "parameters": [ { "name": "id", "in": "path", "description": "Customer id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Customer data to be modified", "content": { "application\/json": { "schema": { "type": "object", "properties": { "contact": { "type": "string", "description": "id of contact", "example": "bIAz0g" }, "id": { "type": "string", "description": "Customer id", "example": "C12345" }, "status": { "enum": [ "active", "locked", "disabled" ], "type": "string", "description": "current state of the customer" } } } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/customers\/{id}\/accounts": { "get": { "tags": [ "Customers" ], "summary": "Get all accounts for selected customer", "description": "This method returns a list of all accounts for the selected customer", "parameters": [ { "name": "id", "in": "path", "description": "customer ID", "required": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "description": "number of results to return", "schema": { "minimum": 1, "type": "integer" } }, { "name": "page", "in": "query", "description": "page to return (offset), starting with `1`", "schema": { "minimum": 1, "type": "integer" } }, { "name": "search", "in": "query", "description": "search phrase (is matched against account data)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 1 }, "data": { "type": "array", "items": { "allOf": [ { "allOf": [ { "type": "object", "properties": { "api": { "type": "boolean", "description": "Account has API access", "example": false }, "apps": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web applications installed via AppInstaller (`-1`: unlimited)", "example": 5 }, "backup": { "type": "object", "properties": { "plans": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "backup plan ID", "example": "a1b2c3" }, "keep": { "maximum": 999, "minimum": 1, "type": "number", "description": "number of backups to keep", "example": 5 } } } }, "count": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of manually triggered backups allowed (`-1`: unlimited)", "example": 5 }, "wait": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Minimum time to wait between two manual backups (in minutes)", "example": 15 } } }, "cgi": { "type": "boolean", "description": "Permission for CGI scripts", "example": false }, "cronjobs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of cron jobs (`-1`: unlimited)", "example": 20 }, "customers": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of customers (`-1`: unlimited)", "example": 100 }, "databases": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of databases (`-1`: unlimited)", "example": 10 }, "dbExtAccess": { "type": "boolean", "description": "Allow enabling external database access", "example": false }, "dns": { "type": "boolean", "description": "Permission to edit DNS entries", "example": true }, "dynDns": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of subdomains with dynamic DNS feature", "example": 10 }, "extDomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed external domains (`-1`: unlimited)", "example": 5 }, "ftpAccounts": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of FTP accounts (`-1`: unlimited)", "example": 5 }, "lac": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true }, "memMax": { "minimum": -1, "type": "integer", "description": "maximum memory (RAM) in MB", "example": 2048 }, "tasksMax": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of processes & threads", "example": 2000 } }, "description": "LiveConfig Account Container (LAC) settings - only available with appropriate license. Currently these settings are only available for hosting accounts, not with hosting templates!" }, "logrotate": { "type": "object", "properties": { "compress": { "type": "boolean", "description": "Compress rotated log files", "example": true }, "filterIPv4": { "maximum": 4, "minimum": 0, "type": "number", "description": "number of bytes to filter from IPv4 addresses in access.log", "example": 1 }, "filterIPv6": { "maximum": 4, "minimum": 0, "type": "number", "description": "filter IPv6 addresses in access.log (0=no filtering, 1= filter last 32 bit, 2 = filter last 64 bit, 3 = filter last 96 bit, 4 = filter whole address)", "example": 2 }, "rotateInterval": { "enum": [ "hour", "day", "week", "month" ], "type": "string", "description": "Rotation interval (mutually exclusive with `rotateSize`)", "example": "week" }, "rotateSize": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Rotation size in MB (mutually exclusive with `rotateInterval`)", "example": 1024 }, "keepCount": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of rotated log files to keep (mutually exclusive with `keepDays`)", "example": 5 }, "keepDays": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of days to keep rotated log files (mutually exclusive with `keepCount`)", "example": 100 } }, "description": "Log rotation settings" }, "mailaddrs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of e-mail addresses (`-1`: unlimited)", "example": 250 }, "mailboxes": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of mailboxes (`-1`: unlimited)", "example": 50 }, "mailquota": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "E-mail storage quota (MiB, `-1`: unlimited)", "example": 10240 }, "php": { "enum": [ "no", "suPHP", "FastCGI", "mod_php", "FPM" ], "type": "string", "description": "PHP support (`suPHP` is deprecated, not available for new templates, `mod_php` is highly disregarded for security reasons).", "example": "FPM" }, "resaleable": { "type": "boolean", "description": "Permission to create subordinated resellers", "example": false }, "shell": { "enum": [ "no", "scponly", "shell", "webShell" ], "type": "string", "description": "Shell access (no, SFTP only, bash, web shell (implies bash))", "example": "no" }, "ssi": { "type": "boolean", "description": "Permission for server-side includes (SSI)", "example": true }, "subdomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed subdomains (`-1`: unlimited; `www` subdomain is not counted)", "example": 5 }, "tls": { "type": "boolean", "description": "Support for TLS\/SSL (https)", "example": true }, "tlsManagement": { "type": "boolean", "description": "allow management of TLS\/SSL certificates (requires `tls=true`)", "example": false }, "users": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web interface users (`-1`: unlimited)", "example": 5 }, "webspace": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Webspace (MiB) (`-1`: unlimited)", "example": 10240 } } }, { "type": "object", "properties": { "comment": { "type": "string", "description": "comment for this account" }, "name": { "type": "string", "description": "account name", "example": "web1" }, "path": { "type": "string", "description": "account path", "readOnly": true, "example": "\/var\/www\/web1" }, "flags": { "type": "array", "items": { "enum": [ "ftp", "cron", "term" ], "type": "string" }, "readOnly": true }, "resellerAccount": { "type": "string", "description": "name of the reseller account, with which this account was created", "example": "res1" }, "templateName": { "type": "string", "description": "template name where this account is based on (use either this or templateId for account creation)", "nullable": true, "example": "Wordpress Hosting" }, "templateId": { "type": "string", "description": "id of the template this account is based on (use either this or templateName for account creation)", "nullable": true, "example": "bIAzOg" }, "editable": { "type": "boolean", "description": "current user may edit this account", "readOnly": true, "example": true } } } ] }, { "type": "object", "properties": { "dbserver": { "type": "object", "properties": { "id": { "type": "string", "description": "host ID", "example": "localhost" }, "hostname": { "type": "string", "description": "database server name", "example": "web01.example.org" }, "description": { "type": "string", "description": "optional server description" }, "flags": { "type": "array", "items": { "enum": [ "offline" ], "type": "string" }, "description": "list of server flags" } }, "description": "database server details" }, "mailserver": { "type": "object", "properties": { "id": { "type": "string", "description": "host ID", "example": "localhost" }, "hostname": { "type": "string", "description": "mail server name", "example": "web01.example.org" }, "description": { "type": "string", "description": "optional server description" }, "flags": { "type": "array", "items": { "enum": [ "offline" ], "type": "string" }, "description": "list of server flags" } }, "description": "mail server details" }, "webserver": { "type": "object", "properties": { "id": { "type": "string", "description": "host ID", "example": "localhost" }, "hostname": { "type": "string", "description": "web server name", "example": "web01.example.org" }, "description": { "type": "string", "description": "optional server description" }, "flags": { "type": "array", "items": { "enum": [ "offline" ], "type": "string" }, "description": "list of server flags" } }, "description": "web server details" }, "override": { "type": "array", "items": { "enum": [ "users", "api", "webspace", "ftpAccounts", "php", "cgi", "ssi", "cronjobs", "shell", "databases", "subdomains", "dns", "dynDns", "extDomains", "mailaddrs", "mailboxes", "mailquota", "logRotate", "compress", "logKeep", "filterIPv4", "filterIPv6", "backupCount", "backupWait" ], "type": "string" }, "description": "List of properties with custom values (overriding values from template)" }, "usage": { "type": "object", "properties": { "customers": { "type": "number", "description": "only with reseller accounts: number of customers created", "example": 2 }, "databases": { "type": "number", "description": "number of databases created", "example": 3 }, "mailaddrs": { "type": "number", "description": "number of existing e-mail addresses", "example": 23 }, "mailaddrsAssigned": { "type": "number", "description": "only with reseller accounts: number of e-mail addresses assigned to accounts", "example": 200 }, "mailboxes": { "type": "number", "description": "number of existing mailboxes (POP3\/IMAP)", "example": 12 }, "mailboxesAssigned": { "type": "number", "description": "only with reseller accounts: number of mailboxes (POP3\/IMAP) assigned to accounts", "example": 150 }, "mailquota": { "type": "number", "description": "actual mailbox storage in use (MiB)", "example": 124 }, "mailquotaAssigned": { "type": "number", "description": "mailbox storage assigned to mailboxes (MiB)", "example": 2048 }, "webspaceFiles": { "type": "number", "description": "number of files in webspace", "example": 123 }, "webspaceUsed": { "type": "number", "description": "webspace usage (bytes)", "example": 10231035 }, "webspaceTs": { "type": "string", "description": "timestamp of last webspace usage update", "format": "date-time", "example": "2022-09-01T09:00:22+05" } }, "description": "current usage statistics" }, "primaryDomain": { "type": "object", "properties": { "name": { "type": "string", "description": "primary (sub)domain name" }, "link": { "enum": [ "", "http", "https" ], "type": "string", "description": "hint, if domain is available via _http_ or _https_" } } }, "stats": { "type": "object", "properties": { "software": { "enum": [ "AWStats", "Webalizer" ], "type": "string", "description": "webstatistics software", "example": "AWStats" }, "subdomain": { "type": "string", "description": "domain for webstatistics", "example": "stats.example.com" }, "user": { "type": "string", "description": "user name for webstatistics", "example": "user" }, "lang": { "type": "string", "description": "language for webstatistics", "example": "de" } }, "description": "webstatistics details" }, "status": { "type": "object", "properties": { "email": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of email", "example": "active" }, "webspace": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of webspace", "example": "suspended" }, "ftp": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of ftp", "example": "locked" } }, "description": "account status" }, "deleted": { "type": "boolean", "description": "is `true` if account is being deleted", "example": "true" }, "traffic": { "type": "object", "properties": { "currentMonth": { "type": "object", "properties": { "hits": { "type": "integer", "description": "website hits", "readOnly": true, "example": 12 }, "in": { "type": "integer", "description": "bytes received", "readOnly": true, "example": 78943532 }, "out": { "type": "integer", "description": "bytes sent", "readOnly": true, "example": 2536543542 }, "ts": { "type": "string", "description": "timestamp of last update", "format": "date", "readOnly": true, "example": "2025-04-15T00:00:00Z" } }, "description": "traffic summary for current month", "readOnly": true }, "lastMonth": { "type": "object", "properties": { "hits": { "type": "integer", "description": "website hits", "readOnly": true, "example": 12 }, "in": { "type": "integer", "description": "bytes received", "readOnly": true, "example": 78943532 }, "out": { "type": "integer", "description": "bytes sent", "readOnly": true, "example": 2536543542 }, "ts": { "type": "string", "description": "timestamp of last update", "format": "date", "readOnly": true, "example": "2025-04-15T00:00:00Z" } }, "description": "traffic summary for last month", "readOnly": true } }, "description": "traffic summary for this account", "readOnly": true } } } ] } } }, "description": "a list of all accounts" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Customers" ], "summary": "Create new hosting account for a customer", "description": "This method adds a new hosting account to an existing customer", "parameters": [ { "name": "id", "in": "path", "description": "customer ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Data of new account", "content": { "application\/json": { "schema": { "allOf": [ { "allOf": [ { "type": "object", "properties": { "api": { "type": "boolean", "description": "Account has API access", "example": false }, "apps": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web applications installed via AppInstaller (`-1`: unlimited)", "example": 5 }, "backup": { "type": "object", "properties": { "plans": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "backup plan ID", "example": "a1b2c3" }, "keep": { "maximum": 999, "minimum": 1, "type": "number", "description": "number of backups to keep", "example": 5 } } } }, "count": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of manually triggered backups allowed (`-1`: unlimited)", "example": 5 }, "wait": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Minimum time to wait between two manual backups (in minutes)", "example": 15 } } }, "cgi": { "type": "boolean", "description": "Permission for CGI scripts", "example": false }, "cronjobs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of cron jobs (`-1`: unlimited)", "example": 20 }, "customers": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of customers (`-1`: unlimited)", "example": 100 }, "databases": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of databases (`-1`: unlimited)", "example": 10 }, "dbExtAccess": { "type": "boolean", "description": "Allow enabling external database access", "example": false }, "dns": { "type": "boolean", "description": "Permission to edit DNS entries", "example": true }, "dynDns": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of subdomains with dynamic DNS feature", "example": 10 }, "extDomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed external domains (`-1`: unlimited)", "example": 5 }, "ftpAccounts": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of FTP accounts (`-1`: unlimited)", "example": 5 }, "lac": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true }, "memMax": { "minimum": -1, "type": "integer", "description": "maximum memory (RAM) in MB", "example": 2048 }, "tasksMax": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of processes & threads", "example": 2000 } }, "description": "LiveConfig Account Container (LAC) settings - only available with appropriate license. Currently these settings are only available for hosting accounts, not with hosting templates!" }, "logrotate": { "type": "object", "properties": { "compress": { "type": "boolean", "description": "Compress rotated log files", "example": true }, "filterIPv4": { "maximum": 4, "minimum": 0, "type": "number", "description": "number of bytes to filter from IPv4 addresses in access.log", "example": 1 }, "filterIPv6": { "maximum": 4, "minimum": 0, "type": "number", "description": "filter IPv6 addresses in access.log (0=no filtering, 1= filter last 32 bit, 2 = filter last 64 bit, 3 = filter last 96 bit, 4 = filter whole address)", "example": 2 }, "rotateInterval": { "enum": [ "hour", "day", "week", "month" ], "type": "string", "description": "Rotation interval (mutually exclusive with `rotateSize`)", "example": "week" }, "rotateSize": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Rotation size in MB (mutually exclusive with `rotateInterval`)", "example": 1024 }, "keepCount": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of rotated log files to keep (mutually exclusive with `keepDays`)", "example": 5 }, "keepDays": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of days to keep rotated log files (mutually exclusive with `keepCount`)", "example": 100 } }, "description": "Log rotation settings" }, "mailaddrs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of e-mail addresses (`-1`: unlimited)", "example": 250 }, "mailboxes": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of mailboxes (`-1`: unlimited)", "example": 50 }, "mailquota": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "E-mail storage quota (MiB, `-1`: unlimited)", "example": 10240 }, "php": { "enum": [ "no", "suPHP", "FastCGI", "mod_php", "FPM" ], "type": "string", "description": "PHP support (`suPHP` is deprecated, not available for new templates, `mod_php` is highly disregarded for security reasons).", "example": "FPM" }, "resaleable": { "type": "boolean", "description": "Permission to create subordinated resellers", "example": false }, "shell": { "enum": [ "no", "scponly", "shell", "webShell" ], "type": "string", "description": "Shell access (no, SFTP only, bash, web shell (implies bash))", "example": "no" }, "ssi": { "type": "boolean", "description": "Permission for server-side includes (SSI)", "example": true }, "subdomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed subdomains (`-1`: unlimited; `www` subdomain is not counted)", "example": 5 }, "tls": { "type": "boolean", "description": "Support for TLS\/SSL (https)", "example": true }, "tlsManagement": { "type": "boolean", "description": "allow management of TLS\/SSL certificates (requires `tls=true`)", "example": false }, "users": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web interface users (`-1`: unlimited)", "example": 5 }, "webspace": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Webspace (MiB) (`-1`: unlimited)", "example": 10240 } } }, { "type": "object", "properties": { "comment": { "type": "string", "description": "comment for this account" }, "name": { "type": "string", "description": "account name", "example": "web1" }, "path": { "type": "string", "description": "account path", "readOnly": true, "example": "\/var\/www\/web1" }, "flags": { "type": "array", "items": { "enum": [ "ftp", "cron", "term" ], "type": "string" }, "readOnly": true }, "resellerAccount": { "type": "string", "description": "name of the reseller account, with which this account was created", "example": "res1" }, "templateName": { "type": "string", "description": "template name where this account is based on (use either this or templateId for account creation)", "nullable": true, "example": "Wordpress Hosting" }, "templateId": { "type": "string", "description": "id of the template this account is based on (use either this or templateName for account creation)", "nullable": true, "example": "bIAzOg" }, "editable": { "type": "boolean", "description": "current user may edit this account", "readOnly": true, "example": true } } } ] }, { "type": "object", "properties": { "dbserver": { "type": "string", "description": "host ID of the database server", "example": "localhost" }, "mailserver": { "type": "string", "description": "host ID of the mail server", "example": "localhost" }, "webserver": { "type": "string", "description": "host ID of the web server", "example": "localhost" }, "primaryDomain": { "type": "string", "description": "primary (sub)domain name for this account", "example": "www.example.org" }, "stats": { "type": "object", "properties": { "software": { "enum": [ "AWStats", "Webalizer" ], "type": "string", "description": "webstatistics software", "nullable": true, "example": "AWStats" }, "subdomain": { "type": "string", "description": "domain for webstatistics", "example": "stats.example.com" }, "user": { "type": "string", "description": "user name for webstatistics", "example": "user" }, "lang": { "type": "string", "description": "language for webstatistics", "example": "de" }, "password": { "type": "string", "description": "password for webstatistics", "writeOnly": true, "example": "SeCrEt" } }, "description": "webstatistics details" }, "status": { "type": "object", "properties": { "email": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of email", "example": "active" }, "webspace": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of webspace", "example": "suspended" }, "ftp": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of ftp", "example": "locked" } }, "description": "account status" } } } ] } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "409": { "description": "Conflict", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/customers\/{id}\/accounts\/{account}": { "get": { "tags": [ "Customers" ], "summary": "Get account details", "description": "This method returns the details of a customer's account", "parameters": [ { "name": "id", "in": "path", "description": "customer ID", "required": true, "schema": { "type": "string" } }, { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } }, { "name": "show", "in": "query", "description": "comma-separated list of additional data to show (`override`: list of overridden values, `template`: template object)\n", "style": "form", "explode": false, "schema": { "type": "array", "items": { "enum": [ "override", "template" ], "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "allOf": [ { "allOf": [ { "type": "object", "properties": { "api": { "type": "boolean", "description": "Account has API access", "example": false }, "apps": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web applications installed via AppInstaller (`-1`: unlimited)", "example": 5 }, "backup": { "type": "object", "properties": { "plans": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "backup plan ID", "example": "a1b2c3" }, "keep": { "maximum": 999, "minimum": 1, "type": "number", "description": "number of backups to keep", "example": 5 } } } }, "count": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of manually triggered backups allowed (`-1`: unlimited)", "example": 5 }, "wait": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Minimum time to wait between two manual backups (in minutes)", "example": 15 } } }, "cgi": { "type": "boolean", "description": "Permission for CGI scripts", "example": false }, "cronjobs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of cron jobs (`-1`: unlimited)", "example": 20 }, "customers": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of customers (`-1`: unlimited)", "example": 100 }, "databases": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of databases (`-1`: unlimited)", "example": 10 }, "dbExtAccess": { "type": "boolean", "description": "Allow enabling external database access", "example": false }, "dns": { "type": "boolean", "description": "Permission to edit DNS entries", "example": true }, "dynDns": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of subdomains with dynamic DNS feature", "example": 10 }, "extDomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed external domains (`-1`: unlimited)", "example": 5 }, "ftpAccounts": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of FTP accounts (`-1`: unlimited)", "example": 5 }, "lac": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true }, "memMax": { "minimum": -1, "type": "integer", "description": "maximum memory (RAM) in MB", "example": 2048 }, "tasksMax": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of processes & threads", "example": 2000 } }, "description": "LiveConfig Account Container (LAC) settings - only available with appropriate license. Currently these settings are only available for hosting accounts, not with hosting templates!" }, "logrotate": { "type": "object", "properties": { "compress": { "type": "boolean", "description": "Compress rotated log files", "example": true }, "filterIPv4": { "maximum": 4, "minimum": 0, "type": "number", "description": "number of bytes to filter from IPv4 addresses in access.log", "example": 1 }, "filterIPv6": { "maximum": 4, "minimum": 0, "type": "number", "description": "filter IPv6 addresses in access.log (0=no filtering, 1= filter last 32 bit, 2 = filter last 64 bit, 3 = filter last 96 bit, 4 = filter whole address)", "example": 2 }, "rotateInterval": { "enum": [ "hour", "day", "week", "month" ], "type": "string", "description": "Rotation interval (mutually exclusive with `rotateSize`)", "example": "week" }, "rotateSize": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Rotation size in MB (mutually exclusive with `rotateInterval`)", "example": 1024 }, "keepCount": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of rotated log files to keep (mutually exclusive with `keepDays`)", "example": 5 }, "keepDays": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of days to keep rotated log files (mutually exclusive with `keepCount`)", "example": 100 } }, "description": "Log rotation settings" }, "mailaddrs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of e-mail addresses (`-1`: unlimited)", "example": 250 }, "mailboxes": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of mailboxes (`-1`: unlimited)", "example": 50 }, "mailquota": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "E-mail storage quota (MiB, `-1`: unlimited)", "example": 10240 }, "php": { "enum": [ "no", "suPHP", "FastCGI", "mod_php", "FPM" ], "type": "string", "description": "PHP support (`suPHP` is deprecated, not available for new templates, `mod_php` is highly disregarded for security reasons).", "example": "FPM" }, "resaleable": { "type": "boolean", "description": "Permission to create subordinated resellers", "example": false }, "shell": { "enum": [ "no", "scponly", "shell", "webShell" ], "type": "string", "description": "Shell access (no, SFTP only, bash, web shell (implies bash))", "example": "no" }, "ssi": { "type": "boolean", "description": "Permission for server-side includes (SSI)", "example": true }, "subdomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed subdomains (`-1`: unlimited; `www` subdomain is not counted)", "example": 5 }, "tls": { "type": "boolean", "description": "Support for TLS\/SSL (https)", "example": true }, "tlsManagement": { "type": "boolean", "description": "allow management of TLS\/SSL certificates (requires `tls=true`)", "example": false }, "users": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web interface users (`-1`: unlimited)", "example": 5 }, "webspace": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Webspace (MiB) (`-1`: unlimited)", "example": 10240 } } }, { "type": "object", "properties": { "comment": { "type": "string", "description": "comment for this account" }, "name": { "type": "string", "description": "account name", "example": "web1" }, "path": { "type": "string", "description": "account path", "readOnly": true, "example": "\/var\/www\/web1" }, "flags": { "type": "array", "items": { "enum": [ "ftp", "cron", "term" ], "type": "string" }, "readOnly": true }, "resellerAccount": { "type": "string", "description": "name of the reseller account, with which this account was created", "example": "res1" }, "templateName": { "type": "string", "description": "template name where this account is based on (use either this or templateId for account creation)", "nullable": true, "example": "Wordpress Hosting" }, "templateId": { "type": "string", "description": "id of the template this account is based on (use either this or templateName for account creation)", "nullable": true, "example": "bIAzOg" }, "editable": { "type": "boolean", "description": "current user may edit this account", "readOnly": true, "example": true } } } ] }, { "type": "object", "properties": { "dbserver": { "type": "object", "properties": { "id": { "type": "string", "description": "host ID", "example": "localhost" }, "hostname": { "type": "string", "description": "database server name", "example": "web01.example.org" }, "description": { "type": "string", "description": "optional server description" }, "flags": { "type": "array", "items": { "enum": [ "offline" ], "type": "string" }, "description": "list of server flags" } }, "description": "database server details" }, "mailserver": { "type": "object", "properties": { "id": { "type": "string", "description": "host ID", "example": "localhost" }, "hostname": { "type": "string", "description": "mail server name", "example": "web01.example.org" }, "description": { "type": "string", "description": "optional server description" }, "flags": { "type": "array", "items": { "enum": [ "offline" ], "type": "string" }, "description": "list of server flags" } }, "description": "mail server details" }, "webserver": { "type": "object", "properties": { "id": { "type": "string", "description": "host ID", "example": "localhost" }, "hostname": { "type": "string", "description": "web server name", "example": "web01.example.org" }, "description": { "type": "string", "description": "optional server description" }, "flags": { "type": "array", "items": { "enum": [ "offline" ], "type": "string" }, "description": "list of server flags" } }, "description": "web server details" }, "override": { "type": "array", "items": { "enum": [ "users", "api", "webspace", "ftpAccounts", "php", "cgi", "ssi", "cronjobs", "shell", "databases", "subdomains", "dns", "dynDns", "extDomains", "mailaddrs", "mailboxes", "mailquota", "logRotate", "compress", "logKeep", "filterIPv4", "filterIPv6", "backupCount", "backupWait" ], "type": "string" }, "description": "List of properties with custom values (overriding values from template)" }, "usage": { "type": "object", "properties": { "customers": { "type": "number", "description": "only with reseller accounts: number of customers created", "example": 2 }, "databases": { "type": "number", "description": "number of databases created", "example": 3 }, "mailaddrs": { "type": "number", "description": "number of existing e-mail addresses", "example": 23 }, "mailaddrsAssigned": { "type": "number", "description": "only with reseller accounts: number of e-mail addresses assigned to accounts", "example": 200 }, "mailboxes": { "type": "number", "description": "number of existing mailboxes (POP3\/IMAP)", "example": 12 }, "mailboxesAssigned": { "type": "number", "description": "only with reseller accounts: number of mailboxes (POP3\/IMAP) assigned to accounts", "example": 150 }, "mailquota": { "type": "number", "description": "actual mailbox storage in use (MiB)", "example": 124 }, "mailquotaAssigned": { "type": "number", "description": "mailbox storage assigned to mailboxes (MiB)", "example": 2048 }, "webspaceFiles": { "type": "number", "description": "number of files in webspace", "example": 123 }, "webspaceUsed": { "type": "number", "description": "webspace usage (bytes)", "example": 10231035 }, "webspaceTs": { "type": "string", "description": "timestamp of last webspace usage update", "format": "date-time", "example": "2022-09-01T09:00:22+05" } }, "description": "current usage statistics" }, "primaryDomain": { "type": "object", "properties": { "name": { "type": "string", "description": "primary (sub)domain name" }, "link": { "enum": [ "", "http", "https" ], "type": "string", "description": "hint, if domain is available via _http_ or _https_" } } }, "stats": { "type": "object", "properties": { "software": { "enum": [ "AWStats", "Webalizer" ], "type": "string", "description": "webstatistics software", "example": "AWStats" }, "subdomain": { "type": "string", "description": "domain for webstatistics", "example": "stats.example.com" }, "user": { "type": "string", "description": "user name for webstatistics", "example": "user" }, "lang": { "type": "string", "description": "language for webstatistics", "example": "de" } }, "description": "webstatistics details" }, "status": { "type": "object", "properties": { "email": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of email", "example": "active" }, "webspace": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of webspace", "example": "suspended" }, "ftp": { "enum": [ "active", "suspended", "locked" ], "type": "string", "description": "status of ftp", "example": "locked" } }, "description": "account status" }, "deleted": { "type": "boolean", "description": "is `true` if account is being deleted", "example": "true" }, "traffic": { "type": "object", "properties": { "currentMonth": { "type": "object", "properties": { "hits": { "type": "integer", "description": "website hits", "readOnly": true, "example": 12 }, "in": { "type": "integer", "description": "bytes received", "readOnly": true, "example": 78943532 }, "out": { "type": "integer", "description": "bytes sent", "readOnly": true, "example": 2536543542 }, "ts": { "type": "string", "description": "timestamp of last update", "format": "date", "readOnly": true, "example": "2025-04-15T00:00:00Z" } }, "description": "traffic summary for current month", "readOnly": true }, "lastMonth": { "type": "object", "properties": { "hits": { "type": "integer", "description": "website hits", "readOnly": true, "example": 12 }, "in": { "type": "integer", "description": "bytes received", "readOnly": true, "example": 78943532 }, "out": { "type": "integer", "description": "bytes sent", "readOnly": true, "example": 2536543542 }, "ts": { "type": "string", "description": "timestamp of last update", "format": "date", "readOnly": true, "example": "2025-04-15T00:00:00Z" } }, "description": "traffic summary for last month", "readOnly": true } }, "description": "traffic summary for this account", "readOnly": true } } } ] } }, "description": "Account details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Customers" ], "summary": "Edit a customer's account details", "description": "This method edits an existing account", "parameters": [ { "name": "id", "in": "path", "description": "customer ID", "required": true, "schema": { "type": "string" } }, { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } } ], "requestBody": { "description": "Account data to be modified", "content": { "application\/json": { "schema": { "allOf": [ { "type": "object", "properties": { "api": { "type": "boolean", "description": "Account has API access", "example": false }, "apps": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web applications installed via AppInstaller (`-1`: unlimited)", "example": 5 }, "backup": { "type": "object", "properties": { "plans": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "backup plan ID", "example": "a1b2c3" }, "keep": { "maximum": 999, "minimum": 1, "type": "number", "description": "number of backups to keep", "example": 5 } } } }, "count": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of manually triggered backups allowed (`-1`: unlimited)", "example": 5 }, "wait": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Minimum time to wait between two manual backups (in minutes)", "example": 15 } } }, "cgi": { "type": "boolean", "description": "Permission for CGI scripts", "example": false }, "cronjobs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of cron jobs (`-1`: unlimited)", "example": 20 }, "customers": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of customers (`-1`: unlimited)", "example": 100 }, "databases": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of databases (`-1`: unlimited)", "example": 10 }, "dbExtAccess": { "type": "boolean", "description": "Allow enabling external database access", "example": false }, "dns": { "type": "boolean", "description": "Permission to edit DNS entries", "example": true }, "dynDns": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of subdomains with dynamic DNS feature", "example": 10 }, "extDomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed external domains (`-1`: unlimited)", "example": 5 }, "ftpAccounts": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of FTP accounts (`-1`: unlimited)", "example": 5 }, "lac": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true }, "memMax": { "minimum": -1, "type": "integer", "description": "maximum memory (RAM) in MB", "example": 2048 }, "tasksMax": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of processes & threads", "example": 2000 } }, "description": "LiveConfig Account Container (LAC) settings - only available with appropriate license. Currently these settings are only available for hosting accounts, not with hosting templates!" }, "logrotate": { "type": "object", "properties": { "compress": { "type": "boolean", "description": "Compress rotated log files", "example": true }, "filterIPv4": { "maximum": 4, "minimum": 0, "type": "number", "description": "number of bytes to filter from IPv4 addresses in access.log", "example": 1 }, "filterIPv6": { "maximum": 4, "minimum": 0, "type": "number", "description": "filter IPv6 addresses in access.log (0=no filtering, 1= filter last 32 bit, 2 = filter last 64 bit, 3 = filter last 96 bit, 4 = filter whole address)", "example": 2 }, "rotateInterval": { "enum": [ "hour", "day", "week", "month" ], "type": "string", "description": "Rotation interval (mutually exclusive with `rotateSize`)", "example": "week" }, "rotateSize": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Rotation size in MB (mutually exclusive with `rotateInterval`)", "example": 1024 }, "keepCount": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of rotated log files to keep (mutually exclusive with `keepDays`)", "example": 5 }, "keepDays": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of days to keep rotated log files (mutually exclusive with `keepCount`)", "example": 100 } }, "description": "Log rotation settings" }, "mailaddrs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of e-mail addresses (`-1`: unlimited)", "example": 250 }, "mailboxes": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of mailboxes (`-1`: unlimited)", "example": 50 }, "mailquota": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "E-mail storage quota (MiB, `-1`: unlimited)", "example": 10240 }, "php": { "enum": [ "no", "suPHP", "FastCGI", "mod_php", "FPM" ], "type": "string", "description": "PHP support (`suPHP` is deprecated, not available for new templates, `mod_php` is highly disregarded for security reasons).", "example": "FPM" }, "resaleable": { "type": "boolean", "description": "Permission to create subordinated resellers", "example": false }, "shell": { "enum": [ "no", "scponly", "shell", "webShell" ], "type": "string", "description": "Shell access (no, SFTP only, bash, web shell (implies bash))", "example": "no" }, "ssi": { "type": "boolean", "description": "Permission for server-side includes (SSI)", "example": true }, "subdomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed subdomains (`-1`: unlimited; `www` subdomain is not counted)", "example": 5 }, "tls": { "type": "boolean", "description": "Support for TLS\/SSL (https)", "example": true }, "tlsManagement": { "type": "boolean", "description": "allow management of TLS\/SSL certificates (requires `tls=true`)", "example": false }, "users": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web interface users (`-1`: unlimited)", "example": 5 }, "webspace": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Webspace (MiB) (`-1`: unlimited)", "example": 10240 } } }, { "type": "object", "properties": { "comment": { "type": "string", "description": "comment for this account" }, "name": { "type": "string", "description": "account name", "example": "web1" }, "path": { "type": "string", "description": "account path", "readOnly": true, "example": "\/var\/www\/web1" }, "flags": { "type": "array", "items": { "enum": [ "ftp", "cron", "term" ], "type": "string" }, "readOnly": true }, "resellerAccount": { "type": "string", "description": "name of the reseller account, with which this account was created", "example": "res1" }, "templateName": { "type": "string", "description": "template name where this account is based on (use either this or templateId for account creation)", "nullable": true, "example": "Wordpress Hosting" }, "templateId": { "type": "string", "description": "id of the template this account is based on (use either this or templateName for account creation)", "nullable": true, "example": "bIAzOg" }, "editable": { "type": "boolean", "description": "current user may edit this account", "readOnly": true, "example": true } } } ] } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/customers\/{id}\/domains": { "get": { "tags": [ "Customers" ], "summary": "Get domain list for selected customer", "description": "This method returns a list of all domains (and optionally subdomains) for the selected customer", "parameters": [ { "name": "id", "in": "path", "description": "customer ID", "required": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "description": "number of results to return", "schema": { "minimum": 1, "type": "integer" } }, { "name": "page", "in": "query", "description": "page to return (offset), starting with `1`", "schema": { "minimum": 1, "type": "integer" } }, { "name": "search", "in": "query", "description": "search phrase (is matched against `account`, `domain`, `idn`, `subdomains.host` and `subdomains.idn`)", "schema": { "type": "string" } }, { "name": "show", "in": "query", "description": "comma-separated list of additional data to show (`subdomains`: show subdomain data, `subdomainList`: return a \"flattened\" list with subdomain data)\n", "style": "form", "explode": false, "schema": { "type": "array", "items": { "enum": [ "subdomains", "subdomainList" ], "type": "string" } } }, { "name": "sort", "in": "query", "description": "sort results by given column (default: `domain`)", "schema": { "enum": [ "account", "dnsTemplate", "domain", "punycode" ], "type": "string" } }, { "name": "account", "in": "query", "description": "optionally filter for (sub)domains of this account", "schema": { "type": "string" } }, { "name": "flag", "in": "query", "description": "optionally filter for subdomains with e-mail respective webspace enabled (requires `show=subdomains|subdomainList`)", "schema": { "enum": [ "mail", "web" ], "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "count": { "type": "integer", "description": "number of records found" }, "data": { "type": "array", "items": { "oneOf": [ { "allOf": [ { "required": [ "account", "domain" ], "type": "object", "properties": { "account": { "type": "string", "description": "account where this domain is assigned to" }, "domain": { "type": "string", "description": "internationalized domain name (UTF-8)" }, "punycode": { "type": "string", "description": "punycode representation (`xn--...`) if this is an IDN (Internationalized Domain Name)" } } }, { "required": [ "flags" ], "type": "object", "properties": { "flags": { "type": "array", "items": { "enum": [ "disabled", "dnssec", "editable", "external" ], "type": "string", "description": "feature flags\n * `disabled`: domain is disabled\n * `dnssec`: DNSSEC is enabled\n * `editable`: domain settings can be edited by current user (own external domain, own managed domain or managed domain of own customer)\n * `external`: external DNS server (not managed by LiveConfig)" }, "description": "array of feature flags" }, "subdomains": { "type": "array", "items": { "allOf": [ { "required": [ "flags", "host", "hostPunycode" ], "type": "object", "properties": { "flags": { "type": "array", "items": { "enum": [ "mail", "web" ], "type": "string", "description": "feature flags\n * `mail`: e-mail is enabled with this subdomain\n * `web`: webspace is enabled\/configured with this subdomain" }, "description": "array of feature flags" } } }, { "type": "object", "properties": { "host": { "type": "string", "description": "subdomain name (without domain part, UTF-8)" }, "hostPunycode": { "type": "string", "description": "punycode representation (`xn--...`) if this is an IDN (Internationalized Domain Name)" }, "web": { "required": [ "destination", "type" ], "type": "object", "properties": { "destination": { "type": "string", "description": "destination for this webspace, depending on `type` value (e.g. a path, a URL, or an application name)" }, "tls": { "type": "boolean", "description": "is set to `true` if a TLS certificate is configured with this subdomain" }, "type": { "enum": [ "webspace", 301, 302, "proxy", "app", "redirect", "builder" ], "type": "string", "description": "webspace destination:\n * `webspace`: webspace (directory)\n * `301` permanent HTTP redirect\n * `302` temporary HTTP redirect\n * `proxy` proxy (mirror) another URL\n * `app` web application\n * `redirect` redirect to HTTPS\n * `builder` website builder\n" } }, "description": "webspace configuration for this subdomain" } } } ] }, "description": "subdomain list (only returned with `show=subdomains`)" } } } ] }, { "allOf": [ { "required": [ "account", "domain" ], "type": "object", "properties": { "account": { "type": "string", "description": "account where this domain is assigned to" }, "domain": { "type": "string", "description": "internationalized domain name (UTF-8)" }, "punycode": { "type": "string", "description": "punycode representation (`xn--...`) if this is an IDN (Internationalized Domain Name)" } } }, { "required": [ "flags" ], "type": "object", "properties": { "flags": { "type": "array", "items": { "enum": [ "disabled", "dnssec", "external", "mail", "web" ], "type": "string", "description": "feature flags\n * `disabled`: domain is disabled\n * `dnssec`: DNSSEC is enabled\n * `external`: external DNS server (not managed by LiveConfig)\n * `mail`: e-mail is enabled with this subdomain\n * `web`: webspace is enabled\/configured with this subdomain" }, "description": "array of feature flags" } }, "description": "This \"flattened\" domain\/subdomain list is returned on `show=subdomainList`\n" }, { "type": "object", "properties": { "host": { "type": "string", "description": "subdomain name (without domain part, UTF-8)" }, "hostPunycode": { "type": "string", "description": "punycode representation (`xn--...`) if this is an IDN (Internationalized Domain Name)" }, "web": { "required": [ "destination", "type" ], "type": "object", "properties": { "destination": { "type": "string", "description": "destination for this webspace, depending on `type` value (e.g. a path, a URL, or an application name)" }, "tls": { "type": "boolean", "description": "is set to `true` if a TLS certificate is configured with this subdomain" }, "type": { "enum": [ "webspace", 301, 302, "proxy", "app", "redirect", "builder" ], "type": "string", "description": "webspace destination:\n * `webspace`: webspace (directory)\n * `301` permanent HTTP redirect\n * `302` temporary HTTP redirect\n * `proxy` proxy (mirror) another URL\n * `app` web application\n * `redirect` redirect to HTTPS\n * `builder` website builder\n" } }, "description": "webspace configuration for this subdomain" } } } ] } ] } } }, "description": "a list of all domains", "example": { "success": true, "count": 0, "data": [ { "id": "1a2b3c4d", "dnssec": false } ] } } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Customers" ], "summary": "Add new domain for selected customer", "description": "This method adds a new domain for the selected customer", "parameters": [ { "name": "id", "in": "path", "description": "customer ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Data of new domain", "content": { "application\/json": { "schema": { "anyOf": [ { "allOf": [ { "required": [ "account", "domain" ], "type": "object", "properties": { "account": { "type": "string", "description": "account name (where this domain is attached to)", "example": "web1" }, "apps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "identifier for this web application", "example": "wp1" }, "name": { "type": "string", "description": "name of web application software", "example": "Wordpress" } } }, "description": "list of successfully installed (selectable) web applications (only returned with `show=apps`)", "readOnly": true }, "dnsSerial": { "type": "number", "description": "initial serial number when creating domain on primary DNS (is only saved when DNS template is changed)", "example": 2025093001 }, "dnsTemplate": { "type": "string", "description": "name of DNS template (if domain is managed on own DNS servers)", "example": "my DNS template" }, "dnssec": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "is `true` if DNSSEC is enabled" }, "addKeys": { "type": "array", "items": { "type": "number" }, "description": "array of DNSSEC key types to add (e.g. `13` for _ECDSA\/SHA256_)", "writeOnly": true, "example": [ 13 ] }, "delKeys": { "type": "array", "items": { "type": "number" }, "description": "array of key IDs to remove (only valid when editing existing domain)", "writeOnly": true, "example": [ 18359 ] }, "ksk": { "type": "array", "items": { "type": "object", "properties": { "algorithm": { "type": "number", "description": "key algorithm (e.g. 13 = ECDSAP256SHA256)", "example": 13 }, "created": { "type": "string", "description": "timestamp when key was created", "format": "date-time", "example": "2025-06-10T08:55:12+02" }, "tag": { "type": "number", "description": "key tag", "example": 23456 }, "digest": { "type": "string", "description": "SHA256 digest of public key (used for DS record)", "example": "E690945A4490A8E9B7ED0C6640C1C7214EF958698C2958B048C10860968104EA" }, "digestType": { "type": "integer", "description": "type of the digest used", "example": 2 }, "flags": { "type": "integer", "description": "used dnssec flags", "example": 257 }, "protocol": { "type": "integer", "description": "key protocol", "example": 3 }, "dnskey": { "type": "string", "description": "base64 encoded public key", "example": "LAPNXZ1E9zRWlGvgV87+xM ... WdAUwJLDbiWcc7Iw==" } } }, "description": "array of key signing keys (KSK)", "readOnly": true } }, "description": "DNSSEC settings (only if domain is managed on own DNS)" }, "domain": { "type": "string", "description": "the domain name", "example": "example.org" }, "punycode": { "type": "string", "description": "punycode representation (`xn--...`) if this is an IDN (Internationalized Domain Name)", "readOnly": true }, "dns": { "type": "object", "properties": { "defaultRrTtl": { "type": "integer", "description": "Default TTL for resource records of this domain", "readOnly": true, "example": 3600 } } } } }, { "required": [ "host" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "noAutoA": { "type": "boolean", "description": "if webspace is enabled: don't create automatic A\/AAAA records" }, "noAutoMx": { "type": "boolean", "description": "if e-mail is enabled: don't create automatic MX record" }, "rr": { "type": "array", "items": { "required": [ "host", "editable", "type" ], "type": "object", "properties": { "host": { "type": "string", "description": "hostname of this resource record", "example": "mail._domainkey.example.org" }, "editable": { "type": "boolean", "description": "flag if this entry can be edited or is managed by liveconfig itself", "example": false }, "type": { "enum": [ "A", "AAAA", "TXT", "MX", "CAA", "CNAME", "NS", "SRV", "TLSA", "PTR" ], "type": "string", "description": "type of the resource record", "example": "A" }, "ttl": { "type": "integer", "description": "ttl of this resource record in seconds or `null` to use default", "example": 3600 }, "address": { "type": "string", "description": "IPv4 address for `type == A` or IPv6 address for `type == AAAA`", "example": "192.168.123.23" }, "serverName": { "type": "string", "description": "server name for this resource record (only if `type` is one of `CNAME`,`MX`,`NS`,`SRV`,`PTR`)", "example": "www.example.org" }, "prio": { "type": "integer", "description": "priority of this resource record (only if `type` is one of `MX`,`SRV`)", "example": 10 }, "value": { "type": "string", "description": "value for this resource record (only if `type` is one of `TXT`,`CAA`)", "example": "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSI...wIDAQAB" }, "weight": { "type": "integer", "description": "the weight of this resource record (only if `type == SRV`)", "example": 10 }, "port": { "type": "integer", "description": "port of this resource record (only if `type == SRV`)", "example": 8443, "min": 1, "max": 65535 }, "usage": { "type": "integer", "description": "the TLSA usage of this entry (only if `type == TLSA`)", "example": 2, "min": 0, "max": 3 }, "selector": { "type": "integer", "description": "the TLSA selector of this entry (only if `type == TLSA`)", "example": 0, "min": 0, "max": 1 }, "matchingType": { "type": "integer", "description": "the TLSA matching type of this entry (only if `type == TLSA`)", "example": 0, "min": 0, "max": 2 }, "key": { "type": "string", "description": "the TLSA key of this entry (only if `type == TLSA`)", "example": "CA43DC21A123BB..." }, "tag": { "enum": [ "issue", "issuewild", "issuemail", "iodef" ], "type": "string", "description": "the CAA tag for this entry (only if `type == CAA`)", "example": "issue" } } }, "description": "list of resource records" } } }, "ipGroup": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "name of this IP group", "example": "default" }, "software": { "enum": [ "apache", "nginx" ], "type": "string", "description": "web server software this IP group is assigned to", "readOnly": true, "example": "apache" } } }, { "type": "object", "properties": { "ips": { "type": "array", "items": { "type": "string" }, "description": "list of all IP addresses in this IP group", "readOnly": true, "example": [ "198.51.100.42", "2a01:db8:cafe::42" ] } } } ] }, "ipGroups": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "name of this IP group", "example": "default" }, "software": { "enum": [ "apache", "nginx" ], "type": "string", "description": "web server software this IP group is assigned to", "readOnly": true, "example": "apache" } } }, { "type": "object", "properties": { "ips": { "type": "array", "items": { "type": "string" }, "description": "list of all IP addresses in this IP group", "readOnly": true, "example": [ "198.51.100.42", "2a01:db8:cafe::42" ] } } } ] }, "description": "list of available IP groups, returned only with `show=ipGroups`", "readOnly": true }, "mail": { "type": "object", "properties": { "autoconfig": { "type": "boolean", "description": "enable AutoConfig\/AutoDiscover support (only if enabled on corresponding mail server)", "example": false }, "dkim": { "type": "boolean", "description": "enable DKIM (a 2048 bit RSA key will be generated automatically when enabling this option)", "example": true }, "dkimKey": { "type": "string", "description": "public key (to be used in TXT record)", "readOnly": true, "example": "MIIBCg[...]IDAQAB" }, "dkimKeyType": { "enum": [ "rsa", "ec" ], "type": "string", "description": "public key type", "readOnly": true, "example": "rsa" }, "dkimSelector": { "type": "string", "description": "differing selector for DKIM (set to `null` for using default value)", "default": "mail", "nullable": true, "example": "email" }, "dkimTest": { "type": "boolean", "description": "enable test mode for DKIM (only relevant when DNS for this domain is managed by LiveConfig)" }, "enabled": { "type": "boolean", "description": "enable e-mail with this subdomain", "example": true }, "rejectExternal": { "type": "boolean", "description": "reject external e-mails with this domain from unauthenticated external senders", "example": true }, "spf": { "type": "string", "description": "SPF record (must start with `v=spf1`); set empty value to use server default", "example": "v=spf1 a mx ~all" } } }, "web": { "type": "object", "properties": { "app": { "type": "object", "properties": { "id": { "type": "string", "description": "identifier for this web application", "example": "wp1" }, "name": { "type": "string", "description": "name of web application software", "example": "Wordpress" } }, "description": "only returned when `type=app`", "readOnly": true }, "enabled": { "type": "boolean", "description": "enable webspace with this subdomain", "example": true }, "hsts": { "type": "number", "description": "number of seconds for HSTS (HTTP Strict Transport Security)", "example": 31536000, "min": 1 }, "target": { "type": "string", "description": "target for this (sub)domain, depending on `type` (`webspace`: DocumentRoot relative to `htdocs\/`, `redirect_301`\/`redirect_302`\/`proxy`: destination URL, `app`: id of web application)", "example": "website-new\/" }, "tlsCertificate": { "type": "string", "description": "ID of TLS certificate (to enable HTTPS). Set to `null` to disable TLS\/SSL.", "nullable": true, "example": "a1b2c3" }, "tlsEnforce": { "type": "boolean", "description": "automatically redirect from `http:\/\/` to `https:\/\/`", "example": true }, "tlsProduct": { "type": "string", "description": "name of TLS product for automated TLS certificate (certificate will be provisioned automatically after it has been issued)", "example": "lets-encrypt" }, "type": { "enum": [ "webspace", "redirect_301", "redirect_302", "proxy", "app", "builder", "minisite", "disabled" ], "type": "string", "description": "destination for this (sub)domain", "example": "webspace" }, "php": { "type": "string", "description": "PHP version code (set to `null` to use server default PHP version)", "nullable": true, "example": "php82" }, "wwwSync": { "enum": [ "preferNone", "preferNoWww", "preferWww" ], "type": "string", "description": "apply these settings also to `www` (respective non-www) subdomain", "nullable": true, "example": "preferWww" } } } } }, { "type": "object", "properties": { "www": { "type": "boolean", "description": "also add `www` subdomain", "example": true } } } ] }, { "allOf": [ { "required": [ "account", "domain" ], "type": "object", "properties": { "account": { "type": "string", "description": "account name (where this domain is attached to)", "example": "web1" }, "apps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "identifier for this web application", "example": "wp1" }, "name": { "type": "string", "description": "name of web application software", "example": "Wordpress" } } }, "description": "list of successfully installed (selectable) web applications (only returned with `show=apps`)", "readOnly": true }, "dnsSerial": { "type": "number", "description": "initial serial number when creating domain on primary DNS (is only saved when DNS template is changed)", "example": 2025093001 }, "dnsTemplate": { "type": "string", "description": "name of DNS template (if domain is managed on own DNS servers)", "example": "my DNS template" }, "dnssec": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "is `true` if DNSSEC is enabled" }, "addKeys": { "type": "array", "items": { "type": "number" }, "description": "array of DNSSEC key types to add (e.g. `13` for _ECDSA\/SHA256_)", "writeOnly": true, "example": [ 13 ] }, "delKeys": { "type": "array", "items": { "type": "number" }, "description": "array of key IDs to remove (only valid when editing existing domain)", "writeOnly": true, "example": [ 18359 ] }, "ksk": { "type": "array", "items": { "type": "object", "properties": { "algorithm": { "type": "number", "description": "key algorithm (e.g. 13 = ECDSAP256SHA256)", "example": 13 }, "created": { "type": "string", "description": "timestamp when key was created", "format": "date-time", "example": "2025-06-10T08:55:12+02" }, "tag": { "type": "number", "description": "key tag", "example": 23456 }, "digest": { "type": "string", "description": "SHA256 digest of public key (used for DS record)", "example": "E690945A4490A8E9B7ED0C6640C1C7214EF958698C2958B048C10860968104EA" }, "digestType": { "type": "integer", "description": "type of the digest used", "example": 2 }, "flags": { "type": "integer", "description": "used dnssec flags", "example": 257 }, "protocol": { "type": "integer", "description": "key protocol", "example": 3 }, "dnskey": { "type": "string", "description": "base64 encoded public key", "example": "LAPNXZ1E9zRWlGvgV87+xM ... WdAUwJLDbiWcc7Iw==" } } }, "description": "array of key signing keys (KSK)", "readOnly": true } }, "description": "DNSSEC settings (only if domain is managed on own DNS)" }, "domain": { "type": "string", "description": "the domain name", "example": "example.org" }, "punycode": { "type": "string", "description": "punycode representation (`xn--...`) if this is an IDN (Internationalized Domain Name)", "readOnly": true }, "dns": { "type": "object", "properties": { "defaultRrTtl": { "type": "integer", "description": "Default TTL for resource records of this domain", "readOnly": true, "example": 3600 } } } } }, { "type": "object", "properties": { "www": { "type": "boolean", "description": "also add `www` subdomain", "example": true } } } ] } ] } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/customers\/{id}\/domains\/{domain}": { "get": { "tags": [ "Customers" ], "summary": "Get domain details", "description": "This method returns the domain details", "parameters": [ { "name": "id", "in": "path", "description": "customer ID", "required": true, "schema": { "type": "string" } }, { "name": "domain", "in": "path", "description": "domain name (UTF-8 IDN or punycode)", "required": true, "schema": { "type": "string" } }, { "name": "show", "in": "query", "description": "comma-separated list of additional data to show (`apps`: show list of installed (selectable) web applications, `dnsTemplates`: show available DNS templates, `ipGroups`: show available IP groups, `phpVersions`: show available PHP versions, `subdomains`: only return list of subdomains, `tls`: show matching TLS certificates and available TLS providers)\n", "style": "form", "explode": false, "schema": { "type": "array", "items": { "enum": [ "apps", "dnsTemplates", "ipGroups", "phpVersions", "subdomains", "tls" ], "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "allOf": [ { "required": [ "account", "domain" ], "type": "object", "properties": { "account": { "type": "string", "description": "account name (where this domain is attached to)", "example": "web1" }, "apps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "identifier for this web application", "example": "wp1" }, "name": { "type": "string", "description": "name of web application software", "example": "Wordpress" } } }, "description": "list of successfully installed (selectable) web applications (only returned with `show=apps`)", "readOnly": true }, "dnsSerial": { "type": "number", "description": "initial serial number when creating domain on primary DNS (is only saved when DNS template is changed)", "example": 2025093001 }, "dnsTemplate": { "type": "string", "description": "name of DNS template (if domain is managed on own DNS servers)", "example": "my DNS template" }, "dnssec": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "is `true` if DNSSEC is enabled" }, "addKeys": { "type": "array", "items": { "type": "number" }, "description": "array of DNSSEC key types to add (e.g. `13` for _ECDSA\/SHA256_)", "writeOnly": true, "example": [ 13 ] }, "delKeys": { "type": "array", "items": { "type": "number" }, "description": "array of key IDs to remove (only valid when editing existing domain)", "writeOnly": true, "example": [ 18359 ] }, "ksk": { "type": "array", "items": { "type": "object", "properties": { "algorithm": { "type": "number", "description": "key algorithm (e.g. 13 = ECDSAP256SHA256)", "example": 13 }, "created": { "type": "string", "description": "timestamp when key was created", "format": "date-time", "example": "2025-06-10T08:55:12+02" }, "tag": { "type": "number", "description": "key tag", "example": 23456 }, "digest": { "type": "string", "description": "SHA256 digest of public key (used for DS record)", "example": "E690945A4490A8E9B7ED0C6640C1C7214EF958698C2958B048C10860968104EA" }, "digestType": { "type": "integer", "description": "type of the digest used", "example": 2 }, "flags": { "type": "integer", "description": "used dnssec flags", "example": 257 }, "protocol": { "type": "integer", "description": "key protocol", "example": 3 }, "dnskey": { "type": "string", "description": "base64 encoded public key", "example": "LAPNXZ1E9zRWlGvgV87+xM ... WdAUwJLDbiWcc7Iw==" } } }, "description": "array of key signing keys (KSK)", "readOnly": true } }, "description": "DNSSEC settings (only if domain is managed on own DNS)" }, "domain": { "type": "string", "description": "the domain name", "example": "example.org" }, "punycode": { "type": "string", "description": "punycode representation (`xn--...`) if this is an IDN (Internationalized Domain Name)", "readOnly": true }, "dns": { "type": "object", "properties": { "defaultRrTtl": { "type": "integer", "description": "Default TTL for resource records of this domain", "readOnly": true, "example": 3600 } } } } }, { "required": [ "host" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "noAutoA": { "type": "boolean", "description": "if webspace is enabled: don't create automatic A\/AAAA records" }, "noAutoMx": { "type": "boolean", "description": "if e-mail is enabled: don't create automatic MX record" }, "rr": { "type": "array", "items": { "required": [ "host", "editable", "type" ], "type": "object", "properties": { "host": { "type": "string", "description": "hostname of this resource record", "example": "mail._domainkey.example.org" }, "editable": { "type": "boolean", "description": "flag if this entry can be edited or is managed by liveconfig itself", "example": false }, "type": { "enum": [ "A", "AAAA", "TXT", "MX", "CAA", "CNAME", "NS", "SRV", "TLSA", "PTR" ], "type": "string", "description": "type of the resource record", "example": "A" }, "ttl": { "type": "integer", "description": "ttl of this resource record in seconds or `null` to use default", "example": 3600 }, "address": { "type": "string", "description": "IPv4 address for `type == A` or IPv6 address for `type == AAAA`", "example": "192.168.123.23" }, "serverName": { "type": "string", "description": "server name for this resource record (only if `type` is one of `CNAME`,`MX`,`NS`,`SRV`,`PTR`)", "example": "www.example.org" }, "prio": { "type": "integer", "description": "priority of this resource record (only if `type` is one of `MX`,`SRV`)", "example": 10 }, "value": { "type": "string", "description": "value for this resource record (only if `type` is one of `TXT`,`CAA`)", "example": "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSI...wIDAQAB" }, "weight": { "type": "integer", "description": "the weight of this resource record (only if `type == SRV`)", "example": 10 }, "port": { "type": "integer", "description": "port of this resource record (only if `type == SRV`)", "example": 8443, "min": 1, "max": 65535 }, "usage": { "type": "integer", "description": "the TLSA usage of this entry (only if `type == TLSA`)", "example": 2, "min": 0, "max": 3 }, "selector": { "type": "integer", "description": "the TLSA selector of this entry (only if `type == TLSA`)", "example": 0, "min": 0, "max": 1 }, "matchingType": { "type": "integer", "description": "the TLSA matching type of this entry (only if `type == TLSA`)", "example": 0, "min": 0, "max": 2 }, "key": { "type": "string", "description": "the TLSA key of this entry (only if `type == TLSA`)", "example": "CA43DC21A123BB..." }, "tag": { "enum": [ "issue", "issuewild", "issuemail", "iodef" ], "type": "string", "description": "the CAA tag for this entry (only if `type == CAA`)", "example": "issue" } } }, "description": "list of resource records" } } }, "ipGroup": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "name of this IP group", "example": "default" }, "software": { "enum": [ "apache", "nginx" ], "type": "string", "description": "web server software this IP group is assigned to", "readOnly": true, "example": "apache" } } }, { "type": "object", "properties": { "ips": { "type": "array", "items": { "type": "string" }, "description": "list of all IP addresses in this IP group", "readOnly": true, "example": [ "198.51.100.42", "2a01:db8:cafe::42" ] } } } ] }, "ipGroups": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "name of this IP group", "example": "default" }, "software": { "enum": [ "apache", "nginx" ], "type": "string", "description": "web server software this IP group is assigned to", "readOnly": true, "example": "apache" } } }, { "type": "object", "properties": { "ips": { "type": "array", "items": { "type": "string" }, "description": "list of all IP addresses in this IP group", "readOnly": true, "example": [ "198.51.100.42", "2a01:db8:cafe::42" ] } } } ] }, "description": "list of available IP groups, returned only with `show=ipGroups`", "readOnly": true }, "mail": { "type": "object", "properties": { "autoconfig": { "type": "boolean", "description": "enable AutoConfig\/AutoDiscover support (only if enabled on corresponding mail server)", "example": false }, "dkim": { "type": "boolean", "description": "enable DKIM (a 2048 bit RSA key will be generated automatically when enabling this option)", "example": true }, "dkimKey": { "type": "string", "description": "public key (to be used in TXT record)", "readOnly": true, "example": "MIIBCg[...]IDAQAB" }, "dkimKeyType": { "enum": [ "rsa", "ec" ], "type": "string", "description": "public key type", "readOnly": true, "example": "rsa" }, "dkimSelector": { "type": "string", "description": "differing selector for DKIM (set to `null` for using default value)", "default": "mail", "nullable": true, "example": "email" }, "dkimTest": { "type": "boolean", "description": "enable test mode for DKIM (only relevant when DNS for this domain is managed by LiveConfig)" }, "enabled": { "type": "boolean", "description": "enable e-mail with this subdomain", "example": true }, "rejectExternal": { "type": "boolean", "description": "reject external e-mails with this domain from unauthenticated external senders", "example": true }, "spf": { "type": "string", "description": "SPF record (must start with `v=spf1`); set empty value to use server default", "example": "v=spf1 a mx ~all" } } }, "web": { "type": "object", "properties": { "app": { "type": "object", "properties": { "id": { "type": "string", "description": "identifier for this web application", "example": "wp1" }, "name": { "type": "string", "description": "name of web application software", "example": "Wordpress" } }, "description": "only returned when `type=app`", "readOnly": true }, "enabled": { "type": "boolean", "description": "enable webspace with this subdomain", "example": true }, "hsts": { "type": "number", "description": "number of seconds for HSTS (HTTP Strict Transport Security)", "example": 31536000, "min": 1 }, "target": { "type": "string", "description": "target for this (sub)domain, depending on `type` (`webspace`: DocumentRoot relative to `htdocs\/`, `redirect_301`\/`redirect_302`\/`proxy`: destination URL, `app`: id of web application)", "example": "website-new\/" }, "tlsCertificate": { "type": "string", "description": "ID of TLS certificate (to enable HTTPS). Set to `null` to disable TLS\/SSL.", "nullable": true, "example": "a1b2c3" }, "tlsEnforce": { "type": "boolean", "description": "automatically redirect from `http:\/\/` to `https:\/\/`", "example": true }, "tlsProduct": { "type": "string", "description": "name of TLS product for automated TLS certificate (certificate will be provisioned automatically after it has been issued)", "example": "lets-encrypt" }, "type": { "enum": [ "webspace", "redirect_301", "redirect_302", "proxy", "app", "builder", "minisite", "disabled" ], "type": "string", "description": "destination for this (sub)domain", "example": "webspace" }, "php": { "type": "string", "description": "PHP version code (set to `null` to use server default PHP version)", "nullable": true, "example": "php82" }, "wwwSync": { "enum": [ "preferNone", "preferNoWww", "preferWww" ], "type": "string", "description": "apply these settings also to `www` (respective non-www) subdomain", "nullable": true, "example": "preferWww" } } } } }, { "required": [ "account", "flags" ], "type": "object", "properties": { "account": { "type": "object", "properties": { "flags": { "type": "array", "items": { "enum": [ "disabled", "dnssec", "editable", "external" ], "type": "string", "description": "feature flags\n * `disabled`: domain is disabled\n * `dnssec`: DNSSEC is enabled\n * `editable`: domain settings can be edited by current user (own external domain, own managed domain or managed domain of own customer)\n * `external`: external DNS server (not managed by LiveConfig)" }, "description": "array of feature flags" }, "hasMail": { "type": "boolean", "description": "is \"true\" if e-mail is available with this account", "example": true }, "mailserverInbound": { "type": "string", "description": "Inbound (POP3\/IMAP) mail server name (if e-mail is available)", "example": "imap.example.org" }, "name": { "type": "string", "description": "account name", "example": "web1" } } } } } ] } }, "description": "Domain details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Customers" ], "summary": "Delete a domain", "description": "This method deletes a domain", "parameters": [ { "name": "id", "in": "path", "description": "customer ID", "required": true, "schema": { "type": "string" } }, { "name": "domain", "in": "path", "description": "domain name (UTF-8 IDN or punycode)", "required": true, "schema": { "type": "string" } }, { "name": "keepCerts", "in": "query", "description": "don't automatically delete TLS certificates issued only for this domain and\/or any subdomain\n", "style": "form", "explode": false, "schema": { "type": "boolean" } }, { "name": "mailAction", "in": "query", "description": "delete or park existing mailboxes with this domain (only required if there are mailboxes configured with this domain or any subdomain)\n", "style": "form", "explode": false, "schema": { "enum": [ "delete", "park" ], "type": "string" } } ], "responses": { "204": { "description": "Operation Successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Customers" ], "summary": "Edit domain settings", "description": "This method edits a domain", "parameters": [ { "name": "id", "in": "path", "description": "customer ID", "required": true, "schema": { "type": "string" } }, { "name": "domain", "in": "path", "description": "domain name (UTF-8 IDN or punycode)", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object with data to be edited", "content": { "application\/json": { "schema": { "required": [ "account", "domain" ], "type": "object", "properties": { "account": { "type": "string", "description": "account name (where this domain is attached to)", "example": "web1" }, "apps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "identifier for this web application", "example": "wp1" }, "name": { "type": "string", "description": "name of web application software", "example": "Wordpress" } } }, "description": "list of successfully installed (selectable) web applications (only returned with `show=apps`)", "readOnly": true }, "dnsSerial": { "type": "number", "description": "initial serial number when creating domain on primary DNS (is only saved when DNS template is changed)", "example": 2025093001 }, "dnsTemplate": { "type": "string", "description": "name of DNS template (if domain is managed on own DNS servers)", "example": "my DNS template" }, "dnssec": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "is `true` if DNSSEC is enabled" }, "addKeys": { "type": "array", "items": { "type": "number" }, "description": "array of DNSSEC key types to add (e.g. `13` for _ECDSA\/SHA256_)", "writeOnly": true, "example": [ 13 ] }, "delKeys": { "type": "array", "items": { "type": "number" }, "description": "array of key IDs to remove (only valid when editing existing domain)", "writeOnly": true, "example": [ 18359 ] }, "ksk": { "type": "array", "items": { "type": "object", "properties": { "algorithm": { "type": "number", "description": "key algorithm (e.g. 13 = ECDSAP256SHA256)", "example": 13 }, "created": { "type": "string", "description": "timestamp when key was created", "format": "date-time", "example": "2025-06-10T08:55:12+02" }, "tag": { "type": "number", "description": "key tag", "example": 23456 }, "digest": { "type": "string", "description": "SHA256 digest of public key (used for DS record)", "example": "E690945A4490A8E9B7ED0C6640C1C7214EF958698C2958B048C10860968104EA" }, "digestType": { "type": "integer", "description": "type of the digest used", "example": 2 }, "flags": { "type": "integer", "description": "used dnssec flags", "example": 257 }, "protocol": { "type": "integer", "description": "key protocol", "example": 3 }, "dnskey": { "type": "string", "description": "base64 encoded public key", "example": "LAPNXZ1E9zRWlGvgV87+xM ... WdAUwJLDbiWcc7Iw==" } } }, "description": "array of key signing keys (KSK)", "readOnly": true } }, "description": "DNSSEC settings (only if domain is managed on own DNS)" }, "domain": { "type": "string", "description": "the domain name", "example": "example.org" }, "punycode": { "type": "string", "description": "punycode representation (`xn--...`) if this is an IDN (Internationalized Domain Name)", "readOnly": true }, "dns": { "type": "object", "properties": { "defaultRrTtl": { "type": "integer", "description": "Default TTL for resource records of this domain", "readOnly": true, "example": 3600 } } } } } } }, "required": true }, "responses": { "204": { "description": "Operation Successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/customers\/{id}\/log": { "get": { "tags": [ "Logs" ], "summary": "Get EventLog list of customer", "description": "This method returns a list all EventLogs from a given customer", "parameters": [ { "name": "count", "in": "query", "description": "number of results to return", "schema": { "minimum": 1, "type": "integer" } }, { "name": "page", "in": "query", "description": "page to return (offset), starting with `1`", "schema": { "minimum": 1, "type": "integer" } }, { "name": "search", "in": "query", "description": "search phrase (is matched against `message`)", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "sort results by given column (default: `timestamp`)", "schema": { "enum": [ "timestamp" ], "type": "string" } }, { "name": "id", "in": "path", "description": "Customer id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 12 }, "data": { "type": "array", "items": { "type": "object", "properties": { "level": { "type": "integer", "description": "The Level of the log entry", "readOnly": true }, "customer": { "type": "string", "description": "Customer id", "readOnly": true }, "user": { "type": "string", "description": "User name", "readOnly": true }, "realUser": { "type": "string", "description": "Real user name (if done on behalf of a user)", "readOnly": true }, "timestamp": { "type": "string", "description": "Date and time of the event", "readOnly": true }, "moduleId": { "type": "integer", "description": "Module id", "readOnly": true }, "eventId": { "type": "integer", "description": "Event id", "readOnly": true }, "message": { "type": "string", "description": "Message of the event", "readOnly": true }, "data": { "type": "string", "description": "Data of the event", "readOnly": true } } } } }, "description": "a list of all eventlogs" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/customers\/{id}\/users\/{login}": { "patch": { "tags": [ "Customers" ], "summary": "Edit a customer's user", "description": "This method edits a customer's user (i.e. change password)", "parameters": [ { "name": "id", "in": "path", "description": "Customer id", "required": true, "schema": { "type": "string" } }, { "name": "login", "in": "path", "description": "User name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "User data to be modified", "content": { "application\/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "resetEmail": { "type": "string", "description": "e-mail address to send password reset link to", "format": "email", "example": "john.doe@example.com" } } }, { "type": "object", "properties": { "password": { "type": "string", "description": "new password", "example": "ToPs3crEt" }, "customerEmail": { "type": "string", "description": "if set, send e-mail with new password to given address (password then must be changed on next login)", "format": "email", "example": "john.doe@example.org" } } } ] } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/customlinks": { "get": { "tags": [ "Custom Links" ], "summary": "Get section list", "description": "This method returns a list of all custom links sections", "parameters": [ { "name": "show", "in": "query", "description": "optionally return list of all links within each section", "schema": { "enum": [ "all" ], "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "description": "The displayed menue title of the section", "example": "Service" }, "uri": { "type": "string", "description": "path segment used for this section (all links of this section are located below this uri segment)", "example": "service" }, "sortOrder": { "type": "integer", "description": "the order to sort the sections by (if `0` orderd by uri)", "example": 1 } } } } }, "description": "a list of all sections" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Custom Links" ], "summary": "Add new custom links section", "description": "This method adds a new custom links section.", "requestBody": { "description": "Data of new section", "content": { "application\/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "description": "The displayed menue title of the section", "example": "Service" }, "uri": { "type": "string", "description": "path segment used for this section (all links of this section are located below this uri segment)", "example": "service" }, "sortOrder": { "type": "integer", "description": "the order to sort the sections by (if `0` orderd by uri)", "example": 1 } } } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/customlinks\/{section}": { "get": { "tags": [ "Custom Links" ], "summary": "Get custom links section details", "description": "This method returns the detailed custom links section data", "parameters": [ { "name": "section", "in": "path", "description": "section uri", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "title": { "type": "string", "description": "The displayed menue title of the section", "example": "Service" }, "uri": { "type": "string", "description": "path segment used for this section (all links of this section are located below this uri segment)", "example": "service" }, "sortOrder": { "type": "integer", "description": "the order to sort the sections by (if `0` orderd by uri)", "example": 1 } } } }, "description": "section details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Custom Links" ], "summary": "Add new custom link to section", "description": "This method adds a new custom link to a section.", "parameters": [ { "name": "section", "in": "path", "description": "the uri of the section", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Data of new link", "content": { "application\/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "description": "The displayed menue title of the section", "example": "Service" }, "uri": { "type": "string", "description": "path segment used for this section (all links of this section are located below this uri segment)", "example": "service" }, "sortOrder": { "type": "integer", "description": "the order to sort the sections by (if `0` orderd by uri)", "example": 1 }, "icon": { "type": "string", "description": "name of the icon selected for the link", "example": "account" }, "password": { "type": "string", "description": "the password for the link", "example": "1234Secure" }, "url": { "type": "string", "description": "the url accessed over the iFrame", "example": "https:\/\/service.example.org\/invoices" } } } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Custom Links" ], "summary": "Remove a custom links section", "parameters": [ { "name": "section", "in": "path", "description": "the uri of the section", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Custom Links" ], "summary": "Edit a custom links section", "description": "This method edits a custom links section.", "parameters": [ { "name": "section", "in": "path", "description": "uri of the section", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "section data to be modified", "content": { "application\/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "description": "The displayed menue title of the section", "example": "Service" }, "uri": { "type": "string", "description": "path segment used for this section (all links of this section are located below this uri segment)", "example": "service" }, "sortOrder": { "type": "integer", "description": "the order to sort the sections by (if `0` orderd by uri)", "example": 1 } } } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/customlinks\/{section}\/{link}": { "get": { "tags": [ "Custom Links" ], "summary": "Get details of a custom link", "description": "This method returns the details of a custom link", "parameters": [ { "name": "section", "in": "path", "description": "uri of the section", "required": true, "schema": { "type": "string" } }, { "name": "link", "in": "path", "description": "uri of the link", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "title": { "type": "string", "description": "The displayed menue title of the section", "example": "Service" }, "uri": { "type": "string", "description": "path segment used for this section (all links of this section are located below this uri segment)", "example": "service" }, "sortOrder": { "type": "integer", "description": "the order to sort the sections by (if `0` orderd by uri)", "example": 1 }, "icon": { "type": "string", "description": "name of the icon selected for the link", "example": "account" }, "password": { "type": "string", "description": "the password for the link", "example": "1234Secure" }, "url": { "type": "string", "description": "the url accessed over the iFrame", "example": "https:\/\/service.example.org\/invoices" } } } }, "description": "link details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Custom Links" ], "summary": "Validate session ID", "description": "This method is required to validate a submitted session ID and get information about the corresponding user. This method is only available via REST API.", "parameters": [ { "name": "section", "in": "path", "description": "uri of the section", "required": true, "schema": { "type": "string" } }, { "name": "link", "in": "path", "description": "uri of the link", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The fields `chk`, `sid` and `ts` are provided by LiveConfig to the IFRAME API destination URL, and must be passed through unmodified.", "content": { "application\/json": { "schema": { "required": [ "chk", "sid", "ts" ], "type": "object", "properties": { "chk": { "type": "string", "description": "SHA1 checksum over ts+sid+password", "example": "06daf96fa9ec958bfa03b618aa290bf44c09fbf2" }, "sid": { "type": "string", "description": "Session ID from LiveConfig session", "example": "jIMN7zjBCzaIaFMjB8NwKeKy" }, "ts": { "type": "number", "description": "UNIX timestamp (logged in to LiveConfig, or page reloaded)", "example": 1725990959 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "cid": { "type": "string", "description": "Customer ID", "example": "C1337" }, "login": { "type": "string", "description": "LiveConfig user name", "example": "john" }, "name": { "type": "string", "example": "John Doe" }, "accounts": { "type": "array", "items": { "required": [ "name" ], "type": "object", "properties": { "comment": { "type": "string", "example": "Production website" }, "name": { "type": "string", "example": "web1" } } }, "description": "List of accounts available to this user" } } } }, "description": "Session information" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Custom Links" ], "summary": "Remove a custom link", "parameters": [ { "name": "section", "in": "path", "description": "uri of the section", "required": true, "schema": { "type": "string" } }, { "name": "link", "in": "path", "description": "uri of the link", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Custom Links" ], "summary": "Edit a custom link", "description": "This method edits a custom link.", "parameters": [ { "name": "section", "in": "path", "description": "uri of the section", "required": true, "schema": { "type": "string" } }, { "name": "link", "in": "path", "description": "uri of the link", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "link data to be modified", "content": { "application\/json": { "schema": { "allOf": [ { "type": "object", "properties": { "title": { "type": "string", "description": "The displayed menue title of the section", "example": "Service" }, "uri": { "type": "string", "description": "path segment used for this section (all links of this section are located below this uri segment)", "example": "service" }, "sortOrder": { "type": "integer", "description": "the order to sort the sections by (if `0` orderd by uri)", "example": 1 }, "icon": { "type": "string", "description": "name of the icon selected for the link", "example": "account" }, "password": { "type": "string", "description": "the password for the link", "example": "1234Secure" }, "url": { "type": "string", "description": "the url accessed over the iFrame", "example": "https:\/\/service.example.org\/invoices" } } }, { "type": "object", "properties": { "section": { "type": "string", "description": "Name of new section (only when assigning to a different section)", "example": "self-service" } } } ] } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/databases": { "get": { "tags": [ "Databases" ], "summary": "Get database list", "description": "This method returns a list of all databases", "parameters": [ { "name": "count", "in": "query", "description": "number of results to return", "schema": { "minimum": 1, "type": "integer" } }, { "name": "page", "in": "query", "description": "page to return (offset), starting with `1`", "schema": { "minimum": 1, "type": "integer" } }, { "name": "search", "in": "query", "description": "search phrase (is matched against `name`, `user`, `comment` and `account`)", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "sort results by given column (default: `name`)", "schema": { "enum": [ "account", "name", "tables", "size", "login" ], "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 12 }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Encoded database id", "readOnly": true }, "account": { "type": "string", "description": "Account name associated with this database", "example": "web1" }, "name": { "maxLength": 64, "type": "string", "description": "Database name", "example": "web1db1" }, "login": { "maxLength": 32, "type": "string", "description": "Database login username", "example": "web1db1user" }, "password": { "maxLength": 45, "type": "string", "description": "Database Password", "writeOnly": true, "example": "$up\u20acrs3cre7" }, "comment": { "type": "string", "description": "Optional comment for this database" }, "extAccess": { "type": "boolean", "description": "Enable external access for this database", "default": false, "example": true }, "extAccessTls": { "type": "boolean", "description": "Enable external access with TLS\/SSL encryption only", "default": false, "example": false }, "sso": { "type": "boolean", "description": "Single Sign-On (SSO) enabled", "default": false, "example": true }, "tables": { "type": "integer", "description": "Number of tables", "readOnly": true, "example": 2 }, "size": { "type": "integer", "description": "Database size (kB)", "readOnly": true, "example": 42 }, "statsTs": { "type": "string", "description": "Timestamp when statistics (size, number of tables) where last updated", "format": "date-time" }, "server": { "type": "object", "properties": { "hostname": { "type": "string", "description": "Database server name", "example": "dbms.example.org" }, "extAccess": { "type": "boolean", "description": "DBMS supports external access" }, "adminUrl": { "type": "string", "description": "URL to administration tool (e.g. phpMyAdmin)", "example": "https:\/\/phpmyadmin.example.org" }, "sso": { "type": "boolean", "description": "Is `true` if `adminURL` is configured and prepared for single sign-on", "example": false } }, "readOnly": true }, "statusTs": { "type": "string", "description": "timestamp of last status change", "format": "date-time", "example": 1500658348 }, "status": { "enum": [ "notCreated", "ok", "error", "deleting", "updating" ], "type": "string", "description": "current status of the database operation" }, "statusMsg": { "type": "string", "description": "Human readable status message for the last database operation", "example": "OK Database successfully created" } } } } }, "description": "a list of all databases" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Databases" ], "summary": "Create database", "description": "This method creates a new database", "requestBody": { "description": "JSON object with data of the new database", "content": { "application\/json": { "schema": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Encoded database id", "readOnly": true }, "account": { "type": "string", "description": "Account name associated with this database", "example": "web1" }, "name": { "maxLength": 64, "type": "string", "description": "Database name", "example": "web1db1" }, "login": { "maxLength": 32, "type": "string", "description": "Database login username", "example": "web1db1user" }, "password": { "maxLength": 45, "type": "string", "description": "Database Password", "writeOnly": true, "example": "$up\u20acrs3cre7" }, "comment": { "type": "string", "description": "Optional comment for this database" }, "extAccess": { "type": "boolean", "description": "Enable external access for this database", "default": false, "example": true }, "extAccessTls": { "type": "boolean", "description": "Enable external access with TLS\/SSL encryption only", "default": false, "example": false }, "sso": { "type": "boolean", "description": "Single Sign-On (SSO) enabled", "default": false, "example": true }, "tables": { "type": "integer", "description": "Number of tables", "readOnly": true, "example": 2 }, "size": { "type": "integer", "description": "Database size (kB)", "readOnly": true, "example": 42 }, "statsTs": { "type": "string", "description": "Timestamp when statistics (size, number of tables) where last updated", "format": "date-time" }, "server": { "type": "object", "properties": { "hostname": { "type": "string", "description": "Database server name", "example": "dbms.example.org" }, "extAccess": { "type": "boolean", "description": "DBMS supports external access" }, "adminUrl": { "type": "string", "description": "URL to administration tool (e.g. phpMyAdmin)", "example": "https:\/\/phpmyadmin.example.org" }, "sso": { "type": "boolean", "description": "Is `true` if `adminURL` is configured and prepared for single sign-on", "example": false } }, "readOnly": true }, "statusTs": { "type": "string", "description": "timestamp of last status change", "format": "date-time", "example": 1500658348 }, "status": { "enum": [ "notCreated", "ok", "error", "deleting", "updating" ], "type": "string", "description": "current status of the database operation" }, "statusMsg": { "type": "string", "description": "Human readable status message for the last database operation", "example": "OK Database successfully created" } } }, { "required": [ "accountName", "name", "login", "password" ], "type": "object" } ] } } }, "required": true }, "responses": { "201": { "description": "Database Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/databases\/{id}": { "get": { "tags": [ "Databases" ], "summary": "Get database details", "description": "This method returns the database details", "parameters": [ { "name": "id", "in": "path", "description": "encoded id of the database", "required": true, "schema": { "type": "string" } }, { "name": "show", "in": "query", "description": "comma-separated list of additional data to show (`backup`: show available backups)\n", "style": "form", "explode": false, "schema": { "type": "array", "items": { "enum": [ "backup" ], "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Encoded database id", "readOnly": true }, "account": { "type": "string", "description": "Account name associated with this database", "example": "web1" }, "name": { "maxLength": 64, "type": "string", "description": "Database name", "example": "web1db1" }, "login": { "maxLength": 32, "type": "string", "description": "Database login username", "example": "web1db1user" }, "password": { "maxLength": 45, "type": "string", "description": "Database Password", "writeOnly": true, "example": "$up\u20acrs3cre7" }, "comment": { "type": "string", "description": "Optional comment for this database" }, "extAccess": { "type": "boolean", "description": "Enable external access for this database", "default": false, "example": true }, "extAccessTls": { "type": "boolean", "description": "Enable external access with TLS\/SSL encryption only", "default": false, "example": false }, "sso": { "type": "boolean", "description": "Single Sign-On (SSO) enabled", "default": false, "example": true }, "tables": { "type": "integer", "description": "Number of tables", "readOnly": true, "example": 2 }, "size": { "type": "integer", "description": "Database size (kB)", "readOnly": true, "example": 42 }, "statsTs": { "type": "string", "description": "Timestamp when statistics (size, number of tables) where last updated", "format": "date-time" }, "server": { "type": "object", "properties": { "hostname": { "type": "string", "description": "Database server name", "example": "dbms.example.org" }, "extAccess": { "type": "boolean", "description": "DBMS supports external access" }, "adminUrl": { "type": "string", "description": "URL to administration tool (e.g. phpMyAdmin)", "example": "https:\/\/phpmyadmin.example.org" }, "sso": { "type": "boolean", "description": "Is `true` if `adminURL` is configured and prepared for single sign-on", "example": false } }, "readOnly": true }, "statusTs": { "type": "string", "description": "timestamp of last status change", "format": "date-time", "example": 1500658348 }, "status": { "enum": [ "notCreated", "ok", "error", "deleting", "updating" ], "type": "string", "description": "current status of the database operation" }, "statusMsg": { "type": "string", "description": "Human readable status message for the last database operation", "example": "OK Database successfully created" } } }, { "type": "object", "properties": { "backup": { "type": "object", "properties": { "list": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "id of the backup", "readOnly": true, "example": "bIAzOg" }, "objectName": { "type": "string", "description": "name of the backuped object", "readOnly": true, "example": "web123@example.org" }, "archiveSize": { "type": "integer", "description": "size of the backuped archive in bytes", "readOnly": true, "example": 1258 }, "size": { "type": "integer", "description": "size of the backuped data in bytes", "readOnly": true, "example": 4082 }, "type": { "enum": [ "web", "db", "mail" ], "type": "string", "description": "type of the backuped object", "readOnly": true, "example": "mail" }, "started": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z" }, "finished": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:35:28Z" }, "status": { "enum": [ "none", "submitted", "inPreparation", "running", "finished", "error" ], "type": "string", "description": "status of the backup", "readOnly": true, "example": "finished" }, "statusMsg": { "type": "string", "description": "human readable status message", "readOnly": true, "example": "Job finished successful" }, "storage": { "type": "string", "description": "backup-storage id", "readOnly": true, "example": "bIAzOg" } }, "required": null }, { "type": "object", "properties": { "objectName": { "example": "web6db1" }, "type": { "example": "db" } } } ] }, "description": "list of available backups (returned only with `show=backup`)" }, "manual": { "type": "boolean", "description": "is `true` if it's possible to trigger a manual backup", "example": true } } } } } ] } }, "description": "Database details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Databases" ], "summary": "Delete database", "description": "This method deletes a database", "parameters": [ { "name": "id", "in": "path", "description": "encoded id of the database", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation Successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Databases" ], "summary": "Edit database", "description": "This method edits a database", "parameters": [ { "name": "id", "in": "path", "description": "encoded id of the database", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object with data to be edited", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Encoded database id", "readOnly": true }, "account": { "type": "string", "description": "Account name associated with this database", "example": "web1" }, "name": { "maxLength": 64, "type": "string", "description": "Database name", "example": "web1db1" }, "login": { "maxLength": 32, "type": "string", "description": "Database login username", "example": "web1db1user" }, "password": { "maxLength": 45, "type": "string", "description": "Database Password", "writeOnly": true, "example": "$up\u20acrs3cre7" }, "comment": { "type": "string", "description": "Optional comment for this database" }, "extAccess": { "type": "boolean", "description": "Enable external access for this database", "default": false, "example": true }, "extAccessTls": { "type": "boolean", "description": "Enable external access with TLS\/SSL encryption only", "default": false, "example": false }, "sso": { "type": "boolean", "description": "Single Sign-On (SSO) enabled", "default": false, "example": true }, "tables": { "type": "integer", "description": "Number of tables", "readOnly": true, "example": 2 }, "size": { "type": "integer", "description": "Database size (kB)", "readOnly": true, "example": 42 }, "statsTs": { "type": "string", "description": "Timestamp when statistics (size, number of tables) where last updated", "format": "date-time" }, "server": { "type": "object", "properties": { "hostname": { "type": "string", "description": "Database server name", "example": "dbms.example.org" }, "extAccess": { "type": "boolean", "description": "DBMS supports external access" }, "adminUrl": { "type": "string", "description": "URL to administration tool (e.g. phpMyAdmin)", "example": "https:\/\/phpmyadmin.example.org" }, "sso": { "type": "boolean", "description": "Is `true` if `adminURL` is configured and prepared for single sign-on", "example": false } }, "readOnly": true }, "statusTs": { "type": "string", "description": "timestamp of last status change", "format": "date-time", "example": 1500658348 }, "status": { "enum": [ "notCreated", "ok", "error", "deleting", "updating" ], "type": "string", "description": "current status of the database operation" }, "statusMsg": { "type": "string", "description": "Human readable status message for the last database operation", "example": "OK Database successfully created" } } } } }, "required": true }, "responses": { "204": { "description": "Operation Successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/databases\/{id}\/sso": { "post": { "tags": [ "Databases" ], "summary": "Create Single Sign-On token for phpMyAdmin", "description": "This method returns a token for logging in to phpMyAdmin.", "parameters": [ { "name": "id", "in": "path", "description": "encoded id of the database", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "adminUrl": { "type": "string", "description": "URL to phpMyAdmin", "example": "https:\/\/phpmyadmin.example.net" }, "token": { "type": "string", "description": "token to authenticate SSO session", "example": "x1b2d3r4t6" } } } } } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/dns\/ext-servers": { "get": { "tags": [ "DNS-Settings" ], "summary": "Get list of all external DNS servers", "description": "This method returns a list of all external DNS servers", "parameters": [ { "name": "count", "in": "query", "description": "number of results to return", "schema": { "minimum": 1, "type": "integer" } }, { "name": "page", "in": "query", "description": "page to return (offset), starting with `1`", "schema": { "minimum": 1, "type": "integer" } }, { "name": "search", "in": "query", "description": "search phrase", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "sort results by given column (default: `name`)", "schema": { "enum": [ "name" ], "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 1 }, "data": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "hostname of the external server (used for NS entry)", "example": "ns1.example.org" }, "ips": { "type": "array", "items": { "type": "string", "description": "ip" }, "description": "list of IP addresses from which the external name server may request a zone transfer", "example": [ "2001:db8::100:42\/32", "198.51.100.42" ] }, "tsig": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "whether TSIG (Transaction Signature) is enabled for this server", "example": true }, "keyName": { "type": "string", "description": "name of the TSIG key", "example": "tsig for ns1.example.org" }, "key": { "type": "string", "description": "TSIG key (algorithm must be HMAC-MD5)", "example": "pM4HUt[...]0+uFNvtM=" } }, "description": "TSIG settings" }, "usage": { "type": "object", "properties": { "templates": { "type": "number", "description": "Number of templates where this external secondary DNS is used", "readOnly": true, "example": 2 }, "zones": { "type": "number", "description": "Number of zones (domains) where this external secondary DNS server is used", "readOnly": true, "example": 1234 } }, "description": "Usage statistics", "readOnly": true } } }, { "type": "object", "required": null } ] } } }, "description": "a list of all external DNS servers" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "DNS-Settings" ], "summary": "Create external DNS server", "description": "This method creates a new external DNS server", "requestBody": { "description": "JSON object with data of the new external DNS server", "content": { "application\/json": { "schema": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "hostname of the external server (used for NS entry)", "example": "ns1.example.org" }, "ips": { "type": "array", "items": { "type": "string", "description": "ip" }, "description": "list of IP addresses from which the external name server may request a zone transfer", "example": [ "2001:db8::100:42\/32", "198.51.100.42" ] }, "tsig": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "whether TSIG (Transaction Signature) is enabled for this server", "example": true }, "keyName": { "type": "string", "description": "name of the TSIG key", "example": "tsig for ns1.example.org" }, "key": { "type": "string", "description": "TSIG key (algorithm must be HMAC-MD5)", "example": "pM4HUt[...]0+uFNvtM=" } }, "description": "TSIG settings" }, "usage": { "type": "object", "properties": { "templates": { "type": "number", "description": "Number of templates where this external secondary DNS is used", "readOnly": true, "example": 2 }, "zones": { "type": "number", "description": "Number of zones (domains) where this external secondary DNS server is used", "readOnly": true, "example": 1234 } }, "description": "Usage statistics", "readOnly": true } } }, { "required": [ "name" ], "type": "object" } ] } } }, "required": true }, "responses": { "201": { "description": "external DNS server Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/dns\/ext-servers\/{server}": { "get": { "tags": [ "DNS-Settings" ], "summary": "Get external DNS server details", "description": "This method returns the external DNS server details", "parameters": [ { "name": "server", "in": "path", "description": "hostname of the external DNS server", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "name": { "type": "string", "description": "hostname of the external server (used for NS entry)", "example": "ns1.example.org" }, "ips": { "type": "array", "items": { "type": "string", "description": "ip" }, "description": "list of IP addresses from which the external name server may request a zone transfer", "example": [ "2001:db8::100:42\/32", "198.51.100.42" ] }, "tsig": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "whether TSIG (Transaction Signature) is enabled for this server", "example": true }, "keyName": { "type": "string", "description": "name of the TSIG key", "example": "tsig for ns1.example.org" }, "key": { "type": "string", "description": "TSIG key (algorithm must be HMAC-MD5)", "example": "pM4HUt[...]0+uFNvtM=" } }, "description": "TSIG settings" }, "usage": { "type": "object", "properties": { "templates": { "type": "number", "description": "Number of templates where this external secondary DNS is used", "readOnly": true, "example": 2 }, "zones": { "type": "number", "description": "Number of zones (domains) where this external secondary DNS server is used", "readOnly": true, "example": 1234 } }, "description": "Usage statistics", "readOnly": true } } } }, "description": "external DNS server details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "DNS-Settings" ], "summary": "Delete external DNS server", "description": "This method deletes a external DNS server", "parameters": [ { "name": "server", "in": "path", "description": "hostname of the external DNS server", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation Successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "DNS-Settings" ], "summary": "Edit external DNS server", "description": "This method edits a external DNS server", "parameters": [ { "name": "server", "in": "path", "description": "hostname of the external DNS server", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object with data to be edited", "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "hostname of the external server (used for NS entry)", "example": "ns1.example.org" }, "ips": { "type": "array", "items": { "type": "string", "description": "ip" }, "description": "list of IP addresses from which the external name server may request a zone transfer", "example": [ "2001:db8::100:42\/32", "198.51.100.42" ] }, "tsig": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "whether TSIG (Transaction Signature) is enabled for this server", "example": true }, "keyName": { "type": "string", "description": "name of the TSIG key", "example": "tsig for ns1.example.org" }, "key": { "type": "string", "description": "TSIG key (algorithm must be HMAC-MD5)", "example": "pM4HUt[...]0+uFNvtM=" } }, "description": "TSIG settings" }, "usage": { "type": "object", "properties": { "templates": { "type": "number", "description": "Number of templates where this external secondary DNS is used", "readOnly": true, "example": 2 }, "zones": { "type": "number", "description": "Number of zones (domains) where this external secondary DNS server is used", "readOnly": true, "example": 1234 } }, "description": "Usage statistics", "readOnly": true } } } } }, "required": true }, "responses": { "204": { "description": "Operation Successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/dns\/templates": { "get": { "tags": [ "DNS-Settings" ], "summary": "Get list of all DNS templates", "description": "This method returns a list of all DNS templates", "parameters": [ { "name": "count", "in": "query", "description": "number of results to return", "schema": { "minimum": 1, "type": "integer" } }, { "name": "page", "in": "query", "description": "page to return (offset), starting with `1`", "schema": { "minimum": 1, "type": "integer" } }, { "name": "search", "in": "query", "description": "search phrase", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "sort results by given column (default: `name`)", "schema": { "enum": [ "name", "zones" ], "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 1 }, "data": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "domainCount": { "type": "integer", "description": "count of domains using this dns template", "readOnly": true, "example": 42, "required": false }, "name": { "type": "string", "description": "name of the template", "example": "Zone 1 hidden primary" }, "soa": { "type": "object", "properties": { "refresh": { "type": "integer", "description": "Number of seconds after which secondary name servers should query the master for the SOA record, to detect zone changes.", "default": 86400, "example": 86400 }, "retry": { "type": "integer", "description": "Number of seconds after which secondary name servers should retry to request the serial number from the master if the master does not respond.", "default": 10800, "example": 7200 }, "expire": { "type": "integer", "description": "Number of seconds after which secondary name servers should stop answering request for this zone if the master does not respond.", "default": "1209600;", "example": 3600000 }, "negativeTtl": { "type": "integer", "description": "Negative response caching TTL in seconds", "default": 3600, "example": 3600 }, "ttl": { "type": "integer", "description": "Time-to-live in seconds for the soa entry", "default": 10800, "example": 10800 }, "email": { "type": "string", "description": "Email address of the administrator responsible for this zone.", "format": "email", "example": "hostmaster@example.org" } } }, "primary": { "type": "object", "properties": { "id": { "type": "string", "description": "hostid of the liveconfig server\/client which acts as primary nameserver of this zone", "example": "localhost" }, "name": { "type": "string", "description": "hostname of the primary dns server", "example": "ns1.example.org" }, "hidden": { "type": "boolean", "description": "flag if this primary should be a hidden primary", "example": true }, "ttl": { "type": "integer", "description": "ttl for the `ns` entry for this primary", "example": 3600 } } }, "secondaries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "host id of the LiveConfig DNS server or hostname of the external DNS server which acts as secondary of this zone (depending on `external`)", "example": "ext-dns1.example.org" }, "external": { "type": "boolean", "description": "type of the server: `false` (internal) => host id of LiveConfig DNS server, `true` (external) => hostname of external DNS server", "example": false }, "name": { "type": "string", "description": "hostname of this secondary server", "example": "ns2.example.org" }, "ttl": { "type": "integer", "description": "ttl for the `ns` entry for this secondary", "default": 10800, "example": 3600 } } }, "description": "list of up to 4 secondary dns servers for this zone" } } }, { "required": [ "id", "name", "domain", "mailbox" ], "type": "object" } ] } } }, "description": "a list of all DNS templates" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "DNS-Settings" ], "summary": "Create DNS template", "description": "This method creates a new DNS template", "requestBody": { "description": "JSON object with data of the new DNS template", "content": { "application\/json": { "schema": { "allOf": [ { "type": "object", "properties": { "domainCount": { "type": "integer", "description": "count of domains using this dns template", "readOnly": true, "example": 42, "required": false }, "name": { "type": "string", "description": "name of the template", "example": "Zone 1 hidden primary" }, "soa": { "type": "object", "properties": { "refresh": { "type": "integer", "description": "Number of seconds after which secondary name servers should query the master for the SOA record, to detect zone changes.", "default": 86400, "example": 86400 }, "retry": { "type": "integer", "description": "Number of seconds after which secondary name servers should retry to request the serial number from the master if the master does not respond.", "default": 10800, "example": 7200 }, "expire": { "type": "integer", "description": "Number of seconds after which secondary name servers should stop answering request for this zone if the master does not respond.", "default": "1209600;", "example": 3600000 }, "negativeTtl": { "type": "integer", "description": "Negative response caching TTL in seconds", "default": 3600, "example": 3600 }, "ttl": { "type": "integer", "description": "Time-to-live in seconds for the soa entry", "default": 10800, "example": 10800 }, "email": { "type": "string", "description": "Email address of the administrator responsible for this zone.", "format": "email", "example": "hostmaster@example.org" } } }, "primary": { "type": "object", "properties": { "id": { "type": "string", "description": "hostid of the liveconfig server\/client which acts as primary nameserver of this zone", "example": "localhost" }, "name": { "type": "string", "description": "hostname of the primary dns server", "example": "ns1.example.org" }, "hidden": { "type": "boolean", "description": "flag if this primary should be a hidden primary", "example": true }, "ttl": { "type": "integer", "description": "ttl for the `ns` entry for this primary", "example": 3600 } } }, "secondaries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "host id of the LiveConfig DNS server or hostname of the external DNS server which acts as secondary of this zone (depending on `external`)", "example": "ext-dns1.example.org" }, "external": { "type": "boolean", "description": "type of the server: `false` (internal) => host id of LiveConfig DNS server, `true` (external) => hostname of external DNS server", "example": false }, "name": { "type": "string", "description": "hostname of this secondary server", "example": "ns2.example.org" }, "ttl": { "type": "integer", "description": "ttl for the `ns` entry for this secondary", "default": 10800, "example": 3600 } } }, "description": "list of up to 4 secondary dns servers for this zone" } } }, { "required": [ "id", "name", "type", "password" ], "type": "object", "properties": { "primary": { "required": [ "id", "name" ], "type": "object" } } } ] } } }, "required": true }, "responses": { "201": { "description": "DNS template Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/dns\/templates\/{name}": { "get": { "tags": [ "DNS-Settings" ], "summary": "Get DNS template details", "description": "This method returns the DNS template details", "parameters": [ { "name": "name", "in": "path", "description": "name of the DNS template", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "domainCount": { "type": "integer", "description": "count of domains using this dns template", "readOnly": true, "example": 42, "required": false }, "name": { "type": "string", "description": "name of the template", "example": "Zone 1 hidden primary" }, "soa": { "type": "object", "properties": { "refresh": { "type": "integer", "description": "Number of seconds after which secondary name servers should query the master for the SOA record, to detect zone changes.", "default": 86400, "example": 86400 }, "retry": { "type": "integer", "description": "Number of seconds after which secondary name servers should retry to request the serial number from the master if the master does not respond.", "default": 10800, "example": 7200 }, "expire": { "type": "integer", "description": "Number of seconds after which secondary name servers should stop answering request for this zone if the master does not respond.", "default": "1209600;", "example": 3600000 }, "negativeTtl": { "type": "integer", "description": "Negative response caching TTL in seconds", "default": 3600, "example": 3600 }, "ttl": { "type": "integer", "description": "Time-to-live in seconds for the soa entry", "default": 10800, "example": 10800 }, "email": { "type": "string", "description": "Email address of the administrator responsible for this zone.", "format": "email", "example": "hostmaster@example.org" } } }, "primary": { "type": "object", "properties": { "id": { "type": "string", "description": "hostid of the liveconfig server\/client which acts as primary nameserver of this zone", "example": "localhost" }, "name": { "type": "string", "description": "hostname of the primary dns server", "example": "ns1.example.org" }, "hidden": { "type": "boolean", "description": "flag if this primary should be a hidden primary", "example": true }, "ttl": { "type": "integer", "description": "ttl for the `ns` entry for this primary", "example": 3600 } } }, "secondaries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "host id of the LiveConfig DNS server or hostname of the external DNS server which acts as secondary of this zone (depending on `external`)", "example": "ext-dns1.example.org" }, "external": { "type": "boolean", "description": "type of the server: `false` (internal) => host id of LiveConfig DNS server, `true` (external) => hostname of external DNS server", "example": false }, "name": { "type": "string", "description": "hostname of this secondary server", "example": "ns2.example.org" }, "ttl": { "type": "integer", "description": "ttl for the `ns` entry for this secondary", "default": 10800, "example": 3600 } } }, "description": "list of up to 4 secondary dns servers for this zone" } } } }, "description": "DNS template details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "DNS-Settings" ], "summary": "Delete DNS template", "description": "This method deletes a DNS template", "parameters": [ { "name": "name", "in": "path", "description": "name of the DNS template", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation Successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "DNS-Settings" ], "summary": "Edit DNS template", "description": "This method edits a DNS template", "parameters": [ { "name": "name", "in": "path", "description": "name of the DNS template", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object with data to be edited", "content": { "application\/json": { "schema": { "type": "object", "properties": { "domainCount": { "type": "integer", "description": "count of domains using this dns template", "readOnly": true, "example": 42, "required": false }, "name": { "type": "string", "description": "name of the template", "example": "Zone 1 hidden primary" }, "soa": { "type": "object", "properties": { "refresh": { "type": "integer", "description": "Number of seconds after which secondary name servers should query the master for the SOA record, to detect zone changes.", "default": 86400, "example": 86400 }, "retry": { "type": "integer", "description": "Number of seconds after which secondary name servers should retry to request the serial number from the master if the master does not respond.", "default": 10800, "example": 7200 }, "expire": { "type": "integer", "description": "Number of seconds after which secondary name servers should stop answering request for this zone if the master does not respond.", "default": "1209600;", "example": 3600000 }, "negativeTtl": { "type": "integer", "description": "Negative response caching TTL in seconds", "default": 3600, "example": 3600 }, "ttl": { "type": "integer", "description": "Time-to-live in seconds for the soa entry", "default": 10800, "example": 10800 }, "email": { "type": "string", "description": "Email address of the administrator responsible for this zone.", "format": "email", "example": "hostmaster@example.org" } } }, "primary": { "type": "object", "properties": { "id": { "type": "string", "description": "hostid of the liveconfig server\/client which acts as primary nameserver of this zone", "example": "localhost" }, "name": { "type": "string", "description": "hostname of the primary dns server", "example": "ns1.example.org" }, "hidden": { "type": "boolean", "description": "flag if this primary should be a hidden primary", "example": true }, "ttl": { "type": "integer", "description": "ttl for the `ns` entry for this primary", "example": 3600 } } }, "secondaries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "host id of the LiveConfig DNS server or hostname of the external DNS server which acts as secondary of this zone (depending on `external`)", "example": "ext-dns1.example.org" }, "external": { "type": "boolean", "description": "type of the server: `false` (internal) => host id of LiveConfig DNS server, `true` (external) => hostname of external DNS server", "example": false }, "name": { "type": "string", "description": "hostname of this secondary server", "example": "ns2.example.org" }, "ttl": { "type": "integer", "description": "ttl for the `ns` entry for this secondary", "default": 10800, "example": 3600 } } }, "description": "list of up to 4 secondary dns servers for this zone" } } } } }, "required": true }, "responses": { "204": { "description": "Operation Successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/domains": { "get": { "tags": [ "Domains" ], "summary": "Get domain list", "description": "This method returns a list of all domains (and optionally subdomains).", "parameters": [ { "name": "count", "in": "query", "description": "number of results to return", "schema": { "minimum": 1, "type": "integer" } }, { "name": "page", "in": "query", "description": "page to return (offset), starting with `1`", "schema": { "minimum": 1, "type": "integer" } }, { "name": "search", "in": "query", "description": "search phrase (is matched against `account`, `domain`, `idn`, `subdomains.host` and `subdomains.idn`)", "schema": { "type": "string" } }, { "name": "show", "in": "query", "description": "comma-separated list of additional data to show (`subdomains`: show subdomain data, `subdomainList`: return a \"flattened\" list with subdomain data)\n", "style": "form", "explode": false, "schema": { "type": "array", "items": { "enum": [ "subdomains", "subdomainList" ], "type": "string" } } }, { "name": "sort", "in": "query", "description": "sort results by given column (default: `domain`)", "schema": { "enum": [ "account", "dnsTemplate", "domain", "punycode" ], "type": "string" } }, { "name": "account", "in": "query", "description": "optionally filter for (sub)domains of this account", "schema": { "type": "string" } }, { "name": "flag", "in": "query", "description": "optionally filter for subdomains with e-mail respective webspace enabled (requires `show=subdomains|subdomainList`)", "schema": { "enum": [ "mail", "web" ], "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "count": { "type": "integer", "description": "number of records found" }, "data": { "type": "array", "items": { "oneOf": [ { "allOf": [ { "required": [ "account", "domain" ], "type": "object", "properties": { "account": { "type": "string", "description": "account where this domain is assigned to" }, "domain": { "type": "string", "description": "internationalized domain name (UTF-8)" }, "punycode": { "type": "string", "description": "punycode representation (`xn--...`) if this is an IDN (Internationalized Domain Name)" } } }, { "required": [ "flags" ], "type": "object", "properties": { "flags": { "type": "array", "items": { "enum": [ "disabled", "dnssec", "editable", "external" ], "type": "string", "description": "feature flags\n * `disabled`: domain is disabled\n * `dnssec`: DNSSEC is enabled\n * `editable`: domain settings can be edited by current user (own external domain, own managed domain or managed domain of own customer)\n * `external`: external DNS server (not managed by LiveConfig)" }, "description": "array of feature flags" }, "subdomains": { "type": "array", "items": { "allOf": [ { "required": [ "flags", "host", "hostPunycode" ], "type": "object", "properties": { "flags": { "type": "array", "items": { "enum": [ "mail", "web" ], "type": "string", "description": "feature flags\n * `mail`: e-mail is enabled with this subdomain\n * `web`: webspace is enabled\/configured with this subdomain" }, "description": "array of feature flags" } } }, { "type": "object", "properties": { "host": { "type": "string", "description": "subdomain name (without domain part, UTF-8)" }, "hostPunycode": { "type": "string", "description": "punycode representation (`xn--...`) if this is an IDN (Internationalized Domain Name)" }, "web": { "required": [ "destination", "type" ], "type": "object", "properties": { "destination": { "type": "string", "description": "destination for this webspace, depending on `type` value (e.g. a path, a URL, or an application name)" }, "tls": { "type": "boolean", "description": "is set to `true` if a TLS certificate is configured with this subdomain" }, "type": { "enum": [ "webspace", 301, 302, "proxy", "app", "redirect", "builder" ], "type": "string", "description": "webspace destination:\n * `webspace`: webspace (directory)\n * `301` permanent HTTP redirect\n * `302` temporary HTTP redirect\n * `proxy` proxy (mirror) another URL\n * `app` web application\n * `redirect` redirect to HTTPS\n * `builder` website builder\n" } }, "description": "webspace configuration for this subdomain" } } } ] }, "description": "subdomain list (only returned with `show=subdomains`)" } } } ] }, { "allOf": [ { "required": [ "account", "domain" ], "type": "object", "properties": { "account": { "type": "string", "description": "account where this domain is assigned to" }, "domain": { "type": "string", "description": "internationalized domain name (UTF-8)" }, "punycode": { "type": "string", "description": "punycode representation (`xn--...`) if this is an IDN (Internationalized Domain Name)" } } }, { "required": [ "flags" ], "type": "object", "properties": { "flags": { "type": "array", "items": { "enum": [ "disabled", "dnssec", "external", "mail", "web" ], "type": "string", "description": "feature flags\n * `disabled`: domain is disabled\n * `dnssec`: DNSSEC is enabled\n * `external`: external DNS server (not managed by LiveConfig)\n * `mail`: e-mail is enabled with this subdomain\n * `web`: webspace is enabled\/configured with this subdomain" }, "description": "array of feature flags" } }, "description": "This \"flattened\" domain\/subdomain list is returned on `show=subdomainList`\n" }, { "type": "object", "properties": { "host": { "type": "string", "description": "subdomain name (without domain part, UTF-8)" }, "hostPunycode": { "type": "string", "description": "punycode representation (`xn--...`) if this is an IDN (Internationalized Domain Name)" }, "web": { "required": [ "destination", "type" ], "type": "object", "properties": { "destination": { "type": "string", "description": "destination for this webspace, depending on `type` value (e.g. a path, a URL, or an application name)" }, "tls": { "type": "boolean", "description": "is set to `true` if a TLS certificate is configured with this subdomain" }, "type": { "enum": [ "webspace", 301, 302, "proxy", "app", "redirect", "builder" ], "type": "string", "description": "webspace destination:\n * `webspace`: webspace (directory)\n * `301` permanent HTTP redirect\n * `302` temporary HTTP redirect\n * `proxy` proxy (mirror) another URL\n * `app` web application\n * `redirect` redirect to HTTPS\n * `builder` website builder\n" } }, "description": "webspace configuration for this subdomain" } } } ] } ] } } }, "description": "a list of all domains", "example": { "success": true, "count": 0, "data": [ { "id": "1a2b3c4d", "dnssec": false } ] } } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Domains" ], "summary": "Add new domain", "description": "This method adds a new domain and subdomain with empty hostname.", "requestBody": { "description": "Data of new domain", "content": { "application\/json": { "schema": { "anyOf": [ { "allOf": [ { "required": [ "account", "domain" ], "type": "object", "properties": { "account": { "type": "string", "description": "account name (where this domain is attached to)", "example": "web1" }, "apps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "identifier for this web application", "example": "wp1" }, "name": { "type": "string", "description": "name of web application software", "example": "Wordpress" } } }, "description": "list of successfully installed (selectable) web applications (only returned with `show=apps`)", "readOnly": true }, "dnsSerial": { "type": "number", "description": "initial serial number when creating domain on primary DNS (is only saved when DNS template is changed)", "example": 2025093001 }, "dnsTemplate": { "type": "string", "description": "name of DNS template (if domain is managed on own DNS servers)", "example": "my DNS template" }, "dnssec": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "is `true` if DNSSEC is enabled" }, "addKeys": { "type": "array", "items": { "type": "number" }, "description": "array of DNSSEC key types to add (e.g. `13` for _ECDSA\/SHA256_)", "writeOnly": true, "example": [ 13 ] }, "delKeys": { "type": "array", "items": { "type": "number" }, "description": "array of key IDs to remove (only valid when editing existing domain)", "writeOnly": true, "example": [ 18359 ] }, "ksk": { "type": "array", "items": { "type": "object", "properties": { "algorithm": { "type": "number", "description": "key algorithm (e.g. 13 = ECDSAP256SHA256)", "example": 13 }, "created": { "type": "string", "description": "timestamp when key was created", "format": "date-time", "example": "2025-06-10T08:55:12+02" }, "tag": { "type": "number", "description": "key tag", "example": 23456 }, "digest": { "type": "string", "description": "SHA256 digest of public key (used for DS record)", "example": "E690945A4490A8E9B7ED0C6640C1C7214EF958698C2958B048C10860968104EA" }, "digestType": { "type": "integer", "description": "type of the digest used", "example": 2 }, "flags": { "type": "integer", "description": "used dnssec flags", "example": 257 }, "protocol": { "type": "integer", "description": "key protocol", "example": 3 }, "dnskey": { "type": "string", "description": "base64 encoded public key", "example": "LAPNXZ1E9zRWlGvgV87+xM ... WdAUwJLDbiWcc7Iw==" } } }, "description": "array of key signing keys (KSK)", "readOnly": true } }, "description": "DNSSEC settings (only if domain is managed on own DNS)" }, "domain": { "type": "string", "description": "the domain name", "example": "example.org" }, "punycode": { "type": "string", "description": "punycode representation (`xn--...`) if this is an IDN (Internationalized Domain Name)", "readOnly": true }, "dns": { "type": "object", "properties": { "defaultRrTtl": { "type": "integer", "description": "Default TTL for resource records of this domain", "readOnly": true, "example": 3600 } } } } }, { "required": [ "host" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "noAutoA": { "type": "boolean", "description": "if webspace is enabled: don't create automatic A\/AAAA records" }, "noAutoMx": { "type": "boolean", "description": "if e-mail is enabled: don't create automatic MX record" }, "rr": { "type": "array", "items": { "required": [ "host", "editable", "type" ], "type": "object", "properties": { "host": { "type": "string", "description": "hostname of this resource record", "example": "mail._domainkey.example.org" }, "editable": { "type": "boolean", "description": "flag if this entry can be edited or is managed by liveconfig itself", "example": false }, "type": { "enum": [ "A", "AAAA", "TXT", "MX", "CAA", "CNAME", "NS", "SRV", "TLSA", "PTR" ], "type": "string", "description": "type of the resource record", "example": "A" }, "ttl": { "type": "integer", "description": "ttl of this resource record in seconds or `null` to use default", "example": 3600 }, "address": { "type": "string", "description": "IPv4 address for `type == A` or IPv6 address for `type == AAAA`", "example": "192.168.123.23" }, "serverName": { "type": "string", "description": "server name for this resource record (only if `type` is one of `CNAME`,`MX`,`NS`,`SRV`,`PTR`)", "example": "www.example.org" }, "prio": { "type": "integer", "description": "priority of this resource record (only if `type` is one of `MX`,`SRV`)", "example": 10 }, "value": { "type": "string", "description": "value for this resource record (only if `type` is one of `TXT`,`CAA`)", "example": "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSI...wIDAQAB" }, "weight": { "type": "integer", "description": "the weight of this resource record (only if `type == SRV`)", "example": 10 }, "port": { "type": "integer", "description": "port of this resource record (only if `type == SRV`)", "example": 8443, "min": 1, "max": 65535 }, "usage": { "type": "integer", "description": "the TLSA usage of this entry (only if `type == TLSA`)", "example": 2, "min": 0, "max": 3 }, "selector": { "type": "integer", "description": "the TLSA selector of this entry (only if `type == TLSA`)", "example": 0, "min": 0, "max": 1 }, "matchingType": { "type": "integer", "description": "the TLSA matching type of this entry (only if `type == TLSA`)", "example": 0, "min": 0, "max": 2 }, "key": { "type": "string", "description": "the TLSA key of this entry (only if `type == TLSA`)", "example": "CA43DC21A123BB..." }, "tag": { "enum": [ "issue", "issuewild", "issuemail", "iodef" ], "type": "string", "description": "the CAA tag for this entry (only if `type == CAA`)", "example": "issue" } } }, "description": "list of resource records" } } }, "ipGroup": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "name of this IP group", "example": "default" }, "software": { "enum": [ "apache", "nginx" ], "type": "string", "description": "web server software this IP group is assigned to", "readOnly": true, "example": "apache" } } }, { "type": "object", "properties": { "ips": { "type": "array", "items": { "type": "string" }, "description": "list of all IP addresses in this IP group", "readOnly": true, "example": [ "198.51.100.42", "2a01:db8:cafe::42" ] } } } ] }, "ipGroups": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "name of this IP group", "example": "default" }, "software": { "enum": [ "apache", "nginx" ], "type": "string", "description": "web server software this IP group is assigned to", "readOnly": true, "example": "apache" } } }, { "type": "object", "properties": { "ips": { "type": "array", "items": { "type": "string" }, "description": "list of all IP addresses in this IP group", "readOnly": true, "example": [ "198.51.100.42", "2a01:db8:cafe::42" ] } } } ] }, "description": "list of available IP groups, returned only with `show=ipGroups`", "readOnly": true }, "mail": { "type": "object", "properties": { "autoconfig": { "type": "boolean", "description": "enable AutoConfig\/AutoDiscover support (only if enabled on corresponding mail server)", "example": false }, "dkim": { "type": "boolean", "description": "enable DKIM (a 2048 bit RSA key will be generated automatically when enabling this option)", "example": true }, "dkimKey": { "type": "string", "description": "public key (to be used in TXT record)", "readOnly": true, "example": "MIIBCg[...]IDAQAB" }, "dkimKeyType": { "enum": [ "rsa", "ec" ], "type": "string", "description": "public key type", "readOnly": true, "example": "rsa" }, "dkimSelector": { "type": "string", "description": "differing selector for DKIM (set to `null` for using default value)", "default": "mail", "nullable": true, "example": "email" }, "dkimTest": { "type": "boolean", "description": "enable test mode for DKIM (only relevant when DNS for this domain is managed by LiveConfig)" }, "enabled": { "type": "boolean", "description": "enable e-mail with this subdomain", "example": true }, "rejectExternal": { "type": "boolean", "description": "reject external e-mails with this domain from unauthenticated external senders", "example": true }, "spf": { "type": "string", "description": "SPF record (must start with `v=spf1`); set empty value to use server default", "example": "v=spf1 a mx ~all" } } }, "web": { "type": "object", "properties": { "app": { "type": "object", "properties": { "id": { "type": "string", "description": "identifier for this web application", "example": "wp1" }, "name": { "type": "string", "description": "name of web application software", "example": "Wordpress" } }, "description": "only returned when `type=app`", "readOnly": true }, "enabled": { "type": "boolean", "description": "enable webspace with this subdomain", "example": true }, "hsts": { "type": "number", "description": "number of seconds for HSTS (HTTP Strict Transport Security)", "example": 31536000, "min": 1 }, "target": { "type": "string", "description": "target for this (sub)domain, depending on `type` (`webspace`: DocumentRoot relative to `htdocs\/`, `redirect_301`\/`redirect_302`\/`proxy`: destination URL, `app`: id of web application)", "example": "website-new\/" }, "tlsCertificate": { "type": "string", "description": "ID of TLS certificate (to enable HTTPS). Set to `null` to disable TLS\/SSL.", "nullable": true, "example": "a1b2c3" }, "tlsEnforce": { "type": "boolean", "description": "automatically redirect from `http:\/\/` to `https:\/\/`", "example": true }, "tlsProduct": { "type": "string", "description": "name of TLS product for automated TLS certificate (certificate will be provisioned automatically after it has been issued)", "example": "lets-encrypt" }, "type": { "enum": [ "webspace", "redirect_301", "redirect_302", "proxy", "app", "builder", "minisite", "disabled" ], "type": "string", "description": "destination for this (sub)domain", "example": "webspace" }, "php": { "type": "string", "description": "PHP version code (set to `null` to use server default PHP version)", "nullable": true, "example": "php82" }, "wwwSync": { "enum": [ "preferNone", "preferNoWww", "preferWww" ], "type": "string", "description": "apply these settings also to `www` (respective non-www) subdomain", "nullable": true, "example": "preferWww" } } } } }, { "type": "object", "properties": { "www": { "type": "boolean", "description": "also add `www` subdomain", "example": true } } } ] }, { "allOf": [ { "required": [ "account", "domain" ], "type": "object", "properties": { "account": { "type": "string", "description": "account name (where this domain is attached to)", "example": "web1" }, "apps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "identifier for this web application", "example": "wp1" }, "name": { "type": "string", "description": "name of web application software", "example": "Wordpress" } } }, "description": "list of successfully installed (selectable) web applications (only returned with `show=apps`)", "readOnly": true }, "dnsSerial": { "type": "number", "description": "initial serial number when creating domain on primary DNS (is only saved when DNS template is changed)", "example": 2025093001 }, "dnsTemplate": { "type": "string", "description": "name of DNS template (if domain is managed on own DNS servers)", "example": "my DNS template" }, "dnssec": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "is `true` if DNSSEC is enabled" }, "addKeys": { "type": "array", "items": { "type": "number" }, "description": "array of DNSSEC key types to add (e.g. `13` for _ECDSA\/SHA256_)", "writeOnly": true, "example": [ 13 ] }, "delKeys": { "type": "array", "items": { "type": "number" }, "description": "array of key IDs to remove (only valid when editing existing domain)", "writeOnly": true, "example": [ 18359 ] }, "ksk": { "type": "array", "items": { "type": "object", "properties": { "algorithm": { "type": "number", "description": "key algorithm (e.g. 13 = ECDSAP256SHA256)", "example": 13 }, "created": { "type": "string", "description": "timestamp when key was created", "format": "date-time", "example": "2025-06-10T08:55:12+02" }, "tag": { "type": "number", "description": "key tag", "example": 23456 }, "digest": { "type": "string", "description": "SHA256 digest of public key (used for DS record)", "example": "E690945A4490A8E9B7ED0C6640C1C7214EF958698C2958B048C10860968104EA" }, "digestType": { "type": "integer", "description": "type of the digest used", "example": 2 }, "flags": { "type": "integer", "description": "used dnssec flags", "example": 257 }, "protocol": { "type": "integer", "description": "key protocol", "example": 3 }, "dnskey": { "type": "string", "description": "base64 encoded public key", "example": "LAPNXZ1E9zRWlGvgV87+xM ... WdAUwJLDbiWcc7Iw==" } } }, "description": "array of key signing keys (KSK)", "readOnly": true } }, "description": "DNSSEC settings (only if domain is managed on own DNS)" }, "domain": { "type": "string", "description": "the domain name", "example": "example.org" }, "punycode": { "type": "string", "description": "punycode representation (`xn--...`) if this is an IDN (Internationalized Domain Name)", "readOnly": true }, "dns": { "type": "object", "properties": { "defaultRrTtl": { "type": "integer", "description": "Default TTL for resource records of this domain", "readOnly": true, "example": 3600 } } } } }, { "type": "object", "properties": { "www": { "type": "boolean", "description": "also add `www` subdomain", "example": true } } } ] } ] } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/domains\/{domain}": { "get": { "tags": [ "Domains" ], "summary": "Get domain details", "description": "This method returns the domain details", "parameters": [ { "name": "domain", "in": "path", "description": "domain name (UTF-8 IDN or punycode)", "required": true, "schema": { "type": "string" } }, { "name": "show", "in": "query", "description": "comma-separated list of additional data to show (`apps`: show list of installed (selectable) web applications, `dnsTemplates`: show available DNS templates, `ipGroups`: show available IP groups, `phpVersions`: show available PHP versions, `subdomains`: only return list of subdomains, `tls`: show matching TLS certificates and available TLS providers)\n", "style": "form", "explode": false, "schema": { "type": "array", "items": { "enum": [ "apps", "dnsTemplates", "ipGroups", "phpVersions", "subdomains", "tls" ], "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "allOf": [ { "required": [ "account", "domain" ], "type": "object", "properties": { "account": { "type": "string", "description": "account name (where this domain is attached to)", "example": "web1" }, "apps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "identifier for this web application", "example": "wp1" }, "name": { "type": "string", "description": "name of web application software", "example": "Wordpress" } } }, "description": "list of successfully installed (selectable) web applications (only returned with `show=apps`)", "readOnly": true }, "dnsSerial": { "type": "number", "description": "initial serial number when creating domain on primary DNS (is only saved when DNS template is changed)", "example": 2025093001 }, "dnsTemplate": { "type": "string", "description": "name of DNS template (if domain is managed on own DNS servers)", "example": "my DNS template" }, "dnssec": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "is `true` if DNSSEC is enabled" }, "addKeys": { "type": "array", "items": { "type": "number" }, "description": "array of DNSSEC key types to add (e.g. `13` for _ECDSA\/SHA256_)", "writeOnly": true, "example": [ 13 ] }, "delKeys": { "type": "array", "items": { "type": "number" }, "description": "array of key IDs to remove (only valid when editing existing domain)", "writeOnly": true, "example": [ 18359 ] }, "ksk": { "type": "array", "items": { "type": "object", "properties": { "algorithm": { "type": "number", "description": "key algorithm (e.g. 13 = ECDSAP256SHA256)", "example": 13 }, "created": { "type": "string", "description": "timestamp when key was created", "format": "date-time", "example": "2025-06-10T08:55:12+02" }, "tag": { "type": "number", "description": "key tag", "example": 23456 }, "digest": { "type": "string", "description": "SHA256 digest of public key (used for DS record)", "example": "E690945A4490A8E9B7ED0C6640C1C7214EF958698C2958B048C10860968104EA" }, "digestType": { "type": "integer", "description": "type of the digest used", "example": 2 }, "flags": { "type": "integer", "description": "used dnssec flags", "example": 257 }, "protocol": { "type": "integer", "description": "key protocol", "example": 3 }, "dnskey": { "type": "string", "description": "base64 encoded public key", "example": "LAPNXZ1E9zRWlGvgV87+xM ... WdAUwJLDbiWcc7Iw==" } } }, "description": "array of key signing keys (KSK)", "readOnly": true } }, "description": "DNSSEC settings (only if domain is managed on own DNS)" }, "domain": { "type": "string", "description": "the domain name", "example": "example.org" }, "punycode": { "type": "string", "description": "punycode representation (`xn--...`) if this is an IDN (Internationalized Domain Name)", "readOnly": true }, "dns": { "type": "object", "properties": { "defaultRrTtl": { "type": "integer", "description": "Default TTL for resource records of this domain", "readOnly": true, "example": 3600 } } } } }, { "required": [ "host" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "noAutoA": { "type": "boolean", "description": "if webspace is enabled: don't create automatic A\/AAAA records" }, "noAutoMx": { "type": "boolean", "description": "if e-mail is enabled: don't create automatic MX record" }, "rr": { "type": "array", "items": { "required": [ "host", "editable", "type" ], "type": "object", "properties": { "host": { "type": "string", "description": "hostname of this resource record", "example": "mail._domainkey.example.org" }, "editable": { "type": "boolean", "description": "flag if this entry can be edited or is managed by liveconfig itself", "example": false }, "type": { "enum": [ "A", "AAAA", "TXT", "MX", "CAA", "CNAME", "NS", "SRV", "TLSA", "PTR" ], "type": "string", "description": "type of the resource record", "example": "A" }, "ttl": { "type": "integer", "description": "ttl of this resource record in seconds or `null` to use default", "example": 3600 }, "address": { "type": "string", "description": "IPv4 address for `type == A` or IPv6 address for `type == AAAA`", "example": "192.168.123.23" }, "serverName": { "type": "string", "description": "server name for this resource record (only if `type` is one of `CNAME`,`MX`,`NS`,`SRV`,`PTR`)", "example": "www.example.org" }, "prio": { "type": "integer", "description": "priority of this resource record (only if `type` is one of `MX`,`SRV`)", "example": 10 }, "value": { "type": "string", "description": "value for this resource record (only if `type` is one of `TXT`,`CAA`)", "example": "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSI...wIDAQAB" }, "weight": { "type": "integer", "description": "the weight of this resource record (only if `type == SRV`)", "example": 10 }, "port": { "type": "integer", "description": "port of this resource record (only if `type == SRV`)", "example": 8443, "min": 1, "max": 65535 }, "usage": { "type": "integer", "description": "the TLSA usage of this entry (only if `type == TLSA`)", "example": 2, "min": 0, "max": 3 }, "selector": { "type": "integer", "description": "the TLSA selector of this entry (only if `type == TLSA`)", "example": 0, "min": 0, "max": 1 }, "matchingType": { "type": "integer", "description": "the TLSA matching type of this entry (only if `type == TLSA`)", "example": 0, "min": 0, "max": 2 }, "key": { "type": "string", "description": "the TLSA key of this entry (only if `type == TLSA`)", "example": "CA43DC21A123BB..." }, "tag": { "enum": [ "issue", "issuewild", "issuemail", "iodef" ], "type": "string", "description": "the CAA tag for this entry (only if `type == CAA`)", "example": "issue" } } }, "description": "list of resource records" } } }, "ipGroup": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "name of this IP group", "example": "default" }, "software": { "enum": [ "apache", "nginx" ], "type": "string", "description": "web server software this IP group is assigned to", "readOnly": true, "example": "apache" } } }, { "type": "object", "properties": { "ips": { "type": "array", "items": { "type": "string" }, "description": "list of all IP addresses in this IP group", "readOnly": true, "example": [ "198.51.100.42", "2a01:db8:cafe::42" ] } } } ] }, "ipGroups": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "name of this IP group", "example": "default" }, "software": { "enum": [ "apache", "nginx" ], "type": "string", "description": "web server software this IP group is assigned to", "readOnly": true, "example": "apache" } } }, { "type": "object", "properties": { "ips": { "type": "array", "items": { "type": "string" }, "description": "list of all IP addresses in this IP group", "readOnly": true, "example": [ "198.51.100.42", "2a01:db8:cafe::42" ] } } } ] }, "description": "list of available IP groups, returned only with `show=ipGroups`", "readOnly": true }, "mail": { "type": "object", "properties": { "autoconfig": { "type": "boolean", "description": "enable AutoConfig\/AutoDiscover support (only if enabled on corresponding mail server)", "example": false }, "dkim": { "type": "boolean", "description": "enable DKIM (a 2048 bit RSA key will be generated automatically when enabling this option)", "example": true }, "dkimKey": { "type": "string", "description": "public key (to be used in TXT record)", "readOnly": true, "example": "MIIBCg[...]IDAQAB" }, "dkimKeyType": { "enum": [ "rsa", "ec" ], "type": "string", "description": "public key type", "readOnly": true, "example": "rsa" }, "dkimSelector": { "type": "string", "description": "differing selector for DKIM (set to `null` for using default value)", "default": "mail", "nullable": true, "example": "email" }, "dkimTest": { "type": "boolean", "description": "enable test mode for DKIM (only relevant when DNS for this domain is managed by LiveConfig)" }, "enabled": { "type": "boolean", "description": "enable e-mail with this subdomain", "example": true }, "rejectExternal": { "type": "boolean", "description": "reject external e-mails with this domain from unauthenticated external senders", "example": true }, "spf": { "type": "string", "description": "SPF record (must start with `v=spf1`); set empty value to use server default", "example": "v=spf1 a mx ~all" } } }, "web": { "type": "object", "properties": { "app": { "type": "object", "properties": { "id": { "type": "string", "description": "identifier for this web application", "example": "wp1" }, "name": { "type": "string", "description": "name of web application software", "example": "Wordpress" } }, "description": "only returned when `type=app`", "readOnly": true }, "enabled": { "type": "boolean", "description": "enable webspace with this subdomain", "example": true }, "hsts": { "type": "number", "description": "number of seconds for HSTS (HTTP Strict Transport Security)", "example": 31536000, "min": 1 }, "target": { "type": "string", "description": "target for this (sub)domain, depending on `type` (`webspace`: DocumentRoot relative to `htdocs\/`, `redirect_301`\/`redirect_302`\/`proxy`: destination URL, `app`: id of web application)", "example": "website-new\/" }, "tlsCertificate": { "type": "string", "description": "ID of TLS certificate (to enable HTTPS). Set to `null` to disable TLS\/SSL.", "nullable": true, "example": "a1b2c3" }, "tlsEnforce": { "type": "boolean", "description": "automatically redirect from `http:\/\/` to `https:\/\/`", "example": true }, "tlsProduct": { "type": "string", "description": "name of TLS product for automated TLS certificate (certificate will be provisioned automatically after it has been issued)", "example": "lets-encrypt" }, "type": { "enum": [ "webspace", "redirect_301", "redirect_302", "proxy", "app", "builder", "minisite", "disabled" ], "type": "string", "description": "destination for this (sub)domain", "example": "webspace" }, "php": { "type": "string", "description": "PHP version code (set to `null` to use server default PHP version)", "nullable": true, "example": "php82" }, "wwwSync": { "enum": [ "preferNone", "preferNoWww", "preferWww" ], "type": "string", "description": "apply these settings also to `www` (respective non-www) subdomain", "nullable": true, "example": "preferWww" } } } } }, { "required": [ "account", "flags" ], "type": "object", "properties": { "host": { "type": "string", "description": "host\/subdomain part (must be empty when editing a domain!)", "example": " " }, "account": { "type": "object", "properties": { "flags": { "type": "array", "items": { "enum": [ "disabled", "dnssec", "editable", "external" ], "type": "string", "description": "feature flags\n * `disabled`: domain is disabled\n * `dnssec`: DNSSEC is enabled\n * `editable`: domain settings can be edited by current user (own external domain, own managed domain or managed domain of own customer)\n * `external`: external DNS server (not managed by LiveConfig)" }, "description": "array of feature flags" }, "hasMail": { "type": "boolean", "description": "is \"true\" if e-mail is available with this account", "example": true }, "mailserverInbound": { "type": "string", "description": "Inbound (POP3\/IMAP) mail server name (if e-mail is available)", "example": "imap.example.org" }, "name": { "type": "string", "description": "account name", "example": "web1" } } } } } ] } }, "description": "Domain details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Domains" ], "summary": "Add new subdomain", "description": "This method adds a new subdomain", "parameters": [ { "name": "domain", "in": "path", "description": "domain name (UTF-8 IDN or punycode)", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Data of new subdomain", "content": { "application\/json": { "schema": { "allOf": [ { "required": [ "host" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "noAutoA": { "type": "boolean", "description": "if webspace is enabled: don't create automatic A\/AAAA records" }, "noAutoMx": { "type": "boolean", "description": "if e-mail is enabled: don't create automatic MX record" }, "rr": { "type": "array", "items": { "required": [ "host", "editable", "type" ], "type": "object", "properties": { "host": { "type": "string", "description": "hostname of this resource record", "example": "mail._domainkey.example.org" }, "editable": { "type": "boolean", "description": "flag if this entry can be edited or is managed by liveconfig itself", "example": false }, "type": { "enum": [ "A", "AAAA", "TXT", "MX", "CAA", "CNAME", "NS", "SRV", "TLSA", "PTR" ], "type": "string", "description": "type of the resource record", "example": "A" }, "ttl": { "type": "integer", "description": "ttl of this resource record in seconds or `null` to use default", "example": 3600 }, "address": { "type": "string", "description": "IPv4 address for `type == A` or IPv6 address for `type == AAAA`", "example": "192.168.123.23" }, "serverName": { "type": "string", "description": "server name for this resource record (only if `type` is one of `CNAME`,`MX`,`NS`,`SRV`,`PTR`)", "example": "www.example.org" }, "prio": { "type": "integer", "description": "priority of this resource record (only if `type` is one of `MX`,`SRV`)", "example": 10 }, "value": { "type": "string", "description": "value for this resource record (only if `type` is one of `TXT`,`CAA`)", "example": "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSI...wIDAQAB" }, "weight": { "type": "integer", "description": "the weight of this resource record (only if `type == SRV`)", "example": 10 }, "port": { "type": "integer", "description": "port of this resource record (only if `type == SRV`)", "example": 8443, "min": 1, "max": 65535 }, "usage": { "type": "integer", "description": "the TLSA usage of this entry (only if `type == TLSA`)", "example": 2, "min": 0, "max": 3 }, "selector": { "type": "integer", "description": "the TLSA selector of this entry (only if `type == TLSA`)", "example": 0, "min": 0, "max": 1 }, "matchingType": { "type": "integer", "description": "the TLSA matching type of this entry (only if `type == TLSA`)", "example": 0, "min": 0, "max": 2 }, "key": { "type": "string", "description": "the TLSA key of this entry (only if `type == TLSA`)", "example": "CA43DC21A123BB..." }, "tag": { "enum": [ "issue", "issuewild", "issuemail", "iodef" ], "type": "string", "description": "the CAA tag for this entry (only if `type == CAA`)", "example": "issue" } } }, "description": "list of resource records" } } }, "ipGroup": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "name of this IP group", "example": "default" }, "software": { "enum": [ "apache", "nginx" ], "type": "string", "description": "web server software this IP group is assigned to", "readOnly": true, "example": "apache" } } }, { "type": "object", "properties": { "ips": { "type": "array", "items": { "type": "string" }, "description": "list of all IP addresses in this IP group", "readOnly": true, "example": [ "198.51.100.42", "2a01:db8:cafe::42" ] } } } ] }, "ipGroups": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "name of this IP group", "example": "default" }, "software": { "enum": [ "apache", "nginx" ], "type": "string", "description": "web server software this IP group is assigned to", "readOnly": true, "example": "apache" } } }, { "type": "object", "properties": { "ips": { "type": "array", "items": { "type": "string" }, "description": "list of all IP addresses in this IP group", "readOnly": true, "example": [ "198.51.100.42", "2a01:db8:cafe::42" ] } } } ] }, "description": "list of available IP groups, returned only with `show=ipGroups`", "readOnly": true }, "mail": { "type": "object", "properties": { "autoconfig": { "type": "boolean", "description": "enable AutoConfig\/AutoDiscover support (only if enabled on corresponding mail server)", "example": false }, "dkim": { "type": "boolean", "description": "enable DKIM (a 2048 bit RSA key will be generated automatically when enabling this option)", "example": true }, "dkimKey": { "type": "string", "description": "public key (to be used in TXT record)", "readOnly": true, "example": "MIIBCg[...]IDAQAB" }, "dkimKeyType": { "enum": [ "rsa", "ec" ], "type": "string", "description": "public key type", "readOnly": true, "example": "rsa" }, "dkimSelector": { "type": "string", "description": "differing selector for DKIM (set to `null` for using default value)", "default": "mail", "nullable": true, "example": "email" }, "dkimTest": { "type": "boolean", "description": "enable test mode for DKIM (only relevant when DNS for this domain is managed by LiveConfig)" }, "enabled": { "type": "boolean", "description": "enable e-mail with this subdomain", "example": true }, "rejectExternal": { "type": "boolean", "description": "reject external e-mails with this domain from unauthenticated external senders", "example": true }, "spf": { "type": "string", "description": "SPF record (must start with `v=spf1`); set empty value to use server default", "example": "v=spf1 a mx ~all" } } }, "web": { "type": "object", "properties": { "app": { "type": "object", "properties": { "id": { "type": "string", "description": "identifier for this web application", "example": "wp1" }, "name": { "type": "string", "description": "name of web application software", "example": "Wordpress" } }, "description": "only returned when `type=app`", "readOnly": true }, "enabled": { "type": "boolean", "description": "enable webspace with this subdomain", "example": true }, "hsts": { "type": "number", "description": "number of seconds for HSTS (HTTP Strict Transport Security)", "example": 31536000, "min": 1 }, "target": { "type": "string", "description": "target for this (sub)domain, depending on `type` (`webspace`: DocumentRoot relative to `htdocs\/`, `redirect_301`\/`redirect_302`\/`proxy`: destination URL, `app`: id of web application)", "example": "website-new\/" }, "tlsCertificate": { "type": "string", "description": "ID of TLS certificate (to enable HTTPS). Set to `null` to disable TLS\/SSL.", "nullable": true, "example": "a1b2c3" }, "tlsEnforce": { "type": "boolean", "description": "automatically redirect from `http:\/\/` to `https:\/\/`", "example": true }, "tlsProduct": { "type": "string", "description": "name of TLS product for automated TLS certificate (certificate will be provisioned automatically after it has been issued)", "example": "lets-encrypt" }, "type": { "enum": [ "webspace", "redirect_301", "redirect_302", "proxy", "app", "builder", "minisite", "disabled" ], "type": "string", "description": "destination for this (sub)domain", "example": "webspace" }, "php": { "type": "string", "description": "PHP version code (set to `null` to use server default PHP version)", "nullable": true, "example": "php82" }, "wwwSync": { "enum": [ "preferNone", "preferNoWww", "preferWww" ], "type": "string", "description": "apply these settings also to `www` (respective non-www) subdomain", "nullable": true, "example": "preferWww" } } } } }, { "type": "object", "properties": { "host": { "type": "string", "description": "host name (subdomain)", "example": "shop" } } } ] } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Domains" ], "summary": "Delete a domain", "description": "This method deletes a domain", "parameters": [ { "name": "domain", "in": "path", "description": "domain name (UTF-8 IDN or punycode)", "required": true, "schema": { "type": "string" } }, { "name": "keepCerts", "in": "query", "description": "don't automatically delete TLS certificates issued only for this domain and\/or any subdomain\n", "style": "form", "explode": false, "schema": { "type": "boolean" } }, { "name": "mailAction", "in": "query", "description": "delete or park existing mailboxes with this domain (only required if there are mailboxes configured with this domain or any subdomain)\n", "style": "form", "explode": false, "schema": { "enum": [ "delete", "park" ], "type": "string" } } ], "responses": { "204": { "description": "Operation Successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Domains" ], "summary": "Edit domain settings", "description": "This method edits a domain", "parameters": [ { "name": "domain", "in": "path", "description": "domain name (UTF-8 IDN or punycode)", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object with data to be edited", "content": { "application\/json": { "schema": { "required": [ "account", "domain" ], "type": "object", "properties": { "account": { "type": "string", "description": "account name (where this domain is attached to)", "example": "web1" }, "apps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "identifier for this web application", "example": "wp1" }, "name": { "type": "string", "description": "name of web application software", "example": "Wordpress" } } }, "description": "list of successfully installed (selectable) web applications (only returned with `show=apps`)", "readOnly": true }, "dnsSerial": { "type": "number", "description": "initial serial number when creating domain on primary DNS (is only saved when DNS template is changed)", "example": 2025093001 }, "dnsTemplate": { "type": "string", "description": "name of DNS template (if domain is managed on own DNS servers)", "example": "my DNS template" }, "dnssec": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "is `true` if DNSSEC is enabled" }, "addKeys": { "type": "array", "items": { "type": "number" }, "description": "array of DNSSEC key types to add (e.g. `13` for _ECDSA\/SHA256_)", "writeOnly": true, "example": [ 13 ] }, "delKeys": { "type": "array", "items": { "type": "number" }, "description": "array of key IDs to remove (only valid when editing existing domain)", "writeOnly": true, "example": [ 18359 ] }, "ksk": { "type": "array", "items": { "type": "object", "properties": { "algorithm": { "type": "number", "description": "key algorithm (e.g. 13 = ECDSAP256SHA256)", "example": 13 }, "created": { "type": "string", "description": "timestamp when key was created", "format": "date-time", "example": "2025-06-10T08:55:12+02" }, "tag": { "type": "number", "description": "key tag", "example": 23456 }, "digest": { "type": "string", "description": "SHA256 digest of public key (used for DS record)", "example": "E690945A4490A8E9B7ED0C6640C1C7214EF958698C2958B048C10860968104EA" }, "digestType": { "type": "integer", "description": "type of the digest used", "example": 2 }, "flags": { "type": "integer", "description": "used dnssec flags", "example": 257 }, "protocol": { "type": "integer", "description": "key protocol", "example": 3 }, "dnskey": { "type": "string", "description": "base64 encoded public key", "example": "LAPNXZ1E9zRWlGvgV87+xM ... WdAUwJLDbiWcc7Iw==" } } }, "description": "array of key signing keys (KSK)", "readOnly": true } }, "description": "DNSSEC settings (only if domain is managed on own DNS)" }, "domain": { "type": "string", "description": "the domain name", "example": "example.org" }, "punycode": { "type": "string", "description": "punycode representation (`xn--...`) if this is an IDN (Internationalized Domain Name)", "readOnly": true }, "dns": { "type": "object", "properties": { "defaultRrTtl": { "type": "integer", "description": "Default TTL for resource records of this domain", "readOnly": true, "example": 3600 } } } } } } }, "required": true }, "responses": { "204": { "description": "Operation Successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/domains\/{domain}\/{host}": { "get": { "tags": [ "Domains" ], "summary": "Get subdomain details", "description": "This method returns the details of a subdomain", "parameters": [ { "name": "domain", "in": "path", "description": "domain name (UTF-8 IDN or punycode)", "required": true, "schema": { "type": "string" } }, { "name": "host", "in": "path", "description": "host name (UTF-8 IDN or punycode)", "required": true, "schema": { "type": "string" } }, { "name": "show", "in": "query", "description": "comma-separated list of additional data to show (`apps`: show list of installed (selectable) web applications, `ipGroups`: show available IP groups, `phpVersions`: show available PHP versions, `tls`: show matching TLS certificates and available TLS providers)\n", "style": "form", "explode": false, "schema": { "type": "array", "items": { "enum": [ "apps", "ipGroups", "phpVersions", "tls" ], "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "allOf": [ { "required": [ "account", "domain" ], "type": "object", "properties": { "account": { "type": "string", "description": "account name (where this domain is attached to)", "example": "web1" }, "apps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "identifier for this web application", "example": "wp1" }, "name": { "type": "string", "description": "name of web application software", "example": "Wordpress" } } }, "description": "list of successfully installed (selectable) web applications (only returned with `show=apps`)", "readOnly": true }, "dnsSerial": { "type": "number", "description": "initial serial number when creating domain on primary DNS (is only saved when DNS template is changed)", "example": 2025093001 }, "dnsTemplate": { "type": "string", "description": "name of DNS template (if domain is managed on own DNS servers)", "example": "my DNS template" }, "dnssec": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "is `true` if DNSSEC is enabled" }, "addKeys": { "type": "array", "items": { "type": "number" }, "description": "array of DNSSEC key types to add (e.g. `13` for _ECDSA\/SHA256_)", "writeOnly": true, "example": [ 13 ] }, "delKeys": { "type": "array", "items": { "type": "number" }, "description": "array of key IDs to remove (only valid when editing existing domain)", "writeOnly": true, "example": [ 18359 ] }, "ksk": { "type": "array", "items": { "type": "object", "properties": { "algorithm": { "type": "number", "description": "key algorithm (e.g. 13 = ECDSAP256SHA256)", "example": 13 }, "created": { "type": "string", "description": "timestamp when key was created", "format": "date-time", "example": "2025-06-10T08:55:12+02" }, "tag": { "type": "number", "description": "key tag", "example": 23456 }, "digest": { "type": "string", "description": "SHA256 digest of public key (used for DS record)", "example": "E690945A4490A8E9B7ED0C6640C1C7214EF958698C2958B048C10860968104EA" }, "digestType": { "type": "integer", "description": "type of the digest used", "example": 2 }, "flags": { "type": "integer", "description": "used dnssec flags", "example": 257 }, "protocol": { "type": "integer", "description": "key protocol", "example": 3 }, "dnskey": { "type": "string", "description": "base64 encoded public key", "example": "LAPNXZ1E9zRWlGvgV87+xM ... WdAUwJLDbiWcc7Iw==" } } }, "description": "array of key signing keys (KSK)", "readOnly": true } }, "description": "DNSSEC settings (only if domain is managed on own DNS)" }, "domain": { "type": "string", "description": "the domain name", "example": "example.org" }, "punycode": { "type": "string", "description": "punycode representation (`xn--...`) if this is an IDN (Internationalized Domain Name)", "readOnly": true }, "dns": { "type": "object", "properties": { "defaultRrTtl": { "type": "integer", "description": "Default TTL for resource records of this domain", "readOnly": true, "example": 3600 } } } } }, { "required": [ "host" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "noAutoA": { "type": "boolean", "description": "if webspace is enabled: don't create automatic A\/AAAA records" }, "noAutoMx": { "type": "boolean", "description": "if e-mail is enabled: don't create automatic MX record" }, "rr": { "type": "array", "items": { "required": [ "host", "editable", "type" ], "type": "object", "properties": { "host": { "type": "string", "description": "hostname of this resource record", "example": "mail._domainkey.example.org" }, "editable": { "type": "boolean", "description": "flag if this entry can be edited or is managed by liveconfig itself", "example": false }, "type": { "enum": [ "A", "AAAA", "TXT", "MX", "CAA", "CNAME", "NS", "SRV", "TLSA", "PTR" ], "type": "string", "description": "type of the resource record", "example": "A" }, "ttl": { "type": "integer", "description": "ttl of this resource record in seconds or `null` to use default", "example": 3600 }, "address": { "type": "string", "description": "IPv4 address for `type == A` or IPv6 address for `type == AAAA`", "example": "192.168.123.23" }, "serverName": { "type": "string", "description": "server name for this resource record (only if `type` is one of `CNAME`,`MX`,`NS`,`SRV`,`PTR`)", "example": "www.example.org" }, "prio": { "type": "integer", "description": "priority of this resource record (only if `type` is one of `MX`,`SRV`)", "example": 10 }, "value": { "type": "string", "description": "value for this resource record (only if `type` is one of `TXT`,`CAA`)", "example": "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSI...wIDAQAB" }, "weight": { "type": "integer", "description": "the weight of this resource record (only if `type == SRV`)", "example": 10 }, "port": { "type": "integer", "description": "port of this resource record (only if `type == SRV`)", "example": 8443, "min": 1, "max": 65535 }, "usage": { "type": "integer", "description": "the TLSA usage of this entry (only if `type == TLSA`)", "example": 2, "min": 0, "max": 3 }, "selector": { "type": "integer", "description": "the TLSA selector of this entry (only if `type == TLSA`)", "example": 0, "min": 0, "max": 1 }, "matchingType": { "type": "integer", "description": "the TLSA matching type of this entry (only if `type == TLSA`)", "example": 0, "min": 0, "max": 2 }, "key": { "type": "string", "description": "the TLSA key of this entry (only if `type == TLSA`)", "example": "CA43DC21A123BB..." }, "tag": { "enum": [ "issue", "issuewild", "issuemail", "iodef" ], "type": "string", "description": "the CAA tag for this entry (only if `type == CAA`)", "example": "issue" } } }, "description": "list of resource records" } } }, "ipGroup": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "name of this IP group", "example": "default" }, "software": { "enum": [ "apache", "nginx" ], "type": "string", "description": "web server software this IP group is assigned to", "readOnly": true, "example": "apache" } } }, { "type": "object", "properties": { "ips": { "type": "array", "items": { "type": "string" }, "description": "list of all IP addresses in this IP group", "readOnly": true, "example": [ "198.51.100.42", "2a01:db8:cafe::42" ] } } } ] }, "ipGroups": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "name of this IP group", "example": "default" }, "software": { "enum": [ "apache", "nginx" ], "type": "string", "description": "web server software this IP group is assigned to", "readOnly": true, "example": "apache" } } }, { "type": "object", "properties": { "ips": { "type": "array", "items": { "type": "string" }, "description": "list of all IP addresses in this IP group", "readOnly": true, "example": [ "198.51.100.42", "2a01:db8:cafe::42" ] } } } ] }, "description": "list of available IP groups, returned only with `show=ipGroups`", "readOnly": true }, "mail": { "type": "object", "properties": { "autoconfig": { "type": "boolean", "description": "enable AutoConfig\/AutoDiscover support (only if enabled on corresponding mail server)", "example": false }, "dkim": { "type": "boolean", "description": "enable DKIM (a 2048 bit RSA key will be generated automatically when enabling this option)", "example": true }, "dkimKey": { "type": "string", "description": "public key (to be used in TXT record)", "readOnly": true, "example": "MIIBCg[...]IDAQAB" }, "dkimKeyType": { "enum": [ "rsa", "ec" ], "type": "string", "description": "public key type", "readOnly": true, "example": "rsa" }, "dkimSelector": { "type": "string", "description": "differing selector for DKIM (set to `null` for using default value)", "default": "mail", "nullable": true, "example": "email" }, "dkimTest": { "type": "boolean", "description": "enable test mode for DKIM (only relevant when DNS for this domain is managed by LiveConfig)" }, "enabled": { "type": "boolean", "description": "enable e-mail with this subdomain", "example": true }, "rejectExternal": { "type": "boolean", "description": "reject external e-mails with this domain from unauthenticated external senders", "example": true }, "spf": { "type": "string", "description": "SPF record (must start with `v=spf1`); set empty value to use server default", "example": "v=spf1 a mx ~all" } } }, "web": { "type": "object", "properties": { "app": { "type": "object", "properties": { "id": { "type": "string", "description": "identifier for this web application", "example": "wp1" }, "name": { "type": "string", "description": "name of web application software", "example": "Wordpress" } }, "description": "only returned when `type=app`", "readOnly": true }, "enabled": { "type": "boolean", "description": "enable webspace with this subdomain", "example": true }, "hsts": { "type": "number", "description": "number of seconds for HSTS (HTTP Strict Transport Security)", "example": 31536000, "min": 1 }, "target": { "type": "string", "description": "target for this (sub)domain, depending on `type` (`webspace`: DocumentRoot relative to `htdocs\/`, `redirect_301`\/`redirect_302`\/`proxy`: destination URL, `app`: id of web application)", "example": "website-new\/" }, "tlsCertificate": { "type": "string", "description": "ID of TLS certificate (to enable HTTPS). Set to `null` to disable TLS\/SSL.", "nullable": true, "example": "a1b2c3" }, "tlsEnforce": { "type": "boolean", "description": "automatically redirect from `http:\/\/` to `https:\/\/`", "example": true }, "tlsProduct": { "type": "string", "description": "name of TLS product for automated TLS certificate (certificate will be provisioned automatically after it has been issued)", "example": "lets-encrypt" }, "type": { "enum": [ "webspace", "redirect_301", "redirect_302", "proxy", "app", "builder", "minisite", "disabled" ], "type": "string", "description": "destination for this (sub)domain", "example": "webspace" }, "php": { "type": "string", "description": "PHP version code (set to `null` to use server default PHP version)", "nullable": true, "example": "php82" }, "wwwSync": { "enum": [ "preferNone", "preferNoWww", "preferWww" ], "type": "string", "description": "apply these settings also to `www` (respective non-www) subdomain", "nullable": true, "example": "preferWww" } } } } }, { "required": [ "account" ], "type": "object", "properties": { "host": { "type": "string", "description": "host\/subdomain part", "example": "www" }, "account": { "type": "object", "properties": { "hasMail": { "type": "boolean", "description": "is \"true\" if e-mail is available with this account", "example": true }, "mailserverInbound": { "type": "string", "description": "Inbound (POP3\/IMAP) mail server name (if e-mail is available)", "example": "imap.example.org" }, "name": { "type": "string", "description": "account name", "example": "web1" } } } } } ] } }, "description": "Domain details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Domains" ], "summary": "Delete a subdomain", "description": "This method deletes a subdomain", "parameters": [ { "name": "domain", "in": "path", "description": "domain name (UTF-8 IDN or punycode)", "required": true, "schema": { "type": "string" } }, { "name": "host", "in": "path", "description": "host name (UTF-8 IDN or punycode)", "required": true, "schema": { "type": "string" } }, { "name": "keepCerts", "in": "query", "description": "don't automatically delete TLS certificates issued only for this subdomain\n", "style": "form", "explode": false, "schema": { "type": "boolean" } }, { "name": "mailAction", "in": "query", "description": "delete or park existing mailboxes with this subdomain (only required if there are mailboxes configured with this subdomain)\n", "style": "form", "explode": false, "schema": { "enum": [ "delete", "park" ], "type": "string" } } ], "responses": { "204": { "description": "Operation Successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Domains" ], "summary": "Edit subdomain details", "description": "This method edits a subdomain", "parameters": [ { "name": "domain", "in": "path", "description": "domain name (UTF-8 IDN or punycode)", "required": true, "schema": { "type": "string" } }, { "name": "host", "in": "path", "description": "host name (UTF-8 IDN or punycode)", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object with data to be edited", "content": { "application\/json": { "schema": { "required": [ "host" ], "type": "object", "properties": { "dns": { "type": "object", "properties": { "noAutoA": { "type": "boolean", "description": "if webspace is enabled: don't create automatic A\/AAAA records" }, "noAutoMx": { "type": "boolean", "description": "if e-mail is enabled: don't create automatic MX record" }, "rr": { "type": "array", "items": { "required": [ "host", "editable", "type" ], "type": "object", "properties": { "host": { "type": "string", "description": "hostname of this resource record", "example": "mail._domainkey.example.org" }, "editable": { "type": "boolean", "description": "flag if this entry can be edited or is managed by liveconfig itself", "example": false }, "type": { "enum": [ "A", "AAAA", "TXT", "MX", "CAA", "CNAME", "NS", "SRV", "TLSA", "PTR" ], "type": "string", "description": "type of the resource record", "example": "A" }, "ttl": { "type": "integer", "description": "ttl of this resource record in seconds or `null` to use default", "example": 3600 }, "address": { "type": "string", "description": "IPv4 address for `type == A` or IPv6 address for `type == AAAA`", "example": "192.168.123.23" }, "serverName": { "type": "string", "description": "server name for this resource record (only if `type` is one of `CNAME`,`MX`,`NS`,`SRV`,`PTR`)", "example": "www.example.org" }, "prio": { "type": "integer", "description": "priority of this resource record (only if `type` is one of `MX`,`SRV`)", "example": 10 }, "value": { "type": "string", "description": "value for this resource record (only if `type` is one of `TXT`,`CAA`)", "example": "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSI...wIDAQAB" }, "weight": { "type": "integer", "description": "the weight of this resource record (only if `type == SRV`)", "example": 10 }, "port": { "type": "integer", "description": "port of this resource record (only if `type == SRV`)", "example": 8443, "min": 1, "max": 65535 }, "usage": { "type": "integer", "description": "the TLSA usage of this entry (only if `type == TLSA`)", "example": 2, "min": 0, "max": 3 }, "selector": { "type": "integer", "description": "the TLSA selector of this entry (only if `type == TLSA`)", "example": 0, "min": 0, "max": 1 }, "matchingType": { "type": "integer", "description": "the TLSA matching type of this entry (only if `type == TLSA`)", "example": 0, "min": 0, "max": 2 }, "key": { "type": "string", "description": "the TLSA key of this entry (only if `type == TLSA`)", "example": "CA43DC21A123BB..." }, "tag": { "enum": [ "issue", "issuewild", "issuemail", "iodef" ], "type": "string", "description": "the CAA tag for this entry (only if `type == CAA`)", "example": "issue" } } }, "description": "list of resource records" } } }, "ipGroup": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "name of this IP group", "example": "default" }, "software": { "enum": [ "apache", "nginx" ], "type": "string", "description": "web server software this IP group is assigned to", "readOnly": true, "example": "apache" } } }, { "type": "object", "properties": { "ips": { "type": "array", "items": { "type": "string" }, "description": "list of all IP addresses in this IP group", "readOnly": true, "example": [ "198.51.100.42", "2a01:db8:cafe::42" ] } } } ] }, "ipGroups": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "name of this IP group", "example": "default" }, "software": { "enum": [ "apache", "nginx" ], "type": "string", "description": "web server software this IP group is assigned to", "readOnly": true, "example": "apache" } } }, { "type": "object", "properties": { "ips": { "type": "array", "items": { "type": "string" }, "description": "list of all IP addresses in this IP group", "readOnly": true, "example": [ "198.51.100.42", "2a01:db8:cafe::42" ] } } } ] }, "description": "list of available IP groups, returned only with `show=ipGroups`", "readOnly": true }, "mail": { "type": "object", "properties": { "autoconfig": { "type": "boolean", "description": "enable AutoConfig\/AutoDiscover support (only if enabled on corresponding mail server)", "example": false }, "dkim": { "type": "boolean", "description": "enable DKIM (a 2048 bit RSA key will be generated automatically when enabling this option)", "example": true }, "dkimKey": { "type": "string", "description": "public key (to be used in TXT record)", "readOnly": true, "example": "MIIBCg[...]IDAQAB" }, "dkimKeyType": { "enum": [ "rsa", "ec" ], "type": "string", "description": "public key type", "readOnly": true, "example": "rsa" }, "dkimSelector": { "type": "string", "description": "differing selector for DKIM (set to `null` for using default value)", "default": "mail", "nullable": true, "example": "email" }, "dkimTest": { "type": "boolean", "description": "enable test mode for DKIM (only relevant when DNS for this domain is managed by LiveConfig)" }, "enabled": { "type": "boolean", "description": "enable e-mail with this subdomain", "example": true }, "rejectExternal": { "type": "boolean", "description": "reject external e-mails with this domain from unauthenticated external senders", "example": true }, "spf": { "type": "string", "description": "SPF record (must start with `v=spf1`); set empty value to use server default", "example": "v=spf1 a mx ~all" } } }, "web": { "type": "object", "properties": { "app": { "type": "object", "properties": { "id": { "type": "string", "description": "identifier for this web application", "example": "wp1" }, "name": { "type": "string", "description": "name of web application software", "example": "Wordpress" } }, "description": "only returned when `type=app`", "readOnly": true }, "enabled": { "type": "boolean", "description": "enable webspace with this subdomain", "example": true }, "hsts": { "type": "number", "description": "number of seconds for HSTS (HTTP Strict Transport Security)", "example": 31536000, "min": 1 }, "target": { "type": "string", "description": "target for this (sub)domain, depending on `type` (`webspace`: DocumentRoot relative to `htdocs\/`, `redirect_301`\/`redirect_302`\/`proxy`: destination URL, `app`: id of web application)", "example": "website-new\/" }, "tlsCertificate": { "type": "string", "description": "ID of TLS certificate (to enable HTTPS). Set to `null` to disable TLS\/SSL.", "nullable": true, "example": "a1b2c3" }, "tlsEnforce": { "type": "boolean", "description": "automatically redirect from `http:\/\/` to `https:\/\/`", "example": true }, "tlsProduct": { "type": "string", "description": "name of TLS product for automated TLS certificate (certificate will be provisioned automatically after it has been issued)", "example": "lets-encrypt" }, "type": { "enum": [ "webspace", "redirect_301", "redirect_302", "proxy", "app", "builder", "minisite", "disabled" ], "type": "string", "description": "destination for this (sub)domain", "example": "webspace" }, "php": { "type": "string", "description": "PHP version code (set to `null` to use server default PHP version)", "nullable": true, "example": "php82" }, "wwwSync": { "enum": [ "preferNone", "preferNoWww", "preferWww" ], "type": "string", "description": "apply these settings also to `www` (respective non-www) subdomain", "nullable": true, "example": "preferWww" } } } } } } }, "required": true }, "responses": { "204": { "description": "Operation Successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/domains\/{domain}\/{host}\/dyndns": { "get": { "tags": [ "Domains" ], "summary": "Get dyndns credentials", "description": "This method returns the credentials for dyndns updates if enabled", "parameters": [ { "name": "domain", "in": "path", "description": "domain name (UTF-8 IDN or punycode)", "required": true, "schema": { "type": "string" } }, { "name": "host", "in": "path", "description": "host name (UTF-8 IDN or punycode)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "login": { "maxLength": 40, "minLength": 1, "type": "string", "description": "User name for dynamic DNS updates (only ASCII characters allowed)", "example": "dyndnsUser" }, "password": { "type": "string", "description": "Password for dynamic DNS updates", "writeOnly": true, "example": "Sup\u20acr$ecur3" } } } }, "description": "DynDns credentials" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Domains" ], "summary": "enabled dyndns updates (create credentials)", "description": "This method enables dyndns updates (creates credentials)", "parameters": [ { "name": "domain", "in": "path", "description": "domain name (UTF-8 IDN or punycode)", "required": true, "schema": { "type": "string" } }, { "name": "host", "in": "path", "description": "host name (UTF-8 IDN or punycode)", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object with data to be edited", "content": { "application\/json": { "schema": { "type": "object", "properties": { "login": { "maxLength": 40, "minLength": 1, "type": "string", "description": "User name for dynamic DNS updates (only ASCII characters allowed)", "example": "dyndnsUser" }, "password": { "type": "string", "description": "Password for dynamic DNS updates", "writeOnly": true, "example": "Sup\u20acr$ecur3" } } } } }, "required": true }, "responses": { "204": { "description": "Operation Successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Domains" ], "summary": "Disable dyndns (remove credentials)", "description": "This method disables dyndns updates (removes credentials)", "parameters": [ { "name": "domain", "in": "path", "description": "domain name (UTF-8 IDN or punycode)", "required": true, "schema": { "type": "string" } }, { "name": "host", "in": "path", "description": "host name (UTF-8 IDN or punycode)", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation Successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Domains" ], "summary": "Edit dyndns credentials", "description": "This method edits dyndns credentials", "parameters": [ { "name": "domain", "in": "path", "description": "domain name (UTF-8 IDN or punycode)", "required": true, "schema": { "type": "string" } }, { "name": "host", "in": "path", "description": "host name (UTF-8 IDN or punycode)", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object with data to be edited", "content": { "application\/json": { "schema": { "type": "object", "properties": { "login": { "maxLength": 40, "minLength": 1, "type": "string", "description": "User name for dynamic DNS updates (only ASCII characters allowed)", "example": "dyndnsUser" }, "password": { "type": "string", "description": "Password for dynamic DNS updates", "writeOnly": true, "example": "Sup\u20acr$ecur3" } } } } }, "required": true }, "responses": { "204": { "description": "Operation Successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/dyndns\/update": { "post": { "tags": [ "Domains" ], "summary": "update dyndns DNS entries", "description": "This method updates dyndns domain records", "requestBody": { "description": "Update Request data", "content": { "application\/x-www-form-urlencoded": { "schema": { "required": [ "hostname" ], "type": "object", "properties": { "hostname": { "type": "string", "description": "dyndns enabled subdomain", "example": "dyndns.example.org" }, "myip": { "type": "string", "description": "IPv4 to be set as A-record of the above hostname (use '`nochg`' to not change, omit to remove A-record)", "example": "198.51.100.12" }, "myip6": { "type": "string", "description": "IPv6 to be set as AAAA-record of the above hostname (use '`nochg`' to not change, omit to remove AAAA-record)", "example": "2001:db8::45ac:432" } } } } }, "required": true }, "responses": { "200": { "description": "Operation Successful", "content": { "text\/plain": { "schema": { "type": "string", "description": "`good\n` for successful operation with changes. `nochg\n` for successful operation without any changes in DNS", "example": "good\\n" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/log": { "get": { "tags": [ "Logs" ], "summary": "Get EventLog list", "description": "This method return a list all EventLogs", "parameters": [ { "name": "count", "in": "query", "description": "number of results to return", "schema": { "minimum": 1, "type": "integer" } }, { "name": "page", "in": "query", "description": "page to return (offset), starting with `1`", "schema": { "minimum": 1, "type": "integer" } }, { "name": "search", "in": "query", "description": "search phrase (is matched against `message`)", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "sort results by given column (default: `timestamp`)", "schema": { "enum": [ "timestamp" ], "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 12 }, "data": { "type": "array", "items": { "type": "object", "properties": { "level": { "type": "integer", "description": "The Level of the log entry", "readOnly": true }, "customer": { "type": "string", "description": "Customer id", "readOnly": true }, "user": { "type": "string", "description": "User name", "readOnly": true }, "realUser": { "type": "string", "description": "Real user name (if done on behalf of a user)", "readOnly": true }, "timestamp": { "type": "string", "description": "Date and time of the event", "readOnly": true }, "moduleId": { "type": "integer", "description": "Module id", "readOnly": true }, "eventId": { "type": "integer", "description": "Event id", "readOnly": true }, "message": { "type": "string", "description": "Message of the event", "readOnly": true }, "data": { "type": "string", "description": "Data of the event", "readOnly": true } } } } }, "description": "a list of all eventlogs" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/mailboxes": { "get": { "tags": [ "Mailboxes" ], "summary": "Get list of all mailboxes", "description": "This method returns a list of all mailboxes", "parameters": [ { "name": "count", "in": "query", "description": "number of results to return", "schema": { "minimum": 1, "type": "integer" } }, { "name": "page", "in": "query", "description": "page to return (offset), starting with `1`", "schema": { "minimum": 1, "type": "integer" } }, { "name": "search", "in": "query", "description": "search phrase (is matched against all fields)", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "sort results by given column (default: `address`)", "schema": { "enum": [ "account", "address", "io", "quota", "size" ], "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 1 }, "data": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Mailbox id", "readOnly": true, "example": "bIAzOg" }, "account": { "type": "string", "description": "Account name", "readOnly": true, "example": "web1" }, "status": { "enum": [ "creating", "ok", "updating", "error", "deleting" ], "type": "string", "description": "Current configuration status of this mailbox", "readOnly": true }, "lastConfigChange": { "type": "string", "description": "Timestamp when the mailbox was last updated on the server", "format": "date-time", "readOnly": true, "example": "2020-07-21T17:32:28Z" }, "name": { "type": "string", "description": "Name part of e-mail address", "example": "info" }, "domain": { "type": "string", "description": "Domain part of e-mail address -> set `null` to park the mailbox without domain", "nullable": true, "example": "example.org" }, "description": { "type": "string", "description": "User-defined mailbox description", "example": "Example address for documentation" }, "mailbox": { "type": "boolean", "description": "`true` for IMAP\/POP3 mailbox, `false` when only forwarding emails" }, "password": { "type": "string", "description": "Password for the IMAP\/POP3 mailbox (required on `POST` when mailbox == `true`)", "writeOnly": true, "example": "$u\u00df\u20acs3cre7" }, "quotaSize": { "type": "integer", "description": "Maximum mailbox size (MiB)", "example": 100 }, "io": { "type": "integer", "description": "Number of e-mails sent and received within the last 24 hours", "readOnly": true, "example": 42 }, "size": { "type": "integer", "description": "Size of all e-mails in this mailbox (MiB)", "example": 2 }, "count": { "type": "integer", "description": "Number of (all) e-mails in this mailbox", "example": 4321 }, "statTs": { "type": "string", "description": "Timestamp when `size` and `count` where calculated", "format": "date-time", "example": "2022-11-21T17:32:28Z" }, "autoConfig": { "enum": [ "imap-pop3", "pop3-imap", "imap-only", "pop3-only", "disabled" ], "type": "string", "description": "AutoConfiguration\/Autodiscover setting", "example": "imap-pop3" }, "selfService": { "type": "boolean", "description": "Allow user to log in to LiveConfig and edit its mailbox settings" }, "purgeTrash": { "type": "integer", "description": "Days after which emails should be purged from the trash folder (0 to disable)", "example": 30, "min": 0, "max": 365 }, "greylisting": { "type": "boolean", "description": "Greylisting enabled" }, "spamfilter": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Spam filter (content scanner) enabled" }, "warnThreshold": { "maximum": 999.99, "minimum": 0, "type": "number", "description": "Threshold for tagging messages as possible spam", "format": "float" }, "rejectThreshold": { "maximum": 999.99, "minimum": 0, "type": "number", "description": "Threshold for rejecting messages as spam", "format": "float" }, "allowList": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "Array of e-mail addresses to _not_ check by spam filter", "examle": [ "info@example.org", "nospam@example.org" ] }, "denyList": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "Array of e-mail addresses to reject by spam filter", "example": [ "spam@example.org" ] } } }, "autoreply": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Autoresponder enabled" }, "subject": { "maxLength": 128, "type": "string", "description": "Subject of the autoresponder email (placeholder `${subject}` will be replaced with original subject)", "example": "Out of Office: Re: ${subject}" }, "text": { "maxLength": 4096, "type": "string", "description": "text of the autoresponder email", "example": "Hi, \n i'm not in the office. please try again later this week." }, "end": { "type": "string", "description": "Date where the autoresponder will be automatically disabled (if `null` autoreply is not disabled automatically)", "format": "date-time", "nullable": true, "example": "2023-01-03T23:59:59Z" } } }, "forward": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "list of email addresses where incoming emails are forwarded to", "example": [ "test@example.org", "test2@example.org" ] }, "enabled": { "type": "boolean", "description": "Mail forwarding enabled" }, "srs": { "type": "boolean", "description": "apply SRS (sender rewriting scheme) when forwarding e-mails (needs to be installed & enabled for the mail server)", "example": true } } }, "bccInbound": { "type": "string", "description": "E-Mail address to send a copy of all incoming e-mails to (only if supported by mail server)", "format": "email", "example": "archiving@example.org" }, "bccOutbound": { "type": "string", "description": "E-Mail address to send a copy of all outbound e-mails to (only if supported by mail server)", "format": "email", "example": "archiving@example.org" }, "aliases": { "type": "array", "items": { "type": "string" }, "description": "list of names used as aliases for this email (local part only)", "example": [ "sales", "accounting" ] }, "limit": { "type": "object", "properties": { "perHour": { "type": "integer", "description": "amount of emails allowed for this account per hour (only set if differing from account or template) (if `null` use the value from account or template)", "nullable": true, "example": 100 }, "blocked": { "type": "boolean", "description": "shows if this mailbox is currently blocked from sending because of offending the limit", "readOnly": true, "example": true }, "lastBlocked": { "type": "string", "description": "Timestamp of when this mailbox was last blocked from sending emails", "format": "datetime", "readOnly": true }, "blockedCount": { "type": "integer", "description": "count of blocked emails during the time the last blocking period", "readOnly": true, "example": 181982 } } } } }, { "required": [ "id", "name", "domain", "mailbox" ], "type": "object" } ] } } }, "description": "a list of all mailboxes" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Mailboxes" ], "summary": "Add new mailbox", "description": "This method adds a new mailbox.", "requestBody": { "description": "Data of new mailbox", "content": { "application\/json": { "schema": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Mailbox id", "readOnly": true, "example": "bIAzOg" }, "account": { "type": "string", "description": "Account name", "readOnly": true, "example": "web1" }, "status": { "enum": [ "creating", "ok", "updating", "error", "deleting" ], "type": "string", "description": "Current configuration status of this mailbox", "readOnly": true }, "lastConfigChange": { "type": "string", "description": "Timestamp when the mailbox was last updated on the server", "format": "date-time", "readOnly": true, "example": "2020-07-21T17:32:28Z" }, "name": { "type": "string", "description": "Name part of e-mail address", "example": "info" }, "domain": { "type": "string", "description": "Domain part of e-mail address -> set `null` to park the mailbox without domain", "nullable": true, "example": "example.org" }, "description": { "type": "string", "description": "User-defined mailbox description", "example": "Example address for documentation" }, "mailbox": { "type": "boolean", "description": "`true` for IMAP\/POP3 mailbox, `false` when only forwarding emails" }, "password": { "type": "string", "description": "Password for the IMAP\/POP3 mailbox (required on `POST` when mailbox == `true`)", "writeOnly": true, "example": "$u\u00df\u20acs3cre7" }, "quotaSize": { "type": "integer", "description": "Maximum mailbox size (MiB)", "example": 100 }, "io": { "type": "integer", "description": "Number of e-mails sent and received within the last 24 hours", "readOnly": true, "example": 42 }, "size": { "type": "integer", "description": "Size of all e-mails in this mailbox (MiB)", "example": 2 }, "count": { "type": "integer", "description": "Number of (all) e-mails in this mailbox", "example": 4321 }, "statTs": { "type": "string", "description": "Timestamp when `size` and `count` where calculated", "format": "date-time", "example": "2022-11-21T17:32:28Z" }, "autoConfig": { "enum": [ "imap-pop3", "pop3-imap", "imap-only", "pop3-only", "disabled" ], "type": "string", "description": "AutoConfiguration\/Autodiscover setting", "example": "imap-pop3" }, "selfService": { "type": "boolean", "description": "Allow user to log in to LiveConfig and edit its mailbox settings" }, "purgeTrash": { "type": "integer", "description": "Days after which emails should be purged from the trash folder (0 to disable)", "example": 30, "min": 0, "max": 365 }, "greylisting": { "type": "boolean", "description": "Greylisting enabled" }, "spamfilter": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Spam filter (content scanner) enabled" }, "warnThreshold": { "maximum": 999.99, "minimum": 0, "type": "number", "description": "Threshold for tagging messages as possible spam", "format": "float" }, "rejectThreshold": { "maximum": 999.99, "minimum": 0, "type": "number", "description": "Threshold for rejecting messages as spam", "format": "float" }, "allowList": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "Array of e-mail addresses to _not_ check by spam filter", "examle": [ "info@example.org", "nospam@example.org" ] }, "denyList": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "Array of e-mail addresses to reject by spam filter", "example": [ "spam@example.org" ] } } }, "autoreply": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Autoresponder enabled" }, "subject": { "maxLength": 128, "type": "string", "description": "Subject of the autoresponder email (placeholder `${subject}` will be replaced with original subject)", "example": "Out of Office: Re: ${subject}" }, "text": { "maxLength": 4096, "type": "string", "description": "text of the autoresponder email", "example": "Hi, \n i'm not in the office. please try again later this week." }, "end": { "type": "string", "description": "Date where the autoresponder will be automatically disabled (if `null` autoreply is not disabled automatically)", "format": "date-time", "nullable": true, "example": "2023-01-03T23:59:59Z" } } }, "forward": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "list of email addresses where incoming emails are forwarded to", "example": [ "test@example.org", "test2@example.org" ] }, "enabled": { "type": "boolean", "description": "Mail forwarding enabled" }, "srs": { "type": "boolean", "description": "apply SRS (sender rewriting scheme) when forwarding e-mails (needs to be installed & enabled for the mail server)", "example": true } } }, "bccInbound": { "type": "string", "description": "E-Mail address to send a copy of all incoming e-mails to (only if supported by mail server)", "format": "email", "example": "archiving@example.org" }, "bccOutbound": { "type": "string", "description": "E-Mail address to send a copy of all outbound e-mails to (only if supported by mail server)", "format": "email", "example": "archiving@example.org" }, "aliases": { "type": "array", "items": { "type": "string" }, "description": "list of names used as aliases for this email (local part only)", "example": [ "sales", "accounting" ] }, "limit": { "type": "object", "properties": { "perHour": { "type": "integer", "description": "amount of emails allowed for this account per hour (only set if differing from account or template) (if `null` use the value from account or template)", "nullable": true, "example": 100 }, "blocked": { "type": "boolean", "description": "shows if this mailbox is currently blocked from sending because of offending the limit", "readOnly": true, "example": true }, "lastBlocked": { "type": "string", "description": "Timestamp of when this mailbox was last blocked from sending emails", "format": "datetime", "readOnly": true }, "blockedCount": { "type": "integer", "description": "count of blocked emails during the time the last blocking period", "readOnly": true, "example": 181982 } } } } }, { "required": [ "id", "name", "domain", "mailbox" ], "type": "object" } ] } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/mailboxes\/{address}": { "get": { "tags": [ "Mailboxes" ], "summary": "Get mailbox details", "description": "This method returns the details of a mailbox", "parameters": [ { "name": "address", "in": "path", "description": "e-mail address or encoded id", "required": true, "schema": { "type": "string" } }, { "name": "show", "in": "query", "description": "comma-separated list of additional data to show (`backup`: show list of available backups, `domains`: show list of e-mail capable domains within same account, `mailserver`: return mail server details)\n", "style": "form", "explode": false, "schema": { "type": "array", "items": { "enum": [ "backup", "domains", "mailserver" ], "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Mailbox id", "readOnly": true, "example": "bIAzOg" }, "account": { "type": "string", "description": "Account name", "readOnly": true, "example": "web1" }, "status": { "enum": [ "creating", "ok", "updating", "error", "deleting" ], "type": "string", "description": "Current configuration status of this mailbox", "readOnly": true }, "lastConfigChange": { "type": "string", "description": "Timestamp when the mailbox was last updated on the server", "format": "date-time", "readOnly": true, "example": "2020-07-21T17:32:28Z" }, "name": { "type": "string", "description": "Name part of e-mail address", "example": "info" }, "domain": { "type": "string", "description": "Domain part of e-mail address -> set `null` to park the mailbox without domain", "nullable": true, "example": "example.org" }, "description": { "type": "string", "description": "User-defined mailbox description", "example": "Example address for documentation" }, "mailbox": { "type": "boolean", "description": "`true` for IMAP\/POP3 mailbox, `false` when only forwarding emails" }, "password": { "type": "string", "description": "Password for the IMAP\/POP3 mailbox (required on `POST` when mailbox == `true`)", "writeOnly": true, "example": "$u\u00df\u20acs3cre7" }, "quotaSize": { "type": "integer", "description": "Maximum mailbox size (MiB)", "example": 100 }, "io": { "type": "integer", "description": "Number of e-mails sent and received within the last 24 hours", "readOnly": true, "example": 42 }, "size": { "type": "integer", "description": "Size of all e-mails in this mailbox (MiB)", "example": 2 }, "count": { "type": "integer", "description": "Number of (all) e-mails in this mailbox", "example": 4321 }, "statTs": { "type": "string", "description": "Timestamp when `size` and `count` where calculated", "format": "date-time", "example": "2022-11-21T17:32:28Z" }, "autoConfig": { "enum": [ "imap-pop3", "pop3-imap", "imap-only", "pop3-only", "disabled" ], "type": "string", "description": "AutoConfiguration\/Autodiscover setting", "example": "imap-pop3" }, "selfService": { "type": "boolean", "description": "Allow user to log in to LiveConfig and edit its mailbox settings" }, "purgeTrash": { "type": "integer", "description": "Days after which emails should be purged from the trash folder (0 to disable)", "example": 30, "min": 0, "max": 365 }, "greylisting": { "type": "boolean", "description": "Greylisting enabled" }, "spamfilter": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Spam filter (content scanner) enabled" }, "warnThreshold": { "maximum": 999.99, "minimum": 0, "type": "number", "description": "Threshold for tagging messages as possible spam", "format": "float" }, "rejectThreshold": { "maximum": 999.99, "minimum": 0, "type": "number", "description": "Threshold for rejecting messages as spam", "format": "float" }, "allowList": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "Array of e-mail addresses to _not_ check by spam filter", "examle": [ "info@example.org", "nospam@example.org" ] }, "denyList": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "Array of e-mail addresses to reject by spam filter", "example": [ "spam@example.org" ] } } }, "autoreply": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Autoresponder enabled" }, "subject": { "maxLength": 128, "type": "string", "description": "Subject of the autoresponder email (placeholder `${subject}` will be replaced with original subject)", "example": "Out of Office: Re: ${subject}" }, "text": { "maxLength": 4096, "type": "string", "description": "text of the autoresponder email", "example": "Hi, \n i'm not in the office. please try again later this week." }, "end": { "type": "string", "description": "Date where the autoresponder will be automatically disabled (if `null` autoreply is not disabled automatically)", "format": "date-time", "nullable": true, "example": "2023-01-03T23:59:59Z" } } }, "forward": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "list of email addresses where incoming emails are forwarded to", "example": [ "test@example.org", "test2@example.org" ] }, "enabled": { "type": "boolean", "description": "Mail forwarding enabled" }, "srs": { "type": "boolean", "description": "apply SRS (sender rewriting scheme) when forwarding e-mails (needs to be installed & enabled for the mail server)", "example": true } } }, "bccInbound": { "type": "string", "description": "E-Mail address to send a copy of all incoming e-mails to (only if supported by mail server)", "format": "email", "example": "archiving@example.org" }, "bccOutbound": { "type": "string", "description": "E-Mail address to send a copy of all outbound e-mails to (only if supported by mail server)", "format": "email", "example": "archiving@example.org" }, "aliases": { "type": "array", "items": { "type": "string" }, "description": "list of names used as aliases for this email (local part only)", "example": [ "sales", "accounting" ] }, "limit": { "type": "object", "properties": { "perHour": { "type": "integer", "description": "amount of emails allowed for this account per hour (only set if differing from account or template) (if `null` use the value from account or template)", "nullable": true, "example": 100 }, "blocked": { "type": "boolean", "description": "shows if this mailbox is currently blocked from sending because of offending the limit", "readOnly": true, "example": true }, "lastBlocked": { "type": "string", "description": "Timestamp of when this mailbox was last blocked from sending emails", "format": "datetime", "readOnly": true }, "blockedCount": { "type": "integer", "description": "count of blocked emails during the time the last blocking period", "readOnly": true, "example": 181982 } } } } }, { "required": [ "id", "name", "domain", "mailbox" ], "type": "object", "properties": { "availableMailDomains": { "type": "array", "items": { "type": "string" }, "description": "Domains with e-mail enabled within same account (can be used to switch e-mail address to another domain). Only returned with `show=domains`.", "example": [ "example1.org", "example2.org", "example3.org" ] }, "backup": { "type": "object", "properties": { "list": { "type": "object", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the backup", "readOnly": true, "example": "bIAzOg" }, "objectName": { "type": "string", "description": "name of the backuped object", "readOnly": true, "example": "web123@example.org" }, "archiveSize": { "type": "integer", "description": "size of the backuped archive in bytes", "readOnly": true, "example": 1258 }, "size": { "type": "integer", "description": "size of the backuped data in bytes", "readOnly": true, "example": 4082 }, "type": { "enum": [ "web", "db", "mail" ], "type": "string", "description": "type of the backuped object", "readOnly": true, "example": "mail" }, "started": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z" }, "finished": { "type": "string", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:35:28Z" }, "status": { "enum": [ "none", "submitted", "inPreparation", "running", "finished", "error" ], "type": "string", "description": "status of the backup", "readOnly": true, "example": "finished" }, "statusMsg": { "type": "string", "description": "human readable status message", "readOnly": true, "example": "Job finished successful" }, "storage": { "type": "string", "description": "backup-storage id", "readOnly": true, "example": "bIAzOg" } }, "required": null }, "description": "list of available backups" }, "manual": { "type": "boolean", "description": "manual backups available", "example": true } }, "description": "Backup details. Only returned with `show=backup`." }, "mailserver": { "type": "object", "properties": { "autoConfig": { "type": "boolean" }, "bccInbound": { "type": "boolean" }, "bccOutbound": { "type": "boolean" }, "greylisting": { "type": "boolean" }, "inbound": { "type": "string", "example": "imap.example.org" }, "outbound": { "type": "string", "example": "smtp.example.org" }, "spamfilter": { "type": "boolean" }, "srs": { "type": "boolean" }, "webmail": { "type": "string", "description": "URL to webmail (if configured at _Servers_ -> _Mail_ -> _Dovecot_)", "example": "https:\/\/webmail.example.org" } } } } } ] } }, "description": "mailbox details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Mailboxes" ], "summary": "Remove a Mailbox", "parameters": [ { "name": "address", "in": "path", "description": "the address or id of the mailbox", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Mailboxes" ], "summary": "Edit a mailbox", "description": "This method edits a mailbox.", "parameters": [ { "name": "address", "in": "path", "description": "e-mail address or encoded id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Mailbox data to be modified", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Mailbox id", "readOnly": true, "example": "bIAzOg" }, "account": { "type": "string", "description": "Account name", "readOnly": true, "example": "web1" }, "status": { "enum": [ "creating", "ok", "updating", "error", "deleting" ], "type": "string", "description": "Current configuration status of this mailbox", "readOnly": true }, "lastConfigChange": { "type": "string", "description": "Timestamp when the mailbox was last updated on the server", "format": "date-time", "readOnly": true, "example": "2020-07-21T17:32:28Z" }, "name": { "type": "string", "description": "Name part of e-mail address", "example": "info" }, "domain": { "type": "string", "description": "Domain part of e-mail address -> set `null` to park the mailbox without domain", "nullable": true, "example": "example.org" }, "description": { "type": "string", "description": "User-defined mailbox description", "example": "Example address for documentation" }, "mailbox": { "type": "boolean", "description": "`true` for IMAP\/POP3 mailbox, `false` when only forwarding emails" }, "password": { "type": "string", "description": "Password for the IMAP\/POP3 mailbox (required on `POST` when mailbox == `true`)", "writeOnly": true, "example": "$u\u00df\u20acs3cre7" }, "quotaSize": { "type": "integer", "description": "Maximum mailbox size (MiB)", "example": 100 }, "io": { "type": "integer", "description": "Number of e-mails sent and received within the last 24 hours", "readOnly": true, "example": 42 }, "size": { "type": "integer", "description": "Size of all e-mails in this mailbox (MiB)", "example": 2 }, "count": { "type": "integer", "description": "Number of (all) e-mails in this mailbox", "example": 4321 }, "statTs": { "type": "string", "description": "Timestamp when `size` and `count` where calculated", "format": "date-time", "example": "2022-11-21T17:32:28Z" }, "autoConfig": { "enum": [ "imap-pop3", "pop3-imap", "imap-only", "pop3-only", "disabled" ], "type": "string", "description": "AutoConfiguration\/Autodiscover setting", "example": "imap-pop3" }, "selfService": { "type": "boolean", "description": "Allow user to log in to LiveConfig and edit its mailbox settings" }, "purgeTrash": { "type": "integer", "description": "Days after which emails should be purged from the trash folder (0 to disable)", "example": 30, "min": 0, "max": 365 }, "greylisting": { "type": "boolean", "description": "Greylisting enabled" }, "spamfilter": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Spam filter (content scanner) enabled" }, "warnThreshold": { "maximum": 999.99, "minimum": 0, "type": "number", "description": "Threshold for tagging messages as possible spam", "format": "float" }, "rejectThreshold": { "maximum": 999.99, "minimum": 0, "type": "number", "description": "Threshold for rejecting messages as spam", "format": "float" }, "allowList": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "Array of e-mail addresses to _not_ check by spam filter", "examle": [ "info@example.org", "nospam@example.org" ] }, "denyList": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "Array of e-mail addresses to reject by spam filter", "example": [ "spam@example.org" ] } } }, "autoreply": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Autoresponder enabled" }, "subject": { "maxLength": 128, "type": "string", "description": "Subject of the autoresponder email (placeholder `${subject}` will be replaced with original subject)", "example": "Out of Office: Re: ${subject}" }, "text": { "maxLength": 4096, "type": "string", "description": "text of the autoresponder email", "example": "Hi, \n i'm not in the office. please try again later this week." }, "end": { "type": "string", "description": "Date where the autoresponder will be automatically disabled (if `null` autoreply is not disabled automatically)", "format": "date-time", "nullable": true, "example": "2023-01-03T23:59:59Z" } } }, "forward": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "list of email addresses where incoming emails are forwarded to", "example": [ "test@example.org", "test2@example.org" ] }, "enabled": { "type": "boolean", "description": "Mail forwarding enabled" }, "srs": { "type": "boolean", "description": "apply SRS (sender rewriting scheme) when forwarding e-mails (needs to be installed & enabled for the mail server)", "example": true } } }, "bccInbound": { "type": "string", "description": "E-Mail address to send a copy of all incoming e-mails to (only if supported by mail server)", "format": "email", "example": "archiving@example.org" }, "bccOutbound": { "type": "string", "description": "E-Mail address to send a copy of all outbound e-mails to (only if supported by mail server)", "format": "email", "example": "archiving@example.org" }, "aliases": { "type": "array", "items": { "type": "string" }, "description": "list of names used as aliases for this email (local part only)", "example": [ "sales", "accounting" ] }, "limit": { "type": "object", "properties": { "perHour": { "type": "integer", "description": "amount of emails allowed for this account per hour (only set if differing from account or template) (if `null` use the value from account or template)", "nullable": true, "example": 100 }, "blocked": { "type": "boolean", "description": "shows if this mailbox is currently blocked from sending because of offending the limit", "readOnly": true, "example": true }, "lastBlocked": { "type": "string", "description": "Timestamp of when this mailbox was last blocked from sending emails", "format": "datetime", "readOnly": true }, "blockedCount": { "type": "integer", "description": "count of blocked emails during the time the last blocking period", "readOnly": true, "example": 181982 } } } } } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/newsfeed": { "get": { "tags": [ "News" ], "summary": "Get list of all newsfeeds", "description": "This method returns a list of all newsfeeds", "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "unique name of the newsfeed", "example": "liveconfig" }, "enabled": { "type": "boolean", "description": "if false all news of this newsfeed are hidden and no refresh is done", "example": true }, "url": { "type": "string", "description": "The url where the newsfeed gets loaded from. For basic authentication add username and password to url, like e.g. https:\/\/username:password@my.liveconfig.com\/newsfeed", "format": "uri", "example": "https:\/\/my.liveconfig.com\/newsfeed" }, "refreshInterval": { "type": "integer", "description": "refresh interval in seconds", "example": 3600, "min": 900 }, "lastUpdate": { "type": "string", "description": "timestamp of the last successful refresh", "format": "date-time", "readOnly": true }, "lastError": { "type": "string", "description": "timestamp of the last refresh error", "format": "date-time", "readOnly": true }, "lastErrorMsg": { "type": "string", "description": "error message of the last refresh error", "readOnly": true, "example": "404 Not Found" } } }, { "required": [ "name", "enabled", "url", "refreshInterval" ], "type": "object" } ] } } }, "description": "a list of all newsfeeds" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "News" ], "summary": "Add new newsfeed", "description": "This method adds a new newsfeed.", "requestBody": { "description": "Data of new newsfeed", "content": { "application\/json": { "schema": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "unique name of the newsfeed", "example": "liveconfig" }, "enabled": { "type": "boolean", "description": "if false all news of this newsfeed are hidden and no refresh is done", "example": true }, "url": { "type": "string", "description": "The url where the newsfeed gets loaded from. For basic authentication add username and password to url, like e.g. https:\/\/username:password@my.liveconfig.com\/newsfeed", "format": "uri", "example": "https:\/\/my.liveconfig.com\/newsfeed" }, "refreshInterval": { "type": "integer", "description": "refresh interval in seconds", "example": 3600, "min": 900 }, "lastUpdate": { "type": "string", "description": "timestamp of the last successful refresh", "format": "date-time", "readOnly": true }, "lastError": { "type": "string", "description": "timestamp of the last refresh error", "format": "date-time", "readOnly": true }, "lastErrorMsg": { "type": "string", "description": "error message of the last refresh error", "readOnly": true, "example": "404 Not Found" } } }, { "required": [ "name", "enabled", "url", "refreshInterval" ], "type": "object" } ] } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/newsfeed\/{name}": { "get": { "tags": [ "News" ], "summary": "Get newsfeed details", "description": "This method returns the details of a newsfeed", "parameters": [ { "name": "name", "in": "path", "description": "name of the requested newsfeed", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "unique name of the newsfeed", "example": "liveconfig" }, "enabled": { "type": "boolean", "description": "if false all news of this newsfeed are hidden and no refresh is done", "example": true }, "url": { "type": "string", "description": "The url where the newsfeed gets loaded from. For basic authentication add username and password to url, like e.g. https:\/\/username:password@my.liveconfig.com\/newsfeed", "format": "uri", "example": "https:\/\/my.liveconfig.com\/newsfeed" }, "refreshInterval": { "type": "integer", "description": "refresh interval in seconds", "example": 3600, "min": 900 }, "lastUpdate": { "type": "string", "description": "timestamp of the last successful refresh", "format": "date-time", "readOnly": true }, "lastError": { "type": "string", "description": "timestamp of the last refresh error", "format": "date-time", "readOnly": true }, "lastErrorMsg": { "type": "string", "description": "error message of the last refresh error", "readOnly": true, "example": "404 Not Found" } } }, { "required": [ "name", "enabled", "url", "refreshInterval" ], "type": "object" } ] } }, "description": "newsfeed details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "News" ], "summary": "Remove a newsfeed", "parameters": [ { "name": "name", "in": "path", "description": "the name of the newsfeed", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "News" ], "summary": "Edit a newsfeed", "description": "This method edits a newsfeed.", "parameters": [ { "name": "name", "in": "path", "description": "name of the newsfeed", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Newsfeed data to be modified", "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "unique name of the newsfeed", "example": "liveconfig" }, "enabled": { "type": "boolean", "description": "if false all news of this newsfeed are hidden and no refresh is done", "example": true }, "url": { "type": "string", "description": "The url where the newsfeed gets loaded from. For basic authentication add username and password to url, like e.g. https:\/\/username:password@my.liveconfig.com\/newsfeed", "format": "uri", "example": "https:\/\/my.liveconfig.com\/newsfeed" }, "refreshInterval": { "type": "integer", "description": "refresh interval in seconds", "example": 3600, "min": 900 }, "lastUpdate": { "type": "string", "description": "timestamp of the last successful refresh", "format": "date-time", "readOnly": true }, "lastError": { "type": "string", "description": "timestamp of the last refresh error", "format": "date-time", "readOnly": true }, "lastErrorMsg": { "type": "string", "description": "error message of the last refresh error", "readOnly": true, "example": "404 Not Found" } } } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/news": { "get": { "tags": [ "News" ], "summary": "Get list of all news for the session user", "description": "This method returns a list of all news for the session user", "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Encoded id for the entry", "example": null }, "confirmable": { "type": "boolean", "description": "ture if this news item can be confirmed", "example": true }, "severity": { "enum": [ "info", "warn", "critical" ], "type": "string", "description": "severity of the news" }, "type": { "enum": [ "news", "popup", "both" ], "type": "string", "description": "should this item only be displayed in the `news`-list or should it be displayed as `popup` or `both`" }, "title": { "type": "string", "description": "title of the news item", "example": "Hello World" }, "text": { "type": "string", "description": "text of the news item", "example": "this is the first news item we publish" } } } } }, "description": "a list of all news for the session user" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/news\/{id}": { "patch": { "tags": [ "News" ], "summary": "Confirm a news item as seen", "description": "This method confirms a news item as seen", "parameters": [ { "name": "id", "in": "path", "description": "Encoded id of the news item", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/panel": { "get": { "tags": [ "LiveConfig" ], "summary": "Get panel information", "description": "Return information on running LiveConfig instance. Output depends on permissions (version, license and database information is only returned to admin users)", "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "commit": { "type": "string", "description": "Commit hash", "example": "9a8b7c6d" }, "date": { "type": "string", "description": "Commit date", "format": "date", "example": "2021-11-09" }, "database": { "type": "string", "description": "Backend database (usually `SQLite` or `MySQL`)", "example": "SQLite" }, "maintenance": { "type": "boolean", "description": "Is `true` if running in maintenance mode (only admin users may log in)", "example": false }, "build": { "type": "string", "description": "Build ID", "example": "9876" }, "version": { "type": "string", "description": "Version string", "example": "3.0.0" }, "versionAvailable": { "type": "string", "description": "Latest available LiveConfig version", "example": "3.0.0" }, "versionChecked": { "type": "string", "description": "Timestamp of last update check", "format": "date-time", "example": "2021-11-09T11:22:33Z" }, "license": { "type": "object", "properties": { "demo": { "type": "boolean", "description": "Whether LiveConfig runs in demo mode", "example": false }, "edition": { "type": "string", "description": "License edition", "example": "Standard" }, "id": { "type": "integer", "description": "Serial number", "example": 12345678 } } }, "sendCrashInfo": { "type": "boolean", "description": "Is `true` if LiveConfig may send diagnostic data after a crash", "example": false }, "sendServerInfo": { "type": "boolean", "description": "Is `true` if LiveConfig may send statistical (non-personalized) data on server versions", "example": false } }, "description": "Panel information", "required": null } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "LiveConfig" ], "summary": "Modify control panel settings", "requestBody": { "description": "Settings to modify", "content": { "application\/json": { "schema": { "type": "object", "properties": { "maintenance": { "type": "boolean", "description": "Enable\/disable maintenance mode (login only allowed for admin users)", "example": true }, "sendCrashInfo": { "type": "boolean", "description": "Allow\/disallow sending of crash reports", "example": true }, "sendServerInfo": { "type": "boolean", "description": "Allow\/disallow sending of statistical data on server versions", "example": true } } } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/panel\/extensions": { "get": { "tags": [ "LiveConfig" ], "summary": "Get list of available extensions", "description": "Return list of available extensions.", "parameters": [ { "name": "type", "in": "query", "description": "requested extension type", "schema": { "enum": [ "sitebuilder" ], "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object", "properties": { "activeConfigs": { "type": "integer", "description": "if `multiCfg == true` this shows the number of configurations in use for this extension", "readOnly": true, "example": 2 }, "description": { "type": "string", "description": "Description of the extension", "readOnly": true, "example": "This is a site builder extension to easily create websites" }, "enabled": { "type": "boolean", "description": "Flag if this extension is enabled", "readOnly": true, "example": true }, "logo": { "type": "string", "description": "Logo for this extension (light mode)", "readOnly": true, "example": "extension.png" }, "logoDark": { "type": "string", "description": "Logo for this extension (dark mode)", "readOnly": true, "example": "extension-dark.png" }, "multiCfg": { "type": "boolean", "description": "if `true` this extension supports more than one global configuration (i.e. multiple licenses or per server configuration)", "readOnly": true, "example": true }, "name": { "type": "string", "description": "Unique name for the extension", "readOnly": true, "example": "megaExtension" }, "type": { "enum": [ "sitebuilder" ], "type": "string", "description": "type of the extension", "readOnly": true, "example": "sitebuilder" }, "vendorUrl": { "type": "string", "description": "URL to the extension vendor", "format": "uri", "readOnly": true, "example": "https:\/\/example.org\/megaExtension" }, "version": { "type": "string", "description": "Version of the extension", "format": "version", "readOnly": true, "example": "1.2.3" } } } } }, "description": "List of all available extensions" } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/panel\/extensions\/{name}": { "get": { "tags": [ "LiveConfig" ], "summary": "Get extensions details", "description": "Return details of selected extension", "parameters": [ { "name": "name", "in": "path", "description": "extension name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "allOf": [ { "type": "object", "properties": { "activeConfigs": { "type": "integer", "description": "if `multiCfg == true` this shows the number of configurations in use for this extension", "readOnly": true, "example": 2 }, "description": { "type": "string", "description": "Description of the extension", "readOnly": true, "example": "This is a site builder extension to easily create websites" }, "enabled": { "type": "boolean", "description": "Flag if this extension is enabled", "readOnly": true, "example": true }, "logo": { "type": "string", "description": "Logo for this extension (light mode)", "readOnly": true, "example": "extension.png" }, "logoDark": { "type": "string", "description": "Logo for this extension (dark mode)", "readOnly": true, "example": "extension-dark.png" }, "multiCfg": { "type": "boolean", "description": "if `true` this extension supports more than one global configuration (i.e. multiple licenses or per server configuration)", "readOnly": true, "example": true }, "name": { "type": "string", "description": "Unique name for the extension", "readOnly": true, "example": "megaExtension" }, "type": { "enum": [ "sitebuilder" ], "type": "string", "description": "type of the extension", "readOnly": true, "example": "sitebuilder" }, "vendorUrl": { "type": "string", "description": "URL to the extension vendor", "format": "uri", "readOnly": true, "example": "https:\/\/example.org\/megaExtension" }, "version": { "type": "string", "description": "Version of the extension", "format": "version", "readOnly": true, "example": "1.2.3" } } }, { "type": "object", "properties": { "configs": { "type": "array", "items": { "type": "string", "description": "name of configuration" }, "description": "list of active configurations on this extension", "readOnly": true }, "globalCfgRules": { "type": "array", "items": { "type": "object", "description": "rule to describe config element required by an extension" }, "description": "List of configuration rules used by LiveConfig for the generation of GUI inputs for the global configuration", "readOnly": true }, "objectCfgRules": { "type": "array", "items": { "type": "object", "description": "rule to describe config element required by an extension" }, "description": "List of configuration rules used by LiveConfig for the generation of GUI inputs for per-object configuration (i.e. per website for `type == sitebuilder`)", "readOnly": true } } } ] } }, "description": "details of selected extension" } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "LiveConfig" ], "summary": "Add extension config", "description": "Add new configuration for extension", "parameters": [ { "name": "name", "in": "path", "description": "extension name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configuration data", "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "identifier for the new configuration", "example": "ws1-config" }, "config": { "type": "object", "description": "key\/value pairs derived from the globalCfgRules from extension object", "example": { "apiurl": "https:\/\/api.example.org", "apikey": "sup\u20acr$ecure", "product": "testpackage" }, "additionalProperties": { "type": "string" } } } } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true } } } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/panel\/extension\/{name}\/{cfg}": { "get": { "tags": [ "LiveConfig" ], "summary": "Get global extensions config", "description": "Return global configuration values of extension", "parameters": [ { "name": "name", "in": "path", "description": "extension name", "required": true, "schema": { "type": "string" } }, { "name": "cfg", "in": "path", "description": "config name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "description": "key\/value pairs of configuration values", "additionalProperties": { "type": "string" } } }, "description": "configuration values of selected extension" } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "LiveConfig" ], "summary": "Remove a extension configuration", "parameters": [ { "name": "name", "in": "path", "description": "the name of the extension", "required": true, "schema": { "type": "string" } }, { "name": "cfg", "in": "path", "description": "the name of the configuration", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "LiveConfig" ], "summary": "Update extension config", "description": "update existing configuration for extension", "parameters": [ { "name": "name", "in": "path", "description": "extension name", "required": true, "schema": { "type": "string" } }, { "name": "cfg", "in": "path", "description": "config name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configuration data to modify", "content": { "application\/json": { "schema": { "type": "object", "description": "key value pairs derived from the globalCfgRules from extension object", "example": { "apiurl": "https:\/\/api.example.org", "apikey": "sup\u20acr$ecure", "product": "testpackage" }, "additionalProperties": { "type": "string" } } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/panel\/mail\/settings": { "get": { "tags": [ "LiveConfig" ], "summary": "Get panel e-mail settings", "description": "Return settings for sending e-mails by LiveConfig.", "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "required": [ "success" ], "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "address": { "maxLength": 128, "type": "string", "description": "Sender address", "example": "support@example.org" }, "footer": { "maxLength": 4096, "type": "string", "description": "E-Mail footer (signature)", "example": "ACME Inc. - visit us at https:\/\/example.org\/" }, "name": { "maxLength": 128, "type": "string", "description": "Sender name", "example": "ACME Inc. Support" }, "method": { "enum": [ "smtp", "sendmail" ], "type": "string", "description": "send method", "example": "smtp" }, "smtp": { "type": "object", "properties": { "server": { "maxLength": 128, "type": "string", "description": "SMTP server name", "example": "smtp.example.org" }, "login": { "maxLength": 128, "type": "string", "description": "SMTP server login (e-mail username)", "example": "support@example.org" }, "password": { "maxLength": 128, "type": "string", "description": "SMTP password", "writeOnly": true }, "port": { "maximum": 65535, "minimum": 1, "type": "number", "description": "SMTP port (only required for non-default port)", "example": 587 }, "encryption": { "enum": [ "starttls", "smtps", "none" ], "type": "string", "description": "SMTP connection encryption", "example": "starttls" } } } } } }, "description": "E-Mail settings" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "LiveConfig" ], "summary": "Modify control panel e-mail settings", "description": "Modify settings for sending e-mails by LiveConfig.", "requestBody": { "description": "Settings to modify", "content": { "application\/json": { "schema": { "type": "object", "properties": { "address": { "maxLength": 128, "type": "string", "description": "Sender address", "example": "support@example.org" }, "footer": { "maxLength": 4096, "type": "string", "description": "E-Mail footer (signature)", "example": "ACME Inc. - visit us at https:\/\/example.org\/" }, "name": { "maxLength": 128, "type": "string", "description": "Sender name", "example": "ACME Inc. Support" }, "method": { "enum": [ "smtp", "sendmail" ], "type": "string", "description": "send method", "example": "smtp" }, "smtp": { "type": "object", "properties": { "server": { "maxLength": 128, "type": "string", "description": "SMTP server name", "example": "smtp.example.org" }, "login": { "maxLength": 128, "type": "string", "description": "SMTP server login (e-mail username)", "example": "support@example.org" }, "password": { "maxLength": 128, "type": "string", "description": "SMTP password", "writeOnly": true }, "port": { "maximum": 65535, "minimum": 1, "type": "number", "description": "SMTP port (only required for non-default port)", "example": 587 }, "encryption": { "enum": [ "starttls", "smtps", "none" ], "type": "string", "description": "SMTP connection encryption", "example": "starttls" } } } } } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/panel\/mail\/templates": { "get": { "tags": [ "LiveConfig" ], "summary": "Get list of available e-mail templates", "description": "Return list of e-mail templates for mails sent by LiveConfig", "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Template identifier", "example": "PWDRECOVER" }, "name": { "type": "string", "description": "Template name", "example": "Recover password" }, "description": { "type": "string", "description": "Description when this template is used", "example": "This mail is sent when a user requests a new password at the login page." } } } } }, "description": "E-Mail templates" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/panel\/mail\/templates\/{id}\/{language}": { "get": { "tags": [ "LiveConfig" ], "summary": "Get e-mail template details", "description": "Return e-mail template data", "parameters": [ { "name": "id", "in": "path", "description": "Template id", "required": true, "schema": { "type": "string" }, "example": "PWDRECOVER" }, { "name": "language", "in": "path", "description": "Language (translation) of the template", "required": true, "schema": { "type": "string" }, "example": "de" } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "required": [ "default" ], "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Is 'true' if the custom message is enabled", "example": true }, "message": { "maxLength": 8192, "type": "string", "description": "Custom message", "example": "Hello, follow this link to set a new password ..." }, "subject": { "maxLength": 255, "type": "string", "description": "Custom subject", "example": "Set a new password" }, "default": { "type": "object", "properties": { "message": { "type": "string", "description": "Default message", "readOnly": true, "example": "Dear customer, ..." }, "subject": { "type": "string", "description": "Default subject", "readOnly": true, "example": "Reset password" } }, "readOnly": true } } } }, "description": "E-Mail template" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "LiveConfig" ], "summary": "Modify e-mail template", "description": "Modify e-mail template", "parameters": [ { "name": "id", "in": "path", "description": "Template id", "required": true, "schema": { "type": "string" }, "example": "PWDRECOVER" }, { "name": "language", "in": "path", "description": "Language (translation) of the template", "required": true, "schema": { "type": "string" }, "example": "de" } ], "requestBody": { "description": "Settings to modify", "content": { "application\/json": { "schema": { "required": [ "default" ], "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Is 'true' if the custom message is enabled", "example": true }, "message": { "maxLength": 8192, "type": "string", "description": "Custom message", "example": "Hello, follow this link to set a new password ..." }, "subject": { "maxLength": 255, "type": "string", "description": "Custom subject", "example": "Set a new password" }, "default": { "type": "object", "properties": { "message": { "type": "string", "description": "Default message", "readOnly": true, "example": "Dear customer, ..." }, "subject": { "type": "string", "description": "Default subject", "readOnly": true, "example": "Reset password" } }, "readOnly": true } } } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/panel\/sbom": { "get": { "tags": [ "LiveConfig" ], "summary": "Get SBOM (Software Bill of Materials)", "description": "Return SBOM for LiveConfig frontend or backend. This feature requires a Business license.", "parameters": [ { "name": "show", "in": "query", "description": "requested SBOM (default: `backend`)", "schema": { "enum": [ "frontend", "backend" ], "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/vnd.cyclonedx+json": { "schema": { "type": "object", "description": "SBOM in CycloneDX format (1.5 or 1.6)" } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/php-settings": { "get": { "tags": [ "PHP-Settings" ], "summary": "Get list of all PHP Settings Templates", "description": "This method returns a list of all PHP Settings Templates", "parameters": [ { "name": "count", "in": "query", "description": "number of results to return", "schema": { "minimum": 1, "type": "integer" } }, { "name": "page", "in": "query", "description": "page to return (offset), starting with `1`", "schema": { "minimum": 1, "type": "integer" } }, { "name": "show", "in": "query", "description": "comma-separated list of additional data to show (`settings`: show list of php settings in this template)\n", "style": "form", "explode": false, "schema": { "type": "array", "items": { "enum": [ "settings" ], "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 1 }, "data": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "name of the template", "example": "mini-cms-settings", "required": true }, "isApplied": { "type": "boolean", "description": "flag if this templates settings are already applied to vhost configurations", "readOnly": true, "example": false, "required": true }, "lastModified": { "type": "string", "description": "timestamp of last change of this template or its settings", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z", "required": false }, "lastApplied": { "type": "string", "description": "timestamp of when the settings were last applied to vhost configurations", "format": "datetime", "readOnly": true, "example": "2020-07-21T17:32:28Z", "required": false }, "settings": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "string", "boolean", "integer", "expression", "extension", "zend_extension" ], "type": "string", "description": "type of the settings value", "example": "boolean", "required": true }, "name": { "type": "string", "description": "name of the setting. for php ini sections write `
.`", "example": "memory_limit", "required": true }, "value": { "type": "string", "description": "value of the setting. the Placeholders '%HOME%', '%PHP%' and '%USER%' will be replaced accordingly.", "example": "32", "required": true }, "modifiableBy": { "enum": [ "none", "account", "user" ], "type": "string", "description": "who can change the value: `none` nobody the value set here is fixed; `account`: the admin\/reseller can change the value per account; `user`: the user can chane the value itself", "example": "none", "required": true }, "unit": { "enum": [ "kilo", "mega", "giga", "" ], "type": "string", "description": "for type `integer` there may be a unit qualification needed (example for memory_limit: 64M)", "example": "mega", "required": false }, "minVersion": { "type": "string", "description": "the minimum version number (including (>=)) for which this setting is used for (`null` if applied to all)", "format": "version number", "nullable": true, "example": "7.4.0", "required": false }, "maxVersion": { "type": "string", "description": "the maximum version number (excluding (<)) for which this setting is used for (`null` if applied to all)", "format": "version number", "nullable": true, "example": "7.4.0", "required": false }, "enabled": { "type": "boolean", "description": "if type is `extension` or `zend_extension` this is required and specifies if the extension is enabled by default", "example": false, "required": false }, "order": { "type": "integer", "description": "if type is `extension` or `zend_extension` this is required and specifies the load order of the extensions", "example": 2, "required": false }, "min": { "type": "integer", "description": "if type is `integer` and `modifiableBy` is set to anything other than `none` this is required and specifies the minimum possible value set in the account or by the user", "example": 10, "required": false }, "max": { "type": "integer", "description": "if type is `integer` and `modifiableBy` is set to anything other than `none` this is required and specifies the maximum possible value set in the account or by the user", "example": 64, "required": false }, "isDefault": { "type": "boolean", "description": "if setting is returned in a list for a php template this signals if the setting comes from said template or from the default template", "example": false, "required": false } }, "description": "PHP setting" }, "description": "list of settings if enabled by `show` parameter", "readOnly": true } } } } }, "description": "a list of all php settings templates" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "PHP-Settings" ], "summary": "Add new PHP Settings Template", "description": "This method adds a new PHP Settings Template.", "requestBody": { "description": "Data of new PHP Settings Template", "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "name of the template", "example": "mini-cms-settings", "required": true }, "isApplied": { "type": "boolean", "description": "flag if this templates settings are already applied to vhost configurations", "readOnly": true, "example": false, "required": true }, "lastModified": { "type": "string", "description": "timestamp of last change of this template or its settings", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z", "required": false }, "lastApplied": { "type": "string", "description": "timestamp of when the settings were last applied to vhost configurations", "format": "datetime", "readOnly": true, "example": "2020-07-21T17:32:28Z", "required": false }, "settings": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "string", "boolean", "integer", "expression", "extension", "zend_extension" ], "type": "string", "description": "type of the settings value", "example": "boolean", "required": true }, "name": { "type": "string", "description": "name of the setting. for php ini sections write `
.`", "example": "memory_limit", "required": true }, "value": { "type": "string", "description": "value of the setting. the Placeholders '%HOME%', '%PHP%' and '%USER%' will be replaced accordingly.", "example": "32", "required": true }, "modifiableBy": { "enum": [ "none", "account", "user" ], "type": "string", "description": "who can change the value: `none` nobody the value set here is fixed; `account`: the admin\/reseller can change the value per account; `user`: the user can chane the value itself", "example": "none", "required": true }, "unit": { "enum": [ "kilo", "mega", "giga", "" ], "type": "string", "description": "for type `integer` there may be a unit qualification needed (example for memory_limit: 64M)", "example": "mega", "required": false }, "minVersion": { "type": "string", "description": "the minimum version number (including (>=)) for which this setting is used for (`null` if applied to all)", "format": "version number", "nullable": true, "example": "7.4.0", "required": false }, "maxVersion": { "type": "string", "description": "the maximum version number (excluding (<)) for which this setting is used for (`null` if applied to all)", "format": "version number", "nullable": true, "example": "7.4.0", "required": false }, "enabled": { "type": "boolean", "description": "if type is `extension` or `zend_extension` this is required and specifies if the extension is enabled by default", "example": false, "required": false }, "order": { "type": "integer", "description": "if type is `extension` or `zend_extension` this is required and specifies the load order of the extensions", "example": 2, "required": false }, "min": { "type": "integer", "description": "if type is `integer` and `modifiableBy` is set to anything other than `none` this is required and specifies the minimum possible value set in the account or by the user", "example": 10, "required": false }, "max": { "type": "integer", "description": "if type is `integer` and `modifiableBy` is set to anything other than `none` this is required and specifies the maximum possible value set in the account or by the user", "example": 64, "required": false }, "isDefault": { "type": "boolean", "description": "if setting is returned in a list for a php template this signals if the setting comes from said template or from the default template", "example": false, "required": false } }, "description": "PHP setting" }, "description": "list of settings if enabled by `show` parameter", "readOnly": true } } } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/php-settings\/{template}": { "get": { "tags": [ "PHP-Settings" ], "summary": "Get PHP settings template details", "description": "This method returns all details of a PHP settings template", "parameters": [ { "name": "template", "in": "path", "description": "name of the template", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "name": { "type": "string", "description": "name of the template", "example": "mini-cms-settings", "required": true }, "isApplied": { "type": "boolean", "description": "flag if this templates settings are already applied to vhost configurations", "readOnly": true, "example": false, "required": true }, "lastModified": { "type": "string", "description": "timestamp of last change of this template or its settings", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z", "required": false }, "lastApplied": { "type": "string", "description": "timestamp of when the settings were last applied to vhost configurations", "format": "datetime", "readOnly": true, "example": "2020-07-21T17:32:28Z", "required": false }, "settings": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "string", "boolean", "integer", "expression", "extension", "zend_extension" ], "type": "string", "description": "type of the settings value", "example": "boolean", "required": true }, "name": { "type": "string", "description": "name of the setting. for php ini sections write `
.`", "example": "memory_limit", "required": true }, "value": { "type": "string", "description": "value of the setting. the Placeholders '%HOME%', '%PHP%' and '%USER%' will be replaced accordingly.", "example": "32", "required": true }, "modifiableBy": { "enum": [ "none", "account", "user" ], "type": "string", "description": "who can change the value: `none` nobody the value set here is fixed; `account`: the admin\/reseller can change the value per account; `user`: the user can chane the value itself", "example": "none", "required": true }, "unit": { "enum": [ "kilo", "mega", "giga", "" ], "type": "string", "description": "for type `integer` there may be a unit qualification needed (example for memory_limit: 64M)", "example": "mega", "required": false }, "minVersion": { "type": "string", "description": "the minimum version number (including (>=)) for which this setting is used for (`null` if applied to all)", "format": "version number", "nullable": true, "example": "7.4.0", "required": false }, "maxVersion": { "type": "string", "description": "the maximum version number (excluding (<)) for which this setting is used for (`null` if applied to all)", "format": "version number", "nullable": true, "example": "7.4.0", "required": false }, "enabled": { "type": "boolean", "description": "if type is `extension` or `zend_extension` this is required and specifies if the extension is enabled by default", "example": false, "required": false }, "order": { "type": "integer", "description": "if type is `extension` or `zend_extension` this is required and specifies the load order of the extensions", "example": 2, "required": false }, "min": { "type": "integer", "description": "if type is `integer` and `modifiableBy` is set to anything other than `none` this is required and specifies the minimum possible value set in the account or by the user", "example": 10, "required": false }, "max": { "type": "integer", "description": "if type is `integer` and `modifiableBy` is set to anything other than `none` this is required and specifies the maximum possible value set in the account or by the user", "example": 64, "required": false }, "isDefault": { "type": "boolean", "description": "if setting is returned in a list for a php template this signals if the setting comes from said template or from the default template", "example": false, "required": false } }, "description": "PHP setting" }, "description": "list of settings if enabled by `show` parameter", "readOnly": true } } } }, "description": "php settings template details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "PHP-Settings" ], "summary": "Add new PHP Setting", "description": "This method adds a new PHP Settings to the given template.", "parameters": [ { "name": "template", "in": "path", "description": "name of the template", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Data of new PHP Settings Template", "content": { "application\/json": { "schema": { "type": "object", "properties": { "type": { "enum": [ "string", "boolean", "integer", "expression", "extension", "zend_extension" ], "type": "string", "description": "type of the settings value", "example": "boolean", "required": true }, "name": { "type": "string", "description": "name of the setting. for php ini sections write `
.`", "example": "memory_limit", "required": true }, "value": { "type": "string", "description": "value of the setting. the Placeholders '%HOME%', '%PHP%' and '%USER%' will be replaced accordingly.", "example": "32", "required": true }, "modifiableBy": { "enum": [ "none", "account", "user" ], "type": "string", "description": "who can change the value: `none` nobody the value set here is fixed; `account`: the admin\/reseller can change the value per account; `user`: the user can chane the value itself", "example": "none", "required": true }, "unit": { "enum": [ "kilo", "mega", "giga", "" ], "type": "string", "description": "for type `integer` there may be a unit qualification needed (example for memory_limit: 64M)", "example": "mega", "required": false }, "minVersion": { "type": "string", "description": "the minimum version number (including (>=)) for which this setting is used for (`null` if applied to all)", "format": "version number", "nullable": true, "example": "7.4.0", "required": false }, "maxVersion": { "type": "string", "description": "the maximum version number (excluding (<)) for which this setting is used for (`null` if applied to all)", "format": "version number", "nullable": true, "example": "7.4.0", "required": false }, "enabled": { "type": "boolean", "description": "if type is `extension` or `zend_extension` this is required and specifies if the extension is enabled by default", "example": false, "required": false }, "order": { "type": "integer", "description": "if type is `extension` or `zend_extension` this is required and specifies the load order of the extensions", "example": 2, "required": false }, "min": { "type": "integer", "description": "if type is `integer` and `modifiableBy` is set to anything other than `none` this is required and specifies the minimum possible value set in the account or by the user", "example": 10, "required": false }, "max": { "type": "integer", "description": "if type is `integer` and `modifiableBy` is set to anything other than `none` this is required and specifies the maximum possible value set in the account or by the user", "example": 64, "required": false }, "isDefault": { "type": "boolean", "description": "if setting is returned in a list for a php template this signals if the setting comes from said template or from the default template", "example": false, "required": false } }, "description": "PHP setting" } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "PHP-Settings" ], "summary": "Remove a PHP settings template and all its settings", "parameters": [ { "name": "template", "in": "path", "description": "name of the template", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "PHP-Settings" ], "summary": "edit PHP Settings Template", "description": "This method edits a PHP Settings Template.", "parameters": [ { "name": "template", "in": "path", "description": "name of the template", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "PHP Settings Template data to be modified", "content": { "application\/json": { "schema": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "name of the template", "example": "mini-cms-settings", "required": true }, "isApplied": { "type": "boolean", "description": "flag if this templates settings are already applied to vhost configurations", "readOnly": true, "example": false, "required": true }, "lastModified": { "type": "string", "description": "timestamp of last change of this template or its settings", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z", "required": false }, "lastApplied": { "type": "string", "description": "timestamp of when the settings were last applied to vhost configurations", "format": "datetime", "readOnly": true, "example": "2020-07-21T17:32:28Z", "required": false }, "settings": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "string", "boolean", "integer", "expression", "extension", "zend_extension" ], "type": "string", "description": "type of the settings value", "example": "boolean", "required": true }, "name": { "type": "string", "description": "name of the setting. for php ini sections write `
.`", "example": "memory_limit", "required": true }, "value": { "type": "string", "description": "value of the setting. the Placeholders '%HOME%', '%PHP%' and '%USER%' will be replaced accordingly.", "example": "32", "required": true }, "modifiableBy": { "enum": [ "none", "account", "user" ], "type": "string", "description": "who can change the value: `none` nobody the value set here is fixed; `account`: the admin\/reseller can change the value per account; `user`: the user can chane the value itself", "example": "none", "required": true }, "unit": { "enum": [ "kilo", "mega", "giga", "" ], "type": "string", "description": "for type `integer` there may be a unit qualification needed (example for memory_limit: 64M)", "example": "mega", "required": false }, "minVersion": { "type": "string", "description": "the minimum version number (including (>=)) for which this setting is used for (`null` if applied to all)", "format": "version number", "nullable": true, "example": "7.4.0", "required": false }, "maxVersion": { "type": "string", "description": "the maximum version number (excluding (<)) for which this setting is used for (`null` if applied to all)", "format": "version number", "nullable": true, "example": "7.4.0", "required": false }, "enabled": { "type": "boolean", "description": "if type is `extension` or `zend_extension` this is required and specifies if the extension is enabled by default", "example": false, "required": false }, "order": { "type": "integer", "description": "if type is `extension` or `zend_extension` this is required and specifies the load order of the extensions", "example": 2, "required": false }, "min": { "type": "integer", "description": "if type is `integer` and `modifiableBy` is set to anything other than `none` this is required and specifies the minimum possible value set in the account or by the user", "example": 10, "required": false }, "max": { "type": "integer", "description": "if type is `integer` and `modifiableBy` is set to anything other than `none` this is required and specifies the maximum possible value set in the account or by the user", "example": 64, "required": false }, "isDefault": { "type": "boolean", "description": "if setting is returned in a list for a php template this signals if the setting comes from said template or from the default template", "example": false, "required": false } }, "description": "PHP setting" }, "description": "list of settings if enabled by `show` parameter", "readOnly": true } } }, { "type": "object", "properties": { "apply": { "type": "boolean", "description": "flag to apply the PHP settings template to the vhost config", "example": true, "required": false } } } ] } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/php-settings\/{template}\/{name}\/{vmin}\/{vmax}": { "get": { "tags": [ "PHP-Settings" ], "summary": "Get PHP settings template details", "description": "This method returns a PHP setting.", "parameters": [ { "name": "template", "in": "path", "description": "name of the template", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "name of the setting", "required": true, "schema": { "type": "string" } }, { "name": "vmin", "in": "path", "description": "minimum version (including (>=)) the setting is used for (`-` if none is set)", "required": true, "schema": { "type": "string" } }, { "name": "vmax", "in": "path", "description": "maximum version (excluding (<)) the setting is used for (`-` if none is set)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "type": { "enum": [ "string", "boolean", "integer", "expression", "extension", "zend_extension" ], "type": "string", "description": "type of the settings value", "example": "boolean", "required": true }, "name": { "type": "string", "description": "name of the setting. for php ini sections write `
.`", "example": "memory_limit", "required": true }, "value": { "type": "string", "description": "value of the setting. the Placeholders '%HOME%', '%PHP%' and '%USER%' will be replaced accordingly.", "example": "32", "required": true }, "modifiableBy": { "enum": [ "none", "account", "user" ], "type": "string", "description": "who can change the value: `none` nobody the value set here is fixed; `account`: the admin\/reseller can change the value per account; `user`: the user can chane the value itself", "example": "none", "required": true }, "unit": { "enum": [ "kilo", "mega", "giga", "" ], "type": "string", "description": "for type `integer` there may be a unit qualification needed (example for memory_limit: 64M)", "example": "mega", "required": false }, "minVersion": { "type": "string", "description": "the minimum version number (including (>=)) for which this setting is used for (`null` if applied to all)", "format": "version number", "nullable": true, "example": "7.4.0", "required": false }, "maxVersion": { "type": "string", "description": "the maximum version number (excluding (<)) for which this setting is used for (`null` if applied to all)", "format": "version number", "nullable": true, "example": "7.4.0", "required": false }, "enabled": { "type": "boolean", "description": "if type is `extension` or `zend_extension` this is required and specifies if the extension is enabled by default", "example": false, "required": false }, "order": { "type": "integer", "description": "if type is `extension` or `zend_extension` this is required and specifies the load order of the extensions", "example": 2, "required": false }, "min": { "type": "integer", "description": "if type is `integer` and `modifiableBy` is set to anything other than `none` this is required and specifies the minimum possible value set in the account or by the user", "example": 10, "required": false }, "max": { "type": "integer", "description": "if type is `integer` and `modifiableBy` is set to anything other than `none` this is required and specifies the maximum possible value set in the account or by the user", "example": 64, "required": false }, "isDefault": { "type": "boolean", "description": "if setting is returned in a list for a php template this signals if the setting comes from said template or from the default template", "example": false, "required": false } }, "description": "PHP setting" } }, "description": "php settings template details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "PHP-Settings" ], "summary": "Remove a PHP setting", "parameters": [ { "name": "template", "in": "path", "description": "name of the template", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "name of the setting", "required": true, "schema": { "type": "string" } }, { "name": "vmin", "in": "path", "description": "minimum version (including (>=)) the setting is used for (`-` if none is set)", "required": true, "schema": { "type": "string" } }, { "name": "vmax", "in": "path", "description": "maximum version (excluding (<)) the setting is used for (`-` if none is set)", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "PHP-Settings" ], "summary": "edit PHP Setting", "description": "This method edits a PHP Setting.", "parameters": [ { "name": "template", "in": "path", "description": "name of the template", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "name of the setting", "required": true, "schema": { "type": "string" } }, { "name": "vmin", "in": "path", "description": "minimum version (including (>=)) the setting is used for (`-` if none is set)", "required": true, "schema": { "type": "string" } }, { "name": "vmax", "in": "path", "description": "maximum version (excluding (<)) the setting is used for (`-` if none is set)", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "PHP Settings data to be modified", "content": { "application\/json": { "schema": { "type": "object", "properties": { "type": { "enum": [ "string", "boolean", "integer", "expression", "extension", "zend_extension" ], "type": "string", "description": "type of the settings value", "example": "boolean", "required": true }, "name": { "type": "string", "description": "name of the setting. for php ini sections write `
.`", "example": "memory_limit", "required": true }, "value": { "type": "string", "description": "value of the setting. the Placeholders '%HOME%', '%PHP%' and '%USER%' will be replaced accordingly.", "example": "32", "required": true }, "modifiableBy": { "enum": [ "none", "account", "user" ], "type": "string", "description": "who can change the value: `none` nobody the value set here is fixed; `account`: the admin\/reseller can change the value per account; `user`: the user can chane the value itself", "example": "none", "required": true }, "unit": { "enum": [ "kilo", "mega", "giga", "" ], "type": "string", "description": "for type `integer` there may be a unit qualification needed (example for memory_limit: 64M)", "example": "mega", "required": false }, "minVersion": { "type": "string", "description": "the minimum version number (including (>=)) for which this setting is used for (`null` if applied to all)", "format": "version number", "nullable": true, "example": "7.4.0", "required": false }, "maxVersion": { "type": "string", "description": "the maximum version number (excluding (<)) for which this setting is used for (`null` if applied to all)", "format": "version number", "nullable": true, "example": "7.4.0", "required": false }, "enabled": { "type": "boolean", "description": "if type is `extension` or `zend_extension` this is required and specifies if the extension is enabled by default", "example": false, "required": false }, "order": { "type": "integer", "description": "if type is `extension` or `zend_extension` this is required and specifies the load order of the extensions", "example": 2, "required": false }, "min": { "type": "integer", "description": "if type is `integer` and `modifiableBy` is set to anything other than `none` this is required and specifies the minimum possible value set in the account or by the user", "example": 10, "required": false }, "max": { "type": "integer", "description": "if type is `integer` and `modifiableBy` is set to anything other than `none` this is required and specifies the maximum possible value set in the account or by the user", "example": 64, "required": false }, "isDefault": { "type": "boolean", "description": "if setting is returned in a list for a php template this signals if the setting comes from said template or from the default template", "example": false, "required": false } }, "description": "PHP setting" } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/reports\/all-customers": { "get": { "tags": [ "Reports" ], "summary": "All customers report", "description": "This method returns a list of all customers", "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "required": [ "id", "status", "accounts", "contact" ], "type": "object", "properties": { "id": { "type": "string", "description": "Customer id", "example": "C12345" }, "status": { "enum": [ "active", "locked", "disabled" ], "type": "string", "description": "current state of the customer" }, "accounts": { "type": "integer", "description": "count of accounts this customer has", "example": 42 }, "contact": { "required": [ "name", null ], "type": "object", "properties": { "name": { "type": "string", "description": "contact name consisting of first and lastname", "example": "Doe, John" }, "company": { "type": "string", "description": "company name", "example": "ACME Inc." }, "city": { "type": "string", "description": "City name" }, "country": { "type": "string", "description": "CountryCode in ISO 3166-1 Alpha 2", "example": "DE" } } } } } } }, "description": "a list of all customers" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/reports\/customer-accounts": { "get": { "tags": [ "Reports" ], "summary": "Customer accounts report", "description": "This method returns a list of own customers accounts", "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "required": [ "customer", "status", "accounts", "contact" ], "type": "object", "properties": { "customer": { "type": "string", "description": "Customer id", "example": "C12345" }, "account": { "type": "string", "description": "Account name", "example": "res1" }, "contact": { "required": [ "name", null ], "type": "object", "properties": { "name": { "type": "string", "description": "contact name consisting of first and lastname", "example": "Doe, John" }, "company": { "type": "string", "description": "company name", "example": "ACME Inc." } } }, "template": { "type": "string", "description": "Template name", "example": "Standard package" }, "webspace": { "type": "object", "properties": { "quota": { "type": "integer", "description": "webspace size in bytes (0 = no webspace, -1 = unlimited, > 0 = actual quota in bytes)", "example": -1 }, "used": { "type": "integer", "description": "used webspace in bytes", "example": 44040192 } } }, "mailbox": { "type": "object", "properties": { "count": { "type": "integer", "description": "count of mailboxes in this account", "example": 815 }, "size": { "type": "integer", "description": "size of all mailboxes in this account", "example": 141459 } } }, "domains": { "type": "integer", "description": "count of domains in this account", "example": 15 }, "databases": { "type": "object", "properties": { "count": { "type": "integer", "description": "count of databases", "example": 9 }, "size": { "type": "integer", "description": "size of all databases", "example": 44040193 } } }, "traffic": { "type": "object", "properties": { "limit": { "type": "integer", "description": "traffic limit in bytes" }, "lastMonth": { "type": "integer", "description": "traffic of the last month" }, "currentMonth": { "type": "integer", "description": "traffic of the current month" } } } } } } }, "description": "a list of own customers" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/reports\/customer-domains": { "get": { "tags": [ "Reports" ], "summary": "Customer domains report", "description": "This method returns a list of all customer domains", "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "required": [ "domain", "account", "customer", "contact" ], "type": "object", "properties": { "domain": { "type": "string", "description": "name of the domain", "example": "example.org" }, "account": { "type": "string", "description": "name of the account", "example": "web123" }, "customer": { "type": "string", "description": "Customer id", "example": "C12345" }, "contact": { "required": [ "name", null ], "type": "object", "properties": { "name": { "type": "string", "description": "contact name consisting of first and lastname", "example": "Doe, John" }, "company": { "type": "string", "description": "company name", "example": "ACME Inc." } } } } } } }, "description": "a list of all customer domains" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/reports\/locked-customer-accounts": { "get": { "tags": [ "Reports" ], "summary": "Locked or suspended Customer accounts report", "description": "This method returns a list of all locked or suspended customer accounts", "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "required": [ "domain", "account", "customer", "contact" ], "type": "object", "properties": { "template": { "type": "string", "description": "name of the account template", "example": "example.org" }, "account": { "type": "string", "description": "name of the account", "example": "web123" }, "customer": { "type": "string", "description": "Customer id", "example": "C12345" }, "contact": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "contact name consisting of first and lastname", "example": "Doe, John" }, "company": { "type": "string", "description": "company name", "example": "ACME Inc." } } }, "webspace": { "type": "object", "properties": { "status": { "enum": [ "active", "locked", "suspended" ], "type": "string", "description": "locked state of webspace" }, "pending": { "type": "boolean", "description": "state is pending (needs to be sent to corresponding server)" } } }, "mail": { "type": "object", "properties": { "status": { "enum": [ "active", "locked", "suspended" ], "type": "string", "description": "locked state of mail" }, "pending": { "type": "boolean", "description": "state is pending (needs to be sent to corresponding server)" } } }, "ftp": { "type": "object", "properties": { "status": { "enum": [ "active", "locked", "suspended" ], "type": "string", "description": "locked state of ftp" }, "pending": { "type": "boolean", "description": "state is pending (needs to be sent to corresponding server)" } } } } } } }, "description": "a list of all locked or suspended customer accounts" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/reports\/locked-own-accounts": { "get": { "tags": [ "Reports" ], "summary": "Locked or suspended accounts report", "description": "This method returns a list of all locked or suspended accounts", "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "required": [ "domain", "account" ], "type": "object", "properties": { "template": { "type": "string", "description": "name of the account template", "example": "example.org" }, "account": { "type": "string", "description": "name of the account", "example": "web123" }, "webspace": { "type": "object", "properties": { "status": { "enum": [ "active", "locked", "suspended" ], "type": "string", "description": "locked state of webspace" }, "pending": { "type": "boolean", "description": "state is pending (needs to be sent to corresponding server)" } } }, "mail": { "type": "object", "properties": { "status": { "enum": [ "active", "locked", "suspended" ], "type": "string", "description": "locked state of mail" }, "pending": { "type": "boolean", "description": "state is pending (needs to be sent to corresponding server)" } } }, "ftp": { "type": "object", "properties": { "status": { "enum": [ "active", "locked", "suspended" ], "type": "string", "description": "locked state of ftp" }, "pending": { "type": "boolean", "description": "state is pending (needs to be sent to corresponding server)" } } } } } } }, "description": "a list of all locked or suspended accounts" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/reports\/overview": { "get": { "tags": [ "Reports" ], "summary": "overview report", "description": "This method returns some overview infos", "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "customers": { "type": "integer", "description": "count of customers", "example": 42 }, "resellers": { "type": "integer", "description": "count of resellers", "example": 15 }, "endCustomers": { "type": "integer", "description": "count of end customers", "example": 27 }, "domains": { "type": "integer", "description": "count of domains", "example": 155 }, "webspace": { "type": "object", "properties": { "bytes": { "type": "integer", "description": "used bytes on webspaces" }, "files": { "type": "integer", "description": "files on webspaces" } } }, "databases": { "type": "integer", "description": "count of databases" }, "traffic": { "type": "object", "properties": { "bytes": { "type": "integer", "description": "traffic produced" }, "hits": { "type": "integer", "description": "hits produced" } } } } } }, "description": "some reports overview infos" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/reports\/own-accounts": { "get": { "tags": [ "Reports" ], "summary": "Own accounts report", "description": "This method returns a list of all your accounts", "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "required": [ "domain", "account" ], "type": "object", "properties": { "template": { "type": "string", "description": "name of the account template", "example": "example.org" }, "account": { "type": "string", "description": "name of the account", "example": "web123" }, "webspace": { "type": "object", "properties": { "quota": { "type": "integer", "description": "webspace size in bytes (0 = no webspace, -1 = unlimited, > 0 = actual quota in bytes)", "example": -1 }, "used": { "type": "integer", "description": "used webspace in bytes", "example": 44040192 } } }, "mailbox": { "type": "object", "properties": { "count": { "type": "integer", "description": "count of mailboxes in this account", "example": 815 }, "size": { "type": "integer", "description": "size of all mailboxes in this account", "example": 141459 } } }, "domains": { "type": "integer", "description": "count of domains in this account", "example": 15 }, "databases": { "type": "object", "properties": { "count": { "type": "integer", "description": "count of databases", "example": 9 }, "size": { "type": "integer", "description": "size of all databases", "example": 44040193 } } }, "traffic": { "type": "object", "properties": { "limit": { "type": "integer", "description": "traffic limit in bytes" }, "lastMonth": { "type": "integer", "description": "traffic of the last month" }, "currentMonth": { "type": "integer", "description": "traffic of the current month" } } } } } } }, "description": "a list of all your accounts" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/reports\/own-domains": { "get": { "tags": [ "Reports" ], "summary": "Own domains report", "description": "This method returns a list of all own domains", "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "required": [ "domain", "account" ], "type": "object", "properties": { "domain": { "type": "string", "description": "name of the domain", "example": "example.org" }, "account": { "type": "string", "description": "name of the account", "example": "web123" } } } } }, "description": "a list of all own domains" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/reports\/servers": { "get": { "tags": [ "Reports" ], "summary": "Own domains report", "description": "This method returns a list of all own domains", "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "required": [ "domain", "account" ], "type": "object", "properties": { "os": { "type": "object", "properties": { "name": { "type": "string", "description": "OS name", "example": "Linux" }, "release": { "type": "string", "description": "Relese of the OS" }, "description": { "type": "string", "description": "description of the OS", "example": "Debian GNU\/Linux 11 (bullseye)" } } }, "mounts": { "type": "array", "items": { "type": "object", "properties": { "mountpoint": { "type": "string", "description": "path of the mountpoint", "example": "\/var\/www" }, "total": { "type": "integer", "description": "total size in bytes", "example": 632984961024 }, "free": { "type": "integer", "description": "total free bytes", "example": 632984960024 } } } }, "id": { "type": "string", "description": "server id", "example": "localhost" }, "hostname": { "type": "string", "description": "hostname of the server", "example": "liveconfig.example.org" }, "description": { "type": "string", "description": "description of the server", "example": "Local server" }, "lc": { "type": "object", "properties": { "version": { "type": "string", "description": "LiveConfig version", "example": "3.0.1" }, "serial": { "type": "string", "description": "LiveConfig license serial", "example": "0x123456789abcdef" }, "license": { "enum": [ "Basic", "Standard", "Business" ], "type": "string", "description": "LiveConfig license type" } } }, "customers": { "type": "integer", "description": "count of customers on the server", "example": 420 } } } } }, "description": "a list of all own domains" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/reports\/top-accounts\/{type}": { "get": { "tags": [ "Reports" ], "summary": "Top accounts Report", "description": "This method returns a list of accounts with the most traffic, mails or hits", "parameters": [ { "name": "type", "in": "path", "description": "type of TOP to filter by", "schema": { "enum": [ "mail", "traffic", "hits" ], "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "others": { "type": "integer", "description": "sum of all other accounts", "example": 3095674 }, "accounts": { "type": "array", "items": { "type": "object", "properties": { "hits": { "type": "integer", "description": "http hits on this account", "example": 1992 }, "traffic": { "type": "integer", "description": "traffic on this account", "example": 1929592 }, "mails": { "type": "integer", "description": "mail IO on this account", "example": 1241 }, "account": { "type": "string", "description": "Account name", "example": "web123" }, "resellerAccount": { "type": "string", "description": "Account name of corresponding reseller", "example": "res 122" }, "contact": { "required": [ "name", null ], "type": "object", "properties": { "name": { "type": "string", "description": "contact name consisting of first and lastname", "example": "Doe, John" }, "company": { "type": "string", "description": "company name", "example": "ACME Inc." } } }, "percent": { "type": "integer", "description": "this accounts percentile of the sum of the selected type", "example": 74 } } } } } } }, "description": "a list of top accounts" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers": { "get": { "tags": [ "Servers" ], "summary": "Get server list", "description": "This method returns a list of all servers.", "parameters": [ { "name": "count", "in": "query", "description": "number of results to return", "schema": { "minimum": 1, "type": "integer" } }, { "name": "page", "in": "query", "description": "page to return (offset), starting with `1`", "schema": { "minimum": 1, "type": "integer" } }, { "name": "sort", "in": "query", "description": "sort by selected column", "schema": { "enum": [ "accounts", "connected", "description", "distribution", "hostname", "id" ], "type": "string" } }, { "name": "search", "in": "query", "description": "search phrase (is matched against `id`)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "count": { "type": "integer", "description": "number of records found" }, "data": { "type": "array", "items": { "required": [ "connected", "hostname", "id", "services" ], "type": "object", "properties": { "accounts": { "type": "number", "description": "number of different accounts deployed on this server (webspace, mail or databases)" }, "connected": { "type": "boolean", "description": "whether LiveConfig client is connected" }, "connectTs": { "type": "string", "description": "timestamp since when the client is connected" }, "cpu": { "type": "object", "properties": { "name": { "type": "string", "description": "CPU name (as reported by `\/proc\/cpuinfo`)" }, "vendor": { "type": "string", "description": "CPU vendor" }, "cores": { "type": "integer", "description": "number of physical CPU cores" }, "threads": { "type": "integer", "description": "number of logical CPU cores" }, "cache": { "type": "integer", "description": "CPU cache size (KiB)" } } }, "description": { "type": "string", "description": "server description", "example": "Local server" }, "distDescription": { "type": "string", "description": "operating system distribution description", "example": "Debian GNU\/Linux 10 (Buster)" }, "distName": { "type": "string", "description": "operating system distribution name", "example": "Debian" }, "distVersion": { "type": "string", "description": "operating system distribution version", "example": "10.9" }, "hostname": { "type": "string", "description": "server hostname" }, "id": { "type": "string", "description": "host ID (used internally by LiveConfig for unique identification)", "example": "localhost" }, "ipv4": { "type": "integer", "description": "number of active IPv4 addresses" }, "ipv6": { "type": "integer", "description": "number of active IPv6 addresses" }, "lcVersion": { "type": "string", "description": "version number of connected LiveConfig client (e.g. `3.0.0`)" }, "lcVersionExtra": { "type": "string", "description": "version number extra information of connected LiveConfig client (e.g. `release`)" }, "license": { "type": "object", "properties": { "serial": { "type": "string", "description": "license serial number of connected LiveConfig client (hex string)", "example": 112394587743 }, "trial": { "type": "boolean", "description": "is `true` while using a free trial license" } } }, "osName": { "type": "string", "description": "operating system name (e.g. `Linux`)", "example": "Linux" }, "osRelease": { "type": "string", "description": "operating system release number (e.g. linux kernel version, like `4.19.0-16-amd64`)", "example": "4.19.0-16-amd64" }, "services": { "type": "array", "items": { "enum": [ "db", "dns", "mail", "web" ], "type": "string" }, "description": "list of services managed by LiveConfig", "example": [ "web", "mail", "db", "dns" ] }, "stats": { "type": "object", "properties": { "accounts": { "type": "integer", "description": "number of webspace accounts deployed on this server" }, "databases": { "type": "integer", "description": "number of databases deployed on this server" }, "dns": { "type": "integer", "description": "number of DNS zones deployed on this server" }, "mail": { "type": "integer", "description": "number of e-mail addresses deployed on this server" } } } } } } }, "description": "a list of all servers" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Servers" ], "summary": "Add new server", "requestBody": { "description": "JSON object with data of new server", "content": { "application\/json": { "schema": { "required": [ "id" ], "type": "object", "properties": { "description": { "type": "string", "description": "server description" }, "id": { "type": "string", "description": "host ID (used internally by LiveConfig for unique identification)" } } }, "examples": { "test-client": { "summary": "Example client server", "value": { "description": "just an example server", "id": "host01-example" } } } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}": { "get": { "tags": [ "Servers" ], "summary": "Get server details", "description": "Get detailed server information", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "allOf": [ { "required": [ "connected", "hostname", "id", "services" ], "type": "object", "properties": { "accounts": { "type": "number", "description": "number of different accounts deployed on this server (webspace, mail or databases)" }, "connected": { "type": "boolean", "description": "whether LiveConfig client is connected" }, "connectTs": { "type": "string", "description": "timestamp since when the client is connected" }, "cpu": { "type": "object", "properties": { "name": { "type": "string", "description": "CPU name (as reported by `\/proc\/cpuinfo`)" }, "vendor": { "type": "string", "description": "CPU vendor" }, "cores": { "type": "integer", "description": "number of physical CPU cores" }, "threads": { "type": "integer", "description": "number of logical CPU cores" }, "cache": { "type": "integer", "description": "CPU cache size (KiB)" } } }, "description": { "type": "string", "description": "server description", "example": "Local server" }, "distDescription": { "type": "string", "description": "operating system distribution description", "example": "Debian GNU\/Linux 10 (Buster)" }, "distName": { "type": "string", "description": "operating system distribution name", "example": "Debian" }, "distVersion": { "type": "string", "description": "operating system distribution version", "example": "10.9" }, "hostname": { "type": "string", "description": "server hostname" }, "id": { "type": "string", "description": "host ID (used internally by LiveConfig for unique identification)", "example": "localhost" }, "ipv4": { "type": "integer", "description": "number of active IPv4 addresses" }, "ipv6": { "type": "integer", "description": "number of active IPv6 addresses" }, "lcVersion": { "type": "string", "description": "version number of connected LiveConfig client (e.g. `3.0.0`)" }, "lcVersionExtra": { "type": "string", "description": "version number extra information of connected LiveConfig client (e.g. `release`)" }, "license": { "type": "object", "properties": { "serial": { "type": "string", "description": "license serial number of connected LiveConfig client (hex string)", "example": 112394587743 }, "trial": { "type": "boolean", "description": "is `true` while using a free trial license" } } }, "osName": { "type": "string", "description": "operating system name (e.g. `Linux`)", "example": "Linux" }, "osRelease": { "type": "string", "description": "operating system release number (e.g. linux kernel version, like `4.19.0-16-amd64`)", "example": "4.19.0-16-amd64" }, "services": { "type": "array", "items": { "enum": [ "db", "dns", "mail", "web" ], "type": "string" }, "description": "list of services managed by LiveConfig", "example": [ "web", "mail", "db", "dns" ] }, "stats": { "type": "object", "properties": { "accounts": { "type": "integer", "description": "number of webspace accounts deployed on this server" }, "databases": { "type": "integer", "description": "number of databases deployed on this server" }, "dns": { "type": "integer", "description": "number of DNS zones deployed on this server" }, "mail": { "type": "integer", "description": "number of e-mail addresses deployed on this server" } } } } }, { "type": "object", "properties": { "disk": { "type": "array", "items": { "required": [ "free", "mount", "total" ], "type": "object", "properties": { "free": { "type": "integer", "description": "free space (bytes)" }, "mount": { "type": "string", "description": "mount name" }, "total": { "type": "integer", "description": "total space (bytes)" } } }, "description": "list of mounted disks" }, "memory": { "type": "object", "properties": { "ram": { "required": [ "free", "total" ], "type": "object", "properties": { "free": { "type": "integer", "description": "free RAM (bytes)" }, "total": { "type": "integer", "description": "total available RAM (bytes)" } } }, "swap": { "required": [ "free", "total" ], "type": "object", "properties": { "free": { "type": "integer", "description": "free swap space (bytes)" }, "total": { "type": "integer", "description": "total available swap space (bytes)" } } } } }, "network": { "type": "array", "items": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "interface name" }, "mac": { "type": "string", "description": "MAC address of interface" }, "ipv4": { "type": "array", "items": { "required": [ "address", "netmask" ], "type": "object", "properties": { "address": { "type": "string", "description": "IPv4 address" }, "netmask": { "type": "integer", "description": "network mask" }, "ifName": { "type": "string", "description": "interface name (if different to assigned interface, e.g. virtual interface name `eth0:1`)" } } }, "description": "IPv4 addresses assigned to this interface" }, "ipv6": { "type": "array", "items": { "required": [ "address", "netmask" ], "type": "object", "properties": { "address": { "type": "string", "description": "IPv6 address" }, "netmask": { "type": "integer", "description": "network mask" }, "ifName": { "type": "string", "description": "interface name (if different to assigned interface, e.g. virtual interface name `eth0:1`)" } } }, "description": "IPv6 addresses assigned to this interface" } } }, "description": "list of network interfaces and IP addresses" } } } ] } }, "description": "Server details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Servers" ], "summary": "Remove a server", "description": "Remove a server from LiveConfig. Restrictions:\n * the server `localhost` can't be removed\n * the server must be disconnected from LiveConfig\n", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" } }, { "name": "force", "in": "query", "description": "Force deletion of server even if objects linked with that server still exist.", "schema": { "enum": [ true, false ], "type": "string", "default": false } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Servers" ], "summary": "Edit a server", "description": "This method edits a server.", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object with changed data of the server", "content": { "application\/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "Server description" }, "id": { "type": "string", "description": "Host ID (used internally by LiveConfig for unique identification). `localhost` can't be renamed." } } }, "examples": { "test-client": { "summary": "Example client server", "value": { "description": "just an example server", "id": "host01-example" } } } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}\/backup": { "get": { "tags": [ "Servers" ], "summary": "Backup service settings", "description": "Returns the backup service settings", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" }, { "name": "show", "in": "query", "description": "comma-separated list of additional data to show (`storage`: show available (configured) backup storage, see [`\/backup-storage`](#get-\/backup-storage))\n", "style": "form", "explode": false, "schema": { "type": "array", "items": { "enum": [ "storage" ], "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "required": [ "managed" ], "type": "object", "properties": { "ioNice": { "maximum": 7, "minimum": 0, "type": "integer", "description": "\"io_nice\" value for backup process I\/O (priority), 7 = lowest priority, 0 = highest priority", "example": 7 }, "managed": { "type": "boolean", "description": "Whether this service is managed by LiveConfig", "example": true }, "nice": { "maximum": 19, "minimum": -20, "type": "integer", "description": "\"nice\" value for backup process (priority), 19 = lowest priority, -20 = highest priority", "example": 10 }, "parallel": { "maximum": 20, "minimum": 1, "type": "integer", "description": "Maximum number of parallel backup jobs", "example": 5 }, "services": { "type": "array", "items": { "required": [ "name", "unit", "status" ], "type": "object", "properties": { "description": { "type": "string", "description": "Short description of that service's purpose", "example": "Flexible service for something important" }, "name": { "type": "string", "description": "Service name", "example": "example" }, "status": { "enum": [ "active", "activating", "inactive", "deactivating", "reloading", "failed", "invalid", "unknown" ], "type": "string", "description": "Current service status (from systemd)", "example": "running" }, "unit": { "type": "string", "description": "systemd unit name", "example": "exampled" }, "title": { "type": "string", "description": "Service title", "example": "Example Service Daemon" } } }, "description": "List of required services" }, "software": { "type": "array", "items": { "required": [ "name", "version" ], "type": "object", "properties": { "name": { "type": "string", "description": "Software name", "example": "borg" }, "packageVersion": { "type": "string", "description": "Version of software package", "example": "1.1.9-2+deb10u1" }, "version": { "type": "string", "description": "Software version", "example": "1.1.9" } } }, "description": "List of detected backup software" }, "storage": { "type": "array", "items": { "required": [ "path" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description for this backup storage", "example": "Off-site storage for long-term backups" }, "type": { "enum": [ "borg", "restic", "tar" ], "type": "string", "description": "Storage type", "readOnly": true, "example": "borg" }, "protocol": { "enum": [ "local", "ssh\/sftp", "ftps" ], "type": "string", "description": "Connection protocol for remote hosts", "readOnly": true, "example": "ssh" }, "host": { "type": "string", "description": "Name of remote server (field not set for local backup)", "example": "backup.example.org" }, "insecure": { "type": "boolean", "description": "Allow insecure remote connections (i.e. don't validate server TLS certificate with FTPS)", "example": false }, "port": { "maximum": 65535, "minimum": 1, "type": "integer", "description": "Optional port number for selected remote host protocol (if differing from standard port)", "example": 22022 }, "connections": { "maximum": 100, "minimum": 1, "type": "integer", "nullable": true, "example": 12, "cdescription": "maximum number of parallel connections possible to the host (only available for `type` == `tar` (protocol `ftps`)) (`borg` and `restic` are limited to one connection per storage!)", "optional": true }, "path": { "type": "string", "description": "Backup base path or vault location" }, "password": { "type": "string", "description": "Optional vault password (only for Borg and Restic)" }, "global": { "type": "boolean", "description": "only available when `host` is non-empty (non-local storage): this storage may also be used for backups from other servers", "example": false }, "auth": { "type": "object", "properties": { "user": { "type": "string", "description": "Username for remote host connection", "example": "backup" }, "method": { "enum": [ "password", "key" ], "type": "string", "description": "Authentication method", "readOnly": true, "example": "password" }, "password": { "type": "string", "description": "Password (for password authentication)", "writeOnly": true }, "key": { "type": "string", "description": "SSH key (for public key authentication)", "writeOnly": true }, "modified": { "type": "string", "description": "Last modification timestamp of authentication data", "format": "date-time", "readOnly": true, "example": "2021-07-21T17:32:28Z" } }, "description": "Authentication data for remote host connection" }, "usage": { "type": "object", "properties": { "accounts": { "type": "integer", "description": "number of accounts that have backups in this storage", "readOnly": true, "example": 10 }, "backups": { "type": "integer", "description": "number of backups in this storage", "readOnly": true, "example": 115 }, "dataSize": { "type": "integer", "description": "data size in bytes of the backups in this storage", "readOnly": true, "example": 20899840 }, "latestBackup": { "type": "string", "description": "timestamp of the last backup created in this storage", "format": "datetime", "readOnly": true, "example": "2024-06-21T15:04:04Z" } }, "description": "some usage informations for the storage", "readOnly": true } } }, "description": "List of configured backup storage available for this server, returned only when `show=storage` is set" } } } }, "description": "Backup service settings" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Servers" ], "summary": "Backup service settings", "description": "Edit the backup service settings", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" } ], "requestBody": { "description": "Settings to modify", "content": { "application\/json": { "schema": { "type": "object", "properties": { "ioNice": { "maximum": 7, "minimum": 0, "type": "integer", "description": "\"io_nice\" value for backup process I\/O (priority), 7 = lowest priority, 0 = highest priority", "default": 7, "example": 4 }, "managed": { "type": "boolean", "description": "Whether this service is managed by LiveConfig (can only be enabled, not disabled)", "example": true }, "nice": { "maximum": 19, "minimum": -20, "type": "integer", "description": "\"nice\" value for backup process (priority), 19 = lowest priority, -20 = highest priority", "default": 10, "example": 0 }, "parallel": { "maximum": 20, "minimum": 1, "type": "integer", "description": "Maximum number of parallel backup jobs", "default": 5, "example": 5 } } } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}\/backup\/storage": { "post": { "tags": [ "Backup" ], "summary": "Add new backup storage", "description": "This method adds a new backup storage.", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" } ], "requestBody": { "description": "Data of new backup storage", "content": { "application\/json": { "schema": { "allOf": [ { "required": [ "path" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description for this backup storage", "example": "Off-site storage for long-term backups" }, "type": { "enum": [ "borg", "restic", "tar" ], "type": "string", "description": "Storage type", "readOnly": true, "example": "borg" }, "protocol": { "enum": [ "local", "ssh\/sftp", "ftps" ], "type": "string", "description": "Connection protocol for remote hosts", "readOnly": true, "example": "ssh" }, "host": { "type": "string", "description": "Name of remote server (field not set for local backup)", "example": "backup.example.org" }, "insecure": { "type": "boolean", "description": "Allow insecure remote connections (i.e. don't validate server TLS certificate with FTPS)", "example": false }, "port": { "maximum": 65535, "minimum": 1, "type": "integer", "description": "Optional port number for selected remote host protocol (if differing from standard port)", "example": 22022 }, "connections": { "maximum": 100, "minimum": 1, "type": "integer", "nullable": true, "example": 12, "cdescription": "maximum number of parallel connections possible to the host (only available for `type` == `tar` (protocol `ftps`)) (`borg` and `restic` are limited to one connection per storage!)", "optional": true }, "path": { "type": "string", "description": "Backup base path or vault location" }, "password": { "type": "string", "description": "Optional vault password (only for Borg and Restic)" }, "global": { "type": "boolean", "description": "only available when `host` is non-empty (non-local storage): this storage may also be used for backups from other servers", "example": false }, "auth": { "type": "object", "properties": { "user": { "type": "string", "description": "Username for remote host connection", "example": "backup" }, "method": { "enum": [ "password", "key" ], "type": "string", "description": "Authentication method", "readOnly": true, "example": "password" }, "password": { "type": "string", "description": "Password (for password authentication)", "writeOnly": true }, "key": { "type": "string", "description": "SSH key (for public key authentication)", "writeOnly": true }, "modified": { "type": "string", "description": "Last modification timestamp of authentication data", "format": "date-time", "readOnly": true, "example": "2021-07-21T17:32:28Z" } }, "description": "Authentication data for remote host connection" }, "usage": { "type": "object", "properties": { "accounts": { "type": "integer", "description": "number of accounts that have backups in this storage", "readOnly": true, "example": 10 }, "backups": { "type": "integer", "description": "number of backups in this storage", "readOnly": true, "example": 115 }, "dataSize": { "type": "integer", "description": "data size in bytes of the backups in this storage", "readOnly": true, "example": 20899840 }, "latestBackup": { "type": "string", "description": "timestamp of the last backup created in this storage", "format": "datetime", "readOnly": true, "example": "2024-06-21T15:04:04Z" } }, "description": "some usage informations for the storage", "readOnly": true } } }, { "required": [ "type", "protocol" ], "type": "object", "properties": { "type": { "readOnly": false }, "protocol": { "readOnly": false } } } ] } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}\/backup\/storage\/{storageId}": { "get": { "tags": [ "Backup" ], "summary": "Get backup storage details", "description": "This method returns the details for a certain backup storage", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" }, { "name": "storageId", "in": "path", "description": "Backup storage id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "required": [ "path" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description for this backup storage", "example": "Off-site storage for long-term backups" }, "type": { "enum": [ "borg", "restic", "tar" ], "type": "string", "description": "Storage type", "readOnly": true, "example": "borg" }, "protocol": { "enum": [ "local", "ssh\/sftp", "ftps" ], "type": "string", "description": "Connection protocol for remote hosts", "readOnly": true, "example": "ssh" }, "host": { "type": "string", "description": "Name of remote server (field not set for local backup)", "example": "backup.example.org" }, "insecure": { "type": "boolean", "description": "Allow insecure remote connections (i.e. don't validate server TLS certificate with FTPS)", "example": false }, "port": { "maximum": 65535, "minimum": 1, "type": "integer", "description": "Optional port number for selected remote host protocol (if differing from standard port)", "example": 22022 }, "connections": { "maximum": 100, "minimum": 1, "type": "integer", "nullable": true, "example": 12, "cdescription": "maximum number of parallel connections possible to the host (only available for `type` == `tar` (protocol `ftps`)) (`borg` and `restic` are limited to one connection per storage!)", "optional": true }, "path": { "type": "string", "description": "Backup base path or vault location" }, "password": { "type": "string", "description": "Optional vault password (only for Borg and Restic)" }, "global": { "type": "boolean", "description": "only available when `host` is non-empty (non-local storage): this storage may also be used for backups from other servers", "example": false }, "auth": { "type": "object", "properties": { "user": { "type": "string", "description": "Username for remote host connection", "example": "backup" }, "method": { "enum": [ "password", "key" ], "type": "string", "description": "Authentication method", "readOnly": true, "example": "password" }, "password": { "type": "string", "description": "Password (for password authentication)", "writeOnly": true }, "key": { "type": "string", "description": "SSH key (for public key authentication)", "writeOnly": true }, "modified": { "type": "string", "description": "Last modification timestamp of authentication data", "format": "date-time", "readOnly": true, "example": "2021-07-21T17:32:28Z" } }, "description": "Authentication data for remote host connection" }, "usage": { "type": "object", "properties": { "accounts": { "type": "integer", "description": "number of accounts that have backups in this storage", "readOnly": true, "example": 10 }, "backups": { "type": "integer", "description": "number of backups in this storage", "readOnly": true, "example": 115 }, "dataSize": { "type": "integer", "description": "data size in bytes of the backups in this storage", "readOnly": true, "example": 20899840 }, "latestBackup": { "type": "string", "description": "timestamp of the last backup created in this storage", "format": "datetime", "readOnly": true, "example": "2024-06-21T15:04:04Z" } }, "description": "some usage informations for the storage", "readOnly": true } } } }, "description": "Backup storage details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Backup" ], "summary": "Remove a backup storage", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" }, { "name": "storageId", "in": "path", "description": "the id of the backup storage", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Backup" ], "summary": "Edit backup storage details", "description": "This method modifies the details for a certain backup storage", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" }, { "name": "storageId", "in": "path", "description": "Backup storage id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Backup storage data to be modified", "content": { "application\/json": { "schema": { "required": [ "path" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description for this backup storage", "example": "Off-site storage for long-term backups" }, "type": { "enum": [ "borg", "restic", "tar" ], "type": "string", "description": "Storage type", "readOnly": true, "example": "borg" }, "protocol": { "enum": [ "local", "ssh\/sftp", "ftps" ], "type": "string", "description": "Connection protocol for remote hosts", "readOnly": true, "example": "ssh" }, "host": { "type": "string", "description": "Name of remote server (field not set for local backup)", "example": "backup.example.org" }, "insecure": { "type": "boolean", "description": "Allow insecure remote connections (i.e. don't validate server TLS certificate with FTPS)", "example": false }, "port": { "maximum": 65535, "minimum": 1, "type": "integer", "description": "Optional port number for selected remote host protocol (if differing from standard port)", "example": 22022 }, "connections": { "maximum": 100, "minimum": 1, "type": "integer", "nullable": true, "example": 12, "cdescription": "maximum number of parallel connections possible to the host (only available for `type` == `tar` (protocol `ftps`)) (`borg` and `restic` are limited to one connection per storage!)", "optional": true }, "path": { "type": "string", "description": "Backup base path or vault location" }, "password": { "type": "string", "description": "Optional vault password (only for Borg and Restic)" }, "global": { "type": "boolean", "description": "only available when `host` is non-empty (non-local storage): this storage may also be used for backups from other servers", "example": false }, "auth": { "type": "object", "properties": { "user": { "type": "string", "description": "Username for remote host connection", "example": "backup" }, "method": { "enum": [ "password", "key" ], "type": "string", "description": "Authentication method", "readOnly": true, "example": "password" }, "password": { "type": "string", "description": "Password (for password authentication)", "writeOnly": true }, "key": { "type": "string", "description": "SSH key (for public key authentication)", "writeOnly": true }, "modified": { "type": "string", "description": "Last modification timestamp of authentication data", "format": "date-time", "readOnly": true, "example": "2021-07-21T17:32:28Z" } }, "description": "Authentication data for remote host connection" }, "usage": { "type": "object", "properties": { "accounts": { "type": "integer", "description": "number of accounts that have backups in this storage", "readOnly": true, "example": 10 }, "backups": { "type": "integer", "description": "number of backups in this storage", "readOnly": true, "example": 115 }, "dataSize": { "type": "integer", "description": "data size in bytes of the backups in this storage", "readOnly": true, "example": 20899840 }, "latestBackup": { "type": "string", "description": "timestamp of the last backup created in this storage", "format": "datetime", "readOnly": true, "example": "2024-06-21T15:04:04Z" } }, "description": "some usage informations for the storage", "readOnly": true } } } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}\/ftp": { "get": { "tags": [ "Servers" ], "summary": "FTP service settings", "description": "Returns the FTP service settings", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "required": [ "managed" ], "type": "object", "properties": { "managed": { "type": "boolean", "description": "Whether this service is managed by LiveConfig", "example": true }, "maxConnections": { "maximum": 99999, "minimum": 1, "type": "integer", "description": "maximum number of concurrent FTP sessions", "default": 100, "example": 100 }, "maxConnectionsPerIp": { "maximum": 99999, "minimum": 1, "type": "integer", "description": "maximum number of concurrent FTP sessions per IP address", "default": 5, "example": 5 }, "pasvFrom": { "maximum": 65535, "minimum": 1024, "type": "integer", "description": "optional PASV port range (start)" }, "pasvTo": { "maximum": 65535, "minimum": 1024, "type": "integer", "description": "optional PASV port range (end)" }, "services": { "type": "array", "items": { "required": [ "name", "unit", "status" ], "type": "object", "properties": { "description": { "type": "string", "description": "Short description of that service's purpose", "example": "Flexible service for something important" }, "name": { "type": "string", "description": "Service name", "example": "example" }, "status": { "enum": [ "active", "activating", "inactive", "deactivating", "reloading", "failed", "invalid", "unknown" ], "type": "string", "description": "Current service status (from systemd)", "example": "running" }, "unit": { "type": "string", "description": "systemd unit name", "example": "exampled" }, "title": { "type": "string", "description": "Service title", "example": "Example Service Daemon" } } }, "description": "List of required services" }, "tls": { "type": "object", "properties": { "certificate": { "required": [ "id" ], "type": "object", "properties": { "automated": { "type": "boolean", "description": "Is `true` when certificate is automatically ordered\/renewed (e.g. with _Let's Encrypt_)", "default": false, "example": true }, "id": { "type": "string", "description": "Certificate id", "example": "1a2b3c" }, "name": { "type": "string", "description": "Certificate name (CommonName)", "example": "example.org" }, "san": { "type": "array", "items": { "type": "string" }, "description": "Array of additional names (SAN - Subject Alternative Name)", "example": [ "example.org", "www.example.org" ] }, "validFrom": { "type": "string", "description": "Certificate validity", "format": "date-time", "example": "2021-07-21T17:32:28Z" }, "validTo": { "type": "string", "description": "Certificate validity", "format": "date-time", "example": "2022-07-21T17:32:28Z" } } }, "enabled": { "type": "boolean", "description": "TLS enabled\/disabled", "example": true }, "onlyTls": { "type": "boolean", "description": "allow only encrypted connections", "example": true }, "sessionReuse": { "type": "boolean", "description": "require TLS session reuse", "example": false } } } } } }, "description": "FTP service settings" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Servers" ], "summary": "FTP service settings", "description": "Edit the FTP service settings", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" } ], "requestBody": { "description": "Settings to modify", "content": { "application\/json": { "schema": { "type": "object", "properties": { "managed": { "type": "boolean", "description": "Whether this service is managed by LiveConfig", "example": true }, "maxConnections": { "maximum": 99999, "minimum": 1, "type": "integer", "description": "maximum number of concurrent FTP sessions", "default": 100, "example": 100 }, "maxConnectionsPerIp": { "maximum": 99999, "minimum": 1, "type": "integer", "description": "maximum number of concurrent FTP sessions per IP address", "default": 5, "example": 5 }, "pasvFrom": { "maximum": 65535, "minimum": 1024, "type": "integer", "description": "optional PASV port range (start)" }, "pasvTo": { "maximum": 65535, "minimum": 1024, "type": "integer", "description": "optional PASV port range (end)" }, "tls": { "type": "object", "properties": { "certificate": { "type": "string", "description": "ID of TLS certificate to use", "example": "1a2b3c" }, "enabled": { "type": "boolean", "description": "TLS enabled\/disabled", "example": true }, "onlyTls": { "type": "boolean", "description": "allow only encrypted connections", "example": true }, "sessionReuse": { "type": "boolean", "description": "require TLS session reuse", "example": false } } } } } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}\/db": { "get": { "tags": [ "Servers" ], "summary": "List RDBMS (database) services", "description": "Returns the list of available RDBMS (database) services", "parameters": [ { "name": "id", "in": "path", "description": "Server ID", "required": true, "schema": { "type": "string" }, "example": "localhost" } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 1 }, "data": { "type": "array", "items": { "required": [ "managed" ], "type": "object", "properties": { "adminSso": { "type": "boolean", "description": "Whether single sign-on (SSO) to admin tool (see `adminUrl`) is possible (see https:\/\/www.liveconfig.com\/en\/kb\/mysql-sso\/)", "example": true }, "adminUrl": { "type": "string", "description": "URL to database administration tool (e.g. phpMyAdmin)", "example": "https:\/\/phpmyadmin.example.org?server_id=2" }, "extAccess": { "type": "boolean", "description": "Is `true` if external access to database service is possible from _any_ IP address (must also be allowed in account and in database)", "example": false }, "extIps": { "type": "array", "items": { "type": "string" }, "description": "IP addresses or subnets from which external connections are allowed" }, "hostname": { "type": "string", "description": "Optional differing hostname (only for display purposes)", "example": "rdbms.example.org" }, "id": { "type": "string", "description": "Database instance ID", "readOnly": true, "example": "mysql" }, "managed": { "type": "boolean", "description": "Whether this service is managed by LiveConfig", "example": true }, "name": { "type": "string", "description": "RDBMS (database software) name", "readOnly": true, "example": "mysql" }, "packageVersion": { "type": "string", "description": "database package version", "readOnly": true, "example": "1:10.3.34-0+deb10u1" }, "password": { "maxLength": 45, "type": "string", "description": "Password for connecting to the database", "writeOnly": true, "example": "Sup\u20acrS3cre7" }, "services": { "allOf": [ { "type": "array", "items": { "required": [ "name", "unit", "status" ], "type": "object", "properties": { "description": { "type": "string", "description": "Short description of that service's purpose", "example": "Flexible service for something important" }, "name": { "type": "string", "description": "Service name", "example": "example" }, "status": { "enum": [ "active", "activating", "inactive", "deactivating", "reloading", "failed", "invalid", "unknown" ], "type": "string", "description": "Current service status (from systemd)", "example": "running" }, "unit": { "type": "string", "description": "systemd unit name", "example": "exampled" }, "title": { "type": "string", "description": "Service title", "example": "Example Service Daemon" } } }, "description": "List of required services" }, { "type": "array", "readOnly": true } ] }, "status": { "enum": [ "uninitialized", "managed", "connecting", "connected", "error" ], "type": "string", "description": "Connection status", "readOnly": true }, "statusMsg": { "type": "string", "description": "Additional message for current status", "readOnly": true }, "statusTs": { "type": "string", "description": "Timestamp of last status change", "format": "date-time", "readOnly": true, "example": "2021-11-09T11:22:33Z" }, "username": { "maxLength": 64, "type": "string", "description": "Username for connecting to the database", "example": "root" }, "version": { "type": "string", "description": "RDBMS (database software) version", "readOnly": true, "example": "10.3.34" } } } } }, "description": "Database services" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}\/db\/{dbId}": { "get": { "tags": [ "Servers" ], "summary": "RDBMS (database software) settings", "description": "Returns the RDBMS (database software) settings", "parameters": [ { "name": "id", "in": "path", "description": "Server ID", "required": true, "schema": { "type": "string" }, "example": "localhost" }, { "name": "dbId", "in": "path", "description": "Database instance ID", "required": true, "schema": { "type": "string" }, "example": "mysql" } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "required": [ "managed" ], "type": "object", "properties": { "adminSso": { "type": "boolean", "description": "Whether single sign-on (SSO) to admin tool (see `adminUrl`) is possible (see https:\/\/www.liveconfig.com\/en\/kb\/mysql-sso\/)", "example": true }, "adminUrl": { "type": "string", "description": "URL to database administration tool (e.g. phpMyAdmin)", "example": "https:\/\/phpmyadmin.example.org?server_id=2" }, "extAccess": { "type": "boolean", "description": "Is `true` if external access to database service is possible from _any_ IP address (must also be allowed in account and in database)", "example": false }, "extIps": { "type": "array", "items": { "type": "string" }, "description": "IP addresses or subnets from which external connections are allowed" }, "hostname": { "type": "string", "description": "Optional differing hostname (only for display purposes)", "example": "rdbms.example.org" }, "id": { "type": "string", "description": "Database instance ID", "readOnly": true, "example": "mysql" }, "managed": { "type": "boolean", "description": "Whether this service is managed by LiveConfig", "example": true }, "name": { "type": "string", "description": "RDBMS (database software) name", "readOnly": true, "example": "mysql" }, "packageVersion": { "type": "string", "description": "database package version", "readOnly": true, "example": "1:10.3.34-0+deb10u1" }, "password": { "maxLength": 45, "type": "string", "description": "Password for connecting to the database", "writeOnly": true, "example": "Sup\u20acrS3cre7" }, "services": { "allOf": [ { "type": "array", "items": { "required": [ "name", "unit", "status" ], "type": "object", "properties": { "description": { "type": "string", "description": "Short description of that service's purpose", "example": "Flexible service for something important" }, "name": { "type": "string", "description": "Service name", "example": "example" }, "status": { "enum": [ "active", "activating", "inactive", "deactivating", "reloading", "failed", "invalid", "unknown" ], "type": "string", "description": "Current service status (from systemd)", "example": "running" }, "unit": { "type": "string", "description": "systemd unit name", "example": "exampled" }, "title": { "type": "string", "description": "Service title", "example": "Example Service Daemon" } } }, "description": "List of required services" }, { "type": "array", "readOnly": true } ] }, "status": { "enum": [ "uninitialized", "managed", "connecting", "connected", "error" ], "type": "string", "description": "Connection status", "readOnly": true }, "statusMsg": { "type": "string", "description": "Additional message for current status", "readOnly": true }, "statusTs": { "type": "string", "description": "Timestamp of last status change", "format": "date-time", "readOnly": true, "example": "2021-11-09T11:22:33Z" }, "username": { "maxLength": 64, "type": "string", "description": "Username for connecting to the database", "example": "root" }, "version": { "type": "string", "description": "RDBMS (database software) version", "readOnly": true, "example": "10.3.34" } } } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Servers" ], "summary": "RDBMS (database software) settings", "description": "Edit the RDBMS (database software) settings", "parameters": [ { "name": "id", "in": "path", "description": "Server ID", "required": true, "schema": { "type": "string" }, "example": "localhost" }, { "name": "dbId", "in": "path", "description": "Database instance ID", "required": true, "schema": { "type": "string" }, "example": "mysql" } ], "requestBody": { "description": "Settings to modify", "content": { "application\/json": { "schema": { "required": [ "managed" ], "type": "object", "properties": { "adminSso": { "type": "boolean", "description": "Whether single sign-on (SSO) to admin tool (see `adminUrl`) is possible (see https:\/\/www.liveconfig.com\/en\/kb\/mysql-sso\/)", "example": true }, "adminUrl": { "type": "string", "description": "URL to database administration tool (e.g. phpMyAdmin)", "example": "https:\/\/phpmyadmin.example.org?server_id=2" }, "extAccess": { "type": "boolean", "description": "Is `true` if external access to database service is possible from _any_ IP address (must also be allowed in account and in database)", "example": false }, "extIps": { "type": "array", "items": { "type": "string" }, "description": "IP addresses or subnets from which external connections are allowed" }, "hostname": { "type": "string", "description": "Optional differing hostname (only for display purposes)", "example": "rdbms.example.org" }, "id": { "type": "string", "description": "Database instance ID", "readOnly": true, "example": "mysql" }, "managed": { "type": "boolean", "description": "Whether this service is managed by LiveConfig", "example": true }, "name": { "type": "string", "description": "RDBMS (database software) name", "readOnly": true, "example": "mysql" }, "packageVersion": { "type": "string", "description": "database package version", "readOnly": true, "example": "1:10.3.34-0+deb10u1" }, "password": { "maxLength": 45, "type": "string", "description": "Password for connecting to the database", "writeOnly": true, "example": "Sup\u20acrS3cre7" }, "services": { "allOf": [ { "type": "array", "items": { "required": [ "name", "unit", "status" ], "type": "object", "properties": { "description": { "type": "string", "description": "Short description of that service's purpose", "example": "Flexible service for something important" }, "name": { "type": "string", "description": "Service name", "example": "example" }, "status": { "enum": [ "active", "activating", "inactive", "deactivating", "reloading", "failed", "invalid", "unknown" ], "type": "string", "description": "Current service status (from systemd)", "example": "running" }, "unit": { "type": "string", "description": "systemd unit name", "example": "exampled" }, "title": { "type": "string", "description": "Service title", "example": "Example Service Daemon" } } }, "description": "List of required services" }, { "type": "array", "readOnly": true } ] }, "status": { "enum": [ "uninitialized", "managed", "connecting", "connected", "error" ], "type": "string", "description": "Connection status", "readOnly": true }, "statusMsg": { "type": "string", "description": "Additional message for current status", "readOnly": true }, "statusTs": { "type": "string", "description": "Timestamp of last status change", "format": "date-time", "readOnly": true, "example": "2021-11-09T11:22:33Z" }, "username": { "maxLength": 64, "type": "string", "description": "Username for connecting to the database", "example": "root" }, "version": { "type": "string", "description": "RDBMS (database software) version", "readOnly": true, "example": "10.3.34" } } } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}\/dns": { "get": { "tags": [ "Servers" ], "summary": "DNS service settings", "description": "Returns the DNS service settings", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "allOf": [ { "required": [ "managed" ], "type": "object", "properties": { "managed": { "type": "boolean", "description": "Whether this service is managed by LiveConfig", "example": true }, "name": { "type": "string", "description": "dns name", "readOnly": true, "example": "bind9" }, "version": { "type": "string", "description": "dns version", "readOnly": true, "example": "9.3.0" }, "packageVersion": { "type": "string", "description": "dns package version", "readOnly": true, "example": "9.3.0" }, "services": { "allOf": [ { "type": "array", "items": { "required": [ "name", "unit", "status" ], "type": "object", "properties": { "description": { "type": "string", "description": "Short description of that service's purpose", "example": "Flexible service for something important" }, "name": { "type": "string", "description": "Service name", "example": "example" }, "status": { "enum": [ "active", "activating", "inactive", "deactivating", "reloading", "failed", "invalid", "unknown" ], "type": "string", "description": "Current service status (from systemd)", "example": "running" }, "unit": { "type": "string", "description": "systemd unit name", "example": "exampled" }, "title": { "type": "string", "description": "Service title", "example": "Example Service Daemon" } } }, "description": "List of required services" }, { "type": "array", "readOnly": true } ] }, "dnssec": { "type": "boolean", "description": "enable DNSSec on this server", "example": true } } }, { "type": "object", "properties": { "ips": { "type": "array", "items": { "required": [ "address", "netmask", "version", "found" ], "type": "object", "properties": { "version": { "enum": [ 4, 6 ], "type": "integer", "description": "version of the IP address", "readOnly": true, "example": 4 }, "address": { "type": "string", "description": "IPv4\/IPv6 address", "readOnly": true, "example": "192.168.0.123" }, "netmask": { "type": "integer", "description": "netmask of the IP address", "readOnly": true, "example": 24 }, "found": { "type": "boolean", "description": "flag if the address was found by LiveConfig", "readOnly": true, "example": true }, "interface": { "type": "string", "description": "name of the interface the IP is configured at", "readOnly": true, "example": "eth0" }, "natAddress": { "type": "string", "description": "user configured alternative IP address mapping (used for dNATed servers)", "example": "203.0.113.123" } } }, "description": "IP addresses assigned to selected web server" }, "otherIps": { "type": "array", "items": { "required": [ "address", "netmask", "version", "found" ], "type": "object", "properties": { "version": { "enum": [ 4, 6 ], "type": "integer", "description": "version of the IP address", "readOnly": true, "example": 4 }, "address": { "type": "string", "description": "IPv4\/IPv6 address", "readOnly": true, "example": "192.168.0.123" }, "netmask": { "type": "integer", "description": "netmask of the IP address", "readOnly": true, "example": 24 }, "found": { "type": "boolean", "description": "flag if the address was found by LiveConfig", "readOnly": true, "example": true }, "interface": { "type": "string", "description": "name of the interface the IP is configured at", "readOnly": true, "example": "eth0" }, "natAddress": { "type": "string", "description": "user configured alternative IP address mapping (used for dNATed servers)", "example": "203.0.113.123" } } }, "description": "all other IP addresses on the server" } } } ] } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Servers" ], "summary": "DNS service settings", "description": "Edit the DNS service settings", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" } ], "requestBody": { "description": "Settings to modify", "content": { "application\/json": { "schema": { "allOf": [ { "required": [ "managed" ], "type": "object", "properties": { "managed": { "type": "boolean", "description": "Whether this service is managed by LiveConfig", "example": true }, "name": { "type": "string", "description": "dns name", "readOnly": true, "example": "bind9" }, "version": { "type": "string", "description": "dns version", "readOnly": true, "example": "9.3.0" }, "packageVersion": { "type": "string", "description": "dns package version", "readOnly": true, "example": "9.3.0" }, "services": { "allOf": [ { "type": "array", "items": { "required": [ "name", "unit", "status" ], "type": "object", "properties": { "description": { "type": "string", "description": "Short description of that service's purpose", "example": "Flexible service for something important" }, "name": { "type": "string", "description": "Service name", "example": "example" }, "status": { "enum": [ "active", "activating", "inactive", "deactivating", "reloading", "failed", "invalid", "unknown" ], "type": "string", "description": "Current service status (from systemd)", "example": "running" }, "unit": { "type": "string", "description": "systemd unit name", "example": "exampled" }, "title": { "type": "string", "description": "Service title", "example": "Example Service Daemon" } } }, "description": "List of required services" }, { "type": "array", "readOnly": true } ] }, "dnssec": { "type": "boolean", "description": "enable DNSSec on this server", "example": true } } }, { "type": "object", "properties": { "ips": { "type": "array", "items": { "type": "string", "format": "ipv4 or ipv6" }, "description": "list of IPv4 and IPv6 addresses this service should listen on for dns requests" } } } ] } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}\/mail\/imap": { "get": { "tags": [ "Servers" ], "summary": "POP3\/IMAP server settings", "description": "Returns all POP3\/IMAP server settings", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "managed": { "type": "boolean", "description": "Whether this service is managed by LiveConfig", "example": true }, "version": { "type": "string", "description": "Dovecot version", "readOnly": true, "example": "2.2.27" }, "packageVersion": { "type": "string", "description": "Version of software package", "readOnly": true, "example": "1:2.2.27-3+deb9u7" }, "config": { "type": "string", "description": "the configuration path", "readOnly": true, "example": "\/etc\/dovecot" }, "name": { "type": "string", "description": "name of the service", "readOnly": true, "example": "dovecot" }, "services": { "allOf": [ { "type": "array", "readOnly": true }, { "type": "array", "items": { "required": [ "name", "unit", "status" ], "type": "object", "properties": { "description": { "type": "string", "description": "Short description of that service's purpose", "example": "Flexible service for something important" }, "name": { "type": "string", "description": "Service name", "example": "example" }, "status": { "enum": [ "active", "activating", "inactive", "deactivating", "reloading", "failed", "invalid", "unknown" ], "type": "string", "description": "Current service status (from systemd)", "example": "running" }, "unit": { "type": "string", "description": "systemd unit name", "example": "exampled" }, "title": { "type": "string", "description": "Service title", "example": "Example Service Daemon" } } }, "description": "List of required services" } ] }, "hostname": { "type": "string", "description": "hostname used for the service", "example": "mail.example.org" }, "tls": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "is TLS enabled", "example": true }, "certificate": { "required": [ "id" ], "type": "object", "properties": { "automated": { "type": "boolean", "description": "Is `true` when certificate is automatically ordered\/renewed (e.g. with _Let's Encrypt_)", "default": false, "example": true }, "id": { "type": "string", "description": "Certificate id", "example": "1a2b3c" }, "name": { "type": "string", "description": "Certificate name (CommonName)", "example": "example.org" }, "san": { "type": "array", "items": { "type": "string" }, "description": "Array of additional names (SAN - Subject Alternative Name)", "example": [ "example.org", "www.example.org" ] }, "validFrom": { "type": "string", "description": "Certificate validity", "format": "date-time", "example": "2021-07-21T17:32:28Z" }, "validTo": { "type": "string", "description": "Certificate validity", "format": "date-time", "example": "2022-07-21T17:32:28Z" } } }, "force": { "type": "boolean", "description": "allow only TLS connections", "example": true }, "imaps": { "type": "boolean", "description": "enable implicit TLS ports (POP3S: 995 and IMAPS: 993)", "example": false }, "ciphers": { "enum": [ "strong", "compatible" ], "type": "string", "description": "the tls ciphers to be used", "example": "compatible" } }, "description": "TLS settings" }, "limits": { "type": "object", "properties": { "maxImapConnections": { "type": "integer", "description": "maximum parallel IMAP connections per user and IP", "example": 10, "min": 1, "max": 9999 }, "maxPop3Connections": { "type": "integer", "description": "maximum parallel POP3 connections per user and IP", "example": 5, "min": 1, "max": 9999 } }, "description": "Limit settings" }, "quotaWarning": { "type": "boolean", "description": "Enable warning email when mailbox quota is reached", "example": true }, "webmailUrl": { "type": "string", "description": "URL to a central webmail installation like roundcube", "example": "https:\/\/webmail.example.org" } }, "description": "POP3\/IMAP server settings" } }, "description": "POP3\/IMAP server settings" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Servers" ], "summary": "POP3\/IMAP service settings", "description": "Edit the POP3\/IMAP service settings", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" } ], "requestBody": { "description": "Settings to modify", "content": { "application\/json": { "schema": { "type": "object", "properties": { "managed": { "type": "boolean", "description": "Whether this service is managed by LiveConfig", "example": true }, "version": { "type": "string", "description": "Dovecot version", "readOnly": true, "example": "2.2.27" }, "packageVersion": { "type": "string", "description": "Version of software package", "readOnly": true, "example": "1:2.2.27-3+deb9u7" }, "config": { "type": "string", "description": "the configuration path", "readOnly": true, "example": "\/etc\/dovecot" }, "name": { "type": "string", "description": "name of the service", "readOnly": true, "example": "dovecot" }, "services": { "allOf": [ { "type": "array", "readOnly": true }, { "type": "array", "items": { "required": [ "name", "unit", "status" ], "type": "object", "properties": { "description": { "type": "string", "description": "Short description of that service's purpose", "example": "Flexible service for something important" }, "name": { "type": "string", "description": "Service name", "example": "example" }, "status": { "enum": [ "active", "activating", "inactive", "deactivating", "reloading", "failed", "invalid", "unknown" ], "type": "string", "description": "Current service status (from systemd)", "example": "running" }, "unit": { "type": "string", "description": "systemd unit name", "example": "exampled" }, "title": { "type": "string", "description": "Service title", "example": "Example Service Daemon" } } }, "description": "List of required services" } ] }, "hostname": { "type": "string", "description": "hostname used for the service", "example": "mail.example.org" }, "tls": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "is TLS enabled", "example": true }, "certificate": { "required": [ "id" ], "type": "object", "properties": { "automated": { "type": "boolean", "description": "Is `true` when certificate is automatically ordered\/renewed (e.g. with _Let's Encrypt_)", "default": false, "example": true }, "id": { "type": "string", "description": "Certificate id", "example": "1a2b3c" }, "name": { "type": "string", "description": "Certificate name (CommonName)", "example": "example.org" }, "san": { "type": "array", "items": { "type": "string" }, "description": "Array of additional names (SAN - Subject Alternative Name)", "example": [ "example.org", "www.example.org" ] }, "validFrom": { "type": "string", "description": "Certificate validity", "format": "date-time", "example": "2021-07-21T17:32:28Z" }, "validTo": { "type": "string", "description": "Certificate validity", "format": "date-time", "example": "2022-07-21T17:32:28Z" } } }, "force": { "type": "boolean", "description": "allow only TLS connections", "example": true }, "imaps": { "type": "boolean", "description": "enable implicit TLS ports (POP3S: 995 and IMAPS: 993)", "example": false }, "ciphers": { "enum": [ "strong", "compatible" ], "type": "string", "description": "the tls ciphers to be used", "example": "compatible" } }, "description": "TLS settings" }, "limits": { "type": "object", "properties": { "maxImapConnections": { "type": "integer", "description": "maximum parallel IMAP connections per user and IP", "example": 10, "min": 1, "max": 9999 }, "maxPop3Connections": { "type": "integer", "description": "maximum parallel POP3 connections per user and IP", "example": 5, "min": 1, "max": 9999 } }, "description": "Limit settings" }, "quotaWarning": { "type": "boolean", "description": "Enable warning email when mailbox quota is reached", "example": true }, "webmailUrl": { "type": "string", "description": "URL to a central webmail installation like roundcube", "example": "https:\/\/webmail.example.org" } }, "description": "POP3\/IMAP server settings" } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}\/mail\/smtp": { "get": { "tags": [ "Servers" ], "summary": "SMTP server settings", "description": "Returns all SMTP server settings", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" }, { "name": "show", "in": "query", "description": "comma-separated list of additional data to show (`ips`: list of available IP addresses)\n", "style": "form", "explode": false, "schema": { "type": "array", "items": { "enum": [ "ips" ], "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "allOf": [ { "type": "object", "properties": { "managed": { "type": "boolean", "description": "Whether this service is managed by LiveConfig", "example": true }, "version": { "type": "string", "description": "Postfix version", "readOnly": true, "example": "2.2.27" }, "packageVersion": { "type": "string", "description": "Version of software package", "readOnly": true, "example": "1:2.2.27-3+deb9u7" }, "config": { "type": "string", "description": "the configuration path", "readOnly": true, "example": "\/etc\/dovecot" }, "name": { "type": "string", "description": "name of the service", "readOnly": true, "example": "dovecot" }, "services": { "allOf": [ { "type": "array", "readOnly": true }, { "type": "array", "items": { "required": [ "name", "unit", "status" ], "type": "object", "properties": { "description": { "type": "string", "description": "Short description of that service's purpose", "example": "Flexible service for something important" }, "name": { "type": "string", "description": "Service name", "example": "example" }, "status": { "enum": [ "active", "activating", "inactive", "deactivating", "reloading", "failed", "invalid", "unknown" ], "type": "string", "description": "Current service status (from systemd)", "example": "running" }, "unit": { "type": "string", "description": "systemd unit name", "example": "exampled" }, "title": { "type": "string", "description": "Service title", "example": "Example Service Daemon" } } }, "description": "List of required services" } ] }, "hostname": { "type": "string", "description": "hostname used for the service", "example": "mail.example.org" }, "antivirus": { "type": "object", "properties": { "enabled": { "type": "string", "description": "Whether the antivirus software is enabled", "example": true }, "name": { "type": "string", "description": "Software name", "example": "ClamAV" }, "version": { "type": "string", "description": "Software version", "example": "0.103.5" } }, "description": "Antivirus software" }, "spamfilter": { "type": "object", "properties": { "enabled": { "type": "string", "description": "Whether the spam filter software is enabled", "example": true }, "name": { "type": "string", "description": "Software name", "example": "SpamAssassin" }, "version": { "type": "string", "description": "Software version", "example": "3.4.2" } }, "description": "Spam filter software" }, "greylisting": { "type": "object", "properties": { "enabled": { "type": "string", "description": "Whether the greylisting software is enabled", "example": true }, "name": { "type": "string", "description": "Software name", "example": "Postgrey" }, "version": { "type": "string", "description": "Software version", "example": 1.36 } }, "description": "Greylisting software" }, "denylists": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "wherer the denylists are enabled", "example": true }, "lists": { "type": "array", "items": { "type": "string" }, "description": "DNS-based deny lists (DNS-RBL, real-time blocking lists)", "example": [ "ix.dnsbl.manitu.net", "sbl-xbl.spamhaus.org", "b.barracudacentral.org" ] } } }, "allowlists": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "wherer the allowlists are enabled", "example": true }, "lists": { "type": "array", "items": { "type": "string" }, "description": "DNS-based allow lists (DNS-WL, real-time DNS whitelist). Hosts matched via one of these lists are only exempted from greylisting (= has no effect on spam filter or virus filter!).", "example": [ "list.dnswl.org=127.0.[0..255].[0..3]" ] } } }, "dane": { "type": "object", "properties": { "enabled": { "type": "string", "description": "Enable DANE\/TLSA", "example": true } }, "description": "DANE\/TLSA" }, "defaultSpfRecord": { "maxLength": 255, "type": "string", "description": "Default SPF record (if no other record is configured for a domain)", "example": "v=spf1 a mx ~all" }, "dkim": { "type": "object", "properties": { "enabled": { "type": "string", "description": "Whether the DKIM software is enabled", "example": true }, "name": { "type": "string", "description": "Software name", "readOnly": true, "example": "OpenDKIM" }, "version": { "type": "string", "description": "Software version", "readOnly": true, "example": "2.11.0" } }, "description": "DKIM software" }, "srs": { "type": "object", "properties": { "enabled": { "type": "string", "description": "Whether the SRS software is enabled", "example": true }, "name": { "type": "string", "description": "Software name", "readOnly": true, "example": "PostSRSd" }, "version": { "type": "string", "description": "Software version", "readOnly": true, "example": "2.0.10" } }, "description": "SRS software" }, "tls": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "is TLS enabled", "example": true }, "certificate": { "required": [ "id" ], "type": "object", "properties": { "automated": { "type": "boolean", "description": "Is `true` when certificate is automatically ordered\/renewed (e.g. with _Let's Encrypt_)", "default": false, "example": true }, "id": { "type": "string", "description": "Certificate id", "example": "1a2b3c" }, "name": { "type": "string", "description": "Certificate name (CommonName)", "example": "example.org" }, "san": { "type": "array", "items": { "type": "string" }, "description": "Array of additional names (SAN - Subject Alternative Name)", "example": [ "example.org", "www.example.org" ] }, "validFrom": { "type": "string", "description": "Certificate validity", "format": "date-time", "example": "2021-07-21T17:32:28Z" }, "validTo": { "type": "string", "description": "Certificate validity", "format": "date-time", "example": "2022-07-21T17:32:28Z" } } }, "force": { "type": "boolean", "description": "allow only TLS connections", "example": true }, "smtps": { "type": "boolean", "description": "enable non standard TLS port (SMTPS: 465)", "example": false }, "ciphers": { "enum": [ "strong", "compatible" ], "type": "string", "description": "the tls ciphers to be used", "example": "compatible" } }, "description": "TLS settings" }, "autodiscovery": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "wether autodiscovery is enabled", "example": true }, "host": { "type": "string", "description": "address of the autodiscovery host", "example": "autodiscovery.example.org" } } }, "ips": { "type": "object", "properties": { "inbound": { "type": "object", "properties": { "mode": { "enum": [ "all", "allv4", "allv6", "selected" ], "type": "string", "description": "mode to select inbound IPs", "example": "selected" } }, "description": "Settings for inbound IPs" }, "outbound": { "type": "object", "description": "Settings for outbound IPs", "properties": null } } }, "limitOutbound": { "type": "boolean", "description": "Whether outbound mail limiting is enabled", "example": true }, "maxSize": { "maximum": 256, "minimum": 1, "type": "integer", "description": "Maximum allowed e-mail size (MB)", "example": 25 }, "allowCatchall": { "type": "boolean", "description": "Whether catchall email addresses are allowed", "example": false }, "allowSuffixExtension": { "type": "boolean", "description": "Whether address extension is allowed (sub-addresses, VERP style)", "example": false }, "allowArchivingInbound": { "type": "boolean", "description": "Whether archiving of inbound emails (via BCC) is allowed", "example": true }, "allowArchivingOutbound": { "type": "boolean", "description": "Whether archiving of outbound emails (via BCC) is allowed", "example": true }, "differingMx": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether an alternate MX entry is used" }, "mx1": { "type": "object", "properties": { "host": { "maxLength": 255, "type": "string", "description": "Hostname for the MX entry", "example": "mail1.example.org" }, "prio": { "type": "integer", "description": "priority of the alternate MX entry", "example": 10, "min": 0, "max": 65535 } }, "description": "Settings for the first alternate MX entry" }, "mx2": { "type": "object", "properties": { "host": { "maxLength": 255, "type": "string", "description": "Hostname for the MX entry", "example": "mail2.example.org" }, "prio": { "type": "integer", "description": "priority of the alternate MX entry", "example": 20, "min": 0, "max": 65535 } }, "description": "Settings for the second alternate MX entry" } } } }, "description": "SMTP server settings" }, { "type": "object", "properties": { "ips": { "type": "object", "properties": { "available": { "type": "array", "items": { "required": [ "address", "netmask", "version", "found" ], "type": "object", "properties": { "version": { "enum": [ 4, 6 ], "type": "integer", "description": "version of the IP address", "readOnly": true, "example": 4 }, "address": { "type": "string", "description": "IPv4\/IPv6 address", "readOnly": true, "example": "192.168.0.123" }, "netmask": { "type": "integer", "description": "netmask of the IP address", "readOnly": true, "example": 24 }, "found": { "type": "boolean", "description": "flag if the address was found by LiveConfig", "readOnly": true, "example": true }, "interface": { "type": "string", "description": "name of the interface the IP is configured at", "readOnly": true, "example": "eth0" }, "natAddress": { "type": "string", "description": "user configured alternative IP address mapping (used for dNATed servers)", "example": "203.0.113.123" } } }, "description": "list of all available IP addresses (returned only with `show=ips`)" }, "inbound": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "required": [ "address", "netmask", "version", "found" ], "type": "object", "properties": { "version": { "enum": [ 4, 6 ], "type": "integer", "description": "version of the IP address", "readOnly": true, "example": 4 }, "address": { "type": "string", "description": "IPv4\/IPv6 address", "readOnly": true, "example": "192.168.0.123" }, "netmask": { "type": "integer", "description": "netmask of the IP address", "readOnly": true, "example": 24 }, "found": { "type": "boolean", "description": "flag if the address was found by LiveConfig", "readOnly": true, "example": true }, "interface": { "type": "string", "description": "name of the interface the IP is configured at", "readOnly": true, "example": "eth0" }, "natAddress": { "type": "string", "description": "user configured alternative IP address mapping (used for dNATed servers)", "example": "203.0.113.123" } } }, "description": "list of all IP addresses for inbound connections", "readOnly": true } } }, "outbound": { "type": "object", "properties": { "v4": { "required": [ "address", "netmask", "version", "found" ], "type": "object", "properties": { "version": { "enum": [ 4, 6 ], "type": "integer", "description": "version of the IP address", "readOnly": true, "example": 4 }, "address": { "type": "string", "description": "IPv4\/IPv6 address", "readOnly": true, "example": "192.168.0.123" }, "netmask": { "type": "integer", "description": "netmask of the IP address", "readOnly": true, "example": 24 }, "found": { "type": "boolean", "description": "flag if the address was found by LiveConfig", "readOnly": true, "example": true }, "interface": { "type": "string", "description": "name of the interface the IP is configured at", "readOnly": true, "example": "eth0" }, "natAddress": { "type": "string", "description": "user configured alternative IP address mapping (used for dNATed servers)", "example": "203.0.113.123" } } }, "v6": { "allOf": [ { "required": [ "address", "netmask", "version", "found" ], "type": "object", "properties": { "version": { "enum": [ 4, 6 ], "type": "integer", "description": "version of the IP address", "readOnly": true, "example": 4 }, "address": { "type": "string", "description": "IPv4\/IPv6 address", "readOnly": true, "example": "192.168.0.123" }, "netmask": { "type": "integer", "description": "netmask of the IP address", "readOnly": true, "example": 24 }, "found": { "type": "boolean", "description": "flag if the address was found by LiveConfig", "readOnly": true, "example": true }, "interface": { "type": "string", "description": "name of the interface the IP is configured at", "readOnly": true, "example": "eth0" }, "natAddress": { "type": "string", "description": "user configured alternative IP address mapping (used for dNATed servers)", "example": "203.0.113.123" } } }, { "readOnly": true, "example": { "version": 6, "address": "2001:0db8:85a3:08d3::0370:7344", "netmask": 56, "found": true, "interface": "eth0" } } ] } } } } } } } ] } }, "description": "SMTP server settings" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Servers" ], "summary": "SMTP service settings", "description": "Edit the SMTP service settings", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" } ], "requestBody": { "description": "Settings to modify", "content": { "application\/json": { "schema": { "allOf": [ { "type": "object", "properties": { "managed": { "type": "boolean", "description": "Whether this service is managed by LiveConfig", "example": true }, "version": { "type": "string", "description": "Postfix version", "readOnly": true, "example": "2.2.27" }, "packageVersion": { "type": "string", "description": "Version of software package", "readOnly": true, "example": "1:2.2.27-3+deb9u7" }, "config": { "type": "string", "description": "the configuration path", "readOnly": true, "example": "\/etc\/dovecot" }, "name": { "type": "string", "description": "name of the service", "readOnly": true, "example": "dovecot" }, "services": { "allOf": [ { "type": "array", "readOnly": true }, { "type": "array", "items": { "required": [ "name", "unit", "status" ], "type": "object", "properties": { "description": { "type": "string", "description": "Short description of that service's purpose", "example": "Flexible service for something important" }, "name": { "type": "string", "description": "Service name", "example": "example" }, "status": { "enum": [ "active", "activating", "inactive", "deactivating", "reloading", "failed", "invalid", "unknown" ], "type": "string", "description": "Current service status (from systemd)", "example": "running" }, "unit": { "type": "string", "description": "systemd unit name", "example": "exampled" }, "title": { "type": "string", "description": "Service title", "example": "Example Service Daemon" } } }, "description": "List of required services" } ] }, "hostname": { "type": "string", "description": "hostname used for the service", "example": "mail.example.org" }, "antivirus": { "type": "object", "properties": { "enabled": { "type": "string", "description": "Whether the antivirus software is enabled", "example": true }, "name": { "type": "string", "description": "Software name", "example": "ClamAV" }, "version": { "type": "string", "description": "Software version", "example": "0.103.5" } }, "description": "Antivirus software" }, "spamfilter": { "type": "object", "properties": { "enabled": { "type": "string", "description": "Whether the spam filter software is enabled", "example": true }, "name": { "type": "string", "description": "Software name", "example": "SpamAssassin" }, "version": { "type": "string", "description": "Software version", "example": "3.4.2" } }, "description": "Spam filter software" }, "greylisting": { "type": "object", "properties": { "enabled": { "type": "string", "description": "Whether the greylisting software is enabled", "example": true }, "name": { "type": "string", "description": "Software name", "example": "Postgrey" }, "version": { "type": "string", "description": "Software version", "example": 1.36 } }, "description": "Greylisting software" }, "denylists": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "wherer the denylists are enabled", "example": true }, "lists": { "type": "array", "items": { "type": "string" }, "description": "DNS-based deny lists (DNS-RBL, real-time blocking lists)", "example": [ "ix.dnsbl.manitu.net", "sbl-xbl.spamhaus.org", "b.barracudacentral.org" ] } } }, "allowlists": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "wherer the allowlists are enabled", "example": true }, "lists": { "type": "array", "items": { "type": "string" }, "description": "DNS-based allow lists (DNS-WL, real-time DNS whitelist). Hosts matched via one of these lists are only exempted from greylisting (= has no effect on spam filter or virus filter!).", "example": [ "list.dnswl.org=127.0.[0..255].[0..3]" ] } } }, "dane": { "type": "object", "properties": { "enabled": { "type": "string", "description": "Enable DANE\/TLSA", "example": true } }, "description": "DANE\/TLSA" }, "defaultSpfRecord": { "maxLength": 255, "type": "string", "description": "Default SPF record (if no other record is configured for a domain)", "example": "v=spf1 a mx ~all" }, "dkim": { "type": "object", "properties": { "enabled": { "type": "string", "description": "Whether the DKIM software is enabled", "example": true }, "name": { "type": "string", "description": "Software name", "readOnly": true, "example": "OpenDKIM" }, "version": { "type": "string", "description": "Software version", "readOnly": true, "example": "2.11.0" } }, "description": "DKIM software" }, "srs": { "type": "object", "properties": { "enabled": { "type": "string", "description": "Whether the SRS software is enabled", "example": true }, "name": { "type": "string", "description": "Software name", "readOnly": true, "example": "PostSRSd" }, "version": { "type": "string", "description": "Software version", "readOnly": true, "example": "2.0.10" } }, "description": "SRS software" }, "tls": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "is TLS enabled", "example": true }, "certificate": { "required": [ "id" ], "type": "object", "properties": { "automated": { "type": "boolean", "description": "Is `true` when certificate is automatically ordered\/renewed (e.g. with _Let's Encrypt_)", "default": false, "example": true }, "id": { "type": "string", "description": "Certificate id", "example": "1a2b3c" }, "name": { "type": "string", "description": "Certificate name (CommonName)", "example": "example.org" }, "san": { "type": "array", "items": { "type": "string" }, "description": "Array of additional names (SAN - Subject Alternative Name)", "example": [ "example.org", "www.example.org" ] }, "validFrom": { "type": "string", "description": "Certificate validity", "format": "date-time", "example": "2021-07-21T17:32:28Z" }, "validTo": { "type": "string", "description": "Certificate validity", "format": "date-time", "example": "2022-07-21T17:32:28Z" } } }, "force": { "type": "boolean", "description": "allow only TLS connections", "example": true }, "smtps": { "type": "boolean", "description": "enable non standard TLS port (SMTPS: 465)", "example": false }, "ciphers": { "enum": [ "strong", "compatible" ], "type": "string", "description": "the tls ciphers to be used", "example": "compatible" } }, "description": "TLS settings" }, "autodiscovery": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "wether autodiscovery is enabled", "example": true }, "host": { "type": "string", "description": "address of the autodiscovery host", "example": "autodiscovery.example.org" } } }, "ips": { "type": "object", "properties": { "inbound": { "type": "object", "properties": { "mode": { "enum": [ "all", "allv4", "allv6", "selected" ], "type": "string", "description": "mode to select inbound IPs", "example": "selected" } }, "description": "Settings for inbound IPs" }, "outbound": { "type": "object", "description": "Settings for outbound IPs", "properties": null } } }, "limitOutbound": { "type": "boolean", "description": "Whether outbound mail limiting is enabled", "example": true }, "maxSize": { "maximum": 256, "minimum": 1, "type": "integer", "description": "Maximum allowed e-mail size (MB)", "example": 25 }, "allowCatchall": { "type": "boolean", "description": "Whether catchall email addresses are allowed", "example": false }, "allowSuffixExtension": { "type": "boolean", "description": "Whether address extension is allowed (sub-addresses, VERP style)", "example": false }, "allowArchivingInbound": { "type": "boolean", "description": "Whether archiving of inbound emails (via BCC) is allowed", "example": true }, "allowArchivingOutbound": { "type": "boolean", "description": "Whether archiving of outbound emails (via BCC) is allowed", "example": true }, "differingMx": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether an alternate MX entry is used" }, "mx1": { "type": "object", "properties": { "host": { "maxLength": 255, "type": "string", "description": "Hostname for the MX entry", "example": "mail1.example.org" }, "prio": { "type": "integer", "description": "priority of the alternate MX entry", "example": 10, "min": 0, "max": 65535 } }, "description": "Settings for the first alternate MX entry" }, "mx2": { "type": "object", "properties": { "host": { "maxLength": 255, "type": "string", "description": "Hostname for the MX entry", "example": "mail2.example.org" }, "prio": { "type": "integer", "description": "priority of the alternate MX entry", "example": 20, "min": 0, "max": 65535 } }, "description": "Settings for the second alternate MX entry" } } } }, "description": "SMTP server settings" }, { "type": "object", "properties": { "ips": { "type": "object", "properties": { "inbound": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "description": "IPs selected for inbound connections", "example": "203.0.113.123" }, "description": "list of all IP addresses for inbound connections" } } }, "outbound": { "type": "object", "properties": { "v4": { "type": "string", "description": "IP selected for outbound IPv4 connections", "example": "203.0.113.123" }, "v6": { "type": "string", "description": "IP selected for outbound IPv6 connections (if empty IPv6 is disabled)", "example": "2001:0db8:85a3:08d3::0370:7344" } } } } } } } ] } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}\/processes": { "get": { "tags": [ "Servers" ], "summary": "Process list", "description": "Returns a list of all active processes.", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "required": [ "pid" ], "type": "object", "properties": { "cmd": { "type": "string", "description": "Command (process name)", "example": "apache" }, "cmdline": { "type": "string", "description": "commandline of the program", "example": "\/usr\/sbin\/apache2 -k start" }, "pid": { "type": "integer", "description": "Process id", "example": 123 }, "euser": { "type": "string", "description": "Effective user name", "example": "www-data" }, "egroup": { "type": "string", "description": "effective group name", "example": "www-data" }, "ruser": { "type": "string", "description": "Real user name (might differ from `euser`)", "example": "root" }, "rgroup": { "type": "string", "description": "Real group name (might differ from `egroup`)", "example": "root" }, "resKb": { "type": "integer", "description": "resident non-swapped memory in kb", "example": 11704 }, "virtKb": { "type": "integer", "description": "total virtual memory in kb", "example": 50592 }, "stime": { "type": "integer", "description": "kernel-mode CPU time accumulated by process", "example": 62 }, "utime": { "type": "integer", "description": "user-mode CPU time accumulated by process", "example": 149 } } } } }, "description": "Process list" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}\/services\/{service}\/status": { "get": { "tags": [ "Servers" ], "summary": "Get service status", "description": "Return current status of given service", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" }, { "name": "service", "in": "path", "description": "Service name", "required": true, "schema": { "type": "string" }, "example": "apache" } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "required": [ "status" ], "type": "object", "properties": { "status": { "enum": [ "active", "activating", "inactive", "deactivating", "reloading", "failed", "invalid", "unknown" ], "type": "string", "description": "current status of the service", "example": "running" } } } }, "description": "Service status" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Servers" ], "summary": "Control service", "description": "Control the service", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" }, { "name": "service", "in": "path", "description": "Service name", "required": true, "schema": { "type": "string" }, "example": "apache" } ], "requestBody": { "description": "JSON object with service command", "content": { "application\/json": { "schema": { "required": [ "action" ], "type": "object", "properties": { "action": { "enum": [ "start", "stop", "restart", "reload" ], "type": "string", "description": "service action", "example": "restart" } } } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}\/services\/{service}\/log": { "get": { "tags": [ "Servers" ], "summary": "Get service log", "description": "Get log of the Service", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" }, { "name": "service", "in": "path", "description": "Service name", "required": true, "schema": { "type": "string" }, "example": "apache" }, { "name": "lines", "in": "query", "description": "maximum number of log lines returned", "required": false, "schema": { "type": "integer" }, "default": 8 } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "required": [ "lines" ], "type": "object", "properties": { "lines": { "type": "array", "items": { "type": "string", "example": "2022-04-21 09:14:29 Started Apache2" }, "description": "logfile lines" } } } }, "description": "Server log" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}\/stats\/cpu\/{range}": { "get": { "tags": [ "Servers" ], "summary": "CPU statistics", "description": "Return statistics on CPU usage", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" }, { "name": "range", "in": "query", "description": "requested statistic time range", "required": false, "schema": { "enum": [ "hour", "day", "week" ], "type": "string", "default": "hour" }, "example": "day" } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "required": [ "from", "to", "data" ], "type": "object", "properties": { "servers": { "type": "object", "properties": { "from": { "type": "integer", "description": "UNIX epoch timestamp of first element" }, "to": { "type": "integer", "description": "UNIX epoch timestamp of last element" }, "data": { "type": "array", "items": { "required": [ "guest", "idle", "irq", "nice", "sirq", "steal", "sys", "ts", "user", "wait" ], "type": "object", "properties": { "guest": { "type": "number", "description": "Time spent for running a virtual CPU or guest OS under the control of the kernel" }, "idle": { "type": "number", "description": "Idle time" }, "irq": { "type": "number", "description": "Time spent serving hardware interrupts" }, "nice": { "type": "number", "description": "Time spent in user mode with low priority (nice)" }, "sirq": { "type": "number", "description": "Time spent serving software interrupts" }, "steal": { "type": "number", "description": "Time \"stolen\" by other operating systems running in a virtual environment" }, "sys": { "type": "number", "description": "Time spent running in kernel mode (percent)" }, "ts": { "type": "integer", "description": "UNIX epoch timestamp" }, "user": { "type": "number", "description": "Time spent with normal processing in user mode (percent)" }, "wait": { "type": "number", "description": "Time spent waiting for I\/O operations to complete" } } }, "description": "Array with statistics data, sorted by timestamp (`ts`)" } } } } } }, "description": "CPU usage statistics" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}\/stats\/net\/{interface}\/{range}": { "get": { "tags": [ "Servers" ], "summary": "Network I\/O statistics", "description": "Return statistics on network usage", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" }, { "name": "interface", "in": "path", "description": "Interface name", "required": true, "schema": { "type": "string" }, "example": "eth0" }, { "name": "range", "in": "query", "description": "requested statistic time range", "required": false, "schema": { "enum": [ "hour", "day", "week" ], "type": "string", "default": "hour" }, "example": "day" } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "required": [ "from", "to", "data" ], "type": "object", "properties": { "servers": { "type": "object", "properties": { "from": { "type": "integer", "description": "UNIX epoch timestamp of first element" }, "to": { "type": "integer", "description": "UNIX epoch timestamp of last element" }, "data": { "type": "array", "items": { "required": [ "in", "out", "ts" ], "type": "object", "properties": { "in": { "type": "number", "description": "Number of bytes received" }, "out": { "type": "number", "description": "Number of bytes sent" }, "ts": { "type": "integer", "description": "UNIX epoch timestamp" } } }, "description": "Array with statistics data, sorted by timestamp (`ts`)" } } } } } }, "description": "Network usage statistics" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}\/web": { "get": { "tags": [ "Servers" ], "summary": "Get web server settings", "description": "Returns all web server settings", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "services": { "type": "array", "items": { "type": "array", "items": { "required": [ "name", "unit", "status" ], "type": "object", "properties": { "description": { "type": "string", "description": "Short description of that service's purpose", "example": "Flexible service for something important" }, "name": { "type": "string", "description": "Service name", "example": "example" }, "status": { "enum": [ "active", "activating", "inactive", "deactivating", "reloading", "failed", "invalid", "unknown" ], "type": "string", "description": "Current service status (from systemd)", "example": "running" }, "unit": { "type": "string", "description": "systemd unit name", "example": "exampled" }, "title": { "type": "string", "description": "Service title", "example": "Example Service Daemon" } } }, "description": "List of required services" } }, "webservers": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "name": { "enum": [ "apache", "nginx" ], "type": "string", "description": "name of the webserver software", "readOnly": true, "example": "apache" }, "managed": { "type": "boolean", "description": "whether this server is managed by LiveConfig", "example": true }, "pkgVersion": { "type": "string", "description": "package version of the Webserver", "readOnly": true, "example": "2.4.38-3+deb10u8" }, "version": { "type": "string", "description": "webserver software version", "readOnly": true, "example": "2.4.38" }, "reverseProxy": { "type": "boolean", "description": "listen on `localhost` for reverse proxy requests", "example": true }, "modules": { "type": "array", "items": { "type": "string", "description": "modulename", "example": "rewrite" }, "description": "list of modules enabled on the server", "readOnly": true } } }, { "type": "object", "properties": { "ips": { "type": "array", "items": { "required": [ "address", "netmask", "version", "found" ], "type": "object", "properties": { "version": { "enum": [ 4, 6 ], "type": "integer", "description": "version of the IP address", "readOnly": true, "example": 4 }, "address": { "type": "string", "description": "IPv4\/IPv6 address", "readOnly": true, "example": "192.168.0.123" }, "netmask": { "type": "integer", "description": "netmask of the IP address", "readOnly": true, "example": 24 }, "found": { "type": "boolean", "description": "flag if the address was found by LiveConfig", "readOnly": true, "example": true }, "interface": { "type": "string", "description": "name of the interface the IP is configured at", "readOnly": true, "example": "eth0" }, "natAddress": { "type": "string", "description": "user configured alternative IP address mapping (used for dNATed servers)", "example": "203.0.113.123" } } } }, "ipGroups": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "name of this IP group", "example": "default" }, "software": { "enum": [ "apache", "nginx" ], "type": "string", "description": "web server software this IP group is assigned to", "readOnly": true, "example": "apache" } } }, { "type": "object", "properties": { "id": { "type": "string", "description": "the id of the IP group", "readOnly": true, "example": null }, "account": { "type": "string", "description": "name of the account this IP group is assigned to (only if `type == exclusive`)", "example": null }, "domainCount": { "type": "integer", "description": "count of domains that are configured with this IP group", "readOnly": true, "example": 10 }, "tlsDomainCount": { "type": "integer", "description": "count of TLS-enabled domains that are configured with this IP group", "readOnly": true, "example": 20 }, "type": { "enum": [ "exclusive", "shared" ], "type": "string", "description": "defines if this IP group is shared or exclusive (for one customer)", "example": "shared" }, "tls": { "type": "boolean", "description": "is TLS\/SSL enabled for this IP group", "example": true }, "tlsCiphers": { "enum": [ "compatible", "strong" ], "type": "string", "description": "TLS ciphers used by this IP group", "example": "compatible" }, "disableTls1": { "type": "boolean", "description": "are old protocols (like TLS 1.0\/1.1) disabled with this IP group", "example": true }, "http2": { "type": "boolean", "description": "is HTTP\/2 available with this IP group", "example": true }, "noDns": { "type": "boolean", "description": "don't add new added IPs to the DNS server", "writeOnly": true, "example": false }, "allowReverseProxy": { "type": "boolean", "description": "allow the web server software to bind on 127.0.0.1 to be available behind a reverse proxy", "example": false } } } ] } } } } ] } }, "webruntimes": { "type": "array", "items": { "required": [ "lang", "code", "version" ], "type": "object", "properties": { "lang": { "type": "string", "description": "name of the web runtime language", "readOnly": true, "example": "PHP" }, "code": { "type": "string", "description": "code to uniquely identify the web runtime language", "readOnly": true, "example": "php74" }, "version": { "type": "string", "description": "version of the web runtime language", "readOnly": true, "example": "7.4.3" }, "prio": { "type": "integer", "description": "sort priority of the web runtime language", "readOnly": true, "example": 10 }, "found": { "type": "boolean", "description": "flag if the runtime was found by LiveConfig", "readOnly": true, "example": true }, "usage": { "type": "integer", "description": "number of subdomains using this web runtime", "readOnly": true, "example": 42 }, "api": { "type": "array", "items": { "enum": [ "FastCGI", "FPM" ], "type": "string", "example": "FPM" }, "description": "available APIs of the web runtime language", "readOnly": true }, "eolDate": { "type": "string", "description": "EOL date of the web runtime language", "format": "date", "nullable": true, "example": "2024-12-31" }, "comment": { "type": "string", "description": "comment that is displayed within the selection box of the GUI", "example": "recommended" }, "restricted": { "type": "boolean", "description": "if set to `true` this runtime can't be used for new or changed configurations", "example": false } } } } } } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}\/web\/{sw}": { "get": { "tags": [ "Servers" ], "summary": "Get web server settings (details)", "description": "Returns the detailed settings of a specific web server", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" }, { "name": "sw", "in": "path", "description": "Name of the web server software", "required": true, "schema": { "type": "string" }, "example": "apache", "enum": [ "apache", "nginx" ] } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "ips": { "type": "array", "items": { "required": [ "address", "netmask", "version", "found" ], "type": "object", "properties": { "version": { "enum": [ 4, 6 ], "type": "integer", "description": "version of the IP address", "readOnly": true, "example": 4 }, "address": { "type": "string", "description": "IPv4\/IPv6 address", "readOnly": true, "example": "192.168.0.123" }, "netmask": { "type": "integer", "description": "netmask of the IP address", "readOnly": true, "example": 24 }, "found": { "type": "boolean", "description": "flag if the address was found by LiveConfig", "readOnly": true, "example": true }, "interface": { "type": "string", "description": "name of the interface the IP is configured at", "readOnly": true, "example": "eth0" }, "natAddress": { "type": "string", "description": "user configured alternative IP address mapping (used for dNATed servers)", "example": "203.0.113.123" } } }, "description": "IP addresses assigned to selected web server" }, "otherIps": { "type": "array", "items": { "allOf": [ { "required": [ "address", "netmask", "version", "found" ], "type": "object", "properties": { "version": { "enum": [ 4, 6 ], "type": "integer", "description": "version of the IP address", "readOnly": true, "example": 4 }, "address": { "type": "string", "description": "IPv4\/IPv6 address", "readOnly": true, "example": "192.168.0.123" }, "netmask": { "type": "integer", "description": "netmask of the IP address", "readOnly": true, "example": 24 }, "found": { "type": "boolean", "description": "flag if the address was found by LiveConfig", "readOnly": true, "example": true }, "interface": { "type": "string", "description": "name of the interface the IP is configured at", "readOnly": true, "example": "eth0" }, "natAddress": { "type": "string", "description": "user configured alternative IP address mapping (used for dNATed servers)", "example": "203.0.113.123" } } }, { "type": "object", "properties": { "available": { "type": "boolean", "description": "is `false` if this IP is not available (i.e. already assigned to another web server)", "example": true } } } ] }, "description": "all other IP addresses on the server" }, "reverseProxy": { "type": "boolean", "description": "Configure this server for use by reverse proxy (bind to `127.0.0.1`). \nIf this property is not set (neither `true` nor `false`), it is not available with the selected web server.\n", "example": true } } } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Servers" ], "summary": "Edit web server settings", "description": "Configure Web server. \nIf web server is initially enabled, and only one IPv4 and\/op IPv6 address exists on the server (and no `ips` parameter is submitted), the server is automatically configured with the\navailable IPv4 and\/or IPv6 address (a `default` IP group is created automatically). \nAlso, if the IP list of a web server is modified and no IP group exists (yet\/anymore) for that web server, a new `default` group will be automatically created, with the list of enabled IP addresses.\n", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" }, { "name": "sw", "in": "path", "description": "Name of the web server software", "required": true, "schema": { "type": "string" }, "example": "apache", "enum": [ "apache", "nginx" ] } ], "requestBody": { "description": "web server settings to be modified", "content": { "application\/json": { "schema": { "allOf": [ { "type": "object", "properties": { "name": { "enum": [ "apache", "nginx" ], "type": "string", "description": "name of the webserver software", "readOnly": true, "example": "apache" }, "managed": { "type": "boolean", "description": "whether this server is managed by LiveConfig", "example": true }, "pkgVersion": { "type": "string", "description": "package version of the Webserver", "readOnly": true, "example": "2.4.38-3+deb10u8" }, "version": { "type": "string", "description": "webserver software version", "readOnly": true, "example": "2.4.38" }, "reverseProxy": { "type": "boolean", "description": "listen on `localhost` for reverse proxy requests", "example": true }, "modules": { "type": "array", "items": { "type": "string", "description": "modulename", "example": "rewrite" }, "description": "list of modules enabled on the server", "readOnly": true } } }, { "type": "object", "properties": { "ips": { "type": "array", "items": { "type": "string", "description": "IP address", "example": "198.51.100.42" } } } } ] } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}\/web\/{sw}\/ipgroups": { "post": { "tags": [ "Servers" ], "summary": "Add new IP group", "description": "This method adds a new IP group.", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" }, { "name": "sw", "in": "path", "description": "Name of the web server software", "required": true, "schema": { "type": "string" }, "example": "apache", "enum": [ "apache", "nginx" ] } ], "requestBody": { "description": "Data of new IP group", "content": { "application\/json": { "schema": { "allOf": [ { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "name of this IP group", "example": "default" }, "software": { "enum": [ "apache", "nginx" ], "type": "string", "description": "web server software this IP group is assigned to", "readOnly": true, "example": "apache" } } }, { "type": "object", "properties": { "id": { "type": "string", "description": "the id of the IP group", "readOnly": true, "example": null }, "account": { "type": "string", "description": "name of the account this IP group is assigned to (only if `type == exclusive`)", "example": null }, "domainCount": { "type": "integer", "description": "count of domains that are configured with this IP group", "readOnly": true, "example": 10 }, "tlsDomainCount": { "type": "integer", "description": "count of TLS-enabled domains that are configured with this IP group", "readOnly": true, "example": 20 }, "type": { "enum": [ "exclusive", "shared" ], "type": "string", "description": "defines if this IP group is shared or exclusive (for one customer)", "example": "shared" }, "tls": { "type": "boolean", "description": "is TLS\/SSL enabled for this IP group", "example": true }, "tlsCiphers": { "enum": [ "compatible", "strong" ], "type": "string", "description": "TLS ciphers used by this IP group", "example": "compatible" }, "disableTls1": { "type": "boolean", "description": "are old protocols (like TLS 1.0\/1.1) disabled with this IP group", "example": true }, "http2": { "type": "boolean", "description": "is HTTP\/2 available with this IP group", "example": true }, "noDns": { "type": "boolean", "description": "don't add new added IPs to the DNS server", "writeOnly": true, "example": false }, "allowReverseProxy": { "type": "boolean", "description": "allow the web server software to bind on 127.0.0.1 to be available behind a reverse proxy", "example": false } } } ] }, { "required": [ "name", "type", "software", "tls", "ips" ], "type": "object", "properties": { "ips": { "type": "array", "items": { "type": "string", "format": "IpAddress", "example": "203.0.113.123" }, "description": "list of all IP addresses in this group", "writeOnly": true } } } ] } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}\/web\/{sw}\/ipgroups\/{name}": { "get": { "tags": [ "Servers" ], "summary": "IP group details", "description": "Get details of an IP group.", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" }, { "name": "name", "in": "path", "description": "IP group name", "required": true, "schema": { "type": "string" }, "example": "default" }, { "name": "sw", "in": "path", "description": "Name of the web server software", "required": true, "schema": { "type": "string" }, "example": "apache", "enum": [ "apache", "nginx" ] } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "allOf": [ { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "name of this IP group", "example": "default" }, "software": { "enum": [ "apache", "nginx" ], "type": "string", "description": "web server software this IP group is assigned to", "readOnly": true, "example": "apache" } } }, { "type": "object", "properties": { "id": { "type": "string", "description": "the id of the IP group", "readOnly": true, "example": null }, "account": { "type": "string", "description": "name of the account this IP group is assigned to (only if `type == exclusive`)", "example": null }, "domainCount": { "type": "integer", "description": "count of domains that are configured with this IP group", "readOnly": true, "example": 10 }, "tlsDomainCount": { "type": "integer", "description": "count of TLS-enabled domains that are configured with this IP group", "readOnly": true, "example": 20 }, "type": { "enum": [ "exclusive", "shared" ], "type": "string", "description": "defines if this IP group is shared or exclusive (for one customer)", "example": "shared" }, "tls": { "type": "boolean", "description": "is TLS\/SSL enabled for this IP group", "example": true }, "tlsCiphers": { "enum": [ "compatible", "strong" ], "type": "string", "description": "TLS ciphers used by this IP group", "example": "compatible" }, "disableTls1": { "type": "boolean", "description": "are old protocols (like TLS 1.0\/1.1) disabled with this IP group", "example": true }, "http2": { "type": "boolean", "description": "is HTTP\/2 available with this IP group", "example": true }, "noDns": { "type": "boolean", "description": "don't add new added IPs to the DNS server", "writeOnly": true, "example": false }, "allowReverseProxy": { "type": "boolean", "description": "allow the web server software to bind on 127.0.0.1 to be available behind a reverse proxy", "example": false } } } ] }, { "type": "object", "properties": { "ips": { "type": "array", "items": { "required": [ "address", "netmask", "version", "found" ], "type": "object", "properties": { "version": { "enum": [ 4, 6 ], "type": "integer", "description": "version of the IP address", "readOnly": true, "example": 4 }, "address": { "type": "string", "description": "IPv4\/IPv6 address", "readOnly": true, "example": "192.168.0.123" }, "netmask": { "type": "integer", "description": "netmask of the IP address", "readOnly": true, "example": 24 }, "found": { "type": "boolean", "description": "flag if the address was found by LiveConfig", "readOnly": true, "example": true }, "interface": { "type": "string", "description": "name of the interface the IP is configured at", "readOnly": true, "example": "eth0" }, "natAddress": { "type": "string", "description": "user configured alternative IP address mapping (used for dNATed servers)", "example": "203.0.113.123" } } }, "description": "list of all IPs in this IP group", "readOnly": true } } } ] } }, "description": "IP group details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Servers" ], "summary": "Remove an IP group", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" }, { "name": "name", "in": "path", "description": "the name of the IP group", "required": true, "schema": { "type": "string" } }, { "name": "sw", "in": "path", "description": "Name of the web server software", "required": true, "schema": { "type": "string" }, "example": "apache", "enum": [ "apache", "nginx" ] } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Servers" ], "summary": "Edit IP group", "description": "Edit an IP group.", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" }, { "name": "name", "in": "path", "description": "IP group name", "required": true, "schema": { "type": "string" }, "example": "default" }, { "name": "sw", "in": "path", "description": "Name of the web server software", "required": true, "schema": { "type": "string" }, "example": "apache", "enum": [ "apache", "nginx" ] } ], "requestBody": { "description": "IP group data to be modified", "content": { "application\/json": { "schema": { "allOf": [ { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "name of this IP group", "example": "default" }, "software": { "enum": [ "apache", "nginx" ], "type": "string", "description": "web server software this IP group is assigned to", "readOnly": true, "example": "apache" } } }, { "type": "object", "properties": { "id": { "type": "string", "description": "the id of the IP group", "readOnly": true, "example": null }, "account": { "type": "string", "description": "name of the account this IP group is assigned to (only if `type == exclusive`)", "example": null }, "domainCount": { "type": "integer", "description": "count of domains that are configured with this IP group", "readOnly": true, "example": 10 }, "tlsDomainCount": { "type": "integer", "description": "count of TLS-enabled domains that are configured with this IP group", "readOnly": true, "example": 20 }, "type": { "enum": [ "exclusive", "shared" ], "type": "string", "description": "defines if this IP group is shared or exclusive (for one customer)", "example": "shared" }, "tls": { "type": "boolean", "description": "is TLS\/SSL enabled for this IP group", "example": true }, "tlsCiphers": { "enum": [ "compatible", "strong" ], "type": "string", "description": "TLS ciphers used by this IP group", "example": "compatible" }, "disableTls1": { "type": "boolean", "description": "are old protocols (like TLS 1.0\/1.1) disabled with this IP group", "example": true }, "http2": { "type": "boolean", "description": "is HTTP\/2 available with this IP group", "example": true }, "noDns": { "type": "boolean", "description": "don't add new added IPs to the DNS server", "writeOnly": true, "example": false }, "allowReverseProxy": { "type": "boolean", "description": "allow the web server software to bind on 127.0.0.1 to be available behind a reverse proxy", "example": false } } } ] }, { "type": "object", "properties": { "ips": { "type": "array", "items": { "type": "string", "format": "IpAddress", "example": "203.0.113.123" }, "description": "list of all IPs in this group", "writeOnly": true } } } ] } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}\/ips": { "get": { "tags": [ "Servers" ], "summary": "Get IP address list", "description": "This method returns a list of all IP addresses of a server.", "parameters": [ { "name": "count", "in": "query", "description": "number of results to return", "schema": { "minimum": 1, "type": "integer" } }, { "name": "page", "in": "query", "description": "page to return (offset), starting with `1`", "schema": { "minimum": 1, "type": "integer" } }, { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "count": { "type": "integer", "description": "number of records found" }, "data": { "type": "array", "items": { "required": [ "address", "netmask", "version", "found" ], "type": "object", "properties": { "version": { "enum": [ 4, 6 ], "type": "integer", "description": "version of the IP address", "readOnly": true, "example": 4 }, "address": { "type": "string", "description": "IPv4\/IPv6 address", "readOnly": true, "example": "192.168.0.123" }, "netmask": { "type": "integer", "description": "netmask of the IP address", "readOnly": true, "example": 24 }, "found": { "type": "boolean", "description": "flag if the address was found by LiveConfig", "readOnly": true, "example": true }, "interface": { "type": "string", "description": "name of the interface the IP is configured at", "readOnly": true, "example": "eth0" }, "natAddress": { "type": "string", "description": "user configured alternative IP address mapping (used for dNATed servers)", "example": "203.0.113.123" } } } } }, "description": "list of all IP addresses of the server" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}\/ips\/{ip}": { "patch": { "tags": [ "Servers" ], "summary": "Edit IP address properties", "description": "Edit IP address properties", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" }, { "name": "ip", "in": "path", "description": "IP address", "required": true, "schema": { "type": "string" }, "example": 1 } ], "requestBody": { "description": "Settings to modify", "content": { "application\/json": { "schema": { "required": [ "address", "netmask", "version", "found" ], "type": "object", "properties": { "version": { "enum": [ 4, 6 ], "type": "integer", "description": "version of the IP address", "readOnly": true, "example": 4 }, "address": { "type": "string", "description": "IPv4\/IPv6 address", "readOnly": true, "example": "192.168.0.123" }, "netmask": { "type": "integer", "description": "netmask of the IP address", "readOnly": true, "example": 24 }, "found": { "type": "boolean", "description": "flag if the address was found by LiveConfig", "readOnly": true, "example": true }, "interface": { "type": "string", "description": "name of the interface the IP is configured at", "readOnly": true, "example": "eth0" }, "natAddress": { "type": "string", "description": "user configured alternative IP address mapping (used for dNATed servers)", "example": "203.0.113.123" } } } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}\/webruntimes": { "get": { "tags": [ "Servers" ], "summary": "Get Webruntimes list", "description": "This method returns a list of all found Webruntimes of a servers.", "parameters": [ { "name": "count", "in": "query", "description": "number of results to return", "schema": { "minimum": 1, "type": "integer" } }, { "name": "page", "in": "query", "description": "page to return (offset), starting with `1`", "schema": { "minimum": 1, "type": "integer" } }, { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "count": { "type": "integer", "description": "number of records found" }, "data": { "type": "array", "items": { "required": [ "lang", "code", "version" ], "type": "object", "properties": { "lang": { "type": "string", "description": "name of the web runtime language", "readOnly": true, "example": "PHP" }, "code": { "type": "string", "description": "code to uniquely identify the web runtime language", "readOnly": true, "example": "php74" }, "version": { "type": "string", "description": "version of the web runtime language", "readOnly": true, "example": "7.4.3" }, "prio": { "type": "integer", "description": "sort priority of the web runtime language", "readOnly": true, "example": 10 }, "found": { "type": "boolean", "description": "flag if the runtime was found by LiveConfig", "readOnly": true, "example": true }, "usage": { "type": "integer", "description": "number of subdomains using this web runtime", "readOnly": true, "example": 42 }, "api": { "type": "array", "items": { "enum": [ "FastCGI", "FPM" ], "type": "string", "example": "FPM" }, "description": "available APIs of the web runtime language", "readOnly": true }, "eolDate": { "type": "string", "description": "EOL date of the web runtime language", "format": "date", "nullable": true, "example": "2024-12-31" }, "comment": { "type": "string", "description": "comment that is displayed within the selection box of the GUI", "example": "recommended" }, "restricted": { "type": "boolean", "description": "if set to `true` this runtime can't be used for new or changed configurations", "example": false } } } } }, "description": "a list of all Webruntimes of the Server" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/servers\/{id}\/webruntimes\/{code}": { "get": { "tags": [ "Servers" ], "summary": "WebRuntime details", "description": "get details of a configured WebRuntime", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" }, "example": "localhost" }, { "name": "code", "in": "path", "description": "webruntime code", "required": true, "schema": { "type": "string" }, "example": "php8" } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "description": "number of records found" }, "data": { "required": [ "lang", "code", "version" ], "type": "object", "properties": { "lang": { "type": "string", "description": "name of the web runtime language", "readOnly": true, "example": "PHP" }, "code": { "type": "string", "description": "code to uniquely identify the web runtime language", "readOnly": true, "example": "php74" }, "version": { "type": "string", "description": "version of the web runtime language", "readOnly": true, "example": "7.4.3" }, "prio": { "type": "integer", "description": "sort priority of the web runtime language", "readOnly": true, "example": 10 }, "found": { "type": "boolean", "description": "flag if the runtime was found by LiveConfig", "readOnly": true, "example": true }, "usage": { "type": "integer", "description": "number of subdomains using this web runtime", "readOnly": true, "example": 42 }, "api": { "type": "array", "items": { "enum": [ "FastCGI", "FPM" ], "type": "string", "example": "FPM" }, "description": "available APIs of the web runtime language", "readOnly": true }, "eolDate": { "type": "string", "description": "EOL date of the web runtime language", "format": "date", "nullable": true, "example": "2024-12-31" }, "comment": { "type": "string", "description": "comment that is displayed within the selection box of the GUI", "example": "recommended" }, "restricted": { "type": "boolean", "description": "if set to `true` this runtime can't be used for new or changed configurations", "example": false } } } } } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Servers" ], "summary": "Edit web runtime details", "description": "This method edits details of a selected web runtime.", "parameters": [ { "name": "id", "in": "path", "description": "Server id", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "path", "description": "webruntime code", "required": true, "schema": { "type": "string" }, "example": "php8" } ], "requestBody": { "description": "JSON object with modified data of the webruntime", "content": { "application\/json": { "schema": { "required": [ "lang", "code", "version" ], "type": "object", "properties": { "lang": { "type": "string", "description": "name of the web runtime language", "readOnly": true, "example": "PHP" }, "code": { "type": "string", "description": "code to uniquely identify the web runtime language", "readOnly": true, "example": "php74" }, "version": { "type": "string", "description": "version of the web runtime language", "readOnly": true, "example": "7.4.3" }, "prio": { "type": "integer", "description": "sort priority of the web runtime language", "readOnly": true, "example": 10 }, "found": { "type": "boolean", "description": "flag if the runtime was found by LiveConfig", "readOnly": true, "example": true }, "usage": { "type": "integer", "description": "number of subdomains using this web runtime", "readOnly": true, "example": 42 }, "api": { "type": "array", "items": { "enum": [ "FastCGI", "FPM" ], "type": "string", "example": "FPM" }, "description": "available APIs of the web runtime language", "readOnly": true }, "eolDate": { "type": "string", "description": "EOL date of the web runtime language", "format": "date", "nullable": true, "example": "2024-12-31" }, "comment": { "type": "string", "description": "comment that is displayed within the selection box of the GUI", "example": "recommended" }, "restricted": { "type": "boolean", "description": "if set to `true` this runtime can't be used for new or changed configurations", "example": false } } } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/sso\/{login}": { "post": { "tags": [ "Customers" ], "summary": "Single Sign-On", "description": "This method creates a single sign-on session for the given login. With the generated token, the user must be redirected to the URL `\/liveconfig\/app\/login\/sso?token=`. The token can only be used once and is only valid for 60 seconds. If the user is already logged in, the old session is automatically ended.", "parameters": [ { "name": "login", "in": "path", "description": "login of the user", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "data for SSO session", "content": { "application\/json": { "schema": { "type": "object", "properties": { "exitUrl": { "type": "string", "description": "optional URL where the user will be redirected to after logging out", "example": "https:\/\/www.example.org\/bye" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "token": { "type": "string", "example": "x1a2b3e4r5g6" } } } } } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/stats": { "get": { "tags": [ "LiveConfig" ], "summary": "Get statistics", "description": "Return statistics on customers, resellers or webspace (depending on individual permissions)", "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "accounts": { "type": "object", "properties": { "accounts": { "type": "integer", "description": "number of own accounts" }, "databases": { "type": "integer", "description": "number of created databases" }, "databaseStorage": { "type": "integer", "description": "size of all databases (MB)" }, "domains": { "type": "integer", "description": "number of own domains" }, "emails": { "type": "integer", "description": "number of e-mails in mailboxes" }, "emailStorage": { "type": "integer", "description": "size of all e-mails in mailboxes (MB)" }, "files": { "type": "integer", "description": "number of files in webspace" }, "mailaddrs": { "type": "integer", "description": "number of e-mail addresses" }, "mailboxes": { "type": "integer", "description": "number of POP3\/IMAP mailboxes" }, "webspace": { "type": "number", "description": "webspace in use (MB)" } }, "description": "statistics on own accounts" }, "customers": { "type": "object", "properties": { "accounts": { "type": "integer", "description": "number of customers' accounts" }, "customers": { "type": "integer", "description": "number of customers" }, "databases": { "type": "integer", "description": "number of databases created by customers" }, "databaseStorage": { "type": "integer", "description": "size of all customers' databases (MB)" }, "domains": { "type": "integer", "description": "number of customers' domains" }, "emails": { "type": "integer", "description": "number of e-mails in mailboxes from all customers" }, "emailStorage": { "type": "integer", "description": "size of e-mails from all customers (MB)" }, "files": { "type": "integer", "description": "number of files in customers' webspace" }, "mailaddrs": { "type": "integer", "description": "number of customers' e-mail addresses" }, "mailboxes": { "type": "integer", "description": "number of customers' POP3\/IMAP mailboxes" }, "webspace": { "type": "number", "description": "customers' webspace in use (MB)" } }, "description": "customer statistics (requires admin\/reseller permission)" }, "resellers": { "type": "object", "properties": { "accounts": { "type": "integer", "description": "number of resellers' accounts" }, "customers": { "type": "integer", "description": "number of resellers' customers" }, "databases": { "type": "integer", "description": "number of databases created by resellers" }, "databaseStorage": { "type": "integer", "description": "size of all resellers' databases (MB)" }, "domains": { "type": "integer", "description": "number of resellers' domains" }, "emails": { "type": "integer", "description": "number of e-mails in mailboxes from all resellers" }, "emailStorage": { "type": "integer", "description": "size of e-mails from all resellers (MB)" }, "files": { "type": "integer", "description": "number of files in resellers' webspace" }, "mailaddrs": { "type": "integer", "description": "number of resellers' e-mail addresses" }, "mailboxes": { "type": "integer", "description": "number of resellers' POP3\/IMAP mailboxes" }, "webspace": { "type": "number", "description": "resellers' webspace in use (MB)" } }, "description": "reseller statistics (requires admin\/reseller permission)" } }, "description": "statistics information", "example": { "accounts": { "accounts": 3, "domains": 12, "files": 1234, "mailAddresses": 42, "webspace": 567.23 }, "customers": { "accounts": 24, "customers": 12, "domains": 36, "files": 12345, "mailAddresses": 421, "webspace": 23456.78 }, "resellers": { "accounts": 12, "customers": 6, "domains": 18, "files": 9876, "mailAddresses": 234, "webspace": 4567.89 } } } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/templates": { "get": { "tags": [ "Accounts" ], "summary": "Get list of hosting templates", "description": "This method returns a list of all hosting templates", "parameters": [ { "name": "count", "in": "query", "description": "number of results to return", "schema": { "minimum": 1, "type": "integer" } }, { "name": "page", "in": "query", "description": "page to return (offset), starting with `1`", "schema": { "minimum": 1, "type": "integer" } }, { "name": "search", "in": "query", "description": "search phrase (is matched against template data)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 1 }, "data": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "api": { "type": "boolean", "description": "Account has API access", "example": false }, "apps": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web applications installed via AppInstaller (`-1`: unlimited)", "example": 5 }, "backup": { "type": "object", "properties": { "plans": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "backup plan ID", "example": "a1b2c3" }, "keep": { "maximum": 999, "minimum": 1, "type": "number", "description": "number of backups to keep", "example": 5 } } } }, "count": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of manually triggered backups allowed (`-1`: unlimited)", "example": 5 }, "wait": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Minimum time to wait between two manual backups (in minutes)", "example": 15 } } }, "cgi": { "type": "boolean", "description": "Permission for CGI scripts", "example": false }, "cronjobs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of cron jobs (`-1`: unlimited)", "example": 20 }, "customers": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of customers (`-1`: unlimited)", "example": 100 }, "databases": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of databases (`-1`: unlimited)", "example": 10 }, "dbExtAccess": { "type": "boolean", "description": "Allow enabling external database access", "example": false }, "dns": { "type": "boolean", "description": "Permission to edit DNS entries", "example": true }, "dynDns": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of subdomains with dynamic DNS feature", "example": 10 }, "extDomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed external domains (`-1`: unlimited)", "example": 5 }, "ftpAccounts": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of FTP accounts (`-1`: unlimited)", "example": 5 }, "lac": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true }, "memMax": { "minimum": -1, "type": "integer", "description": "maximum memory (RAM) in MB", "example": 2048 }, "tasksMax": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of processes & threads", "example": 2000 } }, "description": "LiveConfig Account Container (LAC) settings - only available with appropriate license. Currently these settings are only available for hosting accounts, not with hosting templates!" }, "logrotate": { "type": "object", "properties": { "compress": { "type": "boolean", "description": "Compress rotated log files", "example": true }, "filterIPv4": { "maximum": 4, "minimum": 0, "type": "number", "description": "number of bytes to filter from IPv4 addresses in access.log", "example": 1 }, "filterIPv6": { "maximum": 4, "minimum": 0, "type": "number", "description": "filter IPv6 addresses in access.log (0=no filtering, 1= filter last 32 bit, 2 = filter last 64 bit, 3 = filter last 96 bit, 4 = filter whole address)", "example": 2 }, "rotateInterval": { "enum": [ "hour", "day", "week", "month" ], "type": "string", "description": "Rotation interval (mutually exclusive with `rotateSize`)", "example": "week" }, "rotateSize": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Rotation size in MB (mutually exclusive with `rotateInterval`)", "example": 1024 }, "keepCount": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of rotated log files to keep (mutually exclusive with `keepDays`)", "example": 5 }, "keepDays": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of days to keep rotated log files (mutually exclusive with `keepCount`)", "example": 100 } }, "description": "Log rotation settings" }, "mailaddrs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of e-mail addresses (`-1`: unlimited)", "example": 250 }, "mailboxes": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of mailboxes (`-1`: unlimited)", "example": 50 }, "mailquota": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "E-mail storage quota (MiB, `-1`: unlimited)", "example": 10240 }, "php": { "enum": [ "no", "suPHP", "FastCGI", "mod_php", "FPM" ], "type": "string", "description": "PHP support (`suPHP` is deprecated, not available for new templates, `mod_php` is highly disregarded for security reasons).", "example": "FPM" }, "resaleable": { "type": "boolean", "description": "Permission to create subordinated resellers", "example": false }, "shell": { "enum": [ "no", "scponly", "shell", "webShell" ], "type": "string", "description": "Shell access (no, SFTP only, bash, web shell (implies bash))", "example": "no" }, "ssi": { "type": "boolean", "description": "Permission for server-side includes (SSI)", "example": true }, "subdomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed subdomains (`-1`: unlimited; `www` subdomain is not counted)", "example": 5 }, "tls": { "type": "boolean", "description": "Support for TLS\/SSL (https)", "example": true }, "tlsManagement": { "type": "boolean", "description": "allow management of TLS\/SSL certificates (requires `tls=true`)", "example": false }, "users": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web interface users (`-1`: unlimited)", "example": 5 }, "webspace": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Webspace (MiB) (`-1`: unlimited)", "example": 10240 } } }, { "type": "object", "properties": { "name": { "type": "string", "description": "Template name", "example": "Wordpress Hosting" } } } ] } } }, "description": "list of all hosting templates" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Accounts" ], "summary": "Create new hosting template", "description": "This method is used for adding a new hosting template", "requestBody": { "description": "Data of new template", "content": { "application\/json": { "schema": { "allOf": [ { "type": "object", "properties": { "api": { "type": "boolean", "description": "Account has API access", "example": false }, "apps": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web applications installed via AppInstaller (`-1`: unlimited)", "example": 5 }, "backup": { "type": "object", "properties": { "plans": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "backup plan ID", "example": "a1b2c3" }, "keep": { "maximum": 999, "minimum": 1, "type": "number", "description": "number of backups to keep", "example": 5 } } } }, "count": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of manually triggered backups allowed (`-1`: unlimited)", "example": 5 }, "wait": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Minimum time to wait between two manual backups (in minutes)", "example": 15 } } }, "cgi": { "type": "boolean", "description": "Permission for CGI scripts", "example": false }, "cronjobs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of cron jobs (`-1`: unlimited)", "example": 20 }, "customers": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of customers (`-1`: unlimited)", "example": 100 }, "databases": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of databases (`-1`: unlimited)", "example": 10 }, "dbExtAccess": { "type": "boolean", "description": "Allow enabling external database access", "example": false }, "dns": { "type": "boolean", "description": "Permission to edit DNS entries", "example": true }, "dynDns": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of subdomains with dynamic DNS feature", "example": 10 }, "extDomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed external domains (`-1`: unlimited)", "example": 5 }, "ftpAccounts": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of FTP accounts (`-1`: unlimited)", "example": 5 }, "lac": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true }, "memMax": { "minimum": -1, "type": "integer", "description": "maximum memory (RAM) in MB", "example": 2048 }, "tasksMax": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of processes & threads", "example": 2000 } }, "description": "LiveConfig Account Container (LAC) settings - only available with appropriate license. Currently these settings are only available for hosting accounts, not with hosting templates!" }, "logrotate": { "type": "object", "properties": { "compress": { "type": "boolean", "description": "Compress rotated log files", "example": true }, "filterIPv4": { "maximum": 4, "minimum": 0, "type": "number", "description": "number of bytes to filter from IPv4 addresses in access.log", "example": 1 }, "filterIPv6": { "maximum": 4, "minimum": 0, "type": "number", "description": "filter IPv6 addresses in access.log (0=no filtering, 1= filter last 32 bit, 2 = filter last 64 bit, 3 = filter last 96 bit, 4 = filter whole address)", "example": 2 }, "rotateInterval": { "enum": [ "hour", "day", "week", "month" ], "type": "string", "description": "Rotation interval (mutually exclusive with `rotateSize`)", "example": "week" }, "rotateSize": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Rotation size in MB (mutually exclusive with `rotateInterval`)", "example": 1024 }, "keepCount": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of rotated log files to keep (mutually exclusive with `keepDays`)", "example": 5 }, "keepDays": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of days to keep rotated log files (mutually exclusive with `keepCount`)", "example": 100 } }, "description": "Log rotation settings" }, "mailaddrs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of e-mail addresses (`-1`: unlimited)", "example": 250 }, "mailboxes": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of mailboxes (`-1`: unlimited)", "example": 50 }, "mailquota": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "E-mail storage quota (MiB, `-1`: unlimited)", "example": 10240 }, "php": { "enum": [ "no", "suPHP", "FastCGI", "mod_php", "FPM" ], "type": "string", "description": "PHP support (`suPHP` is deprecated, not available for new templates, `mod_php` is highly disregarded for security reasons).", "example": "FPM" }, "resaleable": { "type": "boolean", "description": "Permission to create subordinated resellers", "example": false }, "shell": { "enum": [ "no", "scponly", "shell", "webShell" ], "type": "string", "description": "Shell access (no, SFTP only, bash, web shell (implies bash))", "example": "no" }, "ssi": { "type": "boolean", "description": "Permission for server-side includes (SSI)", "example": true }, "subdomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed subdomains (`-1`: unlimited; `www` subdomain is not counted)", "example": 5 }, "tls": { "type": "boolean", "description": "Support for TLS\/SSL (https)", "example": true }, "tlsManagement": { "type": "boolean", "description": "allow management of TLS\/SSL certificates (requires `tls=true`)", "example": false }, "users": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web interface users (`-1`: unlimited)", "example": 5 }, "webspace": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Webspace (MiB) (`-1`: unlimited)", "example": 10240 } } }, { "type": "object", "properties": { "name": { "type": "string", "description": "Template name", "example": "Wordpress Hosting" } } } ] } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/templates\/{id}": { "get": { "tags": [ "Accounts" ], "summary": "Get hosting template details", "description": "This method returns all details for a hosting template", "parameters": [ { "name": "id", "in": "path", "description": "Template id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "allOf": [ { "type": "object", "properties": { "api": { "type": "boolean", "description": "Account has API access", "example": false }, "apps": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web applications installed via AppInstaller (`-1`: unlimited)", "example": 5 }, "backup": { "type": "object", "properties": { "plans": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "backup plan ID", "example": "a1b2c3" }, "keep": { "maximum": 999, "minimum": 1, "type": "number", "description": "number of backups to keep", "example": 5 } } } }, "count": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of manually triggered backups allowed (`-1`: unlimited)", "example": 5 }, "wait": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Minimum time to wait between two manual backups (in minutes)", "example": 15 } } }, "cgi": { "type": "boolean", "description": "Permission for CGI scripts", "example": false }, "cronjobs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of cron jobs (`-1`: unlimited)", "example": 20 }, "customers": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of customers (`-1`: unlimited)", "example": 100 }, "databases": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of databases (`-1`: unlimited)", "example": 10 }, "dbExtAccess": { "type": "boolean", "description": "Allow enabling external database access", "example": false }, "dns": { "type": "boolean", "description": "Permission to edit DNS entries", "example": true }, "dynDns": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of subdomains with dynamic DNS feature", "example": 10 }, "extDomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed external domains (`-1`: unlimited)", "example": 5 }, "ftpAccounts": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of FTP accounts (`-1`: unlimited)", "example": 5 }, "lac": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true }, "memMax": { "minimum": -1, "type": "integer", "description": "maximum memory (RAM) in MB", "example": 2048 }, "tasksMax": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of processes & threads", "example": 2000 } }, "description": "LiveConfig Account Container (LAC) settings - only available with appropriate license. Currently these settings are only available for hosting accounts, not with hosting templates!" }, "logrotate": { "type": "object", "properties": { "compress": { "type": "boolean", "description": "Compress rotated log files", "example": true }, "filterIPv4": { "maximum": 4, "minimum": 0, "type": "number", "description": "number of bytes to filter from IPv4 addresses in access.log", "example": 1 }, "filterIPv6": { "maximum": 4, "minimum": 0, "type": "number", "description": "filter IPv6 addresses in access.log (0=no filtering, 1= filter last 32 bit, 2 = filter last 64 bit, 3 = filter last 96 bit, 4 = filter whole address)", "example": 2 }, "rotateInterval": { "enum": [ "hour", "day", "week", "month" ], "type": "string", "description": "Rotation interval (mutually exclusive with `rotateSize`)", "example": "week" }, "rotateSize": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Rotation size in MB (mutually exclusive with `rotateInterval`)", "example": 1024 }, "keepCount": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of rotated log files to keep (mutually exclusive with `keepDays`)", "example": 5 }, "keepDays": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of days to keep rotated log files (mutually exclusive with `keepCount`)", "example": 100 } }, "description": "Log rotation settings" }, "mailaddrs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of e-mail addresses (`-1`: unlimited)", "example": 250 }, "mailboxes": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of mailboxes (`-1`: unlimited)", "example": 50 }, "mailquota": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "E-mail storage quota (MiB, `-1`: unlimited)", "example": 10240 }, "php": { "enum": [ "no", "suPHP", "FastCGI", "mod_php", "FPM" ], "type": "string", "description": "PHP support (`suPHP` is deprecated, not available for new templates, `mod_php` is highly disregarded for security reasons).", "example": "FPM" }, "resaleable": { "type": "boolean", "description": "Permission to create subordinated resellers", "example": false }, "shell": { "enum": [ "no", "scponly", "shell", "webShell" ], "type": "string", "description": "Shell access (no, SFTP only, bash, web shell (implies bash))", "example": "no" }, "ssi": { "type": "boolean", "description": "Permission for server-side includes (SSI)", "example": true }, "subdomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed subdomains (`-1`: unlimited; `www` subdomain is not counted)", "example": 5 }, "tls": { "type": "boolean", "description": "Support for TLS\/SSL (https)", "example": true }, "tlsManagement": { "type": "boolean", "description": "allow management of TLS\/SSL certificates (requires `tls=true`)", "example": false }, "users": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web interface users (`-1`: unlimited)", "example": 5 }, "webspace": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Webspace (MiB) (`-1`: unlimited)", "example": 10240 } } }, { "type": "object", "properties": { "name": { "type": "string", "description": "Template name", "example": "Wordpress Hosting" } } } ] } }, "description": "hosting template details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Accounts" ], "summary": "delete hosting template", "description": "This method deletes a hosting template", "parameters": [ { "name": "id", "in": "path", "description": "Template id", "required": true, "schema": { "type": "string" } }, { "name": "moveTo", "in": "query", "description": "If there are still accounts using this template, `moveTo` must be set to another template id to change these accounts to, or to an empty value if accounts have to be configured individually.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Accounts" ], "summary": "Edit hosting template", "description": "This method edits an existing hosting template", "parameters": [ { "name": "id", "in": "path", "description": "Template id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Template data to be modified", "content": { "application\/json": { "schema": { "allOf": [ { "type": "object", "properties": { "api": { "type": "boolean", "description": "Account has API access", "example": false }, "apps": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web applications installed via AppInstaller (`-1`: unlimited)", "example": 5 }, "backup": { "type": "object", "properties": { "plans": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "backup plan ID", "example": "a1b2c3" }, "keep": { "maximum": 999, "minimum": 1, "type": "number", "description": "number of backups to keep", "example": 5 } } } }, "count": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of manually triggered backups allowed (`-1`: unlimited)", "example": 5 }, "wait": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Minimum time to wait between two manual backups (in minutes)", "example": 15 } } }, "cgi": { "type": "boolean", "description": "Permission for CGI scripts", "example": false }, "cronjobs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of cron jobs (`-1`: unlimited)", "example": 20 }, "customers": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of customers (`-1`: unlimited)", "example": 100 }, "databases": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of databases (`-1`: unlimited)", "example": 10 }, "dbExtAccess": { "type": "boolean", "description": "Allow enabling external database access", "example": false }, "dns": { "type": "boolean", "description": "Permission to edit DNS entries", "example": true }, "dynDns": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of subdomains with dynamic DNS feature", "example": 10 }, "extDomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed external domains (`-1`: unlimited)", "example": 5 }, "ftpAccounts": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of FTP accounts (`-1`: unlimited)", "example": 5 }, "lac": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true }, "memMax": { "minimum": -1, "type": "integer", "description": "maximum memory (RAM) in MB", "example": 2048 }, "tasksMax": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "maximum number of processes & threads", "example": 2000 } }, "description": "LiveConfig Account Container (LAC) settings - only available with appropriate license. Currently these settings are only available for hosting accounts, not with hosting templates!" }, "logrotate": { "type": "object", "properties": { "compress": { "type": "boolean", "description": "Compress rotated log files", "example": true }, "filterIPv4": { "maximum": 4, "minimum": 0, "type": "number", "description": "number of bytes to filter from IPv4 addresses in access.log", "example": 1 }, "filterIPv6": { "maximum": 4, "minimum": 0, "type": "number", "description": "filter IPv6 addresses in access.log (0=no filtering, 1= filter last 32 bit, 2 = filter last 64 bit, 3 = filter last 96 bit, 4 = filter whole address)", "example": 2 }, "rotateInterval": { "enum": [ "hour", "day", "week", "month" ], "type": "string", "description": "Rotation interval (mutually exclusive with `rotateSize`)", "example": "week" }, "rotateSize": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Rotation size in MB (mutually exclusive with `rotateInterval`)", "example": 1024 }, "keepCount": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of rotated log files to keep (mutually exclusive with `keepDays`)", "example": 5 }, "keepDays": { "maximum": 999999999, "minimum": 1, "type": "integer", "description": "Number of days to keep rotated log files (mutually exclusive with `keepCount`)", "example": 100 } }, "description": "Log rotation settings" }, "mailaddrs": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of e-mail addresses (`-1`: unlimited)", "example": 250 }, "mailboxes": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of mailboxes (`-1`: unlimited)", "example": 50 }, "mailquota": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "E-mail storage quota (MiB, `-1`: unlimited)", "example": 10240 }, "php": { "enum": [ "no", "suPHP", "FastCGI", "mod_php", "FPM" ], "type": "string", "description": "PHP support (`suPHP` is deprecated, not available for new templates, `mod_php` is highly disregarded for security reasons).", "example": "FPM" }, "resaleable": { "type": "boolean", "description": "Permission to create subordinated resellers", "example": false }, "shell": { "enum": [ "no", "scponly", "shell", "webShell" ], "type": "string", "description": "Shell access (no, SFTP only, bash, web shell (implies bash))", "example": "no" }, "ssi": { "type": "boolean", "description": "Permission for server-side includes (SSI)", "example": true }, "subdomains": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of allowed subdomains (`-1`: unlimited; `www` subdomain is not counted)", "example": 5 }, "tls": { "type": "boolean", "description": "Support for TLS\/SSL (https)", "example": true }, "tlsManagement": { "type": "boolean", "description": "allow management of TLS\/SSL certificates (requires `tls=true`)", "example": false }, "users": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Number of web interface users (`-1`: unlimited)", "example": 5 }, "webspace": { "maximum": 999999999, "minimum": -1, "type": "integer", "description": "Webspace (MiB) (`-1`: unlimited)", "example": 10240 } } }, { "type": "object", "properties": { "name": { "type": "string", "description": "Template name", "example": "Wordpress Hosting" } } } ] } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/tls\/accounts": { "get": { "tags": [ "TlsCerts" ], "summary": "Get TLS account list", "description": "This method returns a list of all available accounts for automated TLS (SSL) certificates.", "parameters": [ { "name": "show", "in": "query", "description": "comma-separated list of additional data to show (`products`: also show list of available TLS products per account)\n", "style": "form", "explode": false, "schema": { "type": "array", "items": { "enum": [ "products" ], "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "allOf": [ { "required": [ "accountId", "certificates", "created", "id", "provider" ], "type": "object", "properties": { "accountId": { "type": "string", "description": "account identifier at the corresponding provider (i.e. _Let's Encrypt_ user ID)", "example": "12345678" }, "certificates": { "type": "number", "description": "number of TLS certificates created with this account", "readOnly": true, "example": 42 }, "created": { "type": "string", "description": "date\/time when this account was created", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z" }, "id": { "type": "string", "description": "account ID", "readOnly": true, "example": "bIAzOg" }, "logo": { "type": "string", "description": "logo file name", "example": "logo-letsencrypt.svg" }, "logoDark": { "type": "string", "description": "optional logo for dark mode", "example": "logo-letsencrypt-white.svg" }, "provider": { "type": "string", "description": "name of TLS provider for this account", "readOnly": true, "example": "lets-encrypt" } } }, { "type": "object", "properties": { "products": { "type": "array", "items": { "required": [ "description" ], "type": "object", "properties": { "free": { "type": "boolean", "description": "is `true` if this TLS\/SSL certificate is free (at no cost)", "example": true }, "id": { "type": "string", "description": "product ID", "example": "lets-encrypt" }, "keyDefault": { "type": "string", "description": "default key type", "example": "ec-secp384r1" }, "name": { "type": "string", "description": "product name", "example": "Let's Encrypt" }, "san": { "type": "number", "description": "maximum number of SAN names (-1: unlimited, 0: none)", "example": 50 }, "sanWww": { "type": "boolean", "description": "is `true` if `www` subdomain can be added as SAN name", "example": true }, "type": { "enum": [ "smime", "tls" ], "type": "string", "example": "tls" }, "validation": { "enum": [ "DV", "OV", "EV" ], "type": "string", "description": "validation type (domain-validation, organization-validation, extended-validation)" }, "wildcard": { "type": "boolean", "description": "is `true` if wildcard certificates are allowed" } } }, "description": "list of available TLS products with this account (with `show=products`)" } } } ] } } }, "description": "a list of all available TLS accounts" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/tls\/accounts\/{id}": { "get": { "tags": [ "TlsCerts" ], "summary": "Get TLS account details", "description": "This method returns all details of a TLS account for automated TLS certificates.", "parameters": [ { "name": "id", "in": "path", "description": "TLS account id", "required": true, "schema": { "type": "string" }, "example": "1a2b3c" } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "required": [ "accountId", "certificates", "created", "id", "provider" ], "type": "object", "properties": { "accountId": { "type": "string", "description": "account identifier at the corresponding provider (i.e. _Let's Encrypt_ user ID)", "example": "12345678" }, "certificates": { "type": "number", "description": "number of TLS certificates created with this account", "readOnly": true, "example": 42 }, "created": { "type": "string", "description": "date\/time when this account was created", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z" }, "id": { "type": "string", "description": "account ID", "readOnly": true, "example": "bIAzOg" }, "logo": { "type": "string", "description": "logo file name", "example": "logo-letsencrypt.svg" }, "logoDark": { "type": "string", "description": "optional logo for dark mode", "example": "logo-letsencrypt-white.svg" }, "provider": { "type": "string", "description": "name of TLS provider for this account", "readOnly": true, "example": "lets-encrypt" } } } }, "description": "TLS account details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/tls\/certs": { "get": { "tags": [ "TlsCerts" ], "summary": "Get list of TLS (SSL) certificates", "description": "This method returns a list of all TLS (SSL) certificates. Automated TLS certificates (e.g. from *Let's Encrypt*) are not returned by default, for these you need set `show=automated` (see details).", "parameters": [ { "name": "count", "in": "query", "description": "number of results to return", "schema": { "minimum": 1, "type": "integer" } }, { "name": "page", "in": "query", "description": "page to return (offset), starting with `1`", "schema": { "minimum": 1, "type": "integer" } }, { "name": "search", "in": "query", "description": "search phrase (is matched against `name` and `san`)", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "sort results by given column (default: `name`)", "schema": { "enum": [ "issuer", "name", "validFrom", "validTo" ], "type": "string" } }, { "name": "show", "in": "query", "description": "comma-separated list of additional data to show (`automated`: also show automated TLS certificates, `cert`: show certificate, `key`: show certificate key)\n", "style": "form", "explode": false, "schema": { "type": "array", "items": { "enum": [ "automated", "cert", "key" ], "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 1 }, "data": { "type": "array", "items": { "allOf": [ { "allOf": [ { "required": [ "id" ], "type": "object", "properties": { "autoAssign": { "type": "boolean", "description": "flag if auto assignment should be tried (first customer which owns a domain within the certificate) (only for new certificates, and not for automated certificates)", "default": true, "writeOnly": true, "example": true }, "autoEnable": { "type": "boolean", "description": "automatically enable `HTTPS` once the certificate is complete, and configure a redirect from `http:\/\/` to `https:\/\/`", "default": true, "example": true }, "autoRenew": { "type": "boolean", "description": "Is `true` when certificate is automatically ordered\/renewed (e.g. with _Let's Encrypt_), requires valid `product`", "default": true, "example": true }, "cert": { "type": "string", "description": "PEM-encoded TLS certificate", "example": "-----BEGIN CERTIFICATE-----\n[...]-----END CERTIFICATE-----\n" }, "comment": { "type": "string", "description": "comment for the certificate", "example": "Cert for new web app" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "description": "customer ID", "example": "c0001" }, "name": { "type": "string", "description": "customer name", "example": "Foobar Inc." } }, "description": "customer details (if assigned to a customer)", "readOnly": true }, "customerId": { "type": "string", "description": "customer CID to whom the certificate should be assigned to", "nullable": true, "writeOnly": true, "example": "C1234" }, "hasOCSP": { "type": "boolean", "description": "flag if certificate has OCSP data", "readOnly": true, "example": false }, "id": { "type": "string", "description": "certificate ID", "readOnly": true, "example": "bIAzOg" }, "issuer": { "type": "string", "description": "certificate issuer", "readOnly": true, "example": "Fancy CA" }, "key": { "type": "string", "description": "PEM-encoded private key for the certificate (may be encrypted if `password` is set)", "example": "-----BEGIN EC PRIVATE KEY-----\n[...]-----END EC PRIVATE KEY-----\n" }, "keyType": { "type": "string", "description": "key type", "readOnly": true, "example": "RSA (4096)" }, "name": { "type": "string", "description": "common name (CN) of the certificate", "readOnly": true, "example": "www.example.org" }, "password": { "type": "string", "description": "password for encrypted private key (only allowed when `key` property is submitted)", "writeOnly": true, "example": "$up\u20acrS4fe" }, "product": { "type": "string", "description": "name of TLS product for automated TLS certificate", "example": "lets-encrypt" }, "reminderPermitted": { "type": "bool", "description": "flag if every customer which is permitted to use this certificate should be reminded before the expiration date", "example": true }, "reminderEmail": { "type": "string", "description": "e-mail address where a reminder should be sent to additionally", "example": "certificateexpiry@example.org" }, "san": { "type": "array", "items": { "type": "string", "readOnly": true }, "description": "list of additional names (SAN - Subject Alternative Names)", "readOnly": true }, "skipDnsCheck": { "type": "boolean", "description": "if enabled, don't check DNS for correct (expected) A\/AAAA records before triggering certificate order (only allowed for automated certificates, i.e. when `product` is selected)", "default": false, "example": true }, "validFrom": { "type": "string", "description": "valid from date", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z" }, "validTo": { "type": "string", "description": "valid to date", "format": "datetime", "readOnly": true, "example": "2021-07-23T23:59:59Z" } } }, { "type": "object", "properties": { "chain": { "type": "array", "items": { "type": "object", "properties": { "cert": { "type": "string", "description": "PEM formatted certificate (can be encrypted if `password` is set!)", "example": "-----BEGIN CERTIFICATE-----\n[...]-----END CERTIFICATE-----\n" }, "validFrom": { "type": "string", "description": "valid from date", "format": "datetime", "example": "2020-07-23T18:32:28Z" }, "validTo": { "type": "string", "description": "valid to date", "format": "datetime", "example": "2020-07-23T18:32:28Z" }, "issuer": { "type": "string", "description": "certificate issuer", "example": "Fancy CA" }, "name": { "type": "string", "description": "common name (CN) of the certificate", "example": "www.example.org" } } }, "readOnly": true } } } ] }, { "required": [ "id", "cert", "issuer", "notBefore", "notAfter" ], "type": "object" } ] } } }, "description": "a list of all TLS certificates" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "TlsCerts" ], "summary": "Add new TLS certificate", "description": "This method adds or orders a new TLS certificate.\n - either `key` (to submit an existing key) or `newKey` (to generate a new key) must be set\n - for ordering a new certificate, either submit a PEM-encoded `csr`, or submit a `newCsr` object with the respective data\n - if a certificate (`cert`) is submitted, `csr`\/`newCsr` must _not_ be submitted", "requestBody": { "description": "Data of new TLS certificate", "content": { "application\/json": { "schema": { "allOf": [ { "allOf": [ { "required": [ "id" ], "type": "object", "properties": { "autoAssign": { "type": "boolean", "description": "flag if auto assignment should be tried (first customer which owns a domain within the certificate) (only for new certificates, and not for automated certificates)", "default": true, "writeOnly": true, "example": true }, "autoEnable": { "type": "boolean", "description": "automatically enable `HTTPS` once the certificate is complete, and configure a redirect from `http:\/\/` to `https:\/\/`", "default": true, "example": true }, "autoRenew": { "type": "boolean", "description": "Is `true` when certificate is automatically ordered\/renewed (e.g. with _Let's Encrypt_), requires valid `product`", "default": true, "example": true }, "cert": { "type": "string", "description": "PEM-encoded TLS certificate", "example": "-----BEGIN CERTIFICATE-----\n[...]-----END CERTIFICATE-----\n" }, "comment": { "type": "string", "description": "comment for the certificate", "example": "Cert for new web app" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "description": "customer ID", "example": "c0001" }, "name": { "type": "string", "description": "customer name", "example": "Foobar Inc." } }, "description": "customer details (if assigned to a customer)", "readOnly": true }, "customerId": { "type": "string", "description": "customer CID to whom the certificate should be assigned to", "nullable": true, "writeOnly": true, "example": "C1234" }, "hasOCSP": { "type": "boolean", "description": "flag if certificate has OCSP data", "readOnly": true, "example": false }, "id": { "type": "string", "description": "certificate ID", "readOnly": true, "example": "bIAzOg" }, "issuer": { "type": "string", "description": "certificate issuer", "readOnly": true, "example": "Fancy CA" }, "key": { "type": "string", "description": "PEM-encoded private key for the certificate (may be encrypted if `password` is set)", "example": "-----BEGIN EC PRIVATE KEY-----\n[...]-----END EC PRIVATE KEY-----\n" }, "keyType": { "type": "string", "description": "key type", "readOnly": true, "example": "RSA (4096)" }, "name": { "type": "string", "description": "common name (CN) of the certificate", "readOnly": true, "example": "www.example.org" }, "password": { "type": "string", "description": "password for encrypted private key (only allowed when `key` property is submitted)", "writeOnly": true, "example": "$up\u20acrS4fe" }, "product": { "type": "string", "description": "name of TLS product for automated TLS certificate", "example": "lets-encrypt" }, "reminderPermitted": { "type": "bool", "description": "flag if every customer which is permitted to use this certificate should be reminded before the expiration date", "example": true }, "reminderEmail": { "type": "string", "description": "e-mail address where a reminder should be sent to additionally", "example": "certificateexpiry@example.org" }, "san": { "type": "array", "items": { "type": "string", "readOnly": true }, "description": "list of additional names (SAN - Subject Alternative Names)", "readOnly": true }, "skipDnsCheck": { "type": "boolean", "description": "if enabled, don't check DNS for correct (expected) A\/AAAA records before triggering certificate order (only allowed for automated certificates, i.e. when `product` is selected)", "default": false, "example": true }, "validFrom": { "type": "string", "description": "valid from date", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z" }, "validTo": { "type": "string", "description": "valid to date", "format": "datetime", "readOnly": true, "example": "2021-07-23T23:59:59Z" } } }, { "type": "object", "properties": { "chain": { "type": "array", "items": { "type": "string", "example": "-----BEGIN CERTIFICATE-----\n[...]-----END CERTIFICATE-----\n" }, "description": "array of PEM-encoded chain certificates" }, "newKey": { "enum": [ "rsa-1024", "rsa-2048", "rsa-4096", "ec-prime256v1", "ec-secp384r1", "ec-secp521r1" ], "type": "string", "description": "generate a new key of given type (mutually exclusive with `key` property)", "example": "ec-secp384r1" } } } ] }, { "type": "object", "properties": { "product": { "readOnly": false }, "newCsr": { "required": [ "commonName" ], "type": "object", "properties": { "commonName": { "type": "string", "description": "common name (usually domain name for the certificate)", "example": "example.org" }, "email": { "type": "string", "example": "info@example.org" }, "organization": { "type": "string", "example": "ACME Inc." }, "organizationalUnit": { "type": "string", "example": "IT department" }, "locality": { "type": "string", "example": "Erlangen" }, "state": { "type": "string", "example": "Bavaria" }, "country": { "type": "string", "example": "DE" }, "san": { "type": "array", "items": { "type": "string" }, "description": "list with additional domain names for the certificate", "example": [ "www.example.org", "mail.example.org" ] } }, "description": "generate a new CSR (certificate signing request) with the submitted data" } } } ] } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/tls\/certs\/{id}": { "get": { "tags": [ "TlsCerts" ], "summary": "Get TLS certificate details", "description": "This method returns the detailed TLS certificate data", "parameters": [ { "name": "id", "in": "path", "description": "TLS certificate id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "allOf": [ { "required": [ "id" ], "type": "object", "properties": { "autoAssign": { "type": "boolean", "description": "flag if auto assignment should be tried (first customer which owns a domain within the certificate) (only for new certificates, and not for automated certificates)", "default": true, "writeOnly": true, "example": true }, "autoEnable": { "type": "boolean", "description": "automatically enable `HTTPS` once the certificate is complete, and configure a redirect from `http:\/\/` to `https:\/\/`", "default": true, "example": true }, "autoRenew": { "type": "boolean", "description": "Is `true` when certificate is automatically ordered\/renewed (e.g. with _Let's Encrypt_), requires valid `product`", "default": true, "example": true }, "cert": { "type": "string", "description": "PEM-encoded TLS certificate", "example": "-----BEGIN CERTIFICATE-----\n[...]-----END CERTIFICATE-----\n" }, "comment": { "type": "string", "description": "comment for the certificate", "example": "Cert for new web app" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "description": "customer ID", "example": "c0001" }, "name": { "type": "string", "description": "customer name", "example": "Foobar Inc." } }, "description": "customer details (if assigned to a customer)", "readOnly": true }, "customerId": { "type": "string", "description": "customer CID to whom the certificate should be assigned to", "nullable": true, "writeOnly": true, "example": "C1234" }, "hasOCSP": { "type": "boolean", "description": "flag if certificate has OCSP data", "readOnly": true, "example": false }, "id": { "type": "string", "description": "certificate ID", "readOnly": true, "example": "bIAzOg" }, "issuer": { "type": "string", "description": "certificate issuer", "readOnly": true, "example": "Fancy CA" }, "key": { "type": "string", "description": "PEM-encoded private key for the certificate (may be encrypted if `password` is set)", "example": "-----BEGIN EC PRIVATE KEY-----\n[...]-----END EC PRIVATE KEY-----\n" }, "keyType": { "type": "string", "description": "key type", "readOnly": true, "example": "RSA (4096)" }, "name": { "type": "string", "description": "common name (CN) of the certificate", "readOnly": true, "example": "www.example.org" }, "password": { "type": "string", "description": "password for encrypted private key (only allowed when `key` property is submitted)", "writeOnly": true, "example": "$up\u20acrS4fe" }, "product": { "type": "string", "description": "name of TLS product for automated TLS certificate", "example": "lets-encrypt" }, "reminderPermitted": { "type": "bool", "description": "flag if every customer which is permitted to use this certificate should be reminded before the expiration date", "example": true }, "reminderEmail": { "type": "string", "description": "e-mail address where a reminder should be sent to additionally", "example": "certificateexpiry@example.org" }, "san": { "type": "array", "items": { "type": "string", "readOnly": true }, "description": "list of additional names (SAN - Subject Alternative Names)", "readOnly": true }, "skipDnsCheck": { "type": "boolean", "description": "if enabled, don't check DNS for correct (expected) A\/AAAA records before triggering certificate order (only allowed for automated certificates, i.e. when `product` is selected)", "default": false, "example": true }, "validFrom": { "type": "string", "description": "valid from date", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z" }, "validTo": { "type": "string", "description": "valid to date", "format": "datetime", "readOnly": true, "example": "2021-07-23T23:59:59Z" } } }, { "type": "object", "properties": { "chain": { "type": "array", "items": { "type": "object", "properties": { "cert": { "type": "string", "description": "PEM formatted certificate (can be encrypted if `password` is set!)", "example": "-----BEGIN CERTIFICATE-----\n[...]-----END CERTIFICATE-----\n" }, "validFrom": { "type": "string", "description": "valid from date", "format": "datetime", "example": "2020-07-23T18:32:28Z" }, "validTo": { "type": "string", "description": "valid to date", "format": "datetime", "example": "2020-07-23T18:32:28Z" }, "issuer": { "type": "string", "description": "certificate issuer", "example": "Fancy CA" }, "name": { "type": "string", "description": "common name (CN) of the certificate", "example": "www.example.org" } } }, "readOnly": true } } } ] } }, "description": "TLS certificate details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "TlsCerts" ], "summary": "Remove a TLS certificate", "parameters": [ { "name": "id", "in": "path", "description": "the id of the TLS certificate", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "TlsCerts" ], "summary": "Edit a TLS certificate", "description": "This method edits a TLS certificate.", "parameters": [ { "name": "id", "in": "path", "description": "encoded id of the TLS certificate", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "TLS certificate data to be modified", "content": { "application\/json": { "schema": { "allOf": [ { "required": [ "id" ], "type": "object", "properties": { "autoAssign": { "type": "boolean", "description": "flag if auto assignment should be tried (first customer which owns a domain within the certificate) (only for new certificates, and not for automated certificates)", "default": true, "writeOnly": true, "example": true }, "autoEnable": { "type": "boolean", "description": "automatically enable `HTTPS` once the certificate is complete, and configure a redirect from `http:\/\/` to `https:\/\/`", "default": true, "example": true }, "autoRenew": { "type": "boolean", "description": "Is `true` when certificate is automatically ordered\/renewed (e.g. with _Let's Encrypt_), requires valid `product`", "default": true, "example": true }, "cert": { "type": "string", "description": "PEM-encoded TLS certificate", "example": "-----BEGIN CERTIFICATE-----\n[...]-----END CERTIFICATE-----\n" }, "comment": { "type": "string", "description": "comment for the certificate", "example": "Cert for new web app" }, "customer": { "type": "object", "properties": { "id": { "type": "string", "description": "customer ID", "example": "c0001" }, "name": { "type": "string", "description": "customer name", "example": "Foobar Inc." } }, "description": "customer details (if assigned to a customer)", "readOnly": true }, "customerId": { "type": "string", "description": "customer CID to whom the certificate should be assigned to", "nullable": true, "writeOnly": true, "example": "C1234" }, "hasOCSP": { "type": "boolean", "description": "flag if certificate has OCSP data", "readOnly": true, "example": false }, "id": { "type": "string", "description": "certificate ID", "readOnly": true, "example": "bIAzOg" }, "issuer": { "type": "string", "description": "certificate issuer", "readOnly": true, "example": "Fancy CA" }, "key": { "type": "string", "description": "PEM-encoded private key for the certificate (may be encrypted if `password` is set)", "example": "-----BEGIN EC PRIVATE KEY-----\n[...]-----END EC PRIVATE KEY-----\n" }, "keyType": { "type": "string", "description": "key type", "readOnly": true, "example": "RSA (4096)" }, "name": { "type": "string", "description": "common name (CN) of the certificate", "readOnly": true, "example": "www.example.org" }, "password": { "type": "string", "description": "password for encrypted private key (only allowed when `key` property is submitted)", "writeOnly": true, "example": "$up\u20acrS4fe" }, "product": { "type": "string", "description": "name of TLS product for automated TLS certificate", "example": "lets-encrypt" }, "reminderPermitted": { "type": "bool", "description": "flag if every customer which is permitted to use this certificate should be reminded before the expiration date", "example": true }, "reminderEmail": { "type": "string", "description": "e-mail address where a reminder should be sent to additionally", "example": "certificateexpiry@example.org" }, "san": { "type": "array", "items": { "type": "string", "readOnly": true }, "description": "list of additional names (SAN - Subject Alternative Names)", "readOnly": true }, "skipDnsCheck": { "type": "boolean", "description": "if enabled, don't check DNS for correct (expected) A\/AAAA records before triggering certificate order (only allowed for automated certificates, i.e. when `product` is selected)", "default": false, "example": true }, "validFrom": { "type": "string", "description": "valid from date", "format": "datetime", "readOnly": true, "example": "2020-07-23T18:32:28Z" }, "validTo": { "type": "string", "description": "valid to date", "format": "datetime", "readOnly": true, "example": "2021-07-23T23:59:59Z" } } }, { "type": "object", "properties": { "chain": { "type": "array", "items": { "type": "string", "example": "-----BEGIN CERTIFICATE-----\n[...]-----END CERTIFICATE-----\n" }, "description": "array of PEM-encoded chain certificates" }, "newKey": { "enum": [ "rsa-1024", "rsa-2048", "rsa-4096", "ec-prime256v1", "ec-secp384r1", "ec-secp521r1" ], "type": "string", "description": "generate a new key of given type (mutually exclusive with `key` property)", "example": "ec-secp384r1" } } } ] } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/tls\/providers": { "get": { "tags": [ "TlsCerts" ], "summary": "Get list of TLS (SSL) providers", "description": "This method returns a list of all TLS (SSL) providers.", "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "required": [ "description", "freeDV", "logo", "name", "priority", "website" ], "type": "object", "properties": { "description": { "type": "string", "description": "provider description", "example": "Let's Encrypt provides free domain-validated SSL\/TLS certificates." }, "freeDV": { "type": "boolean", "description": "is \"true\" if this provider has free and automated domain-validated (DV) certificates" }, "logo": { "type": "string", "description": "logo file name", "example": "logo-letsencrypt.svg" }, "logoDark": { "type": "string", "description": "optional logo for dark mode", "example": "logo-letsencrypt-white.svg" }, "name": { "type": "string", "description": "provider name", "example": "Let's Encrypt" }, "priority": { "type": "number", "description": "sort priority (only for displaying)" }, "website": { "type": "string", "description": "URL of provider website", "example": "https:\/\/letsencrypt.org\/" } } } } }, "description": "a list of all available TLS providers" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/users": { "get": { "tags": [ "Users" ], "summary": "Get user list", "description": "This method returns a list of all users", "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "description": "number of records found", "example": 1 }, "data": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "login": { "type": "string", "description": "User name (login)", "example": "foobar" }, "password": { "type": "string", "description": "Password of the user", "writeOnly": true, "example": "$ecr\u20act" }, "status": { "enum": [ "active", "locked" ], "type": "string", "description": "current state of the login" }, "forcePasswordChange": { "type": "boolean", "description": "flag if the user is forced to change his password after the next login", "writeOnly": true, "example": false }, "language": { "type": "string", "description": "language set for the login", "example": "de" }, "timezone": { "type": "string", "description": "name of the timezone set for the login", "default": "UTC", "example": "Europe\/Berlin" }, "otp": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "flag if OTP is enabled on this login", "example": false }, "description": { "type": "string", "description": "description of the OTP device", "example": "OTP Token used by John Doe" }, "secret": { "type": "string", "description": "initialization string of the OTP generator", "writeOnly": true, "example": "SfkbxvzhVozILu4Wyhyt" } }, "description": "OTP Settings of the login" }, "webauthn": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Login with Passkey or WebAuthn enabled", "example": false }, "devices": { "type": "number", "description": "Number of registered Passkey\/WebAuthn devices", "readOnly": true, "example": 2 } }, "description": "WebAuthn settings" }, "lastLoginIp": { "type": "string", "description": "IP address of last login", "readOnly": true }, "lastLoginTime": { "type": "string", "description": "Timestamp of last login", "format": "date-time", "readOnly": true }, "mainUser": { "type": "boolean", "description": "Is `true` if this is the main user of that customer", "readOnly": true, "example": true } } }, { "type": "object", "properties": { "contact": { "required": [ "id", "type", "countryCode" ], "type": "object", "properties": { "id": { "type": "string", "description": "Encoded contact id", "readOnly": true, "example": "bIAzOg" }, "type": { "enum": [ "org", "person" ], "type": "string", "description": "Type of the contact. For `type == org` the field `company` is required. For `type == person` the fields `firstName` and `lastName` are required." }, "title": { "type": "string", "description": "title", "example": "Prof." }, "firstName": { "type": "string", "description": "First name", "example": "John" }, "lastName": { "type": "string", "description": "Last name", "example": "Doe" }, "company": { "type": "string", "description": "Company name", "example": "ACME Inc." }, "address1": { "type": "string", "description": "Address" }, "address2": { "type": "string", "description": "Address (2nd line)" }, "zipCode": { "type": "string", "description": "ZIP code" }, "city": { "type": "string", "description": "City name" }, "country": { "type": "string", "description": "Country name (localized)", "readOnly": true, "example": "Germany" }, "countryCode": { "type": "string", "description": "CountryCode in ISO 3166-1 Alpha 2", "example": "DE" }, "phone": { "type": "string", "description": "phone number" }, "fax": { "type": "string", "description": "fax number" }, "mobile": { "type": "string", "description": "mobile number" }, "email": { "type": "string", "description": "email address", "format": "email" }, "website": { "type": "string", "description": "website address" } } } } } ] } } }, "description": "a list of all users" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } }, "parameters": null }, "post": { "tags": [ "Users" ], "summary": "Add new user", "description": "This method adds a new user.", "requestBody": { "description": "Data of new user", "content": { "application\/json": { "schema": { "allOf": [ { "type": "object", "properties": { "login": { "type": "string", "description": "User name (login)", "example": "foobar" }, "password": { "type": "string", "description": "Password of the user", "writeOnly": true, "example": "$ecr\u20act" }, "status": { "enum": [ "active", "locked" ], "type": "string", "description": "current state of the login" }, "forcePasswordChange": { "type": "boolean", "description": "flag if the user is forced to change his password after the next login", "writeOnly": true, "example": false }, "language": { "type": "string", "description": "language set for the login", "example": "de" }, "timezone": { "type": "string", "description": "name of the timezone set for the login", "default": "UTC", "example": "Europe\/Berlin" }, "otp": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "flag if OTP is enabled on this login", "example": false }, "description": { "type": "string", "description": "description of the OTP device", "example": "OTP Token used by John Doe" }, "secret": { "type": "string", "description": "initialization string of the OTP generator", "writeOnly": true, "example": "SfkbxvzhVozILu4Wyhyt" } }, "description": "OTP Settings of the login" }, "webauthn": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Login with Passkey or WebAuthn enabled", "example": false }, "devices": { "type": "number", "description": "Number of registered Passkey\/WebAuthn devices", "readOnly": true, "example": 2 } }, "description": "WebAuthn settings" }, "lastLoginIp": { "type": "string", "description": "IP address of last login", "readOnly": true }, "lastLoginTime": { "type": "string", "description": "Timestamp of last login", "format": "date-time", "readOnly": true }, "mainUser": { "type": "boolean", "description": "Is `true` if this is the main user of that customer", "readOnly": true, "example": true } } }, { "required": [ "contact", "login", "password", "permissions" ], "type": "object", "properties": { "contact": { "type": "string", "description": "Contact ID", "example": "bIAzOg" }, "permissions": { "type": "object", "properties": { "add": { "type": "array", "items": { "type": "string", "description": "Permission name", "example": "CORE_LOGIN" }, "description": "List of permissions to grant to the user" } } } } } ] } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/users\/{login}": { "get": { "tags": [ "Users" ], "summary": "Get users details", "description": "This method returns the detailed user data", "parameters": [ { "name": "login", "in": "path", "description": "User login", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "allOf": [ { "type": "object", "properties": { "login": { "type": "string", "description": "User name (login)", "example": "foobar" }, "password": { "type": "string", "description": "Password of the user", "writeOnly": true, "example": "$ecr\u20act" }, "status": { "enum": [ "active", "locked" ], "type": "string", "description": "current state of the login" }, "forcePasswordChange": { "type": "boolean", "description": "flag if the user is forced to change his password after the next login", "writeOnly": true, "example": false }, "language": { "type": "string", "description": "language set for the login", "example": "de" }, "timezone": { "type": "string", "description": "name of the timezone set for the login", "default": "UTC", "example": "Europe\/Berlin" }, "otp": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "flag if OTP is enabled on this login", "example": false }, "description": { "type": "string", "description": "description of the OTP device", "example": "OTP Token used by John Doe" }, "secret": { "type": "string", "description": "initialization string of the OTP generator", "writeOnly": true, "example": "SfkbxvzhVozILu4Wyhyt" } }, "description": "OTP Settings of the login" }, "webauthn": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Login with Passkey or WebAuthn enabled", "example": false }, "devices": { "type": "number", "description": "Number of registered Passkey\/WebAuthn devices", "readOnly": true, "example": 2 } }, "description": "WebAuthn settings" }, "lastLoginIp": { "type": "string", "description": "IP address of last login", "readOnly": true }, "lastLoginTime": { "type": "string", "description": "Timestamp of last login", "format": "date-time", "readOnly": true }, "mainUser": { "type": "boolean", "description": "Is `true` if this is the main user of that customer", "readOnly": true, "example": true } } }, { "type": "object", "properties": { "contact": { "required": [ "id", "type", "countryCode" ], "type": "object", "properties": { "id": { "type": "string", "description": "Encoded contact id", "readOnly": true, "example": "bIAzOg" }, "type": { "enum": [ "org", "person" ], "type": "string", "description": "Type of the contact. For `type == org` the field `company` is required. For `type == person` the fields `firstName` and `lastName` are required." }, "title": { "type": "string", "description": "title", "example": "Prof." }, "firstName": { "type": "string", "description": "First name", "example": "John" }, "lastName": { "type": "string", "description": "Last name", "example": "Doe" }, "company": { "type": "string", "description": "Company name", "example": "ACME Inc." }, "address1": { "type": "string", "description": "Address" }, "address2": { "type": "string", "description": "Address (2nd line)" }, "zipCode": { "type": "string", "description": "ZIP code" }, "city": { "type": "string", "description": "City name" }, "country": { "type": "string", "description": "Country name (localized)", "readOnly": true, "example": "Germany" }, "countryCode": { "type": "string", "description": "CountryCode in ISO 3166-1 Alpha 2", "example": "DE" }, "phone": { "type": "string", "description": "phone number" }, "fax": { "type": "string", "description": "fax number" }, "mobile": { "type": "string", "description": "mobile number" }, "email": { "type": "string", "description": "email address", "format": "email" }, "website": { "type": "string", "description": "website address" } } }, "permissions": { "type": "array", "items": { "type": "string", "description": "Permission name", "example": "CORE_LOGIN" }, "description": "List of permissions granted to the user" } } } ] } }, "description": "User details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Users" ], "summary": "Remove a user", "parameters": [ { "name": "login", "in": "path", "description": "the login of the user", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Users" ], "summary": "Edit a user", "description": "This method edits a user.", "parameters": [ { "name": "login", "in": "path", "description": "login of the user", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "User data to be modified", "content": { "application\/json": { "schema": { "allOf": [ { "type": "object", "properties": { "login": { "type": "string", "description": "User name (login)", "example": "foobar" }, "password": { "type": "string", "description": "Password of the user", "writeOnly": true, "example": "$ecr\u20act" }, "status": { "enum": [ "active", "locked" ], "type": "string", "description": "current state of the login" }, "forcePasswordChange": { "type": "boolean", "description": "flag if the user is forced to change his password after the next login", "writeOnly": true, "example": false }, "language": { "type": "string", "description": "language set for the login", "example": "de" }, "timezone": { "type": "string", "description": "name of the timezone set for the login", "default": "UTC", "example": "Europe\/Berlin" }, "otp": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "flag if OTP is enabled on this login", "example": false }, "description": { "type": "string", "description": "description of the OTP device", "example": "OTP Token used by John Doe" }, "secret": { "type": "string", "description": "initialization string of the OTP generator", "writeOnly": true, "example": "SfkbxvzhVozILu4Wyhyt" } }, "description": "OTP Settings of the login" }, "webauthn": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Login with Passkey or WebAuthn enabled", "example": false }, "devices": { "type": "number", "description": "Number of registered Passkey\/WebAuthn devices", "readOnly": true, "example": 2 } }, "description": "WebAuthn settings" }, "lastLoginIp": { "type": "string", "description": "IP address of last login", "readOnly": true }, "lastLoginTime": { "type": "string", "description": "Timestamp of last login", "format": "date-time", "readOnly": true }, "mainUser": { "type": "boolean", "description": "Is `true` if this is the main user of that customer", "readOnly": true, "example": true } } }, { "type": "object", "properties": { "contact": { "type": "string", "description": "Contact ID", "example": "bIAzOg" }, "permissions": { "type": "object", "properties": { "add": { "type": "array", "items": { "type": "string", "description": "Permission name", "example": "CORE_LOGIN" }, "description": "List of permissions to grant to the user" }, "del": { "type": "array", "items": { "type": "string", "description": "Permission name", "example": "CORE_LOGIN" }, "description": "List of permissions to revoke from the user" } } } } } ] } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/webspace\/{account}\/processes": { "get": { "tags": [ "Webspace" ], "summary": "Process list", "description": "Returns a list of all active processes of the webspace account.", "parameters": [ { "name": "account", "in": "path", "description": "the name of the account", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "required": [ "pid" ], "type": "object", "properties": { "cmd": { "type": "string", "description": "Command (process name)", "example": "apache" }, "cmdline": { "type": "string", "description": "commandline of the program", "example": "\/usr\/sbin\/apache2 -k start" }, "pid": { "type": "integer", "description": "Process id", "example": 123 }, "euser": { "type": "string", "description": "Effective user name", "example": "www-data" }, "egroup": { "type": "string", "description": "effective group name", "example": "www-data" }, "ruser": { "type": "string", "description": "Real user name (might differ from `euser`)", "example": "root" }, "rgroup": { "type": "string", "description": "Real group name (might differ from `egroup`)", "example": "root" }, "resKb": { "type": "integer", "description": "resident non-swapped memory in kb", "example": 11704 }, "virtKb": { "type": "integer", "description": "total virtual memory in kb", "example": 50592 }, "stime": { "type": "integer", "description": "kernel-mode CPU time accumulated by process", "example": 62 }, "utime": { "type": "integer", "description": "user-mode CPU time accumulated by process", "example": 149 } } } } }, "description": "Process list" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/webspace\/{account}\/cron": { "get": { "tags": [ "Webspace" ], "summary": "Get list of cron jobs", "description": "This method returns a list of cronjobs configured for the given webspace", "parameters": [ { "name": "account", "in": "path", "description": "the name of the account", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "example": 3 }, "data": { "type": "array", "items": { "required": [ "id", "active", "cmd", "min", "hour", "day", "month", "dow" ], "type": "object", "properties": { "id": { "type": "string", "description": "the id of the cron job", "example": "dcCUig" }, "active": { "type": "boolean", "description": "flag if this cron job is enabled", "example": true }, "cmd": { "type": "string", "description": "command that gets executed by this cron job", "example": "\/usr\/bin\/php \/var\/www\/web123\/priv\/cron.php > \/dev\/null" }, "description": { "type": "string", "description": "description of the cron job", "example": "my first cron job" }, "email": { "type": "string", "description": "email to send cron output emails to", "example": "mail@example.org" }, "min": { "type": "string", "description": "minute part of the cron job", "example": "*\/5" }, "hour": { "type": "string", "description": "hour part of the cron job", "example": "1,3,6" }, "day": { "type": "string", "description": "day of the month part of the cron job", "example": "*" }, "month": { "type": "string", "description": "month part of the cron job", "example": "1-5" }, "dow": { "type": "string", "description": "day of the week part of the cron job", "example": "*" } } } } }, "description": "Cron job details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Webspace" ], "summary": "Add new cron job", "description": "This method adds a new cron job to the given account.", "parameters": [ { "name": "account", "in": "path", "description": "the name of the account", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object with data of new cron job", "content": { "application\/json": { "schema": { "required": [ "active", "cmd", "min", "hour", "day", "month", "dow" ], "type": "object", "properties": { "active": { "type": "boolean", "description": "flag if this cron job is enabled", "example": true }, "cmd": { "type": "string", "description": "command that gets executed by this cron job", "example": "\/usr\/bin\/php \/var\/www\/web123\/priv\/cron.php > \/dev\/null" }, "description": { "type": "string", "description": "description of the cron job", "example": "my first cron job" }, "email": { "type": "string", "description": "email to send cron output emails to", "example": "mail@example.org" }, "min": { "type": "string", "description": "minute part of the cron job", "example": "*\/5" }, "hour": { "type": "string", "description": "hour part of the cron job", "example": "1,3,6" }, "day": { "type": "string", "description": "day of the month part of the cron job", "example": "*" }, "month": { "type": "string", "description": "month part of the cron job", "example": "1-5" }, "dow": { "type": "string", "description": "day of the week part of the cron job", "example": "*" } } } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/webspace\/{account}\/cron\/{id}": { "get": { "tags": [ "Webspace" ], "summary": "Get webspace cron job", "description": "This method returns the properties of the requested cron job", "parameters": [ { "name": "account", "in": "path", "description": "the name of the account", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "the id of the cron job", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "required": [ "id", "active", "cmd", "m", "h", "dom", "mon", "dow" ], "type": "object", "properties": { "id": { "type": "string", "description": "the id of the cron job", "example": "dcCUig" }, "active": { "type": "boolean", "description": "flag if this cron job is enabled", "example": true }, "cmd": { "type": "string", "description": "command that gets executed by this cron job", "example": "\/usr\/bin\/php \/var\/www\/web123\/priv\/cron.php > \/dev\/null" }, "description": { "type": "string", "description": "description of the cron job", "example": "my first cron job" }, "email": { "type": "string", "description": "email to send cron output emails to", "example": "mail@example.org" }, "min": { "type": "string", "description": "minute part of the cron job", "example": "*\/5" }, "hour": { "type": "string", "description": "hour part of the cron job", "example": "1,3,6" }, "day": { "type": "string", "description": "day of the month part of the cron job", "example": "*" }, "month": { "type": "string", "description": "month part of the cron job", "example": "1-5" }, "dow": { "type": "string", "description": "day of the week part of the cron job", "example": "*" } } } }, "description": "Cron job details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Webspace" ], "summary": "Remove a cron job", "parameters": [ { "name": "account", "in": "path", "description": "the name of the account", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "the id of the cron job", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Webspace" ], "summary": "Modify cron job", "parameters": [ { "name": "account", "in": "path", "description": "the name of the account", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "the id of the cron job", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object with data of cron job to modify", "content": { "application\/json": { "schema": { "type": "object", "properties": { "active": { "type": "boolean", "description": "flag if this cron job is enabled", "example": true }, "cmd": { "type": "string", "description": "command that gets executed by this cron job", "example": "\/usr\/bin\/php \/var\/www\/web123\/priv\/cron.php > \/dev\/null" }, "description": { "type": "string", "description": "description of the cron job", "example": "my first cron job" }, "email": { "type": "string", "description": "email to send cron output emails to", "example": "mail@example.org" }, "min": { "type": "string", "description": "minute part of the cron job", "example": "*\/5" }, "hour": { "type": "string", "description": "hour part of the cron job", "example": "1,3,6" }, "day": { "type": "string", "description": "day of the month part of the cron job", "example": "*" }, "month": { "type": "string", "description": "month part of the cron job", "example": "1-5" }, "dow": { "type": "string", "description": "day of the week part of the cron job", "example": "*" } } } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/webspace\/{account}\/files": { "get": { "tags": [ "Webspace" ], "summary": "Get file list with metadata", "description": "This method returns a list of files and their metadata within the webspace account", "parameters": [ { "name": "account", "in": "path", "description": "the name of the account", "required": true, "schema": { "type": "string" } }, { "name": "path", "in": "query", "description": "the path of the file\/directory to get files or metadata from", "required": true, "schema": { "type": "string" } }, { "name": "show", "in": "query", "description": "return only files or directories or http allowed directories", "required": false, "style": "form", "explode": false, "schema": { "enum": [ "files", "directories", "httpdirs" ], "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "oneOf": [ { "required": [ "mode", "name", "user", "group", "size", "mtime", "type" ], "type": "object", "properties": { "mode": { "type": "string", "description": "the file mode as given by `stat()`", "example": "0744" }, "name": { "type": "string", "description": "the name of the file or directory" }, "user": { "type": "string", "description": "the user name the file or directory belongs to" }, "group": { "type": "string", "description": "the group name the file or directory belongs to" }, "size": { "type": "integer", "description": "file size (bytes)" }, "mtime": { "type": "string", "description": "timestamp of last modification", "format": "date-time" }, "type": { "enum": [ "file", "directory" ], "type": "string", "description": "type of the entry" } }, "example": { "mode": 33188, "name": "test.txt", "user": "nobody", "group": "nogroup", "size": 124, "mtime": "2022-10-25T09:35:04+0000", "type": "file" } }, { "type": "array", "items": { "required": [ "mode", "name", "user", "group", "size", "mtime", "type" ], "type": "object", "properties": { "mode": { "type": "string", "description": "the file mode as given by `stat()`", "example": "0744" }, "name": { "type": "string", "description": "the name of the file or directory" }, "user": { "type": "string", "description": "the user name the file or directory belongs to" }, "group": { "type": "string", "description": "the group name the file or directory belongs to" }, "size": { "type": "integer", "description": "file size (bytes)" }, "mtime": { "type": "string", "description": "timestamp of last modification", "format": "date-time" }, "type": { "enum": [ "file", "directory" ], "type": "string", "description": "type of the entry" } }, "example": { "mode": 33188, "name": "test.txt", "user": "nobody", "group": "nogroup", "size": 124, "mtime": "2022-10-25T09:35:04+0000", "type": "file" } } } ] } }, "description": "metadata of one or more files" } } } } } } }, "\/webspace\/{account}\/files\/cp": { "patch": { "tags": [ "Webspace" ], "summary": "copy a directory\/file on a webspace", "parameters": [ { "name": "account", "in": "path", "description": "the name of the account", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "the path of the directory\/file to be copied", "required": true, "schema": { "type": "string" } }, { "name": "to", "in": "query", "description": "the path of the new (to be created) directory\/file", "required": true, "schema": { "type": "string" } }, { "name": "recursive", "in": "query", "description": "make the copy operation recursive", "required": false, "schema": { "enum": [ "true", "false" ], "type": "string" }, "default": "false" } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/webspace\/{account}\/files\/download": { "get": { "tags": [ "Webspace" ], "summary": "Download file", "description": "This method downloads a file from within the webspace account", "parameters": [ { "name": "account", "in": "path", "description": "the name of the account", "required": true, "schema": { "type": "string" } }, { "name": "path", "in": "query", "description": "the path of the file which to download", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/octet-stream": { "schema": { "type": "string", "description": "the file contents of the specified file", "format": "binary" } } } } } } }, "\/webspace\/{account}\/files\/mkdir": { "post": { "tags": [ "Webspace" ], "summary": "Create directory", "description": "This method creates a directory on the webspace account", "parameters": [ { "name": "account", "in": "path", "description": "the name of the account", "required": true, "schema": { "type": "string" } }, { "name": "path", "in": "query", "description": "the path of the directory to be created", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "none", "required": false }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/webspace\/{account}\/files\/mv": { "patch": { "tags": [ "Webspace" ], "summary": "move\/rename a directory\/file on a webspace", "parameters": [ { "name": "account", "in": "path", "description": "the name of the account", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "the path of the directory\/file to be copied", "required": true, "schema": { "type": "string" } }, { "name": "to", "in": "query", "description": "the path of the new (to be created) directory\/file", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/webspace\/{account}\/files\/perms": { "patch": { "tags": [ "Webspace" ], "summary": "Change file permission", "description": "This method changes a files permissions on the webspace account", "parameters": [ { "name": "account", "in": "path", "description": "the name of the account", "required": true, "schema": { "type": "string" } }, { "name": "path", "in": "query", "description": "the path of the file where to change the permissions", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "json object of permissions to set\/unset", "content": { "application\/json": { "schema": { "type": "object", "properties": { "mode": { "type": "string", "description": "new file mode in octal notation", "example": "0755" } } } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/webspace\/{account}\/files\/rm": { "delete": { "tags": [ "Webspace" ], "summary": "Remove a directory\/file from the webspace", "parameters": [ { "name": "account", "in": "path", "description": "the name of the account", "required": true, "schema": { "type": "string" } }, { "name": "path", "in": "query", "description": "the directory\/file to be deleted", "required": true, "schema": { "type": "string" } }, { "name": "recursive", "in": "query", "description": "make the delete operation recursive", "required": false, "schema": { "enum": [ "true", "false" ], "type": "string" }, "default": "false" } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/webspace\/{account}\/files\/upload": { "post": { "tags": [ "Webspace" ], "summary": "Upload file", "description": "This method uploads a file to the webspace account", "parameters": [ { "name": "account", "in": "path", "description": "the name of the account", "required": true, "schema": { "type": "string" } }, { "name": "path", "in": "query", "description": "the path of the file where to upload", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Binary data of the file to upload", "content": { "application\/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/webspace\/{account}\/log\/files": { "get": { "tags": [ "Webspace" ], "summary": "Get file list of available logfiles", "description": "This method returns a list of available logfiles within the webspace account. The files can be found within the `\/logs\/` dir in the account home.", "parameters": [ { "name": "account", "in": "path", "description": "the name of the account", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "string", "description": "filename of logfiles" }, "example": [ "error.log", "access.log", "priv\/php_errors.log" ] } }, "description": "metadata of one or more files" } } } } } } }, "\/webspace\/{account}\/ftp": { "get": { "tags": [ "Webspace" ], "summary": "Get list of ftp accounts", "description": "This method returns a list of ftp accounts configured for the given webspace", "parameters": [ { "name": "account", "in": "path", "description": "the name of the webspace account", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "count": { "type": "integer", "example": 3 }, "data": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "password": { "type": "string", "description": "password to be set for the account", "writeOnly": true, "example": "$up\u20acrS3cre7" }, "baseDir": { "type": "string", "description": "path below the webspace directory where the user starts", "example": "\/htdocs\/www.example.com\/website" }, "lastPasswordChange": { "type": "string", "description": "Timestamp of the last password change", "format": "datetime", "readOnly": true, "example": "1970-01-01T00:00:00Z" }, "userType": { "enum": [ "system", "virtual" ], "type": "string", "description": "type of the FTP user which can be a native system user or a virtual ftp user", "readOnly": true, "example": "virtual" } } }, { "type": "object", "properties": { "login": { "type": "string", "description": "login name", "example": "web1" } } } ] } } }, "description": "account details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Webspace" ], "summary": "Add new virtual ftp account", "description": "This method adds a new virtual ftp account to the given webspace.", "parameters": [ { "name": "account", "in": "path", "description": "the name of the account", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object with data of new virtual ftp account", "content": { "application\/json": { "schema": { "allOf": [ { "type": "object", "properties": { "password": { "type": "string", "description": "password to be set for the account", "writeOnly": true, "example": "$up\u20acrS3cre7" }, "baseDir": { "type": "string", "description": "path below the webspace directory where the user starts", "example": "\/htdocs\/www.example.com\/website" }, "lastPasswordChange": { "type": "string", "description": "Timestamp of the last password change", "format": "datetime", "readOnly": true, "example": "1970-01-01T00:00:00Z" }, "userType": { "enum": [ "system", "virtual" ], "type": "string", "description": "type of the FTP user which can be a native system user or a virtual ftp user", "readOnly": true, "example": "virtual" } } }, { "required": [ "login", "password", "baseDir" ], "type": "object", "properties": { "login": { "type": "string", "description": "login of the newly created ftp account", "writeOnly": true, "example": "web1" } } } ] } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/webspace\/{account}\/ftp\/{login}": { "get": { "tags": [ "Webspace" ], "summary": "Get webspace ftp account", "description": "This method returns the properties of the requested ftp account", "parameters": [ { "name": "account", "in": "path", "description": "the name of the account", "required": true, "schema": { "type": "string" } }, { "name": "login", "in": "path", "description": "the login of the ftp account", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "password": { "type": "string", "description": "password to be set for the account", "writeOnly": true, "example": "$up\u20acrS3cre7" }, "baseDir": { "type": "string", "description": "path below the webspace directory where the user starts", "example": "\/htdocs\/www.example.com\/website" }, "lastPasswordChange": { "type": "string", "description": "Timestamp of the last password change", "format": "datetime", "readOnly": true, "example": "1970-01-01T00:00:00Z" }, "userType": { "enum": [ "system", "virtual" ], "type": "string", "description": "type of the FTP user which can be a native system user or a virtual ftp user", "readOnly": true, "example": "virtual" } } } }, "description": "ftp account details" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Webspace" ], "summary": "Remove a virtual ftp account from a webspace", "parameters": [ { "name": "account", "in": "path", "description": "the name of the webspace account", "required": true, "schema": { "type": "string" } }, { "name": "login", "in": "path", "description": "the login of the ftp account", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Webspace" ], "summary": "Modify ftp account of webspace", "parameters": [ { "name": "account", "in": "path", "description": "the name of the webspace account", "required": true, "schema": { "type": "string" } }, { "name": "login", "in": "path", "description": "the login of the ftp accout", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON object with data of ftp account to modify", "content": { "application\/json": { "schema": { "type": "object", "properties": { "password": { "type": "string", "description": "password to be set for the account", "writeOnly": true, "example": "$up\u20acrS3cre7" }, "baseDir": { "type": "string", "description": "path below the webspace directory where the user starts", "example": "\/htdocs\/www.example.com\/website" }, "lastPasswordChange": { "type": "string", "description": "Timestamp of the last password change", "format": "datetime", "readOnly": true, "example": "1970-01-01T00:00:00Z" }, "userType": { "enum": [ "system", "virtual" ], "type": "string", "description": "type of the FTP user which can be a native system user or a virtual ftp user", "readOnly": true, "example": "virtual" } } } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/webspace\/{account}\/protect\/directories": { "get": { "tags": [ "Webspace" ], "summary": "List password protected directories", "description": "This method returns a list of all password protected directories of the given account.\nIf query variable `path` is given the output can be filtered by the directories path.\n", "parameters": [ { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } }, { "name": "path", "in": "query", "description": "path of the directory to filter by", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "required": [ "user" ], "type": "object", "properties": { "newPath": { "type": "string", "description": "only when editing existing object: new path (if path should be changed)", "example": "\/htdocs\/new-datashare" }, "path": { "type": "string", "description": "path of the directory (relative to the account base directory)", "example": "\/htdocs\/datashare" }, "title": { "type": "string", "description": "Title for the directory", "example": "Share for Engineers" }, "users": { "type": "array", "items": { "type": "string" }, "description": "User names which have access to this directory", "example": [ "user1", "user2", "user3" ] } } } } }, "description": "a list of all password protected directories" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Webspace" ], "summary": "Add password protection to directory", "description": "This method is used for adding password protection to a directory", "parameters": [ { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } } ], "requestBody": { "description": "Data of new directory", "content": { "application\/json": { "schema": { "required": [ "user" ], "type": "object", "properties": { "newPath": { "type": "string", "description": "only when editing existing object: new path (if path should be changed)", "example": "\/htdocs\/new-datashare" }, "path": { "type": "string", "description": "path of the directory (relative to the account base directory)", "example": "\/htdocs\/datashare" }, "title": { "type": "string", "description": "Title for the directory", "example": "Share for Engineers" }, "users": { "type": "array", "items": { "type": "string" }, "description": "User names which have access to this directory", "example": [ "user1", "user2", "user3" ] } } } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Webspace" ], "summary": "Remove password protection from directory", "description": "This method removes the password protection from the given directory.\n", "parameters": [ { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } }, { "name": "path", "in": "query", "description": "path of the directory", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Webspace" ], "summary": "Edit password protection of directory", "description": "This method is used for editing password protection of a directory", "parameters": [ { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } } ], "requestBody": { "description": "Data of directory", "content": { "application\/json": { "schema": { "allOf": [ { "required": [ "user" ], "type": "object", "properties": { "newPath": { "type": "string", "description": "only when editing existing object: new path (if path should be changed)", "example": "\/htdocs\/new-datashare" }, "path": { "type": "string", "description": "path of the directory (relative to the account base directory)", "example": "\/htdocs\/datashare" }, "title": { "type": "string", "description": "Title for the directory", "example": "Share for Engineers" }, "users": { "type": "array", "items": { "type": "string" }, "description": "User names which have access to this directory", "example": [ "user1", "user2", "user3" ] } } } ] } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/webspace\/{account}\/protect\/users": { "get": { "tags": [ "Webspace" ], "summary": "Get password protection user list", "description": "This method returns a list of all password protection users of the given account.\n", "parameters": [ { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "allOf": [ { "required": [ "user" ], "type": "object", "properties": { "password": { "type": "string", "description": "password of the user", "writeOnly": true, "example": "$ecr\u20actW0rd" }, "lastPasswordChange": { "type": "string", "description": "Timestamp of last password change", "format": "date-time", "readOnly": true, "example": "2021-11-09T11:22:33Z" } } }, { "type": "object", "properties": { "user": { "type": "string", "description": "name of the password protection user", "readOnly": true, "example": "john" } } } ] } } }, "description": "a list of all password protection users" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "post": { "tags": [ "Webspace" ], "summary": "Create new password protection user", "description": "This method is used for adding a new password protection user", "parameters": [ { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } } ], "requestBody": { "description": "Data of new user", "content": { "application\/json": { "schema": { "allOf": [ { "required": [ "user" ], "type": "object", "properties": { "password": { "type": "string", "description": "password of the user", "writeOnly": true, "example": "$ecr\u20actW0rd" }, "lastPasswordChange": { "type": "string", "description": "Timestamp of last password change", "format": "date-time", "readOnly": true, "example": "2021-11-09T11:22:33Z" } } }, { "type": "object", "properties": { "user": { "type": "string", "description": "name of the password protection user", "example": "john" } } } ] } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/webspace\/{account}\/protect\/users\/{user}": { "get": { "tags": [ "Webspace" ], "summary": "Get details of a password protection user", "description": "This method returns the details of a password protection users for the given account.\n", "parameters": [ { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } }, { "name": "user", "in": "path", "description": "user name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "allOf": [ { "required": [ "user" ], "type": "object", "properties": { "password": { "type": "string", "description": "password of the user", "writeOnly": true, "example": "$ecr\u20actW0rd" }, "lastPasswordChange": { "type": "string", "description": "Timestamp of last password change", "format": "date-time", "readOnly": true, "example": "2021-11-09T11:22:33Z" } } }, { "type": "object", "properties": { "login": { "type": "string", "description": "login of the password protection user", "readOnly": true, "example": "john" } } } ] } }, "description": "details of password protection user" } } } }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "503": { "description": "Service unavailable: either the server or the requested resource is currently unavailable.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "delete": { "tags": [ "Webspace" ], "summary": "Delete a password protection user", "description": "This method deletes the given password protection user of the given account.\n", "parameters": [ { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } }, { "name": "user", "in": "path", "description": "user name", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } }, "patch": { "tags": [ "Webspace" ], "summary": "Edit password protection user", "description": "This method is used for editing a password protection user", "parameters": [ { "name": "account", "in": "path", "description": "Name of the account", "schema": { "type": "string" } }, { "name": "user", "in": "path", "description": "user name", "schema": { "type": "string" } } ], "requestBody": { "description": "Data of user", "content": { "application\/json": { "schema": { "required": [ "user" ], "type": "object", "properties": { "password": { "type": "string", "description": "password of the user", "writeOnly": true, "example": "$ecr\u20actW0rd" }, "lastPasswordChange": { "type": "string", "description": "Timestamp of last password change", "format": "date-time", "readOnly": true, "example": "2021-11-09T11:22:33Z" } } } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "The submitted request data was malformed (see details in error object)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "401": { "description": "Unauthorized (i.e. no API key submitted)", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "403": { "description": "Not authorized to use this function", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "404": { "description": "Resource not found", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } }, "500": { "description": "An internal error occured.", "content": { "application\/problem+json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } } } }, "\/webspace\/{account}\/traffic": { "get": { "tags": [ "Webspace" ], "summary": "Traffic statistics", "description": "Return statistics on traffic usage for given account", "parameters": [ { "name": "account", "in": "path", "description": "the name of the account", "required": true, "schema": { "type": "string" } }, { "name": "range", "in": "query", "description": "range for the traffic statistics", "schema": { "enum": [ "hour", "day", "week" ], "type": "string", "default": "hour" } } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "hits": { "type": "integer", "description": "website hits", "readOnly": true, "example": 12 }, "in": { "type": "integer", "description": "bytes received", "readOnly": true, "example": 78943532 }, "out": { "type": "integer", "description": "bytes sent", "readOnly": true, "example": 2536543542 }, "ts": { "type": "string", "description": "timestamp of this datapoint", "format": "date", "readOnly": true, "example": "2025-04-15T00:00:00Z" } }, "description": "traffic data point", "readOnly": true } } }, "description": "traffic data points for given account" } } } } } } } }, "components": { "responses": { "default": { "description": "unexpected error", "content": { "application\/json": { "schema": { "required": [ "success", "status", "title", "detail" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "Always `false` on error" }, "status": { "type": "integer", "description": "HTTP status code" }, "title": { "type": "string", "description": "Corresponding name for the HTTP status" }, "detail": { "oneOf": [ { "type": "string", "description": "Detailed error message" }, { "type": "object", "additionalProperties": true } ] } }, "example": { "success": false, "status": 404, "title": "Not found", "detail": "The requested resource was not found (either not existing, or not permitted to access it)" } } } } } }, "securitySchemes": { "bearerAuth": { "type": "http", "description": "API keys can be generated in the user settings. \nUsers with reseller permission can *additionally* submit a HTTP header `X-Customer-ID` to act on behalf of a direct customer's main user,\n*or* `X-User-Name` to act on behalf of the given user at an arbitrary reseller depth.\n", "scheme": "bearer", "bearerFormat": "API key" }, "customerId": { "type": "apiKey", "description": "Customer ID when acting on behalf of a reseller.\n", "name": "X-Customer-ID", "in": "header" }, "userName": { "type": "apiKey", "description": "User name when acting on behalf of a reseller.\n", "name": "X-User-Name", "in": "header" } } }, "security": [ { "bearerAuth": [] }, { "bearerAuth": [], "customerId": [] }, { "bearerAuth": [], "userName": [] } ], "tags": [ { "name": "Accounts", "description": "Manage accounts and templates. For template management, at least a _Standard License_ is required.\n", "summary": "Manage accounts" }, { "name": "Backup", "description": "Backup management" }, { "name": "Certificates", "description": "Manage TLS (SSL) certificates" }, { "name": "Contacts", "description": "Manage contacts" }, { "name": "Customers", "description": "Manage customers. For this feature, at least a _Standard License_ is required.\n", "summary": "Manage customers" }, { "name": "Custom Links", "description": "Manage sections & links for the IFRAME API" }, { "name": "Databases", "description": "Manage databases" }, { "name": "Domains", "description": "Manage domains and subdomains" }, { "name": "DNS-Settings", "description": "Manage DNS Templates and external nameservers" }, { "name": "EventLog", "description": "EventLogs" }, { "name": "Mailboxes", "description": "Manage e-mail addresses" }, { "name": "LiveConfig", "description": "Control panel management" }, { "name": "PHP-Settings", "description": "PHP.ini Settings Management" }, { "name": "Servers", "description": "Manage servers" }, { "name": "TlsCerts", "description": "Manage TLS\/SSL Certificates" }, { "name": "Users", "description": "Manage users" }, { "name": "Webspace", "description": "Manage webspace" }, { "name": "Apps", "description": "Appinstaller" }, { "name": "News", "description": "News" }, { "name": "Reports", "description": "Reports" } ] }