{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "domain.com" } ], "info": { "name": "Tenantos API Documentation", "_postman_id": "8b5ec7e9-906d-4923-99fb-ac9891cd5b16", "description": "Tenantos API", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Alias Roles", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/users\/alias-users\/", "item": [ { "name": "api\/aliasRoles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aliasRoles", "query": [], "raw": "{{baseUrl}}\/api\/aliasRoles" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":[{\"name\":\"Admin Alias Role \",\"id\":6,\"assignedUsers\":[{\"userId\":11,\"fullname\":\"Admin Alias User\",\"username\":\"exampleAliasUser\"}],\"notDeleteable\":0,\"notAssignable\":0,\"ownedBy\":{\"userId\":1,\"fullname\":\"Mable White\",\"username\":\"adm\"},\"ownerUserId\":1,\"type\":\"user_created\",\"permissions\":[],\"isAliasRole\":1}],\"message\":\"success\"}", "name": "" } ] }, { "name": "POST api\/aliasRoles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aliasRoles", "query": [], "raw": "{{baseUrl}}\/api\/aliasRoles" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"est\",\"permissionlist\":[\"servers.update.param.tags\",\"servers.apiOutput.param.tags\"],\"permissionsets\":[\"Manage Server Description\"],\"userId\":4}" }, "description": "The available permissions can be requested via the `api\/permissions` endpoint." }, "response": [] }, { "name": "api\/aliasRoles\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aliasRoles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/aliasRoles\/:id", "variable": [ { "id": "id", "key": "id", "value": "6", "description": "The ID of the role." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":null,\"message\":\"success\"}", "name": "" } ] }, { "name": "PUT api\/aliasRoles\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aliasRoles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/aliasRoles\/:id", "variable": [ { "id": "id", "key": "id", "value": "11", "description": "The ID of the role." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"recusandae\",\"permissionlist\":[\"servers.update.param.tags\",\"servers.apiOutput.param.tags\"],\"permissionsets\":[\"Manage Server Description\"],\"serversIndexDisablePermissionChecks\":true}" }, "description": "The available permissions can be requested via the `api\/permissions` endpoint." }, "response": [] }, { "name": "api\/aliasRoles\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aliasRoles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/aliasRoles\/:id", "variable": [ { "id": "id", "key": "id", "value": "15", "description": "The ID of the role." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Alias Users", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/users\/alias-users\/", "item": [ { "name": "api\/aliasUsers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aliasUsers", "query": [], "raw": "{{baseUrl}}\/api\/aliasUsers" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":[{\"id\":11,\"name\":\"Admin Alias User\",\"email\":null,\"created_at\":\"2025-08-25T15:19:02.000000Z\",\"root_owner\":1,\"username\":\"exampleAliasUser\",\"accountstatus\":\"enabled\",\"isParentAccountSuspended\":0,\"isSharedAccess\":true,\"sharedUserId\":1,\"realOrSharedUserId\":1,\"role_id\":6,\"role_name\":\"Admin Alias Role \",\"root_owner_username\":\"adm\",\"lastlogin\":{\"date\":\"Never\",\"ip\":\"-\"},\"canCreateSubUsers\":1,\"description\":null,\"user_alias_assignments\":[]}],\"message\":\"success\"}", "name": "" } ] }, { "name": "POST api\/aliasUsers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aliasUsers", "query": [], "raw": "{{baseUrl}}\/api\/aliasUsers" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "API parameters are the same as for the [`POST api\/users` endpoint](#users-POSTapi-users)." }, "response": [] }, { "name": "api\/aliasUsers\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aliasUsers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/aliasUsers\/:id", "variable": [ { "id": "id", "key": "id", "value": "quia", "description": "The ID of the aliasUser." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_alias_assignments\":{\"type\":\"servers\",\"itemIds\":[8],\"hasAccessToAllItems\":false},\"accountstatus\":\"disabled\",\"role_id\":3}" }, "description": "" }, "response": [] }, { "name": "api\/aliasUsers\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aliasUsers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/aliasUsers\/:id", "variable": [ { "id": "id", "key": "id", "value": "enim", "description": "The ID of the aliasUser." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Brands", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/branding\/branding\/", "item": [ { "name": "api\/system\/brands\/{brand}\/logos\/store", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/brands\/:brand\/logos\/store", "query": [], "raw": "{{baseUrl}}\/api\/system\/brands\/:brand\/logos\/store", "variable": [ { "id": "brand", "key": "brand", "value": "ipsam", "description": "The brand." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "lightlogo", "src": [], "type": "file" }, { "key": "darklogo", "src": [], "type": "file" }, { "key": "favicon", "src": [], "type": "file" } ] }, "description": "" }, "response": [] }, { "name": "api\/system\/brands\/{brand}\/logos\/delete", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/brands\/:brand\/logos\/delete", "query": [], "raw": "{{baseUrl}}\/api\/system\/brands\/:brand\/logos\/delete", "variable": [ { "id": "brand", "key": "brand", "value": "maxime", "description": "The brand." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"lightlogo\":true,\"darklogo\":true,\"favicon\":true}" }, "description": "" }, "response": [] }, { "name": "api\/system\/brands", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/brands", "query": [], "raw": "{{baseUrl}}\/api\/system\/brands" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 1,\n\"user_id\": 1,\n\"domain\": \"domain.com\",\n\"login_page_text\": \"Server Management\",\n\"top_navbar_header_title\": \"Tenantos\",\n\"page_title\": \"Control\",\n\"color_scheme\": {\n\"light\": {\n\"primary\": \"#0C47A0\",\n\"...\": \"...\"\n},\n\"dark\": {\n\"primary\": \"#536DFE\",\n\"...\": \"...\"\n}\n},\n\"languageOverrides\": [],\n\"languageData\": [\n{\"en-us\": {\"common_table_nodata_reload\": \"No data available. Reload?\", \"...\": \"...\" }}\n],\n\"navbar_text_instead_logo\": 0,\n\"navbar_logo_always_dark\": 1,\n\"loginpage_text_instead_logo\": 0,\n\"loginpage_logo_always_dark\": 0,\n\"loginpage_logo_above_form\": 0,\n\"loginpage_show_text_within_form\": 0,\n\"navbar_logo_max_height\": 30,\n\"loginpage_logo_max_height\": 40,\n\"theme_flat_buttons\": 0,\n\"theme_cards_elevation\": 3,\n\"theme_cards_outlined\": 0,\n\"theme_top_bar_full_length\": 0,\n\"theme_serverpage_notes_importantNotes_showOnTop\": 0,\n\"default_theme_mode\": \"light\",\n\"availableLanguages\": [\n{\n\"languageName\": \"English\",\n\"languageCode\": \"en-us\"\n}\n],\n\"defaultColorScheme\": {\n\"light\": {\n\"primary\": \"#0C47A0\",\n\"...\": \"...\"\n},\n\"dark\": {\n\"primary\": \"#536DFE\",\n\"...\": \"...\"\n}\n},\n\"logos\": {\n\"favicon\": {\n\"publicPath\": \"\/storage\/brands\/1\/logos\/favicon_673930630b2c9.png\"\n},\n\"lightlogo\": {\n\"publicPath\": \"\/storage\/brands\/1\/logos\/lightlogo_3e6ed656923ef.png\"\n},\n\"darklogo\": {\n\"publicPath\": \"\/storage\/brands\/1\/logos\/darklogo_e4c15c2d3b6e5.png\"\n}\n}\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/system\/brands", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/brands", "query": [], "raw": "{{baseUrl}}\/api\/system\/brands" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"domain\":\"app.domain.com\"}" }, "description": "" }, "response": [] }, { "name": "api\/system\/brands\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/brands\/:id", "query": [], "raw": "{{baseUrl}}\/api\/system\/brands\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the brand." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\":\n{\n\"id\": 1,\n\"user_id\": 1,\n\"domain\": \"domain.com\",\n\"login_page_text\": \"Server Management\",\n\"top_navbar_header_title\": \"Tenantos\",\n\"page_title\": \"Control\",\n\"color_scheme\": {\n\"light\": {\n\"primary\": \"#0C47A0\",\n\"...\": \"...\"\n},\n\"dark\": {\n\"primary\": \"#536DFE\",\n\"...\": \"...\"\n}\n},\n\"languageOverrides\": [],\n\"languageData\": [\n{\"en-us\": {\"common_table_nodata_reload\": \"No data available. Reload?\", \"...\": \"...\" }}\n],\n\"navbar_text_instead_logo\": 0,\n\"navbar_logo_always_dark\": 1,\n\"loginpage_text_instead_logo\": 0,\n\"loginpage_logo_always_dark\": 0,\n\"loginpage_logo_above_form\": 0,\n\"loginpage_show_text_within_form\": 0,\n\"navbar_logo_max_height\": 30,\n\"loginpage_logo_max_height\": 40,\n\"theme_flat_buttons\": 0,\n\"theme_cards_elevation\": 3,\n\"theme_cards_outlined\": 0,\n\"theme_top_bar_full_length\": 0,\n\"theme_serverpage_notes_importantNotes_showOnTop\": 0,\n\"default_theme_mode\": \"light\",\n\"availableLanguages\": [\n{\n\"languageName\": \"English\",\n\"languageCode\": \"en-us\"\n}\n],\n\"defaultColorScheme\": {\n\"light\": {\n\"primary\": \"#0C47A0\",\n\"...\": \"...\"\n},\n\"dark\": {\n\"primary\": \"#536DFE\",\n\"...\": \"...\"\n}\n},\n\"logos\": {\n\"favicon\": {\n\"publicPath\": \"\/storage\/brands\/1\/logos\/favicon_673930630b2c9.png\"\n},\n\"lightlogo\": {\n\"publicPath\": \"\/storage\/brands\/1\/logos\/lightlogo_3e6ed656923ef.png\"\n},\n\"darklogo\": {\n\"publicPath\": \"\/storage\/brands\/1\/logos\/darklogo_e4c15c2d3b6e5.png\"\n}\n}\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/system\/brands\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/brands\/:id", "query": [], "raw": "{{baseUrl}}\/api\/system\/brands\/:id", "variable": [ { "id": "id", "key": "id", "value": "18", "description": "The ID of the brand." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"login_page_text\":\"Login To App\",\"page_title\":\"Tenantos\",\"top_navbar_header_title\":\"Tenantos\",\"color_scheme\":{\"dark\":{\"primary\":\"#536DFE\"},\"light\":{\"primary\":\"#0C47A0\"}},\"user_id\":14,\"languageOverrides\":{\"en-us\":{\"common_table_nodata_reload\":\"No data available. Reload?\"}},\"navbar_text_instead_logo\":true,\"navbar_logo_always_dark\":false,\"loginpage_text_instead_logo\":true,\"loginpage_logo_always_dark\":false,\"loginpage_logo_above_form\":true,\"loginpage_show_text_within_form\":true,\"navbar_logo_max_height\":4,\"loginpage_logo_max_height\":6,\"theme_flat_buttons\":true,\"theme_cards_elevation\":19,\"theme_cards_outlined\":false,\"theme_top_bar_full_length\":true,\"theme_serverpage_notes_importantNotes_showOnTop\":true,\"default_theme_mode\":\"dark\",\"availableLanguages\":[{\"languageName\":\"\",\"languageCode\":\"es\"}]}" }, "description": "" }, "response": [] }, { "name": "api\/system\/brands\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/brands\/:id", "query": [], "raw": "{{baseUrl}}\/api\/system\/brands\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the brand." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "External Providers", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/external-providers\/about-external-providers\/", "item": [ { "name": "api\/externalProviders", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/externalProviders", "query": [], "raw": "{{baseUrl}}\/api\/externalProviders" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 1,\n\"provider\": \"proxmox\",\n\"name\": \"host-01\",\n\"apiUrl\": \"proxmox01.domain.com\",\n\"apiUser\": \"root\",\n\"apiPassword\": \"**************\",\n\"meta\": null,\n\"isStandaloneRdnsProvider\": [],\n\"usage\": {\n\"serverIds\": [\n2,\n3,\n4,\n5\n]\n}\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/externalProviders", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/externalProviders", "query": [], "raw": "{{baseUrl}}\/api\/externalProviders" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"provider\":\"novoserve\",\"name\":\"Host-01\",\"apiUrl\":\"proxmox01.domain.com\",\"apiUser\":\"root\",\"apiPassword\":\"secret\",\"meta\":[]}" }, "description": "" }, "response": [] }, { "name": "api\/externalProviders\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/externalProviders\/:id", "query": [], "raw": "{{baseUrl}}\/api\/externalProviders\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the provider." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"id\": 1,\n\"provider\": \"proxmox\",\n\"name\": \"Host 01\",\n\"apiUrl\": \"proxmox01.domain.com\",\n\"apiUser\": \"root\",\n\"apiPassword\": \"**************\",\n\"meta\": null,\n\"providerDetails\": {\n\"nodes\": [\n{\n\"value\": \"host01\",\n\"name\": \"host01\"\n},\n{\n\"value\": \"host02\",\n\"name\": \"host02\"\n}\n],\n\"storages\": {\n\"host01\": [\n{\n\"shared\": 0,\n\"used\": 1719563468800,\n\"content\": [\n\"snippets\",\n\"images\",\n\"iso\",\n\"rootdir\",\n\"vztmpl\",\n\"backup\"\n],\n\"used_fraction\": 0.881667875391091,\n\"type\": \"dir\",\n\"total\": 1950352867328,\n\"avail\": 220859899904,\n\"enabled\": 1,\n\"storage\": \"local\",\n\"active\": 1,\n\"backendId\": \"local\"\n}\n],\n\"host02\": [\n{\n\"avail\": 87191961600,\n\"active\": 1,\n\"total\": 468513751040,\n\"enabled\": 1,\n\"content\": [\n\"iso\",\n\"snippets\",\n\"vztmpl\",\n\"rootdir\",\n\"images\",\n\"backup\"\n],\n\"storage\": \"local\",\n\"used_fraction\": 0.811824328459309,\n\"type\": \"dir\",\n\"used\": 380350861312,\n\"shared\": 0,\n\"backendId\": \"local\"\n}\n]\n},\n\"networks\": {\n\"host02\": [\n{\n\"bridge_stp\": \"off\",\n\"bridge_ports\": \"enp2s0\",\n\"options\": [\n\"hwaddress 44:aa:5b:2c:3c:dc\",\n\"pointopoint 192.168.100.1\",\n\"bridge_hello 2\",\n\"bridge_maxage 12\"\n],\n\"cidr\": \"10.10.11.10\/24\",\n\"address\": \"10.10.11.10\",\n\"type\": \"bridge\",\n\"autostart\": 1,\n\"method6\": \"manual\",\n\"iface\": \"vmbr0\",\n\"bridge_fd\": \"1\",\n\"families\": [\n\"inet\"\n],\n\"priority\": 4,\n\"method\": \"static\",\n\"netmask\": \"32\",\n\"gateway\": \"10.10.11.1\",\n\"active\": 1,\n\"backendId\": \"vmbr0\"\n},\n{\n\"method6\": \"manual\",\n\"autostart\": 1,\n\"type\": \"bridge\",\n\"mtu\": \"1400\",\n\"bridge_fd\": 0,\n\"iface\": \"vmbr2\",\n\"bridge_ports\": \"enp2s0.4000\",\n\"bridge_stp\": \"off\",\n\"address\": \"10.10.11.2\",\n\"cidr\": \"10.10.11.2\/24\",\n\"method\": \"static\",\n\"active\": 1,\n\"netmask\": \"24\",\n\"priority\": 6,\n\"families\": [\n\"inet\"\n],\n\"backendId\": \"vmbr2\"\n}\n],\n\"host01\": [\n{\n\"netmask\": \"29\",\n\"bridge_fd\": \"0\",\n\"bridge_ports\": \"\",\n\"address\": \"10.20.10.5\",\n\"active\": 1,\n\"autostart\": 1,\n\"cidr\": \"10.20.10.5\/24\",\n\"method6\": \"manual\",\n\"bridge_stp\": \"off\",\n\"iface\": \"vmbr0\",\n\"families\": [\n\"inet\"\n],\n\"type\": \"bridge\",\n\"method\": \"static\",\n\"priority\": 12,\n\"backendId\": \"vmbr3\"\n}\n]\n},\n\"haGroups\": [\n{\n\"group\": \"ha-group-ceph-1\",\n\"comment\": \"Ceph nodes\"\n},\n{\n\"group\": \"ha-group-nfs-1\",\n\"comment\": \"NFS, only for dev\"\n}\n]\n},\n\"nodeResources\": {\n \"host01\": {\n \"cpuCores\": 8,\n \"cpuUtil\": 0.0133663366336634,\n \"maxMem\": 33523425280,\n \"usedMem\": 25098756096,\n \"freeMem\": 8424669184,\n \"memUsagePercentage\": 74.8693067201992,\n \"uptime\": 54516143,\n \"status\": \"online\"\n },\n \"host02\": {\n \"cpuCores\": 8,\n \"cpuUtil\": 0.510303390007536,\n \"maxMem\": 67213066240,\n \"usedMem\": 43491606528,\n \"freeMem\": 23721459712,\n \"memUsagePercentage\": 64.70707105178482,\n \"uptime\": 54137712,\n \"status\": \"online\"\n }\n},\n\"availableVpsBalancerPlans\": [\n {\n \"id\": 1,\n \"created_at\": \"2023-05-03T21:11:53.000000Z\",\n \"updated_at\": \"2023-05-03T21:11:53.000000Z\",\n \"planname\": \"Balancer #1\",\n \"cpuPriority\": 2,\n \"cpuRequireIdlePercentage\": 30,\n \"storagePriority\": 1,\n \"storageReserveFreeAmount\": 20,\n \"ramPriority\": 1.5,\n \"ramReserveFreeAmount\": 10,\n \"vmCountPriority\": 1,\n \"vmMaxAmount\": 50,\n \"nodeMustMatchRegex\": \"\/^node[0-9]+$\/\",\n \"nodeMustNotMatchRegex\": \"\/^gluster[0-9]+$\/\"\n }\n],\n\"isStandaloneRdnsProvider\": [],\n\"usage\": {\n\"serverIds\": [\n2,\n3,\n4,\n5\n]\n}\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/externalProviders\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/externalProviders\/:id", "query": [], "raw": "{{baseUrl}}\/api\/externalProviders\/:id", "variable": [ { "id": "id", "key": "id", "value": "7", "description": "The ID of the provider." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Host-01\",\"apiUrl\":\"proxmox01.domain.com\",\"apiUser\":\"root\",\"apiPassword\":\"secret\",\"meta\":[]}" }, "description": "" }, "response": [] }, { "name": "api\/externalProviders\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/externalProviders\/:id", "query": [], "raw": "{{baseUrl}}\/api\/externalProviders\/:id", "variable": [ { "id": "id", "key": "id", "value": "17", "description": "The ID of the provider." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Files", "description": "\nTo some objects files can be attached (e.g. server comments). This endpoint is used to download and delete these files.", "item": [ { "name": "api\/files\/{fileId}\/download", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/files\/:fileId\/download", "query": [], "raw": "{{baseUrl}}\/api\/files\/:fileId\/download", "variable": [ { "id": "fileId", "key": "fileId", "value": "voluptatem", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 500, "body": "{\"message\":\"Exception\",\"result\":\"Access to this file denied or file not found.\"}", "name": "" } ] }, { "name": "api\/files\/{fileId}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/files\/:fileId", "query": [], "raw": "{{baseUrl}}\/api\/files\/:fileId", "variable": [ { "id": "fileId", "key": "fileId", "value": "neque", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "IP Management", "description": "\n**These API endpoints are, by default, only accessible as admin and are not intended for normal users.**", "item": [ { "name": "api\/ip\/massaction", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/ip\/massaction", "query": [], "raw": "{{baseUrl}}\/api\/ip\/massaction" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"mode\":\"reserve\",\"ips\":[\"10.10.10.28\",\"10.10.10.29\"],\"type\":\"singleIp\"}" }, "description": "" }, "response": [] }, { "name": "api\/ip\/reserve", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/ip\/reserve", "query": [], "raw": "{{baseUrl}}\/api\/ip\/reserve" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"adminIp\":\"10.10.10.20\",\"type\":\"singleIp\"}" }, "description": "" }, "response": [] }, { "name": "api\/ip\/unreserve", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/ip\/unreserve", "query": [], "raw": "{{baseUrl}}\/api\/ip\/unreserve" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"adminIp\":\"10.10.10.20\",\"type\":\"singleIp\"}" }, "description": "" }, "response": [] }, { "name": "POST api\/ip\/comment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/ip\/comment", "query": [], "raw": "{{baseUrl}}\/api\/ip\/comment" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"comment\":\"VPN IP\",\"adminIp\":\"10.10.10.20\",\"type\":\"singleIp\"}" }, "description": "If a user wants to create a comment for an IP, the `PUT api\/servers\/{server_id}\/ipassignments\/{id}` endpoint can be used." }, "response": [] }, { "name": "api\/ip\/delete", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/ip\/delete", "query": [], "raw": "{{baseUrl}}\/api\/ip\/delete" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"adminIp\":\"quasi\",\"type\":\"subnet\"}" }, "description": "" }, "response": [] } ] }, { "name": "Inventory", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/inventory-manager\/inventory-manager\/", "item": [ { "name": "api\/inventorycomponents\/customfields", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inventorycomponents\/customfields", "query": [], "raw": "{{baseUrl}}\/api\/inventorycomponents\/customfields" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":[{\"id\":1,\"name\":\"Disk Type\",\"type\":\"dropdown\",\"availableValues\":[{\"id\":\"1\",\"value\":\"HDD\"},{\"id\":\"2\",\"value\":\"SSD\"},{\"id\":\"3\",\"value\":\"NVMe\"}],\"notdeletable\":1,\"created_at\":\"2021-12-25T23:14:22.000000Z\",\"updated_at\":\"2021-12-25T23:14:22.000000Z\"},{\"id\":2,\"name\":\"Cores\",\"type\":\"input\",\"availableValues\":[],\"notdeletable\":1,\"created_at\":\"2021-12-27T00:00:00.000000Z\",\"updated_at\":\"2021-12-27T22:41:28.000000Z\"},{\"id\":3,\"name\":\"MHz Turbo\",\"type\":\"input\",\"availableValues\":[],\"notdeletable\":1,\"created_at\":\"2021-12-27T00:00:00.000000Z\",\"updated_at\":\"2021-12-27T22:41:30.000000Z\"},{\"id\":4,\"name\":\"MHz Normal\",\"type\":\"input\",\"availableValues\":[],\"notdeletable\":1,\"created_at\":\"2021-12-27T00:00:00.000000Z\",\"updated_at\":\"2021-12-27T22:41:32.000000Z\"},{\"id\":5,\"name\":\"Threads\",\"type\":\"input\",\"availableValues\":[],\"notdeletable\":1,\"created_at\":\"2021-12-27T00:00:00.000000Z\",\"updated_at\":\"2021-12-27T22:41:33.000000Z\"}],\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/inventorycomponents\/customfields", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inventorycomponents\/customfields", "query": [], "raw": "{{baseUrl}}\/api\/inventorycomponents\/customfields" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Datacenter\",\"type\":\"dropdown\",\"availableValues\":[\"Datacenter-1\",\"Datacenter-2\"]}" }, "description": "" }, "response": [] }, { "name": "api\/inventorycomponents\/customfields\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inventorycomponents\/customfields\/:id", "query": [], "raw": "{{baseUrl}}\/api\/inventorycomponents\/customfields\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the inventory component custom field." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":{\"id\":1,\"name\":\"Disk Type\",\"type\":\"dropdown\",\"availableValues\":[{\"id\":\"1\",\"value\":\"HDD\"},{\"id\":\"2\",\"value\":\"SSD\"},{\"id\":\"3\",\"value\":\"NVMe\"}],\"notdeletable\":1,\"created_at\":\"2021-12-25T23:14:22.000000Z\",\"updated_at\":\"2021-12-25T23:14:22.000000Z\"},\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/inventorycomponents\/customfields\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inventorycomponents\/customfields\/:id", "query": [], "raw": "{{baseUrl}}\/api\/inventorycomponents\/customfields\/:id", "variable": [ { "id": "id", "key": "id", "value": "14", "description": "The ID of the inventory component custom field." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Datacenter\",\"type\":\"dropdown\",\"availableValues\":[\"Datacenter-1\",\"Datacenter-2\"]}" }, "description": "" }, "response": [] }, { "name": "api\/inventorycomponents\/customfields\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inventorycomponents\/customfields\/:id", "query": [], "raw": "{{baseUrl}}\/api\/inventorycomponents\/customfields\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the inventory component custom field." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "api\/inventorycomponents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inventorycomponents", "query": [], "raw": "{{baseUrl}}\/api\/inventorycomponents" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":[{\"id\":1,\"created_at\":\"2025-08-25T15:17:58.000000Z\",\"updated_at\":\"2025-08-25T15:17:58.000000Z\",\"componentname\":\"cpu\",\"description\":\"CPU Model\",\"notdeletable\":1,\"groupname\":\"Hardware\",\"valueType\":\"MHz\",\"customfieldsRelations\":[2,3,4,5],\"customfields\":[{\"field_id\":2,\"name\":\"Cores\",\"type\":\"input\",\"values\":[]},{\"field_id\":3,\"name\":\"MHz Turbo\",\"type\":\"input\",\"values\":[]},{\"field_id\":4,\"name\":\"MHz Normal\",\"type\":\"input\",\"values\":[]},{\"field_id\":5,\"name\":\"Threads\",\"type\":\"input\",\"values\":[]}]},{\"id\":2,\"created_at\":\"2025-08-25T15:17:58.000000Z\",\"updated_at\":\"2025-08-25T15:17:58.000000Z\",\"componentname\":\"memory\",\"description\":\"RAM\",\"notdeletable\":1,\"groupname\":\"Hardware\",\"valueType\":\"mb\",\"customfieldsRelations\":[],\"customfields\":[]},{\"id\":3,\"created_at\":\"2025-08-25T15:17:58.000000Z\",\"updated_at\":\"2025-08-25T15:17:58.000000Z\",\"componentname\":\"system\",\"description\":\"System\",\"notdeletable\":1,\"groupname\":\"Hardware\",\"valueType\":\"text\",\"customfieldsRelations\":[],\"customfields\":[]},{\"id\":4,\"created_at\":\"2025-08-25T15:17:58.000000Z\",\"updated_at\":\"2025-08-25T15:17:58.000000Z\",\"componentname\":\"bios\",\"description\":\"BIOS\",\"notdeletable\":1,\"groupname\":\"Hardware\",\"valueType\":\"text\",\"customfieldsRelations\":[],\"customfields\":[]},{\"id\":5,\"created_at\":\"2025-08-25T15:17:58.000000Z\",\"updated_at\":\"2025-08-25T15:17:58.000000Z\",\"componentname\":\"storage_controller\",\"description\":\"Storage Controller\",\"notdeletable\":1,\"groupname\":\"Hardware\",\"valueType\":\"text\",\"customfieldsRelations\":[],\"customfields\":[]},{\"id\":6,\"created_at\":\"2025-08-25T15:17:58.000000Z\",\"updated_at\":\"2025-08-25T15:17:58.000000Z\",\"componentname\":\"mainboard\",\"description\":\"Mainboard Model\",\"notdeletable\":1,\"groupname\":\"Hardware\",\"valueType\":\"text\",\"customfieldsRelations\":[],\"customfields\":[]},{\"id\":7,\"created_at\":\"2025-08-25T15:17:58.000000Z\",\"updated_at\":\"2025-08-25T15:18:27.000000Z\",\"componentname\":\"disk\",\"description\":\"Disk\",\"notdeletable\":1,\"groupname\":\"Hardware\",\"valueType\":\"mib\",\"customfieldsRelations\":[1],\"customfields\":[{\"field_id\":1,\"name\":\"Disk Type\",\"type\":\"dropdown\",\"values\":[{\"id\":\"1\",\"value\":\"HDD\"},{\"id\":\"2\",\"value\":\"SSD\"},{\"id\":\"3\",\"value\":\"NVMe\"}]}]},{\"id\":8,\"created_at\":\"2025-08-25T15:17:58.000000Z\",\"updated_at\":\"2025-08-25T15:17:58.000000Z\",\"componentname\":\"nic\",\"description\":\"NIC\",\"notdeletable\":1,\"groupname\":\"Hardware\",\"valueType\":\"text\",\"customfieldsRelations\":[],\"customfields\":[]},{\"id\":9,\"created_at\":\"2025-08-25T15:18:28.000000Z\",\"updated_at\":\"2025-08-25T15:18:28.000000Z\",\"componentname\":\"raid_controller\",\"description\":\"RAID Controller\",\"notdeletable\":1,\"groupname\":\"Hardware\",\"valueType\":\"text\",\"customfieldsRelations\":[],\"customfields\":[]}],\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/inventorycomponents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inventorycomponents", "query": [], "raw": "{{baseUrl}}\/api\/inventorycomponents" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupname\":\"Software\",\"description\":\"Software licenses\",\"componentname\":\"Software name\",\"customfieldsRelations\":[1,3],\"valueType\":\"text\"}" }, "description": "" }, "response": [] }, { "name": "api\/inventorycomponents\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inventorycomponents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/inventorycomponents\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the inventory component." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":{\"id\":1,\"created_at\":\"2025-08-25T15:17:58.000000Z\",\"updated_at\":\"2025-08-25T15:17:58.000000Z\",\"componentname\":\"cpu\",\"description\":\"CPU Model\",\"notdeletable\":1,\"groupname\":\"Hardware\",\"valueType\":\"MHz\",\"customfieldsRelations\":[2,3,4,5],\"customfields\":[{\"field_id\":2,\"name\":\"Cores\",\"type\":\"input\",\"values\":[]},{\"field_id\":3,\"name\":\"MHz Turbo\",\"type\":\"input\",\"values\":[]},{\"field_id\":4,\"name\":\"MHz Normal\",\"type\":\"input\",\"values\":[]},{\"field_id\":5,\"name\":\"Threads\",\"type\":\"input\",\"values\":[]}]},\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/inventorycomponents\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inventorycomponents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/inventorycomponents\/:id", "variable": [ { "id": "id", "key": "id", "value": "2", "description": "The ID of the inventory component." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupname\":\"Software\",\"description\":\"Software licenses\",\"componentname\":\"Software name\",\"customfieldsRelations\":[1,3],\"valueType\":\"text\"}" }, "description": "" }, "response": [] }, { "name": "api\/inventorycomponents\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inventorycomponents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/inventorycomponents\/:id", "variable": [ { "id": "id", "key": "id", "value": "9", "description": "The ID of the inventory component." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Network Devices", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/network-devices\/network-devices\/", "item": [ { "name": "POST api\/networkDevices\/{networkDevice}\/actions\/testConnectivity", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/networkDevices\/:networkDevice\/actions\/testConnectivity", "query": [], "raw": "{{baseUrl}}\/api\/networkDevices\/:networkDevice\/actions\/testConnectivity", "variable": [ { "id": "networkDevice", "key": "networkDevice", "value": "8", "description": "The ID of the network device." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"useCache\":true}" }, "description": "Tests if the connection between the Tenantos main server and the network device does work." }, "response": [] }, { "name": "api\/networkDevices", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/networkDevices", "query": [], "raw": "{{baseUrl}}\/api\/networkDevices" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"id\": 1,\n\"name\": \"EX3200\",\n\"host\": \"192.168.188.223\",\n\"deviceType\": \"snmp_switch\",\n\"snmpCommunity\": \"Aks8gkjsa8a2\",\n\"snmpVersion\": \"2c\",\n\"agentId\": 1,\n\"features\": [\n\"bw_collection\"\n],\n\"meta\": {\n\"cachePorts\": true\n},\n\"username\": \"\",\n\"password\": \"\",\n\"port\": null,\n\"statusCache\": [],\n\"snmpAuthAlgo\": null,\n\"snmpAuthLevel\": null,\n\"snmpCryptoAlgo\": null,\n\"snmpCryptoPassword\": \"\",\n\"enableAdvancedManagement\": 1,\n\"managementVendor\": \"juniperSsh\",\n\"managementPort\": \"22\",\n\"managementUser\": \"root\",\n\"managementPassword\": \"secret\",\n\"rootType\": \"snmp_switch\",\n\"extendedDetailsAvailable\": true\n}", "name": "" } ] }, { "name": "api\/networkDevices", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/networkDevices", "query": [], "raw": "{{baseUrl}}\/api\/networkDevices" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"deviceType\":\"snmp_switch\",\"name\":\"nisi\",\"host\":\"switch01.domain.com\",\"snmpCommunity\":\"et\",\"snmpVersion\":\"2c\",\"enableAdvancedManagement\":false,\"managementVendor\":\"tempora\",\"managementPort\":50454,\"managementUser\":\"modi\",\"managementPassword\":\"ratione\",\"agentId\":1,\"features\":[\"bw_collection\"],\"meta\":{\"flip_in_out\":\"true\"}}" }, "description": "" }, "response": [] }, { "name": "api\/networkDevices\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/networkDevices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/networkDevices\/:id", "variable": [ { "id": "id", "key": "id", "value": "2", "description": "The ID of the network device." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"id\": 3,\n\"name\": \"EdgeSwitch WZ\",\n\"host\": \"192.168.188.215\",\n\"deviceType\": \"snmp_switch\",\n\"snmpCommunity\": \"secret\",\n\"snmpVersion\": \"2c\",\n\"agentId\": 1,\n\"features\": [\n\"bw_collection\"\n],\n\"meta\": {\n\"cachePorts\": true\n},\n\"username\": \"\",\n\"password\": \"\",\n\"port\": null,\n\"statusCache\": [],\n\"snmpAuthAlgo\": null,\n\"snmpAuthLevel\": null,\n\"snmpCryptoAlgo\": null,\n\"snmpCryptoPassword\": \"\",\n\"enableAdvancedManagement\": null,\n\"managementVendor\": null,\n\"managementPort\": null,\n\"managementUser\": \"\",\n\"managementPassword\": \"\",\n\"ports\": [\n{\n\"id\": 1,\n\"name\": \"GigabitEthernet1\",\n\"assignments\": []\n},\n{\n\"id\": 1007,\n\"name\": \"LAG8\",\n\"assignments\": []\n}\n],\n\"rootType\": \"snmp_switch\",\n\"extendedDetailsAvailable\": true\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/networkDevices\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/networkDevices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/networkDevices\/:id", "variable": [ { "id": "id", "key": "id", "value": "9", "description": "The ID of the network device." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"deviceType\":\"snmp_switch\",\"name\":\"eos\",\"host\":\"switch01.domain.com\",\"snmpCommunity\":\"laborum\",\"snmpVersion\":\"2c\",\"enableAdvancedManagement\":true,\"managementVendor\":\"eveniet\",\"managementPort\":31852,\"managementUser\":\"repellendus\",\"managementPassword\":\"velit\",\"agentId\":1,\"features\":[\"bw_collection\"],\"meta\":{\"flip_in_out\":\"true\"}}" }, "description": "" }, "response": [] }, { "name": "api\/networkDevices\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/networkDevices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/networkDevices\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "The ID of the network device." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "api\/networkDevices\/{networkDevice}\/actions\/{networkDeviceAction}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/networkDevices\/:networkDevice\/actions\/:networkDeviceAction", "query": [], "raw": "{{baseUrl}}\/api\/networkDevices\/:networkDevice\/actions\/:networkDeviceAction", "variable": [ { "id": "networkDevice", "key": "networkDevice", "value": "1", "description": "The ID of the network device." }, { "id": "networkDeviceAction", "key": "networkDeviceAction", "value": "getFeatures", "description": "The action to execute. Use `getFeatures` to see the available actions. The features depend on the network device type." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"clearCache\": {\n\"requestBody\": []\n},\n\"getFeatures\": {\n\"requestBody\": []\n},\n\"getStatistics\": {\n\"requestBody\": {\n\"portIds\": {\n\"type\": \"array\",\n\"required\": false,\n\"example\": [\n\"1\",\n\"2\",\n\"3\"\n]\n},\n\"mode\": {\n\"type\": \"string\",\n\"required\": false,\n\"example\": \"text or graph\"\n},\n\"groupBy\": {\n\"type\": \"string\",\n\"required\": false,\n\"example\": \"1d\"\n},\n\"from\": {\n\"type\": \"datetime\",\n\"required\": false,\n\"example\": \"2024-08-02 09:12:27\"\n},\n\"to\": {\n\"type\": \"datetime\",\n\"required\": false,\n\"example\": \"2024-09-02 09:12:27\"\n}\n}\n},\n\"setPortEnabled\": {\n\"requestBody\": {\n\"portId\": {\n\"type\": \"string\",\n\"required\": true,\n\"example\": \"ge-0\/0\/1\"\n}\n}\n},\n\"setPortDisabled\": {\n\"requestBody\": {\n\"portId\": {\n\"type\": \"string\",\n\"required\": true,\n\"example\": \"ge-0\/0\/1\"\n}\n}\n},\n\"setInterfaceDescription\": {\n\"requestBody\": {\n\"portId\": {\n\"type\": \"string\",\n\"required\": true,\n\"example\": \"ge-0\/0\/1\"\n},\n\"description\": {\n\"type\": \"string\",\n\"required\": true,\n\"example\": \"Uplink to core switch\"\n}\n}\n},\n\"deleteVlanFromInterface\": {\n\"requestBody\": {\n\"portId\": {\n\"type\": \"string\",\n\"required\": true,\n\"example\": \"ge-0\/0\/1\"\n},\n\"vlanId\": {\n\"type\": \"integer\",\n\"required\": true,\n\"example\": 100\n}\n}\n},\n\"updateInterface\": {\n\"requestBody\": {\n\"portId\": {\n\"type\": \"string\",\n\"required\": true,\n\"example\": \"ge-0\/0\/1\"\n},\n\"portAdminStatus\": {\n\"type\": \"string\",\n\"required\": false,\n\"example\": \"enabled\"\n},\n\"trunkNativeVlan\": {\n\"type\": \"string\",\n\"required\": false,\n\"example\": \"0\"\n},\n\"trunkVlans\": {\n\"type\": \"array\",\n\"required\": false,\n\"example\": [\n10,\n20,\n30\n]\n},\n\"accessVlan\": {\n\"type\": \"string\",\n\"required\": false,\n\"example\": \"0\"\n},\n\"description\": {\n\"type\": \"string\",\n\"required\": false,\n\"example\": \"Uplink to core switch\"\n}\n}\n},\n\"updateVlan\": {\n\"requestBody\": {\n\"id\": {\n\"type\": \"string|integer\",\n\"required\": true,\n\"example\": \"30\"\n},\n\"name\": {\n\"type\": \"string\",\n\"required\": false,\n\"example\": \"vlan30\"\n},\n\"l3Ips\": {\n\"type\": \"array\",\n\"required\": false,\n\"example\": [\n\"10.10.10.1\/24\",\n\"10.10.11.1\/24\"\n]\n}\n}\n},\n\"createVlan\": {\n\"requestBody\": {\n\"id\": {\n\"type\": \"string|integer\",\n\"required\": true,\n\"example\": \"30\"\n},\n\"name\": {\n\"type\": \"string\",\n\"required\": true,\n\"example\": \"vlan30\"\n},\n\"l3Ips\": {\n\"type\": \"array\",\n\"required\": false,\n\"example\": [\n\"10.10.10.1\/24\",\n\"10.10.11.1\/24\"\n]\n}\n}\n},\n\"getActionLogs\": {\n\"requestBody\": []\n}\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/networkDevices\/{networkDevice}\/extendedDetails", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/networkDevices\/:networkDevice\/extendedDetails", "query": [], "raw": "{{baseUrl}}\/api\/networkDevices\/:networkDevice\/extendedDetails", "variable": [ { "id": "networkDevice", "key": "networkDevice", "value": "assumenda", "description": "The networkDevice." }, { "id": "id", "key": "id", "value": "2", "description": "The ID of the network device." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"id\": 2,\n\"created_at\": \"2024-09-01T22:11:49.000000Z\",\n\"updated_at\": \"2024-09-01T22:11:49.000000Z\",\n\"name\": \"USG 3G\",\n\"host\": \"192.168.188.1\",\n\"deviceType\": \"snmp_switch\",\n\"snmpCommunity\": \"secret\",\n\"snmpVersion\": \"2c\",\n\"agentId\": 1,\n\"features\": [\n\"bw_collection\"\n],\n\"meta\": {\n\"cachePorts\": true\n},\n\"username\": \"\",\n\"password\": \"\",\n\"port\": null,\n\"statusCache\": {\n\"content\": {\n\"success\": 1,\n\"result\": \"EdgeOS v4.4.57.5578372.230112.0823\"\n},\n\"time\": 1725264053\n},\n\"snmpAuthAlgo\": null,\n\"snmpAuthLevel\": null,\n\"snmpCryptoAlgo\": null,\n\"snmpCryptoPassword\": \"\",\n\"enableAdvancedManagement\": null,\n\"managementVendor\": null,\n\"managementPort\": null,\n\"managementUser\": \"\",\n\"managementPassword\": \"\",\n\"ports\": [\n{\n\"id\": 1,\n\"name\": \"lo\",\n\"assignments\": []\n},\n{\n\"id\": 2,\n\"name\": \"eth0\",\n\"assignments\": [\n{\n\"type\": \"server\",\n\"relId\": 2,\n\"connectionId\": 25\n},\n{\n\"type\": \"server\",\n\"relId\": 61,\n\"connectionId\": 26\n}\n]\n}\n],\n\"extendedDetails\": {\n\"ports\": [\n{\n\"name\": \"lo\",\n\"portOperStatus\": \"1\",\n\"portAdminStatus\": \"1\",\n\"description\": \"lo\",\n\"alias\": \"lo\",\n\"linkSpeed\": \"10\",\n\"ifType\": \"24\",\n\"id\": 1,\n\"assignments\": []\n},\n{\n\"name\": \"eth0\",\n\"portOperStatus\": \"1\",\n\"portAdminStatus\": \"1\",\n\"description\": \"eth0\",\n\"alias\": \"WAN\",\n\"linkSpeed\": \"1000\",\n\"ifType\": \"6\",\n\"id\": 2,\n\"assignments\": [\n{\n\"type\": \"server\",\n\"relId\": 2,\n\"connectionId\": 25\n},\n{\n\"type\": \"server\",\n\"relId\": 61,\n\"connectionId\": 26\n}\n]\n}\n],\n\"advancedManagementAvailable\": 0\n},\n\"rootType\": \"snmp_switch\",\n\"extendedDetailsAvailable\": true\n},\n\"message\": \"success\"\n}", "name": "" } ] } ] }, { "name": "Others", "description": "", "item": [ { "name": "api\/system\/version", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/version", "query": [], "raw": "{{baseUrl}}\/api\/system\/version" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":{\"app_version\":\"1.0.36\",\"app_changelog_link\":\"https:\\\/\\\/documentation.tenantos.com\\\/changelog\\\/Tenantos\\\/\",\"updateAvailable\":0,\"updateVersion\":\"1.0.36\"},\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/system\/listTimezones", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/listTimezones", "query": [], "raw": "{{baseUrl}}\/api\/system\/listTimezones" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n\"Africa\/Abidjan\",\n\"Africa\/Accra\",\n\"...\"\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "GET api\/ping", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/ping", "query": [], "raw": "{{baseUrl}}\/api\/ping" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint provides a simple and resource-efficient way to check if the API is reachable." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":\"pong\",\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/system\/listTimeDateFormats", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/listTimeDateFormats", "query": [], "raw": "{{baseUrl}}\/api\/system\/listTimeDateFormats" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":[{\"format\":\"DD.MM.YYYY HH:mm:ss\",\"example\":\"25.08.2025 15:29:17\"},{\"format\":\"DD\\\/MM\\\/YYYY HH:mm:ss\",\"example\":\"25\\\/08\\\/2025 15:29:17\"},{\"format\":\"DD-MM-YYYY HH:mm:ss\",\"example\":\"25-08-2025 15:29:17\"},{\"format\":\"MM.DD.YYYY HH:mm:ss\",\"example\":\"08.25.2025 15:29:17\"},{\"format\":\"MM\\\/DD\\\/YYYY HH:mm:ss\",\"example\":\"08\\\/25\\\/2025 15:29:17\"},{\"format\":\"MM-DD-YYYY HH:mm:ss\",\"example\":\"08-25-2025 15:29:17\"},{\"format\":\"YYYY.MM.DD HH:mm:ss\",\"example\":\"2025.08.25 15:29:17\"},{\"format\":\"YYYY\\\/MM\\\/DD HH:mm:ss\",\"example\":\"2025\\\/08\\\/25 15:29:17\"},{\"format\":\"YYYY-MM-DD HH:mm:ss\",\"example\":\"2025-08-25 15:29:17\"}],\"message\":\"success\"}", "name": "" } ] }, { "name": "GET api\/system\/settingsAfterLogin", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/settingsAfterLogin", "query": [], "raw": "{{baseUrl}}\/api\/system\/settingsAfterLogin" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint is queried by the browser after logging in into the Tenantos web interface. The response contains various settings for the user interface, such as which checkboxes should be activated by default." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":{\"precheck_addserver_redirect_to_server\":\"off\",\"show_server_id_on_server_detail_page\":\"off\",\"precheck_adduser_redirect_to_user\":\"off\",\"precheck_deleteserver_delete_vm_on_node\":\"off\",\"server_console_show_dialog\":\"on\",\"ui_connection_assignments_dont_show_already_assigned_items\":\"off\",\"precheck_networkgraph_show_summary\":\"off\",\"networkgraphs_show_total_p95th_line\":\"off\",\"password_hide_ipmipass\":\"show\",\"ui_users_allow_power_actions_during_pxe_boot\":\"off\",\"ui_admins_allow_power_actions_during_pxe_boot\":\"off\",\"suspension_default_network_action\":\"off\",\"suspension_default_power_action\":\"off\",\"suspension_affect_all_network_ports\":\"off\",\"suspension_actions_in_background\":\"off\",\"ui_pxemanager_hide_disabled_pxeprofiles\":\"off\",\"ui_pxemanager_hide_disabled_disklayouts\":\"off\",\"ui_pxemanager_hide_disabled_scripts\":\"off\",\"ui_password_hide_passwords_generally_by_default\":\"off\"},\"message\":\"success\"}", "name": "" } ] }, { "name": "GET api\/system\/ui\/uiLanguage", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/ui\/uiLanguage", "query": [], "raw": "{{baseUrl}}\/api\/system\/ui\/uiLanguage" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint is queried by the browser before and after logging into the Tenantos interface. The response contains the language files and may differ depending on the brand\/domain." }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"en-us\": {\n\"common_table_nodata_reload\": \"No data available. Reload?\",\n\"common_table_placeholder_search\": \"Search...\",\n\"...\": \"...\"\n}\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "GET api\/system\/ui\/settings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/ui\/settings", "query": [], "raw": "{{baseUrl}}\/api\/system\/ui\/settings" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint is queried by the browser before logging into the Tenantos interface. The response contains various settings for the user interface, such as the color scheme and various texts. The response may differ depending on the brand\/domain." }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"top_navbar_header_title\": \"Tenantos\",\n\"page_title\": \"Control\",\n\"login_page_text\": \"Server Management\",\n\"theme_dark\": {\n\"primary\": \"#536DFE\",\n\"...\": \"...\"\n},\n\"theme_light\": {\n\"primary\": \"#0C47A0\",\n\"...\": \"...\"\n}\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/system\/ui\/version", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/ui\/version", "query": [], "raw": "{{baseUrl}}\/api\/system\/ui\/version" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":{\"frontend_version\":\"897701fbf2f63c25509aa6f5d846e00430b3090dda1cb121b1a4f94391691e48\"},\"message\":\"success\"}", "name": "" } ] } ] }, { "name": "PXE Basic Operations", "description": "", "item": [ { "name": "api\/pxe\/profiles\/{pxeProfileId}\/duplicate", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/profiles\/:pxeProfileId\/duplicate", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/profiles\/:pxeProfileId\/duplicate", "variable": [ { "id": "pxeProfileId", "key": "pxeProfileId", "value": "16", "description": "The ID of the PXE profile which should be duplicated." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"sit\"}" }, "description": "" }, "response": [] }, { "name": "api\/pxe\/scripts\/{pxeScriptId}\/duplicate", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/scripts\/:pxeScriptId\/duplicate", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/scripts\/:pxeScriptId\/duplicate", "variable": [ { "id": "pxeScriptId", "key": "pxeScriptId", "value": "18", "description": "The ID of the PXE script which should be duplicated." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"eaque\"}" }, "description": "" }, "response": [] }, { "name": "api\/pxe\/disklayouts\/{pxeDisklayoutId}\/duplicate", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/disklayouts\/:pxeDisklayoutId\/duplicate", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/disklayouts\/:pxeDisklayoutId\/duplicate", "variable": [ { "id": "pxeDisklayoutId", "key": "pxeDisklayoutId", "value": "9", "description": "The ID of the PXE script which should be duplicated." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"est\"}" }, "description": "" }, "response": [] }, { "name": "POST api\/os\/list", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/os\/list", "query": [], "raw": "{{baseUrl}}\/api\/os\/list" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"pxe\"}" }, "description": "Normally the available profiles are queried via the `api\/servers\/{server}\/provisioning\/getProfiles` endpoint, but there are situations where all available profiles need to be queried (e.g. for billing integrations)." }, "response": [] } ] }, { "name": "PXE Disklayouts", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/pxe-manager\/disklayouts\/disklayouts\/", "item": [ { "name": "api\/pxe\/disklayouts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/disklayouts", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/disklayouts" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 2,\n\"tags\": [\n\"preseed\",\n\"kickstart\"\n],\n\"disklayout\": \"\",\n\"name\": \"Auto RAID\",\n\"isDisabled\": 0,\n\"isStockTemplate\": 1,\n\"internal_key\": \"auto_raid\",\n\"isAutoRaid\": 1,\n\"min_disks\": null,\n\"offer_if_has_tag\": [],\n\"dont_offer_if_has_tag\": [],\n\"offer_if_user_has_role\": [],\n\"dont_offer_if_user_has_role\": [],\n\"allow_for_vps\": 1,\n\"allow_for_dedicated\": 1\n},\n{\n\"id\": 4,\n\"tags\": [\n\"kickstart\",\n\"preseed\"\n],\n\"disklayout\": \"\",\n\"name\": \"RAID 1\",\n\"isDisabled\": 0,\n\"isStockTemplate\": 1,\n\"internal_key\": \"auto_raid_1\",\n\"isAutoRaid\": 1,\n\"min_disks\": 2,\n\"offer_if_has_tag\": [],\n\"dont_offer_if_has_tag\": [],\n\"offer_if_user_has_role\": [],\n\"dont_offer_if_user_has_role\": [],\n\"allow_for_vps\": 1,\n\"allow_for_dedicated\": 1\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/pxe\/disklayouts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/disklayouts", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/disklayouts" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"tags\":[\"kickstart\"],\"disklayout\":\"autopart --type=lvm\",\"name\":\"accusamus\",\"min_disks\":3,\"isDisabled\":true,\"offer_if_has_tag\":[\"rerum\"],\"dont_offer_if_has_tag\":[\"odit\"],\"offer_if_user_has_role\":[null],\"dont_offer_if_user_has_role\":[null],\"allow_for_vps\":true,\"allow_for_dedicated\":false,\"hw_raid_handling\":\"dont_offer_if_hw_raid\"}" }, "description": "" }, "response": [] }, { "name": "api\/pxe\/disklayouts\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/disklayouts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/disklayouts\/:id", "variable": [ { "id": "id", "key": "id", "value": "2", "description": "The ID of the disk layout." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"id\": 2,\n\"tags\": [\n\"preseed\",\n\"kickstart\"\n],\n\"disklayout\": \"\",\n\"name\": \"Auto RAID\",\n\"isDisabled\": 0,\n\"isStockTemplate\": 1,\n\"internal_key\": \"auto_raid\",\n\"isAutoRaid\": 1,\n\"min_disks\": null,\n\"offer_if_has_tag\": [],\n\"dont_offer_if_has_tag\": [],\n\"offer_if_user_has_role\": [],\n\"dont_offer_if_user_has_role\": [],\n\"allow_for_vps\": 1,\n\"allow_for_dedicated\": 1\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/pxe\/disklayouts\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/disklayouts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/disklayouts\/:id", "variable": [ { "id": "id", "key": "id", "value": "19", "description": "The ID of the disk layout." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"tags\":[\"kickstart\"],\"disklayout\":\"autopart --type=lvm\",\"name\":\"adipisci\",\"min_disks\":3,\"isDisabled\":true,\"offer_if_has_tag\":[\"alias\"],\"dont_offer_if_has_tag\":[\"et\"],\"offer_if_user_has_role\":[null],\"dont_offer_if_user_has_role\":[null],\"partition_size_boot\":13,\"partition_size_efi\":94,\"allow_for_vps\":true,\"allow_for_dedicated\":false,\"hw_raid_handling\":\"always_offer\"}" }, "description": "" }, "response": [] }, { "name": "api\/pxe\/disklayouts\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/disklayouts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/disklayouts\/:id", "variable": [ { "id": "id", "key": "id", "value": "8", "description": "The ID of the disk layout." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "PXE Profiles", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/pxe-manager\/profiles\/profile\/", "item": [ { "name": "GET api\/pxe\/tags", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/tags", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/tags" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all available PXE tags (aggregated from all PXE profiles)." }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"tags\": [\n{\n\"id\": \"kickstart\",\n\"name\": \"kickstart\"\n},\n{\n\"id\": \"centos\",\n\"name\": \"centos\"\n}\n]\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/pxe\/tags\/getPxeProfilesByTags", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/tags\/getPxeProfilesByTags", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/tags\/getPxeProfilesByTags" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"tags\":[\"et\"]}" }, "description": "" }, "response": [] }, { "name": "GET api\/pxe\/profiles\/{pxeProfileId}\/clearcache", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/profiles\/:pxeProfileId\/clearcache", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/profiles\/:pxeProfileId\/clearcache", "variable": [ { "id": "pxeProfileId", "key": "pxeProfileId", "value": "1", "description": "The ID of the PXE profile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes all cached OS data from all remote agents for this profile. Tenantos caches the files necessary for the installation of the respective operating system.\n\nWindows operating system installation files cannot be deleted because Windows is imported from an ISO and not downloaded from a remote server." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":\"ok\",\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/pxe\/profiles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/profiles", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/profiles" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 2,\n\"tags\": [\n\"kickstart\",\n\"centos\"\n],\n\"osName\": \"CentOS 8\",\n\"pxeConfig\": \"...\",\n\"pxeType\": \"kickstart\",\n\"networkConfigMode\": null,\n\"defaultDiskLayout\": \"...\",\n\"customPostScript\": \"\",\n\"customFirstBoot\": \"\",\n\"packages\": \"...\",\n\"language\": \"en_US\",\n\"autoInstallTemplate\": \"...\",\n\"timezone\": \"Etc\/UTC\",\n\"mirrorUrl\": \"...\",\n\"cacheDirectory\": \"centos8\",\n\"httpdirectory\": \"\",\n\"version\": null,\n\"isStockTemplate\": 1,\n\"isDisabled\": 0,\n\"allow_ssh_keys\": 1,\n\"default_disklayout_template\": 2,\n\"enforced_default_disklayout_template\": 0,\n\"default_run_scripts\": [\n1\n],\n\"enforced_default_run_scripts\": 1,\n\"default_run_scripts_hide_others\": 0,\n\"allow_set_hostname\": 1,\n\"set_root_password\": 1,\n\"mark_installation_completed_event\": \"firstBootAfterScriptExecution\",\n\"pxe_file_caching_policy\": \"smartCaching\",\n\"configure_all_ipvfour_ask_user\": null,\n\"configure_all_ipvfour_enforce\": 1,\n\"configure_ipvfour_even_if_outside_of_gateway\": 1,\n\"configure_all_ipvsix_ask_user\": null,\n\"configure_all_ipvsix_enforce\": 1,\n\"offer_if_has_tag\": [],\n\"dont_offer_if_has_tag\": [],\n\"offer_if_user_has_role\": [],\n\"dont_offer_if_user_has_role\": [],\n\"windows_activation_key\": null,\n\"windows_use_empty_activation_key\": null,\n\"windows_key_location_userdata\": null,\n\"windows_key_location_specialize\": null,\n\"windows_skip_oobe\": null,\n\"windows_bypass_system_requirements_check\": null,\n\"allow_for_vps\": 1,\n\"allow_for_dedicated\": 1,\n\"fallback_to_default_disklayout_if_unset\": 1,\n\"pxe_enable_comboot\": null,\n\"licensekey\": null,\n\"additionalDriversUrl\": null,\n\"disklayouts\": [\n{\n\"id\": 2,\n\"name\": \"Auto RAID\"\n}\n],\n\"scripts\": [\n{\n\"id\": 1,\n\"name\": \"System Upgrade\"\n}\n],\n\"isRescue\": 0\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/pxe\/profiles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/profiles", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/profiles" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"tags\":[\"kickstart \"],\"osName\":\"nobis\",\"pxeType\":\"kickstart\",\"pxeConfig\":\"#!ipxe\",\"defaultDiskLayout\":\"autopart --type=lvm\",\"packages\":\"kexec-tools\",\"language\":\"sequi\",\"autoInstallTemplate\":\"network --bootproto=static\",\"timezone\":\"sed\",\"mirrorUrl\":\"http:\\\/\\\/mirror.fra10.de.leaseweb.net\\\/centos\\\/8-stream\\\/BaseOS\\\/x86_64\\\/os\",\"additionalDriversUrl\":\"https:\\\/\\\/domain.com\\\/drivers\",\"cacheDirectory\":\"centos8\",\"networkConfigMode\":\"default\",\"httpdirectory\":\"vel\",\"version\":\"voluptate\",\"customFirstBoot\":\"touch \\\/root\\\/123\",\"customPostScript\":\"touch \\\/root\\\/123\",\"isDisabled\":true,\"allow_ssh_keys\":true,\"allow_set_hostname\":true,\"allow_for_vps\":true,\"allow_for_dedicated\":false,\"set_root_password\":true,\"updateServerHardwareInventory\":false,\"mark_installation_completed_event\":\"firstBootAfterScriptExecution\",\"default_disklayout_template\":4,\"fallback_to_default_disklayout_if_unset\":false,\"enforced_default_disklayout_template\":false,\"default_run_scripts\":[\"nulla\"],\"enforced_default_run_scripts\":true,\"default_run_scripts_hide_others\":false,\"configure_all_ipvfour_ask_user\":false,\"configure_all_ipvfour_enforce\":true,\"configure_ipvfour_even_if_outside_of_gateway\":true,\"configure_all_ipvsix_ask_user\":true,\"configure_all_ipvsix_enforce\":false,\"offer_if_has_tag\":[\"aut\"],\"dont_offer_if_has_tag\":[\"ex\"],\"offer_if_user_has_role\":[null],\"dont_offer_if_user_has_role\":[null],\"windows_activation_key\":\"ipsam\",\"windows_use_empty_activation_key\":false,\"windows_key_location_userdata\":false,\"windows_key_location_specialize\":false,\"windows_bypass_system_requirements_check\":true,\"windows_skip_oobe\":true,\"pxe_enable_comboot\":true,\"ipxe_bios_file\":\"facere\",\"ipxe_efi_file\":\"atque\",\"licensekey\":\"voluptatem\",\"keep_dhcp_minutes\":4340,\"pxe_file_caching_policy\":\"keepAsLongAsPossible\"}" }, "description": "" }, "response": [] }, { "name": "api\/pxe\/profiles\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/profiles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/profiles\/:id", "variable": [ { "id": "id", "key": "id", "value": "2", "description": "The ID of the PXE profile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"id\": 2,\n\"tags\": [\n\"kickstart\",\n\"centos\"\n],\n\"osName\": \"CentOS 8\",\n\"pxeConfig\": \"...\",\n\"pxeType\": \"kickstart\",\n\"networkConfigMode\": null,\n\"defaultDiskLayout\": \"...\",\n\"customPostScript\": \"\",\n\"customFirstBoot\": \"\",\n\"packages\": \"...\",\n\"language\": \"en_US\",\n\"autoInstallTemplate\": \"...\",\n\"timezone\": \"Etc\/UTC\",\n\"mirrorUrl\": \"...\",\n\"cacheDirectory\": \"centos8\",\n\"httpdirectory\": \"\",\n\"version\": null,\n\"isStockTemplate\": 1,\n\"isDisabled\": 0,\n\"allow_ssh_keys\": 1,\n\"default_disklayout_template\": 2,\n\"enforced_default_disklayout_template\": 0,\n\"default_run_scripts\": [\n1\n],\n\"enforced_default_run_scripts\": 1,\n\"default_run_scripts_hide_others\": 0,\n\"allow_set_hostname\": 1,\n\"set_root_password\": 1,\n\"mark_installation_completed_event\": \"firstBootAfterScriptExecution\",\n\"pxe_file_caching_policy\": \"smartCaching\",\n\"configure_all_ipvfour_ask_user\": null,\n\"configure_all_ipvfour_enforce\": 1,\n\"configure_ipvfour_even_if_outside_of_gateway\": null,\n\"configure_all_ipvsix_ask_user\": null,\n\"configure_all_ipvsix_enforce\": 1,\n\"offer_if_has_tag\": [],\n\"dont_offer_if_has_tag\": [],\n\"offer_if_user_has_role\": [],\n\"dont_offer_if_user_has_role\": [],\n\"windows_activation_key\": null,\n\"windows_use_empty_activation_key\": null,\n\"windows_key_location_userdata\": null,\n\"windows_key_location_specialize\": null,\n\"windows_skip_oobe\": null,\n\"windows_bypass_system_requirements_check\": null,\n\"allow_for_vps\": 1,\n\"allow_for_dedicated\": 1,\n\"fallback_to_default_disklayout_if_unset\": 1,\n\"pxe_enable_comboot\": null,\n\"licensekey\": null,\n\"additionalDriversUrl\": null,\n\"disklayouts\": [\n{\n\"id\": 2,\n\"name\": \"Auto RAID\"\n}\n],\n\"scripts\": [\n{\n\"id\": 1,\n\"name\": \"System Upgrade\"\n}\n],\n\"isRescue\": 0\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/pxe\/profiles\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/profiles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/profiles\/:id", "variable": [ { "id": "id", "key": "id", "value": "2", "description": "The ID of the PXE profile." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"tags\":[\"kickstart \"],\"osName\":\"rerum\",\"pxeType\":\"kickstart\",\"pxeConfig\":\"#!ipxe\",\"defaultDiskLayout\":\"autopart --type=lvm\",\"packages\":\"kexec-tools\",\"language\":\"iste\",\"autoInstallTemplate\":\"network --bootproto=static\",\"timezone\":\"sint\",\"mirrorUrl\":\"http:\\\/\\\/mirror.fra10.de.leaseweb.net\\\/centos\\\/8-stream\\\/BaseOS\\\/x86_64\\\/os\",\"additionalDriversUrl\":\"https:\\\/\\\/domain.com\\\/drivers\",\"cacheDirectory\":\"centos8\",\"networkConfigMode\":\"ex\",\"httpdirectory\":\"at\",\"version\":\"atque\",\"customFirstBoot\":\"touch \\\/root\\\/123\",\"customPostScript\":\"touch \\\/root\\\/123\",\"isDisabled\":false,\"allow_ssh_keys\":true,\"allow_for_vps\":true,\"allow_for_dedicated\":true,\"allow_set_hostname\":true,\"set_root_password\":true,\"updateServerHardwareInventory\":false,\"mark_installation_completed_event\":\"firstBootBeforeScriptExecution\",\"default_disklayout_template\":4,\"fallback_to_default_disklayout_if_unset\":true,\"enforced_default_disklayout_template\":false,\"default_run_scripts\":[\"quo\"],\"enforced_default_run_scripts\":true,\"default_run_scripts_hide_others\":true,\"configure_all_ipvfour_ask_user\":true,\"configure_all_ipvfour_enforce\":true,\"configure_ipvfour_even_if_outside_of_gateway\":false,\"configure_all_ipvsix_ask_user\":true,\"configure_all_ipvsix_enforce\":false,\"offer_if_has_tag\":[\"voluptatem\"],\"dont_offer_if_has_tag\":[\"modi\"],\"offer_if_user_has_role\":[null],\"dont_offer_if_user_has_role\":[null],\"windows_activation_key\":\"omnis\",\"windows_use_empty_activation_key\":true,\"windows_key_location_userdata\":false,\"windows_key_location_specialize\":false,\"windows_bypass_system_requirements_check\":true,\"windows_skip_oobe\":true,\"pxe_enable_comboot\":false,\"ipxe_bios_file\":\"error\",\"ipxe_efi_file\":\"rerum\",\"licensekey\":\"labore\",\"keep_dhcp_minutes\":1174,\"pxe_file_caching_policy\":\"dailyCleanup\"}" }, "description": "" }, "response": [] }, { "name": "api\/pxe\/profiles\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/profiles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/profiles\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the PXE profile." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "api\/pxe\/profiles\/{pxeProfileId}\/restore", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/profiles\/:pxeProfileId\/restore", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/profiles\/:pxeProfileId\/restore", "variable": [ { "id": "pxeProfileId", "key": "pxeProfileId", "value": "ex", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "PXE Scripts", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/pxe-manager\/scripts\/", "item": [ { "name": "api\/pxe\/scripts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/scripts", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/scripts" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 1,\n\"tags\": [\n\"kickstart\",\n\"preseed\",\n\"openvz 7\"\n],\n\"script\": \"...\",\n\"name\": \"System Upgrade\",\n\"isDisabled\": 0,\n\"isStockTemplate\": 1,\n\"offer_if_has_tag\": [],\n\"dont_offer_if_has_tag\": [],\n\"offer_if_user_has_role\": [],\n\"dont_offer_if_user_has_role\": [],\n\"allow_for_vps\": 1,\n\"allow_for_dedicated\": 1\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/pxe\/scripts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/scripts", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/scripts" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"tags\":[\"kickstart\"],\"script\":\"touch \\\/root\\\/123\",\"name\":\"quo\",\"isDisabled\":true,\"offer_if_has_tag\":[\"adipisci\"],\"dont_offer_if_has_tag\":[\"sit\"],\"offer_if_user_has_role\":[null],\"dont_offer_if_user_has_role\":[null],\"allow_for_vps\":false,\"allow_for_dedicated\":false}" }, "description": "" }, "response": [] }, { "name": "api\/pxe\/scripts\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/scripts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/scripts\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the PXE script." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\":\n{\n\"id\": 1,\n\"tags\": [\n\"kickstart\",\n\"preseed\",\n\"openvz 7\"\n],\n\"script\": \"...\",\n\"name\": \"System Upgrade\",\n\"isDisabled\": 0,\n\"isStockTemplate\": 1,\n\"offer_if_has_tag\": [],\n\"dont_offer_if_has_tag\": [],\n\"offer_if_user_has_role\": [],\n\"dont_offer_if_user_has_role\": []\n\"allow_for_vps\": 1,\n\"allow_for_dedicated\": 1\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/pxe\/scripts\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/scripts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/scripts\/:id", "variable": [ { "id": "id", "key": "id", "value": "19", "description": "The ID of the PXE script." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"tags\":[\"kickstart\"],\"script\":\"touch \\\/root\\\/123\",\"name\":\"eaque\",\"isDisabled\":true,\"offer_if_has_tag\":[\"expedita\"],\"dont_offer_if_has_tag\":[\"necessitatibus\"],\"offer_if_user_has_role\":[null],\"dont_offer_if_user_has_role\":[null],\"allow_for_vps\":true,\"allow_for_dedicated\":true}" }, "description": "" }, "response": [] }, { "name": "api\/pxe\/scripts\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/scripts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/scripts\/:id", "variable": [ { "id": "id", "key": "id", "value": "20", "description": "The ID of the PXE script." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "PXE Windows Profiles", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/pxe-manager\/profiles\/windows\/", "item": [ { "name": "api\/pxe\/windows\/importWindows", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/windows\/importWindows", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/windows\/importWindows" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"editions\":[\"Windows Server 2022 SERVERSTANDARD\"],\"cacheDirectory\":\"win2k22\",\"language\":\"en-us\",\"mode\":\"iso\"}" }, "description": "" }, "response": [] }, { "name": "GET api\/pxe\/windows\/getWindowsInformation", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pxe\/windows\/getWindowsInformation", "query": [], "raw": "{{baseUrl}}\/api\/pxe\/windows\/getWindowsInformation" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"mode\":\"iso\"}" }, "description": "Lists all available Windows versions of the ISO." }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"data\": [\n{\n\"build\": \"Windows Server 2022 SERVERSTANDARDCORE\",\n\"name\": \"Windows Server 2022 Standard Evaluation\",\n\"languages\": [\n\"en-us\"\n],\n\"size\": \"4810.42 MB\"\n}\n]\n},\n\"message\": \"success\"\n}", "name": "" } ] } ] }, { "name": "Remote Agents", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/remote-agents\/about-remote-agents\/", "item": [ { "name": "POST api\/remoteAgents\/{agentId}\/actions\/testConnectivity", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/remoteAgents\/:agentId\/actions\/testConnectivity", "query": [], "raw": "{{baseUrl}}\/api\/remoteAgents\/:agentId\/actions\/testConnectivity", "variable": [ { "id": "agentId", "key": "agentId", "value": "1", "description": "The ID of the agent." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"useCache\":true}" }, "description": "Tests if the connection between the Tenantos main server and the remote agent does work." }, "response": [] }, { "name": "api\/remoteAgents\/{agentId}\/actions\/getAssignments", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/remoteAgents\/:agentId\/actions\/getAssignments", "query": [], "raw": "{{baseUrl}}\/api\/remoteAgents\/:agentId\/actions\/getAssignments", "variable": [ { "id": "agentId", "key": "agentId", "value": "1", "description": "The ID of the agent." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"deviceId\": 1,\n\"name\": \"USG 3G\",\n\"rootType\": \"Network Device\",\n\"assignmentType\": \"snmp_switch\",\n\"features\": [\n\"bw_collection\"\n]\n},\n{\n\"deviceId\": 1,\n\"name\": \"server-001\",\n\"rootType\": \"Server\",\n\"assignmentType\": \"ipmi\",\n\"features\": [\n\"power_management\"\n]\n},\n{\n\"deviceId\": 1,\n\"name\": \"server-001\",\n\"rootType\": \"Server\",\n\"assignmentType\": \"pxe\",\n\"features\": [\n\"installation\"\n]\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "GET api\/remoteAgents\/ipmiKvmIsos", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/remoteAgents\/ipmiKvmIsos", "query": [], "raw": "{{baseUrl}}\/api\/remoteAgents\/ipmiKvmIsos" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Feature: https:\/\/documentation.tenantos.com\/Tenantos\/remote-agents\/ipmi-kvm-isos\/" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 1,\n\"created_at\": \"2025-05-01T11:29:46.000000Z\",\n\"name\": \"grml64-full 2021.07\",\n\"filename\": \"789_grml64-full.iso\",\n\"type\": \"public_admin\",\n\"status\": \"Completed\",\n\"state\": \"complete\",\n\"expectedSize\": 9547854,\n\"filesize\": 9547854,\n\"isDeletable\": true,\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/remoteAgents\/ipmiKvmIsos", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/remoteAgents\/ipmiKvmIsos", "query": [], "raw": "{{baseUrl}}\/api\/remoteAgents\/ipmiKvmIsos" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"cum\",\"downloadUrl\":\"https:\\\/\\\/download.grml.org\\\/grml64-full_2021.07.iso\"}" }, "description": "" }, "response": [] }, { "name": "api\/remoteAgents\/ipmiKvmIsos\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/remoteAgents\/ipmiKvmIsos\/:id", "query": [], "raw": "{{baseUrl}}\/api\/remoteAgents\/ipmiKvmIsos\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the ISO." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\":\n{\n\"id\": 1,\n\"created_at\": \"2025-05-01T11:29:46.000000Z\",\n\"name\": \"grml64-full 2021.07\",\n\"filename\": \"789_grml64-full.iso\",\n\"type\": \"public_admin\",\n\"status\": \"Completed\",\n\"state\": \"complete\",\n\"expectedSize\": 9547854,\n\"filesize\": 9547854,\n\"isDeletable\": true,\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/remoteAgents\/ipmiKvmIsos\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/remoteAgents\/ipmiKvmIsos\/:id", "query": [], "raw": "{{baseUrl}}\/api\/remoteAgents\/ipmiKvmIsos\/:id", "variable": [ { "id": "id", "key": "id", "value": "10", "description": "The ID of the ISO." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "api\/remoteAgents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/remoteAgents", "query": [], "raw": "{{baseUrl}}\/api\/remoteAgents" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 1,\n\"name\": \"Local Agent\",\n\"ip\": \"10.99.1.5\",\n\"hostname\": \"local-agent.domain.com\",\n\"sshport\": 22,\n\"installStatus\": 1\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/remoteAgents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/remoteAgents", "query": [], "raw": "{{baseUrl}}\/api\/remoteAgents" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"non\",\"hostname\":\"cum\",\"password\":\"inventore\",\"sshport\":10,\"ip\":\"in\"}" }, "description": "" }, "response": [] }, { "name": "api\/remoteAgents\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/remoteAgents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/remoteAgents\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the agent." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"id\": 1,\n\"name\": \"Local Agent\",\n\"ip\": \"10.99.1.5\",\n\"hostname\": \"local-agent.domain.com\",\n\"sshport\": 22,\n\"installStatus\": 1\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/remoteAgents\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/remoteAgents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/remoteAgents\/:id", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "The ID of the agent." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"saepe\",\"hostname\":\"consequatur\",\"sshport\":6}" }, "description": "" }, "response": [] }, { "name": "api\/remoteAgents\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/remoteAgents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/remoteAgents\/:id", "variable": [ { "id": "id", "key": "id", "value": "2", "description": "The ID of the agent." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "POST api\/remoteAgents\/{agentId}\/reprovisioning", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/remoteAgents\/:agentId\/reprovisioning", "query": [], "raw": "{{baseUrl}}\/api\/remoteAgents\/:agentId\/reprovisioning", "variable": [ { "id": "agentId", "key": "agentId", "value": "2", "description": "The ID of the agent to reprovision." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"veritatis\",\"hostname\":\"quia\",\"ip\":\"quia\",\"sshport\":11,\"password\":\"voluptatem\"}" }, "description": "Documentation: https:\/\/documentation.tenantos.com\/Tenantos\/remote-agents\/manage-remote-agents\/#redeploying-remote-agents\n\nReprovisions a remote agent by reinstalling the agent software on the target server.\nThis can be used to install on a new server or reinstall on the same server." }, "response": [] } ] }, { "name": "Reverse DNS", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/ip-manager\/rdns-servers\/\n\n**These API endpoints are, by default, only accessible as admin and are not intended for normal users.**", "item": [ { "name": "DELETE api\/subnets\/{subnet_id}\/rdnsAssignment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subnets\/:subnet\/rdnsAssignment", "query": [], "raw": "{{baseUrl}}\/api\/subnets\/:subnet\/rdnsAssignment", "variable": [ { "id": "subnet", "key": "subnet", "value": "3", "description": "The ID of the subnet." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes the assigned RDNS server from the subnet." }, "response": [] }, { "name": "GET api\/subnets\/{subnet_id}\/rdnsAssignment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subnets\/:subnet_id\/rdnsAssignment", "query": [], "raw": "{{baseUrl}}\/api\/subnets\/:subnet_id\/rdnsAssignment", "variable": [ { "id": "subnet_id", "key": "subnet_id", "value": "1", "description": "The ID of the subnet." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Shows the current assigned RDNS server." }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "" } ] }, { "name": "POST api\/rdns\/providers\/{provider}\/configure", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/rdns\/providers\/:provider\/configure", "query": [], "raw": "{{baseUrl}}\/api\/rdns\/providers\/:provider\/configure", "variable": [ { "id": "provider", "key": "provider", "value": "1", "description": "The ID of the RDNS provider." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The features of this endpoint depends on the RDNS provider. For example, at PowerDNS, it is possible to create a reverse DNS zone using this endpoint." }, "response": [] }, { "name": "POST api\/subnets\/{subnet}\/rdnsAssignment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subnets\/:subnet\/rdnsAssignment", "query": [], "raw": "{{baseUrl}}\/api\/subnets\/:subnet\/rdnsAssignment", "variable": [ { "id": "subnet", "key": "subnet", "value": "1", "description": "The ID of the subnet." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"serverId\":1}" }, "description": "Assigns a RDNS server to the subnet." }, "response": [] }, { "name": "POST api\/rdns\/providers\/{provider}\/addSubnetAssignment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/rdns\/providers\/:provider\/addSubnetAssignment", "query": [], "raw": "{{baseUrl}}\/api\/rdns\/providers\/:provider\/addSubnetAssignment", "variable": [ { "id": "provider", "key": "provider", "value": "1", "description": "The ID of the RDNS server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"subnet\":\"10.10.10.0\"}" }, "description": "An alternative way to assign a RDNS server to a subnet. The other way to do it is using the `POST api\/subnets\/{subnet}\/rdnsAssignment` endpoint." }, "response": [] }, { "name": "POST api\/rdns\/ip", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/rdns\/ip", "query": [], "raw": "{{baseUrl}}\/api\/rdns\/ip" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"adminIp\":\"8.100.62.132\"}" }, "description": "Get the RDNS entry. Users can query the RDNS entry via the `POST api\/servers\/{server}\/ipassignments\/rdns` endpoint." }, "response": [] }, { "name": "PUT api\/rdns\/ip", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/rdns\/ip", "query": [], "raw": "{{baseUrl}}\/api\/rdns\/ip" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ptrRecord\":\"aut\",\"adminIp\":\"52.77.102.18\",\"setPtrTemplate\":false}" }, "description": "Set the RDNS entry. Users can set the RDNS entry via the `PUT api\/servers\/{server_id}\/ipassignments\/{id}` endpoint." }, "response": [] }, { "name": "DELETE api\/rdns\/ip", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/rdns\/ip", "query": [], "raw": "{{baseUrl}}\/api\/rdns\/ip" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"adminIp\":\"113.11.160.146\"}" }, "description": "Delete the RDNS entry. Users can delete the RDNS entry via the `PUT api\/servers\/{server_id}\/ipassignments\/{id}` endpoint." }, "response": [] }, { "name": "api\/rdns\/providers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/rdns\/providers", "query": [], "raw": "{{baseUrl}}\/api\/rdns\/providers" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"withStatusCheck\":false}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":[{\"id\":1,\"provider\":\"powerdns\",\"providerName\":\"PowerDNS\",\"serverName\":\"ns1.tenantos.com\",\"detailedAssignments\":[{\"subnet\":\"10.10.10.0\",\"id\":1}],\"assignments\":[\"10.10.10.0\"],\"configurationFeatures\":[\"createZone\",\"assignSubnets\"],\"data\":{\"serverName\":\"ns1.tenantos.com\",\"mysql_host\":\"10.10.10.2\",\"mysql_port\":9000,\"mysql_username\":\"root\",\"mysql_password\":\"iIinhf327jahJHJge\",\"mysql_database\":\"powerdns\",\"record_ttl\":86400}}],\"message\":\"success\"}", "name": "" } ] }, { "name": "POST api\/rdns\/providers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/rdns\/providers", "query": [], "raw": "{{baseUrl}}\/api\/rdns\/providers" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"PowerDNS\",\"data\":{\"serverName\":\"ns1.tenantos.com\",\"mysql_host\":\"10.10.10.2\",\"mysql_port\":9000,\"mysql_username\":\"root\",\"mysql_password\":\"secret\",\"mysql_database\":\"powerdns\"}}" }, "description": "The body differs depending on the RDNS provider. Please add the provider via the interface to find out the required parameters." }, "response": [] }, { "name": "api\/rdns\/providers\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/rdns\/providers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/rdns\/providers\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the RDNS provider." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"withStatusCheck\":true}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":{\"id\":1,\"provider\":\"powerdns\",\"providerName\":\"PowerDNS\",\"serverName\":\"ns1.tenantos.com\",\"detailedAssignments\":[{\"subnet\":\"10.10.10.0\",\"id\":1}],\"assignments\":[\"10.10.10.0\"],\"configurationFeatures\":[\"createZone\",\"assignSubnets\"],\"data\":{\"serverName\":\"ns1.tenantos.com\",\"mysql_host\":\"10.10.10.2\",\"mysql_port\":9000,\"mysql_username\":\"root\",\"mysql_password\":\"iIinhf327jahJHJge\",\"mysql_database\":\"powerdns\",\"record_ttl\":86400},\"status\":{\"success\":true}},\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/rdns\/providers\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/rdns\/providers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/rdns\/providers\/:id", "variable": [ { "id": "id", "key": "id", "value": "11", "description": "The ID of the RDNS provider." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data\":[\"rerum\"]}" }, "description": "" }, "response": [] }, { "name": "api\/rdns\/providers\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/rdns\/providers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/rdns\/providers\/:id", "variable": [ { "id": "id", "key": "id", "value": "20", "description": "The ID of the RDNS provider." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "api\/rdns\/providers\/{provider}\/actions\/testConnectivity", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/rdns\/providers\/:provider\/actions\/testConnectivity", "query": [], "raw": "{{baseUrl}}\/api\/rdns\/providers\/:provider\/actions\/testConnectivity", "variable": [ { "id": "provider", "key": "provider", "value": "voluptatibus", "description": "The provider." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Roles", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/permissions\/manage-roles\/", "item": [ { "name": "api\/roles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/roles", "query": [], "raw": "{{baseUrl}}\/api\/roles" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"name\": \"admin \",\n\"id\": 1,\n\"isAliasRole\": 0,\n\"assignedUsers\": [\n{\n\"userId\": 1,\n\"fullname\": \"Carlotta West\",\n\"username\": \"adm\"\n}\n],\n\"notDeleteable\": 1,\n\"notAssignable\": 0,\n\"serversIndexDisablePermissionChecks\": 0,\n\"ownedBy\": {\n\"userId\": 1,\n\"fullname\": \"Carlotta West\",\n\"username\": \"adm\"\n},\n\"ownerUserId\": 1,\n\"type\": \"user_created\",\n\"permissions\": []\n},\n{\n\"name\": \"reseller \",\n\"id\": 2,\n\"isAliasRole\": 0,\n\"assignedUsers\": [\n{\n\"userId\": 2,\n\"fullname\": \"Alexie Reichel\",\n\"username\": \"christiansen.conner2549195\"\n}\n],\n\"notDeleteable\": 0,\n\"notAssignable\": 0,\n\"serversIndexDisablePermissionChecks\": 0,\n\"ownedBy\": {\n\"userId\": 1,\n\"fullname\": \"Carlotta West\",\n\"username\": \"adm\"\n},\n\"ownerUserId\": 1,\n\"type\": \"user_created\",\n\"permissions\": []\n},\n{\n\"name\": \"user \",\n\"id\": 3,\n\"isAliasRole\": 0,\n\"assignedUsers\": [\n{\n\"userId\": 3,\n\"fullname\": \"Shanel Mayer\",\n\"username\": \"marquis662975871\"\n}\n],\n\"notDeleteable\": 0,\n\"notAssignable\": 0,\n\"serversIndexDisablePermissionChecks\": 0,\n\"ownedBy\": {\n\"userId\": 1,\n\"fullname\": \"Carlotta West\",\n\"username\": \"adm\"\n},\n\"ownerUserId\": 1,\n\"type\": \"user_created\",\n\"permissions\": []\n},\n{\n\"name\": \"Default Subreseller Template Role For Resellers \",\n\"id\": 4,\n\"isAliasRole\": 0,\n\"assignedUsers\": [],\n\"notDeleteable\": 1,\n\"notAssignable\": 1,\n\"ownedBy\": {\n\"userId\": 1,\n\"fullname\": \"Carlotta West\",\n\"username\": \"adm\"\n},\n\"ownerUserId\": 1,\n\"type\": \"reseller_template\",\n\"permissions\": []\n},\n{\n\"name\": \"Default User Role Template For Resellers \",\n\"id\": 5,\n\"isAliasRole\": 0,\n\"assignedUsers\": [],\n\"notDeleteable\": 1,\n\"notAssignable\": 1,\n\"serversIndexDisablePermissionChecks\": 0,\n\"ownedBy\": {\n\"userId\": 1,\n\"fullname\": \"Carlotta West\",\n\"username\": \"adm\"\n},\n\"ownerUserId\": 1,\n\"type\": \"user_template\",\n\"permissions\": []\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "POST api\/roles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/roles", "query": [], "raw": "{{baseUrl}}\/api\/roles" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"laborum\",\"permissionlist\":[\"servers.update.param.tags\",\"servers.apiOutput.param.tags\"],\"permissionsets\":[\"Manage Server Description\"]}" }, "description": "The available permissions can be requested via the `api\/permissions` endpoint." }, "response": [] }, { "name": "api\/roles\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/roles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/roles\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the role." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"name\": \"admin \",\n\"id\": 1,\n\"isAliasRole\": 0,\n\"assignedUsers\": [\n{\n\"userId\": 1,\n\"fullname\": \"Carlotta West\",\n\"username\": \"adm\"\n}\n],\n\"notDeleteable\": 1,\n\"notAssignable\": 0,\n\"serversIndexDisablePermissionChecks\": 0,\n\"ownedBy\": {\n\"userId\": 1,\n\"fullname\": \"Carlotta West\",\n\"username\": \"adm\"\n},\n\"ownerUserId\": 1,\n\"type\": \"user_created\",\n\"permissions\": [\n{\n\"id\": 1,\n\"name\": \"system.version\"\n},\n{\n\"id\": \"...\",\n\"name\": \"...\"\n}\n]\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "PUT api\/roles\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/roles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/roles\/:id", "variable": [ { "id": "id", "key": "id", "value": "9", "description": "The ID of the role." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"inventore\",\"permissionlist\":[\"servers.update.param.tags\",\"servers.apiOutput.param.tags\"],\"permissionsets\":[\"Manage Server Description\"],\"serversIndexDisablePermissionChecks\":true}" }, "description": "The available permissions can be requested via the `api\/permissions` endpoint." }, "response": [] }, { "name": "api\/roles\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/roles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/roles\/:id", "variable": [ { "id": "id", "key": "id", "value": "12", "description": "The ID of the role." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "GET api\/permissions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/permissions", "query": [], "raw": "{{baseUrl}}\/api\/permissions" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"userId\":6}" }, "description": "Returns a list of the available permissions and the group names.\n\nGroup names (permissionsets) can be found at the \"name\" key and the individual permissions (permissionlist) at the `apiEndpoint`, `apiUpdateFields` and `apiOutput` fields." }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"name\": \"View System Version\",\n\"permissions\": {\n\"apiEndpoint\": [\n\"system.version\"\n],\n\"apiUpdateFields\": [],\n\"apiOutput\": [\n\"system.apiOutput.param.app_version\",\n\"system.apiOutput.param.updateAvailable\",\n\"system.apiOutput.param.updateVersion\"\n],\n\"isDangerousAliasUserPermissionSet\": false\n},\n\"permission_level\": \"admin\"\n},\n{\n\"...\": \"...\"\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] } ] }, { "name": "Search Function", "description": "", "item": [ { "name": "api\/search\/quicksearch", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/search\/quicksearch", "query": [], "raw": "{{baseUrl}}\/api\/search\/quicksearch" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"text\":\"server-001\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 61,\n\"match\": \"server-001\",\n\"matchedFields\": [\n\"Servername\"\n],\n\"desc\": \"hostname.com\",\n\"path\": \"\/servers\/61\",\n\"group\": \"Servers\",\n\"uuid\": \"servers-635bced823ff5\"\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] } ] }, { "name": "Server BMC User Management", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/server-management\/ipmi\/ipmi-user-management\/", "item": [ { "name": "api\/servers\/{server}\/bmc\/users\/listUsers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/bmc\/users\/listUsers", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/bmc\/users\/listUsers", "variable": [ { "id": "server", "key": "server", "value": "1", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":[{\"id\":2,\"name\":\"ADMIN\",\"callin\":true,\"linkAuth\":true,\"ipmiMsg\":true,\"privilegeName\":\"ADMINISTRATOR\",\"privilegeId\":4},{\"id\":3,\"name\":\"tos_61_8\",\"callin\":false,\"linkAuth\":false,\"ipmiMsg\":true,\"privilegeName\":\"OPERATOR\",\"privilegeId\":3}],\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/servers\/{server}\/bmc\/users\/createUser", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/bmc\/users\/createUser", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/bmc\/users\/createUser", "variable": [ { "id": "server", "key": "server", "value": "1", "description": "The ID of the server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"username\":\"qui\",\"channelAccessSettings\":\"ipmi=off callin=off link=off privilege=3\",\"dontFailIfUserExists\":false}" }, "description": "" }, "response": [] }, { "name": "POST api\/servers\/{server}\/bmc\/users\/createUserWithPasswordAndPrivilege", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/bmc\/users\/createUserWithPasswordAndPrivilege", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/bmc\/users\/createUserWithPasswordAndPrivilege", "variable": [ { "id": "server", "key": "server", "value": "1", "description": "The ID of the server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"username\":\"alias\",\"password\":\"aspernatur\",\"privilege\":3,\"channelAccessSettings\":\"ipmi=off callin=off link=off privilege=3\",\"dontFailIfUserExists\":false,\"dontFailIfPasswordChangeFailed\":false,\"dontChangePasswordIfUserExists\":true}" }, "description": "**This is the recommended API endpoint to create IPMI users.**\n\nThis endpoints automatically handles edge cases which you would have to handle manually if you use the createUser\/setUserPassword\/setUserPrivilege\/enableUser endpoints.\n\nUsing this endpoint, it is also possible to update an existing IPMI user: Set `dontFailIfUserExists` to true and use the `listUsers` endpoint if you need to know if the user already exists.\nTo update an IPMI user, you can also use the `updateUser` endpoint." }, "response": [] }, { "name": "api\/servers\/{server}\/bmc\/users\/updateUser", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/bmc\/users\/updateUser", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/bmc\/users\/updateUser", "variable": [ { "id": "server", "key": "server", "value": "1", "description": "The ID of the server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"slot\":1,\"username\":\"libero\",\"password\":\"voluptatem\",\"privilege\":3,\"channelAccessSettings\":\"ipmi=off callin=off link=off privilege=3\"}" }, "description": "" }, "response": [] }, { "name": "api\/servers\/{server}\/bmc\/users\/deleteUser", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/bmc\/users\/deleteUser", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/bmc\/users\/deleteUser", "variable": [ { "id": "server", "key": "server", "value": "1", "description": "The ID of the server." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"slot\":1,\"username\":\"ut\"}" }, "description": "" }, "response": [] }, { "name": "api\/servers\/{server}\/bmc\/users\/enableUser", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/bmc\/users\/enableUser", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/bmc\/users\/enableUser", "variable": [ { "id": "server", "key": "server", "value": "1", "description": "The ID of the server." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"slot\":1,\"username\":\"quisquam\",\"withoutSlotCheck\":false}" }, "description": "" }, "response": [] }, { "name": "api\/servers\/{server}\/bmc\/users\/disableUser", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/bmc\/users\/disableUser", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/bmc\/users\/disableUser", "variable": [ { "id": "server", "key": "server", "value": "1", "description": "The ID of the server." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"slot\":1,\"username\":\"quia\",\"withoutSlotCheck\":false}" }, "description": "" }, "response": [] }, { "name": "api\/servers\/{server}\/bmc\/users\/setUserPassword", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/bmc\/users\/setUserPassword", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/bmc\/users\/setUserPassword", "variable": [ { "id": "server", "key": "server", "value": "1", "description": "The ID of the server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"slot\":1,\"username\":\"modi\",\"password\":\"ea\",\"withoutSlotCheck\":true}" }, "description": "" }, "response": [] }, { "name": "api\/servers\/{server}\/bmc\/users\/setUserPrivilege", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/bmc\/users\/setUserPrivilege", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/bmc\/users\/setUserPrivilege", "variable": [ { "id": "server", "key": "server", "value": "1", "description": "The ID of the server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"slot\":1,\"username\":\"dolorem\",\"privilege\":\"4\",\"withoutSlotCheck\":true}" }, "description": "" }, "response": [] }, { "name": "api\/servers\/{server}\/bmc\/users\/channelSetAccess", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/bmc\/users\/channelSetAccess", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/bmc\/users\/channelSetAccess", "variable": [ { "id": "server", "key": "server", "value": "1", "description": "The ID of the server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"slot\":\"1\",\"username\":\"voluptatem\",\"withoutSlotCheck\":false,\"accessSettings\":\"ipmi=off callin=off link=off privilege=3\"}" }, "description": "" }, "response": [] } ] }, { "name": "Server Backups", "description": "\nManage server backups.", "item": [ { "name": "GET api\/servers\/{server}\/backups", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/backups", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/backups", "variable": [ { "id": "server_id", "key": "server_id", "value": "quisquam", "description": "The ID of the server." }, { "id": "server", "key": "server", "value": "2", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all backups for a server." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":{\"backups\":[{\"backupId\":\"3dd47d5913_vzdump-qemu-2017-2025_08_03-22_34_20.vma.zst\",\"name\":\"3dd47d5913_vzdump-qemu-2017-2025_08_03-22_34_20.vma.zst\",\"size\":2721123,\"created\":1754253260,\"format\":\"vma.zst\",\"note\":\"\",\"storage\":\"local\",\"isDeleting\":false,\"isRestoring\":false,\"deleteTaskId\":null,\"restoreTaskId\":null}],\"notifications\":[],\"activeTasks\":{\"hasAnyActiveTask\":false,\"runningTask\":null,\"activeCreateBackupTask\":null,\"activeDeleteBackupTasks\":[],\"activeRestoreBackupTask\":null},\"meta\":{\"maxBackups\":3,\"defaultBackupStorage\":\"local\",\"defaultBackupMode\":\"snapshot\",\"defaultBackupCompression\":\"zstd\",\"availableBackupStorages\":[{\"id\":\"local\",\"name\":\"local\"}],\"availableBackupModes\":[\"snapshot\",\"suspend\",\"stop\"],\"availableBackupCompression\":[\"zstd\"],\"backupsEnabled\":true,\"ui\":{\"create\":{\"storage\":{\"type\":\"select\",\"label\":\"Storage\",\"required\":true,\"options\":[{\"id\":\"local\",\"name\":\"local\"}],\"tooltip\":\"\",\"placeholder\":\"\",\"default\":\"local\"},\"mode\":{\"type\":\"select\",\"label\":\"Backup Mode\",\"required\":true,\"options\":[{\"id\":\"snapshot\",\"name\":\"Snapshot (fastest)\"},{\"id\":\"suspend\",\"name\":\"Suspend (consistent)\"},{\"id\":\"stop\",\"name\":\"Stop (most consistent)\"}],\"tooltip\":\"\",\"placeholder\":\"\",\"default\":\"snapshot\"},\"compression\":{\"type\":\"select\",\"label\":\"Compression\",\"required\":true,\"tooltip\":\"\",\"placeholder\":\"\",\"options\":[{\"id\":\"zstd\",\"name\":\"ZSTD (best)\"}],\"default\":\"zstd\"},\"notes\":{\"type\":\"text\",\"label\":\"Note\",\"required\":false,\"maxLength\":100,\"tooltip\":\"\",\"placeholder\":\"Enter a short description\",\"default\":\"\"}}},\"canCreateUnlimitedBackups\":false}},\"message\":\"success\"}", "name": "" } ] }, { "name": "POST api\/servers\/{server}\/backups", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/backups", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/backups", "variable": [ { "id": "server", "key": "server", "value": "2", "description": "The ID of the server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"options\":[\"ut\"]}" }, "description": "Create a new backup for the server." }, "response": [] }, { "name": "DELETE api\/servers\/{server}\/backups", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/backups", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/backups", "variable": [ { "id": "server_id", "key": "server_id", "value": "expedita", "description": "The ID of the server." }, { "id": "server", "key": "server", "value": "2", "description": "The ID of the server." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"backupId\":\"vzdump-qemu-100-2024_01_15.vma.gz\"}" }, "description": "Delete a backup." }, "response": [] }, { "name": "POST api\/servers\/{server}\/backups\/restore", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/backups\/restore", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/backups\/restore", "variable": [ { "id": "server", "key": "server", "value": "2", "description": "The ID of the server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"backupId\":\"vzdump-qemu-100-2024_01_15.vma.gz\"}" }, "description": "Restore a backup." }, "response": [] }, { "name": "GET api\/servers\/{server}\/backups\/available", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/backups\/available", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/backups\/available", "variable": [ { "id": "server", "key": "server", "value": "2", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Check if backups are supported for this server." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":{\"available\":true},\"message\":\"success\"}", "name": "" } ] } ] }, { "name": "Server Basic Operations", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/server-management\/add-server\/", "item": [ { "name": "api\/servers\/tags", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/tags", "query": [], "raw": "{{baseUrl}}\/api\/servers\/tags" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"tags\": [\n\"For Rent\",\n\"Internal\",\n\"...\"\n]\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "GET api\/servers\/getByIp\/{ip}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/getByIp\/:ip", "query": [], "raw": "{{baseUrl}}\/api\/servers\/getByIp\/:ip", "variable": [ { "id": "ip", "key": "ip", "value": "10.10.10.30", "description": "Get server by IPv4 address." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Find a server by the IP address. At the moment, only IPv4 addresses are supported." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":{\"id\":61,\"hostname\":\"hostname.com\",\"servername\":\"server-001\",\"user_id\":8,\"os\":\"CentOS 8\",\"servertype\":\"auto\",\"suspendedUserIds\":[],\"primaryip\":\"10.10.10.30\",\"reinstallationprovider\":\"pxe\",\"powerprovider\":{\"type\":\"ipmi\",\"supportedFeatures\":[\"getPowerStatus\",\"setPowerOff\",\"setPowerOn\",\"setPowerReset\",\"setPowerCycle\",\"setBootType\",\"setBmcReset\",\"executeCustomCommand\"]},\"consoleprovider\":{\"type\":\"ipmi\",\"supportedConsoleMode\":\"standard\"},\"owner_realname\":\"Tania Metz\",\"tags\":[\"Internal\"],\"description\":\"Database server\",\"reinstallationRunning\":0,\"diskwipeRunning\":0,\"rescueBootRunning\":0,\"hardwarecollectRunning\":0,\"passwordResetRunning\":0,\"detailedHardwareInformation\":{\"mainboard\":{\"model\":\"MAG X570 TOMAHAWK WIFI (MS-7C84)\",\"value\":\"1.0\",\"count\":1,\"valueType\":\"text\",\"details\":[{\"model\":\"MAG X570 TOMAHAWK WIFI (MS-7C84)\",\"size\":\"1.0\"}]},\"memory\":{\"model\":\"multiple\",\"value\":65536,\"count\":4,\"valueType\":\"mb\",\"details\":[{\"model\":\"CMH32GX4M2Z3200C16\",\"size\":\"16384\"},{\"model\":\"CMW32GX4M2C3200C16\",\"size\":\"16384\"},{\"model\":\"CMH32GX4M2Z3200C16\",\"size\":\"16384\"},{\"model\":\"CMW32GX4M2C3200C16\",\"size\":\"16384\"}]},\"cpu\":{\"model\":\"AMD Ryzen 9 3900XT\",\"value\":\"2200\",\"count\":1,\"valueType\":\"MHz\",\"cores\":\"12\",\"threads\":\"24\",\"mhzTurbo\":4775},\"disk\":{\"model\":\"multiple\",\"value\":2842540,\"count\":4,\"valueType\":\"mib\",\"details\":[{\"model\":\"Samsung SSD 860 EVO 500GB\",\"size\":\"476940\"},{\"model\":\"SanDisk SDSSDHII480G\",\"size\":\"457862\"},{\"model\":\"WDS100T3X0C-00SJG0\",\"size\":\"953869\"},{\"model\":\"WDS100T3X0C-00SJG0\",\"size\":\"953869\"}]}},\"ownerChain\":[{\"userId\":1,\"name\":\"Mable White\",\"username\":\"adm\",\"type\":\"admin\",\"assignmentDate\":\"2021-08-25 15:18:01\"},{\"userId\":8,\"name\":\"Tania Metz\",\"username\":\"ziemann.bridget1588383\",\"type\":\"enduser\",\"assignmentDate\":\"2021-08-25 15:18:01\"}],\"typeOfServer\":\"dedicated\",\"cachedPowerstatus\":\"offline\",\"backendDeletable\":0,\"assignmentDate\":\"2021-08-25 15:18:01\",\"isExternalServer\":0,\"postReinstallationActionAvailable\":\"\",\"trafficStatistics\":{\"1d\":\"2.15\",\"7d\":\"119.28\",\"14d\":\"191.14\",\"30d\":\"422.04\",\"95th_in_30d\":\"3.88\",\"95th_out_30d\":\"0.19\",\"95th_total_30d\":\"4.12\"},\"lastBwrate\":{\"in\":\"0.04\",\"out\":\"0.04\"},\"isSuspended\":0,\"ipassignments\":[{\"updated_at\":\"2025-08-25T15:15:47.000000Z\",\"ip\":\"10.10.10.30\",\"primary_ip\":1,\"ipAttributes\":{\"isIpv4\":1,\"isIpv6\":0,\"isSubnet\":0},\"subnetinformation\":{\"subnet\":\"10.10.10.0\",\"netmask\":\"255.255.255.0\",\"gw\":\"10.10.10.1\",\"type\":\"v4\",\"subnetOwnedByUser\":true}}]},\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/servers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers", "query": [], "raw": "{{baseUrl}}\/api\/servers" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 61,\n\"hostname\": \"hostname.com\",\n\"servername\": \"server-001\",\n\"user_id\": 8,\n\"os\": \"CentOS 8\",\n\"servertype\": \"auto\",\n\"suspendedUserIds\": [],\n\"primaryip\": \"10.10.10.30\",\n\"reinstallationprovider\": \"pxe\",\n\"powerprovider\": {\n\"type\": \"ipmi\",\n\"supportedFeatures\": [\n\"getPowerStatus\",\n\"setPowerOff\",\n\"setPowerOn\",\n\"setPowerReset\",\n\"setPowerCycle\",\n\"setBootType\",\n\"setBmcReset\",\n\"executeCustomCommand\"\n]\n},\n\"consoleprovider\": {\n\"type\": \"ipmi\"\n},\n\"owner_realname\": \"Dr. Sabryna Tromp V\",\n\"tags\": [\n\"Internal\"\n],\n\"description\": \"Database server\",\n\"reinstallationRunning\": 0,\n\"diskwipeRunning\": 0,\n\"rescueBootRunning\": 0,\n\"hardwarecollectRunning\": 0,\n\"passwordResetRunning\": 0,\n\"detailedHardwareInformation\": {\n\"mainboard\": {\n\"model\": \"MAG X570 TOMAHAWK WIFI (MS-7C84)\",\n\"value\": \"1.0\",\n\"count\": 1,\n\"valueType\": \"text\",\n\"details\": [\n{\n\"model\": \"MAG X570 TOMAHAWK WIFI (MS-7C84)\",\n\"size\": \"1.0\"\n}\n]\n},\n\"memory\": {\n\"model\": \"CMW32GX4M2C3200C16\",\n\"value\": 65536,\n\"count\": 4,\n\"valueType\": \"mb\",\n\"details\": [\n{\n\"model\": \"CMH32GX4M2Z3200C16\",\n\"size\": \"16384\"\n},\n{\n\"model\": \"CMW32GX4M2C3200C16\",\n\"size\": \"16384\"\n},\n{\n\"model\": \"CMH32GX4M2Z3200C16\",\n\"size\": \"16384\"\n},\n{\n\"model\": \"CMW32GX4M2C3200C16\",\n\"size\": \"16384\"\n}\n]\n},\n\"cpu\": {\n\"model\": \"AMD Ryzen 9 3900XT\",\n\"value\": \"2200\",\n\"count\": 1,\n\"valueType\": \"MHz\",\n\"cores\": \"12\"\n},\n\"disk\": {\n\"model\": \"multiple\",\n\"value\": 2842540,\n\"count\": 4,\n\"valueType\": \"mb\",\n\"details\": [\n{\n\"model\": \"Samsung SSD 860 EVO 500GB\",\n\"size\": \"476940\"\n},\n{\n\"model\": \"SanDisk SDSSDHII480G\",\n\"size\": \"457862\"\n},\n{\n\"model\": \"WDS100T3X0C-00SJG0\",\n\"size\": \"953869\"\n},\n{\n\"model\": \"WDS100T3X0C-00SJG0\",\n\"size\": \"953869\"\n}\n]\n}\n},\n\"ownerChain\": [\n{\n\"userId\": 1,\n\"name\": \"Dr. Eva Flatley\",\n\"username\": \"adm\",\n\"type\": \"admin\",\n\"assignmentDate\": \"2021-10-20 21:38:59\"\n},\n{\n\"userId\": 8,\n\"name\": \"Dr. Sabryna Tromp V\",\n\"username\": \"nigel742503837\",\n\"type\": \"enduser\",\n\"assignmentDate\": \"2021-10-20 21:38:59\"\n}\n],\n\"typeOfServer\": \"dedicated\",\n\"cachedPowerstatus\": \"online\",\n\"backendDeletable\": 0,\n\"assignmentDate\": \"2021-10-20 21:38:59\",\n\"isExternalServer\": 0,\n\"postReinstallationActionAvailable\": \"\",\n\"trafficStatistics\": {\n\"1d\": \"8.24\",\n\"7d\": \"790.71\",\n\"14d\": \"941.83\",\n\"30d\": \"1783.39\",\n\"95th_in_30d\": \"5.49\",\n\"95th_out_30d\": \"0.19\",\n\"95th_total_30d\": \"5.63\"\n},\n\"lastBwrate\": {\n\"in\": \"0.10\",\n\"out\": \"3.10\"\n},\n\"ipassignments\": [\n{\n\"updated_at\": \"2022-10-20T21:38:15.000000Z\",\n\"ip\": \"10.10.10.30\",\n\"primary_ip\": 1,\n\"ipAttributes\": {\n\"isIpv4\": 1,\n\"isIpv6\": 0,\n\"isSubnet\": 0\n},\n\"subnetinformation\": {\n\"cidr\": 24,\n\"subnet\": \"10.10.10.0\",\n\"netmask\": \"255.255.255.0\",\n\"gw\": \"10.10.10.1\",\n\"type\": \"v4\",\n\"rdnsAvailable\": 1,\n\"vlanAutomationAvailable\": false,\n\"subnetOwnedByUser\": true,\n\"rootSubnetId\": null,\n\"isExternalProvider\": 0\n}\n}\n]\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/servers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers", "query": [], "raw": "{{baseUrl}}\/api\/servers" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"hostname\":\"hostname.com\",\"servername\":\"server-001\",\"description\":\"enim\",\"tags\":[\"veniam\"],\"os\":\"nemo\",\"servertype\":\"auto\",\"config\":{\"agentId\":1,\"ipmi_ip\":\"10.10.10.99\",\"ipmi_user\":\"ADMIN\",\"ipmi_password\":\"ADMIN\",\"pxe_mac\":\"aa:bb:cc:dd:ee:ff\",\"enable_pxe\":true,\"enable_ipmi_console\":true,\"enable_ipmi_powermanagement\":true,\"enable_permanent_dhcp\":true},\"ipassignments\":[{\"ip\":\"10.10.10.55\",\"subnets_id\":7,\"primary_ip\":false}]}" }, "description": "" }, "response": [] }, { "name": "api\/servers\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:id", "variable": [ { "id": "id", "key": "id", "value": "61", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"id\": 61,\n\"hostname\": \"hostname.com\",\n\"servername\": \"server-001\",\n\"user_id\": 8,\n\"os\": \"CentOS 8\",\n\"servertype\": \"auto\",\n\"suspendedUserIds\": [],\n\"primaryip\": \"10.10.10.30\",\n\"reinstallationprovider\": \"pxe\",\n\"powerprovider\": {\n\"type\": \"ipmi\",\n\"supportedFeatures\": [\n\"getPowerStatus\",\n\"setPowerOff\",\n\"setPowerOn\",\n\"setPowerReset\",\n\"setPowerCycle\",\n\"setBootType\",\n\"setBmcReset\",\n\"executeCustomCommand\"\n]\n},\n\"consoleprovider\": {\n\"type\": \"ipmi\"\n},\n\"owner_realname\": \"Dejah Leannon\",\n\"tags\": [\n\"Internal\"\n],\n\"description\": \"Database server\",\n\"reinstallationRunning\": 0,\n\"diskwipeRunning\": 0,\n\"rescueBootRunning\": 0,\n\"hardwarecollectRunning\": 0,\n\"passwordResetRunning\": 0,\n\"detailedHardwareInformation\": {\n\"mainboard\": {\n\"model\": \"MAG X570 TOMAHAWK WIFI (MS-7C84)\",\n\"value\": \"1.0\",\n\"count\": 1,\n\"valueType\": \"text\",\n\"details\": [\n{\n\"model\": \"MAG X570 TOMAHAWK WIFI (MS-7C84)\",\n\"size\": \"1.0\"\n}\n]\n},\n\"memory\": {\n\"model\": \"CMW32GX4M2C3200C16\",\n\"value\": 65536,\n\"count\": 4,\n\"valueType\": \"mb\",\n\"details\": [\n{\n\"model\": \"CMH32GX4M2Z3200C16\",\n\"size\": \"16384\"\n},\n{\n\"model\": \"CMW32GX4M2C3200C16\",\n\"size\": \"16384\"\n},\n{\n\"model\": \"CMH32GX4M2Z3200C16\",\n\"size\": \"16384\"\n},\n{\n\"model\": \"CMW32GX4M2C3200C16\",\n\"size\": \"16384\"\n}\n]\n},\n\"cpu\": {\n\"model\": \"AMD Ryzen 9 3900XT\",\n\"value\": \"2200\",\n\"count\": 1,\n\"valueType\": \"MHz\",\n\"cores\": \"12\"\n},\n\"disk\": {\n\"model\": \"multiple\",\n\"value\": 2842540,\n\"count\": 4,\n\"valueType\": \"mb\",\n\"details\": [\n{\n\"model\": \"Samsung SSD 860 EVO 500GB\",\n\"size\": \"476940\"\n},\n{\n\"model\": \"SanDisk SDSSDHII480G\",\n\"size\": \"457862\"\n},\n{\n\"model\": \"WDS100T3X0C-00SJG0\",\n\"size\": \"953869\"\n},\n{\n\"model\": \"WDS100T3X0C-00SJG0\",\n\"size\": \"953869\"\n}\n]\n}\n},\n\"ownerChain\": [\n{\n\"userId\": 1,\n\"name\": \"Viva Botsford\",\n\"username\": \"adm\",\n\"type\": \"admin\",\n\"assignmentDate\": \"2021-10-21 19:29:10\"\n},\n{\n\"userId\": 8,\n\"name\": \"Dejah Leannon\",\n\"username\": \"esmeralda44314938\",\n\"type\": \"enduser\",\n\"assignmentDate\": \"2021-10-21 19:29:10\"\n}\n],\n\"typeOfServer\": \"dedicated\",\n\"cachedPowerstatus\": \"online\",\n\"backendDeletable\": 0,\n\"assignmentDate\": \"2021-10-21 19:29:10\",\n\"isExternalServer\": 0,\n\"postReinstallationActionAvailable\": \"\",\n\"trafficStatistics\": {\n\"1d\": \"8.24\",\n\"7d\": \"790.71\",\n\"14d\": \"941.83\",\n\"30d\": \"1783.39\",\n\"95th_in_30d\": \"5.49\",\n\"95th_out_30d\": \"0.19\",\n\"95th_total_30d\": \"5.63\"\n},\n\"lastBwrate\": {\n\"in\": \"0.10\",\n\"out\": \"3.10\"\n},\n\"ipassignments\": [\n{\n\"updated_at\": \"2022-10-21T19:28:25.000000Z\",\n\"ip\": \"10.10.10.30\",\n\"primary_ip\": 1,\n\"ipAttributes\": {\n\"isIpv4\": 1,\n\"isIpv6\": 0,\n\"isSubnet\": 0\n},\n\"subnetinformation\": {\n\"cidr\": 24,\n\"subnet\": \"10.10.10.0\",\n\"netmask\": \"255.255.255.0\",\n\"gw\": \"10.10.10.1\",\n\"type\": \"v4\",\n\"rdnsAvailable\": 1,\n\"vlanAutomationAvailable\": false,\n\"subnetOwnedByUser\": true,\n\"rootSubnetId\": null,\n\"isExternalProvider\": 0\n}\n}\n]\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/servers\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:id", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "The ID of the server." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"hostname\":\"hostname.com\",\"servername\":\"server-001\",\"user_id\":11,\"description\":\"labore\",\"tags\":[\"corporis\"],\"os\":\"harum\",\"servertype\":\"dedicated\",\"suspendUserIds\":[8],\"assignmentDates\":[{\"userId\":18,\"datetime\":\"2024-01-13\"}],\"suspendPowerAction\":\"setPowerOn\",\"suspendNetworkPortAction\":\"enable\"}" }, "description": "" }, "response": [] }, { "name": "api\/servers\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:id", "variable": [ { "id": "id", "key": "id", "value": "9", "description": "The ID of the server." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"destroy\":false}" }, "description": "" }, "response": [] }, { "name": "GET api\/servers\/{server}\/console\/start", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/console\/start", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/console\/start", "variable": [ { "id": "server", "key": "server", "value": "1", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"authorizedIp\":\"10.0.0.10\",\"consoleMode\":\"standard\"}" }, "description": "Generates a NoVNC session and returns a link to open the console.\n\nFor security reasons, the console can only be opened by the specificated IP. If no IP has been specificated, the console is bound to the requestor IP." }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"token\": \"fa5ed6be6666631b7e53e0968d47b03dd92cb8ae\",\n\"accessUrl\": \"https:\/\/domain.com\/console\/fa5ed6be6666631b7e53e0968d47b03dd92cb8ae\"\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/servers\/getByTags", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/getByTags", "query": [], "raw": "{{baseUrl}}\/api\/servers\/getByTags" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"tags\":[\"Clients\",\"Damaged\"]}" }, "description": "" }, "response": [] }, { "name": "POST api\/servers\/{id}\/tags\/rename", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tags\/rename", "query": [], "raw": "{{baseUrl}}\/api\/tags\/rename" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"oldTag\":\"et\",\"newTag\":\"reiciendis\",\"updateSubnets\":false,\"updatePxeProfiles\":false}" }, "description": "Rename a tag globally across all servers (and optionally subnets and PXE profiles for admins)" }, "response": [] }, { "name": "POST api\/servers\/{id}\/tags\/delete", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tags\/delete", "query": [], "raw": "{{baseUrl}}\/api\/tags\/delete" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"tag\":\"dignissimos\",\"updateSubnets\":true,\"updatePxeProfiles\":true}" }, "description": "Delete a tag globally from all servers (and optionally subnets and PXE profiles for admins)" }, "response": [] } ] }, { "name": "Server Comments", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/about-notes\/about-notes-descriptions-tags\/", "item": [ { "name": "api\/servers\/{server_id}\/comments", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/comments", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/comments", "variable": [ { "id": "server_id", "key": "server_id", "value": "61", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 1,\n\"created_at\": \"2023-11-17T21:29:07.000000Z\",\n\"updated_at\": \"2024-08-10T21:29:07.000000Z\",\n\"comment\": \"

Server is broken<\/p>\",\n\"sticky\": 1,\n\"user_id\": 1,\n\"clientname\": \"Viva Botsford\"\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/servers\/{server}\/comments", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/comments", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/comments", "variable": [ { "id": "server", "key": "server", "value": "8", "description": "The ID of the server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "comment", "value": "quo", "type": "text", "description": "" }, { "key": "sticky", "value": false, "type": "text", "description": "" }, { "key": "user_id", "value": 14, "type": "text", "description": "" }, { "key": "attachments[]", "src": [], "type": "file" } ] }, "description": "" }, "response": [] }, { "name": "api\/servers\/{server_id}\/comments\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/comments\/:id", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/comments\/:id", "variable": [ { "id": "server_id", "key": "server_id", "value": "61", "description": "The ID of the server." }, { "id": "id", "key": "id", "value": "1", "description": "The ID of the comment." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"id\": 1,\n\"created_at\": \"2023-11-17T21:29:07.000000Z\",\n\"updated_at\": \"2024-08-10T21:29:07.000000Z\",\n\"comment\": \"

Server is broken<\/p>\",\n\"sticky\": 1,\n\"user_id\": 1\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/servers\/{server_id}\/comments\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/comments\/:id", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/comments\/:id", "variable": [ { "id": "server_id", "key": "server_id", "value": "12", "description": "The ID of the server." }, { "id": "id", "key": "id", "value": "10", "description": "The ID of the comment." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"comment\":\"veniam\",\"sticky\":true,\"user_id\":2}" }, "description": "" }, "response": [] }, { "name": "api\/servers\/{server_id}\/comments\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/comments\/:id", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/comments\/:id", "variable": [ { "id": "server_id", "key": "server_id", "value": "16", "description": "The ID of the server." }, { "id": "id", "key": "id", "value": "3", "description": "The ID of the comment." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Server Connections", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/server-management\/server-page\/connections\/", "item": [ { "name": "GET api\/servers\/{server}\/connections\/{testConnectionId}\/test", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/connections\/:testConnectionId\/test", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/connections\/:testConnectionId\/test", "variable": [ { "id": "server", "key": "server", "value": "61", "description": "The ID of the server." }, { "id": "testConnectionId", "key": "testConnectionId", "value": "21", "description": "The ID of the connection. Not all connections support testing." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Verifies if the connection details are working. Connection testing does not work with every connection. IPMI connection tests are supported." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":\"online\",\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/servers\/{server_id}\/connections", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/connections", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/connections", "variable": [ { "id": "server_id", "key": "server_id", "value": "61", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 21,\n\"agentId\": 1,\n\"serverId\": 61,\n\"types\": [\n\"power_management\",\n\"remote_console\"\n],\n\"agentAssignmentsRelationId\": 21,\n\"agent_details\": {\n\"id\": 1,\n\"name\": \"Local Agent\",\n\"hostname\": \"local-agent.domain.com\"\n},\n\"related_data\": {\n\"id\": 21,\n\"type\": \"ipmi\",\n\"meta\": {\n\"username\": \"ADMIN\",\n\"password\": \"ADMIN\",\n\"ip\": \"10.10.10.101\",\n\"javaVersion\": \"auto\",\n\"bmcPort\": \"623\"\n}\n}\n},\n{\n\"id\": 22,\n\"agentId\": 1,\n\"serverId\": 61,\n\"types\": [\n\"installation\"\n],\n\"agentAssignmentsRelationId\": 22,\n\"agent_details\": {\n\"id\": 1,\n\"name\": \"Local Agent\",\n\"hostname\": \"local-agent.domain.com\"\n},\n\"related_data\": {\n\"id\": 22,\n\"type\": \"pxe\",\n\"meta\": []\n}\n},\n{\n\"id\": 23,\n\"agentId\": 1,\n\"serverId\": 61,\n\"types\": [\n\"dhcp\"\n],\n\"agentAssignmentsRelationId\": 23,\n\"agent_details\": {\n\"id\": 1,\n\"name\": \"Local Agent\",\n\"hostname\": \"local-agent.domain.com\"\n},\n\"related_data\": {\n\"id\": 23,\n\"type\": \"dhcp\",\n\"meta\": {\n\"pxe_mac\": \"00:50:56:86:E1:A3\"\n}\n}\n},\n{\n\"id\": 26,\n\"agentId\": 0,\n\"serverId\": 61,\n\"types\": [],\n\"agentAssignmentsRelationId\": 26,\n\"agent_details\": null,\n\"related_data\": {\n\"id\": 26,\n\"type\": \"snmp_switch\",\n\"meta\": {\n\"switchId\": 2,\n\"portId\": 2\n}\n}\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/servers\/{server}\/connections", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/connections", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/connections", "variable": [ { "id": "server", "key": "server", "value": "7", "description": "The ID of the server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"agentId\":6,\"types\":[\"power_management\",\"remote_console\"],\"connectionDetails\":{\"meta\":{\"ip\":\"192.168.171.200\",\"username\":\"admin\",\"password\":\"admin\",\"javaVersion\":\"auto\"},\"type\":\"ipmi\"}}" }, "description": "" }, "response": [] }, { "name": "api\/servers\/{server_id}\/connections\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/connections\/:id", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/connections\/:id", "variable": [ { "id": "server_id", "key": "server_id", "value": "61", "description": "The ID of the server." }, { "id": "id", "key": "id", "value": "23", "description": "The ID of the connection." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"id\": 23,\n\"agentId\": 1,\n\"serverId\": 61,\n\"types\": [\n\"dhcp\"\n],\n\"agentAssignmentsRelationId\": 23,\n\"agent_details\": {\n\"id\": 1,\n\"name\": \"Local Agent\",\n\"hostname\": \"local-agent.domain.com\"\n},\n\"related_data\": {\n\"id\": 23,\n\"type\": \"dhcp\",\n\"meta\": {\n\"pxe_mac\": \"00:50:56:86:E1:A3\"\n}\n}\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/servers\/{server_id}\/connections\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/connections\/:id", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/connections\/:id", "variable": [ { "id": "server_id", "key": "server_id", "value": "18", "description": "The ID of the server." }, { "id": "id", "key": "id", "value": "19", "description": "The ID of the connection." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"agentId\":5,\"types\":[\"power_management\",\"remote_console\"],\"connectionDetails\":{\"meta\":{\"ip\":\"192.168.171.200\",\"username\":\"admin\",\"password\":\"admin\",\"javaVersion\":\"auto\"},\"type\":\"ipmi\"}}" }, "description": "" }, "response": [] }, { "name": "api\/servers\/{server_id}\/connections\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/connections\/:id", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/connections\/:id", "variable": [ { "id": "server_id", "key": "server_id", "value": "13", "description": "The ID of the server." }, { "id": "id", "key": "id", "value": "2", "description": "The ID of the connection." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "api\/servers\/{server}\/connections\/{testConnectionId}\/{serverConnectionAction}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/connections\/:testConnectionId\/:serverConnectionAction", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/connections\/:testConnectionId\/:serverConnectionAction", "variable": [ { "id": "server", "key": "server", "value": "1", "description": "The ID of the server." }, { "id": "testConnectionId", "key": "testConnectionId", "value": "24", "description": "The ID of the connection." }, { "id": "serverConnectionAction", "key": "serverConnectionAction", "value": "getSupportedActions", "description": "The action to execute. Use `getSupportedActions` to receive information about the available actions. To execute IPMI commands, use the `api\/servers\/{server}\/bmc\/executeCommand` endpoint." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"powerActions\": [\n\"getPowerStatus\",\n\"setPowerOff\",\n\"setPowerOn\",\n\"setPowerReset\"\n]\n},\n\"message\": \"success\"\n}", "name": "" } ] } ] }, { "name": "Server IP Assignments", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/server-management\/server-page\/server-page\/#ip-management", "item": [ { "name": "POST api\/servers\/{server}\/ipassignments\/rdns", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/ipassignments\/rdns", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/ipassignments\/rdns", "variable": [ { "id": "server", "key": "server", "value": "61", "description": "The ID of the server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ip\":\"10.10.10.30\"}" }, "description": "Get the RDNS entry of an IP address." }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"ptrRecord\": \"server-001.com\"\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "GET api\/servers\/{server}\/ipassignments\/getAssignableSubnets", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/ipassignments\/getAssignableSubnets", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/ipassignments\/getAssignableSubnets", "variable": [ { "id": "server", "key": "server", "value": "1", "description": "The ID of the server (optional if called via `GET api\/virtualization\/ipassignments\/getAssignableSubnets`)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Receives a list of subnets from which IPs can be assigned to the server. Subnets are not always available to all servers.\n\nAlias: `GET api\/virtualization\/ipassignments\/getAssignableSubnets` - used to set the subnets in VPS plans." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":[{\"id\":1,\"subnet\":\"10.10.10.0\\\/24\",\"type\":{\"hasChildSubnets\":0,\"amountOfDirectChilds\":0,\"hasSubIps\":1,\"amountOfSubIps\":263,\"type\":\"v4\"},\"usageStatistics\":{\"free\":68,\"reserved\":25,\"used\":170,\"totalUsed\":195,\"totalIps\":263,\"usedPercentage\":74.14},\"vlanAutomationAvailable\":false,\"ownerChain\":[{\"userId\":1,\"name\":\"Mable White\",\"username\":\"adm\"}],\"isDirectOwner\":true}],\"message\":\"success\"}", "name": "" } ] }, { "name": "POST api\/servers\/{server}\/ipassignments\/getAssignableIpsOfSubnet", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/ipassignments\/getAssignableIpsOfSubnet", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/ipassignments\/getAssignableIpsOfSubnet", "variable": [ { "id": "server", "key": "server", "value": "7", "description": "The ID of the server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"subnets_id\":12}" }, "description": "Receives a list of available IPs of the subnet." }, "response": [] }, { "name": "GET api\/servers\/{server}\/ipassignments\/getAssignableSubnets", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/virtualization\/ipassignments\/getAssignableSubnets", "query": [], "raw": "{{baseUrl}}\/api\/virtualization\/ipassignments\/getAssignableSubnets", "variable": [ { "id": "server", "key": "server", "value": "1", "description": "The ID of the server (optional if called via `GET api\/virtualization\/ipassignments\/getAssignableSubnets`)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Receives a list of subnets from which IPs can be assigned to the server. Subnets are not always available to all servers.\n\nAlias: `GET api\/virtualization\/ipassignments\/getAssignableSubnets` - used to set the subnets in VPS plans." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":[{\"id\":1,\"subnet\":\"10.10.10.0\\\/24\",\"type\":{\"hasChildSubnets\":0,\"amountOfDirectChilds\":0,\"hasSubIps\":1,\"amountOfSubIps\":263,\"type\":\"v4\"},\"usageStatistics\":{\"free\":68,\"reserved\":25,\"used\":170,\"totalUsed\":195,\"totalIps\":263,\"usedPercentage\":74.14},\"vlanAutomationAvailable\":false,\"ownerChain\":[{\"userId\":1,\"name\":\"Mable White\",\"username\":\"adm\"}],\"isDirectOwner\":true}],\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/servers\/{server_id}\/ipassignments", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/ipassignments", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/ipassignments", "variable": [ { "id": "server_id", "key": "server_id", "value": "61", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 32,\n\"updated_at\": \"2022-10-21T19:28:25.000000Z\",\n\"ip\": \"10.10.10.30\",\n\"primary_ip\": 1,\n\"description\": null,\n\"ipAttributes\": {\n\"isIpv4\": 1,\n\"isIpv6\": 0,\n\"isSubnet\": 0\n},\n\"subnetinformation\": {\n\"cidr\": 24,\n\"subnet\": \"10.10.10.0\",\n\"netmask\": \"255.255.255.0\",\n\"gw\": \"10.10.10.1\",\n\"type\": \"v4\",\n\"rdnsAvailable\": 1,\n\"vlanAutomationAvailable\": false,\n\"subnetOwnedByUser\": true,\n\"rootSubnetId\": null,\n\"isExternalProvider\": 0\n}\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/servers\/{server}\/ipassignments", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/ipassignments", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/ipassignments", "variable": [ { "id": "server", "key": "server", "value": "18", "description": "The ID of the server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"subnets_id\":1,\"ips\":[\"10.10.10.20\",\"10.10.10.21\"],\"description\":\"porro\",\"performVlanActions\":\"none\"}" }, "description": "" }, "response": [] }, { "name": "api\/servers\/{server_id}\/ipassignments\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/ipassignments\/:id", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/ipassignments\/:id", "variable": [ { "id": "server_id", "key": "server_id", "value": "61", "description": "The ID of the server." }, { "id": "id", "key": "id", "value": "0", "description": "The ID of the IP assignment. However, actually the \"ip\" body parameter is used for identification. The id parameter must not be empty, but can be any integer or string." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"description\":\"quia\",\"primary_ip\":true,\"ptrRecord\":\"et\",\"setPtrTemplate\":false,\"ip\":\"10.10.10.30\"}" }, "description": "" }, "response": [] }, { "name": "api\/servers\/{server_id}\/ipassignments\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/ipassignments\/:id", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/ipassignments\/:id", "variable": [ { "id": "server_id", "key": "server_id", "value": "2", "description": "The ID of the server." }, { "id": "id", "key": "id", "value": "0", "description": "The ID of the IP assignment. However, actually the \"ip\" body parameter is used for identification. The id parameter must not be empty, but can be any integer or string." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ip\":\"10.10.10.4\",\"performVlanActions\":\"none\"}" }, "description": "" }, "response": [] }, { "name": "api\/servers\/{server}\/ipassignments\/dynamicIpAssignments", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/ipassignments\/dynamicIpAssignments", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/ipassignments\/dynamicIpAssignments", "variable": [ { "id": "server", "key": "server", "value": "debitis", "description": "The server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ipv4Addresses\":[{\"count\":19,\"cidrSize\":10,\"assignmentMode\":\"preferSequentialIps\",\"restrictToSameSubnet\":true,\"restrictToSubnetsOwnedByUserId\":2,\"allowOwnSubnetsAsFallbackForRestrictedUser\":false,\"fromSubnetIds\":[12],\"excludeSubnetIds\":[4]}],\"ipv6Addresses\":[{\"count\":13,\"cidrSize\":8,\"assignmentMode\":\"failIfNotSequentialIps\",\"restrictToSameSubnet\":false,\"restrictToSubnetsOwnedByUserId\":18,\"allowOwnSubnetsAsFallbackForRestrictedUser\":false,\"fromSubnetIds\":[1],\"excludeSubnetIds\":[8]}],\"ipv4Subnets\":[{\"cidrSize\":10,\"assignmentMode\":\"requireSplitSubnet\",\"subnetSelectionMode\":\"largestSubnetFirst\",\"fromParentSubnetIds\":[13],\"excludeParentSubnetsIds\":[10],\"restrictToSubnetsOwnedByUserId\":7,\"allowOwnSubnetsAsFallbackForRestrictedUser\":false,\"assignSubnetOwnershipToUserId\":10,\"reserveGatewayIp\":true,\"reserveBroadcastIp\":true,\"reserveNetworkAddress\":false,\"gatewayMethod\":\"custom\",\"copyVlanConfigurationFromParent\":true}],\"ipv6Subnets\":[{\"cidrSize\":16,\"assignmentMode\":\"requireExistingSubnet\",\"subnetSelectionMode\":\"largestSubnetFirst\",\"fromParentSubnetIds\":[19],\"excludeParentSubnetsIds\":[15],\"restrictToSubnetsOwnedByUserId\":9,\"allowOwnSubnetsAsFallbackForRestrictedUser\":true,\"assignSubnetOwnershipToUserId\":18,\"gatewayMethod\":\"custom\",\"copyVlanConfigurationFromParent\":true}],\"performVlanActions\":{\"afterAllIpAssignments\":\"none\",\"afterEachIpAssignment\":\"none\",\"afterDeleteExistingIpAssignments\":\"none\"},\"deleteExistingIpAssignments\":{\"ipv4\":true,\"ipv6\":false}}" }, "description": "" }, "response": [] } ] }, { "name": "Server Inventory", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/server-management\/server-page\/inventory\/", "item": [ { "name": "GET api\/servers\/{server_id}\/hwsummary", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/hwsummary", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/hwsummary", "variable": [ { "id": "server_id", "key": "server_id", "value": "61", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Summarized overview of the hardware inventory." }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"mainboard\": {\n\"model\": \"MAG X570 TOMAHAWK WIFI (MS-7C84)\",\n\"value\": \"1.0\",\n\"count\": 1,\n\"valueType\": \"text\",\n\"details\": null\n},\n\"memory\": {\n\"model\": \"CMW32GX4M2C3200C16\",\n\"value\": 65536,\n\"count\": 4,\n\"valueType\": \"mb\",\n\"details\": null\n},\n\"cpu\": {\n\"model\": \"AMD Ryzen 9 3900XT\",\n\"value\": \"2200\",\n\"count\": 1,\n\"valueType\": \"MHz\",\n\"cores\": \"12\"\n},\n\"disk\": {\n\"model\": \"multiple\",\n\"value\": 2842540,\n\"count\": 4,\n\"valueType\": \"mb\",\n\"details\": null\n}\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "GET api\/servers\/{server}\/hwsummary\/withDetails", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/hwsummary\/withDetails", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/hwsummary\/withDetails", "variable": [ { "id": "server", "key": "server", "value": "61", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "More detailled summary of the hardware inventory." }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"mainboard\": {\n\"model\": \"MAG X570 TOMAHAWK WIFI (MS-7C84)\",\n\"value\": \"1.0\",\n\"count\": 1,\n\"valueType\": \"text\",\n\"details\": [\n{\n\"model\": \"MAG X570 TOMAHAWK WIFI (MS-7C84)\",\n\"size\": \"1.0\"\n}\n]\n},\n\"memory\": {\n\"model\": \"CMW32GX4M2C3200C16\",\n\"value\": 65536,\n\"count\": 4,\n\"valueType\": \"mb\",\n\"details\": [\n{\n\"model\": \"CMH32GX4M2Z3200C16\",\n\"size\": \"16384\"\n},\n{\n\"model\": \"CMW32GX4M2C3200C16\",\n\"size\": \"16384\"\n},\n{\n\"model\": \"CMH32GX4M2Z3200C16\",\n\"size\": \"16384\"\n},\n{\n\"model\": \"CMW32GX4M2C3200C16\",\n\"size\": \"16384\"\n}\n]\n},\n\"cpu\": {\n\"model\": \"AMD Ryzen 9 3900XT\",\n\"value\": \"2200\",\n\"count\": 1,\n\"valueType\": \"MHz\",\n\"cores\": \"12\"\n},\n\"disk\": {\n\"model\": \"multiple\",\n\"value\": 2842540,\n\"count\": 4,\n\"valueType\": \"mb\",\n\"details\": [\n{\n\"model\": \"Samsung SSD 860 EVO 500GB\",\n\"size\": \"476940\"\n},\n{\n\"model\": \"SanDisk SDSSDHII480G\",\n\"size\": \"457862\"\n},\n{\n\"model\": \"WDS100T3X0C-00SJG0\",\n\"size\": \"953869\"\n},\n{\n\"model\": \"WDS100T3X0C-00SJG0\",\n\"size\": \"953869\"\n}\n]\n}\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "GET api\/servers\/{server}\/inventory\/getInventoryCommand", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/inventory\/getInventoryCommand", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/inventory\/getInventoryCommand", "variable": [ { "id": "server", "key": "server", "value": "1", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a shell command which can be executed on linux servers to collect information about the server hardware without rebooting." }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": \"wget -qO - https:\/\/domain.com\/api\/scripts\/hwdetect | bash -s 'https:\/\/domain.com\/api\/servers\/inventory\/callback\/40b219a00840e8a242c4bd12ec1a3f43'\",\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "GET api\/servers\/{server_id}\/inventory", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/inventory", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/inventory", "variable": [ { "id": "server_id", "key": "server_id", "value": "61", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Complete list of the server hardware inventory." }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 12,\n\"created_at\": \"2022-10-20T21:23:50.000000Z\",\n\"updated_at\": \"2022-10-20T21:23:50.000000Z\",\n\"model\": \"MAG X570 TOMAHAWK WIFI (MS-7C84)\",\n\"value\": \"1.0\",\n\"serial\": \"K317253975\",\n\"description\": \"\",\n\"server_id\": 61,\n\"customfields\": null,\n\"root_component\": {\n\"id\": 6,\n\"description\": \"Mainboard Model\",\n\"valueType\": \"text\"\n}\n},\n{\n\"id\": 13,\n\"created_at\": \"2022-10-20T21:23:50.000000Z\",\n\"updated_at\": \"2022-10-20T21:23:50.000000Z\",\n\"model\": \"American Megatrends Inc.\",\n\"value\": \"1.00\",\n\"serial\": \"04\/11\/2020\",\n\"description\": \"\",\n\"server_id\": 61,\n\"customfields\": null,\n\"root_component\": {\n\"id\": 4,\n\"description\": \"BIOS\",\n\"valueType\": \"text\"\n}\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/servers\/{server}\/inventory", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/inventory", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/inventory", "variable": [ { "id": "server", "key": "server", "value": "4", "description": "The ID of the server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"model\":\"Samsung SSD 860 EVO\",\"value\":\"476940\",\"serial\":\"S1Z2NB1K736669A\",\"inventorycomponent_id\":7,\"description\":\"Second SSD\"}" }, "description": "" }, "response": [] }, { "name": "api\/servers\/{server_id}\/inventory\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/inventory\/:id", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/inventory\/:id", "variable": [ { "id": "server_id", "key": "server_id", "value": "61", "description": "The ID of the server." }, { "id": "id", "key": "id", "value": "32", "description": "The ID of the inventory." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"id\": 32,\n\"created_at\": \"2022-10-20T21:23:50.000000Z\",\n\"updated_at\": \"2022-10-20T21:23:50.000000Z\",\n\"model\": \"WDS100T3X0C-00SJG0\",\n\"value\": \"953869\",\n\"serial\": \"192306800431\",\n\"description\": \"\",\n\"server_id\": 61,\n\"customfields\": [\n{\n\"fieldId\": 1,\n\"value\": \"3\"\n}\n],\n\"root_component\": {\n\"id\": 7,\n\"description\": \"Disk\",\n\"valueType\": \"mb\",\n\"customfields\": [\n{\n\"values\": []\n}\n]\n}\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/servers\/{server_id}\/inventory\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/inventory\/:id", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/inventory\/:id", "variable": [ { "id": "server_id", "key": "server_id", "value": "12", "description": "The ID of the server." }, { "id": "id", "key": "id", "value": "nihil", "description": "integer The ID of the inventory." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"model\":\"Samsung SSD 860 EVO\",\"value\":\"476940\",\"serial\":\"S1Z2NB1K736669A\",\"inventorycomponent_id\":7,\"description\":\"Second SSD\"}" }, "description": "" }, "response": [] }, { "name": "api\/servers\/{server_id}\/inventory\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/inventory\/:id", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/inventory\/:id", "variable": [ { "id": "server_id", "key": "server_id", "value": "9", "description": "The ID of the server." }, { "id": "id", "key": "id", "value": "3", "description": "The ID of the inventory." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Server Network Management", "description": "\nNetwork-related operations for servers", "item": [ { "name": "api\/servers\/{server}\/network\/regenerateVlanConfiguration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/network\/regenerateVlanConfiguration", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/network\/regenerateVlanConfiguration", "variable": [ { "id": "server", "key": "server", "value": "aut", "description": "The server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"performVlanActions\":\"none\"}" }, "description": "" }, "response": [] }, { "name": "GET api\/servers\/{server}\/network\/getManageableNetworkPorts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/network\/getManageableNetworkPorts", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/network\/getManageableNetworkPorts", "variable": [ { "id": "server", "key": "server", "value": "16", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get manageable network ports for a server" }, "response": [ { "header": [], "code": 200, "body": "{\n \"result\": {\n \"hasManageablePorts\": true\n },\n \"message\": \"success\"\n}", "name": "" } ] } ] }, { "name": "Server OS Provisioning", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/server-management\/server-page\/reinstallation-rescue\/", "item": [ { "name": "api\/servers\/{server}\/provisioning\/startReinstallation", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/provisioning\/startReinstallation", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/provisioning\/startReinstallation", "variable": [ { "id": "server", "key": "server", "value": "2", "description": "The ID of the server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"profileId\":1,\"rootpassword\":\"secretpassword\",\"disklayoutId\":1,\"runScripts\":[1,2],\"userprovidedDiskLayout\":\"autopart --type=lvm\",\"hostname\":\"my.hostname.com\",\"sshkeys\":[\"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCPMKW3XDPL0k257n8IBrmJrhSTOfczRjD5V5nou8uYCg1HJHnaCtdgPPdCQPfg5jYVKP5MCsgFBbfCWXv8GgDZAI905Yel46ZcRBkC0JKVkkc53I+wS\\\/zmwfxXzvkV6GRbCISnc1n98+wE4z+Qtg9FV+VAhJzinTCYFo9TV7hwkz7V5e+pj9\\\/5NgfVbFy0H8B2aXqp1F6A7ENBXNrbejXdTyo3lVIq1\\\/tHKfv6mcVmR4b4w7EVI4bvDMDdHeEKfMCvDUG359ElVp7gla5M0kohCCWtgLSchR\\\/6NTEIa6rAFhsmCHCfIE6q959Ff+KUR40e8yzulZtp3NPu8ukUjJtkBA5c4lAE2UUNldyqkWiE8sWAr+GlMjU0UkB3xzB0ID53EKH93WoIapjAnpDYxah8dOdyfk2cSmkdSe8DFNLeWffi8j3Ea9XeCQnMa\\\/VTcSarspnCKL8RG5LL8vGy\\\/\\\/0Cs6QXQDn\\\/gCTR2McTPbiiks2sFVWCaIIbgkTs9fGFuhM= root\"],\"configure_all_ipvfour\":false,\"configure_all_ipvsix\":false,\"installPowerAction\":\"noRestart\"}" }, "description": "" }, "response": [] }, { "name": "api\/servers\/{server}\/provisioning\/stopReinstallation", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/provisioning\/stopReinstallation", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/provisioning\/stopReinstallation", "variable": [ { "id": "server", "key": "server", "value": "61", "description": "The ID of the server." }, { "id": "withoutPowerReset", "key": "withoutPowerReset", "value": "2", "description": "By default, aborting an installation will trigger a power reset. Setting this parameter to 1 doesn't reset the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":\"ok\",\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/servers\/{server}\/provisioning\/getInstallStatus", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/provisioning\/getInstallStatus", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/provisioning\/getInstallStatus", "variable": [ { "id": "server", "key": "server", "value": "1", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"installProgress\": [],\n\"completed\": 0,\n\"canCancelInstallation\": 1,\n\"running\": 1,\n\"step\": 1\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "GET api\/servers\/{server}\/provisioning\/executePostCommand", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/provisioning\/executePostCommand", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/provisioning\/executePostCommand", "variable": [ { "id": "server", "key": "server", "value": "10", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "With some providers (e.g. OVH), a post action can be executed after the installation is complete. In the case of OVH, the post action is to request the credentials (for SSH, etc.) after the installation has been completed.\n\nThis endpoint is not used for PXE based installations." }, "response": [ { "header": [], "code": 200, "body": "{\"result\":{\"postTask\":[{\"type\":\"SSH\",\"url\":\"ssh:\\\/\\\/ns2114132.ip-34-144-0.eu\",\"username\":\"root\",\"password\":\"EH9HMSQ22gfvsjIQ2\",\"serverMainIp\":\"34.144.0.0\"}],\"postTaskAction\":\"getPassword\"},\"message\":\"success\"}", "name": "" } ] }, { "name": "GET api\/servers\/{server}\/provisioning\/getProfiles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/provisioning\/getProfiles", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/provisioning\/getProfiles", "variable": [ { "id": "server", "key": "server", "value": "61", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a list of installable operating systems for the server. The list also contains the rescue systems (see `isRescue`)." }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 1,\n\"name\": \"CentOS 7\",\n\"disklayouts\": [\n{\n\"id\": 2,\n\"name\": \"Automatic Partitioning\"\n},\n{\n\"id\": 4,\n\"name\": \"RAID 1\"\n},\n{\n\"id\": 5,\n\"name\": \"RAID 5\"\n},\n{\n\"id\": 6,\n\"name\": \"RAID 10\"\n},\n{\n\"id\": 7,\n\"name\": \"RAID 0\"\n},\n{\n\"id\": 8,\n\"name\": \"Install on largest disk\"\n},\n{\n\"id\": 9,\n\"name\": \"Install on smallest disk\"\n}\n],\n\"scripts\": [\n{\n\"id\": 2,\n\"name\": \"Install Nextcloud\"\n}\n],\n\"isRescue\": 0,\n\"isPasswordResetProfile\": 0,\n\"features\": {\n\"follow_install_progress\": 1,\n\"0\": 1,\n\"allow_ssh_keys\": 1,\n\"allow_set_hostname\": 1,\n\"set_root_password\": 1\n},\n\"default_disklayout_template\": 2,\n\"default_run_scripts\": [\n1\n],\n\"groupname\": \"CentOS\",\n\"grouplogo\": \"\/storage\/oslogos\/centos.png\"\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "POST api\/servers\/{server}\/provisioning\/getOsLogo", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/provisioning\/getOsLogo", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/provisioning\/getOsLogo", "variable": [ { "id": "server", "key": "server", "value": "13", "description": "The ID of the server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"os\":\"debian\"}" }, "description": "Returns the path to the logo of the OS." }, "response": [] } ] }, { "name": "Server Power", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/server-management\/server-page\/server-page\/#power-management", "item": [ { "name": "api\/servers\/{server}\/power\/{serverPowerMethod}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/power\/:serverPowerMethod", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/power\/:serverPowerMethod", "variable": [ { "id": "server", "key": "server", "value": "1", "description": "The ID of the server." }, { "id": "serverPowerMethod", "key": "serverPowerMethod", "value": "setPowerOn", "description": "The power method. Must be one of powerprovider.supportedFeatures (see `GET api\/servers\/{id}`)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"params\":\"aut\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":\"executed\",\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/servers\/{server}\/bmc\/executeCommand", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/bmc\/executeCommand", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/bmc\/executeCommand", "variable": [ { "id": "server", "key": "server", "value": "2", "description": "The ID of the server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"command\":\"chassis status\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": \"System Power : on\\nPower Overload : false\\nPower Interlock : inactive\\nMain Power Fault : false\\nPower Control Fault : false\\nPower Restore Policy : always-off\\nLast Power Event : \\nChassis Intrusion : inactive\\nFront-Panel Lockout : inactive\\nDrive Fault : false\\nCooling\/Fan Fault : false\",\n\"message\": \"success\"\n}", "name": "" } ] } ] }, { "name": "Server Ressources (VM)", "description": "", "item": [ { "name": "GET api\/servers\/{server_id}\/vm", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/vm", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/vm", "variable": [ { "id": "server_id", "key": "server_id", "value": "2", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Receive the current virtual server resources." }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"cpu\": {\n\"cores\": 2,\n\"sockets\": 2,\n\"cpulimit\": \"128\",\n\"cpuunits\": \"\",\n\"vcpus\": 2\n},\n\"disks\": [\n{\n\"size\": \"32\",\n\"name\": \"local:2017\/vm-2017-disk-1.qcow2,discard=on,size=32G\",\n\"id\": \"scsi0\"\n}\n],\n\"memory\": {\n\"memory\": 3400,\n\"balloon\": \"\"\n}\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/servers\/{server_id}\/vm", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/vm", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/vm", "variable": [ { "id": "server_id", "key": "server_id", "value": "2", "description": "The ID of the server." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"cpu\":{\"cores\":\"2\",\"sockets\":\"2\",\"cpulimit\":\"128\",\"cpuunits\":\"\"},\"disks\":[{\"size\":\"32\",\"name\":\"local:2017\\\/vm-2017-disk-1.qcow2,discard=on,size=32G\",\"id\":\"scsi0\"}],\"memory\":{\"memory\":3400,\"balloon\":\"\"}}" }, "description": "" }, "response": [] } ] }, { "name": "Server Snapshots", "description": "\nManage server snapshots.", "item": [ { "name": "GET api\/servers\/{server}\/snapshots", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/snapshots", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/snapshots", "variable": [ { "id": "server_id", "key": "server_id", "value": "ipsam", "description": "The ID of the server." }, { "id": "server", "key": "server", "value": "2", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all snapshots for a server." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":{\"snapshots\":[{\"snapshotId\":\"test\",\"name\":\"test\",\"description\":\"\",\"created\":1756135351,\"parent\":\"beforeUpgrade\",\"includesMemory\":false,\"size\":0,\"isCurrent\":true,\"isDeleting\":false,\"isRollingBack\":false,\"deleteTaskId\":null,\"rollbackTaskId\":null},{\"snapshotId\":\"beforeUpgrade\",\"name\":\"beforeUpgrade\",\"description\":\"\",\"created\":1756128772,\"parent\":null,\"includesMemory\":false,\"size\":0,\"isCurrent\":false,\"isDeleting\":false,\"isRollingBack\":false,\"deleteTaskId\":null,\"rollbackTaskId\":null}],\"notifications\":[],\"activeTasks\":{\"hasAnyActiveTask\":false,\"runningTask\":null,\"activeCreateSnapshotTask\":null,\"activeDeleteSnapshotTasks\":[],\"activeRollbackSnapshotTask\":null},\"meta\":{\"maxSnapshots\":3,\"defaultSnapshotMode\":\"snapshot\",\"defaultSnapshotIncludeMemory\":true,\"snapshotsEnabled\":true,\"ui\":{\"create\":{\"name\":{\"type\":\"text\",\"label\":\"Snapshot Name\",\"required\":true,\"maxLength\":40,\"default\":\"\",\"validationRegex\":\"^[a-zA-Z][a-zA-Z0-9_]*$\",\"validationMessage\":\"Must start with a letter. Allowed characters: A-Z, a-z, 0-9, _\",\"tooltip\":\"\",\"placeholder\":\"Enter a short name\"},\"description\":{\"type\":\"text\",\"label\":\"Description\",\"required\":false,\"maxLength\":100,\"default\":\"\",\"tooltip\":\"\",\"placeholder\":\"Enter a short snapshot description\"},\"includeMemory\":{\"type\":\"checkbox\",\"label\":\"Include VM Memory State\",\"tooltip\":\"Saves the current RAM state along with the disk state. This allows you to restore the VM to its exact running state. Note: The VM may be briefly unresponsive during snapshot creation but will continue running.\",\"required\":false,\"default\":true}}},\"canCreateUnlimitedSnapshots\":false}},\"message\":\"success\"}", "name": "" } ] }, { "name": "POST api\/servers\/{server}\/snapshots", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/snapshots", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/snapshots", "variable": [ { "id": "server", "key": "server", "value": "2", "description": "The ID of the server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"options\":[\"asperiores\"]}" }, "description": "Create a new snapshot for the server." }, "response": [] }, { "name": "DELETE api\/servers\/{server}\/snapshots", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/snapshots", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/snapshots", "variable": [ { "id": "server_id", "key": "server_id", "value": "repudiandae", "description": "The ID of the server." }, { "id": "server", "key": "server", "value": "2", "description": "The ID of the server." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"snapshotId\":\"snapshot1\"}" }, "description": "Delete a snapshot." }, "response": [] }, { "name": "POST api\/servers\/{server}\/snapshots\/rollback", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/snapshots\/rollback", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/snapshots\/rollback", "variable": [ { "id": "server", "key": "server", "value": "2", "description": "The ID of the server." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"snapshotId\":\"snapshot1\"}" }, "description": "Rollback to a snapshot." }, "response": [] }, { "name": "GET api\/servers\/{server}\/snapshots\/available", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/snapshots\/available", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/snapshots\/available", "variable": [ { "id": "server", "key": "server", "value": "2", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Check if snapshots are supported for this server." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":{\"available\":true},\"message\":\"success\"}", "name": "" } ] } ] }, { "name": "Server Statistics", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/server-management\/server-page\/server-page\/#statistics", "item": [ { "name": "api\/servers\/{server}\/stats\/network\/{statsMode}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/stats\/network\/:statsMode", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/stats\/network\/:statsMode", "variable": [ { "id": "server", "key": "server", "value": "9", "description": "The ID of the server." }, { "id": "statsMode", "key": "statsMode", "value": "text", "description": "Must be one of graph, or text. \"graph\" does return values for a graph (5 minute interval), \"text\" returns a summary for each day." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"from\":\"2025-08-25T15:29:15\",\"to\":\"2025-08-25T15:29:15\",\"predefined\":\"24h\",\"user_id\":7,\"groupBy\":\"1mo\",\"summary\":true}" }, "description": "" }, "response": [] }, { "name": "api\/servers\/{server}\/stats\/ipmi\/{statsMode}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/stats\/ipmi\/:statsMode", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/stats\/ipmi\/:statsMode", "variable": [ { "id": "server", "key": "server", "value": "2", "description": "The ID of the server." }, { "id": "statsMode", "key": "statsMode", "value": "text", "description": "Must be one of graph, or text. As of now, graph and text returns the same values. This behavior may change in the future. If detailed information is required, graph mode is recommended." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"from\":\"2025-08-25T15:29:15\",\"to\":\"2025-08-25T15:29:15\",\"predefined\":\"14days\",\"user_id\":15}" }, "description": "" }, "response": [] }, { "name": "api\/servers\/{server}\/stats\/cpu\/{statsMode}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/stats\/cpu\/:statsMode", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/stats\/cpu\/:statsMode", "variable": [ { "id": "server", "key": "server", "value": "1", "description": "The ID of the server." }, { "id": "statsMode", "key": "statsMode", "value": "graph", "description": "Must be one of graph, or text." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"from\":\"2025-08-25T15:29:15\",\"to\":\"2025-08-25T15:29:15\",\"predefined\":\"1h\",\"user_id\":1}" }, "description": "" }, "response": [] }, { "name": "api\/servers\/{server}\/stats\/memory\/{statsMode}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/stats\/memory\/:statsMode", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/stats\/memory\/:statsMode", "variable": [ { "id": "server", "key": "server", "value": "4", "description": "The ID of the server." }, { "id": "statsMode", "key": "statsMode", "value": "graph", "description": "Must be one of graph, or text." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"from\":\"2025-08-25T15:29:15\",\"to\":\"2025-08-25T15:29:15\",\"predefined\":\"1h\",\"user_id\":5}" }, "description": "" }, "response": [] }, { "name": "api\/servers\/{server}\/stats\/diskio\/{statsMode}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/stats\/diskio\/:statsMode", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/stats\/diskio\/:statsMode", "variable": [ { "id": "server", "key": "server", "value": "2", "description": "The ID of the server." }, { "id": "statsMode", "key": "statsMode", "value": "graph", "description": "Must be one of graph, or text." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"from\":\"2025-08-25T15:29:15\",\"to\":\"2025-08-25T15:29:15\",\"predefined\":\"14days\",\"user_id\":5}" }, "description": "" }, "response": [] }, { "name": "api\/servers\/{server}\/stats\/getAvailableStatistics", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server\/stats\/getAvailableStatistics", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server\/stats\/getAvailableStatistics", "variable": [ { "id": "server", "key": "server", "value": "1", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"predefined\":\"1h\",\"user_id\":1}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"available\": [\n\"bandwidth\",\n\"cpu\",\n\"memory\",\n\"diskio\"\n]\n},\n\"message\": \"success\"\n}", "name": "" } ] } ] }, { "name": "Subnet Management", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/ip-manager\/add-subnets\/", "item": [ { "name": "api\/subnets\/{subnetId}\/withDetails", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subnets\/:subnetId\/withDetails", "query": [], "raw": "{{baseUrl}}\/api\/subnets\/:subnetId\/withDetails", "variable": [ { "id": "subnetId", "key": "subnetId", "value": "1", "description": "The ID of the subnet." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"id\": 1,\n\"subnet\": \"10.10.10.0\",\n\"cidr\": 24,\n\"netmask\": \"255.255.255.0\",\n\"gw\": \"10.10.10.1\",\n\"type\": \"v4\",\n\"priority\": null,\n\"reserved\": 0,\n\"offer_if_server_has_tag\": [],\n\"dont_offer_if_server_has_tag\": [],\n\"only_if_server_has_remote_agents\": [],\n\"apply_restrictions_to_childs\": 0,\n\"dns_resolvers\": [\n\"65.108.22.20\",\n\"10.10.10.13\"\n],\n\"enable_switch_automation\": null,\n\"copy_network_automation_configuration_to_childs\": null,\n\"vlan_mode\": null,\n\"access_vlan_generation_mode\": null,\n\"static_access_vlan_id\": null,\n\"range_start_access_vlan_id\": null,\n\"range_end_access_vlan_id\": null,\n\"trunk_vlans\": null,\n\"vlan_layer3_mode\": null,\n\"vlan_layer3_ip\": null,\n\"reuse_access_vlan\": null,\n\"use_existing_port_access_vlan\": null,\n\"vlan_remove_layer3_ip_on_unassign\": null,\n\"rdnsAvailable\": 1,\n\"rdnsServerId\": 1,\n\"usageStatistics\": {\n\"free\": 68,\n\"reserved\": 25,\n\"used\": 170,\n\"totalIps\": 263,\n\"usedPercentage\": 74.14\n},\n\"description\": null,\n\"subnetAttributes\": {\n\"hasChildSubnets\": 0,\n\"amountOfDirectChilds\": 0,\n\"hasSubIps\": 1,\n\"amountOfSubIps\": 263,\n\"type\": \"v4\"\n},\n\"vlanAutomationAvailable\": false,\n\"ips\": [\n{ \"...\": \"...\" },\n{\n\"ip\": \"10.10.10.99\",\n\"reserved\": 0,\n\"servers_id\": 1,\n\"description\": null,\n\"servers_owner_realname\": \"Prof. Ernestina Beahan I\",\n\"servers_owner_id\": 10,\n\"servername\": \"the-server-name\",\n\"rdns_entry\": \"\"\n}\n],\n\"childSubnets\": [],\n\"rdnsFeatures\": {\n\"canManageUnassignedIPs\": 1,\n\"canManageAssignedIPs\": 1\n}\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "POST api\/subnets\/{subnetId}\/split", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subnets\/:subnetId\/split", "query": [], "raw": "{{baseUrl}}\/api\/subnets\/:subnetId\/split", "variable": [ { "id": "subnetId", "key": "subnetId", "value": "19", "description": "The ID of the subnet." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"mode\":\"subnet\",\"toPrefix\":64,\"gateway_method\":\"first\",\"toAmount\":100,\"generateIps\":false,\"copy_network_automation_configuration_to_childs\":true}" }, "description": "Split a subnet into smaller parts. Only available for IPv6." }, "response": [] }, { "name": "api\/subnets\/{subnetId}\/childsMassActions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subnets\/:subnetId\/childsMassActions", "query": [], "raw": "{{baseUrl}}\/api\/subnets\/:subnetId\/childsMassActions", "variable": [ { "id": "subnetId", "key": "subnetId", "value": "1", "description": "The ID of the subnet." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"updateRdns\":false,\"updateResolvers\":false,\"updateRestrictions\":true,\"updateSubnetOwners\":false,\"updateNetworkAutomationSettings\":false,\"updateDynamicIpAssignmentsSetting\":true}" }, "description": "" }, "response": [] }, { "name": "GET api\/subnets\/{subnetId}\/listFreeIps", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subnets\/:subnetId\/listFreeIps", "query": [], "raw": "{{baseUrl}}\/api\/subnets\/:subnetId\/listFreeIps", "variable": [ { "id": "subnetId", "key": "subnetId", "value": "1", "description": "The ID of the subnet." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a list of available IPs (unassigned, not reserved)." }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 33,\n\"ip\": \"10.10.10.31\"\n},\n{ \"...\": \"...\" }\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/subnets", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subnets", "query": [], "raw": "{{baseUrl}}\/api\/subnets" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":[{\"id\":1,\"subnet\":\"10.10.10.0\",\"cidr\":24,\"netmask\":\"255.255.255.0\",\"gw\":\"10.10.10.1\",\"type\":\"v4\",\"priority\":null,\"rootSubnetId\":null,\"isExternalProvider\":0,\"reserved\":0,\"offer_if_server_has_tag\":[],\"dont_offer_if_server_has_tag\":[],\"only_if_server_has_remote_agents\":[],\"apply_restrictions_to_childs\":0,\"dns_resolvers\":[\"65.108.22.20\",\"10.10.10.13\"],\"enable_switch_automation\":null,\"vlan_mode\":null,\"access_vlan_generation_mode\":null,\"static_access_vlan_id\":null,\"range_start_access_vlan_id\":null,\"range_end_access_vlan_id\":null,\"trunk_vlans\":[],\"vlan_layer3_mode\":null,\"vlan_layer3_ip\":null,\"reuse_access_vlan\":null,\"use_existing_port_access_vlan\":null,\"vlan_remove_layer3_ip_on_unassign\":null,\"userId\":1,\"copy_network_automation_configuration_to_childs\":null,\"exclude_from_dynamic_ip_assignments\":null,\"rdnsAvailable\":1,\"rdnsServerId\":1,\"usageStatistics\":{\"free\":68,\"reserved\":25,\"used\":170,\"totalIps\":263,\"usedPercentage\":74.14},\"description\":null,\"subnetAttributes\":{\"hasChildSubnets\":0,\"amountOfDirectChilds\":0,\"hasSubIps\":1,\"amountOfSubIps\":263,\"type\":\"v4\"},\"vlanAutomationAvailable\":false,\"ownerChain\":[{\"userId\":1,\"name\":\"Mable White\",\"username\":\"adm\"}],\"subnetOwnedByUser\":true},{\"id\":2,\"subnet\":\"64:ff9b:2::\",\"cidr\":48,\"netmask\":\"\",\"gw\":\"64:ff9b:2::1\",\"type\":\"v6\",\"priority\":null,\"rootSubnetId\":null,\"isExternalProvider\":0,\"reserved\":0,\"offer_if_server_has_tag\":[],\"dont_offer_if_server_has_tag\":[],\"only_if_server_has_remote_agents\":[],\"apply_restrictions_to_childs\":0,\"dns_resolvers\":[\"aaaa:bbbb::1\",\"aaaa:bbbc::2\"],\"enable_switch_automation\":null,\"vlan_mode\":null,\"access_vlan_generation_mode\":null,\"static_access_vlan_id\":null,\"range_start_access_vlan_id\":null,\"range_end_access_vlan_id\":null,\"trunk_vlans\":[],\"vlan_layer3_mode\":null,\"vlan_layer3_ip\":null,\"reuse_access_vlan\":null,\"use_existing_port_access_vlan\":null,\"vlan_remove_layer3_ip_on_unassign\":null,\"userId\":1,\"copy_network_automation_configuration_to_childs\":null,\"exclude_from_dynamic_ip_assignments\":null,\"rdnsAvailable\":0,\"rdnsServerId\":null,\"usageStatistics\":{\"free\":0,\"reserved\":0,\"used\":0,\"totalIps\":0,\"usedPercentage\":0},\"description\":null,\"subnetAttributes\":{\"hasChildSubnets\":0,\"amountOfDirectChilds\":0,\"hasSubIps\":0,\"amountOfSubIps\":0,\"type\":\"v6\"},\"vlanAutomationAvailable\":false,\"ownerChain\":[{\"userId\":1,\"name\":\"Mable White\",\"username\":\"adm\"}],\"subnetOwnedByUser\":true},{\"id\":3,\"subnet\":\"64:ff9b:1::\",\"cidr\":48,\"netmask\":\"\",\"gw\":\"64:ff9b:1::1\",\"type\":\"v6\",\"priority\":null,\"rootSubnetId\":null,\"isExternalProvider\":0,\"reserved\":0,\"offer_if_server_has_tag\":[],\"dont_offer_if_server_has_tag\":[],\"only_if_server_has_remote_agents\":[],\"apply_restrictions_to_childs\":0,\"dns_resolvers\":[\"aaaa:bbbb::1\",\"aaaa:bbbc::2\"],\"enable_switch_automation\":null,\"vlan_mode\":null,\"access_vlan_generation_mode\":null,\"static_access_vlan_id\":null,\"range_start_access_vlan_id\":null,\"range_end_access_vlan_id\":null,\"trunk_vlans\":[],\"vlan_layer3_mode\":null,\"vlan_layer3_ip\":null,\"reuse_access_vlan\":null,\"use_existing_port_access_vlan\":null,\"vlan_remove_layer3_ip_on_unassign\":null,\"userId\":1,\"copy_network_automation_configuration_to_childs\":null,\"exclude_from_dynamic_ip_assignments\":null,\"rdnsAvailable\":0,\"rdnsServerId\":null,\"usageStatistics\":{\"free\":0,\"reserved\":0,\"used\":0,\"totalIps\":0,\"usedPercentage\":0},\"description\":null,\"subnetAttributes\":{\"hasChildSubnets\":0,\"amountOfDirectChilds\":0,\"hasSubIps\":0,\"amountOfSubIps\":0,\"type\":\"v6\"},\"vlanAutomationAvailable\":false,\"ownerChain\":[{\"userId\":1,\"name\":\"Mable White\",\"username\":\"adm\"}],\"subnetOwnedByUser\":true}],\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/subnets", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subnets", "query": [], "raw": "{{baseUrl}}\/api\/subnets" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"subnet\":\"10.10.11.0\",\"cidr\":24,\"userId\":12,\"netmask\":\"255.255.255.0\",\"gw\":\"10.10.11.1\",\"type\":\"v4\",\"offer_if_server_has_tag\":[\"adipisci\"],\"dont_offer_if_server_has_tag\":[\"fugit\"],\"only_if_server_has_remote_agents\":[7],\"dns_resolvers\":[\"1.1.1.1\",\"1.0.0.1\",\"8.8.8.8\"],\"generateIps\":true,\"enable_switch_automation\":false,\"copy_network_automation_configuration_to_childs\":true,\"vlan_mode\":\"access\",\"access_vlan_generation_mode\":\"fixed\",\"static_access_vlan_id\":8,\"range_start_access_vlan_id\":1,\"range_end_access_vlan_id\":2884,\"trunk_vlans\":[1441],\"vlan_layer3_mode\":\"custom\",\"vlan_layer3_ip\":\"est\",\"reuse_access_vlan\":false,\"use_existing_port_access_vlan\":true,\"vlan_remove_layer3_ip_on_unassign\":true,\"exclude_from_dynamic_ip_assignments\":false}" }, "description": "" }, "response": [] }, { "name": "api\/subnets\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subnets\/:id", "query": [], "raw": "{{baseUrl}}\/api\/subnets\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the subnet." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":{\"id\":1,\"subnet\":\"10.10.10.0\",\"cidr\":24,\"netmask\":\"255.255.255.0\",\"gw\":\"10.10.10.1\",\"type\":\"v4\",\"priority\":null,\"rootSubnetId\":null,\"isExternalProvider\":0,\"reserved\":0,\"offer_if_server_has_tag\":[],\"dont_offer_if_server_has_tag\":[],\"only_if_server_has_remote_agents\":[],\"apply_restrictions_to_childs\":0,\"dns_resolvers\":[\"65.108.22.20\",\"10.10.10.13\"],\"enable_switch_automation\":null,\"vlan_mode\":null,\"access_vlan_generation_mode\":null,\"static_access_vlan_id\":null,\"range_start_access_vlan_id\":null,\"range_end_access_vlan_id\":null,\"trunk_vlans\":[],\"vlan_layer3_mode\":null,\"vlan_layer3_ip\":null,\"reuse_access_vlan\":null,\"use_existing_port_access_vlan\":null,\"vlan_remove_layer3_ip_on_unassign\":null,\"userId\":1,\"copy_network_automation_configuration_to_childs\":null,\"exclude_from_dynamic_ip_assignments\":null,\"rdnsAvailable\":1,\"rdnsServerId\":1,\"usageStatistics\":{\"free\":68,\"reserved\":25,\"used\":170,\"totalIps\":263,\"usedPercentage\":74.14},\"description\":null,\"subnetAttributes\":{\"hasChildSubnets\":0,\"amountOfDirectChilds\":0,\"hasSubIps\":1,\"amountOfSubIps\":263,\"type\":\"v4\"},\"vlanAutomationAvailable\":false,\"ownerChain\":[{\"userId\":1,\"name\":\"Mable White\",\"username\":\"adm\"}],\"subnetOwnedByUser\":true},\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/subnets\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subnets\/:id", "query": [], "raw": "{{baseUrl}}\/api\/subnets\/:id", "variable": [ { "id": "id", "key": "id", "value": "18", "description": "The ID of the subnet." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"gw\":\"174.69.12.140\",\"userId\":14,\"description\":\"officia\",\"priority\":18,\"offer_if_server_has_tag\":[\"ipsa\"],\"dont_offer_if_server_has_tag\":[\"modi\"],\"only_if_server_has_remote_agents\":[8],\"dns_resolvers\":[\"1.1.1.1\",\"1.0.0.1\",\"8.8.8.8\"],\"enable_switch_automation\":true,\"copy_network_automation_configuration_to_childs\":true,\"vlan_mode\":\"access\",\"access_vlan_generation_mode\":\"fixed\",\"static_access_vlan_id\":4,\"range_start_access_vlan_id\":0,\"range_end_access_vlan_id\":2610,\"trunk_vlans\":[3142],\"vlan_layer3_mode\":\"custom\",\"vlan_layer3_ip\":\"natus\",\"reuse_access_vlan\":false,\"use_existing_port_access_vlan\":true,\"vlan_remove_layer3_ip_on_unassign\":false,\"exclude_from_dynamic_ip_assignments\":true}" }, "description": "" }, "response": [] }, { "name": "api\/subnets\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subnets\/:id", "query": [], "raw": "{{baseUrl}}\/api\/subnets\/:id", "variable": [ { "id": "id", "key": "id", "value": "18", "description": "The ID of the subnet." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "System Backups", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/system-settings\/system-backups\/", "item": [ { "name": "api\/system\/backups\/storages", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/backups\/storages", "query": [], "raw": "{{baseUrl}}\/api\/system\/backups\/storages" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":[{\"id\":2,\"name\":\"FTP #1\",\"provider\":\"ftp\",\"configuration\":{\"host\":\"10.10.3.1\",\"username\":\"backup\",\"password\":\"password\",\"port\":21,\"ssl\":true,\"timeout\":10,\"root\":\"\"},\"last_backup_date\":\"2025-08-25 15:18:51\",\"last_status_message\":\"success\",\"retention\":1,\"enabled\":0}],\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/system\/backups\/storages", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/backups\/storages", "query": [], "raw": "{{baseUrl}}\/api\/system\/backups\/storages" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"placeat\",\"provider\":\"local\",\"retention\":4021,\"enabled\":true}" }, "description": "" }, "response": [] }, { "name": "api\/system\/backups\/storages\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/backups\/storages\/:id", "query": [], "raw": "{{baseUrl}}\/api\/system\/backups\/storages\/:id", "variable": [ { "id": "id", "key": "id", "value": "2", "description": "The ID of the storage." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"id\": 2,\n\"name\": \"FTP #1\",\n\"provider\": \"ftp\",\n\"configuration\": {\n\"host\": \"10.10.3.1\",\n\"username\": \"backup\",\n\"password\": \"password\",\n\"port\": 21,\n\"ssl\": true,\n\"timeout\": 10,\n\"root\": \"\"\n},\n\"last_backup_date\": \"2023-01-11 12:37:04\",\n\"last_status_message\": \"success\",\n\"retention\": 1,\n\"enabled\": 0\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/system\/backups\/storages\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/backups\/storages\/:id", "query": [], "raw": "{{baseUrl}}\/api\/system\/backups\/storages\/:id", "variable": [ { "id": "id", "key": "id", "value": "2", "description": "The ID of the storage." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"nihil\",\"retention\":3521,\"enabled\":false}" }, "description": "" }, "response": [] }, { "name": "api\/system\/backups\/storages\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/backups\/storages\/:id", "query": [], "raw": "{{baseUrl}}\/api\/system\/backups\/storages\/:id", "variable": [ { "id": "id", "key": "id", "value": "2", "description": "The ID of the storage." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "api\/system\/backups\/history", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/backups\/history", "query": [], "raw": "{{baseUrl}}\/api\/system\/backups\/history" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":[{\"id\":1,\"created_at\":\"2025-08-25T15:18:48.000000Z\",\"archive_size\":6351460,\"script_log\":\"Mon 25 Aug 2025 03:18:48 PM UTC: [START] Creating backup of the local database\\nMon 25 Aug 2025 03:18:48 PM UTC: [END] Creating backup of the local database\\nMon 25 Aug 2025 03:18:48 PM UTC: [START] Copying essential files\\nMon 25 Aug 2025 03:18:51 PM UTC: [END] Copying essential files\\nMon 25 Aug 2025 03:18:51 PM UTC: [START] Creating backup archive\\nMon 25 Aug 2025 03:18:51 PM UTC: [END] Creating backup archive\\n\\\/var\\\/www\\\/storage\\\/system_backups\\\/app-5b0ea187cb-1756135131.tar.gz\",\"tasks_log\":[{\"date\":\"2025-08-25 15:18:48\",\"message\":\"Task pending\",\"type\":\"info\"},{\"date\":\"2025-08-25 15:18:48\",\"message\":\"Backup started\",\"type\":\"info\"},{\"date\":\"2025-08-25 15:18:51\",\"message\":\"Backup archive created\",\"type\":\"info\"},{\"date\":\"2025-08-25 15:18:51\",\"message\":\"local: Started retention task\",\"type\":\"info\"},{\"date\":\"2025-08-25 15:18:51\",\"message\":\"local: Deleting file app-5b0ea187cb-1754323895.tar.gz\",\"type\":\"info\"},{\"date\":\"2025-08-25 15:18:51\",\"message\":\"local: Retention task completed\",\"type\":\"info\"},{\"date\":\"2025-08-25 15:18:51\",\"message\":\"Backup ended\",\"type\":\"info\"}],\"current_status\":\"Executed\",\"result\":\"Done\",\"warning\":0,\"error\":0,\"end_date\":\"2025-08-25 15:18:51\"}],\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/system\/backups\/history\/{backupTaskId}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/backups\/history\/:backupTaskId", "query": [], "raw": "{{baseUrl}}\/api\/system\/backups\/history\/:backupTaskId", "variable": [ { "id": "backupTaskId", "key": "backupTaskId", "value": "1", "description": "The ID of the backup task." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":{\"id\":1,\"created_at\":\"2025-08-25T15:18:48.000000Z\",\"archive_size\":6351460,\"script_log\":\"Mon 25 Aug 2025 03:18:48 PM UTC: [START] Creating backup of the local database\\nMon 25 Aug 2025 03:18:48 PM UTC: [END] Creating backup of the local database\\nMon 25 Aug 2025 03:18:48 PM UTC: [START] Copying essential files\\nMon 25 Aug 2025 03:18:51 PM UTC: [END] Copying essential files\\nMon 25 Aug 2025 03:18:51 PM UTC: [START] Creating backup archive\\nMon 25 Aug 2025 03:18:51 PM UTC: [END] Creating backup archive\\n\\\/var\\\/www\\\/storage\\\/system_backups\\\/app-5b0ea187cb-1756135131.tar.gz\",\"tasks_log\":[{\"date\":\"2025-08-25 15:18:48\",\"message\":\"Task pending\",\"type\":\"info\"},{\"date\":\"2025-08-25 15:18:48\",\"message\":\"Backup started\",\"type\":\"info\"},{\"date\":\"2025-08-25 15:18:51\",\"message\":\"Backup archive created\",\"type\":\"info\"},{\"date\":\"2025-08-25 15:18:51\",\"message\":\"local: Started retention task\",\"type\":\"info\"},{\"date\":\"2025-08-25 15:18:51\",\"message\":\"local: Deleting file app-5b0ea187cb-1754323895.tar.gz\",\"type\":\"info\"},{\"date\":\"2025-08-25 15:18:51\",\"message\":\"local: Retention task completed\",\"type\":\"info\"},{\"date\":\"2025-08-25 15:18:51\",\"message\":\"Backup ended\",\"type\":\"info\"}],\"current_status\":\"Executed\",\"result\":\"Done\",\"warning\":0,\"error\":0,\"end_date\":\"2025-08-25 15:18:51\"},\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/system\/backups\/create", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/backups\/create", "query": [], "raw": "{{baseUrl}}\/api\/system\/backups\/create" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "System Logs", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/logs\/system-logs\/", "item": [ { "name": "api\/servers\/{server_id}\/activitylog", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/servers\/:server_id\/activitylog", "query": [], "raw": "{{baseUrl}}\/api\/servers\/:server_id\/activitylog", "variable": [ { "id": "server_id", "key": "server_id", "value": "20", "description": "The ID of the server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 1812,\n\"userId\": \"1\",\n\"relationId\": \"1\",\n\"relationType\": \"servers\",\n\"rootId\": \"1\",\n\"rootType\": \"serverPower\",\n\"description\": \"Executed Power Action setPowerOff\",\n\"modelchanges\": [],\n\"userIp\": \"192.168.22.59\",\n\"visibleFor\": \"all\",\n\"loglevel\": \"info\",\n\"postdata\": \"\",\n\"created_at\": \"2022-10-21T16:56:21.000000Z\",\n\"updated_at\": \"2022-10-21T16:56:21.000000Z\",\n\"endpoint\": \"\/api\/servers\/1\/power\/setPowerOff\",\n\"method\": \"GET\",\n\"requestSource\": \"web\",\n\"userDetails\": {\n\"username\": \"adm\",\n\"name\": \"Mrs. Adelia Murphy\",\n\"id\": 1\n},\n\"meta\": {\n\"href\": \"\/servers\/1\",\n\"text\": \"server-01\"\n}\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/activitylog\/user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/activitylog\/user", "query": [], "raw": "{{baseUrl}}\/api\/activitylog\/user", "variable": [ { "id": "limit", "key": "limit", "value": "11", "description": "Limit the returned results." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 2262,\n\"userId\": \"1\",\n\"relationId\": \"\",\n\"relationType\": \"\",\n\"rootId\": \"1\",\n\"rootType\": \"subnet\",\n\"description\": \"Updated Subnet 10.10.10.0\",\n\"modelchanges\": {\n\"only_if_server_has_remote_agents\": {\n\"original\": [\n1\n],\n\"changes\": \"[]\"\n}\n},\n\"userIp\": \"192.168.155.48\",\n\"visibleFor\": \"all\",\n\"loglevel\": \"info\",\n\"postdata\": \"{\\\"only_if_server_has_remote_agents\\\":[]}\",\n\"created_at\": \"2022-10-21T17:58:19.000000Z\",\n\"updated_at\": \"2022-10-21T17:58:19.000000Z\",\n\"endpoint\": \"\/api\/subnets\/1\",\n\"method\": \"PUT\",\n\"requestSource\": \"web\",\n\"userDetails\": {\n\"username\": \"adm\",\n\"name\": \"Mrs. Adelia Murphy\",\n\"id\": 1\n},\n\"meta\": {\n\"text\": \"ID: 1\"\n}\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/activitylog\/agents\/{agentId?}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/activitylog\/agents\/:agentId", "query": [], "raw": "{{baseUrl}}\/api\/activitylog\/agents\/:agentId", "variable": [ { "id": "agentId", "key": "agentId", "value": "8", "description": "optional The ID of the agent." }, { "id": "limit", "key": "limit", "value": "11", "description": "Limit the returned results." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 7950,\n\"userId\": \"system\",\n\"relationId\": \"\",\n\"relationType\": \"\",\n\"rootId\": \"1\",\n\"rootType\": \"servers\",\n\"description\": \"Aborted PXE provisioning\",\n\"modelchanges\": \"[]\",\n\"userIp\": \"-\",\n\"visibleFor\": \"admin\",\n\"loglevel\": \"info\",\n\"postdata\": \"\\\"\\\"\",\n\"created_at\": \"2022-10-21 16:56:18\",\n\"updated_at\": \"2022-10-21 16:56:18\",\n\"agentId\": 1,\n\"agentName\": \"Local Agent\",\n\"userDetails\": {\n\"username\": \"System\",\n\"name\": \"system\",\n\"id\": \"System\"\n},\n\"meta\": {\n\"href\": \"\/servers\/1\",\n\"text\": \"server-001\"\n}\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/activitylog\/system", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/activitylog\/system", "query": [], "raw": "{{baseUrl}}\/api\/activitylog\/system", "variable": [ { "id": "limit", "key": "limit", "value": "17", "description": "Limit the returned results." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 1810,\n\"userId\": \"system\",\n\"relationId\": \"\",\n\"relationType\": \"\",\n\"rootId\": \"1\",\n\"rootType\": \"agents\",\n\"description\": \"Regenerated DHCP Configuration\",\n\"modelchanges\": [],\n\"userIp\": \"-\",\n\"visibleFor\": \"admin\",\n\"loglevel\": \"info\",\n\"postdata\": \"\",\n\"created_at\": \"2022-10-21T16:56:19.000000Z\",\n\"updated_at\": \"2022-10-21T16:56:19.000000Z\",\n\"endpoint\": \"\/api\/servers\/1\/provisioning\/stopReinstallation\",\n\"method\": \"GET\",\n\"requestSource\": \"web\",\n\"userDetails\": {\n\"username\": \"System\",\n\"name\": \"system\",\n\"id\": \"System\"\n},\n\"meta\": {\n\"href\": \"\",\n\"text\": \"\"\n}\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] } ] }, { "name": "System Settings", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/system-settings\/behaviour\/", "item": [ { "name": "api\/system\/globalSystemSettings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/globalSystemSettings", "query": [], "raw": "{{baseUrl}}\/api\/system\/globalSystemSettings" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 2,\n\"setting\": \"delete_rdns_entry_when_delete_ip\",\n\"value\": \"on\",\n\"created_at\": \"2022-10-21T09:43:03.000000Z\",\n\"updated_at\": \"2022-10-21T09:43:03.000000Z\"\n},\n{ \"...\": \"...\"}\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/system\/globalSystemSettings\/{settingname}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/globalSystemSettings\/:settingname", "query": [], "raw": "{{baseUrl}}\/api\/system\/globalSystemSettings\/:settingname", "variable": [ { "id": "settingname", "key": "settingname", "value": "default_datetime_format", "description": "The name of the setting." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":\"DD.MM.YYYY HH:mm:ss\",\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/system\/globalSystemSettings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system\/globalSystemSettings", "query": [], "raw": "{{baseUrl}}\/api\/system\/globalSystemSettings" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"settings\":[{\"delete_rdns_entry_when_delete_ip\":\"off\"}]}" }, "description": "" }, "response": [] } ] }, { "name": "Task Tracking", "description": "\nGet task status and details for polling operations. Currently only used for server backups and snapshots.", "item": [ { "name": "GET api\/tasks\/{task}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tasks\/:id", "query": [], "raw": "{{baseUrl}}\/api\/tasks\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the task." }, { "id": "task", "key": "task", "value": "123", "description": "The ID of the task." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get details of a specific task." }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"id\": 1,\n\"action\": \"createSnapshot\",\n\"status\": \"running\",\n\"progress\": 0,\n\"message\": null,\n\"created_at\": \"2025-08-25T15:22:31.000000Z\",\n\"updated_at\": \"2025-08-25T15:22:31.000000Z\"\n},\n\"message\": \"success\"\n}", "name": "" } ] } ] }, { "name": "Users", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/users\/manage-users\/", "item": [ { "name": "api\/impersonate\/{impersonateUserId}\/start", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/impersonate\/:impersonateUserId\/start", "query": [], "raw": "{{baseUrl}}\/api\/impersonate\/:impersonateUserId\/start", "variable": [ { "id": "impersonateUserId", "key": "impersonateUserId", "value": "2", "description": "The user ID which you want to impersonate." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/user\/additionalUserInformation", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/additionalUserInformation", "query": [], "raw": "{{baseUrl}}\/api\/user\/additionalUserInformation" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"userId\":15,\"withOwnedUsersData\":false,\"limitOwnedUsersDataToIds\":[1,10,20]}" }, "description": "" }, "response": [] }, { "name": "GET api\/user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user", "query": [], "raw": "{{baseUrl}}\/api\/user" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Receive information about the current logged in user." }, "response": [ { "header": [], "code": 200, "body": "{\n\"id\": 1,\n\"name\": \"Dr. Eva Flatley\",\n\"timezone\": \"Europe\/Berlin\",\n\"datetimeFormat\": \"DD.MM.YYYY HH:mm:ss\",\n\"darkmode\": null,\n\"sshkeys\": [],\n\"prefs\": [],\n\"currentIp\": \"10.12.13.14\",\n\"language\": \"en-us\",\n\"isSharedAccess\": false,\n\"sharedUserId\": null,\n\"realOrSharedUserId\": 1,\n\"permissions\": [\n\"system.version\",\n\"system.apiOutput.param.app_version\",\n\"...\"\n]\n}", "name": "" } ] }, { "name": "api\/impersonate\/{impersonateUserId}\/stop", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/impersonate\/:impersonateUserId\/stop", "query": [], "raw": "{{baseUrl}}\/api\/impersonate\/:impersonateUserId\/stop", "variable": [ { "id": "impersonateUserId", "key": "impersonateUserId", "value": "2", "description": "Stop impersonating the user ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/users\/{user}\/tokens", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:user\/tokens", "query": [], "raw": "{{baseUrl}}\/api\/users\/:user\/tokens", "variable": [ { "id": "user", "key": "user", "value": "1", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":[{\"id\":1,\"name\":\"WHMCS\",\"created_at\":\"2022-03-27T10:24:42.000000Z\",\"last_used\":\"2025-08-25T15:29:14.000000Z\",\"allowedHosts\":[]},{\"id\":2,\"name\":\"Docs auth\",\"created_at\":\"2022-10-27T06:48:44.000000Z\",\"last_used\":null,\"allowedHosts\":[]}],\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/users\/{user}\/tokens", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:user\/tokens", "query": [], "raw": "{{baseUrl}}\/api\/users\/:user\/tokens", "variable": [ { "id": "user", "key": "user", "value": "8", "description": "The ID of the user." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"recusandae\",\"allowedHosts\":[\"10.10.12.10\"]}" }, "description": "" }, "response": [] }, { "name": "api\/users\/{user}\/tokens\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:user\/tokens\/:id", "query": [], "raw": "{{baseUrl}}\/api\/users\/:user\/tokens\/:id", "variable": [ { "id": "user", "key": "user", "value": "1", "description": "The ID of the user." }, { "id": "id", "key": "id", "value": "2", "description": "The ID of the token." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":{\"id\":1,\"name\":\"WHMCS\",\"created_at\":\"2022-03-27T10:24:42.000000Z\",\"last_used\":\"2025-08-25T15:29:14.000000Z\",\"allowedHosts\":[]},\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/users\/{user}\/tokens\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:user\/tokens\/:id", "query": [], "raw": "{{baseUrl}}\/api\/users\/:user\/tokens\/:id", "variable": [ { "id": "user", "key": "user", "value": "7", "description": "The ID of the user." }, { "id": "id", "key": "id", "value": "10", "description": "The ID of the token." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "api\/users\/{user}\/sshkeys", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:user\/sshkeys", "query": [], "raw": "{{baseUrl}}\/api\/users\/:user\/sshkeys", "variable": [ { "id": "user", "key": "user", "value": "1", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":[{\"id\":1,\"created_at\":\"2025-08-25T15:18:48.000000Z\",\"name\":\"Ansible\",\"pubkey\":\"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCPMKW3XDPL0k257n8IBrmJrhSTOfczRjD5V5nou8uYCg1HJHnaCtdgPPdCQPfg5jYVKP5MCsgFBbfCWXv8GgDZAI905Yel46ZcRBkC0JKVkkc53I+wS\\\/zmwfxXzvkV6GRbCISnc1n98+wE4z+Qtg9FV+VAhJzinTCYFo9TV7hwkz7V5e+pj9\\\/5NgfVbFy0H8B2aXqp1F6A7ENBXNrbejXdTyo3lVIq1\\\/tHKfv6mcVmR4b4w7EVI4bvDMDdHeEKfMCvDUG359ElVp7gla5M0kohCCWtgLSchR\\\/6NTEIa6rAFhsmCHCfIE6q959Ff+KUR40e8yzulZtp3NPu8ukUjJtkBA5c4lAE2UUNldyqkWiE8sWAr+GlMjU0UkB3xzB0ID53EKH93WoIapjAnpDYxah8dOdyfk2cSmkdSe8DFNLeWffi8j3Ea9XeCQnMa\\\/VTcSarspnCKL8RG5LL8vGy\\\/\\\/0Cs6QXQDn\\\/gCTR2McTPbiiks2sFVWCaIIbgkTs9fGFuhM= root@ansible\",\"userid\":1,\"description\":\"Ansible SSH Key\"}],\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/users\/{user}\/sshkeys", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:user\/sshkeys", "query": [], "raw": "{{baseUrl}}\/api\/users\/:user\/sshkeys", "variable": [ { "id": "user", "key": "user", "value": "20", "description": "The ID of the user." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"reiciendis\",\"pubkey\":\"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCPMKW3XDPL0k257n8IBrmJrhSTOfczRjD5V5nou8uYCg1HJHnaCtdgPPdCQPfg5jYVKP5MCsgFBbfCWXv8GgDZAI905Yel46ZcRBkC0JKVkkc53I+wS\\\/zmwfxXzvkV6GRbCISnc1n98+wE4z+Qtg9FV+VAhJzinTCYFo9TV7hwkz7V5e+pj9\\\/5NgfVbFy0H8B2aXqp1F6A7ENBXNrbejXdTyo3lVIq1\\\/tHKfv6mcVmR4b4w7EVI4bvDMDdHeEKfMCvDUG359ElVp7gla5M0kohCCWtgLSchR\\\/6NTEIa6rAFhsmCHCfIE6q959Ff+KUR40e8yzulZtp3NPu8ukUjJtkBA5c4lAE2UUNldyqkWiE8sWAr+GlMjU0UkB3xzB0ID53EKH93WoIapjAnpDYxah8dOdyfk2cSmkdSe8DFNLeWffi8j3Ea9XeCQnMa\\\/VTcSarspnCKL8RG5LL8vGy\\\/\\\/0Cs6QXQDn\\\/gCTR2McTPbiiks2sFVWCaIIbgkTs9fGFuhM=\",\"description\":\"delectus\"}" }, "description": "" }, "response": [] }, { "name": "api\/users\/{user}\/sshkeys\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:user\/sshkeys\/:id", "query": [], "raw": "{{baseUrl}}\/api\/users\/:user\/sshkeys\/:id", "variable": [ { "id": "user", "key": "user", "value": "1", "description": "The ID of the user." }, { "id": "id", "key": "id", "value": "1", "description": "The ID of the SSH key." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":{\"id\":1,\"created_at\":\"2025-08-25T15:18:48.000000Z\",\"name\":\"Ansible\",\"pubkey\":\"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCPMKW3XDPL0k257n8IBrmJrhSTOfczRjD5V5nou8uYCg1HJHnaCtdgPPdCQPfg5jYVKP5MCsgFBbfCWXv8GgDZAI905Yel46ZcRBkC0JKVkkc53I+wS\\\/zmwfxXzvkV6GRbCISnc1n98+wE4z+Qtg9FV+VAhJzinTCYFo9TV7hwkz7V5e+pj9\\\/5NgfVbFy0H8B2aXqp1F6A7ENBXNrbejXdTyo3lVIq1\\\/tHKfv6mcVmR4b4w7EVI4bvDMDdHeEKfMCvDUG359ElVp7gla5M0kohCCWtgLSchR\\\/6NTEIa6rAFhsmCHCfIE6q959Ff+KUR40e8yzulZtp3NPu8ukUjJtkBA5c4lAE2UUNldyqkWiE8sWAr+GlMjU0UkB3xzB0ID53EKH93WoIapjAnpDYxah8dOdyfk2cSmkdSe8DFNLeWffi8j3Ea9XeCQnMa\\\/VTcSarspnCKL8RG5LL8vGy\\\/\\\/0Cs6QXQDn\\\/gCTR2McTPbiiks2sFVWCaIIbgkTs9fGFuhM= root@ansible\",\"userid\":1,\"description\":\"Ansible SSH Key\"},\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/users\/{user}\/sshkeys\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:user\/sshkeys\/:id", "query": [], "raw": "{{baseUrl}}\/api\/users\/:user\/sshkeys\/:id", "variable": [ { "id": "user", "key": "user", "value": "9", "description": "The ID of the user." }, { "id": "id", "key": "id", "value": "10", "description": "The ID of the SSH key." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"fugit\",\"pubkey\":\"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCPMKW3XDPL0k257n8IBrmJrhSTOfczRjD5V5nou8uYCg1HJHnaCtdgPPdCQPfg5jYVKP5MCsgFBbfCWXv8GgDZAI905Yel46ZcRBkC0JKVkkc53I+wS\\\/zmwfxXzvkV6GRbCISnc1n98+wE4z+Qtg9FV+VAhJzinTCYFo9TV7hwkz7V5e+pj9\\\/5NgfVbFy0H8B2aXqp1F6A7ENBXNrbejXdTyo3lVIq1\\\/tHKfv6mcVmR4b4w7EVI4bvDMDdHeEKfMCvDUG359ElVp7gla5M0kohCCWtgLSchR\\\/6NTEIa6rAFhsmCHCfIE6q959Ff+KUR40e8yzulZtp3NPu8ukUjJtkBA5c4lAE2UUNldyqkWiE8sWAr+GlMjU0UkB3xzB0ID53EKH93WoIapjAnpDYxah8dOdyfk2cSmkdSe8DFNLeWffi8j3Ea9XeCQnMa\\\/VTcSarspnCKL8RG5LL8vGy\\\/\\\/0Cs6QXQDn\\\/gCTR2McTPbiiks2sFVWCaIIbgkTs9fGFuhM=\",\"description\":\"illo\"}" }, "description": "" }, "response": [] }, { "name": "api\/users\/{user}\/sshkeys\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:user\/sshkeys\/:id", "query": [], "raw": "{{baseUrl}}\/api\/users\/:user\/sshkeys\/:id", "variable": [ { "id": "user", "key": "user", "value": "13", "description": "The ID of the user." }, { "id": "id", "key": "id", "value": "16", "description": "The ID of the SSH key." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "api\/user\/{user}\/twofactor\/enable", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/:user\/twofactor\/enable", "query": [], "raw": "{{baseUrl}}\/api\/user\/:user\/twofactor\/enable", "variable": [ { "id": "user", "key": "user", "value": "1", "description": "The user." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"quasi\"}" }, "description": "" }, "response": [] }, { "name": "api\/user\/{user}\/twofactor\/disable", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/:user\/twofactor\/disable", "query": [], "raw": "{{baseUrl}}\/api\/user\/:user\/twofactor\/disable", "variable": [ { "id": "user", "key": "user", "value": "1", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":\"ok\",\"message\":\"success\"}", "name": "" } ] }, { "name": "POST api\/users\/{user}\/generateSsoToken", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:user\/generateSsoToken", "query": [], "raw": "{{baseUrl}}\/api\/users\/:user\/generateSsoToken", "variable": [ { "id": "user", "key": "user", "value": "3", "description": "The ID of the user." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"endpoint\":\"\\\/servers\",\"validForSeconds\":9}" }, "description": "Generates an one-time login link. Login via: https:\/\/domain.com\/tokenLogin\/$authToken" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"authToken\": \"1e4304d1ff81b3194c288a39e954d1122efc80a5a198ac05a6b9db21409d8223ed4cb44179d075eae08d6941dde2738bcb17\",\n\"validUntil\": 1666430700\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/users", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users", "query": [], "raw": "{{baseUrl}}\/api\/users" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 3,\n\"name\": \"Ellie Mraz\",\n\"email\": \"233592_celine67@example.org\",\n\"two_factor_confirmed\": 0,\n\"created_at\": \"2022-10-21T19:28:24.000000Z\",\n\"root_owner\": 1,\n\"username\": \"keenan.rutherford1929810\",\n\"accountstatus\": \"enabled\",\n\"timezone\": \"Europe\/Berlin\",\n\"datetimeFormat\": \"DD.MM.YYYY HH:mm:ss\",\n\"darkmode\": null,\n\"prefs\": [],\n\"allowedHosts\": [\"10.12.13.10\"],\n\"isSharedAccess\": false,\n\"sharedUserId\": null,\n\"realOrSharedUserId\": 3,\n\"role_id\": 3,\n\"role_name\": \"user \",\n\"root_owner_username\": \"adm\",\n\"lastlogin\": {\n\"date\": \"Never\",\n\"ip\": \"-\"\n},\n\"canCreateSubUsers\": 0,\n\"description\": null,\n\"subUsers\": [],\n\"permissions\": []\n},\n{\n\"id\": 2,\n\"name\": \"Magnus Kessler\",\n\"email\": \"421483_toy.gerhold@example.net\",\n\"two_factor_confirmed\": 0,\n\"created_at\": \"2022-10-21T19:28:24.000000Z\",\n\"root_owner\": 1,\n\"username\": \"fadel.cecil2797368\",\n\"accountstatus\": \"enabled\",\n\"timezone\": \"Europe\/Berlin\",\n\"datetimeFormat\": \"DD.MM.YYYY HH:mm:ss\",\n\"darkmode\": null,\n\"prefs\": [],\n\"allowedHosts\": [],\n\"isSharedAccess\": false,\n\"sharedUserId\": null,\n\"realOrSharedUserId\": 2,\n\"role_id\": 2,\n\"role_name\": \"reseller \",\n\"root_owner_username\": \"adm\",\n\"lastlogin\": {\n\"date\": \"Never\",\n\"ip\": \"-\"\n},\n\"canCreateSubUsers\": 1,\n\"description\": null,\n\"subUsers\": [],\n\"permissions\": []\n},\n{\n\"id\": 1,\n\"name\": \"Viva Botsford\",\n\"email\": \"admin@admin.com\",\n\"two_factor_confirmed\": 0,\n\"created_at\": \"2022-10-21T19:28:24.000000Z\",\n\"root_owner\": 1,\n\"username\": \"adm\",\n\"accountstatus\": \"enabled\",\n\"isParentAccountSuspended\": false,\n\"timezone\": \"Europe\/Berlin\",\n\"datetimeFormat\": \"DD.MM.YYYY HH:mm:ss\",\n\"darkmode\": null,\n\"prefs\": [],\n\"allowedHosts\": [],\n\"isSharedAccess\": false,\n\"sharedUserId\": null,\n\"realOrSharedUserId\": 1,\n\"role_id\": 1,\n\"role_name\": \"admin \",\n\"root_owner_username\": \"adm\",\n\"lastlogin\": {\n\"ip\": \"127.0.0.1\",\n\"date\": \"2022-10-21T19:32:52.000000Z\"\n},\n\"canCreateSubUsers\": 1,\n\"description\": null,\n\"subUsers\": {\n\"1\": 2,\n\"2\": 3,\n\"3\": 4,\n\"4\": 5,\n\"5\": 6,\n\"6\": 7,\n\"7\": 8,\n\"8\": 9,\n\"9\": 10,\n\"10\": 12\n},\n\"permissions\": []\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/users", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users", "query": [], "raw": "{{baseUrl}}\/api\/users" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"iste\",\"email\":\"ismael59@example.org\",\"password\":\"similique\",\"root_owner\":10,\"description\":\"nam\",\"username\":\"zuskpxhvdkxhnytwumiwzhnehokvxqrvqifveopjgfzjrmiriskpczuxlmajdotbnipbctcgnxqzrcwpmgdywkfmvhklmesbcvlqjwcnhhmlfnmnypcaohmomdfngoygyagnsbydmyradyhilvsypjztyovlielivlfdwnughxsklnxknyxwgtipjqobulrrdexsibcprbapnriekmgcjbcccbmdrnyemduvyalhmflehwbufxgzajreawcqxch\",\"role_id\":14,\"accountstatus\":\"disabled\",\"timezone\":\"Asia\\\/Macau\",\"datetimeFormat\":\"nisi\",\"darkmode\":\"0\",\"allowedHosts\":[\"consectetur\"],\"language\":\"qui\"}" }, "description": "" }, "response": [] }, { "name": "api\/users\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:id", "query": [], "raw": "{{baseUrl}}\/api\/users\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"id\": 1,\n\"name\": \"Dr. Eva Flatley\",\n\"email\": \"admin@admin.com\",\n\"two_factor_confirmed\": 0,\n\"created_at\": \"2022-10-20T21:38:15.000000Z\",\n\"root_owner\": 1,\n\"username\": \"adm\",\n\"accountstatus\": \"enabled\",\n\"timezone\": \"Europe\/Berlin\",\n\"datetimeFormat\": \"DD.MM.YYYY HH:mm:ss\",\n\"darkmode\": null,\n\"prefs\": [],\n\"allowedHosts\": [\"10.12.10.13\"],\n\"isSharedAccess\": false,\n\"sharedUserId\": null,\n\"realOrSharedUserId\": 1,\n\"role_id\": 1,\n\"role_name\": \"admin \",\n\"root_owner_username\": \"adm\",\n\"lastlogin\": {\n\"ip\": \"192.168.166.5\",\n\"date\": \"2022-10-20T22:12:21.000000Z\"\n},\n\"canCreateSubUsers\": 1,\n\"description\": null,\n\"subUsers\": {\n\"1\": 2,\n\"2\": 3\n},\n\"roles\": [\n[]\n],\n\"permissions\": [\n\"inventorycomponents.index\",\n\"inventorycomponents.show\",\n\"...\"\n]\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/users\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:id", "query": [], "raw": "{{baseUrl}}\/api\/users\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the user." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"sed\",\"email\":\"tess61@example.com\",\"password\":\"placeat\",\"root_owner\":8,\"description\":\"soluta\",\"username\":\"spwbtxbgipbtdheoyjyjsvamcgtzfyhajlynvsarzhehmekgowoghkwdkmxrzjbmowhfjclwgxrsztnzxcsctyijszwwsyooxzkzanrstbajdpbpramcuuvfappkdktddeifvzfxxspskozogavteorcvka\",\"accountstatus\":\"enabled\",\"role_id\":8,\"timezone\":\"Europe\\\/Budapest\",\"datetimeFormat\":\"ratione\",\"darkmode\":\"1\",\"allowedHosts\":[\"quidem\"],\"language\":\"quaerat\"}" }, "description": "" }, "response": [] }, { "name": "api\/users\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:id", "query": [], "raw": "{{baseUrl}}\/api\/users\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the user." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "api\/users\/{user_id}\/loginhistory", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:user_id\/loginhistory", "query": [], "raw": "{{baseUrl}}\/api\/users\/:user_id\/loginhistory", "variable": [ { "id": "user_id", "key": "user_id", "value": "6", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":[{\"created_at\":\"2025-08-25T15:18:51.000000Z\",\"ip\":\"127.0.0.1\",\"userAgent\":\"Symfony\"},{\"created_at\":\"2025-08-25T15:18:48.000000Z\",\"ip\":\"192.168.174.20\",\"userAgent\":\"Mozilla\\\/5.0 (X11; Linux x86_64) AppleWebKit\\\/537.36 (KHTML, like Gecko) Chrome\\\/106.0.0.0 Safari\\\/537.36\"}],\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/users\/{user_id}\/accesslog", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:user_id\/accesslog", "query": [], "raw": "{{baseUrl}}\/api\/users\/:user_id\/accesslog", "variable": [ { "id": "user_id", "key": "user_id", "value": "9", "description": "The ID of the user." }, { "id": "limit", "key": "limit", "value": "16", "description": "Limit the returned results." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 479,\n\"request\": \"{\\\"tags\\\":[\\\"Internal\\\",\\\"New\\\"]}\",\n\"response\": \"{\\\"result\\\":{\\\"id\\\":61,\\\"hostname\\\":\\\"hostname.com\\\",\\\"...\\\":\\\"...\\\"}\",\n\"endpoint\": \"\/api\/servers\/61\",\n\"method\": \"PUT\",\n\"statuscode\": \"200\",\n\"ip\": \"192.168.174.100\",\n\"userAgent\": \"Mozilla\/5.0 (X11; Linux x86_64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/106.0.0.0 Safari\/537.36\",\n\"created_at\": \"2022-10-20T22:03:55.000000Z\",\n\"requestSource\": \"web\"\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/users\/{user}\/tokens\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:user\/tokens\/:id", "query": [], "raw": "{{baseUrl}}\/api\/users\/:user\/tokens\/:id", "variable": [ { "id": "user", "key": "user", "value": "18", "description": "The ID of the user." }, { "id": "id", "key": "id", "value": "2", "description": "The ID of the token." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"ea\",\"allowedHosts\":[\"10.10.12.10\"]}" }, "description": "" }, "response": [] }, { "name": "POST api\/users\/loginDetails", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/testLoginDetails", "query": [], "raw": "{{baseUrl}}\/api\/user\/testLoginDetails" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"identify\":\"magni\",\"password\":\"quia\",\"two_factor_code\":\"123456\"}" }, "description": "Verify the login details of a user account via the API." }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"result\": \"success\",\n\"twoFactorAuthEnabled\": false,\n\"twoFactorAuthPassed\": null,\n\"userId\": 1\n},\n\"message\": \"success\"\n}", "name": "" } ] } ] }, { "name": "VPS Plans", "description": "\nFeature: https:\/\/documentation.tenantos.com\/Tenantos\/virtualization\/about-virtualization\/", "item": [ { "name": "api\/virtualization\/vpsplans", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/virtualization\/vpsplans", "query": [], "raw": "{{baseUrl}}\/api\/virtualization\/vpsplans" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": [\n{\n\"id\": 1,\n\"created_at\": \"2022-10-21T09:43:54.000000Z\",\n\"updated_at\": \"2022-10-21T09:43:54.000000Z\",\n\"planname\": \"VPS PLAN #1\",\n\"planconfig\": {\n\"bios\": \"seabios\",\n\"display\": \"std\",\n\"machine\": \"pc-i440fx\",\n\"scsi_controller\": \"virtio-scsi-pci\",\n\"qemu_version\": \"6.0\",\n\"os_type\": \"l26\",\n\"ifaces\": {\n\"iface0\": {\n\"network_type\": \"virtio\",\n\"interface\": \"vmbr1\",\n\"subnets\": [\n1\n],\n\"amount_ipv4\": \"1\",\n\"firewall\": true,\n\"ipspoof_filter\": true\n}\n},\n\"disks\": {\n\"disk0\": {\n\"disk_bus\": \"scsi\",\n\"disk_cache\": \"none\",\n\"discard\": 1,\n\"storage\": \"local\",\n\"disk_size\": \"20\",\n\"disk_format\": \"qcow2\"\n}\n},\n\"cpu_type\": \"kvm64\",\n\"cpu_flags\": [\n\"aes\"\n],\n\"cpu_units\": 1024,\n\"memory_ballooning\": 1,\n\"features\": {\n\"enable_console_access\": 1,\n\"enable_power_control\": 1,\n\"auto_sync_hw\": 1\n},\n\"firewall\": {\n\"policy_in\": \"ACCEPT\",\n\"policy_out\": \"ACCEPT\"\n},\n\"agent\": {\n\"pxeAgent\": 1,\n\"pxe_iface\": \"iface0\",\n\"dhcpAgent\": 1\n},\n\"sockets\": \"2\",\n\"cores\": \"4\",\n\"memory\": \"1024\",\n\"memory_min\": \"1024\",\n\"node\": \"host-01\",\n\"startVmid\": \"9000\",\n\"additionalHardware\": {\n\"cdrom\": {\n\"cdrom0\": {\n\"bus\": \"none\"\n}\n}\n},\n\"backup\": {\n\"enabled\": 0,\n\"availableBackupStorages\": [\n\"pbs-01\",\n\"local\"\n],\n\"defaultBackupStorage\": null,\n\"defaultBackupMode\": null,\n\"defaultBackupCompression\": null,\n\"maxBackups\": \"5\"\n},\n\"snapshot\": {\n\"enabled\": false,\n\"maxSnapshots\": null\n}\n},\n\"providerId\": 1,\n\"summary\": {\n\"totalDiskSpace\": 20,\n\"cpucores\": 8,\n\"memory\": \"1024\",\n\"disks\": [\n\"20\"\n],\n\"node\": \"host-01\",\n\"provider\": {\n\"name\": \"proxmox-cluster\",\n\"provider\": \"proxmox\",\n\"id\": 1\n},\n\"virtualization\": \"Proxmox KVM\"\n}\n}\n],\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/virtualization\/vpsplans", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/virtualization\/vpsplans", "query": [], "raw": "{{baseUrl}}\/api\/virtualization\/vpsplans" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"planname\":\"et\",\"planconfig\":[{\"information\":\"See GET api\\\/virtualization\\\/vpsplans\\\/{id} for a list of values - values may differ depending on the virtualization platform\"}],\"providerId\":3}" }, "description": "" }, "response": [] }, { "name": "api\/virtualization\/vpsplans\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/virtualization\/vpsplans\/:id", "query": [], "raw": "{{baseUrl}}\/api\/virtualization\/vpsplans\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the VPS plan." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"id\": 1,\n\"created_at\": \"2022-10-21T09:43:54.000000Z\",\n\"updated_at\": \"2022-10-21T09:43:54.000000Z\",\n\"planname\": \"VPS PLAN #1\",\n\"planconfig\": {\n\"bios\": \"seabios\",\n\"display\": \"std\",\n\"machine\": \"pc-i440fx\",\n\"scsi_controller\": \"virtio-scsi-pci\",\n\"qemu_version\": \"6.0\",\n\"os_type\": \"l26\",\n\"ifaces\": {\n\"iface0\": {\n\"network_type\": \"virtio\",\n\"interface\": \"vmbr1\",\n\"subnets\": [\n1\n],\n\"amount_ipv4\": \"1\",\n\"firewall\": true,\n\"ipspoof_filter\": true\n}\n},\n\"disks\": {\n\"disk0\": {\n\"disk_bus\": \"scsi\",\n\"disk_cache\": \"none\",\n\"discard\": 1,\n\"storage\": \"local\",\n\"disk_size\": \"20\",\n\"disk_format\": \"qcow2\"\n}\n},\n\"cpu_type\": \"kvm64\",\n\"cpu_flags\": [\n\"aes\"\n],\n\"cpu_units\": 1024,\n\"memory_ballooning\": 1,\n\"features\": {\n\"enable_console_access\": 1,\n\"enable_power_control\": 1,\n\"auto_sync_hw\": 1\n},\n\"firewall\": {\n\"policy_in\": \"ACCEPT\",\n\"policy_out\": \"ACCEPT\"\n},\n\"agent\": {\n\"pxeAgent\": 1,\n\"pxe_iface\": \"iface0\",\n\"dhcpAgent\": 1\n},\n\"sockets\": \"2\",\n\"cores\": \"4\",\n\"memory\": \"1024\",\n\"memory_min\": \"1024\",\n\"node\": \"host-01\",\n\"startVmid\": \"9000\"\n},\n\"additionalHardware\": {\n\"cdrom\": {\n\"cdrom0\": {\n\"bus\": \"none\"\n}\n}\n},\n\"backup\": {\n\"enabled\": 0,\n\"availableBackupStorages\": [\n\"pbs-01\",\n\"local\"\n],\n\"defaultBackupStorage\": null,\n\"defaultBackupMode\": null,\n\"defaultBackupCompression\": null,\n\"maxBackups\": \"5\"\n},\n\"snapshot\": {\n\"enabled\": false,\n\"maxSnapshots\": null\n},\n\"providerId\": 1\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/virtualization\/vpsplans\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/virtualization\/vpsplans\/:id", "query": [], "raw": "{{baseUrl}}\/api\/virtualization\/vpsplans\/:id", "variable": [ { "id": "id", "key": "id", "value": "18", "description": "The ID of the VPS plan." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"planname\":\"omnis\",\"planconfig\":[{\"information\":\"See GET api\\\/virtualization\\\/vpsplans\\\/{id} for a list of values - values may differ depending on the virtualization platform\"}],\"providerId\":15}" }, "description": "" }, "response": [] }, { "name": "api\/virtualization\/vpsplans\/{vpsplan}\/duplicate", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/virtualization\/vpsplans\/:vpsplan\/duplicate", "query": [], "raw": "{{baseUrl}}\/api\/virtualization\/vpsplans\/:vpsplan\/duplicate", "variable": [ { "id": "vpsplan", "key": "vpsplan", "value": "1", "description": "The ID of the VPS plan." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n\"result\": {\n\"id\": 211,\n\"created_at\": \"2022-10-21T19:01:52.000000Z\",\n\"updated_at\": \"2022-10-21T19:01:52.000000Z\",\n\"planname\": \"VPS PLAN #1 (Duplicated)\",\n\"planconfig\": {\n\"bios\": \"seabios\",\n\"display\": \"std\",\n\"machine\": \"pc-i440fx\",\n\"scsi_controller\": \"virtio-scsi-pci\",\n\"qemu_version\": \"6.0\",\n\"os_type\": \"l26\",\n\"ifaces\": {\n\"iface0\": {\n\"network_type\": \"virtio\",\n\"interface\": \"vmbr1\",\n\"subnets\": [\n1\n],\n\"amount_ipv4\": \"1\",\n\"firewall\": true,\n\"ipspoof_filter\": true\n}\n},\n\"disks\": {\n\"disk0\": {\n\"disk_bus\": \"scsi\",\n\"disk_cache\": \"none\",\n\"discard\": 1,\n\"storage\": \"local\",\n\"disk_size\": \"20\",\n\"disk_format\": \"qcow2\"\n}\n},\n\"cpu_type\": \"kvm64\",\n\"cpu_flags\": [\n\"aes\"\n],\n\"cpu_units\": 1024,\n\"memory_ballooning\": 1,\n\"features\": {\n\"enable_console_access\": 1,\n\"enable_power_control\": 1,\n\"auto_sync_hw\": 1\n},\n\"firewall\": {\n\"policy_in\": \"ACCEPT\",\n\"policy_out\": \"ACCEPT\"\n},\n\"agent\": {\n\"pxeAgent\": 1,\n\"pxe_iface\": \"iface0\",\n\"dhcpAgent\": 1\n},\n\"sockets\": \"2\",\n\"cores\": \"4\",\n\"memory\": \"1024\",\n\"memory_min\": \"1024\",\n\"node\": \"host03\",\n\"startVmid\": \"9000\"\n},\n\"providerId\": 1\n},\n\"message\": \"success\"\n}", "name": "" } ] }, { "name": "api\/virtualization\/vpsplans\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/virtualization\/vpsplans\/:id", "query": [], "raw": "{{baseUrl}}\/api\/virtualization\/vpsplans\/:id", "variable": [ { "id": "id", "key": "id", "value": "11", "description": "The ID of the VPS plan." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "api\/virtualization\/balancerplans\/testBalancerConfiguration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/virtualization\/balancerplans\/testBalancerConfiguration", "query": [], "raw": "{{baseUrl}}\/api\/virtualization\/balancerplans\/testBalancerConfiguration" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"providerId\":11,\"cpuPriority\":38711,\"cpuRequireIdlePercentage\":52,\"storagePriority\":91940,\"storageReserveFreeAmount\":20,\"ramPriority\":90929,\"ramReserveFreeAmount\":14,\"vmCountPriority\":64617,\"vmMaxAmount\":788215,\"vmMaxAmountPerCore\":15436,\"diskSize\":4,\"ramSize\":19,\"nodeMustMatchRegex\":\"\\\/^node[0-9]+$\\\/\",\"nodeMustNotMatchRegex\":\"\\\/^gluster[0-9]+$\\\/\",\"storages\":[{\"backendStorageName\":\"local\",\"diskSize\":11}]}" }, "description": "" }, "response": [] }, { "name": "api\/virtualization\/balancerplans", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/virtualization\/balancerplans", "query": [], "raw": "{{baseUrl}}\/api\/virtualization\/balancerplans" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":[{\"id\":1,\"created_at\":\"2025-08-25T15:18:51.000000Z\",\"updated_at\":\"2025-08-25T15:18:51.000000Z\",\"planname\":\"Balancer #1\",\"cpuPriority\":2,\"cpuRequireIdlePercentage\":30,\"storagePriority\":1,\"storageReserveFreeAmount\":20,\"ramPriority\":1.5,\"ramReserveFreeAmount\":10,\"vmCountPriority\":1,\"vmMaxAmount\":50,\"nodeMustMatchRegex\":\"\\\/^node[0-9]+$\\\/\",\"nodeMustNotMatchRegex\":\"\\\/^gluster[0-9]+$\\\/\",\"vmMaxAmountPerCore\":null}],\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/virtualization\/balancerplans", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/virtualization\/balancerplans", "query": [], "raw": "{{baseUrl}}\/api\/virtualization\/balancerplans" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"planname\":\"aqcexvwfrgerkyajqjkodwvosabtrihnrgjwahiztwmqnqmkultnxxwckrcxmskkcicmtmkewgkhxvssblqpeyrtttowepxdefkkvhztdbpnoovwvfhsqdhvpxmzkv\",\"cpuPriority\":33401,\"cpuRequireIdlePercentage\":42,\"storagePriority\":17793,\"storageReserveFreeAmount\":1,\"ramPriority\":2739,\"ramReserveFreeAmount\":16,\"vmCountPriority\":23647,\"vmMaxAmount\":800077,\"vmMaxAmountPerCore\":22710,\"nodeMustMatchRegex\":\"\\\/^node[0-9]+$\\\/\",\"nodeMustNotMatchRegex\":\"\\\/^gluster[0-9]+$\\\/\"}" }, "description": "" }, "response": [] }, { "name": "api\/virtualization\/balancerplans\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/virtualization\/balancerplans\/:id", "query": [], "raw": "{{baseUrl}}\/api\/virtualization\/balancerplans\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the VPS balancer plan." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "referrer-policy", "value": "no-referrer" }, { "key": "x-xss-protection", "value": "1; mode=block" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"result\":{\"id\":1,\"created_at\":\"2025-08-25T15:18:51.000000Z\",\"updated_at\":\"2025-08-25T15:18:51.000000Z\",\"planname\":\"Balancer #1\",\"cpuPriority\":2,\"cpuRequireIdlePercentage\":30,\"storagePriority\":1,\"storageReserveFreeAmount\":20,\"ramPriority\":1.5,\"ramReserveFreeAmount\":10,\"vmCountPriority\":1,\"vmMaxAmount\":50,\"nodeMustMatchRegex\":\"\\\/^node[0-9]+$\\\/\",\"nodeMustNotMatchRegex\":\"\\\/^gluster[0-9]+$\\\/\",\"vmMaxAmountPerCore\":null},\"message\":\"success\"}", "name": "" } ] }, { "name": "api\/virtualization\/balancerplans\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/virtualization\/balancerplans\/:id", "query": [], "raw": "{{baseUrl}}\/api\/virtualization\/balancerplans\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the VPS balancer plan." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"planname\":\"dgbnueceljwnmbmenrtckzzxguweoiqjlenvtimalolhqfcmqgkdmraeqkwrzppsloqbludqnyheziqymllwlvdevyrejnkteiazsrgmkxjcnylqkotgxs\",\"cpuPriority\":86490,\"cpuRequireIdlePercentage\":97,\"storagePriority\":94664,\"storageReserveFreeAmount\":16,\"ramPriority\":70052,\"ramReserveFreeAmount\":5,\"vmCountPriority\":22512,\"vmMaxAmount\":800937,\"vmMaxAmountPerCore\":11417,\"nodeMustMatchRegex\":\"\\\/^node[0-9]+$\\\/\",\"nodeMustNotMatchRegex\":\"\\\/^gluster[0-9]+$\\\/\"}" }, "description": "" }, "response": [] }, { "name": "api\/virtualization\/balancerplans\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/virtualization\/balancerplans\/:id", "query": [], "raw": "{{baseUrl}}\/api\/virtualization\/balancerplans\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the VPS balancer plan." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] } ], "auth": { "type": "bearer" } }