{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/your-easydcim.com" } ], "info": { "name": "EasyDCIM APIv3 Documentation", "_postman_id": "3807534a-6b74-4295-95f8-6a0fc58898d6", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Admin Endpoints", "description": "", "item": [ { "name": "System", "description": "", "item": [ { "name": "Get Client Area Configuration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/client-area\/config", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/client-area\/config" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns current Client Area connection settings.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status\": \"success\",\n \"message\": \"success\",\n \"data\": {\n \"mode\": \"local\",\n \"is_enabled\": true,\n \"full_url\": \"https:\/\/your-easydcim.com\/client\",\n \"company_name\": \"EasyDCIM\",\n \"branding\": {\n \"colors_primary\": {\n \"50\": \"#EBF5FF\",\n \"100\": \"#E1EFFE\",\n \"200\": \"#C3DDFD\",\n \"300\": \"#A4CAFE\",\n \"400\": \"#83B3F7\",\n \"500\": \"#6BA5F5\",\n \"600\": \"#5396F4\",\n \"700\": \"#3A87F2\",\n \"800\": \"#1A73EF\",\n \"900\": \"#0E60D2\"\n },\n \"logo_url\": \"logo.png\",\n \"favicon_url\": \"favicon.ico\",\n \"custom_css\": \"\",\n \"custom_js_header\": \"\",\n \"custom_js_footer\": \"\"\n },\n \"visibility\": {\n \"services_table\": {\n \"column_type\": true,\n \"column_ip\": true,\n \"column_status\": true,\n \"column_location\": true,\n \"column_created_at\": true\n },\n \"my_account\": {\n \"two_factor_auth\": true\n },\n \"navigation\": {\n \"iso_images\": true,\n \"ssh_keys\": true\n }\n },\n \"default_client_area_language\": \"en\",\n \"languages\": {\n \"en\": \"English\",\n \"de\": \"German\",\n \"es\": \"Spanish\"\n },\n \"timezones\": {\n \"\": \"Select something...\",\n \"0\": \"Africa\/Abidjan\",\n \"1\": \"Africa\/Accra\",\n \"2\": \"Africa\/Addis_Ababa\",\n \"3\": \"Africa\/Algiers\",\n \"4\": \"Africa\/Asmara\",\n \"5\": \"Africa\/Bamako\",\n \"6\": \"Africa\/Bangui\",\n \"7\": \"Africa\/Banjul\",\n \"8\": \"Africa\/Bissau\",\n \"9\": \"Africa\/Blantyre\",\n \"10\": \"Africa\/Brazzaville\",\n \"11\": \"Africa\/Bujumbura\",\n \"12\": \"Africa\/Cairo\",\n \"13\": \"Africa\/Casablanca\",\n \"14\": \"Africa\/Ceuta\",\n \"15\": \"Africa\/Conakry\",\n \"16\": \"Africa\/Dakar\",\n \"17\": \"Africa\/Dar_es_Salaam\",\n \"18\": \"Africa\/Djibouti\",\n \"19\": \"Africa\/Douala\",\n \"20\": \"Africa\/El_Aaiun\",\n \"21\": \"Africa\/Freetown\",\n \"22\": \"Africa\/Gaborone\",\n \"23\": \"Africa\/Harare\",\n \"24\": \"Africa\/Johannesburg\",\n \"25\": \"Africa\/Juba\",\n \"26\": \"Africa\/Kampala\",\n \"27\": \"Africa\/Khartoum\",\n \"28\": \"Africa\/Kigali\",\n \"29\": \"Africa\/Kinshasa\",\n \"30\": \"Africa\/Lagos\",\n \"31\": \"Africa\/Libreville\",\n \"32\": \"Africa\/Lome\",\n \"33\": \"Africa\/Luanda\",\n \"34\": \"Africa\/Lubumbashi\",\n \"35\": \"Africa\/Lusaka\",\n \"36\": \"Africa\/Malabo\",\n \"37\": \"Africa\/Maputo\",\n \"38\": \"Africa\/Maseru\",\n \"39\": \"Africa\/Mbabane\",\n \"40\": \"Africa\/Mogadishu\",\n \"41\": \"Africa\/Monrovia\",\n \"42\": \"Africa\/Nairobi\",\n \"43\": \"Africa\/Ndjamena\",\n \"44\": \"Africa\/Niamey\",\n \"45\": \"Africa\/Nouakchott\",\n \"46\": \"Africa\/Ouagadougou\",\n \"47\": \"Africa\/Porto-Novo\",\n \"48\": \"Africa\/Sao_Tome\",\n \"49\": \"Africa\/Tripoli\",\n \"50\": \"Africa\/Tunis\",\n \"51\": \"Africa\/Windhoek\",\n \"52\": \"America\/Adak\",\n \"53\": \"America\/Anchorage\",\n \"54\": \"America\/Anguilla\",\n \"55\": \"America\/Antigua\",\n \"56\": \"America\/Araguaina\",\n \"57\": \"America\/Argentina\/Buenos_Aires\",\n \"58\": \"America\/Argentina\/Catamarca\",\n \"59\": \"America\/Argentina\/Cordoba\",\n \"60\": \"America\/Argentina\/Jujuy\",\n \"61\": \"America\/Argentina\/La_Rioja\",\n \"62\": \"America\/Argentina\/Mendoza\",\n \"63\": \"America\/Argentina\/Rio_Gallegos\",\n \"64\": \"America\/Argentina\/Salta\",\n \"65\": \"America\/Argentina\/San_Juan\",\n \"66\": \"America\/Argentina\/San_Luis\",\n \"67\": \"America\/Argentina\/Tucuman\",\n \"68\": \"America\/Argentina\/Ushuaia\",\n \"69\": \"America\/Aruba\",\n \"70\": \"America\/Asuncion\",\n \"71\": \"America\/Atikokan\",\n \"72\": \"America\/Bahia\",\n \"73\": \"America\/Bahia_Banderas\",\n \"74\": \"America\/Barbados\",\n \"75\": \"America\/Belem\",\n \"76\": \"America\/Belize\",\n \"77\": \"America\/Blanc-Sablon\",\n \"78\": \"America\/Boa_Vista\",\n \"79\": \"America\/Bogota\",\n \"80\": \"America\/Boise\",\n \"81\": \"America\/Cambridge_Bay\",\n \"82\": \"America\/Campo_Grande\",\n \"83\": \"America\/Cancun\",\n \"84\": \"America\/Caracas\",\n \"85\": \"America\/Cayenne\",\n \"86\": \"America\/Cayman\",\n \"87\": \"America\/Chicago\",\n \"88\": \"America\/Chihuahua\",\n \"89\": \"America\/Ciudad_Juarez\",\n \"90\": \"America\/Costa_Rica\",\n \"91\": \"America\/Creston\",\n \"92\": \"America\/Cuiaba\",\n \"93\": \"America\/Curacao\",\n \"94\": \"America\/Danmarkshavn\",\n \"95\": \"America\/Dawson\",\n \"96\": \"America\/Dawson_Creek\",\n \"97\": \"America\/Denver\",\n \"98\": \"America\/Detroit\",\n \"99\": \"America\/Dominica\",\n \"100\": \"America\/Edmonton\",\n \"101\": \"America\/Eirunepe\",\n \"102\": \"America\/El_Salvador\",\n \"103\": \"America\/Fort_Nelson\",\n \"104\": \"America\/Fortaleza\",\n \"105\": \"America\/Glace_Bay\",\n \"106\": \"America\/Goose_Bay\",\n \"107\": \"America\/Grand_Turk\",\n \"108\": \"America\/Grenada\",\n \"109\": \"America\/Guadeloupe\",\n \"110\": \"America\/Guatemala\",\n \"111\": \"America\/Guayaquil\",\n \"112\": \"America\/Guyana\",\n \"113\": \"America\/Halifax\",\n \"114\": \"America\/Havana\",\n \"115\": \"America\/Hermosillo\",\n \"116\": \"America\/Indiana\/Indianapolis\",\n \"117\": \"America\/Indiana\/Knox\",\n \"118\": \"America\/Indiana\/Marengo\",\n \"119\": \"America\/Indiana\/Petersburg\",\n \"120\": \"America\/Indiana\/Tell_City\",\n \"121\": \"America\/Indiana\/Vevay\",\n \"122\": \"America\/Indiana\/Vincennes\",\n \"123\": \"America\/Indiana\/Winamac\",\n \"124\": \"America\/Inuvik\",\n \"125\": \"America\/Iqaluit\",\n \"126\": \"America\/Jamaica\",\n \"127\": \"America\/Juneau\",\n \"128\": \"America\/Kentucky\/Louisville\",\n \"129\": \"America\/Kentucky\/Monticello\",\n \"130\": \"America\/Kralendijk\",\n \"131\": \"America\/La_Paz\",\n \"132\": \"America\/Lima\",\n \"133\": \"America\/Los_Angeles\",\n \"134\": \"America\/Lower_Princes\",\n \"135\": \"America\/Maceio\",\n \"136\": \"America\/Managua\",\n \"137\": \"America\/Manaus\",\n \"138\": \"America\/Marigot\",\n \"139\": \"America\/Martinique\",\n \"140\": \"America\/Matamoros\",\n \"141\": \"America\/Mazatlan\",\n \"142\": \"America\/Menominee\",\n \"143\": \"America\/Merida\",\n \"144\": \"America\/Metlakatla\",\n \"145\": \"America\/Mexico_City\",\n \"146\": \"America\/Miquelon\",\n \"147\": \"America\/Moncton\",\n \"148\": \"America\/Monterrey\",\n \"149\": \"America\/Montevideo\",\n \"150\": \"America\/Montserrat\",\n \"151\": \"America\/Nassau\",\n \"152\": \"America\/New_York\",\n \"153\": \"America\/Nome\",\n \"154\": \"America\/Noronha\",\n \"155\": \"America\/North_Dakota\/Beulah\",\n \"156\": \"America\/North_Dakota\/Center\",\n \"157\": \"America\/North_Dakota\/New_Salem\",\n \"158\": \"America\/Nuuk\",\n \"159\": \"America\/Ojinaga\",\n \"160\": \"America\/Panama\",\n \"161\": \"America\/Paramaribo\",\n \"162\": \"America\/Phoenix\",\n \"163\": \"America\/Port-au-Prince\",\n \"164\": \"America\/Port_of_Spain\",\n \"165\": \"America\/Porto_Velho\",\n \"166\": \"America\/Puerto_Rico\",\n \"167\": \"America\/Punta_Arenas\",\n \"168\": \"America\/Rankin_Inlet\",\n \"169\": \"America\/Recife\",\n \"170\": \"America\/Regina\",\n \"171\": \"America\/Resolute\",\n \"172\": \"America\/Rio_Branco\",\n \"173\": \"America\/Santarem\",\n \"174\": \"America\/Santiago\",\n \"175\": \"America\/Santo_Domingo\",\n \"176\": \"America\/Sao_Paulo\",\n \"177\": \"America\/Scoresbysund\",\n \"178\": \"America\/Sitka\",\n \"179\": \"America\/St_Barthelemy\",\n \"180\": \"America\/St_Johns\",\n \"181\": \"America\/St_Kitts\",\n \"182\": \"America\/St_Lucia\",\n \"183\": \"America\/St_Thomas\",\n \"184\": \"America\/St_Vincent\",\n \"185\": \"America\/Swift_Current\",\n \"186\": \"America\/Tegucigalpa\",\n \"187\": \"America\/Thule\",\n \"188\": \"America\/Tijuana\",\n \"189\": \"America\/Toronto\",\n \"190\": \"America\/Tortola\",\n \"191\": \"America\/Vancouver\",\n \"192\": \"America\/Whitehorse\",\n \"193\": \"America\/Winnipeg\",\n \"194\": \"America\/Yakutat\",\n \"195\": \"Antarctica\/Casey\",\n \"196\": \"Antarctica\/Davis\",\n \"197\": \"Antarctica\/DumontDUrville\",\n \"198\": \"Antarctica\/Macquarie\",\n \"199\": \"Antarctica\/Mawson\",\n \"200\": \"Antarctica\/McMurdo\",\n \"201\": \"Antarctica\/Palmer\",\n \"202\": \"Antarctica\/Rothera\",\n \"203\": \"Antarctica\/Syowa\",\n \"204\": \"Antarctica\/Troll\",\n \"205\": \"Antarctica\/Vostok\",\n \"206\": \"Arctic\/Longyearbyen\",\n \"207\": \"Asia\/Aden\",\n \"208\": \"Asia\/Almaty\",\n \"209\": \"Asia\/Amman\",\n \"210\": \"Asia\/Anadyr\",\n \"211\": \"Asia\/Aqtau\",\n \"212\": \"Asia\/Aqtobe\",\n \"213\": \"Asia\/Ashgabat\",\n \"214\": \"Asia\/Atyrau\",\n \"215\": \"Asia\/Baghdad\",\n \"216\": \"Asia\/Bahrain\",\n \"217\": \"Asia\/Baku\",\n \"218\": \"Asia\/Bangkok\",\n \"219\": \"Asia\/Barnaul\",\n \"220\": \"Asia\/Beirut\",\n \"221\": \"Asia\/Bishkek\",\n \"222\": \"Asia\/Brunei\",\n \"223\": \"Asia\/Chita\",\n \"224\": \"Asia\/Colombo\",\n \"225\": \"Asia\/Damascus\",\n \"226\": \"Asia\/Dhaka\",\n \"227\": \"Asia\/Dili\",\n \"228\": \"Asia\/Dubai\",\n \"229\": \"Asia\/Dushanbe\",\n \"230\": \"Asia\/Famagusta\",\n \"231\": \"Asia\/Gaza\",\n \"232\": \"Asia\/Hebron\",\n \"233\": \"Asia\/Ho_Chi_Minh\",\n \"234\": \"Asia\/Hong_Kong\",\n \"235\": \"Asia\/Hovd\",\n \"236\": \"Asia\/Irkutsk\",\n \"237\": \"Asia\/Jakarta\",\n \"238\": \"Asia\/Jayapura\",\n \"239\": \"Asia\/Jerusalem\",\n \"240\": \"Asia\/Kabul\",\n \"241\": \"Asia\/Kamchatka\",\n \"242\": \"Asia\/Karachi\",\n \"243\": \"Asia\/Kathmandu\",\n \"244\": \"Asia\/Khandyga\",\n \"245\": \"Asia\/Kolkata\",\n \"246\": \"Asia\/Krasnoyarsk\",\n \"247\": \"Asia\/Kuala_Lumpur\",\n \"248\": \"Asia\/Kuching\",\n \"249\": \"Asia\/Kuwait\",\n \"250\": \"Asia\/Macau\",\n \"251\": \"Asia\/Magadan\",\n \"252\": \"Asia\/Makassar\",\n \"253\": \"Asia\/Manila\",\n \"254\": \"Asia\/Muscat\",\n \"255\": \"Asia\/Nicosia\",\n \"256\": \"Asia\/Novokuznetsk\",\n \"257\": \"Asia\/Novosibirsk\",\n \"258\": \"Asia\/Omsk\",\n \"259\": \"Asia\/Oral\",\n \"260\": \"Asia\/Phnom_Penh\",\n \"261\": \"Asia\/Pontianak\",\n \"262\": \"Asia\/Pyongyang\",\n \"263\": \"Asia\/Qatar\",\n \"264\": \"Asia\/Qostanay\",\n \"265\": \"Asia\/Qyzylorda\",\n \"266\": \"Asia\/Riyadh\",\n \"267\": \"Asia\/Sakhalin\",\n \"268\": \"Asia\/Samarkand\",\n \"269\": \"Asia\/Seoul\",\n \"270\": \"Asia\/Shanghai\",\n \"271\": \"Asia\/Singapore\",\n \"272\": \"Asia\/Srednekolymsk\",\n \"273\": \"Asia\/Taipei\",\n \"274\": \"Asia\/Tashkent\",\n \"275\": \"Asia\/Tbilisi\",\n \"276\": \"Asia\/Tehran\",\n \"277\": \"Asia\/Thimphu\",\n \"278\": \"Asia\/Tokyo\",\n \"279\": \"Asia\/Tomsk\",\n \"280\": \"Asia\/Ulaanbaatar\",\n \"281\": \"Asia\/Urumqi\",\n \"282\": \"Asia\/Ust-Nera\",\n \"283\": \"Asia\/Vientiane\",\n \"284\": \"Asia\/Vladivostok\",\n \"285\": \"Asia\/Yakutsk\",\n \"286\": \"Asia\/Yangon\",\n \"287\": \"Asia\/Yekaterinburg\",\n \"288\": \"Asia\/Yerevan\",\n \"289\": \"Atlantic\/Azores\",\n \"290\": \"Atlantic\/Bermuda\",\n \"291\": \"Atlantic\/Canary\",\n \"292\": \"Atlantic\/Cape_Verde\",\n \"293\": \"Atlantic\/Faroe\",\n \"294\": \"Atlantic\/Madeira\",\n \"295\": \"Atlantic\/Reykjavik\",\n \"296\": \"Atlantic\/South_Georgia\",\n \"297\": \"Atlantic\/St_Helena\",\n \"298\": \"Atlantic\/Stanley\",\n \"299\": \"Australia\/Adelaide\",\n \"300\": \"Australia\/Brisbane\",\n \"301\": \"Australia\/Broken_Hill\",\n \"302\": \"Australia\/Darwin\",\n \"303\": \"Australia\/Eucla\",\n \"304\": \"Australia\/Hobart\",\n \"305\": \"Australia\/Lindeman\",\n \"306\": \"Australia\/Lord_Howe\",\n \"307\": \"Australia\/Melbourne\",\n \"308\": \"Australia\/Perth\",\n \"309\": \"Australia\/Sydney\",\n \"310\": \"Europe\/Amsterdam\",\n \"311\": \"Europe\/Andorra\",\n \"312\": \"Europe\/Astrakhan\",\n \"313\": \"Europe\/Athens\",\n \"314\": \"Europe\/Belgrade\",\n \"315\": \"Europe\/Berlin\",\n \"316\": \"Europe\/Bratislava\",\n \"317\": \"Europe\/Brussels\",\n \"318\": \"Europe\/Bucharest\",\n \"319\": \"Europe\/Budapest\",\n \"320\": \"Europe\/Busingen\",\n \"321\": \"Europe\/Chisinau\",\n \"322\": \"Europe\/Copenhagen\",\n \"323\": \"Europe\/Dublin\",\n \"324\": \"Europe\/Gibraltar\",\n \"325\": \"Europe\/Guernsey\",\n \"326\": \"Europe\/Helsinki\",\n \"327\": \"Europe\/Isle_of_Man\",\n \"328\": \"Europe\/Istanbul\",\n \"329\": \"Europe\/Jersey\",\n \"330\": \"Europe\/Kaliningrad\",\n \"331\": \"Europe\/Kirov\",\n \"332\": \"Europe\/Kyiv\",\n \"333\": \"Europe\/Lisbon\",\n \"334\": \"Europe\/Ljubljana\",\n \"335\": \"Europe\/London\",\n \"336\": \"Europe\/Luxembourg\",\n \"337\": \"Europe\/Madrid\",\n \"338\": \"Europe\/Malta\",\n \"339\": \"Europe\/Mariehamn\",\n \"340\": \"Europe\/Minsk\",\n \"341\": \"Europe\/Monaco\",\n \"342\": \"Europe\/Moscow\",\n \"343\": \"Europe\/Oslo\",\n \"344\": \"Europe\/Paris\",\n \"345\": \"Europe\/Podgorica\",\n \"346\": \"Europe\/Prague\",\n \"347\": \"Europe\/Riga\",\n \"348\": \"Europe\/Rome\",\n \"349\": \"Europe\/Samara\",\n \"350\": \"Europe\/San_Marino\",\n \"351\": \"Europe\/Sarajevo\",\n \"352\": \"Europe\/Saratov\",\n \"353\": \"Europe\/Simferopol\",\n \"354\": \"Europe\/Skopje\",\n \"355\": \"Europe\/Sofia\",\n \"356\": \"Europe\/Stockholm\",\n \"357\": \"Europe\/Tallinn\",\n \"358\": \"Europe\/Tirane\",\n \"359\": \"Europe\/Ulyanovsk\",\n \"360\": \"Europe\/Vaduz\",\n \"361\": \"Europe\/Vatican\",\n \"362\": \"Europe\/Vienna\",\n \"363\": \"Europe\/Vilnius\",\n \"364\": \"Europe\/Volgograd\",\n \"365\": \"Europe\/Warsaw\",\n \"366\": \"Europe\/Zagreb\",\n \"367\": \"Europe\/Zurich\",\n \"368\": \"Indian\/Antananarivo\",\n \"369\": \"Indian\/Chagos\",\n \"370\": \"Indian\/Christmas\",\n \"371\": \"Indian\/Cocos\",\n \"372\": \"Indian\/Comoro\",\n \"373\": \"Indian\/Kerguelen\",\n \"374\": \"Indian\/Mahe\",\n \"375\": \"Indian\/Maldives\",\n \"376\": \"Indian\/Mauritius\",\n \"377\": \"Indian\/Mayotte\",\n \"378\": \"Indian\/Reunion\",\n \"379\": \"Pacific\/Apia\",\n \"380\": \"Pacific\/Auckland\",\n \"381\": \"Pacific\/Bougainville\",\n \"382\": \"Pacific\/Chatham\",\n \"383\": \"Pacific\/Chuuk\",\n \"384\": \"Pacific\/Easter\",\n \"385\": \"Pacific\/Efate\",\n \"386\": \"Pacific\/Fakaofo\",\n \"387\": \"Pacific\/Fiji\",\n \"388\": \"Pacific\/Funafuti\",\n \"389\": \"Pacific\/Galapagos\",\n \"390\": \"Pacific\/Gambier\",\n \"391\": \"Pacific\/Guadalcanal\",\n \"392\": \"Pacific\/Guam\",\n \"393\": \"Pacific\/Honolulu\",\n \"394\": \"Pacific\/Kanton\",\n \"395\": \"Pacific\/Kiritimati\",\n \"396\": \"Pacific\/Kosrae\",\n \"397\": \"Pacific\/Kwajalein\",\n \"398\": \"Pacific\/Majuro\",\n \"399\": \"Pacific\/Marquesas\",\n \"400\": \"Pacific\/Midway\",\n \"401\": \"Pacific\/Nauru\",\n \"402\": \"Pacific\/Niue\",\n \"403\": \"Pacific\/Norfolk\",\n \"404\": \"Pacific\/Noumea\",\n \"405\": \"Pacific\/Pago_Pago\",\n \"406\": \"Pacific\/Palau\",\n \"407\": \"Pacific\/Pitcairn\",\n \"408\": \"Pacific\/Pohnpei\",\n \"409\": \"Pacific\/Port_Moresby\",\n \"410\": \"Pacific\/Rarotonga\",\n \"411\": \"Pacific\/Saipan\",\n \"412\": \"Pacific\/Tahiti\",\n \"413\": \"Pacific\/Tarawa\",\n \"414\": \"Pacific\/Tongatapu\",\n \"415\": \"Pacific\/Wake\",\n \"416\": \"Pacific\/Wallis\",\n \"417\": \"UTC\"\n }\n }\n}", "name": "" } ] }, { "name": "Update Client Area Configuration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/client-area\/config", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/client-area\/config" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"mode\":\"external\",\"full_url\":\"https:\\\/\\\/client.example.com\",\"is_enabled\":true,\"branding\":{\"colors_primary\":{\"500\":\"#6BA5F5\",\"700\":\"#3A87F2\",\"900\":\"#0E60D2\"},\"logo_url\":\"data:image\\\/svg+xml;base64,PHN2ZyB3aWR0aD0i...\",\"logo_dark_url\":\"data:image\\\/svg+xml;base64,PHN2ZyB3aWR0aD0i...\",\"favicon_url\":\"data:image\\\/png;base64,iVBORw0K...\",\"custom_css\":\"body { background: #f4f4f4; }\",\"custom_js_header\":\"console.log('Header loaded');\",\"custom_js_footer\":\"console.log('Footer loaded');\"},\"visibility\":{\"services_table\":{\"column_type\":true,\"column_ip\":false,\"column_status\":true,\"column_location\":false,\"column_created_at\":true,\"column_model\":true},\"my_account\":{\"two_factor_auth\":true},\"navigation\":{\"iso_images\":true,\"ssh_keys\":false}}}" }, "description": "Updates the Client Area connection and branding settings." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Get System Configuration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/system\/config", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/system\/config" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns current system configuration for admin area." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"appearance\":{\"table_view\":\"default\",\"graphs_driver\":\"Components\\\\Libs\\\\Graphs\\\\Drivers\\\\ChartJSDriver\",\"custom_backend_css\":\"\",\"email_footer\":\"\",\"email_css\":\"\"},\"company\":{\"name\":\"EasyDCIM\",\"email\":\"admin_email@gmail.com\"},\"license\":{\"license_key\":\"license_key\",\"license_status\":\"Active\",\"devices_limit\":120,\"valid_domain\":\"easydcim_hostname\",\"current_devices\":68},\"localization\":{\"timezone\":\"365\",\"admin_language\":\"en\",\"default_client_language\":\"en\",\"available_languages\":{\"backend\":{\"en\":\"English\"},\"client\":{\"en\":\"English\",\"de\":\"German\",\"es\":\"Spanish\"}}},\"meta\":{\"app_version\":\"1.23\",\"php_version\":\"8.3.25\"},\"modules\":{\"os\":{\"0\":\"OSInstallation\",\"1\":\"OS Installation\",\"version\":\"2.1.0\"},\"ipmi\":{\"0\":\"IpmiIntegration\",\"1\":\"IPMI Integration\",\"version\":\"1.5.5\"},\"ip-manager\":{\"0\":\"IPManager\",\"1\":\"IP Address Management\",\"version\":\"1.8.5\"},\"advanced-monitoring\":{\"0\":\"AdvancedMonitoring\",\"1\":\"Advanced Monitoring\",\"version\":\"1.1.1\"},\"dns-manager\":{\"0\":\"DNSManager\",\"1\":\"DNS Management\",\"version\":\"1.4.2\"},\"pdu-manager\":{\"0\":\"PDUManager\",\"1\":\"PDU Management\",\"version\":\"1.2.7\"},\"password-manager\":{\"0\":\"PasswordManager\",\"1\":\"Password Management\",\"version\":\"1.1\"},\"ldap\":{\"0\":\"LDAPAuthentication\",\"1\":\"LDAP Authentication\",\"version\":\"1.0.0\"},\"two-factor-auth\":{\"0\":\"TwoFactorAuth\",\"1\":\"Two-Factor Authentication\",\"version\":\"1.2.0\"},\"usage-collector\":{\"0\":\"UsageCollector\",\"1\":\"Usage Collector\",\"version\":\"1.3.5\"},\"switches-manager\":{\"0\":\"SwitchesManager\",\"1\":\"Switch Management\",\"version\":\"1.4.3\"}},\"system\":{\"debug_mode\":false,\"ssh_port\":22,\"allowed_ips\":[],\"allowed_api_ips\":[]},\"urls\":{\"base\":\"https:\/\/your-easydcim.com\"}}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Health Check", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/system\/health-check", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/system\/health-check" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Performs a full system health check, verifying core components:\nRedis, database, queue, web server (Apache), and remote agents." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"database\":{\"status\":\"success\",\"driver\":\"mariadb\",\"database\":\"db_name\",\"version\":\"10.11.14-MariaDB-0+deb12u2\",\"host\":\"127.0.0.1\",\"port\":\"db_port\",\"query_time_ms\":0.85,\"size_mb\":\"225.98\",\"message\":\"Successfully connected to database \\\"db_name\\\".\"},\"apache2\":{\"status\":\"success\",\"server_url\":\"https:\/\/your-easydcim.com\",\"http_code\":200},\"redis\":{\"status\":\"success\",\"data\":{\"data\":{\"status\":\"success\",\"host\":\"127.0.0.1\",\"port\":\"redis_port\",\"version\":\"7.0.15\",\"uptime\":1218174,\"memory\":\"789.13M\"},\"cache\":{\"status\":\"success\",\"host\":\"127.0.0.1\",\"port\":\"redis_port\",\"version\":\"7.0.15\",\"uptime\":1218174,\"memory\":\"1.68M\"}}},\"queue\":{\"status\":\"success\",\"queues\":[{\"Name\":\"name\",\"PID\":\"pid\",\"Status\":\"running\",\"Workers\":\"worker_name\",\"Balancing\":\"auto\"}]},\"agents\":[{\"id\":1,\"name\":\"Local\",\"status\":\"success\",\"database\":{\"status\":\"success\",\"message\":\"Successfully connected to the DB: agent_db_name\"},\"queue\":{\"status\":\"success\",\"queues\":[{\"Name\":\"name\",\"PID\":\"pid\",\"Status\":\"running\",\"Workers\":\"worker_name\",\"Balancing\":\"auto\"}]},\"sshConnection\":{\"status\":\"success\"}}]}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "Locations", "description": "", "item": [ { "name": "List Locations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/locations", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, name, city, state.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, name, city, state.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/locations?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of locations" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":3009,\"app_id\":null,\"name\":\"Lueilwitz, Upton and Jerde\",\"address\":\"880 Mann Shoal\\nAndersonstad, FL 82814\",\"city\":\"South Henry\",\"state\":\"Maryland\",\"description\":\"Nemo sequi nesciunt ipsa ab laudantium. Praesentium illum minus quisquam perferendis omnis ut in. Enim et id tempora corporis.\",\"notes\":\"Ut ut et dolor consequuntur qui est blanditiis saepe. Unde et eligendi et nam. Ex dolorem perspiciatis voluptatem et et quis laboriosam. Sed repellendus culpa voluptas maiores.\",\"emergency\":\"0\",\"phone\":\"254-895-0006\",\"flag\":\"USA.png\",\"created_at\":\"2026-07-10 09:50:04\",\"updated_at\":\"2026-07-10 09:50:04\"},{\"id\":3010,\"app_id\":null,\"name\":\"Haley PLC\",\"address\":\"6217 Bednar Flats Suite 567\\nKeeblershire, CA 13072-1184\",\"city\":\"North Nola\",\"state\":\"Virginia\",\"description\":\"Est doloribus nihil illum eum cum. Dolorem cum laboriosam error accusantium est et laborum fuga. Omnis atque tempora natus dolores omnis.\",\"notes\":\"Tempora maiores iure reiciendis necessitatibus. Consectetur est dolorem voluptatum ratione voluptas quia voluptatem. Unde qui provident atque.\",\"emergency\":\"1\",\"phone\":\"+1 (562) 724-1464\",\"flag\":\"Canada.png\",\"created_at\":\"2026-07-10 09:50:04\",\"updated_at\":\"2026-07-10 09:50:04\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/locations?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/locations\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show location", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/locations\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/locations\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the location." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Display detailed information about a single location by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":3011,\"app_id\":null,\"name\":\"Schuster, Bahringer and Altenwerth\",\"address\":\"62798 Cecelia Flat Suite 287\\nLittlefurt, NC 42564\",\"city\":\"East Dustin\",\"state\":\"Arizona\",\"description\":\"Neque illo qui aliquam. Et corrupti similique eum quo id soluta. Impedit explicabo impedit facilis a explicabo sunt.\",\"notes\":\"Officia sed tempora et aliquid harum blanditiis omnis accusamus. Accusamus dolor officia optio voluptas exercitationem voluptatem. Dolor corporis illo aliquid id excepturi dolor.\",\"emergency\":\"1\",\"phone\":\"+1.540.238.5157\",\"flag\":\"Canada.png\",\"created_at\":\"2026-07-10 09:50:05\",\"updated_at\":\"2026-07-10 09:50:05\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create location", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/locations", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/locations" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"New York Data Center\",\"address\":\"1234 Madison Ave, New York, NY\",\"phone\":\"+1 212-555-0199\",\"description\":\"Main East Coast colocation facility.\",\"manager_id\":42,\"remote_agent\":7}" }, "description": "Store a new location in the system using validated request data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":3012,\"app_id\":null,\"name\":\"Nicolas, Doyle and Dickinson\",\"address\":\"64031 Goodwin Inlet\\nEast Kaciebury, UT 85316\",\"city\":\"Ludwigbury\",\"state\":\"California\",\"description\":\"Maxime veritatis dignissimos a cupiditate soluta quasi provident. Nostrum et sint est quidem sit sint omnis reprehenderit. Ea similique sed labore maiores ratione accusamus amet. Natus consequatur autem distinctio rerum maiores.\",\"notes\":\"Voluptatem beatae et quam quasi tempora. Dolor dignissimos iure dolorem quod. Et occaecati culpa et.\",\"emergency\":\"1\",\"phone\":\"+1.972.519.9667\",\"flag\":\"UK.png\",\"created_at\":\"2026-07-10 09:50:06\",\"updated_at\":\"2026-07-10 09:50:06\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update location", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/locations\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/locations\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "The ID of the location." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Warsaw DC-1\",\"address\":\"ul. Marsza\u0142kowska 10, Warsaw, PL\",\"phone\":\"+48 22 123 45 67\",\"description\":\"Primary colocation facility in Warsaw.\",\"manager_id\":12,\"remote_agent\":3}" }, "description": "Updates the specified location with provided data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":3013,\"app_id\":null,\"name\":\"Borer-Hansen\",\"address\":\"43384 Wintheiser Knolls\\nMannberg, GA 93163-3230\",\"city\":\"Johnsonhaven\",\"state\":\"Colorado\",\"description\":\"Magni qui laboriosam quo est. Amet et eius at explicabo aut expedita natus. Quis qui qui est id optio.\",\"notes\":\"Autem fugiat numquam et. Delectus neque veniam fugiat. Accusamus omnis optio error dolorem velit at quia.\",\"emergency\":\"0\",\"phone\":\"+1 (551) 482-0693\",\"flag\":\"Germany.png\",\"created_at\":\"2026-07-10 09:50:06\",\"updated_at\":\"2026-07-10 09:50:06\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete location", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/locations\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/locations\/:id", "variable": [ { "id": "id", "key": "id", "value": "7", "description": "The ID of the location." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes the specified location from the system." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "Racks", "description": "", "item": [ { "name": "List Racks", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/racks", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, name, location_id, floor_id, units_number, weight, manager_id.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, name, location_id, floor_id.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/racks?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of racks" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":617,\"name\":\"repellendus\",\"floor_id\":586,\"location_id\":3014,\"description\":\"Maiores aut tempora est laudantium sint.\",\"room\":\"cupiditate\",\"units_number\":95,\"weight\":152,\"speed\":1000,\"manager_id\":5450,\"location\":{\"id\":3014,\"app_id\":null,\"name\":\"Altenwerth and Sons\",\"address\":\"17302 Harber Trafficway Suite 326\\nNew Opheliaberg, OR 69209\",\"city\":\"Stantonburgh\",\"state\":\"Alaska\",\"description\":\"Non ipsum et ratione tempore est. Delectus architecto eaque ut dolorem magni voluptas debitis laboriosam. Odit rerum voluptatem sapiente similique quas numquam delectus fugit.\",\"notes\":\"Sed placeat ut voluptates facere. Aut iusto et et modi iure qui assumenda occaecati. Earum et autem voluptas officiis quis consectetur.\",\"emergency\":\"0\",\"phone\":\"+1-623-328-2105\",\"flag\":\"Canada.png\",\"created_at\":\"2026-07-10 09:50:07\",\"updated_at\":\"2026-07-10 09:50:07\"},\"floor\":{\"id\":586,\"name\":\"ut\",\"number\":81,\"rows\":5,\"columns\":4,\"racks\":[{\"id\":617,\"name\":\"repellendus\"}],\"created_at\":\"2026-07-10 09:50:07\",\"updated_at\":\"2026-07-10 09:50:07\"},\"manager\":{\"id\":5450,\"username\":\"randi.conn\",\"email\":\"edmond.wilkinson@example.net\",\"name\":\"Felipa Hane\",\"firstname\":\"Felipa\",\"lastname\":\"Hane\",\"gender\":\"0\",\"avatar\":\"\/\/www.gravatar.com\/avatar\/5e9de79a7a5f61531be4c46af13edf3e?s=30&d=mm&r=g\",\"large_avatar\":\"\/\/www.gravatar.com\/avatar\/5e9de79a7a5f61531be4c46af13edf3e?s=130&d=mm&r=g\",\"company\":null,\"active\":1,\"status\":\"Active\",\"address1\":null,\"address2\":null,\"city\":null,\"state\":null,\"postcode\":null,\"country_code\":null,\"country_name\":\"United States\",\"locale\":null,\"timezone\":0,\"last_login\":null},\"created_at\":\"2026-07-10 09:50:07\",\"updated_at\":\"2026-07-10 09:50:07\"},{\"id\":618,\"name\":\"error\",\"floor_id\":587,\"location_id\":3016,\"description\":\"Ut voluptatem fuga molestias numquam est maxime.\",\"room\":\"cum\",\"units_number\":81,\"weight\":90,\"speed\":1000,\"manager_id\":5453,\"location\":{\"id\":3016,\"app_id\":null,\"name\":\"Dooley, Dicki and Nader\",\"address\":\"5244 Hazel Road\\nJakubowskistad, DC 52363\",\"city\":\"Port Zola\",\"state\":\"Alabama\",\"description\":\"Nulla tempore ullam voluptates. Eum officiis rerum voluptas possimus placeat ut. Quo nam quia est repellat. Molestiae quasi et odio ut iusto.\",\"notes\":\"Rerum placeat earum velit et explicabo qui. Quae omnis cumque ad in non. Natus et aperiam aut dolorem. Quasi ex neque itaque iure.\",\"emergency\":\"1\",\"phone\":\"(480) 240-6102\",\"flag\":\"Canada.png\",\"created_at\":\"2026-07-10 09:50:08\",\"updated_at\":\"2026-07-10 09:50:08\"},\"floor\":{\"id\":587,\"name\":\"nam\",\"number\":12,\"rows\":8,\"columns\":2,\"racks\":[{\"id\":618,\"name\":\"error\"}],\"created_at\":\"2026-07-10 09:50:08\",\"updated_at\":\"2026-07-10 09:50:08\"},\"manager\":{\"id\":5453,\"username\":\"herminia17\",\"email\":\"cierra.herzog@example.net\",\"name\":\"Dusty McClure\",\"firstname\":\"Dusty\",\"lastname\":\"McClure\",\"gender\":\"0\",\"avatar\":\"\/\/www.gravatar.com\/avatar\/5e3391c70bbb8ad86dfbf3e061e25255?s=30&d=mm&r=g\",\"large_avatar\":\"\/\/www.gravatar.com\/avatar\/5e3391c70bbb8ad86dfbf3e061e25255?s=130&d=mm&r=g\",\"company\":null,\"active\":1,\"status\":\"Active\",\"address1\":null,\"address2\":null,\"city\":null,\"state\":null,\"postcode\":null,\"country_code\":null,\"country_name\":\"United States\",\"locale\":null,\"timezone\":0,\"last_login\":null},\"created_at\":\"2026-07-10 09:50:08\",\"updated_at\":\"2026-07-10 09:50:08\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/racks?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/racks\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show rack", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/racks\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/racks\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "Rack ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns detailed information about a specific rack." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":619,\"name\":\"id\",\"floor_id\":588,\"location_id\":3018,\"description\":\"Rerum nesciunt dolore eum ut quisquam non quasi inventore.\",\"room\":\"nisi\",\"units_number\":15,\"weight\":153,\"speed\":10,\"manager_id\":5456,\"location\":{\"id\":3018,\"app_id\":null,\"name\":\"Carter-Hettinger\",\"address\":\"59477 Hegmann Summit\\nBergnaumtown, DE 31672-6955\",\"city\":\"East Willa\",\"state\":\"New Hampshire\",\"description\":\"Et modi qui amet est dicta. Et nobis incidunt pariatur qui. Reprehenderit vel quod earum sunt.\",\"notes\":\"Eum ut quia placeat et exercitationem sunt laborum. Assumenda sunt est et sunt est ipsam eligendi. Est qui fugit consectetur iusto enim.\",\"emergency\":\"0\",\"phone\":\"701.252.8272\",\"flag\":\"USA.png\",\"created_at\":\"2026-07-10 09:50:09\",\"updated_at\":\"2026-07-10 09:50:09\"},\"floor\":{\"id\":588,\"name\":\"tempore\",\"number\":12,\"rows\":10,\"columns\":5,\"racks\":[{\"id\":619,\"name\":\"id\"}],\"created_at\":\"2026-07-10 09:50:10\",\"updated_at\":\"2026-07-10 09:50:10\"},\"manager\":{\"id\":5456,\"username\":\"hammes.alexa\",\"email\":\"borer.ahmed@example.org\",\"name\":\"Geovanni Miller\",\"firstname\":\"Geovanni\",\"lastname\":\"Miller\",\"gender\":\"0\",\"avatar\":\"\/\/www.gravatar.com\/avatar\/c0e0da09e3f29ae561ff4aac6de3bd23?s=30&d=mm&r=g\",\"large_avatar\":\"\/\/www.gravatar.com\/avatar\/c0e0da09e3f29ae561ff4aac6de3bd23?s=130&d=mm&r=g\",\"company\":null,\"active\":1,\"status\":\"Active\",\"address1\":null,\"address2\":null,\"city\":null,\"state\":null,\"postcode\":null,\"country_code\":null,\"country_name\":\"United States\",\"locale\":null,\"timezone\":0,\"last_login\":null},\"created_at\":\"2026-07-10 09:50:10\",\"updated_at\":\"2026-07-10 09:50:10\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create rack", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/racks", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/racks" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Rack A-101\",\"location_id\":5,\"floor_id\":12,\"description\":\"42U rack with redundant power.\",\"room\":\"Server Room 2B\",\"units_number\":42,\"weight\":350,\"manager_id\":42}" }, "description": "Creates a new rack within a specific location and floor." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":620,\"name\":\"omnis\",\"floor_id\":589,\"location_id\":3020,\"description\":\"Consequatur dolores et qui autem optio voluptatem.\",\"room\":\"repellendus\",\"units_number\":85,\"weight\":53,\"speed\":100,\"manager_id\":5459,\"location\":{\"id\":3020,\"app_id\":null,\"name\":\"Gaylord Ltd\",\"address\":\"4681 Teagan Camp\\nD'Amoreberg, VA 86429-2376\",\"city\":\"Beckerton\",\"state\":\"South Dakota\",\"description\":\"Non ex cumque facere aspernatur quibusdam. Veritatis perspiciatis dolorem aut atque quidem. Aut non corporis autem quis impedit soluta. Corrupti at natus nihil qui labore ratione.\",\"notes\":\"Hic est sed occaecati a. Consequuntur veritatis adipisci dolores porro voluptatem non. Pariatur voluptatem dolorum culpa numquam aspernatur fugiat dolorum at.\",\"emergency\":\"0\",\"phone\":\"1-703-770-2234\",\"flag\":\"USA.png\",\"created_at\":\"2026-07-10 09:50:10\",\"updated_at\":\"2026-07-10 09:50:10\"},\"floor\":{\"id\":589,\"name\":\"eaque\",\"number\":27,\"rows\":10,\"columns\":5,\"racks\":[{\"id\":620,\"name\":\"omnis\"}],\"created_at\":\"2026-07-10 09:50:11\",\"updated_at\":\"2026-07-10 09:50:11\"},\"manager\":{\"id\":5459,\"username\":\"tristian12\",\"email\":\"bhintz@example.com\",\"name\":\"Antonietta Anderson\",\"firstname\":\"Antonietta\",\"lastname\":\"Anderson\",\"gender\":\"0\",\"avatar\":\"\/\/www.gravatar.com\/avatar\/f5b728588f18fbe3cf72d04039270c59?s=30&d=mm&r=g\",\"large_avatar\":\"\/\/www.gravatar.com\/avatar\/f5b728588f18fbe3cf72d04039270c59?s=130&d=mm&r=g\",\"company\":null,\"active\":1,\"status\":\"Active\",\"address1\":null,\"address2\":null,\"city\":null,\"state\":null,\"postcode\":null,\"country_code\":null,\"country_name\":\"United States\",\"locale\":null,\"timezone\":0,\"last_login\":null},\"created_at\":\"2026-07-10 09:50:11\",\"updated_at\":\"2026-07-10 09:50:11\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update rack", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/racks\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/racks\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "Rack ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Rack A-101\",\"location_id\":5,\"floor_id\":12,\"description\":\"42U rack with redundant power.\",\"room\":\"Server Room 2B\",\"units_number\":42,\"weight\":350,\"manager_id\":42}" }, "description": "Updates the attributes of an existing rack." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":621,\"name\":\"omnis\",\"floor_id\":590,\"location_id\":3022,\"description\":\"Et molestias cum rem necessitatibus.\",\"room\":\"minus\",\"units_number\":87,\"weight\":158,\"speed\":10,\"manager_id\":5462,\"location\":{\"id\":3022,\"app_id\":null,\"name\":\"Dickens Ltd\",\"address\":\"577 Conn Glens Suite 601\\nWest Bernardtown, AL 31451\",\"city\":\"West Carmela\",\"state\":\"Maine\",\"description\":\"Ad ab dignissimos et id magnam. Omnis placeat reiciendis omnis omnis perspiciatis. Qui aspernatur voluptates iusto illum non temporibus inventore.\",\"notes\":\"Impedit sint at rem deserunt commodi voluptas rem. Voluptas eos et ut quisquam et quos animi.\",\"emergency\":\"0\",\"phone\":\"(860) 218-1670\",\"flag\":\"USA.png\",\"created_at\":\"2026-07-10 09:50:11\",\"updated_at\":\"2026-07-10 09:50:11\"},\"floor\":{\"id\":590,\"name\":\"quisquam\",\"number\":51,\"rows\":8,\"columns\":4,\"racks\":[{\"id\":621,\"name\":\"omnis\"}],\"created_at\":\"2026-07-10 09:50:12\",\"updated_at\":\"2026-07-10 09:50:12\"},\"manager\":{\"id\":5462,\"username\":\"ojaskolski\",\"email\":\"daryl.runolfsson@example.org\",\"name\":\"Cletus Reilly\",\"firstname\":\"Cletus\",\"lastname\":\"Reilly\",\"gender\":\"0\",\"avatar\":\"\/\/www.gravatar.com\/avatar\/8bca86f5121c9429328140f5d75a93df?s=30&d=mm&r=g\",\"large_avatar\":\"\/\/www.gravatar.com\/avatar\/8bca86f5121c9429328140f5d75a93df?s=130&d=mm&r=g\",\"company\":null,\"active\":1,\"status\":\"Active\",\"address1\":null,\"address2\":null,\"city\":null,\"state\":null,\"postcode\":null,\"country_code\":null,\"country_name\":\"United States\",\"locale\":null,\"timezone\":0,\"last_login\":null},\"created_at\":\"2026-07-10 09:50:12\",\"updated_at\":\"2026-07-10 09:50:12\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete rack", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/racks\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/racks\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "Rack ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Permanently removes a rack from the system." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "Floors", "description": "", "item": [ { "name": "List floors", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/floors", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, name, number, location_id, rows, columns.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, name, number, location_id.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/floors?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of floors." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":591,\"name\":\"unde\",\"number\":48,\"rows\":4,\"columns\":9,\"racks\":[],\"created_at\":\"2026-07-10 09:50:12\",\"updated_at\":\"2026-07-10 09:50:12\"},{\"id\":592,\"name\":\"ut\",\"number\":33,\"rows\":9,\"columns\":3,\"racks\":[],\"created_at\":\"2026-07-10 09:50:13\",\"updated_at\":\"2026-07-10 09:50:13\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/floors?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/floors\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show floor", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/floors\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/floors\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the floor." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Display detailed information about a single floor by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":593,\"name\":\"sed\",\"number\":68,\"rows\":8,\"columns\":7,\"racks\":[],\"created_at\":\"2026-07-10 09:50:13\",\"updated_at\":\"2026-07-10 09:50:13\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create floor", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/floors", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/floors" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Floor 1\",\"number\":2,\"rows\":10,\"columns\":8,\"location_id\":1}" }, "description": "Store a new floor in the system using validated request data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":594,\"name\":\"illo\",\"number\":2,\"rows\":6,\"columns\":9,\"racks\":[],\"created_at\":\"2026-07-10 09:50:14\",\"updated_at\":\"2026-07-10 09:50:14\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update floor", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/floors\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/floors\/:id", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "The ID of the floor." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Updated Floor 2\",\"number\":3,\"rows\":12,\"columns\":15,\"location_id\":2}" }, "description": "Updates the specified floor with provided data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":595,\"name\":\"deserunt\",\"number\":65,\"rows\":2,\"columns\":3,\"racks\":[],\"created_at\":\"2026-07-10 09:50:14\",\"updated_at\":\"2026-07-10 09:50:14\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete floor", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/floors\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/floors\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "The ID of the floor." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes the specified floor from the system." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "Item Models", "description": "", "item": [ { "name": "List item models", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/item-models", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, name, label, manufacturer, status, type_id, location_id, created_at.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, name, label, manufacturer, status, type_id.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/item-models?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of item models." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":1519,\"name\":\"expedita\",\"label\":\"aliquid\",\"type_id\":1954,\"type\":{\"id\":1954,\"name\":\"veritatis\"},\"location_id\":3029,\"status\":\"in_use\",\"description\":\"Ullam repellat molestiae quisquam beatae aspernatur animi.\",\"is_part\":true,\"mountable\":false,\"manufacturer\":\"Stracke, Reichert and Doyle\",\"position\":\"rerum\",\"size\":0,\"image\":\"https:\/\/via.placeholder.com\/640x480.png\/0011bb?text=illum\",\"data_ports\":6,\"serialnumber1\":\"bc58f319-0dbf-36a7-a14a-95ba2be13fbe\",\"serialnumber2\":\"360ac2f2-8a05-3b85-82a7-31102d95af9d\",\"service_tag\":\"84c72877-3e0e-339f-834b-17c3a4d48f08\",\"comments\":\"Rerum accusamus omnis nemo at architecto vero. Ad impedit et exercitationem. Officia quia aliquid ut et. Qui quibusdam voluptas ut. Voluptatem nesciunt veritatis eveniet minus.\",\"notes\":\"Ipsam nostrum incidunt aut nihil omnis. Ut ab et minima. Officiis sapiente reiciendis dolorem aut et enim.\",\"purchase_date\":\"2007-01-01\",\"warranty_months\":25,\"warranty_info\":\"Optio id pariatur rerum debitis a et.\",\"function\":\"laborum\",\"maintenance_instruction\":\"Et placeat beatae occaecati molestias voluptatem recusandae id. Consequuntur voluptatibus et illo velit commodi expedita numquam. Et eveniet vel id odio. Doloremque nostrum qui qui.\",\"origin\":\"Tanzania\",\"buy_price\":498.64,\"appdata\":\"a:1:{s:3:\\\"key\\\";s:3:\\\"non\\\";}\",\"fields_data\":\"a:1:{s:5:\\\"field\\\";s:8:\\\"voluptas\\\";}\",\"parts_data\":\"a:1:{s:4:\\\"part\\\";s:3:\\\"qui\\\";}\",\"created_at\":\"2026-07-10T07:50:15.000000Z\",\"updated_at\":\"2026-07-10T07:50:15.000000Z\"},{\"id\":1520,\"name\":\"est\",\"label\":\"recusandae\",\"type_id\":1955,\"type\":{\"id\":1955,\"name\":\"asperiores\"},\"location_id\":3030,\"status\":\"available\",\"description\":\"Quis unde ipsa laudantium nostrum quod quod.\",\"is_part\":true,\"mountable\":false,\"manufacturer\":\"Zieme PLC\",\"position\":\"neque\",\"size\":0,\"image\":\"https:\/\/via.placeholder.com\/640x480.png\/000044?text=et\",\"data_ports\":9,\"serialnumber1\":\"be505654-645d-3924-8bae-de18cdff3e28\",\"serialnumber2\":\"423af26b-6dec-3486-8f16-5fde6b98b736\",\"service_tag\":\"3d6ccd66-3ed6-3a1a-9f0b-efc09a1c626b\",\"comments\":\"Sapiente ut dolorem nihil debitis ipsam. Quia qui rerum porro numquam ut saepe. Tenetur ad incidunt dolores cupiditate quod est pariatur.\",\"notes\":\"Exercitationem quo fugiat pariatur rerum. Maiores provident inventore sed architecto eveniet accusantium. Quis sunt repellendus quam mollitia. Aut quo earum inventore dolore tempora autem ducimus.\",\"purchase_date\":\"1998-06-30\",\"warranty_months\":16,\"warranty_info\":\"Et illum qui eius neque voluptate optio.\",\"function\":\"veniam\",\"maintenance_instruction\":\"Enim distinctio sint aut sunt vel aut vero. Reiciendis rerum porro nihil quia vel qui. Ea aut quis ut dolorum ut odio repellat.\",\"origin\":\"Western Sahara\",\"buy_price\":256.61,\"appdata\":\"a:1:{s:3:\\\"key\\\";s:10:\\\"laudantium\\\";}\",\"fields_data\":\"a:1:{s:5:\\\"field\\\";s:4:\\\"ipsa\\\";}\",\"parts_data\":\"a:1:{s:4:\\\"part\\\";s:5:\\\"saepe\\\";}\",\"created_at\":\"2026-07-10T07:50:15.000000Z\",\"updated_at\":\"2026-07-10T07:50:15.000000Z\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/item-models?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/item-models\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show item model", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/item-models\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/item-models\/:id", "variable": [ { "id": "id", "key": "id", "value": "10", "description": "The ID of the item model." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Display detailed information about a single item model by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":1521,\"name\":\"facere\",\"label\":\"voluptas\",\"type_id\":1956,\"type\":{\"id\":1956,\"name\":\"aliquid\"},\"location_id\":3031,\"status\":\"available\",\"description\":\"Sunt eligendi quia quae nulla.\",\"is_part\":false,\"mountable\":true,\"manufacturer\":\"Marks PLC\",\"position\":\"cupiditate\",\"size\":0,\"image\":\"https:\/\/via.placeholder.com\/640x480.png\/001133?text=sint\",\"data_ports\":2,\"serialnumber1\":\"0fd30395-eeb9-37b5-a0b5-f6010f3e13c8\",\"serialnumber2\":\"b37951e0-3e96-342e-a532-94b613c0e14d\",\"service_tag\":\"58b327b5-03f0-3556-b383-be7c7514d94c\",\"comments\":\"Aut aut earum laboriosam nesciunt rerum est non incidunt. Quos et at rerum ut sint. Amet neque laboriosam nostrum est consequuntur. Aut veritatis ad accusamus id non libero ut.\",\"notes\":\"Molestiae temporibus id similique ut sed id. Consequuntur iure vel sunt aut consequuntur voluptas quam consequuntur. Et laborum quos dolorem eligendi. Quam distinctio iusto veritatis non.\",\"purchase_date\":\"2025-12-27\",\"warranty_months\":14,\"warranty_info\":\"Repudiandae quasi recusandae accusamus ipsum corrupti.\",\"function\":\"sint\",\"maintenance_instruction\":\"Totam non sint ea non eveniet eum magni cumque. Neque in debitis perferendis voluptatem. Architecto cum et est ab et quasi. Deserunt necessitatibus ullam et. Modi quam eum nostrum.\",\"origin\":\"Korea\",\"buy_price\":100.64,\"appdata\":\"a:1:{s:3:\\\"key\\\";s:2:\\\"et\\\";}\",\"fields_data\":\"a:1:{s:5:\\\"field\\\";s:7:\\\"aperiam\\\";}\",\"parts_data\":\"a:1:{s:4:\\\"part\\\";s:12:\\\"perspiciatis\\\";}\",\"created_at\":\"2026-07-10T07:50:16.000000Z\",\"updated_at\":\"2026-07-10T07:50:16.000000Z\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create item model", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/item-models", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/item-models" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Dell PowerEdge R740\",\"type_id\":1,\"location_id\":5,\"label\":\"High-Performance Server\",\"status\":\"active\",\"description\":\"Dual CPU server with support for up to 3TB RAM.\",\"is_part\":false,\"mountable\":true,\"manufacturer\":\"Dell\",\"position\":\"front\",\"size\":2,\"image\":\"lsrtmoirzadephoia\",\"serialnumber1\":\"SN123456789\",\"serialnumber2\":\"SN987654321\",\"service_tag\":\"ST-001122\",\"comments\":\"mtohis\",\"notes\":\"eevoroxvqnqeojebycmyu\",\"purchase_date\":\"2026-07-10T09:50:16\",\"warranty_months\":36,\"warranty_info\":\"drd\",\"function\":\"izbrdjbxfueqhzbr\",\"maintenance_instruction\":\"x\",\"origin\":\"gmzrw\",\"buy_price\":2500}" }, "description": "Store a new item model in the system using validated request data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":1522,\"name\":\"eum\",\"label\":\"voluptatem\",\"type_id\":1957,\"type\":{\"id\":1957,\"name\":\"error\"},\"location_id\":3032,\"status\":\"in_use\",\"description\":\"Ut et maiores ratione eos.\",\"is_part\":false,\"mountable\":true,\"manufacturer\":\"Waelchi, Carroll and Kozey\",\"position\":\"tenetur\",\"size\":0,\"image\":\"https:\/\/via.placeholder.com\/640x480.png\/00dddd?text=excepturi\",\"data_ports\":4,\"serialnumber1\":\"753079dc-ad82-373d-8244-228abdf0ad98\",\"serialnumber2\":\"e7a637b4-213a-3e07-bec7-6236f607188f\",\"service_tag\":\"8a9362b9-006e-334b-8fb0-7ea79c628c3e\",\"comments\":\"Possimus officiis rerum id rerum iure. Recusandae qui excepturi nostrum ipsum aut nesciunt. Nam eum dolorem culpa ad et nisi reiciendis.\",\"notes\":\"Et aspernatur et dolorum ut. Autem est ullam cupiditate ex numquam. Hic error iure error et at. Temporibus rerum rem porro tempore reiciendis.\",\"purchase_date\":\"2003-03-01\",\"warranty_months\":28,\"warranty_info\":\"Qui veniam corporis enim quo.\",\"function\":\"culpa\",\"maintenance_instruction\":\"Sed nobis dignissimos expedita et similique porro. Enim et magnam suscipit sint occaecati tempore temporibus. Et voluptas qui aut perferendis expedita.\",\"origin\":\"Bahamas\",\"buy_price\":634.84,\"appdata\":\"a:1:{s:3:\\\"key\\\";s:5:\\\"minus\\\";}\",\"fields_data\":\"a:1:{s:5:\\\"field\\\";s:11:\\\"accusantium\\\";}\",\"parts_data\":\"a:1:{s:4:\\\"part\\\";s:10:\\\"recusandae\\\";}\",\"created_at\":\"2026-07-10T07:50:16.000000Z\",\"updated_at\":\"2026-07-10T07:50:16.000000Z\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update item model", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/item-models\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/item-models\/:id", "variable": [ { "id": "id", "key": "id", "value": "12", "description": "The ID of the item model." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Dell PowerEdge R740\",\"type_id\":1,\"location_id\":5,\"label\":\"High-Performance Server\",\"status\":\"active\",\"description\":\"Dual CPU server with support for up to 3TB RAM.\",\"is_part\":false,\"mountable\":true,\"manufacturer\":\"Dell\",\"position\":\"front\",\"size\":2,\"image\":\"dxpchnkrsotznzyndi\",\"serialnumber1\":\"SN123456789\",\"serialnumber2\":\"SN987654321\",\"service_tag\":\"ST-001122\",\"comments\":\"gbwnlxkqqaqtqbbmegd\",\"notes\":\"vfrwijvss\",\"purchase_date\":\"2026-07-10T09:50:16\",\"warranty_months\":36,\"warranty_info\":\"yzkbbhdlbfxc\",\"function\":\"vchwgcxydqaz\",\"maintenance_instruction\":\"sfnpanidufvsvjluvs\",\"origin\":\"z\",\"buy_price\":2500}" }, "description": "Updates the specified item model with the provided request data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":1523,\"name\":\"ut\",\"label\":\"dolorum\",\"type_id\":1958,\"type\":{\"id\":1958,\"name\":\"esse\"},\"location_id\":3033,\"status\":\"in_use\",\"description\":\"Aliquid similique voluptatem consectetur officia doloribus voluptas et.\",\"is_part\":true,\"mountable\":false,\"manufacturer\":\"Hayes-O'Keefe\",\"position\":\"eos\",\"size\":0,\"image\":\"https:\/\/via.placeholder.com\/640x480.png\/00bbbb?text=et\",\"data_ports\":4,\"serialnumber1\":\"ab8b2ffd-b744-3461-9e17-df694f0c2b41\",\"serialnumber2\":\"cf0675e0-1232-39a9-b985-d6713f737ae8\",\"service_tag\":\"d5775d34-6d5d-3ea2-acae-ff91f5639073\",\"comments\":\"Et nostrum consequatur soluta eligendi maxime. Quis quaerat aut vel sint. Ipsam dolorem adipisci dignissimos est consectetur sit.\",\"notes\":\"Et dicta corrupti dolor officiis porro dignissimos animi. Enim quia consectetur mollitia est. Eum eveniet et id voluptatem voluptas perspiciatis qui. Alias id nihil labore explicabo nemo.\",\"purchase_date\":\"1982-06-17\",\"warranty_months\":26,\"warranty_info\":\"Enim esse repellat et non.\",\"function\":\"cumque\",\"maintenance_instruction\":\"Quibusdam nisi quam facilis aliquid est omnis quia. Iure vitae sapiente ea ducimus. Est magnam eum esse animi. Hic exercitationem provident esse eum est accusantium quo.\",\"origin\":\"Aruba\",\"buy_price\":956.69,\"appdata\":\"a:1:{s:3:\\\"key\\\";s:2:\\\"ut\\\";}\",\"fields_data\":\"a:1:{s:5:\\\"field\\\";s:2:\\\"ut\\\";}\",\"parts_data\":\"a:1:{s:4:\\\"part\\\";s:5:\\\"dolor\\\";}\",\"created_at\":\"2026-07-10T07:50:17.000000Z\",\"updated_at\":\"2026-07-10T07:50:17.000000Z\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete item model", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/item-models\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/item-models\/:id", "variable": [ { "id": "id", "key": "id", "value": "15", "description": "The ID of the item model." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes the specified item model from the system." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "Users", "description": "", "item": [ { "name": "List users", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/users", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, email, firstname, lastname, company, status.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, email, firstname, lastname, company, status.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/users?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of users" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":5473,\"username\":\"dkozey\",\"email\":\"kody.price@example.org\",\"name\":\"Jany Ebert\",\"firstname\":\"Jany\",\"lastname\":\"Ebert\",\"gender\":\"0\",\"avatar\":\"\/\/www.gravatar.com\/avatar\/bdc353231b656b4c29d3ce7f810f6591?s=30&d=mm&r=g\",\"large_avatar\":\"\/\/www.gravatar.com\/avatar\/bdc353231b656b4c29d3ce7f810f6591?s=130&d=mm&r=g\",\"company\":null,\"active\":1,\"status\":\"Active\",\"address1\":null,\"address2\":null,\"city\":null,\"state\":null,\"postcode\":null,\"country_code\":null,\"country_name\":\"United States\",\"locale\":null,\"timezone\":0,\"last_login\":null},{\"id\":5474,\"username\":\"lind.name\",\"email\":\"jamie21@example.net\",\"name\":\"Hillary O'Reilly\",\"firstname\":\"Hillary\",\"lastname\":\"O'Reilly\",\"gender\":\"0\",\"avatar\":\"\/\/www.gravatar.com\/avatar\/20194d4c359cb7b1bc684d77c354796c?s=30&d=mm&r=g\",\"large_avatar\":\"\/\/www.gravatar.com\/avatar\/20194d4c359cb7b1bc684d77c354796c?s=130&d=mm&r=g\",\"company\":null,\"active\":1,\"status\":\"Active\",\"address1\":null,\"address2\":null,\"city\":null,\"state\":null,\"postcode\":null,\"country_code\":null,\"country_name\":\"United States\",\"locale\":null,\"timezone\":0,\"last_login\":null}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/users?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/users\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Fetch user by email", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/users\/find-by-email", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/users\/find-by-email" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"user@example.com\"}" }, "description": "Returns a user that matches the provided email." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":5475,\"username\":\"ioreilly\",\"email\":\"mccullough.rylee@example.org\",\"name\":\"Kiel Wisoky\",\"firstname\":\"Kiel\",\"lastname\":\"Wisoky\",\"gender\":\"0\",\"avatar\":\"\/\/www.gravatar.com\/avatar\/d8d4bf03ae27f28af393ddfaeb725e18?s=30&d=mm&r=g\",\"large_avatar\":\"\/\/www.gravatar.com\/avatar\/d8d4bf03ae27f28af393ddfaeb725e18?s=130&d=mm&r=g\",\"company\":null,\"active\":1,\"status\":\"Active\",\"address1\":null,\"address2\":null,\"city\":null,\"state\":null,\"postcode\":null,\"country_code\":null,\"country_name\":\"United States\",\"locale\":null,\"timezone\":0,\"last_login\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show User", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/users\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/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": "Updates the specified user with provided data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":5476,\"username\":\"mosciski.dora\",\"email\":\"dibbert.alexander@example.net\",\"name\":\"Dusty Abshire\",\"firstname\":\"Dusty\",\"lastname\":\"Abshire\",\"devices\":[],\"orders\":[],\"gender\":\"0\",\"avatar\":\"\/\/www.gravatar.com\/avatar\/2758779b2640a0eaa2233ccbdfdfbc9b?s=30&d=mm&r=g\",\"large_avatar\":\"\/\/www.gravatar.com\/avatar\/2758779b2640a0eaa2233ccbdfdfbc9b?s=130&d=mm&r=g\",\"company\":null,\"active\":1,\"status\":\"Active\",\"address1\":null,\"address2\":null,\"city\":null,\"state\":null,\"postcode\":null,\"country_code\":null,\"country_name\":\"United States\",\"locale\":null,\"timezone\":0,\"last_login\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/users", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/users" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"username\":\"johndoe\",\"firstname\":\"John\",\"lastname\":\"Doe\",\"email\":\"john@example.com\",\"password\":\"secret123\",\"password_confirmation\":\"secret123\",\"role\":2,\"active\":1,\"company\":\"Acme Inc.\",\"date_of_birth\":\"1990-05-15\",\"address1\":\"123 Main Street\",\"address2\":\"Apt 4B\",\"city\":\"New York\",\"state\":\"NY\",\"postcode\":\"10001\",\"country_code\":\"US\",\"locale\":\"en\",\"timezone\":\"America\\\/New_York\"}" }, "description": "Creates a new user account with the provided details." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":5477,\"username\":\"pbednar\",\"email\":\"rath.misty@example.net\",\"name\":\"Josephine Zemlak\",\"firstname\":\"Josephine\",\"lastname\":\"Zemlak\",\"gender\":\"0\",\"avatar\":\"\/\/www.gravatar.com\/avatar\/5347afaf0b9ba93625625e7cd857ff9f?s=30&d=mm&r=g\",\"large_avatar\":\"\/\/www.gravatar.com\/avatar\/5347afaf0b9ba93625625e7cd857ff9f?s=130&d=mm&r=g\",\"company\":null,\"active\":1,\"status\":\"Active\",\"address1\":null,\"address2\":null,\"city\":null,\"state\":null,\"postcode\":null,\"country_code\":null,\"country_name\":\"United States\",\"locale\":null,\"timezone\":0,\"last_login\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update User", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/users\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/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": "{\"username\":\"johndoe\",\"firstname\":\"John\",\"lastname\":\"Doe\",\"email\":\"john@example.com\",\"password\":\"secret123\",\"password_confirmation\":\"secret123\",\"role\":2,\"active\":1,\"company\":\"Acme Inc.\",\"date_of_birth\":\"1990-05-15\",\"address1\":\"123 Main Street\",\"address2\":\"Apt 4B\",\"city\":\"New York\",\"state\":\"NY\",\"postcode\":\"10001\",\"country_code\":\"US\",\"locale\":\"en\",\"timezone\":\"America\\\/New_York\"}" }, "description": "Updates the specified user with provided data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":5478,\"username\":\"zita.renner\",\"email\":\"schmitt.jo@example.org\",\"name\":\"Norberto Emmerich\",\"firstname\":\"Norberto\",\"lastname\":\"Emmerich\",\"gender\":\"0\",\"avatar\":\"\/\/www.gravatar.com\/avatar\/6fdbde8918552e042b97ba85e11bea4f?s=30&d=mm&r=g\",\"large_avatar\":\"\/\/www.gravatar.com\/avatar\/6fdbde8918552e042b97ba85e11bea4f?s=130&d=mm&r=g\",\"company\":null,\"active\":1,\"status\":\"Active\",\"address1\":null,\"address2\":null,\"city\":null,\"state\":null,\"postcode\":null,\"country_code\":null,\"country_name\":\"United States\",\"locale\":null,\"timezone\":0,\"last_login\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "User bandwidth", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/users\/:id\/bandwidth", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/users\/:id\/bandwidth", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the user." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"start_date\":\"2025-09-22 00:00:00\",\"end_date\":\"2025-09-22 23:59:59\",\"device_ids\":[5],\"device_selection\":\"all\"}" }, "description": "Returns an array of bandwidth usage values for a specified period of time." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"BW_TOTAL\":\"79.67 GB\",\"BW_IN\":\"41.30 GB\",\"BW_OUT\":\"38.37 GB\",\"95TH_PERC\":\"1.32 MBps\",\"95TH_PERC_IN\":\"0.68 MBps\",\"95TH_PERC_OUT\":\"0.64 MBps\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete User", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/users\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/users\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "The ID of the user." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes the specified user from the system." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "Authentication", "description": "", "item": [ { "name": "Verify API token and check if it has the given ability.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/users\/verify-token-ability", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/users\/verify-token-ability" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ability\":\"impersonate-users\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"abilities\":[\"impersonate-users\"],\"valid\":true}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "Ports", "description": "", "item": [ { "name": "List Network Ports", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ports", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, item_id, colocation_id, port_number, port_index, name, port_label, description.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, item_id, colocation_id, port_number, port_index, name, port_label, description.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/ports?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of ports." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":7508,\"name\":null,\"description\":\"Id rerum molestiae esse aliquam dolorem.\",\"item_id\":1068,\"colocation_id\":0,\"connected_item\":null,\"connected_port\":null,\"port_number\":48,\"port_index\":11,\"port_mode\":\"access\",\"port_label\":\"quia\",\"user_label\":\"necessitatibus\",\"speed\":\"100\",\"high_speed\":\"100\",\"if_type\":\"194\",\"physaddress\":\"EE:A1:85:AE:B0:74\",\"pullable\":1,\"primary\":1,\"vlan\":0,\"vlans\":[],\"opstate\":\"down\",\"adminstate\":\"down\",\"type\":\"\",\"ifInUcastPkts\":6234,\"ifOutUcastPkts\":6606,\"ifInErrors\":0,\"ifOutErrors\":0,\"ifInOctets\":0,\"ifOutOctets\":0,\"poll_time\":2026,\"poll_period\":300,\"current_in_bps\":null,\"current_out_bps\":null,\"current_total_bps\":null,\"current_usage_percent\":null,\"rate_valid\":false,\"created_at\":\"2026-07-10 09:50:19\",\"updated_at\":\"2026-07-10 09:50:19\"},{\"id\":7509,\"name\":null,\"description\":\"Aut ut qui dolor omnis assumenda.\",\"item_id\":1069,\"colocation_id\":0,\"connected_item\":null,\"connected_port\":null,\"port_number\":9,\"port_index\":51,\"port_mode\":\"access\",\"port_label\":\"ratione\",\"user_label\":\"occaecati\",\"speed\":\"1000\",\"high_speed\":\"100\",\"if_type\":\"232\",\"physaddress\":\"1D:05:76:52:5E:FB\",\"pullable\":0,\"primary\":0,\"vlan\":0,\"vlans\":[],\"opstate\":\"up\",\"adminstate\":\"down\",\"type\":\"\",\"ifInUcastPkts\":9949,\"ifOutUcastPkts\":7873,\"ifInErrors\":0,\"ifOutErrors\":0,\"ifInOctets\":0,\"ifOutOctets\":0,\"poll_time\":2026,\"poll_period\":300,\"current_in_bps\":null,\"current_out_bps\":null,\"current_total_bps\":null,\"current_usage_percent\":null,\"rate_valid\":false,\"created_at\":\"2026-07-10 09:50:20\",\"updated_at\":\"2026-07-10 09:50:20\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ports?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ports\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show port", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ports\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ports\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the port." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Display detailed information about a single port by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":7510,\"name\":null,\"description\":\"Laborum cum omnis cumque a aut.\",\"item\":{\"id\":1070,\"name\":null,\"label\":\"ullam\",\"type_id\":1963,\"location_id\":3039,\"status\":\"available\",\"description\":\"Tenetur iste accusantium magnam in qui nulla.\",\"is_part\":false,\"mountable\":true,\"manufacturer\":\"Fisher-Reichel\",\"position\":null,\"size\":8,\"image\":null,\"data_ports\":0,\"serialnumber1\":\"SN667PV\",\"serialnumber2\":null,\"service_tag\":\"ST104IU\",\"comments\":null,\"notes\":null,\"purchase_date\":\"2025-07-10\",\"warranty_months\":24,\"warranty_info\":null,\"function\":null,\"maintenance_instruction\":null,\"origin\":null,\"buy_price\":0,\"appdata\":false,\"fields_data\":null,\"parts_data\":null,\"created_at\":\"2026-07-10T07:50:20.000000Z\",\"updated_at\":\"2026-07-10T07:50:20.000000Z\"},\"colocation\":null,\"connected_item\":null,\"connected_port\":null,\"port_number\":20,\"port_index\":14,\"port_mode\":\"access\",\"port_label\":\"sit\",\"user_label\":\"deserunt\",\"speed\":\"100\",\"high_speed\":\"100\",\"if_type\":\"68\",\"physaddress\":\"45:BD:23:98:78:47\",\"pullable\":0,\"primary\":1,\"vlan\":0,\"vlans\":[],\"opstate\":\"down\",\"adminstate\":\"down\",\"type\":\"\",\"ifInUcastPkts\":3775,\"ifOutUcastPkts\":3269,\"ifInErrors\":0,\"ifOutErrors\":0,\"ifInOctets\":0,\"ifOutOctets\":0,\"poll_time\":2026,\"poll_period\":300,\"current_in_bps\":null,\"current_out_bps\":null,\"current_total_bps\":null,\"current_usage_percent\":null,\"rate_valid\":false,\"created_at\":\"2026-07-10 09:50:21\",\"updated_at\":\"2026-07-10 09:50:21\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create Port", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ports", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ports" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"port_number\":1,\"device_id\":115,\"port_label\":32,\"if_type\":1,\"pullable\":true,\"description\":\"This is description of the port\",\"user_label\":\"Uplink port\",\"physaddress\":\"00:0a:95:9d:68:16\"}" }, "description": "Store a new port in the system using validated request data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":7511,\"name\":null,\"description\":\"Veniam rerum possimus soluta ut quia.\",\"item\":{\"id\":1071,\"name\":null,\"label\":\"id\",\"type_id\":1965,\"location_id\":3041,\"status\":\"available\",\"description\":\"Eos ad exercitationem sed aut nihil aut.\",\"is_part\":false,\"mountable\":true,\"manufacturer\":\"Waters-Dickens\",\"position\":null,\"size\":3,\"image\":null,\"data_ports\":0,\"serialnumber1\":\"SN210PR\",\"serialnumber2\":null,\"service_tag\":\"ST465VX\",\"comments\":null,\"notes\":null,\"purchase_date\":\"2025-07-10\",\"warranty_months\":24,\"warranty_info\":null,\"function\":null,\"maintenance_instruction\":null,\"origin\":null,\"buy_price\":0,\"appdata\":false,\"fields_data\":null,\"parts_data\":null,\"created_at\":\"2026-07-10T07:50:21.000000Z\",\"updated_at\":\"2026-07-10T07:50:21.000000Z\"},\"colocation\":null,\"connected_item\":null,\"connected_port\":null,\"port_number\":31,\"port_index\":17,\"port_mode\":\"trunk\",\"port_label\":\"explicabo\",\"user_label\":\"aliquid\",\"speed\":\"100\",\"high_speed\":\"100\",\"if_type\":\"13\",\"physaddress\":\"0A:55:8C:76:F7:F7\",\"pullable\":1,\"primary\":1,\"vlan\":0,\"vlans\":[],\"opstate\":\"up\",\"adminstate\":\"down\",\"type\":\"\",\"ifInUcastPkts\":4492,\"ifOutUcastPkts\":6157,\"ifInErrors\":0,\"ifOutErrors\":0,\"ifInOctets\":0,\"ifOutOctets\":0,\"poll_time\":2026,\"poll_period\":300,\"current_in_bps\":null,\"current_out_bps\":null,\"current_total_bps\":null,\"current_usage_percent\":null,\"rate_valid\":false,\"created_at\":\"2026-07-10 09:50:22\",\"updated_at\":\"2026-07-10 09:50:22\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update Port", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ports\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ports\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the port." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"port_number\":1,\"port_label\":32,\"if_type\":1,\"pullable\":true,\"description\":\"This is description of the port\",\"user_label\":\"Uplink port\",\"physaddress\":\"00:0a:95:9d:68:16\"}" }, "description": "Updates the specified port with provided data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":7512,\"name\":null,\"description\":\"Velit unde pariatur adipisci.\",\"item\":null,\"colocation\":null,\"connected_item\":null,\"connected_port\":null,\"port_number\":9,\"port_index\":33,\"port_mode\":\"access\",\"port_label\":\"maxime\",\"user_label\":\"quasi\",\"speed\":\"1000\",\"high_speed\":\"100\",\"if_type\":\"137\",\"physaddress\":\"E4:17:82:BD:B0:42\",\"pullable\":0,\"primary\":0,\"vlan\":0,\"vlans\":[],\"opstate\":\"up\",\"adminstate\":\"down\",\"type\":\"\",\"ifInUcastPkts\":7740,\"ifOutUcastPkts\":8772,\"ifInErrors\":0,\"ifOutErrors\":0,\"ifInOctets\":0,\"ifOutOctets\":0,\"poll_time\":2026,\"poll_period\":300,\"current_in_bps\":null,\"current_out_bps\":null,\"current_total_bps\":null,\"current_usage_percent\":null,\"rate_valid\":false,\"created_at\":\"2026-07-10 09:50:24\",\"updated_at\":\"2026-07-10 09:50:24\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Assign port", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ports\/:id\/assign", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ports\/:id\/assign", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the port." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"connected_item\":12,\"connected_port\":115}" }, "description": "Assign network port to another port" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":7513,\"name\":null,\"description\":\"Eius sint reiciendis tempora facilis quo.\",\"item\":{\"id\":1073,\"name\":null,\"label\":\"corrupti\",\"type_id\":1969,\"location_id\":3045,\"status\":\"available\",\"description\":\"Et sint et eligendi possimus aut veritatis ea.\",\"is_part\":false,\"mountable\":true,\"manufacturer\":\"Armstrong Group\",\"position\":null,\"size\":5,\"image\":null,\"data_ports\":0,\"serialnumber1\":\"SN511DN\",\"serialnumber2\":null,\"service_tag\":\"ST186FL\",\"comments\":null,\"notes\":null,\"purchase_date\":\"2025-07-10\",\"warranty_months\":24,\"warranty_info\":null,\"function\":null,\"maintenance_instruction\":null,\"origin\":null,\"buy_price\":0,\"appdata\":false,\"fields_data\":null,\"parts_data\":null,\"created_at\":\"2026-07-10T07:50:24.000000Z\",\"updated_at\":\"2026-07-10T07:50:24.000000Z\"},\"colocation\":null,\"connected_item\":null,\"connected_port\":null,\"port_number\":17,\"port_index\":21,\"port_mode\":\"trunk\",\"port_label\":\"inventore\",\"user_label\":\"eaque\",\"speed\":\"10000\",\"high_speed\":\"1000\",\"if_type\":\"24\",\"physaddress\":\"27:9E:8C:75:33:E5\",\"pullable\":1,\"primary\":1,\"vlan\":0,\"vlans\":[],\"opstate\":\"up\",\"adminstate\":\"down\",\"type\":\"\",\"ifInUcastPkts\":2557,\"ifOutUcastPkts\":732,\"ifInErrors\":0,\"ifOutErrors\":0,\"ifInOctets\":0,\"ifOutOctets\":0,\"poll_time\":2026,\"poll_period\":300,\"current_in_bps\":null,\"current_out_bps\":null,\"current_total_bps\":null,\"current_usage_percent\":null,\"rate_valid\":false,\"created_at\":\"2026-07-10 09:50:25\",\"updated_at\":\"2026-07-10 09:50:25\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Unassign port", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ports\/:id\/unassign", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ports\/:id\/unassign", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the port." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Unassign network port" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":7514,\"name\":null,\"description\":\"Aut delectus rem sed molestiae.\",\"item\":{\"id\":1074,\"name\":null,\"label\":\"voluptas\",\"type_id\":1971,\"location_id\":3047,\"status\":\"available\",\"description\":\"Cupiditate doloremque deleniti ipsum temporibus similique.\",\"is_part\":false,\"mountable\":true,\"manufacturer\":\"McClure-Kreiger\",\"position\":null,\"size\":9,\"image\":null,\"data_ports\":0,\"serialnumber1\":\"SN107VA\",\"serialnumber2\":null,\"service_tag\":\"ST287ED\",\"comments\":null,\"notes\":null,\"purchase_date\":\"2025-07-10\",\"warranty_months\":24,\"warranty_info\":null,\"function\":null,\"maintenance_instruction\":null,\"origin\":null,\"buy_price\":0,\"appdata\":false,\"fields_data\":null,\"parts_data\":null,\"created_at\":\"2026-07-10T07:50:25.000000Z\",\"updated_at\":\"2026-07-10T07:50:25.000000Z\"},\"colocation\":null,\"connected_item\":null,\"connected_port\":null,\"port_number\":17,\"port_index\":34,\"port_mode\":\"access\",\"port_label\":\"ipsam\",\"user_label\":\"molestias\",\"speed\":\"10000\",\"high_speed\":\"1000\",\"if_type\":\"103\",\"physaddress\":\"67:9C:43:90:46:67\",\"pullable\":1,\"primary\":0,\"vlan\":0,\"vlans\":[],\"opstate\":\"down\",\"adminstate\":\"down\",\"type\":\"\",\"ifInUcastPkts\":337,\"ifOutUcastPkts\":9360,\"ifInErrors\":0,\"ifOutErrors\":0,\"ifInOctets\":0,\"ifOutOctets\":0,\"poll_time\":2026,\"poll_period\":300,\"current_in_bps\":null,\"current_out_bps\":null,\"current_total_bps\":null,\"current_usage_percent\":null,\"rate_valid\":false,\"created_at\":\"2026-07-10 09:50:26\",\"updated_at\":\"2026-07-10 09:50:26\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Enable port", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ports\/:id\/enable", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ports\/:id\/enable", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the port." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Enable port with given id." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Disable port", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ports\/:id\/disable", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ports\/:id\/disable", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the port." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Disable port with given id." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete Port", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ports\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ports\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "The ID of the port." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes the specified port from the system." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "Orders", "description": "", "item": [ { "name": "List orders", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/orders", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, ordernumber, status, service_status, type, user_id.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, ordernumber, status, service_status, type, user_id.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/orders?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of orders" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":577,\"ordernumber\":367486,\"user_id\":5500,\"status\":\"pending\",\"service_status\":\"waiting\",\"type\":\"Colocation\",\"options\":{\"autostart\":true},\"service\":null,\"created_at\":\"2026-07-10 09:50:26\",\"updated_at\":\"2026-07-10 09:50:26\"},{\"id\":578,\"ordernumber\":239662,\"user_id\":5501,\"status\":\"accepted\",\"service_status\":\"suspended\",\"type\":\"Colocation\",\"options\":{\"autostart\":true},\"service\":null,\"created_at\":\"2026-07-10 09:50:26\",\"updated_at\":\"2026-07-10 09:50:26\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/orders?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/orders\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/orders\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/orders\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the order." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Display detailed information about a single order by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":579,\"ordernumber\":311134,\"user_id\":5502,\"status\":\"accepted\",\"service_status\":\"terminated\",\"type\":\"Colocation\",\"options\":{\"autostart\":true},\"service\":null,\"created_at\":\"2026-07-10 09:50:26\",\"updated_at\":\"2026-07-10 09:50:26\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/orders", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/orders" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"module\":\"Server\",\"client\":1,\"auto_accept\":true}" }, "description": "Creates a new order in the system based on the given module, client, and criteria." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":580,\"ordernumber\":557707,\"user_id\":5503,\"status\":\"pending\",\"service_status\":\"provisioning\",\"type\":\"Colocation\",\"options\":{\"autostart\":true},\"service\":null,\"created_at\":\"2026-07-10 09:50:26\",\"updated_at\":\"2026-07-10 09:50:26\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Quick create & activate order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/orders\/quick-create", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/orders\/quick-create" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"module\":\"Server\",\"client\":1,\"device_id\":10}" }, "description": "Creates a new order for a specific device and customer.\nThe order is automatically accepted and the device assigned." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":581,\"ordernumber\":787227,\"user_id\":5504,\"status\":\"pending\",\"service_status\":\"provisioning\",\"type\":\"Server\",\"options\":{\"autostart\":true},\"service\":null,\"created_at\":\"2026-07-10 09:50:26\",\"updated_at\":\"2026-07-10 09:50:26\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/orders\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/orders\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the order." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"client\":1}" }, "description": "Update order details before it is accepted." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":582,\"ordernumber\":935070,\"user_id\":5505,\"status\":\"pending\",\"service_status\":\"waiting\",\"type\":\"Server\",\"options\":{\"autostart\":true},\"service\":null,\"created_at\":\"2026-07-10 09:50:26\",\"updated_at\":\"2026-07-10 09:50:26\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/orders\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/orders\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the order." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes an order by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Accept order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/orders\/:id\/accept", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/orders\/:id\/accept", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the order." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Accepts an order by ID and optionally activates the service if configured." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":583,\"ordernumber\":352538,\"user_id\":5506,\"status\":\"pending\",\"service_status\":\"terminated\",\"type\":\"Server\",\"options\":{\"autostart\":true},\"service\":null,\"created_at\":\"2026-07-10 09:50:26\",\"updated_at\":\"2026-07-10 09:50:26\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Activate service", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/orders\/:id\/service\/activate", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/orders\/:id\/service\/activate", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the order." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Activates the service assigned to the specified order." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"order\":{\"id\":31,\"ordernumber\":16,\"user_id\":1,\"status\":\"accepted\",\"service_status\":\"activated\",\"type\":\"Server\",\"options\":[],\"service\":{\"id\":40,\"related_id\":41,\"type\":\"Server\",\"status\":\"provisioning\",\"related\":{\"label\":\"label6\",\"model\":\"Generic\",\"location\":\"New York\",\"location_flag\":null,\"rack\":null,\"device_status\":\"running\",\"uptime\":\"172 days, 18h 17m 15s\",\"ip_addresses\":[\"192.168.56.128\"],\"metadata\":[]},\"access_level\":{\"id\":1,\"name\":\"Full Access\",\"type\":\"Server\",\"default\":true},\"created_at\":\"2025-10-16 09:41:48\"},\"created_at\":\"2025-10-16 09:41:48\",\"updated_at\":\"2025-10-20 12:45:21\"},\"result\":true}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Suspend service", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/orders\/:id\/service\/suspend", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/orders\/:id\/service\/suspend", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the order." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Suspends the service assigned to the specified order." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"order\":{\"id\":31,\"ordernumber\":16,\"user_id\":1,\"status\":\"accepted\",\"service_status\":\"suspended\",\"type\":\"Server\",\"options\":[],\"service\":{\"id\":40,\"related_id\":41,\"type\":\"Server\",\"status\":\"provisioning\",\"related\":{\"label\":\"label6\",\"model\":\"Generic\",\"location\":\"New York\",\"location_flag\":null,\"rack\":null,\"device_status\":\"running\",\"uptime\":\"172 days, 18h 17m 15s\",\"ip_addresses\":[\"192.168.56.128\"],\"metadata\":[]},\"access_level\":{\"id\":1,\"name\":\"Full Access\",\"type\":\"Server\",\"default\":true},\"created_at\":\"2025-10-16 09:41:48\"},\"created_at\":\"2025-10-16 09:41:48\",\"updated_at\":\"2025-10-20 12:45:21\"},\"result\":true}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Unsuspend service", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/orders\/:id\/service\/unsuspend", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/orders\/:id\/service\/unsuspend", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the order." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Unsuspends the service assigned to the specified order." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"order\":{\"id\":31,\"ordernumber\":16,\"user_id\":1,\"status\":\"accepted\",\"service_status\":\"activated\",\"type\":\"Server\",\"options\":[],\"service\":{\"id\":40,\"related_id\":41,\"type\":\"Server\",\"status\":\"provisioning\",\"related\":{\"label\":\"label6\",\"model\":\"Generic\",\"location\":\"New York\",\"location_flag\":null,\"rack\":null,\"device_status\":\"running\",\"uptime\":\"172 days, 18h 17m 15s\",\"ip_addresses\":[\"192.168.56.128\"],\"metadata\":[]},\"access_level\":{\"id\":1,\"name\":\"Full Access\",\"type\":\"Server\",\"default\":true},\"created_at\":\"2025-10-16 09:41:48\"},\"created_at\":\"2025-10-16 09:41:48\",\"updated_at\":\"2025-10-20 12:45:21\"},\"result\":true}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Terminate service", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/orders\/:id\/service\/terminate", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/orders\/:id\/service\/terminate", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the order." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Terminates the service belonging to the specified order." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"order\":{\"id\":31,\"ordernumber\":16,\"user_id\":1,\"status\":\"accepted\",\"service_status\":\"terminated\",\"type\":\"Server\",\"options\":[],\"service\":[],\"created_at\":\"2025-10-16 09:41:48\",\"updated_at\":\"2025-10-20 12:45:21\"},\"result\":true}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "List provisioning logs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/orders\/:id\/provisioning-logs", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "date_string", "description": "The field to sort by. Allowed: date_string, level.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "message", "description": "Optional. Restrict search to specific fields. Allowed: message.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/orders\/:id\/provisioning-logs?per_page=10&page=1&sort_by=date_string&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=message", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the order." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of provisioning logs for a given order." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"date\":\"2025-10-16 09:41:48\",\"level\":\"NOTICE\",\"message\":\"#ServerProvisioningModule Activate service action has been started\"},{\"date\":\"2025-10-16 09:41:48\",\"level\":\"INFO\",\"message\":\"#ServerProvisioningModule Found the applicable device model: http:\/\/easydcim_hostname\/backend\/devices\/41\/summary with hostname 192.168.56.128\"},{\"date\":\"2025-10-16 09:41:48\",\"level\":\"INFO\",\"message\":\"#ServerProvisioningModule Device status has changed\"},{\"date\":\"2025-10-16 09:41:48\",\"level\":\"INFO\",\"message\":\"#ServerProvisioningModule Device is going to be used during provisioning process\"},{\"date\":\"2025-10-16 09:41:48\",\"level\":\"INFO\",\"message\":\"#ServerProvisioningModule Client and order have been associated with device\"},{\"date\":\"2025-10-16 09:41:48\",\"level\":\"INFO\",\"message\":\"#ServerProvisioningModule Save the changes on device model\"},{\"date\":\"2025-10-16 09:41:48\",\"level\":\"ERROR\",\"message\":\"#ServerProvisioningModule Project ID not found for service ID: 40\"},{\"date\":\"2025-10-16 09:41:49\",\"level\":\"INFO\",\"message\":\"#ServerProvisioningModule [Usage Collector] Trying to set monthly traffic limit\"},{\"date\":\"2025-10-16 09:41:49\",\"level\":\"INFO\",\"message\":\"#ServerProvisioningModule [Usage Collector] Start Date has been set: first day of this month\"},{\"date\":\"2025-10-16 09:41:49\",\"level\":\"INFO\",\"message\":\"#ServerProvisioningModule [Usage Collector] Traffic limit IN\/OUT has been set: 1 GB. Traffic limit IN has been set: 0.1 GB. Traffic limit OUT has been set: 0.1 GB. Traffic percentile limit has been set: 10 Mbps.\"}],\"links\":{\"first\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/orders\/31\/provisioning-logs?page=1\",\"last\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/orders\/31\/provisioning-logs?page=3\",\"prev\":null,\"next\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/orders\/31\/provisioning-logs?page=2\"},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":3,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/orders\/31\/provisioning-logs?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/orders\/31\/provisioning-logs?page=2\",\"label\":\"2\",\"page\":2,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/orders\/31\/provisioning-logs?page=3\",\"label\":\"3\",\"page\":3,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/orders\/31\/provisioning-logs?page=2\",\"label\":\"Next »\",\"page\":2,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/orders\/31\/provisioning-logs\",\"per_page\":10,\"to\":10,\"total\":30,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Get order actions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/orders\/actions\/list", "query": [ { "key": "type", "value": "Server", "description": "The module type. Allowed: Server, Colocation.", "disabled": false }, { "key": "action", "value": "activate", "description": "The order action. Allowed: activate, suspend, unsuspend, terminate.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/orders\/actions\/list?type=Server&action=activate" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"Colocation\",\"action\":\"suspend\"}" }, "description": "Returns available global and module-specific actions for the given module type and action." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"globalActions\":[\"boot\",\"ports\"],\"allActions\":{\"boot\":\"Boot a device\",\"ports\":\"Enable traffic aggregation ports\",\"notifications_delete\":\"Delete notifications\",\"install_os\":\"[OS Installation] Install Operating System\",\"ipmi_create_operator_account\":\"[IPMI Integration] Create Operator Account\",\"ipam_assign_subnet\":\"[IP Address Management] Assign Subnet\",\"ipam_set_primary_ip\":\"[IP Address Management] Assign Primary IP to Device\",\"remove_dns\":\"[DNS Management] Delete zones and rDNS records\",\"add_dns_zone\":\"[DNS Management] Create zone\",\"add_rdns\":\"[DNS Management] Create rDNS records\",\"uc_set_usage_limit\":\"[Usage Collector] Set the monthly traffic limit\"}}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Get Devices in Stock Based on Criteria", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/orders\/stock", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/orders\/stock" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"criteria\":{\"model\":12,\"location\":12,\"require_parts\":1,\"parts\":{\"8\":{\"model\":[16,12],\"hdd.size\":[1048576,2048576]},\"9\":{\"model\":[25,21],\"ssd.size\":[\"524288|1048576\",524288]}}}}" }, "description": "Returns a devices in stock number based on order criteria" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"stock\":10}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "Device Bays", "description": "", "item": [ { "name": "List Device Bays", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/device-bays", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, parent_id, child_id, name.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, parent_id, child_id, name.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/device-bays?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of device bays." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":75,\"name\":\"Rachelle Russel I\",\"order\":8,\"parent_id\":1076,\"child_id\":1075,\"created_at\":\"2026-07-10 09:50:29\",\"updated_at\":\"2026-07-10 09:50:29\"},{\"id\":76,\"name\":\"Miss Marcella Lockman\",\"order\":7,\"parent_id\":1078,\"child_id\":1077,\"created_at\":\"2026-07-10 09:50:31\",\"updated_at\":\"2026-07-10 09:50:31\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/device-bays?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/device-bays\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show Device Bay", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/device-bays\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/device-bays\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the device bay." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Display detailed information about a single device bay by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":77,\"name\":\"Dr. Alejandra Raynor Jr.\",\"order\":3,\"parent\":{\"id\":1080,\"label\":\"consequuntur\",\"model\":\"eos\",\"product_id\":0,\"model_id\":1549,\"parent_id\":0,\"type_id\":6,\"user_id\":5523,\"order_id\":0,\"location_id\":3059,\"rack_id\":0,\"blade_id\":0,\"os_installation\":0,\"colocation_id\":0,\"provisioning_id\":0,\"manufacturer\":\"Mann LLC\",\"description\":\"Est in expedita aut maxime unde officiis.\",\"comments\":null,\"status\":\"available\",\"device_status\":\"running\",\"service_status\":\"activated\",\"function\":null,\"serialnumber1\":\"SN431ER\",\"serialnumber2\":null,\"service_tag\":\"ST475RP\",\"location\":\"Aufderhar-Vandervort\",\"metadata\":[],\"locked\":0,\"last_discovered\":\"Never\",\"discovery_time\":0,\"last_polled\":\"Never\",\"poller_disabled\":0,\"poller_time\":0,\"last_hour_traffic\":0,\"last_day_traffic\":0,\"last_week_traffic\":0,\"last_month_traffic\":0,\"current_month_traffic\":0,\"labeledRackWithPosition\":\"Unassigned<\/span>\",\"device_traffic\":null},\"child\":null,\"created_at\":\"2026-07-10 09:50:34\",\"updated_at\":\"2026-07-10 09:50:34\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create Device Bay", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/device-bays", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/device-bays" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"First Device Bay\",\"parent_id\":10,\"child_id\":18,\"order\":1}" }, "description": "Store a new device bay in the system using validated request data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":78,\"name\":\"Claudine Runolfsdottir DVM\",\"order\":3,\"parent\":{\"id\":1082,\"label\":\"doloremque\",\"model\":\"ipsa\",\"product_id\":0,\"model_id\":1553,\"parent_id\":0,\"type_id\":6,\"user_id\":5529,\"order_id\":0,\"location_id\":3063,\"rack_id\":0,\"blade_id\":0,\"os_installation\":0,\"colocation_id\":0,\"provisioning_id\":0,\"manufacturer\":\"Dicki-Rowe\",\"description\":\"Numquam ut beatae et quaerat odit.\",\"comments\":null,\"status\":\"available\",\"device_status\":\"running\",\"service_status\":\"activated\",\"function\":null,\"serialnumber1\":\"SN607VF\",\"serialnumber2\":null,\"service_tag\":\"ST998NT\",\"location\":\"Krajcik-Cassin\",\"metadata\":[],\"locked\":0,\"last_discovered\":\"Never\",\"discovery_time\":0,\"last_polled\":\"Never\",\"poller_disabled\":0,\"poller_time\":0,\"last_hour_traffic\":0,\"last_day_traffic\":0,\"last_week_traffic\":0,\"last_month_traffic\":0,\"current_month_traffic\":0,\"labeledRackWithPosition\":\"Unassigned<\/span>\",\"device_traffic\":null},\"child\":{\"id\":1081,\"label\":\"deleniti\",\"model\":\"est\",\"product_id\":0,\"model_id\":1551,\"parent_id\":0,\"type_id\":1982,\"user_id\":5526,\"order_id\":0,\"location_id\":3063,\"rack_id\":0,\"blade_id\":0,\"os_installation\":0,\"colocation_id\":0,\"provisioning_id\":0,\"manufacturer\":\"Langworth, McGlynn and Huel\",\"description\":\"Et unde assumenda delectus officiis.\",\"comments\":null,\"status\":\"available\",\"device_status\":\"running\",\"service_status\":\"activated\",\"function\":null,\"serialnumber1\":\"SN490NI\",\"serialnumber2\":null,\"service_tag\":\"ST044HT\",\"location\":\"Krajcik-Cassin\",\"metadata\":[],\"locked\":0,\"last_discovered\":\"Never\",\"discovery_time\":0,\"last_polled\":\"Never\",\"poller_disabled\":0,\"poller_time\":0,\"last_hour_traffic\":0,\"last_day_traffic\":0,\"last_week_traffic\":0,\"last_month_traffic\":0,\"current_month_traffic\":0,\"labeledRackWithPosition\":\"Unassigned<\/span>\",\"device_traffic\":null},\"created_at\":\"2026-07-10 09:50:36\",\"updated_at\":\"2026-07-10 09:50:36\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update Device Bay", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/device-bays\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/device-bays\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the device bay." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"First Device Bay\",\"child_id\":18,\"order\":1}" }, "description": "Updates the specified device bay with provided data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":79,\"name\":\"Dee Zulauf\",\"order\":1,\"parent\":{\"id\":1084,\"label\":\"pariatur\",\"model\":\"perferendis\",\"product_id\":0,\"model_id\":1557,\"parent_id\":0,\"type_id\":6,\"user_id\":5535,\"order_id\":0,\"location_id\":3067,\"rack_id\":0,\"blade_id\":0,\"os_installation\":0,\"colocation_id\":0,\"provisioning_id\":0,\"manufacturer\":\"Bailey-Bosco\",\"description\":\"Rerum enim et sapiente sed tempora rem itaque.\",\"comments\":null,\"status\":\"available\",\"device_status\":\"running\",\"service_status\":\"activated\",\"function\":null,\"serialnumber1\":\"SN834XH\",\"serialnumber2\":null,\"service_tag\":\"ST715EG\",\"location\":\"Wilkinson Inc\",\"metadata\":[],\"locked\":0,\"last_discovered\":\"Never\",\"discovery_time\":0,\"last_polled\":\"Never\",\"poller_disabled\":0,\"poller_time\":0,\"last_hour_traffic\":0,\"last_day_traffic\":0,\"last_week_traffic\":0,\"last_month_traffic\":0,\"current_month_traffic\":0,\"labeledRackWithPosition\":\"Unassigned<\/span>\",\"device_traffic\":null},\"child\":null,\"created_at\":\"2026-07-10 09:50:39\",\"updated_at\":\"2026-07-10 09:50:39\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete Device Bay", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/device-bays\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/device-bays\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "The ID of the device bay." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes the specified device bay from the system." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "Item Types", "description": "", "item": [ { "name": "List Item Types", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/types", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, name, predefined.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, name, description.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/types?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of item types." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":1988,\"name\":\"sint\",\"description\":\"Consequatur qui quo quam eos fugiat ut.\",\"hardware\":0,\"software\":0,\"predefined\":0,\"color\":\"olive\",\"created_at\":\"2026-07-10 09:50:39\",\"updated_at\":\"2026-07-10 09:50:39\"},{\"id\":1989,\"name\":\"a\",\"description\":\"Ut fugiat dolores aspernatur repudiandae et neque.\",\"hardware\":1,\"software\":1,\"predefined\":1,\"color\":\"navy\",\"created_at\":\"2026-07-10 09:50:39\",\"updated_at\":\"2026-07-10 09:50:39\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/types?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/types\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show Item Type", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/types\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/types\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the item type." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Display detailed information about a single item type by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":1990,\"name\":\"reiciendis\",\"description\":\"Sunt quis eum vero voluptatem sed.\",\"hardware\":0,\"software\":1,\"predefined\":1,\"color\":\"maroon\",\"created_at\":\"2026-07-10 09:50:39\",\"updated_at\":\"2026-07-10 09:50:39\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create Item Type", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/types", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/types" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Blade\",\"description\":\"Blade type description\",\"group\":\"hardware\",\"color\":\"#A8DBA8\"}" }, "description": "Store a new item type in the system using validated request data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":1991,\"name\":\"aliquid\",\"description\":\"Eius reiciendis incidunt aperiam tempore soluta.\",\"hardware\":1,\"software\":1,\"predefined\":0,\"color\":\"green\",\"created_at\":\"2026-07-10 09:50:39\",\"updated_at\":\"2026-07-10 09:50:39\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update Item Type", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/types\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/types\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the item type." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Blade\",\"description\":\"Blade type description\",\"group\":\"hardware\",\"color\":\"#A8DBA8\"}" }, "description": "Updates the specified item type with provided data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":1992,\"name\":\"eum\",\"description\":\"Aut voluptate dolorum possimus natus dolor minima.\",\"hardware\":0,\"software\":1,\"predefined\":1,\"color\":\"green\",\"created_at\":\"2026-07-10 09:50:39\",\"updated_at\":\"2026-07-10 09:50:39\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete Item type", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/types\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/types\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "The ID of the item type." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes the specified item type from the system." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "Groups", "description": "", "item": [ { "name": "List Groups", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/groups", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, title.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, title.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/groups?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of groups." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":64,\"title\":\"Estevan Tillman DDS\"},{\"id\":65,\"title\":\"Murl Carroll\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/groups?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/groups\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "List Permissions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/permissions", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/permissions" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of permissions." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":481,\"name\":\"occaecati.ut.dolor\",\"display_name\":\"Maximillia Carroll\",\"created_at\":\"2026-07-10 09:50:39\",\"updated_at\":\"2026-07-10 09:50:39\"},{\"id\":482,\"name\":\"in.quibusdam.non\",\"display_name\":\"Ciara Bashirian IV\",\"created_at\":\"2026-07-10 09:50:39\",\"updated_at\":\"2026-07-10 09:50:39\"}]}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show Group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/groups\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/groups\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the group." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Display detailed information about a single group by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":66,\"title\":\"Bernhard Dickinson\",\"permissions\":[]}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create Group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/groups", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/groups" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Employees\",\"permissions\":[1]}" }, "description": "Store a new group in the system using validated request data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":67,\"title\":\"Prof. Kiara McClure DVM\",\"permissions\":[]}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update Group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/groups\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/groups\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the group." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Employees\",\"permissions\":[1]}" }, "description": "Updates the specified group with provided data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":68,\"title\":\"Arvid Runte\",\"permissions\":[]}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete Group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/groups\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/groups\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "The ID of the group." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes the specified group from the system." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "Items", "description": "", "item": [ { "name": "List Items", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/items", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, model_id, parent_id, type_id, user_id, location_id, label, description.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, model_id, parent_id, type_id, user_id, location_id, label, description.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/items?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of items." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":1085,\"model_id\":1559,\"parent_id\":0,\"type_id\":1993,\"user_id\":5538,\"location_id\":3069,\"rack_id\":0,\"position\":null,\"image\":null,\"is_part\":1,\"mountable\":0,\"model\":\"temporibus\",\"manufacturer\":\"Rau, Blanda and Stamm\",\"serialnumber1\":\"SN764XH\",\"serialnumber2\":null,\"service_tag\":\"ST551GH\",\"comments\":null,\"label\":\"ut\",\"description\":\"Eum laudantium id ullam sequi sed assumenda voluptatem.\",\"purchase_date\":\"2025-07-10\",\"warranty_months\":24,\"warranty_info\":null,\"status\":\"available\",\"function\":null,\"origin\":null,\"buy_price\":0,\"appdata\":false,\"notes\":null,\"created_at\":\"2026-07-10 09:50:39\",\"updated_at\":\"2026-07-10 09:50:39\"},{\"id\":1086,\"model_id\":1561,\"parent_id\":0,\"type_id\":1995,\"user_id\":5541,\"location_id\":3071,\"rack_id\":0,\"position\":null,\"image\":null,\"is_part\":1,\"mountable\":0,\"model\":\"cumque\",\"manufacturer\":\"Jacobson, Bartoletti and Larson\",\"serialnumber1\":\"SN290JW\",\"serialnumber2\":null,\"service_tag\":\"ST551WU\",\"comments\":null,\"label\":\"consectetur\",\"description\":\"Magni quisquam ut error enim.\",\"purchase_date\":\"2025-07-10\",\"warranty_months\":24,\"warranty_info\":null,\"status\":\"available\",\"function\":null,\"origin\":null,\"buy_price\":0,\"appdata\":false,\"notes\":null,\"created_at\":\"2026-07-10 09:50:40\",\"updated_at\":\"2026-07-10 09:50:40\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/items?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/items\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show Item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/items\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/items\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the item." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Display detailed information about a single item by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":1087,\"model\":{\"id\":1563,\"name\":\"repellat\",\"label\":null,\"type_id\":1997,\"location_id\":0,\"status\":null,\"description\":null,\"is_part\":false,\"mountable\":true,\"manufacturer\":null,\"position\":null,\"size\":1,\"image\":null,\"data_ports\":null,\"serialnumber1\":null,\"serialnumber2\":null,\"service_tag\":null,\"comments\":null,\"notes\":null,\"purchase_date\":null,\"warranty_months\":null,\"warranty_info\":null,\"function\":null,\"maintenance_instruction\":null,\"origin\":null,\"buy_price\":null,\"appdata\":false,\"fields_data\":false,\"parts_data\":false,\"created_at\":\"2026-07-10T07:50:42.000000Z\",\"updated_at\":\"2026-07-10T07:50:42.000000Z\"},\"user\":{\"id\":5544,\"username\":\"brannon.schuster\",\"email\":\"fharvey@example.org\",\"name\":\"Guido Kassulke\",\"firstname\":\"Guido\",\"lastname\":\"Kassulke\",\"gender\":\"0\",\"avatar\":\"\/\/www.gravatar.com\/avatar\/2c60241ee7134118d12700cbf86f97eb?s=30&d=mm&r=g\",\"large_avatar\":\"\/\/www.gravatar.com\/avatar\/2c60241ee7134118d12700cbf86f97eb?s=130&d=mm&r=g\",\"company\":null,\"active\":1,\"status\":\"Active\",\"address1\":null,\"address2\":null,\"city\":null,\"state\":null,\"postcode\":null,\"country_code\":null,\"country_name\":\"United States\",\"locale\":null,\"timezone\":0,\"last_login\":null},\"type\":{\"id\":1997,\"name\":\"molestiae\",\"description\":\"Sed aperiam ipsa delectus sunt.\",\"hardware\":1,\"software\":1,\"predefined\":1,\"color\":\"silver\",\"created_at\":\"2026-07-10 09:50:41\",\"updated_at\":\"2026-07-10 09:50:41\"},\"parent\":null,\"location\":{\"id\":3073,\"app_id\":null,\"name\":\"Douglas-Gerlach\",\"address\":\"58879 Lockman Highway Apt. 897\\nHowardside, DC 44539\",\"city\":\"Hughside\",\"state\":\"District of Columbia\",\"description\":\"Aperiam rerum non sit officia. Qui omnis corporis quas molestiae incidunt rerum. Facere iusto nihil dolor neque temporibus est. Veniam voluptates natus animi accusantium et eligendi pariatur sequi.\",\"notes\":\"Vero voluptas dolorum sint quibusdam et. Autem voluptas exercitationem repellat dolores ut mollitia. Autem et aliquid occaecati. Omnis aut voluptatem saepe molestiae. Alias corporis rerum quia est.\",\"emergency\":\"1\",\"phone\":\"760.203.5207\",\"flag\":\"USA.png\",\"created_at\":\"2026-07-10 09:50:42\",\"updated_at\":\"2026-07-10 09:50:42\"},\"rack\":null,\"metadata\":[],\"position\":null,\"image\":null,\"is_part\":0,\"mountable\":1,\"manufacturer\":\"Champlin-Mertz\",\"serialnumber1\":\"SN426FC\",\"serialnumber2\":null,\"service_tag\":\"ST068JL\",\"comments\":null,\"label\":\"dolore\",\"description\":\"In et consequatur animi quam.\",\"purchase_date\":\"2025-07-10\",\"warranty_months\":24,\"warranty_info\":null,\"status\":\"available\",\"function\":null,\"origin\":null,\"buy_price\":0,\"appdata\":false,\"notes\":null,\"created_at\":\"2026-07-10 09:50:41\",\"updated_at\":\"2026-07-10 09:50:41\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show Item QR Code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/items\/:id\/qrcode", "query": [ { "key": "size", "value": "300", "description": "The size of the QR code.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/items\/:id\/qrcode?size=300", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the item." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Display QR code for item by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":\"data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAAFAAQMAAAD3XjfpAAAABlBMVEX\/\/\/8AAABVwtN+AAAACXBIWXMAAA7EAAAOxAGVKw4bAAAB6UlEQVRoge2WQZbDIAxDuYHvf0tu4GmxZDxpAnRdMX1pge9ZKEaiNY3fGeZj9GY9pu9fryen2BW4A2Nh7M2F1+PNEBd4AFosWKg+5ijCrAs8B9mrVD1egMBvQfwKJ8gSgecgDADNG8YZRfdOIfAWnFt3f5\/JJfAWrMOyg6H\/FRD4CKJBs107KpqV9yBwC1JoNCeQDCOPgBe4A4d9\/nOEGVPRyVBc4BJsvAlFDWTmHuygCdyCV709S0LxuMkL3IBInrHOiyYul2EEznunwCXo2a68aPa54dwReACOL6YQXLT0LwmBK7BDcj4joaK2zyKBGzCETrsMsl\/+gcAd2Oapt\/IGePaH3i5wC5oT8LTUzkSKTzqFwGdw7MFHYZgMo4io6qQCn8GW5xueadAbWlsagMAFOE00dO+1T6vcApcgHIARFNueF876XgSuwDZPf41xukJrVXKBT2A0btG0T1OF2sbkErgA2au9xFAiKBN4BuLgZ\/TAE2wKL3APelmcytNP2dcCl2Ce\/LRMY7gbWrhEksAnkLIasscZSexndwaSwBUIlxwf6lwKsmsFbkAaQHn2qEqxBX4BUvmRUdnSqbnAMzBzKBSGqVJ+gVuQXTlYNm8mk+OSJHADZiClwqF8GOmYXZJL4A2o8SvjD1rk6zzrRJ7rAAAAAElFTkSuQmCC\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create Item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/items", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/items" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"label\":\"Intel Xeon\",\"model\":123,\"type_id\":1,\"user_id\":5,\"parent_id\":10,\"location_id\":3,\"is_part\":true,\"manufacturer\":\"Intel\",\"serialnumber1\":\"SN123456789\",\"service_tag\":\"ST987654\",\"comments\":\"Example comment\",\"description\":\"Intel Xeon server CPU with 8 cores\",\"purchase_date\":\"2025-09-17\",\"warranty_months\":36,\"warranty_info\":\"Standard 3-year warranty\",\"status\":\"available\",\"function\":\"Server CPU\",\"origin\":\"Warehouse A\",\"buy_price\":2500.5,\"appdata\":{\"key\":\"value\"},\"notes\":\"Needs firmware update\",\"metadata\":[{\"metadata_id\":37,\"value\":\"1\",\"raw_value\":\"1\"}]}" }, "description": "Store a new item in the system using validated request data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":1088,\"model\":{\"id\":1565,\"name\":\"et\",\"label\":null,\"type_id\":1999,\"location_id\":0,\"status\":null,\"description\":null,\"is_part\":true,\"mountable\":false,\"manufacturer\":null,\"position\":null,\"size\":1,\"image\":null,\"data_ports\":null,\"serialnumber1\":null,\"serialnumber2\":null,\"service_tag\":null,\"comments\":null,\"notes\":null,\"purchase_date\":null,\"warranty_months\":null,\"warranty_info\":null,\"function\":null,\"maintenance_instruction\":null,\"origin\":null,\"buy_price\":null,\"appdata\":false,\"fields_data\":false,\"parts_data\":false,\"created_at\":\"2026-07-10T07:50:43.000000Z\",\"updated_at\":\"2026-07-10T07:50:43.000000Z\"},\"user\":{\"id\":5547,\"username\":\"glynch\",\"email\":\"jaqueline88@example.net\",\"name\":\"Marisol Welch\",\"firstname\":\"Marisol\",\"lastname\":\"Welch\",\"gender\":\"0\",\"avatar\":\"\/\/www.gravatar.com\/avatar\/d0daf83c8e56728fa095f6145b2c6bbb?s=30&d=mm&r=g\",\"large_avatar\":\"\/\/www.gravatar.com\/avatar\/d0daf83c8e56728fa095f6145b2c6bbb?s=130&d=mm&r=g\",\"company\":null,\"active\":1,\"status\":\"Active\",\"address1\":null,\"address2\":null,\"city\":null,\"state\":null,\"postcode\":null,\"country_code\":null,\"country_name\":\"United States\",\"locale\":null,\"timezone\":0,\"last_login\":null},\"type\":{\"id\":1999,\"name\":\"hic\",\"description\":\"Iste culpa repudiandae cumque quis et ducimus.\",\"hardware\":0,\"software\":0,\"predefined\":1,\"color\":\"olive\",\"created_at\":\"2026-07-10 09:50:42\",\"updated_at\":\"2026-07-10 09:50:42\"},\"parent\":null,\"location\":{\"id\":3075,\"app_id\":null,\"name\":\"Lowe, Roob and Jerde\",\"address\":\"3712 Cole Extension Suite 489\\nLake Letamouth, IN 99833\",\"city\":\"West Watsonchester\",\"state\":\"Vermont\",\"description\":\"Ex qui officia ullam earum voluptatem enim sequi rerum. Reiciendis ab ut excepturi eum et earum. Omnis cum explicabo qui aliquid aspernatur saepe.\",\"notes\":\"Iusto doloremque placeat eum ipsam omnis laudantium. Incidunt nulla et numquam nihil quam architecto. Et amet provident quia eum.\",\"emergency\":\"0\",\"phone\":\"1-337-774-8498\",\"flag\":\"Germany.png\",\"created_at\":\"2026-07-10 09:50:43\",\"updated_at\":\"2026-07-10 09:50:43\"},\"rack\":null,\"metadata\":[],\"position\":null,\"image\":null,\"is_part\":1,\"mountable\":0,\"manufacturer\":\"Koelpin Ltd\",\"serialnumber1\":\"SN244HJ\",\"serialnumber2\":null,\"service_tag\":\"ST326MX\",\"comments\":null,\"label\":\"officiis\",\"description\":\"Unde quis vel qui nihil.\",\"purchase_date\":\"2025-07-10\",\"warranty_months\":24,\"warranty_info\":null,\"status\":\"available\",\"function\":null,\"origin\":null,\"buy_price\":0,\"appdata\":false,\"notes\":null,\"created_at\":\"2026-07-10 09:50:42\",\"updated_at\":\"2026-07-10 09:50:42\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update Item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/items\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/items\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the item." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"label\":\"Intel Xeon\",\"model\":123,\"user_id\":5,\"parent_id\":10,\"location_id\":3,\"is_part\":true,\"manufacturer\":\"Intel\",\"serialnumber1\":\"SN123456789\",\"service_tag\":\"ST987654\",\"comments\":\"Example comment\",\"description\":\"Intel Xeon server CPU with 8 cores\",\"purchase_date\":\"2025-09-17\",\"warranty_months\":36,\"warranty_info\":\"Standard 3-year warranty\",\"status\":\"available\",\"function\":\"Server CPU\",\"origin\":\"Warehouse A\",\"buy_price\":2500.5,\"appdata\":{\"key\":\"value\"},\"notes\":\"Needs firmware update\",\"metadata\":[{\"metadata_id\":37,\"value\":\"1\",\"raw_value\":\"1\"}]}" }, "description": "Updates the specified item with provided data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":1089,\"model\":{\"id\":1567,\"name\":\"tempora\",\"label\":null,\"type_id\":2001,\"location_id\":0,\"status\":null,\"description\":null,\"is_part\":false,\"mountable\":true,\"manufacturer\":null,\"position\":null,\"size\":1,\"image\":null,\"data_ports\":null,\"serialnumber1\":null,\"serialnumber2\":null,\"service_tag\":null,\"comments\":null,\"notes\":null,\"purchase_date\":null,\"warranty_months\":null,\"warranty_info\":null,\"function\":null,\"maintenance_instruction\":null,\"origin\":null,\"buy_price\":null,\"appdata\":false,\"fields_data\":false,\"parts_data\":false,\"created_at\":\"2026-07-10T07:50:45.000000Z\",\"updated_at\":\"2026-07-10T07:50:45.000000Z\"},\"user\":{\"id\":5550,\"username\":\"ludie05\",\"email\":\"ada24@example.org\",\"name\":\"Destany Bode\",\"firstname\":\"Destany\",\"lastname\":\"Bode\",\"gender\":\"0\",\"avatar\":\"\/\/www.gravatar.com\/avatar\/0cf62eac7c53b994f66915315b416272?s=30&d=mm&r=g\",\"large_avatar\":\"\/\/www.gravatar.com\/avatar\/0cf62eac7c53b994f66915315b416272?s=130&d=mm&r=g\",\"company\":null,\"active\":1,\"status\":\"Active\",\"address1\":null,\"address2\":null,\"city\":null,\"state\":null,\"postcode\":null,\"country_code\":null,\"country_name\":\"United States\",\"locale\":null,\"timezone\":0,\"last_login\":null},\"type\":{\"id\":2001,\"name\":\"voluptatum\",\"description\":\"Quaerat exercitationem et omnis pariatur nobis voluptatem ipsum.\",\"hardware\":1,\"software\":1,\"predefined\":1,\"color\":\"maroon\",\"created_at\":\"2026-07-10 09:50:43\",\"updated_at\":\"2026-07-10 09:50:43\"},\"parent\":null,\"location\":{\"id\":3077,\"app_id\":null,\"name\":\"Blanda, Feest and Lakin\",\"address\":\"688 Alfonso Gardens Apt. 834\\nSouth Walker, NE 82007\",\"city\":\"Gibsonville\",\"state\":\"Montana\",\"description\":\"Sequi quis optio modi rerum inventore assumenda. Voluptatibus quis soluta deserunt doloribus ullam enim ullam.\",\"notes\":\"Est et odio id. Sint dolore cumque magni qui inventore voluptates ex. Consequatur iusto rerum expedita.\",\"emergency\":\"0\",\"phone\":\"480.539.1032\",\"flag\":\"Germany.png\",\"created_at\":\"2026-07-10 09:50:45\",\"updated_at\":\"2026-07-10 09:50:45\"},\"rack\":null,\"metadata\":[],\"position\":null,\"image\":null,\"is_part\":0,\"mountable\":1,\"manufacturer\":\"Lang-Wilkinson\",\"serialnumber1\":\"SN950TD\",\"serialnumber2\":null,\"service_tag\":\"ST616WX\",\"comments\":null,\"label\":\"similique\",\"description\":\"Ad blanditiis ut voluptatum id.\",\"purchase_date\":\"2025-07-10\",\"warranty_months\":24,\"warranty_info\":null,\"status\":\"available\",\"function\":null,\"origin\":null,\"buy_price\":0,\"appdata\":false,\"notes\":null,\"created_at\":\"2026-07-10 09:50:43\",\"updated_at\":\"2026-07-10 09:50:43\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Assign Metadata To Item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/items\/:id\/metadata\/assign", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/items\/:id\/metadata\/assign", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the item." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"slug\":\"ipmi.ip\",\"value\":\"192.168.56.180\"}" }, "description": "Assigns metadata for specified item." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":1090,\"model\":{\"id\":1569,\"name\":\"adipisci\",\"label\":null,\"type_id\":2003,\"location_id\":0,\"status\":null,\"description\":null,\"is_part\":true,\"mountable\":false,\"manufacturer\":null,\"position\":null,\"size\":1,\"image\":null,\"data_ports\":null,\"serialnumber1\":null,\"serialnumber2\":null,\"service_tag\":null,\"comments\":null,\"notes\":null,\"purchase_date\":null,\"warranty_months\":null,\"warranty_info\":null,\"function\":null,\"maintenance_instruction\":null,\"origin\":null,\"buy_price\":null,\"appdata\":false,\"fields_data\":false,\"parts_data\":false,\"created_at\":\"2026-07-10T07:50:46.000000Z\",\"updated_at\":\"2026-07-10T07:50:46.000000Z\"},\"user\":{\"id\":5553,\"username\":\"may57\",\"email\":\"pearl09@example.org\",\"name\":\"Omer Kling\",\"firstname\":\"Omer\",\"lastname\":\"Kling\",\"gender\":\"0\",\"avatar\":\"\/\/www.gravatar.com\/avatar\/58c29e10d28f3614e7da6c4a7ba172a9?s=30&d=mm&r=g\",\"large_avatar\":\"\/\/www.gravatar.com\/avatar\/58c29e10d28f3614e7da6c4a7ba172a9?s=130&d=mm&r=g\",\"company\":null,\"active\":1,\"status\":\"Active\",\"address1\":null,\"address2\":null,\"city\":null,\"state\":null,\"postcode\":null,\"country_code\":null,\"country_name\":\"United States\",\"locale\":null,\"timezone\":0,\"last_login\":null},\"type\":{\"id\":2003,\"name\":\"corrupti\",\"description\":\"Dolores esse eos et sed.\",\"hardware\":1,\"software\":0,\"predefined\":1,\"color\":\"blue\",\"created_at\":\"2026-07-10 09:50:45\",\"updated_at\":\"2026-07-10 09:50:45\"},\"parent\":null,\"location\":{\"id\":3079,\"app_id\":null,\"name\":\"Powlowski-Raynor\",\"address\":\"50548 Cullen Fork Suite 598\\nLarkinhaven, ID 96649-7513\",\"city\":\"Jeanside\",\"state\":\"Montana\",\"description\":\"Sed quia omnis recusandae commodi exercitationem. Exercitationem doloribus voluptatibus suscipit. Ullam earum laborum dolorum qui in esse modi.\",\"notes\":\"Nemo necessitatibus sit reiciendis laboriosam. Pariatur et nisi assumenda esse. Dolorum aliquam et corporis amet. Esse dicta incidunt repellat.\",\"emergency\":\"1\",\"phone\":\"(931) 705-5211\",\"flag\":\"USA.png\",\"created_at\":\"2026-07-10 09:50:46\",\"updated_at\":\"2026-07-10 09:50:46\"},\"rack\":null,\"metadata\":[],\"position\":null,\"image\":null,\"is_part\":1,\"mountable\":0,\"manufacturer\":\"Kilback-Cassin\",\"serialnumber1\":\"SN610JI\",\"serialnumber2\":null,\"service_tag\":\"ST452MI\",\"comments\":null,\"label\":\"odit\",\"description\":\"Illo id ullam illo possimus.\",\"purchase_date\":\"2025-07-10\",\"warranty_months\":24,\"warranty_info\":null,\"status\":\"available\",\"function\":null,\"origin\":null,\"buy_price\":0,\"appdata\":false,\"notes\":null,\"created_at\":\"2026-07-10 09:50:45\",\"updated_at\":\"2026-07-10 09:50:45\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete Item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/items\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/items\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "The ID of the item." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes the specified item from the system." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "Item Type Fields", "description": "", "item": [ { "name": "List Item Type Fields", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/fields", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, slug, predefined, label, unique.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, slug, predefined, label, unique.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/fields?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of item type fields." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":157,\"related_type\":null,\"element\":\"text\",\"group\":\"Base\",\"slug\":\"aut.perspiciatis.qui\",\"label\":\"Prof. Giuseppe Lockman V\",\"options\":{\"sint consectetur maiores ducimus aut\":\"sint consectetur maiores ducimus aut\"},\"predefined\":1,\"hidden\":0,\"provisionable\":0,\"combined\":0,\"filterable\":0,\"filterable_type\":null,\"unique\":1,\"sortable\":0,\"encrypted\":0,\"additional_rules\":[\"libero\",\"facilis\",\"cum\",\"necessitatibus\",\"voluptatum\"],\"order\":70,\"types\":[],\"created_at\":\"2026-07-10 09:50:46\",\"updated_at\":\"2026-07-10 09:50:46\"},{\"id\":158,\"related_type\":null,\"element\":\"text_multi\",\"group\":\"Base\",\"slug\":\"aut.quia.autem\",\"label\":\"Prof. Brennon Pollich\",\"options\":{\"pariatur qui dolor et est\":\"pariatur qui dolor et est\"},\"predefined\":1,\"hidden\":0,\"provisionable\":1,\"combined\":0,\"filterable\":0,\"filterable_type\":null,\"unique\":1,\"sortable\":0,\"encrypted\":0,\"additional_rules\":[\"consequuntur\",\"sed\",\"rerum\",\"recusandae\",\"autem\"],\"order\":37,\"types\":[],\"created_at\":\"2026-07-10 09:50:46\",\"updated_at\":\"2026-07-10 09:50:46\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/fields?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/fields\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show Item Type Field", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/fields\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/fields\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the item type field." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Display detailed information about a single item type field by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":159,\"related_type\":null,\"element\":\"text_multi\",\"group\":\"Base\",\"slug\":\"placeat.beatae.adipisci\",\"label\":\"Leatha Schaefer\",\"options\":{\"asperiores blanditiis quo repellendus doloribus\":\"asperiores blanditiis quo repellendus doloribus\"},\"predefined\":1,\"hidden\":0,\"provisionable\":0,\"combined\":0,\"filterable\":0,\"filterable_type\":null,\"unique\":0,\"sortable\":1,\"encrypted\":1,\"additional_rules\":[\"nobis\",\"non\",\"at\",\"nobis\",\"aliquid\"],\"order\":19,\"values\":[],\"types\":[],\"created_at\":\"2026-07-10 09:50:46\",\"updated_at\":\"2026-07-10 09:50:46\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create Item Type Field", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/fields", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/fields" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"element\":\"text\",\"group\":\"Base\",\"slug\":\"hostname\",\"label\":\"Host Name\",\"options\":\"option1,option2\",\"hidden\":false,\"provisionable\":true,\"combined\":false,\"filterable\":true,\"filterable_type\":\"equals\",\"unique\":true,\"sortable\":true,\"encrypted\":false,\"additional_rules\":[\"ip\",\"email\"],\"order\":1,\"types\":[1]}" }, "description": "Store a new item type field in the system using validated request data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":160,\"related_type\":null,\"element\":\"text_multi\",\"group\":\"Base\",\"slug\":\"beatae.quod.tempore\",\"label\":\"Shaun Wolff V\",\"options\":{\"temporibus alias debitis ut voluptatum\":\"temporibus alias debitis ut voluptatum\"},\"predefined\":1,\"hidden\":1,\"provisionable\":0,\"combined\":0,\"filterable\":0,\"filterable_type\":null,\"unique\":0,\"sortable\":0,\"encrypted\":0,\"additional_rules\":[\"aliquid\",\"aut\",\"et\",\"culpa\",\"beatae\"],\"order\":68,\"values\":[],\"types\":[],\"created_at\":\"2026-07-10 09:50:46\",\"updated_at\":\"2026-07-10 09:50:46\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update Item Type Field", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/fields\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/fields\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the item type field." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"element\":\"text\",\"group\":\"Base\",\"slug\":\"hostname\",\"label\":\"Host Name\",\"options\":\"option1,option2\",\"hidden\":false,\"provisionable\":true,\"combined\":false,\"filterable\":true,\"filterable_type\":\"equals\",\"unique\":true,\"sortable\":true,\"encrypted\":false,\"additional_rules\":[\"ip\",\"email\"],\"order\":1,\"types\":[1]}" }, "description": "Updates the specified item type field with provided data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":161,\"related_type\":null,\"element\":\"textarea\",\"group\":\"Base\",\"slug\":\"corrupti.ipsum.dignissimos\",\"label\":\"Hilbert Oberbrunner\",\"options\":{\"ad rerum consectetur magni id\":\"ad rerum consectetur magni id\"},\"predefined\":0,\"hidden\":1,\"provisionable\":1,\"combined\":0,\"filterable\":0,\"filterable_type\":null,\"unique\":0,\"sortable\":0,\"encrypted\":1,\"additional_rules\":[\"quam\",\"qui\",\"in\",\"totam\",\"molestiae\"],\"order\":81,\"values\":[],\"types\":[],\"created_at\":\"2026-07-10 09:50:46\",\"updated_at\":\"2026-07-10 09:50:46\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete Item Type Field", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/fields\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/fields\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "The ID of the item type field." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes the specified item type field from the system." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "Power Ports", "description": "", "item": [ { "name": "List Power Ports", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/power-ports", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, item_id, colocation_id, port_number, port_index, name, port_label, description.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, item_id, colocation_id, port_number, port_index, name, port_label, description.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/power-ports?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of power ports." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":445,\"name\":\"placeat\",\"description\":\"Est enim esse autem aut.\",\"item_id\":1091,\"colocation_id\":0,\"port_number\":7,\"port_label\":\"est\",\"user_label\":\"quidem\",\"outlet_state\":\"outletOn\",\"connected_item\":null,\"connected_port\":null,\"power_usage\":68,\"power_usage_units\":\"Amps\",\"power_usage_value\":68,\"power_usage_unit\":\"amps\",\"power_usage_label\":\"68 Amps\",\"created_at\":\"2026-07-10 09:50:46\",\"updated_at\":\"2026-07-10 09:50:46\"},{\"id\":446,\"name\":\"veniam\",\"description\":\"Consequatur et ab ea.\",\"item_id\":1092,\"colocation_id\":0,\"port_number\":3,\"port_label\":\"voluptas\",\"user_label\":\"rerum\",\"outlet_state\":\"down\",\"connected_item\":null,\"connected_port\":null,\"power_usage\":3,\"power_usage_units\":\"Amps\",\"power_usage_value\":3,\"power_usage_unit\":\"amps\",\"power_usage_label\":\"3 Amps\",\"created_at\":\"2026-07-10 09:50:48\",\"updated_at\":\"2026-07-10 09:50:48\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/power-ports?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/power-ports\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show Power Port", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/power-ports\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/power-ports\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the power port." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Display detailed information about a single power port by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":447,\"name\":\"rerum\",\"description\":\"Deleniti nulla minima cupiditate eum possimus aliquid.\",\"item\":{\"id\":1093,\"name\":null,\"label\":\"quia\",\"type_id\":2009,\"location_id\":3089,\"status\":\"available\",\"description\":\"Facilis nesciunt est fuga est.\",\"is_part\":false,\"mountable\":true,\"manufacturer\":\"Howe-Larson\",\"position\":null,\"size\":1,\"image\":null,\"data_ports\":0,\"serialnumber1\":\"SN921QM\",\"serialnumber2\":null,\"service_tag\":\"ST978SW\",\"comments\":null,\"notes\":null,\"purchase_date\":\"2025-07-10\",\"warranty_months\":24,\"warranty_info\":null,\"function\":null,\"maintenance_instruction\":null,\"origin\":null,\"buy_price\":0,\"appdata\":false,\"fields_data\":null,\"parts_data\":null,\"created_at\":\"2026-07-10T07:50:51.000000Z\",\"updated_at\":\"2026-07-10T07:50:51.000000Z\"},\"colocation\":null,\"port_number\":21,\"port_label\":\"aliquam\",\"user_label\":\"voluptatibus\",\"outlet_state\":\"up\",\"connected_item\":null,\"connected_port\":null,\"power_usage\":18,\"power_usage_units\":\"Amps\",\"power_usage_value\":18,\"power_usage_unit\":\"amps\",\"power_usage_label\":\"18 Amps\",\"created_at\":\"2026-07-10 09:50:51\",\"updated_at\":\"2026-07-10 09:50:51\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create Power Port", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/power-ports", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/power-ports" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"port_number\":1,\"device_id\":115,\"port_label\":\"Power Port 1\",\"primary\":true,\"description\":\"This is description of the power port\",\"user_label\":\"Description of power port\"}" }, "description": "Store a new power port in the system using validated request data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":448,\"name\":\"deserunt\",\"description\":\"Culpa repellendus aut delectus dolor beatae eligendi facere.\",\"item\":{\"id\":1094,\"name\":null,\"label\":\"quasi\",\"type_id\":2011,\"location_id\":3093,\"status\":\"available\",\"description\":\"Id nostrum dolorum qui qui omnis sequi mollitia.\",\"is_part\":false,\"mountable\":true,\"manufacturer\":\"Anderson Ltd\",\"position\":null,\"size\":1,\"image\":null,\"data_ports\":0,\"serialnumber1\":\"SN851ZL\",\"serialnumber2\":null,\"service_tag\":\"ST668HF\",\"comments\":null,\"notes\":null,\"purchase_date\":\"2025-07-10\",\"warranty_months\":24,\"warranty_info\":null,\"function\":null,\"maintenance_instruction\":null,\"origin\":null,\"buy_price\":0,\"appdata\":false,\"fields_data\":null,\"parts_data\":null,\"created_at\":\"2026-07-10T07:50:53.000000Z\",\"updated_at\":\"2026-07-10T07:50:53.000000Z\"},\"colocation\":null,\"port_number\":14,\"port_label\":\"ut\",\"user_label\":\"ratione\",\"outlet_state\":\"down\",\"connected_item\":null,\"connected_port\":null,\"power_usage\":77,\"power_usage_units\":\"Amps\",\"power_usage_value\":77,\"power_usage_unit\":\"amps\",\"power_usage_label\":\"77 Amps\",\"created_at\":\"2026-07-10 09:50:53\",\"updated_at\":\"2026-07-10 09:50:53\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update Power Port", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/power-ports\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/power-ports\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the power port." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"port_number\":1,\"port_label\":32,\"primary\":true,\"description\":\"This is description of the power port\",\"user_label\":\"Description of power port\"}" }, "description": "Updates the specified power port with provided data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":449,\"name\":\"unde\",\"description\":\"Laborum sit cupiditate dolores excepturi sed quo impedit.\",\"item\":{\"id\":1095,\"name\":null,\"label\":\"ex\",\"type_id\":2013,\"location_id\":3097,\"status\":\"available\",\"description\":\"Distinctio officiis est vel repellat non itaque enim.\",\"is_part\":false,\"mountable\":true,\"manufacturer\":\"Schulist-Kuvalis\",\"position\":null,\"size\":1,\"image\":null,\"data_ports\":0,\"serialnumber1\":\"SN872TH\",\"serialnumber2\":null,\"service_tag\":\"ST462DW\",\"comments\":null,\"notes\":null,\"purchase_date\":\"2025-07-10\",\"warranty_months\":24,\"warranty_info\":null,\"function\":null,\"maintenance_instruction\":null,\"origin\":null,\"buy_price\":0,\"appdata\":false,\"fields_data\":null,\"parts_data\":null,\"created_at\":\"2026-07-10T07:50:56.000000Z\",\"updated_at\":\"2026-07-10T07:50:56.000000Z\"},\"colocation\":null,\"port_number\":10,\"port_label\":\"libero\",\"user_label\":\"est\",\"outlet_state\":\"up\",\"connected_item\":null,\"connected_port\":null,\"power_usage\":50,\"power_usage_units\":\"Amps\",\"power_usage_value\":50,\"power_usage_unit\":\"amps\",\"power_usage_label\":\"50 Amps\",\"created_at\":\"2026-07-10 09:50:56\",\"updated_at\":\"2026-07-10 09:50:56\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Assign Power Port", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/power-ports\/:id\/assign", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/power-ports\/:id\/assign", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the power port." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"connected_item\":12,\"connected_port\":115}" }, "description": "Assign power port to another port" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":450,\"name\":\"et\",\"description\":\"Quos totam fugit at quia cumque iste beatae.\",\"item\":{\"id\":1096,\"name\":null,\"label\":\"distinctio\",\"type_id\":2015,\"location_id\":3101,\"status\":\"available\",\"description\":\"Aut vel consequatur quia quas inventore.\",\"is_part\":false,\"mountable\":true,\"manufacturer\":\"Koepp PLC\",\"position\":null,\"size\":1,\"image\":null,\"data_ports\":0,\"serialnumber1\":\"SN778HO\",\"serialnumber2\":null,\"service_tag\":\"ST853DE\",\"comments\":null,\"notes\":null,\"purchase_date\":\"2025-07-10\",\"warranty_months\":24,\"warranty_info\":null,\"function\":null,\"maintenance_instruction\":null,\"origin\":null,\"buy_price\":0,\"appdata\":false,\"fields_data\":null,\"parts_data\":null,\"created_at\":\"2026-07-10T07:50:58.000000Z\",\"updated_at\":\"2026-07-10T07:50:58.000000Z\"},\"colocation\":null,\"port_number\":47,\"port_label\":\"ratione\",\"user_label\":\"dolorem\",\"outlet_state\":\"down\",\"connected_item\":null,\"connected_port\":null,\"power_usage\":17,\"power_usage_units\":\"Amps\",\"power_usage_value\":17,\"power_usage_unit\":\"amps\",\"power_usage_label\":\"17 Amps\",\"created_at\":\"2026-07-10 09:50:58\",\"updated_at\":\"2026-07-10 09:50:58\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Unassign Power Port", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/power-ports\/:id\/unassign", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/power-ports\/:id\/unassign", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the power port." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Unassigns power port" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":451,\"name\":\"perferendis\",\"description\":\"Placeat ducimus qui qui molestias aut.\",\"item\":{\"id\":1097,\"name\":null,\"label\":\"soluta\",\"type_id\":2017,\"location_id\":3105,\"status\":\"available\",\"description\":\"Occaecati eius excepturi ut dolorum iusto at asperiores.\",\"is_part\":false,\"mountable\":true,\"manufacturer\":\"Douglas-Keebler\",\"position\":null,\"size\":1,\"image\":null,\"data_ports\":0,\"serialnumber1\":\"SN054VV\",\"serialnumber2\":null,\"service_tag\":\"ST590KX\",\"comments\":null,\"notes\":null,\"purchase_date\":\"2025-07-10\",\"warranty_months\":24,\"warranty_info\":null,\"function\":null,\"maintenance_instruction\":null,\"origin\":null,\"buy_price\":0,\"appdata\":false,\"fields_data\":null,\"parts_data\":null,\"created_at\":\"2026-07-10T07:51:01.000000Z\",\"updated_at\":\"2026-07-10T07:51:01.000000Z\"},\"colocation\":null,\"port_number\":28,\"port_label\":\"maxime\",\"user_label\":\"aliquid\",\"outlet_state\":\"outletOff\",\"connected_item\":null,\"connected_port\":null,\"power_usage\":57,\"power_usage_units\":\"Amps\",\"power_usage_value\":57,\"power_usage_unit\":\"amps\",\"power_usage_label\":\"57 Amps\",\"created_at\":\"2026-07-10 09:51:01\",\"updated_at\":\"2026-07-10 09:51:01\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Perform action on a specific Power Port", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/power-ports\/:id\/action", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/power-ports\/:id\/action", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the power port." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"action\":\"outletOff\"}" }, "description": "Executes an outlet action (outletOn, outletOff, outletReboot) for a given port." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":452,\"name\":\"unde\",\"description\":\"Quo vel quo voluptas autem et.\",\"item\":null,\"colocation\":null,\"port_number\":43,\"port_label\":\"nihil\",\"user_label\":\"est\",\"outlet_state\":\"down\",\"connected_item\":null,\"connected_port\":null,\"power_usage\":40,\"power_usage_units\":\"Amps\",\"power_usage_value\":40,\"power_usage_unit\":\"amps\",\"power_usage_label\":\"40 Amps\",\"created_at\":\"2026-07-10 09:51:03\",\"updated_at\":\"2026-07-10 09:51:03\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete Power Port", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/power-ports\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/power-ports\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "The ID of the power port." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes the specified power port from the system." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "Sensors", "description": "", "item": [ { "name": "List Sensors", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/sensors", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, item_id, name, class, type.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, item_id, name, class, type.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/sensors?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of sensors." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":713,\"item_id\":1099,\"name\":\"consequuntur\",\"class\":\"Fans\",\"type\":\"Power\",\"unit\":\"Celsius\",\"index\":\"Power\",\"reading\":216,\"last_polled\":\"0000-00-00 00:00:00\",\"configuration\":[],\"created_at\":\"2026-07-10 09:51:07\",\"updated_at\":\"2026-07-10 09:51:07\"},{\"id\":714,\"item_id\":1100,\"name\":\"itaque\",\"class\":\"Power Supply\",\"type\":\"Power\",\"unit\":\"Watts\",\"index\":\"Power\",\"reading\":730,\"last_polled\":\"0000-00-00 00:00:00\",\"configuration\":[],\"created_at\":\"2026-07-10 09:51:08\",\"updated_at\":\"2026-07-10 09:51:08\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/sensors?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/sensors\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show sensor", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/sensors\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/sensors\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the sensor." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Display detailed information about a single sensor by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":715,\"item_id\":1101,\"name\":\"accusantium\",\"class\":\"Power Supply\",\"type\":\"Thermal\",\"unit\":\"RPM\",\"index\":\"Thermal\",\"reading\":720,\"last_polled\":\"0000-00-00 00:00:00\",\"configuration\":[],\"created_at\":\"2026-07-10 09:51:09\",\"updated_at\":\"2026-07-10 09:51:09\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete Sensor", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/sensors\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/sensors\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "The ID of the sensor." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes the specified sensor from the system." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "Access Levels", "description": "", "item": [ { "name": "List Services Access Levels", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/service-access-levels", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, name.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, name, type.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/service-access-levels?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of access levels." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":60,\"name\":\"vero\",\"type\":\"Colocation\",\"default\":1,\"value\":\"a:5:{s:13:\\\"base_features\\\";a:5:{i:0;s:8:\\\"position\\\";i:1;s:5:\\\"label\\\";i:2;s:11:\\\"description\\\";i:3;s:8:\\\"location\\\";i:4;s:5:\\\"model\\\";}s:18:\\\"traffic_statistics\\\";a:5:{i:0;s:9:\\\"filtering\\\";i:1;s:17:\\\"left_sidebar_link\\\";i:2;s:17:\\\"widget_last_month\\\";i:3;s:23:\\\"widget_last_month_graph\\\";i:4;s:20:\\\"widget_network_ports\\\";}s:5:\\\"power\\\";a:6:{i:0;s:20:\\\"widget_average_usage\\\";i:1;s:17:\\\"left_sidebar_link\\\";i:2;s:23:\\\"widget_last_month_graph\\\";i:3;s:17:\\\"widget_last_month\\\";i:4;s:7:\\\"outlets\\\";i:5;s:9:\\\"filtering\\\";}s:4:\\\"ipam\\\";a:1:{i:0;s:30:\\\"ipam_widget_in_service_summary\\\";}s:11:\\\"dns-manager\\\";a:4:{i:0;s:11:\\\"create_rdns\\\";i:1;s:11:\\\"delete_rdns\\\";i:2;s:22:\\\"rdns_left_sidebar_link\\\";i:3;s:11:\\\"update_rdns\\\";}}\"},{\"id\":61,\"name\":\"tempore\",\"type\":\"Server\",\"default\":0,\"value\":\"a:5:{s:13:\\\"base_features\\\";a:5:{i:0;s:5:\\\"model\\\";i:1;s:8:\\\"position\\\";i:2;s:5:\\\"label\\\";i:3;s:11:\\\"description\\\";i:4;s:8:\\\"location\\\";}s:18:\\\"traffic_statistics\\\";a:5:{i:0;s:17:\\\"widget_last_month\\\";i:1;s:9:\\\"filtering\\\";i:2;s:20:\\\"widget_network_ports\\\";i:3;s:23:\\\"widget_last_month_graph\\\";i:4;s:17:\\\"left_sidebar_link\\\";}s:5:\\\"power\\\";a:6:{i:0;s:23:\\\"widget_last_month_graph\\\";i:1;s:9:\\\"filtering\\\";i:2;s:17:\\\"widget_last_month\\\";i:3;s:7:\\\"outlets\\\";i:4;s:20:\\\"widget_average_usage\\\";i:5;s:17:\\\"left_sidebar_link\\\";}s:4:\\\"ipam\\\";a:1:{i:0;s:30:\\\"ipam_widget_in_service_summary\\\";}s:11:\\\"dns-manager\\\";a:4:{i:0;s:11:\\\"delete_rdns\\\";i:1;s:11:\\\"update_rdns\\\";i:2;s:22:\\\"rdns_left_sidebar_link\\\";i:3;s:11:\\\"create_rdns\\\";}}\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/service-access-levels?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/service-access-levels\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "Devices", "description": "", "item": [ { "name": "List Devices", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/devices", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, model_id, order_id, parent_id, colocation_id, type_id, user_id, location_id, rack_id, provisioning_id, label, model, manufacturer, serialnumber1, serialnumber2, service_tag, description, comments, status, device_status, service_status, function, poller_disabled, locked, metadata.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, model_id, order_id, parent_id, colocation_id, type_id, user_id, location_id, rack_id, provisioning_id, label, model, manufacturer, serialnumber1, serialnumber2, service_tag, description, comments, status, device_status, service_status, function, poller_disabled, locked, metadata.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/devices?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of devices." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":1102,\"label\":\"eaque\",\"model\":\"cupiditate\",\"product_id\":0,\"model_id\":1593,\"parent_id\":0,\"type_id\":2027,\"user_id\":5621,\"order_id\":592,\"location_id\":3119,\"rack_id\":0,\"blade_id\":0,\"os_installation\":0,\"colocation_id\":0,\"provisioning_id\":0,\"manufacturer\":\"Gaylord LLC\",\"description\":\"Nulla distinctio optio voluptatibus autem.\",\"comments\":null,\"status\":\"available\",\"device_status\":\"running\",\"service_status\":\"activated\",\"function\":null,\"serialnumber1\":\"SN888FG\",\"serialnumber2\":null,\"service_tag\":\"ST909GT\",\"location\":\"Sporer-Braun\",\"metadata\":[],\"locked\":0,\"last_discovered\":\"Never\",\"discovery_time\":0,\"last_polled\":\"Never\",\"poller_disabled\":0,\"poller_time\":0,\"last_hour_traffic\":0,\"last_day_traffic\":0,\"last_week_traffic\":0,\"last_month_traffic\":0,\"current_month_traffic\":0,\"labeledRackWithPosition\":\"Unassigned<\/span>\",\"device_traffic\":null},{\"id\":1103,\"label\":\"a\",\"model\":\"officiis\",\"product_id\":0,\"model_id\":1595,\"parent_id\":0,\"type_id\":2029,\"user_id\":5628,\"order_id\":593,\"location_id\":3123,\"rack_id\":0,\"blade_id\":0,\"os_installation\":0,\"colocation_id\":0,\"provisioning_id\":0,\"manufacturer\":\"Denesik LLC\",\"description\":\"Esse accusamus ratione ut neque incidunt.\",\"comments\":null,\"status\":\"available\",\"device_status\":\"running\",\"service_status\":\"activated\",\"function\":null,\"serialnumber1\":\"SN120EE\",\"serialnumber2\":null,\"service_tag\":\"ST480VR\",\"location\":\"Pfannerstill, Barton and Jacobi\",\"metadata\":[],\"locked\":0,\"last_discovered\":\"Never\",\"discovery_time\":0,\"last_polled\":\"Never\",\"poller_disabled\":0,\"poller_time\":0,\"last_hour_traffic\":0,\"last_day_traffic\":0,\"last_week_traffic\":0,\"last_month_traffic\":0,\"current_month_traffic\":0,\"labeledRackWithPosition\":\"Unassigned<\/span>\",\"device_traffic\":null}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/devices?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/devices\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show Device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/devices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/devices\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the device." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Display detailed information about a single device by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":1104,\"product_id\":0,\"model_id\":1597,\"parent_id\":0,\"type_id\":2031,\"user_id\":5635,\"order_id\":594,\"location_id\":3127,\"rack_id\":0,\"blade_id\":0,\"os_installation\":0,\"colocation_id\":0,\"provisioning_id\":0,\"position\":null,\"image\":null,\"tags\":null,\"size\":1,\"size_position\":\"full\",\"data_ports\":0,\"power_supplies\":0,\"manufacturer\":\"Kilback Group\",\"serialnumber1\":\"SN565LU\",\"serialnumber2\":null,\"service_tag\":\"ST671DG\",\"comments\":null,\"label\":\"eos\",\"description\":\"Sit architecto voluptas ea.\",\"ip_addresses\":[],\"purchase_date\":\"2025-07-10\",\"warranty_months\":24,\"warranty_info\":null,\"status\":\"available\",\"is_service\":0,\"service_status\":\"activated\",\"device_status\":\"running\",\"function\":null,\"maintenance_instruction\":null,\"origin\":null,\"buy_price\":0,\"appdata\":false,\"notes\":null,\"locked\":0,\"last_discovered\":\"Never\",\"discovery_time\":0,\"last_polled\":\"Never\",\"poller_disabled\":0,\"poller_time\":0,\"last_hour_traffic\":0,\"last_day_traffic\":0,\"last_week_traffic\":0,\"last_month_traffic\":0,\"current_month_traffic\":0,\"labeledRackWithPosition\":\"Unassigned<\/span>\",\"metadata\":[],\"device_traffic\":null,\"type\":{\"id\":2031,\"name\":\"natus\",\"description\":\"Autem voluptatibus odio quae et vel doloribus.\",\"hardware\":1,\"software\":0,\"predefined\":1,\"color\":\"black\",\"created_at\":\"2026-07-10 09:51:15\",\"updated_at\":\"2026-07-10 09:51:15\"},\"model\":{\"id\":1597,\"name\":\"cumque\",\"label\":null,\"type_id\":2031,\"location_id\":0,\"status\":null,\"description\":null,\"is_part\":true,\"mountable\":false,\"manufacturer\":null,\"position\":null,\"size\":1,\"image\":null,\"data_ports\":null,\"serialnumber1\":null,\"serialnumber2\":null,\"service_tag\":null,\"comments\":null,\"notes\":null,\"purchase_date\":null,\"warranty_months\":null,\"warranty_info\":null,\"function\":null,\"maintenance_instruction\":null,\"origin\":null,\"buy_price\":null,\"appdata\":false,\"fields_data\":false,\"parts_data\":false,\"created_at\":\"2026-07-10T07:51:17.000000Z\",\"updated_at\":\"2026-07-10T07:51:17.000000Z\"},\"user\":{\"id\":5635,\"username\":\"vidal.kris\",\"email\":\"bradley15@example.com\",\"name\":\"Matt Terry\",\"firstname\":\"Matt\",\"lastname\":\"Terry\",\"gender\":\"0\",\"avatar\":\"\/\/www.gravatar.com\/avatar\/5e28ab40e5a3675aa9edb34111a6bc95?s=30&d=mm&r=g\",\"large_avatar\":\"\/\/www.gravatar.com\/avatar\/5e28ab40e5a3675aa9edb34111a6bc95?s=130&d=mm&r=g\",\"company\":null,\"active\":1,\"status\":\"Active\",\"address1\":null,\"address2\":null,\"city\":null,\"state\":null,\"postcode\":null,\"country_code\":null,\"country_name\":\"United States\",\"locale\":null,\"timezone\":0,\"last_login\":null},\"location\":{\"id\":3127,\"app_id\":null,\"name\":\"Abernathy-Klein\",\"address\":\"66387 Nona Forge\\nPiperberg, DC 06285-1644\",\"city\":\"Dickensstad\",\"state\":\"New Mexico\",\"description\":\"Voluptatem qui repellat eius iure. Et quisquam et nobis officia aut perferendis quisquam. Voluptas occaecati qui reiciendis nihil.\",\"notes\":\"Consequatur sit ad aperiam a fuga amet. Fugit itaque aut odio eius. Corporis sequi facilis sit perferendis et modi.\",\"emergency\":\"1\",\"phone\":\"(704) 771-9419\",\"flag\":\"Germany.png\",\"created_at\":\"2026-07-10 09:51:16\",\"updated_at\":\"2026-07-10 09:51:16\"},\"rack\":null,\"parent\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create Device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/devices", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/devices" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"label\":\"Intel Xeon\",\"model\":123,\"type_id\":1,\"parent\":10,\"location\":3,\"client\":5,\"rack\":7,\"position\":12,\"size\":1,\"size_position\":\"front\",\"is_part\":true,\"manufacturer\":\"Intel\",\"serialnumber1\":\"SN123456789\",\"service_tag\":\"ST987654\",\"comments\":\"Example comment\",\"description\":\"Intel Xeon server CPU with 8 cores\",\"purchase_date\":\"2025-09-17\",\"warranty_months\":36,\"warranty_info\":\"Standard 3-year warranty\",\"status\":\"available\",\"function\":\"Server CPU\",\"origin\":\"Warehouse A\",\"buy_price\":2500.5,\"appdata\":{\"key\":\"value\"},\"notes\":\"Needs firmware update\",\"provisioning_id\":1,\"metadata\":[{\"metadata_id\":37,\"value\":\"1\",\"raw_value\":\"1\"}]}" }, "description": "Store a new device in the system using validated request data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":1105,\"product_id\":0,\"model_id\":1599,\"parent_id\":0,\"type_id\":2033,\"user_id\":5642,\"order_id\":595,\"location_id\":3131,\"rack_id\":0,\"blade_id\":0,\"os_installation\":0,\"colocation_id\":0,\"provisioning_id\":0,\"position\":null,\"image\":null,\"tags\":null,\"size\":1,\"size_position\":\"full\",\"data_ports\":0,\"power_supplies\":0,\"manufacturer\":\"Kemmer-Block\",\"serialnumber1\":\"SN217CS\",\"serialnumber2\":null,\"service_tag\":\"ST953BB\",\"comments\":null,\"label\":\"ea\",\"description\":\"Distinctio sed molestias velit et maiores vel asperiores.\",\"ip_addresses\":[],\"purchase_date\":\"2025-07-10\",\"warranty_months\":24,\"warranty_info\":null,\"status\":\"available\",\"is_service\":0,\"service_status\":\"activated\",\"device_status\":\"running\",\"function\":null,\"maintenance_instruction\":null,\"origin\":null,\"buy_price\":0,\"appdata\":false,\"notes\":null,\"locked\":0,\"last_discovered\":\"Never\",\"discovery_time\":0,\"last_polled\":\"Never\",\"poller_disabled\":0,\"poller_time\":0,\"last_hour_traffic\":0,\"last_day_traffic\":0,\"last_week_traffic\":0,\"last_month_traffic\":0,\"current_month_traffic\":0,\"labeledRackWithPosition\":\"Unassigned<\/span>\",\"metadata\":[],\"device_traffic\":null,\"type\":{\"id\":2033,\"name\":\"sed\",\"description\":\"Aspernatur est expedita aperiam doloribus sint.\",\"hardware\":0,\"software\":0,\"predefined\":1,\"color\":\"navy\",\"created_at\":\"2026-07-10 09:51:17\",\"updated_at\":\"2026-07-10 09:51:17\"},\"model\":{\"id\":1599,\"name\":\"itaque\",\"label\":null,\"type_id\":2033,\"location_id\":0,\"status\":null,\"description\":null,\"is_part\":true,\"mountable\":false,\"manufacturer\":null,\"position\":null,\"size\":1,\"image\":null,\"data_ports\":null,\"serialnumber1\":null,\"serialnumber2\":null,\"service_tag\":null,\"comments\":null,\"notes\":null,\"purchase_date\":null,\"warranty_months\":null,\"warranty_info\":null,\"function\":null,\"maintenance_instruction\":null,\"origin\":null,\"buy_price\":null,\"appdata\":false,\"fields_data\":false,\"parts_data\":false,\"created_at\":\"2026-07-10T07:51:20.000000Z\",\"updated_at\":\"2026-07-10T07:51:20.000000Z\"},\"user\":{\"id\":5642,\"username\":\"wbraun\",\"email\":\"russel.zoie@example.org\",\"name\":\"Damon Rosenbaum\",\"firstname\":\"Damon\",\"lastname\":\"Rosenbaum\",\"gender\":\"0\",\"avatar\":\"\/\/www.gravatar.com\/avatar\/bbe7fcc88fddd292a6490e93445d3e7e?s=30&d=mm&r=g\",\"large_avatar\":\"\/\/www.gravatar.com\/avatar\/bbe7fcc88fddd292a6490e93445d3e7e?s=130&d=mm&r=g\",\"company\":null,\"active\":1,\"status\":\"Active\",\"address1\":null,\"address2\":null,\"city\":null,\"state\":null,\"postcode\":null,\"country_code\":null,\"country_name\":\"United States\",\"locale\":null,\"timezone\":0,\"last_login\":null},\"location\":{\"id\":3131,\"app_id\":null,\"name\":\"Cronin and Sons\",\"address\":\"801 Orn Street\\nPort Laurybury, DC 96615\",\"city\":\"Rolfsonfurt\",\"state\":\"Rhode Island\",\"description\":\"Amet eos et nostrum. Necessitatibus vel voluptatibus quis esse qui eum. Minus dolor quaerat ipsa vel omnis tempora.\",\"notes\":\"Quis illum praesentium hic officia consequatur est et. Atque veritatis a porro incidunt voluptatibus ut optio. Rerum omnis aut officiis ipsam.\",\"emergency\":\"0\",\"phone\":\"+1.818.915.6136\",\"flag\":\"UK.png\",\"created_at\":\"2026-07-10 09:51:18\",\"updated_at\":\"2026-07-10 09:51:18\"},\"rack\":null,\"parent\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update Device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/devices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/devices\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the device." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"label\":\"Intel Xeon\",\"model\":123,\"parent\":10,\"location\":3,\"client\":5,\"rack\":7,\"position\":12,\"size\":1,\"size_position\":\"front\",\"is_part\":true,\"manufacturer\":\"Intel\",\"serialnumber1\":\"SN123456789\",\"service_tag\":\"ST987654\",\"comments\":\"Example comment\",\"description\":\"Intel Xeon server CPU with 8 cores\",\"purchase_date\":\"2025-09-17\",\"warranty_months\":36,\"warranty_info\":\"Standard 3-year warranty\",\"status\":\"available\",\"function\":\"Server CPU\",\"origin\":\"Warehouse A\",\"buy_price\":2500.5,\"appdata\":{\"key\":\"value\"},\"notes\":\"Needs firmware update\",\"provisioning_id\":1,\"metadata\":[{\"metadata_id\":37,\"value\":\"1\",\"raw_value\":\"1\"}]}" }, "description": "Updates the specified device with provided data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":1106,\"product_id\":0,\"model_id\":1601,\"parent_id\":0,\"type_id\":2035,\"user_id\":5649,\"order_id\":596,\"location_id\":3135,\"rack_id\":0,\"blade_id\":0,\"os_installation\":0,\"colocation_id\":0,\"provisioning_id\":0,\"position\":null,\"image\":null,\"tags\":null,\"size\":1,\"size_position\":\"full\",\"data_ports\":0,\"power_supplies\":0,\"manufacturer\":\"Pfeffer, Abshire and Stokes\",\"serialnumber1\":\"SN439KP\",\"serialnumber2\":null,\"service_tag\":\"ST544FK\",\"comments\":null,\"label\":\"sequi\",\"description\":\"Omnis ea eligendi sed et ea itaque nam est.\",\"ip_addresses\":[],\"purchase_date\":\"2025-07-10\",\"warranty_months\":24,\"warranty_info\":null,\"status\":\"available\",\"is_service\":0,\"service_status\":\"activated\",\"device_status\":\"running\",\"function\":null,\"maintenance_instruction\":null,\"origin\":null,\"buy_price\":0,\"appdata\":false,\"notes\":null,\"locked\":0,\"last_discovered\":\"Never\",\"discovery_time\":0,\"last_polled\":\"Never\",\"poller_disabled\":0,\"poller_time\":0,\"last_hour_traffic\":0,\"last_day_traffic\":0,\"last_week_traffic\":0,\"last_month_traffic\":0,\"current_month_traffic\":0,\"labeledRackWithPosition\":\"Unassigned<\/span>\",\"metadata\":[],\"device_traffic\":null,\"type\":{\"id\":2035,\"name\":\"non\",\"description\":\"Rerum cum ducimus autem.\",\"hardware\":0,\"software\":0,\"predefined\":1,\"color\":\"purple\",\"created_at\":\"2026-07-10 09:51:20\",\"updated_at\":\"2026-07-10 09:51:20\"},\"model\":{\"id\":1601,\"name\":\"nemo\",\"label\":null,\"type_id\":2035,\"location_id\":0,\"status\":null,\"description\":null,\"is_part\":true,\"mountable\":false,\"manufacturer\":null,\"position\":null,\"size\":1,\"image\":null,\"data_ports\":null,\"serialnumber1\":null,\"serialnumber2\":null,\"service_tag\":null,\"comments\":null,\"notes\":null,\"purchase_date\":null,\"warranty_months\":null,\"warranty_info\":null,\"function\":null,\"maintenance_instruction\":null,\"origin\":null,\"buy_price\":null,\"appdata\":false,\"fields_data\":false,\"parts_data\":false,\"created_at\":\"2026-07-10T07:51:22.000000Z\",\"updated_at\":\"2026-07-10T07:51:22.000000Z\"},\"user\":{\"id\":5649,\"username\":\"nico86\",\"email\":\"xfarrell@example.com\",\"name\":\"Maureen Hahn\",\"firstname\":\"Maureen\",\"lastname\":\"Hahn\",\"gender\":\"0\",\"avatar\":\"\/\/www.gravatar.com\/avatar\/96fd3428892b23dea22747089290072a?s=30&d=mm&r=g\",\"large_avatar\":\"\/\/www.gravatar.com\/avatar\/96fd3428892b23dea22747089290072a?s=130&d=mm&r=g\",\"company\":null,\"active\":1,\"status\":\"Active\",\"address1\":null,\"address2\":null,\"city\":null,\"state\":null,\"postcode\":null,\"country_code\":null,\"country_name\":\"United States\",\"locale\":null,\"timezone\":0,\"last_login\":null},\"location\":{\"id\":3135,\"app_id\":null,\"name\":\"Prohaska, Hagenes and Orn\",\"address\":\"799 Kianna Rapids\\nStarkland, OH 16020\",\"city\":\"Rhiannaland\",\"state\":\"Nebraska\",\"description\":\"Commodi et non vel explicabo. Quia quia ipsam eos explicabo voluptatem.\",\"notes\":\"Nulla expedita repellendus sit nesciunt dolor. Assumenda aliquid vitae et beatae quam quia assumenda. Voluptas id eos nihil molestias a.\",\"emergency\":\"1\",\"phone\":\"+1.863.610.0264\",\"flag\":\"USA.png\",\"created_at\":\"2026-07-10 09:51:21\",\"updated_at\":\"2026-07-10 09:51:21\"},\"rack\":null,\"parent\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Assign Metadata To Device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/devices\/:id\/metadata\/assign", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/devices\/:id\/metadata\/assign", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the device." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"slug\":\"ipmi.ip\",\"value\":\"192.168.56.180\"}" }, "description": "Assigns metadata for specified device." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":1107,\"product_id\":0,\"model_id\":1603,\"parent_id\":0,\"type_id\":2037,\"user_id\":5656,\"order_id\":597,\"location_id\":3139,\"rack_id\":0,\"blade_id\":0,\"os_installation\":0,\"colocation_id\":0,\"provisioning_id\":0,\"position\":null,\"image\":null,\"tags\":null,\"size\":1,\"size_position\":\"full\",\"data_ports\":0,\"power_supplies\":0,\"manufacturer\":\"Murazik-Vandervort\",\"serialnumber1\":\"SN006WJ\",\"serialnumber2\":null,\"service_tag\":\"ST187EB\",\"comments\":null,\"label\":\"quibusdam\",\"description\":\"Eos sint quaerat aspernatur sapiente odit explicabo.\",\"ip_addresses\":[],\"purchase_date\":\"2025-07-10\",\"warranty_months\":24,\"warranty_info\":null,\"status\":\"available\",\"is_service\":0,\"service_status\":\"activated\",\"device_status\":\"running\",\"function\":null,\"maintenance_instruction\":null,\"origin\":null,\"buy_price\":0,\"appdata\":false,\"notes\":null,\"locked\":0,\"last_discovered\":\"Never\",\"discovery_time\":0,\"last_polled\":\"Never\",\"poller_disabled\":0,\"poller_time\":0,\"last_hour_traffic\":0,\"last_day_traffic\":0,\"last_week_traffic\":0,\"last_month_traffic\":0,\"current_month_traffic\":0,\"labeledRackWithPosition\":\"Unassigned<\/span>\",\"metadata\":[],\"device_traffic\":null,\"type\":{\"id\":2037,\"name\":\"voluptatum\",\"description\":\"Ut dicta provident cupiditate consequatur.\",\"hardware\":0,\"software\":0,\"predefined\":1,\"color\":\"olive\",\"created_at\":\"2026-07-10 09:51:23\",\"updated_at\":\"2026-07-10 09:51:23\"},\"model\":{\"id\":1603,\"name\":\"quod\",\"label\":null,\"type_id\":2037,\"location_id\":0,\"status\":null,\"description\":null,\"is_part\":true,\"mountable\":false,\"manufacturer\":null,\"position\":null,\"size\":1,\"image\":null,\"data_ports\":null,\"serialnumber1\":null,\"serialnumber2\":null,\"service_tag\":null,\"comments\":null,\"notes\":null,\"purchase_date\":null,\"warranty_months\":null,\"warranty_info\":null,\"function\":null,\"maintenance_instruction\":null,\"origin\":null,\"buy_price\":null,\"appdata\":false,\"fields_data\":false,\"parts_data\":false,\"created_at\":\"2026-07-10T07:51:25.000000Z\",\"updated_at\":\"2026-07-10T07:51:25.000000Z\"},\"user\":{\"id\":5656,\"username\":\"champlin.casimer\",\"email\":\"ruby.schimmel@example.org\",\"name\":\"Hilario Mayert\",\"firstname\":\"Hilario\",\"lastname\":\"Mayert\",\"gender\":\"0\",\"avatar\":\"\/\/www.gravatar.com\/avatar\/39ccf05a63e49497dc59fe757adaf043?s=30&d=mm&r=g\",\"large_avatar\":\"\/\/www.gravatar.com\/avatar\/39ccf05a63e49497dc59fe757adaf043?s=130&d=mm&r=g\",\"company\":null,\"active\":1,\"status\":\"Active\",\"address1\":null,\"address2\":null,\"city\":null,\"state\":null,\"postcode\":null,\"country_code\":null,\"country_name\":\"United States\",\"locale\":null,\"timezone\":0,\"last_login\":null},\"location\":{\"id\":3139,\"app_id\":null,\"name\":\"Kshlerin and Sons\",\"address\":\"7998 Jakubowski Row Apt. 892\\nVolkmanshire, SD 75229\",\"city\":\"Jerdeport\",\"state\":\"North Dakota\",\"description\":\"Iste asperiores quia et et enim dolorem eum. Ipsa perspiciatis nemo corrupti. Fuga porro facere similique eius perspiciatis. Saepe itaque eveniet magnam blanditiis.\",\"notes\":\"Porro quia dignissimos quo et. Enim adipisci qui maxime voluptate doloribus voluptas.\",\"emergency\":\"0\",\"phone\":\"386-529-4397\",\"flag\":\"Germany.png\",\"created_at\":\"2026-07-10 09:51:24\",\"updated_at\":\"2026-07-10 09:51:24\"},\"rack\":null,\"parent\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Force Polling", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/devices\/:id\/poll", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/devices\/:id\/poll", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the device." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Dispatches polling job for device." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Discover Device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/devices\/:id\/discover", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/devices\/:id\/discover", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the device." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"protocol\":\"SNMP\"}" }, "description": "Dispatches discovery job for device." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Perform Power Action", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/devices\/:id\/power\/action", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/devices\/:id\/power\/action", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the device." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"action\":\"boot\"}" }, "description": "Executes a power-related action on a device. This includes booting, rebooting, or shutting down the device." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Get Device Power Usage", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/devices\/:id\/power\/usage", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/devices\/:id\/power\/usage", "variable": [ { "id": "id", "key": "id", "value": "101", "description": "The ID of the device." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"startDate\":\"2024-01-01 00:00:00\",\"endDate\":\"2024-01-31 23:59:59\"}" }, "description": "Retrieves power usage data for a specific device. If a date range is provided, it returns detailed power data for that period. Otherwise, it returns historical usage data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"AVG_TOTAL_USAGE\":10,\"units\":\"Amps\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Get Device Bandwidth", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/devices\/:id\/bandwidth", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/devices\/:id\/bandwidth", "variable": [ { "id": "id", "key": "id", "value": "101", "description": "The ID of the device." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"startDate\":\"2024-01-01 00:00:00\",\"endDate\":\"2024-01-31 23:59:59\",\"units\":\"GB\",\"ports\":[12,100]}" }, "description": "Retrieves bandwidth usage for a specific device. If a date range is provided, it returns detailed traffic data for that period. Otherwise, it returns historical usage data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"raw\":{\"BW_TOTAL\":{\"rrd\":\"93.78 GB\",\"bytes\":93780000000},\"BW_IN\":{\"rrd\":\"43.04 GB\",\"bytes\":43040000000},\"BW_OUT\":{\"rrd\":\"50.74 GB\",\"bytes\":50740000000},\"95TH_PERC\":{\"rrd\":\"0.00\",\"bytes\":0},\"95TH_PERC_IN\":{\"rrd\":\"0.00\",\"bytes\":0},\"95TH_PERC_OUT\":{\"rrd\":\"0.00\",\"bytes\":0}},\"BW_TOTAL\":\"93.78\",\"BW_IN\":\"43.04\",\"BW_OUT\":\"50.74\",\"95TH_PERC\":\"0.00\",\"95TH_PERC_IN\":\"0.00\",\"95TH_PERC_OUT\":\"0.00\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete Device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/devices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/devices\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "The ID of the device." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes the specified device from the system." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "Graphs", "description": "", "item": [ { "name": "Export Graph", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/graphs\/:id\/export", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/graphs\/:id\/export", "variable": [ { "id": "id", "key": "id", "value": "42", "description": "The ID of the target." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"AggregateTraffic\",\"target\":\"service\",\"start\":\"2025-04-01 00:00:00\",\"end\":\"2025-04-30 23:59:59\",\"raw\":false,\"mode\":\"total\",\"device_ids\":[10],\"device_selection\":\"all\"}" }, "description": "Exports a graph data for a given target" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"datasets\":[{\"data\":[\"0.00186\",\"0.00000\",\"0.00231\",\"0.00231\",\"0.00228\",\"0.00229\",\"0.00006\",\"0.00219\",\"0.00245\",\"0.00336\",\"0.00337\",\"0.00191\",\"0.00000\"],\"dataset_name\":\"inboundtotal\"},{\"data\":[\"0.00045\",\"0.00046\",\"0.00321\",\"0.00321\",\"0.00000\",\"0.00232\",\"0.00198\",\"0.00193\",\"0.00036\",\"0.00036\",\"0.00145\",\"0.00286\",\"0.00000\"],\"dataset_name\":\"outboundtotal\"},{\"data\":[\"0.00232\",\"0.00046\",\"0.00552\",\"0.00552\",\"0.00228\",\"0.00461\",\"0.00204\",\"0.00412\",\"0.00281\",\"0.00372\",\"0.00482\",\"0.00478\",\"0.00000\"],\"dataset_name\":\"totalboundbits\"},{\"data\":[\"0.00336\",\"0.00336\",\"0.00336\",\"0.00336\",\"0.00336\",\"0.00336\",\"0.00336\",\"0.00336\",\"0.00336\",\"0.00336\",\"0.00336\",\"0.00336\",\"0.00336\"],\"dataset_name\":\"95_percentile\"}],\"labels\":[\"2025-10-21 13:35:00\",\"2025-10-21 13:40:00\",\"2025-10-21 13:45:00\",\"2025-10-21 13:50:00\",\"2025-10-21 13:55:00\",\"2025-10-21 14:00:00\",\"2025-10-21 14:05:00\",\"2025-10-21 14:10:00\",\"2025-10-21 14:15:00\",\"2025-10-21 14:20:00\",\"2025-10-21 14:25:00\",\"2025-10-21 14:30:00\",\"2025-10-21 14:35:00\"]},\"legend\":{\"header\":[\"Current\",\"Average\",\"Maximum\",\"95th %\"],\"rows\":[{\"label\":\"In\",\"color\":\"#62C45E\",\"values\":[632798.1868925721,1372582.1214573288,2053141.22367529,2053141.22367529]},{\"label\":\"Out\",\"color\":\"#2BA7FF\",\"values\":[639398.799042107,1396441.8722763401,1919831.1749942221,1919831.1749942221]}],\"format\":\"bits\",\"footer\":\"Total 670.81 GB (In 332.34 GB Out 338.47 GB)\"},\"units\":{\"traffic\":\"Mbps\",\"power_usage\":\"Amps\"},\"precision\":{\"traffic\":\"2\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "Remote Agents", "description": "", "item": [ { "name": "List Remote Agents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/remote-agents", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, name, status, created_at, updated_at.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, name, status, message.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/remote-agents?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of Remote Agents (Remote Applications)." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":857,\"name\":\"cum illo exercitationem\",\"status\":\"1\",\"message\":\"All Good!\",\"installed_version\":\"1.0\",\"created_at\":\"2026-07-10 09:51:26\",\"updated_at\":\"2026-07-10 09:51:26\"},{\"id\":858,\"name\":\"placeat facilis possimus\",\"status\":\"1\",\"message\":\"All Good!\",\"installed_version\":\"1.0\",\"created_at\":\"2026-07-10 09:51:26\",\"updated_at\":\"2026-07-10 09:51:26\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/remote-agents?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/remote-agents\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show Remote Agent", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/remote-agents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/remote-agents\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the Remote Agent." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Display detailed information about a single Remote Agent by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":859,\"name\":\"quia fugit omnis\",\"status\":\"1\",\"message\":\"All Good!\",\"installed_version\":\"1.0\",\"created_at\":\"2026-07-10 09:51:26\",\"updated_at\":\"2026-07-10 09:51:26\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create Remote Agent", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/remote-agents", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/remote-agents" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"host\":\"192.168.56.100\",\"apikey\":\"I4Vv1ZIgCXD6aykQF98kjuzG\",\"name\":\"Remote Agent #1\",\"pxe_ip\":\"192.168.56.101\"}" }, "description": "Creates a new Remote Agent with the specified configuration." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":860,\"name\":\"deleniti qui eveniet\",\"status\":\"1\",\"message\":\"All Good!\",\"installed_version\":\"1.0\",\"created_at\":\"2026-07-10 09:51:26\",\"updated_at\":\"2026-07-10 09:51:26\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete Remote Agent", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/remote-agents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/remote-agents\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "The ID of the Remote Agent." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes the specified Remote Agent from the system." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "List DHCP Subnets", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/remote-agents\/:id\/subnets", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, type, subnet, mask.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, type, subnet, gateway.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/remote-agents\/:id\/subnets?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the Remote Agent." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of DHCP subnets assigned to the given Remote Agent." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":50,\"type\":\"ipv4\",\"subnet\":\"75.64.51.120\",\"mask\":24,\"gateway\":\"46.7.199.76\"},{\"id\":51,\"type\":\"ipv4\",\"subnet\":\"28.234.112.41\",\"mask\":24,\"gateway\":\"38.48.143.76\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/remote-agents\/{id}\/subnets?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/remote-agents\/{id}\/subnets\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create DHCP Subnet", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/remote-agents\/:id\/subnets", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/remote-agents\/:id\/subnets", "variable": [ { "id": "id", "key": "id", "value": "eos", "description": "The ID of the remote agent." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"ipv4\",\"subnet\":\"10.10.10.0\",\"mask\":24,\"gateway\":\"10.10.10.1\",\"description\":\"DHCP range for rack A\"}" }, "description": "Creates a new DHCP subnet for the specified Remote Agent." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":52,\"type\":\"ipv4\",\"subnet\":\"136.185.228.160\",\"mask\":24,\"gateway\":\"11.191.38.97\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update DHCP Subnet", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/remote-agents\/:id\/subnets\/:subnetId", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/remote-agents\/:id\/subnets\/:subnetId", "variable": [ { "id": "id", "key": "id", "value": "suscipit", "description": "The ID of the remote agent." }, { "id": "subnetId", "key": "subnetId", "value": "veritatis", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"ipv4\",\"subnet\":\"10.10.10.0\",\"mask\":24,\"gateway\":\"10.10.10.1\",\"description\":\"DHCP range for rack A\"}" }, "description": "Updates an existing DHCP subnet configuration." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":53,\"type\":\"ipv4\",\"subnet\":\"45.234.191.43\",\"mask\":24,\"gateway\":\"32.49.22.216\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete DHCP Subnet", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/remote-agents\/:id\/subnets\/:subnetId", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/remote-agents\/:id\/subnets\/:subnetId", "variable": [ { "id": "id", "key": "id", "value": "eos", "description": "The ID of the remote agent." }, { "id": "subnetId", "key": "subnetId", "value": "numquam", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes a DHCP subnet assigned to a Remote Agent." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "OS Installation", "description": "", "item": [ { "name": "List ISO Images", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/isoimages", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, name, iso_url, status.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, name, iso_url, status.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/isoimages?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of ISO images" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":96,\"name\":\"autem-iso\",\"iso_url\":\"http:\/\/powlowski.org\/et-ea-tenetur-quo-perspiciatis-provident-enim\",\"status\":3,\"status_label\":\"Finished\",\"created_at\":\"2026-07-10 09:51:28\",\"updated_at\":\"2026-07-10 09:51:28\"},{\"id\":97,\"name\":\"sed-iso\",\"iso_url\":\"http:\/\/www.volkman.com\/\",\"status\":3,\"status_label\":\"Finished\",\"created_at\":\"2026-07-10 09:51:28\",\"updated_at\":\"2026-07-10 09:51:28\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/os\/isoimages?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/os\/isoimages\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show ISO Image", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/isoimages\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/isoimages\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the ISO image." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns detailed information about a specific ISO Image." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":98,\"name\":\"qui-iso\",\"iso_url\":\"http:\/\/www.white.com\/aspernatur-magnam-fugiat-voluptatem-molestias-et-enim\",\"status\":3,\"status_label\":\"Finished\",\"created_at\":\"2026-07-10 09:51:28\",\"updated_at\":\"2026-07-10 09:51:28\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create ISO Image", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/isoimages", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/isoimages" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Ubuntu Server ISO\",\"iso_url\":\"https:\\\/\\\/example.com\\\/images\\\/ubuntu.iso\",\"remoteApp\":[1],\"availability\":\"public\",\"users\":[1]}" }, "description": "Creates a new ISO image." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":99,\"name\":\"in-iso\",\"iso_url\":\"https:\/\/www.bruen.info\/aperiam-molestiae-pariatur-id-nulla\",\"status\":3,\"status_label\":\"Finished\",\"created_at\":\"2026-07-10 09:51:28\",\"updated_at\":\"2026-07-10 09:51:28\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update ISO Image", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/isoimages\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/isoimages\/:id", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "The ID of the ISO image to update." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Ubuntu Server ISO\",\"remoteApp\":[1],\"availability\":\"public\",\"users\":[1]}" }, "description": "Updates the name of an existing ISO image." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":100,\"name\":\"et-iso\",\"iso_url\":\"https:\/\/kris.com\/sint-doloremque-excepturi-soluta-in-numquam.html\",\"status\":2,\"status_label\":\"Started\",\"created_at\":\"2026-07-10 09:51:28\",\"updated_at\":\"2026-07-10 09:51:28\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete ISO Image", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/isoimages\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/isoimages\/:id", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "The ID of the ISO image to delete." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes a specific ISO image." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "List OS Templates", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/templates", "query": [ { "key": "with_addons", "value": "1", "description": "Optional. If set to true, includes a list of addons for each template.", "disabled": false }, { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, name, edition, architecture, family.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, name, edition, architecture, tags.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/templates?with_addons=1&per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Updated in 1.25.1<\/small>\nReturns a paginated list of OS templates.\n\nOptionally, you can include a list of addons (based on template tags) by using the `with_addons` query parameter." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":224,\"template_id\":224,\"name\":\"possimus\",\"server_id\":497,\"tags\":[\"aut\",\"repellendus\",\"atque\",\"autem\"],\"architecture\":\"arm\",\"cache_folder\":\"voluptates\",\"mirror\":\"http:\/\/zboncak.com\/nihil-ea-possimus-illo-numquam-quo\",\"edition\":\"eos\",\"iso_url\":\"http:\/\/www.braun.net\/\",\"tftp_url\":\"http:\/\/breitenberg.com\/\",\"license\":\"sed\",\"gpxe\":\"Molestiae placeat error recusandae officia ut.\",\"disk_layout\":\"Officia dolor aperiam deleniti.\",\"packages\":\"Et assumenda ratione cumque minima tenetur.\",\"post_installation\":\"Voluptatem aut molestias quia est.\",\"first_boot\":\"Sunt qui facere qui qui amet et provident optio.\",\"extras\":\"Sit amet consectetur vero quos ut.\",\"timezone\":\"America\/Montevideo\",\"language\":\"sk\",\"family\":\"\",\"is_windows\":false,\"is_rescue\":false,\"servers\":[{\"id\":497,\"app_id\":896,\"name\":\"Lexus Sauer\",\"module\":\"Remote Module\",\"configuration\":{\"app\":896,\"rebootmethod\":\"manual\",\"nameserver_1\":null,\"nameserver_2\":\"251.77.76.191\",\"rescue_template\":null,\"reinstall_template\":null,\"bootloader\":\"undionly.kpxe\"},\"enabled\":0},{\"id\":498,\"app_id\":897,\"name\":\"Rogers Bogan\",\"module\":\"Remote Module\",\"configuration\":{\"app\":897,\"rebootmethod\":\"pdu\",\"nameserver_1\":null,\"nameserver_2\":\"173.20.97.1\",\"rescue_template\":null,\"reinstall_template\":null,\"bootloader\":null},\"enabled\":0}],\"provisioning_profiles\":[]},{\"id\":225,\"template_id\":225,\"name\":\"numquam\",\"server_id\":499,\"tags\":[\"blanditiis\",\"odit\",\"neque\",\"reiciendis\",\"et\"],\"architecture\":\"arm\",\"cache_folder\":\"dolore\",\"mirror\":\"https:\/\/www.kessler.com\/quibusdam-accusantium-debitis-debitis-reprehenderit-quidem-aliquid\",\"edition\":\"repellendus\",\"iso_url\":\"http:\/\/www.runolfsdottir.com\/\",\"tftp_url\":\"https:\/\/grady.biz\/amet-facilis-in-et-esse.html\",\"license\":\"veritatis\",\"gpxe\":\"Sint culpa dicta officia voluptatibus et velit.\",\"disk_layout\":\"Dolore nulla occaecati quos velit asperiores iste.\",\"packages\":\"Cupiditate reprehenderit molestiae doloribus quia quia.\",\"post_installation\":\"Quia vel quam maiores quia placeat.\",\"first_boot\":\"Modi unde eligendi excepturi et.\",\"extras\":\"Similique nisi eos id.\",\"timezone\":\"Europe\/Dublin\",\"language\":\"zh\",\"family\":\"\",\"is_windows\":false,\"is_rescue\":false,\"servers\":[{\"id\":499,\"app_id\":898,\"name\":\"Miles Moore MD\",\"module\":\"Remote Module\",\"configuration\":{\"app\":898,\"rebootmethod\":\"ipmi_easy_uefi\",\"nameserver_1\":\"213.62.149.115\",\"nameserver_2\":\"225.85.209.108\",\"rescue_template\":null,\"reinstall_template\":null,\"bootloader\":null},\"enabled\":0},{\"id\":500,\"app_id\":899,\"name\":\"Frederique Stark\",\"module\":\"Remote Module\",\"configuration\":{\"app\":899,\"rebootmethod\":\"manual\",\"nameserver_1\":null,\"nameserver_2\":null,\"rescue_template\":null,\"reinstall_template\":null,\"bootloader\":null},\"enabled\":0}],\"provisioning_profiles\":[]}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/os\/templates?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/os\/templates\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show OS Template", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/templates\/:id", "query": [ { "key": "with_addons", "value": "1", "description": "Optional. If set to true, includes a list of addons for each template.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/templates\/:id?with_addons=1", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the template." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Updated in 1.25.1<\/small>\nReturns detailed information about a specific template.\n\nOptionally, you can include a list of addons (based on template tags) by using the `with_addons` query parameter." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":226,\"template_id\":226,\"name\":\"consequuntur\",\"server_id\":501,\"tags\":[\"nihil\",\"velit\",\"earum\"],\"architecture\":\"x64\",\"cache_folder\":\"odio\",\"mirror\":\"http:\/\/von.com\/\",\"edition\":\"impedit\",\"iso_url\":\"https:\/\/www.shanahan.net\/labore-velit-id-qui-voluptate-ea-vel-delectus-unde\",\"tftp_url\":\"http:\/\/www.weissnat.info\/\",\"license\":\"dolor\",\"gpxe\":\"Tenetur qui fugit blanditiis fuga suscipit est.\",\"disk_layout\":\"Quod quia unde vel possimus laudantium.\",\"packages\":\"Quia assumenda eum consequatur architecto maiores.\",\"post_installation\":\"Quae aliquam dolorem nulla voluptatum et.\",\"first_boot\":\"Voluptas iusto veritatis aut vel reprehenderit omnis et.\",\"extras\":\"Tenetur modi ut est eum libero deserunt cumque omnis.\",\"timezone\":\"Europe\/Amsterdam\",\"language\":\"mt\",\"family\":\"\",\"is_windows\":false,\"is_rescue\":false,\"servers\":[{\"id\":501,\"app_id\":900,\"name\":\"Ms. Emely Marquardt II\",\"module\":\"Remote Module\",\"configuration\":{\"app\":900,\"rebootmethod\":\"ipmi_easy\",\"nameserver_1\":null,\"nameserver_2\":null,\"rescue_template\":null,\"reinstall_template\":null,\"bootloader\":null},\"enabled\":0},{\"id\":502,\"app_id\":901,\"name\":\"Abdullah Murphy V\",\"module\":\"Remote Module\",\"configuration\":{\"app\":901,\"rebootmethod\":\"ipmi_easy\",\"nameserver_1\":null,\"nameserver_2\":null,\"rescue_template\":null,\"reinstall_template\":null,\"bootloader\":\"ipxe1.0.0undionly.kkpxe\"},\"enabled\":0}],\"provisioning_profiles\":[]}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create OS Template", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/templates", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/templates" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Ubuntu 24\",\"server\":[1],\"provisioning_profiles\":[3],\"tags\":\"windows custom\",\"architecture\":\"amd64\",\"cache_folder\":\"debian_bookworm\",\"mirror\":\"http:\\\/\\\/ftp.debian.org\\\/debian\",\"edition\":\"bookworm\",\"iso_url\":\"https:\\\/\\\/cdimage.debian.org\\\/cdimage\\\/unofficial\\\/non-free\\\/firmware\\\/bookworm\\\/current\\\/firmware.cpio.gz\",\"extract_iso\":false,\"timezone\":\"America\\\/Los_Angeles\",\"language\":\"en_US\",\"gpxe\":\"Example GPXE script\",\"disk_layout\":\"Example Disk Layout script\",\"packages\":\"Example Packages\",\"post_installation\":\"Example Post Installation script\",\"first_boot\":\"Example First Boot script\"}" }, "description": "Updated in 1.25.1<\/small>\nCreates a new template with the provided details." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":227,\"template_id\":227,\"name\":\"iste\",\"server_id\":503,\"tags\":[\"aut\",\"ut\",\"illum\",\"ea\",\"corrupti\"],\"architecture\":\"arm\",\"cache_folder\":\"distinctio\",\"mirror\":\"http:\/\/www.blick.com\/ad-neque-harum-sint-provident-sunt\",\"edition\":\"aut\",\"iso_url\":\"http:\/\/www.bayer.com\/\",\"tftp_url\":\"https:\/\/www.rippin.info\/sed-velit-cupiditate-sint-dolorum-pariatur-aut\",\"license\":\"nihil\",\"gpxe\":\"Optio rem qui cumque.\",\"disk_layout\":\"Nobis laboriosam corrupti est rem.\",\"packages\":\"Eveniet aut deleniti consequatur cum.\",\"post_installation\":\"Sequi rerum harum et suscipit quis debitis placeat.\",\"first_boot\":\"Ullam molestiae voluptatem illum suscipit unde quia impedit.\",\"extras\":\"Tempore praesentium deserunt cumque sapiente molestiae qui nihil.\",\"timezone\":\"Europe\/Ljubljana\",\"language\":\"lo\",\"family\":\"\",\"is_windows\":false,\"is_rescue\":false,\"servers\":[{\"id\":503,\"app_id\":902,\"name\":\"Prof. Bradly Reichert\",\"module\":\"Remote Module\",\"configuration\":{\"app\":902,\"rebootmethod\":\"ipmi_easy\",\"nameserver_1\":\"155.41.109.60\",\"nameserver_2\":\"2.185.147.172\",\"rescue_template\":null,\"reinstall_template\":null,\"bootloader\":null},\"enabled\":0},{\"id\":504,\"app_id\":903,\"name\":\"Tamia Stiedemann I\",\"module\":\"Remote Module\",\"configuration\":{\"app\":903,\"rebootmethod\":\"ipmi_easy_uefi\",\"nameserver_1\":\"70.63.147.113\",\"nameserver_2\":null,\"rescue_template\":null,\"reinstall_template\":null,\"bootloader\":null},\"enabled\":0}],\"provisioning_profiles\":[]}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update OS Template", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/templates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/templates\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the template." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Ubuntu 24\",\"server\":[1],\"provisioning_profiles\":[3],\"provisioning_addons\":[5],\"tags\":\"windows custom\",\"architecture\":\"amd64\",\"cache_folder\":\"debian_bookworm\",\"mirror\":\"http:\\\/\\\/ftp.debian.org\\\/debian\",\"edition\":\"bookworm\",\"iso_url\":\"https:\\\/\\\/cdimage.debian.org\\\/cdimage\\\/unofficial\\\/non-free\\\/firmware\\\/bookworm\\\/current\\\/firmware.cpio.gz\",\"extract_iso\":false,\"timezone\":\"America\\\/Los_Angeles\",\"language\":\"en_US\",\"gpxe\":\"Example GPXE script\",\"disk_layout\":\"Example Disk Layout script\",\"packages\":\"Example Packages\",\"post_installation\":\"Example Post Installation script\",\"first_boot\":\"Example First Boot script\"}" }, "description": "Updated in 1.25.1<\/small>\nUpdates template with the provided details and id." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":228,\"template_id\":228,\"name\":\"unde\",\"server_id\":505,\"tags\":[\"quibusdam\",\"consequuntur\",\"est\",\"assumenda\"],\"architecture\":\"x64\",\"cache_folder\":\"laudantium\",\"mirror\":\"http:\/\/gerhold.com\/officia-pariatur-rerum-aut-illo-deleniti.html\",\"edition\":\"qui\",\"iso_url\":\"http:\/\/koelpin.com\/cumque-quis-suscipit-exercitationem-ut\",\"tftp_url\":\"http:\/\/www.denesik.com\/voluptas-ea-tempora-commodi-aliquam-quia-autem-molestiae.html\",\"license\":\"perspiciatis\",\"gpxe\":\"Ut vel officia quibusdam est veniam aut asperiores.\",\"disk_layout\":\"Ea omnis in cum suscipit earum architecto saepe.\",\"packages\":\"Non et est et qui veritatis ducimus.\",\"post_installation\":\"Perspiciatis cum modi dignissimos laborum.\",\"first_boot\":\"Voluptatum ratione sint sed deserunt.\",\"extras\":\"Voluptas repellendus qui est provident dolore adipisci.\",\"timezone\":\"Pacific\/Wake\",\"language\":\"na\",\"family\":\"\",\"is_windows\":false,\"is_rescue\":false,\"servers\":[{\"id\":505,\"app_id\":904,\"name\":\"Nelle Wuckert\",\"module\":\"Remote Module\",\"configuration\":{\"app\":904,\"rebootmethod\":\"manual\",\"nameserver_1\":null,\"nameserver_2\":null,\"rescue_template\":null,\"reinstall_template\":null,\"bootloader\":\"vmware.kpxe\"},\"enabled\":1},{\"id\":506,\"app_id\":905,\"name\":\"Ms. Michaela Volkman\",\"module\":\"Remote Module\",\"configuration\":{\"app\":905,\"rebootmethod\":\"ipmi_easy_uefi\",\"nameserver_1\":null,\"nameserver_2\":null,\"rescue_template\":null,\"reinstall_template\":null,\"bootloader\":\"vmware.kpxe\"},\"enabled\":1}],\"provisioning_profiles\":[]}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete OS Template", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/templates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/templates\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the template." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes template with given id" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "List OS Addons", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/addons", "query": [ { "key": "template_id", "value": "14", "description": "Optional. If set returns filtered collection for provided OS Template id", "disabled": false }, { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, name, type.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, name, type, tag.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/addons?template_id=14&per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of OS addons." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":88,\"server_id\":507,\"name\":\"Maynard Feeney\",\"description\":\"Facilis libero dignissimos fugit et.\",\"type\":\"firstboot\",\"tag\":\"quisquam unde\",\"tags\":[\"quisquam\",\"unde\"],\"data\":\"Dolore corporis excepturi ut dolorem necessitatibus explicabo.\"},{\"id\":89,\"server_id\":508,\"name\":\"Prof. Susan Goldner MD\",\"description\":\"Qui illum consequatur aliquam beatae.\",\"type\":\"disklayout\",\"tag\":\"quia amet\",\"tags\":[\"quia\",\"amet\"],\"data\":\"Enim nihil cupiditate dolor.\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/os\/addons?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/os\/addons\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show OS Addon", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/addons\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/addons\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the addon." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns detailed information about a specific addon." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"id\":90,\"server_id\":509,\"name\":\"Larry McClure II\",\"description\":\"Consequatur ut quis qui quibusdam quos.\",\"type\":\"postinstall\",\"tag\":\"quibusdam quo\",\"tags\":[\"quibusdam\",\"quo\"],\"data\":\"Delectus nihil velit consequatur cumque.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create OS Addon", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/addons", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/addons" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"cpanel\",\"tag\":\"adipisci\",\"type\":\"disklayout\",\"description\":\"Install cPanel\",\"data\":\"Example addon script\"}" }, "description": "Creates a new addon with the provided details." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"id\":91,\"server_id\":510,\"name\":\"Dr. Rebeca Raynor\",\"description\":\"Ad quos voluptatem placeat deserunt doloribus nihil quisquam.\",\"type\":\"disklayout\",\"tag\":\"adipisci officia\",\"tags\":[\"adipisci\",\"officia\"],\"data\":\"Mollitia repellendus similique deserunt.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update OS Addon", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/addons\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/addons\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the addon." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"cpanel\",\"tag\":\"fugiat\",\"type\":\"disklayout\",\"description\":\"Install cPanel\",\"data\":\"Example addon script\"}" }, "description": "Updates addon with the provided details and id." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"id\":92,\"server_id\":511,\"name\":\"Linwood Rau\",\"description\":\"Ex magni sed quibusdam adipisci alias.\",\"type\":\"postinstall\",\"tag\":\"culpa qui\",\"tags\":[\"culpa\",\"qui\"],\"data\":\"Esse deleniti iusto possimus numquam.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete OS Addon", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/addons\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/addons\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the addon." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes addon with given id" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Install OS on Device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/:deviceId\/install", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/:deviceId\/install", "variable": [ { "id": "deviceId", "key": "deviceId", "value": "1", "description": "The ID of the device." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"template\":12,\"hostname\":\"server01.example.com\",\"username\":\"admin\",\"password\":\"secret123\",\"root_password\":\"rootsecret\",\"disk_addon\":1,\"extras\":[20],\"ssh_keys\":[12]}" }, "description": "Initiates OS installation on a device" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":194,\"device_id\":1111,\"template_id\":229,\"server_id\":512,\"message\":\"Ipsum adipisci doloribus quia ut quae quia.\",\"dhcp\":1,\"configuration\":[],\"log\":\"\",\"created_at\":\"2026-07-10 09:51:29\",\"updated_at\":\"2026-07-10 09:51:29\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Cancel OS Installation", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/:deviceId\/cancel", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/:deviceId\/cancel", "variable": [ { "id": "deviceId", "key": "deviceId", "value": "1", "description": "The ID of the device." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Attempts to cancel the operating system installation process" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "OS Installation Information", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/:deviceId\/install\/information", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/:deviceId\/install\/information", "variable": [ { "id": "deviceId", "key": "deviceId", "value": "1", "description": "The ID of the device." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns details about the current OS installation process" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":195,\"device_id\":1112,\"template_id\":230,\"server_id\":515,\"message\":\"Ducimus dolore doloremque quia quaerat.\",\"dhcp\":1,\"configuration\":[],\"log\":\"\",\"created_at\":\"2026-07-10 09:51:30\",\"updated_at\":\"2026-07-10 09:51:30\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Enable Rescue Mode", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/:deviceId\/rescue\/enable", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/:deviceId\/rescue\/enable", "variable": [ { "id": "deviceId", "key": "deviceId", "value": "1", "description": "The ID of the device." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Initiates rescue mode for the device" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":196,\"device_id\":1113,\"template_id\":231,\"server_id\":518,\"message\":\"Itaque consequuntur esse nobis corporis omnis incidunt.\",\"dhcp\":1,\"configuration\":[],\"log\":\"\",\"created_at\":\"2026-07-10 09:51:30\",\"updated_at\":\"2026-07-10 09:51:30\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Rescue Mode Status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/:deviceId\/rescue\/status", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/:deviceId\/rescue\/status", "variable": [ { "id": "deviceId", "key": "deviceId", "value": "1", "description": "The ID of the device." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the current rescue mode status" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"inRescueMode\":false}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show Device Configuration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/:deviceId\/configuration", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/:deviceId\/configuration", "variable": [ { "id": "deviceId", "key": "deviceId", "value": "1", "description": "The ID of the device." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Updated in 1.25.1<\/small>\nReturns device OS configuration." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"gateway\":\"192.168.56.1\",\"netmask\":\"255.255.255.0\",\"nameserver_1\":\"1.1.1.1\",\"nameserver_2\":\"8.8.8.8\",\"rebootmethod\":\"manual\",\"bootloader\":\"undionly.kpxe\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update Device Configuration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/:deviceId\/configuration", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/:deviceId\/configuration", "variable": [ { "id": "deviceId", "key": "deviceId", "value": "1", "description": "The ID of the device." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"gateway\":\"192.168.1.1\",\"netmask\":\"255.255.255.0\",\"nameserver_1\":\"8.8.8.8\",\"nameserver_2\":\"8.8.4.4\",\"rebootmethod\":\"ipmi_easy\",\"bootloader\":\"undionly.kpxe\",\"installation_lock\":\"1\"}" }, "description": "Updated in 1.25.1<\/small>\nUpdates device OS configuration with the provided details and id." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"gateway\":\"192.168.56.1\",\"netmask\":\"255.255.255.0\",\"nameserver_1\":\"1.1.1.1\",\"nameserver_2\":\"8.8.8.8\",\"rebootmethod\":\"manual\",\"bootloader\":\"undionly.kpxe\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Find OS provisioning server", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/:id\/provisioning\/server", "query": [ { "key": "find_by_type", "value": "device", "description": "Optional. One of location, device. If not set default to device.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/:id\/provisioning\/server?find_by_type=device", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the location or device." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns detailed information about provisioning server" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":521,\"app_id\":920,\"name\":\"Wilton Bruen DDS\",\"module\":\"Remote Module\",\"configuration\":{\"app\":920,\"rebootmethod\":\"ipmi_easy_uefi\",\"nameserver_1\":null,\"nameserver_2\":null,\"rescue_template\":null,\"reinstall_template\":null,\"bootloader\":null},\"enabled\":0}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "List provisioning tasks", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/provisioning\/tasks", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, device_id, server_id, template_id, message.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, device_id, server_id, template_id, message.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/provisioning\/tasks?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of provisioning tasks." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":197,\"device_id\":1114,\"template_id\":232,\"server_id\":522,\"message\":\"Laudantium harum ullam ducimus velit et eaque.\",\"dhcp\":1,\"configuration\":[],\"log\":\"\",\"created_at\":\"2026-07-10 09:51:30\",\"updated_at\":\"2026-07-10 09:51:30\"},{\"id\":198,\"device_id\":1115,\"template_id\":233,\"server_id\":525,\"message\":\"Ut ea sed id animi est sit autem.\",\"dhcp\":1,\"configuration\":[],\"log\":\"\",\"created_at\":\"2026-07-10 09:51:31\",\"updated_at\":\"2026-07-10 09:51:31\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/os\/provisioning\/tasks?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/os\/provisioning\/tasks\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "List provisioning history", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/provisioning\/history", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, device_id, server_id, status.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, device_id, server_id, status, template.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/provisioning\/history?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of provisioning history." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":129,\"device_id\":1116,\"server_id\":528,\"template\":\"Mateo Koch\",\"status\":\"\",\"log\":\"\",\"created_at\":\"2026-07-10 09:51:31\",\"updated_at\":\"2026-07-10 09:51:31\"},{\"id\":130,\"device_id\":1117,\"server_id\":529,\"template\":\"Dr. Athena Johns\",\"status\":\"\",\"log\":\"\",\"created_at\":\"2026-07-10 09:51:32\",\"updated_at\":\"2026-07-10 09:51:32\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/os\/provisioning\/history?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/os\/provisioning\/history\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "List Provisioning Profiles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/provisioning-profiles", "query": [ { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, name, type, version, predefined.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, uuid, name, description, type, version.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/provisioning-profiles?search_term=active%2Cpending&per_page=10&page=1&sort_by=id&sort_dir=asc&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of provisioning profiles." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":79,\"uuid\":\"fdbcee17-3b3a-3608-8f87-0fb2bd4c7bed\",\"name\":\"Unattend quidem\",\"description\":\"Aut rerum consectetur voluptas ullam.\",\"type\":{\"value\":\"unattend\",\"label\":\"Unattend (Windows)\"},\"version\":\"2.0\",\"predefined\":false,\"official\":false,\"installation_template\":\"unattend_rerum\",\"settings\":[],\"update_available\":false,\"latest_version\":null,\"created_at\":\"2026-07-10 09:51:32\",\"updated_at\":\"2026-07-10 09:51:32\"},{\"id\":80,\"uuid\":\"5c53dbf3-d990-37b5-9c8e-126622c1732e\",\"name\":\"Unattend error\",\"description\":\"Iure numquam dignissimos aut ipsam voluptatibus itaque quis.\",\"type\":{\"value\":\"unattend\",\"label\":\"Unattend (Windows)\"},\"version\":\"1.1\",\"predefined\":false,\"official\":false,\"installation_template\":\"unattend_inventore\",\"settings\":[],\"update_available\":false,\"latest_version\":null,\"created_at\":\"2026-07-10 09:51:32\",\"updated_at\":\"2026-07-10 09:51:32\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/os\/provisioning-profiles?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/os\/provisioning-profiles\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show Provisioning Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/provisioning-profiles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/provisioning-profiles\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the provisioning profile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns detailed information about a specific provisioning profile." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":81,\"uuid\":\"6ffc5064-a74a-39ec-924c-efc07ae917f1\",\"name\":\"Startnet vero\",\"description\":\"Nihil pariatur sapiente culpa aperiam.\",\"type\":{\"value\":\"startnet\",\"label\":\"Startnet (Windows)\"},\"version\":\"2.0\",\"predefined\":false,\"official\":false,\"installation_template\":\"startnet_minus\",\"settings\":[],\"update_available\":false,\"latest_version\":null,\"created_at\":\"2026-07-10 09:51:32\",\"updated_at\":\"2026-07-10 09:51:32\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create Provisioning Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/provisioning-profiles", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/provisioning-profiles" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Basic Kickstart\",\"description\":\"Default kickstart profile for Linux installations.\",\"type\":\"kickstart\",\"version\":\"1.0\",\"installation_template\":\"firstboot_linux_ssh_network\"}" }, "description": "Creates a new provisioning profile." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":82,\"uuid\":\"75548ad3-f96e-3837-a37b-4562d0d50ce5\",\"name\":\"Postinstall mollitia\",\"description\":\"Voluptas quae et voluptas et dolores est illo.\",\"type\":{\"value\":\"postinstall\",\"label\":\"PostInstall (Bootstrap script)\"},\"version\":\"1.0\",\"predefined\":false,\"official\":false,\"installation_template\":\"postinstall_aut\",\"settings\":[],\"update_available\":false,\"latest_version\":null,\"created_at\":\"2026-07-10 09:51:32\",\"updated_at\":\"2026-07-10 09:51:32\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update Provisioning Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/provisioning-profiles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/provisioning-profiles\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the provisioning profile." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Basic Kickstart\",\"description\":\"Updated description.\",\"type\":\"kickstart\",\"version\":\"1.1\",\"installation_template\":\"firstboot_linux_ssh_network\"}" }, "description": "Updates provisioning profile with the provided details." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete Provisioning Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/os\/provisioning-profiles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/os\/provisioning-profiles\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the provisioning profile." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes provisioning profile with given id." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "IPMI", "description": "", "item": [ { "name": "List Proxy Servers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipmi\/proxy\/servers", "query": [ { "key": "with_sessions", "value": "1", "description": "Optional. If set to true, includes a list of sessions for each proxy server.", "disabled": false }, { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, app_id, name.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, app_id, name.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipmi\/proxy\/servers?with_sessions=1&per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of proxy servers." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":104,\"app_id\":930,\"name\":\"Vance Olson\",\"locations\":[{\"id\":3188,\"app_id\":null,\"name\":\"Sanford Ltd\",\"address\":\"64583 Thaddeus Ridge Apt. 238\\nEast Myriamchester, IN 85466-2346\",\"city\":\"Pagacberg\",\"state\":\"Nebraska\",\"description\":\"Cumque ut soluta occaecati qui ipsa quaerat. Magnam velit nobis expedita autem. Adipisci ad et esse facere saepe est.\",\"notes\":\"Atque sed voluptatem perferendis quod molestiae incidunt rerum. Ipsa dolore eos aperiam ut voluptatem. Non est maxime deserunt voluptate.\",\"emergency\":\"1\",\"phone\":\"+1-667-467-9530\",\"flag\":\"Canada.png\",\"created_at\":\"2026-07-10 09:51:32\",\"updated_at\":\"2026-07-10 09:51:32\"},{\"id\":3189,\"app_id\":null,\"name\":\"Hirthe, Gutkowski and Kunde\",\"address\":\"4493 Prosacco Crossing Suite 958\\nWestleytown, VA 60342\",\"city\":\"South Melanybury\",\"state\":\"Connecticut\",\"description\":\"Enim voluptas neque maiores dicta. Minus rerum fuga mollitia doloremque. Ullam ad molestias deleniti veniam voluptatem nam.\",\"notes\":\"Dolorem voluptatum voluptatum officia eum odit nihil quis. Non omnis culpa saepe repellendus qui alias numquam. Laborum tenetur quia aut asperiores et. Quia cumque tempore in modi sint totam error.\",\"emergency\":\"0\",\"phone\":\"618.666.2113\",\"flag\":\"USA.png\",\"created_at\":\"2026-07-10 09:51:32\",\"updated_at\":\"2026-07-10 09:51:32\"}],\"configuration\":[]},{\"id\":105,\"app_id\":931,\"name\":\"Joanne Langworth V\",\"locations\":[{\"id\":3190,\"app_id\":null,\"name\":\"Gorczany and Sons\",\"address\":\"7390 Renner Court Suite 899\\nReichelview, AK 81912-1587\",\"city\":\"Lake Finnfurt\",\"state\":\"South Carolina\",\"description\":\"Dolorem aut corrupti nulla sit. Et expedita dolorem reiciendis enim laboriosam. Ipsam beatae itaque quasi provident ipsa perspiciatis perspiciatis.\",\"notes\":\"Dolorem distinctio doloremque incidunt. Rerum omnis deleniti ut qui. Sapiente quia molestias incidunt eum repudiandae.\",\"emergency\":\"0\",\"phone\":\"(458) 925-3772\",\"flag\":\"USA.png\",\"created_at\":\"2026-07-10 09:51:33\",\"updated_at\":\"2026-07-10 09:51:33\"},{\"id\":3191,\"app_id\":null,\"name\":\"Gerlach-Crooks\",\"address\":\"4538 Ettie Burgs Suite 928\\nNew Scottiefort, NH 80484-0571\",\"city\":\"West Giuseppeshire\",\"state\":\"South Carolina\",\"description\":\"Sunt dignissimos error impedit non blanditiis temporibus eos. Doloremque eum qui et ipsa suscipit. Blanditiis esse non quidem asperiores sequi et ut dolore. Explicabo non a officiis sunt est sint culpa minus.\",\"notes\":\"Enim quae neque eum. Culpa sed incidunt unde omnis. Expedita maxime distinctio ipsa et nihil. Aut quaerat omnis repellendus cumque et reiciendis.\",\"emergency\":\"1\",\"phone\":\"+1-234-708-5265\",\"flag\":\"UK.png\",\"created_at\":\"2026-07-10 09:51:33\",\"updated_at\":\"2026-07-10 09:51:33\"}],\"configuration\":[]}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipmi\/proxy\/servers?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipmi\/proxy\/servers\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show Proxy Server", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipmi\/proxy\/servers\/:id", "query": [ { "key": "with_sessions", "value": "1", "description": "Optional. If set to true, includes a list of sessions.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipmi\/proxy\/servers\/:id?with_sessions=1", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the proxy server." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns detailed information about a specific proxy server." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":106,\"app_id\":932,\"name\":\"Jan Jerde\",\"locations\":[{\"id\":3192,\"app_id\":null,\"name\":\"McLaughlin-Brakus\",\"address\":\"81780 Baumbach Street Suite 885\\nPort Joyceview, CA 98974-2985\",\"city\":\"New Kyliestad\",\"state\":\"Hawaii\",\"description\":\"Amet autem itaque quis repudiandae. Est accusamus corporis sit omnis. Blanditiis aut soluta et et maxime. Et sapiente voluptatem maxime ea et quae vero.\",\"notes\":\"Ut iusto dolores aliquam numquam neque. Nisi libero rem est consequatur voluptas. Mollitia et est quia natus.\",\"emergency\":\"0\",\"phone\":\"+1.724.484.1276\",\"flag\":\"Canada.png\",\"created_at\":\"2026-07-10 09:51:33\",\"updated_at\":\"2026-07-10 09:51:33\"},{\"id\":3193,\"app_id\":null,\"name\":\"Hartmann-Koelpin\",\"address\":\"5952 Rath Coves\\nRexview, SD 74622-1098\",\"city\":\"Lake Paolostad\",\"state\":\"Wyoming\",\"description\":\"Dolores eos qui ullam. Nostrum illo saepe velit tempora esse sit. Autem libero aut rerum repudiandae consequatur quos. Aperiam voluptatem alias qui magnam debitis illo ut.\",\"notes\":\"Doloremque voluptates nihil nam quas. Ipsam ut dolorum illo eum error impedit temporibus. Officia cupiditate quia unde cum.\",\"emergency\":\"1\",\"phone\":\"+1.570.505.4817\",\"flag\":\"UK.png\",\"created_at\":\"2026-07-10 09:51:33\",\"updated_at\":\"2026-07-10 09:51:33\"}],\"configuration\":[]}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create Proxy Server", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipmi\/proxy\/servers", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipmi\/proxy\/servers" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Main IPMI Proxy\",\"app_id\":12,\"location\":[5],\"proxy_type\":\"console\",\"java_version\":\"jdk1.8.0_121\",\"enable_firewall\":true,\"firewall_rules\":\"iptables -N ALLOW_ONLY\\n iptables -A OUTPUT -d {{:ipmi.ip}} -j ALLOW_ONLY\\n iptables -A ALLOW_ONLY -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT\\n iptables -A ALLOW_ONLY -p tcp --dport 80 -j ACCEPT\\n iptables -A ALLOW_ONLY -p tcp --dport 443 -j ACCEPT\\n iptables -A ALLOW_ONLY -p tcp --dport {{:ipmi.kvmport}} -j ACCEPT\\n iptables -A OUTPUT -j DROP\",\"disable_login_buttons\":false}" }, "description": "Creates a new proxy server with the provided details." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":107,\"app_id\":933,\"name\":\"Vernie Abernathy III\",\"locations\":[{\"id\":3194,\"app_id\":null,\"name\":\"Mohr and Sons\",\"address\":\"113 Dillon Stream Apt. 127\\nOkunevachester, MD 40645-7264\",\"city\":\"East Pinkiefurt\",\"state\":\"Florida\",\"description\":\"Reprehenderit adipisci qui sit ab consequatur tempora voluptas et. Modi dicta expedita in dolores earum minus cupiditate.\",\"notes\":\"Rerum ipsam quas veniam et. Voluptates similique eos error consequatur cum et. Commodi ut vel hic.\",\"emergency\":\"0\",\"phone\":\"1-480-531-1757\",\"flag\":\"Canada.png\",\"created_at\":\"2026-07-10 09:51:33\",\"updated_at\":\"2026-07-10 09:51:33\"},{\"id\":3195,\"app_id\":null,\"name\":\"Lehner PLC\",\"address\":\"17649 Okuneva Orchard Suite 792\\nVilmaberg, MD 80033\",\"city\":\"West Larue\",\"state\":\"Massachusetts\",\"description\":\"Quia illum quibusdam qui earum et. Error optio assumenda vero eos dolores. Esse tempora iure est. Autem nulla iure soluta.\",\"notes\":\"Doloribus dolores illum et esse neque atque. Quaerat perferendis et tempora. Reprehenderit quia facere consequatur repudiandae dolorum.\",\"emergency\":\"1\",\"phone\":\"+19493000851\",\"flag\":\"Canada.png\",\"created_at\":\"2026-07-10 09:51:33\",\"updated_at\":\"2026-07-10 09:51:33\"}],\"configuration\":[]}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update Proxy Server", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipmi\/proxy\/servers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipmi\/proxy\/servers\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the proxy server." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Main IPMI Proxy\",\"app_id\":12,\"location\":[3],\"proxy_type\":\"console\",\"java_version\":\"jdk1.8.0_121\",\"enable_firewall\":true,\"firewall_rules\":\"iptables -N ALLOW_ONLY\\n iptables -A OUTPUT -d {{:ipmi.ip}} -j ALLOW_ONLY\\n iptables -A ALLOW_ONLY -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT\\n iptables -A ALLOW_ONLY -p tcp --dport 80 -j ACCEPT\\n iptables -A ALLOW_ONLY -p tcp --dport 443 -j ACCEPT\\n iptables -A ALLOW_ONLY -p tcp --dport {{:ipmi.kvmport}} -j ACCEPT\\n iptables -A OUTPUT -j DROP\",\"disable_login_buttons\":false}" }, "description": "Updates proxy server with the provided details and id." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":108,\"app_id\":934,\"name\":\"Ron Rice\",\"locations\":[{\"id\":3196,\"app_id\":null,\"name\":\"Roob-Lesch\",\"address\":\"7153 Russel Throughway Apt. 975\\nIsmaelborough, TX 49248-5757\",\"city\":\"Coleborough\",\"state\":\"Alaska\",\"description\":\"Temporibus quae corrupti omnis non. Omnis repellendus sed aspernatur qui. Molestiae et laboriosam omnis porro quos nostrum cum architecto. Soluta mollitia maiores deserunt nam a consequuntur.\",\"notes\":\"Sit quibusdam est quisquam nihil vero odit. Sit et iusto sed in cupiditate error. Mollitia numquam explicabo qui eveniet. Quisquam iure rerum deserunt voluptatem porro nam eius.\",\"emergency\":\"1\",\"phone\":\"719.600.1081\",\"flag\":\"Canada.png\",\"created_at\":\"2026-07-10 09:51:33\",\"updated_at\":\"2026-07-10 09:51:33\"},{\"id\":3197,\"app_id\":null,\"name\":\"Bergnaum, Osinski and Ferry\",\"address\":\"7919 Ignatius Prairie\\nNikitamouth, IL 97934\",\"city\":\"New Rosetta\",\"state\":\"South Carolina\",\"description\":\"Velit molestiae doloribus tenetur reprehenderit. Qui dignissimos unde veniam voluptatem. Magnam voluptates iste praesentium suscipit. Ullam laboriosam beatae molestias ducimus.\",\"notes\":\"Ut est atque a eveniet deserunt. Exercitationem animi omnis consectetur sunt odit. Et qui ullam officiis hic numquam qui.\",\"emergency\":\"1\",\"phone\":\"1-585-532-8763\",\"flag\":\"Canada.png\",\"created_at\":\"2026-07-10 09:51:33\",\"updated_at\":\"2026-07-10 09:51:33\"}],\"configuration\":[]}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete Proxy Server", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipmi\/proxy\/servers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipmi\/proxy\/servers\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the addon." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes proxy server with given id" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "List Proxy Sessions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipmi\/proxy\/sessions", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, device_id, ipmi_proxy_id.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, device_id, ipmi_proxy_id.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipmi\/proxy\/sessions?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of proxy sessions." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":92,\"device_id\":1119,\"ipmi_proxy_id\":109,\"url\":\"https:\/\/192.168.203.150\/client\/console\/53103\/Bi8P3Gwd\/0f5e719ee4e08a9885f34ee128fc70767dc38536\",\"status\":1,\"message\":\"Vero et ipsam error cumque ut aut.\",\"log\":null},{\"id\":93,\"device_id\":1120,\"ipmi_proxy_id\":110,\"url\":\"https:\/\/192.168.203.150\/client\/console\/39452\/PJXMkeZd\/bf4f5d71d842dc8081d5c52784b8d532fbc75bbe\",\"status\":1,\"message\":\"Nemo maxime consectetur perferendis aliquid voluptate cumque non.\",\"log\":null}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipmi\/proxy\/sessions?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipmi\/proxy\/sessions\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show Proxy Session", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipmi\/proxy\/sessions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipmi\/proxy\/sessions\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the proxy session." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns detailed information about a specific proxy session." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":94,\"device_id\":1121,\"ipmi_proxy_id\":111,\"url\":\"https:\/\/192.168.203.150\/client\/console\/22640\/v4F3kIVD\/224455f2d04538de9b6b29398cbaad2f3edce294\",\"status\":1,\"message\":\"Magni explicabo consequatur inventore.\",\"log\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete Proxy Session", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipmi\/proxy\/sessions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipmi\/proxy\/sessions\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the proxy session." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes proxy session with given id" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Start noVNC Session", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipmi\/:deviceId\/novnc-connect", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipmi\/:deviceId\/novnc-connect", "variable": [ { "id": "deviceId", "key": "deviceId", "value": "1", "description": "The ID of the device." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Initiates a remote IPMI proxy session to the BMC of the device.\nThe proxy allows web-based access to the BMC for remote management tasks like KVM, virtual media, or BIOS configuration.\n\nIf a session cannot be established, an error with logs may be returned for debugging purposes." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":95,\"device_id\":1122,\"ipmi_proxy_id\":112,\"url\":\"https:\/\/192.168.203.150\/client\/console\/57490\/YwzcM49A\/9c03907f982a470a46aeabc300956f0c4f4a7954\",\"status\":1,\"message\":\"Iste corrupti dolores quia labore.\",\"log\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "IPMI Power Status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipmi\/:deviceId\/power-status", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipmi\/:deviceId\/power-status", "variable": [ { "id": "deviceId", "key": "deviceId", "value": "1", "description": "The ID of the device." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Checking IPMI power status of the device." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"status\":\"running\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "BMC Cold Reset", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipmi\/:deviceId\/bmc-reset-cold", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipmi\/:deviceId\/bmc-reset-cold", "variable": [ { "id": "deviceId", "key": "deviceId", "value": "1", "description": "The ID of the device." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Sends a cold reset command to the BMC (Baseboard Management Controller) of the device.\nThis action forces a full reboot of the BMC, which may temporarily interrupt device management features." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "IPMI Force Boot", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipmi\/:deviceId\/force-boot", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipmi\/:deviceId\/force-boot", "variable": [ { "id": "deviceId", "key": "deviceId", "value": "1", "description": "The ID of the device." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"force_pxe\"}" }, "description": "Added in 1.25.1<\/small>\nSets the boot flag that the device BMC should provide to the system firmware on boot.\nAccepted values: force_pxe, force_disk, force_safe, force_diag, force_cdrom, force_bios." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "IPMI Boot Status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipmi\/:deviceId\/boot-status", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipmi\/:deviceId\/boot-status", "variable": [ { "id": "deviceId", "key": "deviceId", "value": "1", "description": "The ID of the device." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Added in 1.25.1<\/small>\nReturns current chassis boot flags reported by the BMC." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "IP Address Management", "description": "", "item": [ { "name": "List of Subnets", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipam\/subnets", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, pool, mask, description, type, status, parent_id, vlan_id.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "mask", "description": "Optional. Restrict search to specific fields. Allowed: mask, description, type, status, parent_id, vlan_id.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipam\/subnets?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=mask" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of subnets" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":126,\"pool\":\"147.211.50.0\",\"mask\":24,\"type\":\"ipv4\",\"status\":\"available\",\"ns1\":null,\"ns2\":null,\"gateway\":null,\"is_master_pool\":0,\"description\":\"Est est dicta consequatur aut voluptas laborum.\",\"assignment\":false,\"tenants\":[],\"children\":[],\"parent\":null,\"vlan\":null,\"created_at\":\"2026-07-10 09:51:35\",\"updated_at\":\"2026-07-10 09:51:35\"},{\"id\":127,\"pool\":\"236.71.93.0\",\"mask\":24,\"type\":\"ipv4\",\"status\":\"available\",\"ns1\":null,\"ns2\":null,\"gateway\":null,\"is_master_pool\":0,\"description\":\"Eaque nihil aliquid deserunt rem asperiores consequuntur doloremque amet.\",\"assignment\":false,\"tenants\":[],\"children\":[],\"parent\":null,\"vlan\":null,\"created_at\":\"2026-07-10 09:51:35\",\"updated_at\":\"2026-07-10 09:51:35\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/subnets?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/subnets\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show Subnet", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipam\/subnets\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipam\/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": "Returns detailed information about a specific subnet." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":128,\"pool\":\"35.89.44.0\",\"mask\":24,\"type\":\"ipv4\",\"status\":\"available\",\"ns1\":null,\"ns2\":null,\"gateway\":null,\"is_master_pool\":0,\"description\":\"Tempora sint quas voluptates tempora.\",\"assignment\":false,\"excluded_ranges\":[],\"tenants\":[],\"children\":[],\"parent\":null,\"vlan\":null,\"ip_addresses\":{\"assigned_ips\":[],\"available_ranges\":[{\"start\":\"35.89.44.1\",\"end\":\"35.89.44.254\"}]},\"addressing\":{\"network_address\":\"35.89.44.0\",\"network_mask\":\"255.255.255.0\",\"wildcard_mask\":\"0.0.0.255\",\"broadcast_address\":\"35.89.44.255\",\"first_available_ip\":\"35.89.44.1\",\"utilization_percentage\":0,\"available_ips\":254,\"assigned_ips\":0,\"free_ips\":254},\"created_at\":\"2026-07-10 09:51:35\",\"updated_at\":\"2026-07-10 09:51:35\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create Subnet", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipam\/subnets", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipam\/subnets" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"pool\":\"192.168.56.100\",\"mask\":32,\"type\":\"ipv4\",\"description\":\"This is the description\",\"status\":\"available\",\"is_master_pool\":1,\"parent_id\":1,\"vlan_id\":2,\"tenant_type\":\"Modules\\\\Addons\\\\IPManager\\\\Model\\\\IpamDevice\",\"tenant_ids\":[1],\"assignment\":[\"location_1\"],\"excluded_ranges\":[\"192.168.1.10-192.168.1.20\"]}" }, "description": "Creates a new subnet with the provided details." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":129,\"pool\":\"62.252.100.0\",\"mask\":24,\"type\":\"ipv4\",\"status\":\"available\",\"ns1\":null,\"ns2\":null,\"gateway\":null,\"is_master_pool\":0,\"description\":\"Dolorem amet ut quia.\",\"assignment\":false,\"excluded_ranges\":[],\"tenants\":[],\"children\":[],\"parent\":null,\"vlan\":null,\"ip_addresses\":{\"assigned_ips\":[],\"available_ranges\":[{\"start\":\"62.252.100.1\",\"end\":\"62.252.100.254\"}]},\"addressing\":{\"network_address\":\"62.252.100.0\",\"network_mask\":\"255.255.255.0\",\"wildcard_mask\":\"0.0.0.255\",\"broadcast_address\":\"62.252.100.255\",\"first_available_ip\":\"62.252.100.1\",\"utilization_percentage\":0,\"available_ips\":254,\"assigned_ips\":0,\"free_ips\":254},\"created_at\":\"2026-07-10 09:51:35\",\"updated_at\":\"2026-07-10 09:51:35\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update Subnet", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipam\/subnets\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipam\/subnets\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the subnet." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"description\":\"This is the description\",\"status\":\"available\",\"is_master_pool\":1,\"parent_id\":1,\"vlan_id\":2,\"tenant_type\":\"Modules\\\\Addons\\\\IPManager\\\\Model\\\\IpamDevice\",\"tenant_ids\":[1],\"assignment\":[\"location_1\"],\"excluded_ranges\":[\"192.168.1.10-192.168.1.20\"]}" }, "description": "Updates subnet with the provided details and id." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":130,\"pool\":\"172.196.51.0\",\"mask\":24,\"type\":\"ipv4\",\"status\":\"available\",\"ns1\":null,\"ns2\":null,\"gateway\":null,\"is_master_pool\":0,\"description\":\"Enim eaque inventore suscipit est commodi.\",\"assignment\":false,\"excluded_ranges\":[],\"tenants\":[],\"children\":[],\"parent\":null,\"vlan\":null,\"ip_addresses\":{\"assigned_ips\":[],\"available_ranges\":[{\"start\":\"172.196.51.1\",\"end\":\"172.196.51.254\"}]},\"addressing\":{\"network_address\":\"172.196.51.0\",\"network_mask\":\"255.255.255.0\",\"wildcard_mask\":\"0.0.0.255\",\"broadcast_address\":\"172.196.51.255\",\"first_available_ip\":\"172.196.51.1\",\"utilization_percentage\":0,\"available_ips\":254,\"assigned_ips\":0,\"free_ips\":254},\"created_at\":\"2026-07-10 09:51:35\",\"updated_at\":\"2026-07-10 09:51:35\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Split Subnet", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipam\/subnets\/:id\/split", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipam\/subnets\/:id\/split", "variable": [ { "id": "id", "key": "id", "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": "{\"selected_mask\":32}" }, "description": "Splits subnet with given id." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":131,\"pool\":\"80.155.126.0\",\"mask\":24,\"type\":\"ipv4\",\"status\":\"available\",\"ns1\":null,\"ns2\":null,\"gateway\":null,\"is_master_pool\":0,\"description\":\"Et voluptatem culpa praesentium itaque quidem.\",\"assignment\":false,\"excluded_ranges\":[],\"tenants\":[],\"children\":[],\"parent\":null,\"vlan\":null,\"ip_addresses\":{\"assigned_ips\":[],\"available_ranges\":[{\"start\":\"80.155.126.1\",\"end\":\"80.155.126.254\"}]},\"addressing\":{\"network_address\":\"80.155.126.0\",\"network_mask\":\"255.255.255.0\",\"wildcard_mask\":\"0.0.0.255\",\"broadcast_address\":\"80.155.126.255\",\"first_available_ip\":\"80.155.126.1\",\"utilization_percentage\":0,\"available_ips\":254,\"assigned_ips\":0,\"free_ips\":254},\"created_at\":\"2026-07-10 09:51:35\",\"updated_at\":\"2026-07-10 09:51:35\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete Subnet", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipam\/subnets\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipam\/subnets\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the subnet." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes subnet with given id" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "List User Subnets", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipam\/user\/:id\/subnets", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, pool, mask, description, type, status, parent_id, vlan_id.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "mask", "description": "Optional. Restrict search to specific fields. Allowed: mask, description, type, status, parent_id, vlan_id.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipam\/user\/:id\/subnets?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=mask", "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": "Returns a paginated list of subnets for user" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":132,\"pool\":\"142.162.159.0\",\"mask\":24,\"type\":\"ipv4\",\"status\":\"available\",\"ns1\":null,\"ns2\":null,\"gateway\":null,\"is_master_pool\":0,\"description\":\"Eum eum sint aut sunt.\",\"assignment\":false,\"tenants\":[],\"children\":[],\"parent\":null,\"vlan\":null,\"created_at\":\"2026-07-10 09:51:35\",\"updated_at\":\"2026-07-10 09:51:35\"},{\"id\":133,\"pool\":\"82.162.134.0\",\"mask\":24,\"type\":\"ipv4\",\"status\":\"available\",\"ns1\":null,\"ns2\":null,\"gateway\":null,\"is_master_pool\":0,\"description\":\"Repellat tempore delectus et aut porro facere facere.\",\"assignment\":false,\"tenants\":[],\"children\":[],\"parent\":null,\"vlan\":null,\"created_at\":\"2026-07-10 09:51:35\",\"updated_at\":\"2026-07-10 09:51:35\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/user\/{id}\/subnets?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/user\/{id}\/subnets\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "List Device Subnets", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipam\/device\/:id\/subnets", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, pool, mask, description, type, status, parent_id, vlan_id.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "mask", "description": "Optional. Restrict search to specific fields. Allowed: mask, description, type, status, parent_id, vlan_id.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipam\/device\/:id\/subnets?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=mask", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the device." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of subnets for device" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":134,\"pool\":\"56.56.146.0\",\"mask\":24,\"type\":\"ipv4\",\"status\":\"available\",\"ns1\":null,\"ns2\":null,\"gateway\":null,\"is_master_pool\":0,\"description\":\"Architecto reiciendis doloremque fugiat.\",\"assignment\":false,\"tenants\":[],\"children\":[],\"parent\":null,\"vlan\":null,\"created_at\":\"2026-07-10 09:51:35\",\"updated_at\":\"2026-07-10 09:51:35\"},{\"id\":135,\"pool\":\"89.124.72.0\",\"mask\":24,\"type\":\"ipv4\",\"status\":\"available\",\"ns1\":null,\"ns2\":null,\"gateway\":null,\"is_master_pool\":0,\"description\":\"Vero quis neque voluptas pariatur sit.\",\"assignment\":false,\"tenants\":[],\"children\":[],\"parent\":null,\"vlan\":null,\"created_at\":\"2026-07-10 09:51:35\",\"updated_at\":\"2026-07-10 09:51:35\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/device\/{id}\/subnets?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/device\/{id}\/subnets\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Assign Subnets to Device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipam\/device\/:id\/subnets\/assign", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipam\/device\/:id\/subnets\/assign", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the device." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"subnets\":[1]}" }, "description": "Assigns Subnets to Device" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":1123,\"label\":\"voluptates\",\"model\":\"officiis\",\"product_id\":0,\"model_id\":1619,\"parent_id\":0,\"type_id\":2069,\"user_id\":5801,\"order_id\":613,\"location_id\":3223,\"rack_id\":651,\"blade_id\":0,\"os_installation\":0,\"colocation_id\":0,\"provisioning_id\":0,\"manufacturer\":\"Schimmel-Boyle\",\"description\":\"Nihil iste omnis ut rem labore.\",\"comments\":null,\"status\":\"available\",\"device_status\":\"running\",\"service_status\":\"activated\",\"function\":null,\"serialnumber1\":\"SN125ID\",\"serialnumber2\":null,\"service_tag\":\"ST557OM\",\"location\":\"Pagac-Ruecker\",\"metadata\":[],\"locked\":0,\"last_discovered\":\"Never\",\"discovery_time\":0,\"last_polled\":\"Never\",\"poller_disabled\":0,\"poller_time\":0,\"last_hour_traffic\":0,\"last_day_traffic\":0,\"last_week_traffic\":0,\"last_month_traffic\":0,\"current_month_traffic\":0,\"labeledRackWithPosition\":\"Unassigned<\/span>\",\"device_traffic\":null,\"subnets\":[]}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Unassign Subnets to Device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipam\/device\/:id\/subnets\/unassign", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipam\/device\/:id\/subnets\/unassign", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the device." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"subnets\":[1]}" }, "description": "Unassigns Subnets to Device" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":1124,\"label\":\"assumenda\",\"model\":\"maiores\",\"product_id\":0,\"model_id\":1620,\"parent_id\":0,\"type_id\":2071,\"user_id\":5808,\"order_id\":614,\"location_id\":3227,\"rack_id\":652,\"blade_id\":0,\"os_installation\":0,\"colocation_id\":0,\"provisioning_id\":0,\"manufacturer\":\"Swift Inc\",\"description\":\"Voluptatem explicabo nam quae voluptate.\",\"comments\":null,\"status\":\"available\",\"device_status\":\"running\",\"service_status\":\"activated\",\"function\":null,\"serialnumber1\":\"SN702GV\",\"serialnumber2\":null,\"service_tag\":\"ST054CK\",\"location\":\"Murray, Smitham and Beer\",\"metadata\":[],\"locked\":0,\"last_discovered\":\"Never\",\"discovery_time\":0,\"last_polled\":\"Never\",\"poller_disabled\":0,\"poller_time\":0,\"last_hour_traffic\":0,\"last_day_traffic\":0,\"last_week_traffic\":0,\"last_month_traffic\":0,\"current_month_traffic\":0,\"labeledRackWithPosition\":\"Unassigned<\/span>\",\"device_traffic\":null,\"subnets\":[]}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "List of IP addresses", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipam\/ips", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, item_id, value, description, type, ip_type.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "value", "description": "Optional. Restrict search to specific fields. Allowed: value, description, type, ip_type.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipam\/ips?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=value" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint returns a paginated collection of IP addresses" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":265,\"item_id\":38,\"device_label\":\"#38 web-prod-01 (PowerEdge R640)\",\"value\":\"200.94.209.231\",\"description\":\"\",\"type\":\"primary\",\"ip_type\":\"ipv4\",\"subnet\":{\"id\":12,\"pool\":\"200.94.209.0\",\"mask\":24,\"cidr\":\"200.94.209.0\/24\"},\"vlan\":{\"id\":7,\"name\":\"Production\",\"vlan_id\":100}},{\"id\":307,\"item_id\":44,\"value\":\"146.224.170.224\",\"description\":\"\",\"type\":\"primary\",\"ip_type\":\"ipv4\"},{\"id\":314,\"item_id\":45,\"value\":\"139.235.236.138\",\"description\":\"\",\"type\":\"primary\",\"ip_type\":\"ipv4\"},{\"id\":328,\"item_id\":47,\"value\":\"207.243.68.21\",\"description\":\"\",\"type\":\"primary\",\"ip_type\":\"ipv4\"},{\"id\":335,\"item_id\":48,\"value\":\"46.236.68.242\",\"description\":\"\",\"type\":\"primary\",\"ip_type\":\"ipv4\"},{\"id\":342,\"item_id\":49,\"value\":\"166.73.24.58\",\"description\":\"\",\"type\":\"primary\",\"ip_type\":\"ipv4\"},{\"id\":356,\"item_id\":51,\"value\":\"160.24.83.37\",\"description\":\"\",\"type\":\"primary\",\"ip_type\":\"ipv4\"},{\"id\":363,\"item_id\":52,\"value\":\"80.24.122.22\",\"description\":\"\",\"type\":\"primary\",\"ip_type\":\"ipv4\"},{\"id\":370,\"item_id\":53,\"value\":\"174.251.45.79\",\"description\":\"\",\"type\":\"primary\",\"ip_type\":\"ipv4\"},{\"id\":377,\"item_id\":54,\"value\":\"155.150.252.1\",\"description\":\"\",\"type\":\"primary\",\"ip_type\":\"ipv4\"}],\"links\":{\"first\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=1\",\"last\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=16\",\"prev\":null,\"next\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=2\"},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":16,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=2\",\"label\":\"2\",\"page\":2,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=3\",\"label\":\"3\",\"page\":3,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=4\",\"label\":\"4\",\"page\":4,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=5\",\"label\":\"5\",\"page\":5,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=6\",\"label\":\"6\",\"page\":6,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=7\",\"label\":\"7\",\"page\":7,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=8\",\"label\":\"8\",\"page\":8,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=9\",\"label\":\"9\",\"page\":9,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=10\",\"label\":\"10\",\"page\":10,\"active\":false},{\"url\":null,\"label\":\"...\",\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=15\",\"label\":\"15\",\"page\":15,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=16\",\"label\":\"16\",\"page\":16,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=2\",\"label\":\"Next »\",\"page\":2,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips\",\"per_page\":10,\"to\":10,\"total\":151,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update IP address description", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipam\/ips\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipam\/ips\/:id", "variable": [ { "id": "id", "key": "id", "value": "456", "description": "The ID of the IP address entity." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"description\":\"Primary IP for web server\",\"ip_address\":\"192.168.56.1\"}" }, "description": "Updates the description of an IP address entity" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "List of VLANs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipam\/vlans", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, vlan_vlan, vlan_name, vlan_type, vlan_status, description, device_id.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "vlan_vlan", "description": "Optional. Restrict search to specific fields. Allowed: vlan_vlan, vlan_name, vlan_type, vlan_status, description, device_id.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipam\/vlans?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=vlan_vlan" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint returns a paginated collection of VLANs" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":63,\"device_id\":null,\"vlan_vlan\":90,\"vlan_name\":\"dolore cupiditate\",\"description\":\"Quos distinctio inventore fugiat at rerum beatae alias velit.\",\"vlan_type\":\"standard\",\"vlan_status\":\"reserved\",\"device\":null},{\"id\":64,\"device_id\":null,\"vlan_vlan\":410,\"vlan_name\":\"aut aperiam\",\"description\":\"Eos suscipit voluptatibus inventore.\",\"vlan_type\":\"standard\",\"vlan_status\":\"active\",\"device\":null}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/vlans?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/vlans\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show VLAN", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipam\/vlans\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipam\/vlans\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the vlan." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns detailed information about a specific VLAN." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":65,\"device_id\":null,\"vlan_vlan\":4046,\"vlan_name\":\"architecto similique\",\"description\":\"Saepe optio dolores ut qui repellendus mollitia.\",\"vlan_type\":\"standard\",\"vlan_status\":\"reserved\",\"device\":null,\"ports\":[]}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create VLAN", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipam\/vlans", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipam\/vlans" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"device_id\":1,\"vlan_vlan\":1001,\"vlan_name\":\"VLAN 1001\",\"vlan_type\":\"standard\",\"status\":\"active\",\"description\":\"This is the description of the vlan.\"}" }, "description": "Creates a new vlan with the provided details." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":66,\"device_id\":null,\"vlan_vlan\":3120,\"vlan_name\":\"quis qui\",\"description\":\"Commodi necessitatibus sit rerum repellendus temporibus.\",\"vlan_type\":\"standard\",\"vlan_status\":\"reserved\",\"device\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update VLAN", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipam\/vlans\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipam\/vlans\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the vlan." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"vlan_type\":\"standard\",\"status\":\"active\",\"description\":\"This is the description of the vlan.\"}" }, "description": "Updates vlan with the provided details and id." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":67,\"device_id\":null,\"vlan_vlan\":3224,\"vlan_name\":\"aut ut\",\"description\":\"Adipisci odit iusto unde.\",\"vlan_type\":\"provisioning\",\"vlan_status\":\"depreciated\",\"device\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete VLAN", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/ipam\/vlans\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/ipam\/vlans\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the vlan." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes vlan with given id" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "DNS Management", "description": "", "item": [ { "name": "List rDNS records", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/dns-manager\/rdns", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, device_id, user_id, server_id, ip, from, name, ttl.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, device_id, user_id, server_id, ip, from, name.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/dns-manager\/rdns?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint returns a paginated list of reverse DNS (rDNS) entries" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":63,\"device_id\":1127,\"user_id\":5837,\"server_id\":93,\"ip\":\"194.228.249.136\",\"from\":\"corkery.info\",\"name\":\"schuster.com\",\"ttl\":\"3600\",\"created_at\":\"2026-07-10 09:51:38\",\"updated_at\":\"2026-07-10 09:51:38\"},{\"id\":64,\"device_id\":1128,\"user_id\":5845,\"server_id\":94,\"ip\":\"78.175.249.80\",\"from\":\"robel.net\",\"name\":\"hudson.com\",\"ttl\":\"3600\",\"created_at\":\"2026-07-10 09:51:38\",\"updated_at\":\"2026-07-10 09:51:38\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/dns-manager\/rdns?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/dns-manager\/rdns\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create rDNS record", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/dns-manager\/rdns", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/dns-manager\/rdns" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ip\":\"192.168.1.1\",\"rdata\":\"example.mydomain.com\",\"device_id\":1,\"ttl\":3600}" }, "description": "Stores a new reverse DNS (rDNS) entry" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":65,\"device_id\":1129,\"user_id\":5853,\"server_id\":95,\"ip\":\"126.196.13.245\",\"from\":\"cremin.com\",\"name\":\"flatley.com\",\"ttl\":\"3600\",\"created_at\":\"2026-07-10 09:51:39\",\"updated_at\":\"2026-07-10 09:51:39\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update rDNS record", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/dns-manager\/rdns\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/dns-manager\/rdns\/:id", "variable": [ { "id": "id", "key": "id", "value": "456", "description": "The ID of the rDNS record." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"rdata\":\"updated.example.net\",\"ttl\":3600}" }, "description": "Updates an existing reverse DNS (rDNS) record." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":66,\"device_id\":1130,\"user_id\":5861,\"server_id\":96,\"ip\":\"62.48.36.209\",\"from\":\"cassin.org\",\"name\":\"johnston.com\",\"ttl\":\"3600\",\"created_at\":\"2026-07-10 09:51:39\",\"updated_at\":\"2026-07-10 09:51:39\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete rDNS record", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/dns-manager\/rdns\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/dns-manager\/rdns\/:id", "variable": [ { "id": "id", "key": "id", "value": "456", "description": "The ID of the rDNS record." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes a reverse DNS (rDNS) record." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "List Zones", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/dns-manager\/zones", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, device_id, server_id, ip, name.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, device_id, server_id, ip, name.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/dns-manager\/zones?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint returns a paginated list of zones" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":31,\"device_id\":1131,\"server_id\":97,\"ip\":\"7.19.139.67\",\"name\":\"hirthe.net\",\"created_at\":\"2026-07-10 09:51:40\",\"updated_at\":\"2026-07-10 09:51:40\"},{\"id\":32,\"device_id\":1132,\"server_id\":98,\"ip\":\"135.228.1.46\",\"name\":\"lesch.info\",\"created_at\":\"2026-07-10 09:51:40\",\"updated_at\":\"2026-07-10 09:51:40\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/dns-manager\/zones?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/dns-manager\/zones\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create Zone", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/dns-manager\/zones", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/dns-manager\/zones" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ip\":\"192.168.1.1\",\"name\":\"example.mydomain.com\",\"device_id\":1,\"server_id\":1}" }, "description": "Stores a new zone" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":33,\"device_id\":1133,\"server_id\":99,\"ip\":\"50.78.96.71\",\"name\":\"barrows.com\",\"created_at\":\"2026-07-10 09:51:40\",\"updated_at\":\"2026-07-10 09:51:40\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete Zone", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/dns-manager\/zones\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/dns-manager\/zones\/:id", "variable": [ { "id": "id", "key": "id", "value": "13", "description": "The ID of the zone." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes a zone record." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Get Zone Records", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/dns-manager\/zones\/:id\/records", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/dns-manager\/zones\/:id\/records", "variable": [ { "id": "id", "key": "id", "value": "11", "description": "The ID of the zone." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint returns a zone records with zone information for given id" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":1,\"device_id\":38,\"server_id\":3,\"ip\":null,\"name\":\"1.168.192.in-addr.arpa\",\"records\":[{\"line\":\"4\",\"name\":\"1.168.192.in-addr.arpa.\",\"type\":\"SOA\",\"class\":\"IN\",\"ttl\":\"86400\",\"rdlength\":null,\"rdata\":{\"mname\":\"ns1.55-33-166-35.cprapid.com\",\"rname\":\"test.com\",\"serial\":\"2025090900\",\"refresh\":\"3600\",\"retry\":\"1800\",\"expire\":\"1209600\",\"minimum\":\"86400\"}},{\"line\":\"10\",\"name\":\"1.168.192.in-addr.arpa.\",\"type\":\"NS\",\"class\":\"IN\",\"ttl\":\"86400\",\"rdlength\":null,\"rdata\":{\"nsdname\":\"ns1.55-33-166-35.cprapid.com\"}},{\"line\":\"11\",\"name\":\"1.168.192.in-addr.arpa.\",\"type\":\"NS\",\"class\":\"IN\",\"ttl\":\"86400\",\"rdlength\":null,\"rdata\":{\"nsdname\":\"ns2.55-33-166-35.cprapid.com\"}},{\"line\":\"12\",\"name\":\"1.168.192.in-addr.arpa.\",\"type\":\"A\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"address\":\"55.33.166.35\"}},{\"line\":\"13\",\"name\":\"1.168.192.in-addr.arpa.\",\"type\":\"MX\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"preference\":\"0\",\"exchange\":\"1.168.192.in-addr.arpa\"}},{\"line\":\"14\",\"name\":\"mail.1.168.192.in-addr.arpa.\",\"type\":\"CNAME\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"cname\":\"1.168.192.in-addr.arpa\"}},{\"line\":\"15\",\"name\":\"www.1.168.192.in-addr.arpa.\",\"type\":\"CNAME\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"cname\":\"1.168.192.in-addr.arpa\"}},{\"line\":\"16\",\"name\":\"ftp.1.168.192.in-addr.arpa.\",\"type\":\"CNAME\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"cname\":\"1.168.192.in-addr.arpa\"}},{\"line\":\"17\",\"name\":\"0.1.168.192.in-addr.arpa.\",\"type\":\"PTR\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"ptrdname\":\"test.com\"}},{\"line\":\"18\",\"name\":\"test.1.168.192.in-addr.arpa.\",\"type\":\"A\",\"class\":\"IN\",\"ttl\":\"3600\",\"rdlength\":null,\"rdata\":{\"address\":\"10.10.10.1\"}}],\"created_at\":\"2025-02-28 13:32:26\",\"updated_at\":\"2025-02-28 13:32:26\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Add Zone Record", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/dns-manager\/zones\/:id\/records\/create", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/dns-manager\/zones\/:id\/records\/create", "variable": [ { "id": "id", "key": "id", "value": "11", "description": "The ID of the zone." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"www\",\"type\":\"A\",\"ttl\":3600,\"fields\":{\"A\":{\"address\":\"192.0.2.1\"},\"AAAA\":{\"address\":\"2001:db8::1\"},\"AFSDB\":{\"subtype\":1,\"hostname\":\"host.example.com\"},\"CNAME\":{\"cname\":\"example.com\"},\"DEF\":{\"value\":\"Some value\"},\"DNAME\":{\"target\":\"example.com\"},\"DS\":{\"keytag\":12345,\"algorithm\":8,\"digesttype\":1,\"digest\":\"49FD46E6C4B45C55D4AC\"},\"HINFO\":{\"cpu\":\"Intel\",\"os\":\"Linux\"},\"ISDN\":{\"isdnaddress\":\"+1-555-1234567\",\"sa\":\"123\"},\"LOC\":{\"version\":0,\"size\":1,\"horiz_pre\":100,\"vert_pre\":10,\"latitude\":\"52 22 23.0 N\",\"longitude\":\"4 53 32.0 E\",\"altitude\":5},\"MB\":{\"madname\":\"mail.example.com\"},\"MD\":{\"madname\":\"mail.example.com\"},\"MF\":{\"madname\":\"forwarder.example.com\"},\"MG\":{\"mgmname\":\"member.example.com\"},\"MINFO\":{\"rmailbx\":\"responsible.example.com\",\"emailbx\":\"errors@example.com\"},\"MR\":{\"newname\":\"newmail.example.com\"},\"MX\":{\"preference\":10,\"exchange\":\"mail.example.com\"},\"NAPTR\":{\"order\":100,\"preference\":10,\"flags\":\"U\",\"services\":\"E2U+sip\",\"regexp\":\"!^.*$!sip:info@example.com!\",\"replacement\":\"example.com\"},\"NS\":{\"nsdname\":\"ns1.example.com\"},\"PTR\":{\"ptrdname\":\"host.example.com\"},\"RP\":{\"mbox\":\"admin.example.com\",\"txtdname\":\"info.example.com\"},\"SOA\":{\"mname\":\"ns1.example.com\",\"rname\":\"admin.example.com\",\"serial\":2025090901,\"refresh\":3600,\"retry\":1800,\"expire\":604800,\"minimum\":86400},\"SPF\":{\"txtdata\":\"\\\"v=spf1 include:example.com ~all\\\"\"},\"SRV\":{\"priority\":10,\"weight\":5,\"port\":5060,\"target\":\"sip.example.com\"},\"TXT\":{\"txtdata\":\"\\\"v=spf1 include:example.com ~all\\\"\"},\"WKS\":{\"address\":\"192.0.2.1\",\"protocol\":6,\"bitmap\":\"0101010100000000\"},\"X25\":{\"psdnaddress\":\"1234567890\"}}}" }, "description": "This endpoint allow to create zone record." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":1,\"device_id\":38,\"server_id\":3,\"ip\":null,\"name\":\"1.168.192.in-addr.arpa\",\"records\":[{\"line\":\"4\",\"name\":\"1.168.192.in-addr.arpa.\",\"type\":\"SOA\",\"class\":\"IN\",\"ttl\":\"86400\",\"rdlength\":null,\"rdata\":{\"mname\":\"ns1.55-33-166-35.cprapid.com\",\"rname\":\"test.com\",\"serial\":\"2025090900\",\"refresh\":\"3600\",\"retry\":\"1800\",\"expire\":\"1209600\",\"minimum\":\"86400\"}},{\"line\":\"10\",\"name\":\"1.168.192.in-addr.arpa.\",\"type\":\"NS\",\"class\":\"IN\",\"ttl\":\"86400\",\"rdlength\":null,\"rdata\":{\"nsdname\":\"ns1.55-33-166-35.cprapid.com\"}},{\"line\":\"11\",\"name\":\"1.168.192.in-addr.arpa.\",\"type\":\"NS\",\"class\":\"IN\",\"ttl\":\"86400\",\"rdlength\":null,\"rdata\":{\"nsdname\":\"ns2.55-33-166-35.cprapid.com\"}},{\"line\":\"12\",\"name\":\"1.168.192.in-addr.arpa.\",\"type\":\"A\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"address\":\"55.33.166.35\"}},{\"line\":\"13\",\"name\":\"1.168.192.in-addr.arpa.\",\"type\":\"MX\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"preference\":\"0\",\"exchange\":\"1.168.192.in-addr.arpa\"}},{\"line\":\"14\",\"name\":\"mail.1.168.192.in-addr.arpa.\",\"type\":\"CNAME\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"cname\":\"1.168.192.in-addr.arpa\"}},{\"line\":\"15\",\"name\":\"www.1.168.192.in-addr.arpa.\",\"type\":\"CNAME\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"cname\":\"1.168.192.in-addr.arpa\"}},{\"line\":\"16\",\"name\":\"ftp.1.168.192.in-addr.arpa.\",\"type\":\"CNAME\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"cname\":\"1.168.192.in-addr.arpa\"}},{\"line\":\"17\",\"name\":\"0.1.168.192.in-addr.arpa.\",\"type\":\"PTR\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"ptrdname\":\"test.com\"}},{\"line\":\"18\",\"name\":\"test.1.168.192.in-addr.arpa.\",\"type\":\"A\",\"class\":\"IN\",\"ttl\":\"3600\",\"rdlength\":null,\"rdata\":{\"address\":\"10.10.10.1\"}}],\"created_at\":\"2025-02-28 13:32:26\",\"updated_at\":\"2025-02-28 13:32:26\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete Zone Record", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/dns-manager\/zones\/:id\/records\/delete", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/dns-manager\/zones\/:id\/records\/delete", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "The ID of the zone." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"line\":1,\"type\":\"A\"}" }, "description": "This endpoint deletes zone record." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":1,\"device_id\":38,\"server_id\":3,\"ip\":null,\"name\":\"1.168.192.in-addr.arpa\",\"records\":[{\"line\":\"4\",\"name\":\"1.168.192.in-addr.arpa.\",\"type\":\"SOA\",\"class\":\"IN\",\"ttl\":\"86400\",\"rdlength\":null,\"rdata\":{\"mname\":\"ns1.55-33-166-35.cprapid.com\",\"rname\":\"test.com\",\"serial\":\"2025090900\",\"refresh\":\"3600\",\"retry\":\"1800\",\"expire\":\"1209600\",\"minimum\":\"86400\"}},{\"line\":\"10\",\"name\":\"1.168.192.in-addr.arpa.\",\"type\":\"NS\",\"class\":\"IN\",\"ttl\":\"86400\",\"rdlength\":null,\"rdata\":{\"nsdname\":\"ns1.55-33-166-35.cprapid.com\"}},{\"line\":\"11\",\"name\":\"1.168.192.in-addr.arpa.\",\"type\":\"NS\",\"class\":\"IN\",\"ttl\":\"86400\",\"rdlength\":null,\"rdata\":{\"nsdname\":\"ns2.55-33-166-35.cprapid.com\"}},{\"line\":\"12\",\"name\":\"1.168.192.in-addr.arpa.\",\"type\":\"A\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"address\":\"55.33.166.35\"}},{\"line\":\"13\",\"name\":\"1.168.192.in-addr.arpa.\",\"type\":\"MX\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"preference\":\"0\",\"exchange\":\"1.168.192.in-addr.arpa\"}},{\"line\":\"14\",\"name\":\"mail.1.168.192.in-addr.arpa.\",\"type\":\"CNAME\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"cname\":\"1.168.192.in-addr.arpa\"}},{\"line\":\"15\",\"name\":\"www.1.168.192.in-addr.arpa.\",\"type\":\"CNAME\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"cname\":\"1.168.192.in-addr.arpa\"}},{\"line\":\"16\",\"name\":\"ftp.1.168.192.in-addr.arpa.\",\"type\":\"CNAME\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"cname\":\"1.168.192.in-addr.arpa\"}},{\"line\":\"17\",\"name\":\"0.1.168.192.in-addr.arpa.\",\"type\":\"PTR\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"ptrdname\":\"test.com\"}},{\"line\":\"18\",\"name\":\"test.1.168.192.in-addr.arpa.\",\"type\":\"A\",\"class\":\"IN\",\"ttl\":\"3600\",\"rdlength\":null,\"rdata\":{\"address\":\"10.10.10.1\"}}],\"created_at\":\"2025-02-28 13:32:26\",\"updated_at\":\"2025-02-28 13:32:26\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update Zone Record", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/dns-manager\/zones\/:id\/records\/update", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/dns-manager\/zones\/:id\/records\/update", "variable": [ { "id": "id", "key": "id", "value": "11", "description": "The ID of the zone." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"line\":1,\"name\":\"www\",\"type\":\"A\",\"ttl\":3600,\"fields\":{\"A\":{\"address\":\"192.0.2.1\"},\"AAAA\":{\"address\":\"2001:db8::1\"},\"AFSDB\":{\"subtype\":1,\"hostname\":\"host.example.com\"},\"CNAME\":{\"cname\":\"example.com\"},\"DEF\":{\"value\":\"Some value\"},\"DNAME\":{\"target\":\"example.com\"},\"DS\":{\"keytag\":12345,\"algorithm\":8,\"digesttype\":1,\"digest\":\"49FD46E6C4B45C55D4AC\"},\"HINFO\":{\"cpu\":\"Intel\",\"os\":\"Linux\"},\"ISDN\":{\"isdnaddress\":\"+1-555-1234567\",\"sa\":\"123\"},\"LOC\":{\"version\":0,\"size\":1,\"horiz_pre\":100,\"vert_pre\":10,\"latitude\":\"52 22 23.0 N\",\"longitude\":\"4 53 32.0 E\",\"altitude\":5},\"MB\":{\"madname\":\"mail.example.com\"},\"MD\":{\"madname\":\"mail.example.com\"},\"MF\":{\"madname\":\"forwarder.example.com\"},\"MG\":{\"mgmname\":\"member.example.com\"},\"MINFO\":{\"rmailbx\":\"responsible.example.com\",\"emailbx\":\"errors@example.com\"},\"MR\":{\"newname\":\"newmail.example.com\"},\"MX\":{\"preference\":10,\"exchange\":\"mail.example.com\"},\"NAPTR\":{\"order\":100,\"preference\":10,\"flags\":\"U\",\"services\":\"E2U+sip\",\"regexp\":\"!^.*$!sip:info@example.com!\",\"replacement\":\"example.com\"},\"NS\":{\"nsdname\":\"ns1.example.com\"},\"PTR\":{\"ptrdname\":\"host.example.com\"},\"RP\":{\"mbox\":\"admin.example.com\",\"txtdname\":\"info.example.com\"},\"SOA\":{\"mname\":\"ns1.example.com\",\"rname\":\"admin.example.com\",\"serial\":2025090901,\"refresh\":3600,\"retry\":1800,\"expire\":604800,\"minimum\":86400},\"SPF\":{\"txtdata\":\"\\\"v=spf1 include:example.com ~all\\\"\"},\"SRV\":{\"priority\":10,\"weight\":5,\"port\":5060,\"target\":\"sip.example.com\"},\"TXT\":{\"txtdata\":\"\\\"v=spf1 include:example.com ~all\\\"\"},\"WKS\":{\"address\":\"192.0.2.1\",\"protocol\":6,\"bitmap\":\"0101010100000000\"},\"X25\":{\"psdnaddress\":\"1234567890\"}}}" }, "description": "This endpoint allow to edit zone record." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":1,\"device_id\":38,\"server_id\":3,\"ip\":null,\"name\":\"1.168.192.in-addr.arpa\",\"records\":[{\"line\":\"4\",\"name\":\"1.168.192.in-addr.arpa.\",\"type\":\"SOA\",\"class\":\"IN\",\"ttl\":\"86400\",\"rdlength\":null,\"rdata\":{\"mname\":\"ns1.55-33-166-35.cprapid.com\",\"rname\":\"test.com\",\"serial\":\"2025090900\",\"refresh\":\"3600\",\"retry\":\"1800\",\"expire\":\"1209600\",\"minimum\":\"86400\"}},{\"line\":\"10\",\"name\":\"1.168.192.in-addr.arpa.\",\"type\":\"NS\",\"class\":\"IN\",\"ttl\":\"86400\",\"rdlength\":null,\"rdata\":{\"nsdname\":\"ns1.55-33-166-35.cprapid.com\"}},{\"line\":\"11\",\"name\":\"1.168.192.in-addr.arpa.\",\"type\":\"NS\",\"class\":\"IN\",\"ttl\":\"86400\",\"rdlength\":null,\"rdata\":{\"nsdname\":\"ns2.55-33-166-35.cprapid.com\"}},{\"line\":\"12\",\"name\":\"1.168.192.in-addr.arpa.\",\"type\":\"A\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"address\":\"55.33.166.35\"}},{\"line\":\"13\",\"name\":\"1.168.192.in-addr.arpa.\",\"type\":\"MX\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"preference\":\"0\",\"exchange\":\"1.168.192.in-addr.arpa\"}},{\"line\":\"14\",\"name\":\"mail.1.168.192.in-addr.arpa.\",\"type\":\"CNAME\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"cname\":\"1.168.192.in-addr.arpa\"}},{\"line\":\"15\",\"name\":\"www.1.168.192.in-addr.arpa.\",\"type\":\"CNAME\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"cname\":\"1.168.192.in-addr.arpa\"}},{\"line\":\"16\",\"name\":\"ftp.1.168.192.in-addr.arpa.\",\"type\":\"CNAME\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"cname\":\"1.168.192.in-addr.arpa\"}},{\"line\":\"17\",\"name\":\"0.1.168.192.in-addr.arpa.\",\"type\":\"PTR\",\"class\":\"IN\",\"ttl\":\"14400\",\"rdlength\":null,\"rdata\":{\"ptrdname\":\"test.com\"}},{\"line\":\"18\",\"name\":\"test.1.168.192.in-addr.arpa.\",\"type\":\"A\",\"class\":\"IN\",\"ttl\":\"3600\",\"rdlength\":null,\"rdata\":{\"address\":\"10.10.10.1\"}}],\"created_at\":\"2025-02-28 13:32:26\",\"updated_at\":\"2025-02-28 13:32:26\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "Usage Collector", "description": "", "item": [ { "name": "List of Limits For Device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/usage-collector\/limits", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, label, location_id, type_id, model_id.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, label, location_id, type_id, model_id.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/usage-collector\/limits?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of limits for devices with configured limits" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":111,\"label\":\"4U\",\"model\":\"Generic\",\"device_status\":\"running\",\"location\":\"Rzeszow\",\"metadata\":[],\"configurations\":[{\"id\":2,\"driver\":\"PowerUsage\",\"enabled\":false,\"config\":{\"total\":\"12\",\"interval_start_day\":\"first day of this month\",\"enable_notifications\":\"0\",\"time_unit\":\"5\",\"warning_notification_treshold\":\"110\"},\"created_at\":\"2025-08-20 12:18:41\",\"updated_at\":\"2025-08-20 12:18:41\"},{\"id\":3,\"driver\":\"TrafficAggregation\",\"enabled\":false,\"config\":{\"bandwidth\":\"1000\",\"bandwidth_unit\":\"MB\",\"bandwidth_in\":\"200\",\"bandwidth_in_unit\":\"MB\",\"bandwidth_out\":\"300\",\"bandwidth_out_unit\":\"TB\",\"percentile\":null,\"disable_traffic_aggregation_ports\":\"0\",\"interval_start_day\":\"first day of this month\",\"enable_notifications\":\"0\",\"time_unit\":\"5\",\"warning_notification_treshold\":\"110\"},\"created_at\":\"2025-08-20 12:24:26\",\"updated_at\":\"2025-08-20 12:24:26\"}]},{\"id\":198,\"label\":\"Test Server\",\"model\":\"Generic\",\"device_status\":null,\"location\":\"Rzeszow\",\"metadata\":[],\"configurations\":[{\"id\":5,\"driver\":\"TrafficAggregation\",\"enabled\":true,\"config\":{\"bandwidth\":0,\"bandwidth_unit\":\"GB\",\"bandwidth_in\":0,\"bandwidth_in_unit\":\"GB\",\"bandwidth_out\":0,\"bandwidth_out_unit\":\"GB\",\"percentile\":0,\"interval_start_day\":\"first day of this month\"},\"created_at\":\"2025-10-16 09:29:47\",\"updated_at\":\"2025-10-16 09:30:49\"}]},{\"id\":41,\"label\":\"label6\",\"model\":\"Generic\",\"device_status\":\"running\",\"location\":\"New York\",\"metadata\":[],\"configurations\":[{\"id\":6,\"driver\":\"TrafficAggregation\",\"enabled\":true,\"config\":{\"bandwidth\":\"1\",\"bandwidth_unit\":\"GB\",\"bandwidth_in\":\"0.1\",\"bandwidth_in_unit\":\"GB\",\"bandwidth_out\":\"0.1\",\"bandwidth_out_unit\":\"GB\",\"percentile\":\"10\",\"interval_start_day\":\"first day of this month\"},\"created_at\":\"2025-10-16 09:34:08\",\"updated_at\":\"2025-10-20 12:45:22\"}]},{\"id\":81,\"label\":\"test\",\"model\":\"Generic\",\"device_status\":\"running\",\"location\":\"Rzeszow\",\"metadata\":[],\"configurations\":[{\"id\":7,\"driver\":\"TrafficAggregation\",\"enabled\":true,\"config\":{\"bandwidth\":0,\"bandwidth_unit\":\"GB\",\"bandwidth_in\":0,\"bandwidth_in_unit\":\"GB\",\"bandwidth_out\":0,\"bandwidth_out_unit\":\"GB\",\"percentile\":0,\"interval_start_day\":\"first day of this month\"},\"created_at\":\"2025-10-16 10:07:01\",\"updated_at\":\"2025-10-16 10:07:01\"}]}],\"links\":{\"first\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/usage-collector\/limits?page=1\",\"last\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/usage-collector\/limits?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/usage-collector\/limits?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/usage-collector\/limits\",\"per_page\":10,\"to\":4,\"total\":4,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show of Limits For Device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/usage-collector\/:id\/limits", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/usage-collector\/:id\/limits", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the device." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns limits for device" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":111,\"label\":\"4U\",\"model\":\"Generic\",\"device_status\":\"running\",\"location\":\"Rzeszow\",\"metadata\":[],\"configurations\":[{\"id\":2,\"driver\":\"PowerUsage\",\"enabled\":false,\"config\":{\"total\":\"12\",\"interval_start_day\":\"first day of this month\",\"enable_notifications\":\"0\",\"time_unit\":\"5\",\"warning_notification_treshold\":\"110\"},\"created_at\":\"2025-08-20 12:18:41\",\"updated_at\":\"2025-08-20 12:18:41\"},{\"id\":3,\"driver\":\"TrafficAggregation\",\"enabled\":false,\"config\":{\"bandwidth\":\"1000\",\"bandwidth_unit\":\"MB\",\"bandwidth_in\":\"200\",\"bandwidth_in_unit\":\"MB\",\"bandwidth_out\":\"300\",\"bandwidth_out_unit\":\"TB\",\"percentile\":null,\"disable_traffic_aggregation_ports\":\"0\",\"interval_start_day\":\"first day of this month\",\"enable_notifications\":\"0\",\"time_unit\":\"5\",\"warning_notification_treshold\":\"110\"},\"created_at\":\"2025-08-20 12:24:26\",\"updated_at\":\"2025-08-20 12:24:26\"}]}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update Limits For Device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/usage-collector\/:id\/limits", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/usage-collector\/:id\/limits", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the device." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"limit_type\":\"TrafficAggregation\",\"config\":{\"bandwidth\":100,\"bandwidth_unit\":\"GB\",\"bandwidth_in\":100,\"bandwidth_in_unit\":\"MB\",\"bandwidth_out\":100,\"bandwidth_out_unit\":\"TB\",\"percentile\":null,\"disable_traffic_aggregation_ports\":false,\"interval_start_day\":\"first day of this month\",\"enable_notifications\":false,\"time_unit\":60,\"warning_notification_treshold\":110}}" }, "description": "Returns limits for device" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":111,\"label\":\"4U\",\"model\":\"Generic\",\"device_status\":\"running\",\"location\":\"Rzeszow\",\"metadata\":[],\"configurations\":[{\"id\":2,\"driver\":\"PowerUsage\",\"enabled\":false,\"config\":{\"total\":\"12\",\"interval_start_day\":\"first day of this month\",\"enable_notifications\":\"0\",\"time_unit\":\"5\",\"warning_notification_treshold\":\"110\"},\"created_at\":\"2025-08-20 12:18:41\",\"updated_at\":\"2025-08-20 12:18:41\"},{\"id\":3,\"driver\":\"TrafficAggregation\",\"enabled\":false,\"config\":{\"bandwidth\":\"1000\",\"bandwidth_unit\":\"MB\",\"bandwidth_in\":\"200\",\"bandwidth_in_unit\":\"MB\",\"bandwidth_out\":\"300\",\"bandwidth_out_unit\":\"TB\",\"percentile\":null,\"disable_traffic_aggregation_ports\":\"0\",\"interval_start_day\":\"first day of this month\",\"enable_notifications\":\"0\",\"time_unit\":\"5\",\"warning_notification_treshold\":\"110\"},\"created_at\":\"2025-08-20 12:24:26\",\"updated_at\":\"2025-08-20 12:24:26\"}]}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete Limits For Device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/usage-collector\/:id\/limits", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/usage-collector\/:id\/limits", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the device." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"limit_type\":\"TrafficAggregation\"}" }, "description": "Returns limits for device" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":111,\"label\":\"4U\",\"model\":\"Generic\",\"device_status\":\"running\",\"location\":\"Rzeszow\",\"metadata\":[],\"configurations\":[{\"id\":2,\"driver\":\"PowerUsage\",\"enabled\":false,\"config\":{\"total\":\"12\",\"interval_start_day\":\"first day of this month\",\"enable_notifications\":\"0\",\"time_unit\":\"5\",\"warning_notification_treshold\":\"110\"},\"created_at\":\"2025-08-20 12:18:41\",\"updated_at\":\"2025-08-20 12:18:41\"},{\"id\":3,\"driver\":\"TrafficAggregation\",\"enabled\":false,\"config\":{\"bandwidth\":\"1000\",\"bandwidth_unit\":\"MB\",\"bandwidth_in\":\"200\",\"bandwidth_in_unit\":\"MB\",\"bandwidth_out\":\"300\",\"bandwidth_out_unit\":\"TB\",\"percentile\":null,\"disable_traffic_aggregation_ports\":\"0\",\"interval_start_day\":\"first day of this month\",\"enable_notifications\":\"0\",\"time_unit\":\"5\",\"warning_notification_treshold\":\"110\"},\"created_at\":\"2025-08-20 12:24:26\",\"updated_at\":\"2025-08-20 12:24:26\"}]}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "Tags", "description": "", "item": [ { "name": "List Tags", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/tags", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, name, type.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, name, type.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/admin\/tags?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of tags." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":58,\"name\":\"ab\",\"color\":\"#8830e2\",\"type\":\"App\\\\Models\\\\User\",\"created_at\":\"2026-07-10 09:51:41\",\"updated_at\":\"2026-07-10 09:51:41\"},{\"id\":59,\"name\":\"at\",\"color\":\"#bb5e04\",\"type\":\"App\\\\Models\\\\User\",\"created_at\":\"2026-07-10 09:51:41\",\"updated_at\":\"2026-07-10 09:51:41\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/tags?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/tags\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Show tag", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/tags\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/tags\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the tag." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Display detailed information about a single tag by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":60,\"name\":\"culpa\",\"color\":\"#4e303a\",\"type\":\"App\\\\Models\\\\User\",\"assignedTo\":[],\"created_at\":\"2026-07-10 09:51:41\",\"updated_at\":\"2026-07-10 09:51:41\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Create tag", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/tags", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/tags" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Server\",\"color\":\"#FA6900\",\"type\":\"App\\\\Models\\\\Item\"}" }, "description": "Store a new tag in the system using validated request data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":61,\"name\":\"ad\",\"color\":\"#69949c\",\"type\":\"App\\\\Models\\\\User\",\"assignedTo\":[],\"created_at\":\"2026-07-10 09:51:41\",\"updated_at\":\"2026-07-10 09:51:41\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Update tag", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/tags\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/tags\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the tag." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Server\",\"color\":\"#FA6900\"}" }, "description": "Updates the specified tag with provided data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":62,\"name\":\"ipsum\",\"color\":\"#60e1e7\",\"type\":\"App\\\\Models\\\\User\",\"assignedTo\":[],\"created_at\":\"2026-07-10 09:51:41\",\"updated_at\":\"2026-07-10 09:51:41\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Delete tag", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/tags\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/tags\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "The ID of the tag." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes the specified tag from the system." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Assign multiple tags to specified entity", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/tags\/assign", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/tags\/assign" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"entity_id\":1,\"entity_type\":\"App\\\\Models\\\\Item\",\"tags\":[1]}" }, "description": "Assigns multiple tags to specified entity" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":38,\"tags\":[{\"id\":3,\"name\":\"For Sale\",\"color\":\"#c70000\",\"type\":\"App\\\\Models\\\\Device\"}]}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Unassign multiple tags from specified entity", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/admin\/tags\/unassign", "query": [], "raw": "{{baseUrl}}\/api\/v3\/admin\/tags\/unassign" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"entity_id\":1,\"entity_type\":\"App\\\\Models\\\\Item\",\"tags\":[1]}" }, "description": "Unassigns multiple tags from specified entity" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":38,\"tags\":[{\"id\":3,\"name\":\"For Sale\",\"color\":\"#c70000\",\"type\":\"App\\\\Models\\\\Device\"}]}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] } ] }, { "name": "Authorization Endpoints", "description": "", "item": [ { "name": "Login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/login", "query": [], "raw": "{{baseUrl}}\/api\/v3\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"user@example.com\",\"password\":\"secret123\",\"device_name\":\"iPhone 13\",\"token_ttl\":0}" }, "description": "This endpoint allows a user to authenticate and receive an access token.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status\": \"success\",\n \"message\": \"success\",\n \"data\": {\n \"id\": 112,\n \"name\": \"iPhone 13\",\n \"last_used_at\": \"-\",\n \"expires_at\": \"-\",\n \"token\": \"112|TT67ipL9gve55ujQNiVpI4CtK4OOW5F6rkzCdPV15cdccbc0\",\n \"created_at\": \"2025-10-21 15:47:12\"\n }\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"status\": \"error\",\n \"message\": \"Your account is not active or has been banned.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"status\": \"error\",\n \"message\": \"Data validation has failed. Please correct the errors and try again.\",\n \"errors\": {\n \"email\": [\n \"The provided email address is incorrect.\"\n ],\n \"password\": [\n \"The provided password is incorrect.\"\n ]\n }\n}", "name": "" } ] }, { "name": "Remind Password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/password\/remind", "query": [], "raw": "{{baseUrl}}\/api\/v3\/password\/remind" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"user@example.com\"}" }, "description": "Sends a password reset link to the provided email address, if it exists in the system.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status\": \"success\",\n \"message\": \"Success! An email has been sent to your inbox.\",\n \"data\": null\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"status\": \"error\",\n \"message\": \"Your account is not active or has been banned.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"status\": \"error\",\n \"message\": \"The provided email address is incorrect.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"success\": false,\n \"status\": \"error\",\n \"message\": \"Unable to send email. Please contact your administrator.\"\n}", "name": "" } ] }, { "name": "Restore Password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/password\/restore", "query": [], "raw": "{{baseUrl}}\/api\/v3\/password\/restore" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"token\":\"123456abcdef\",\"password\":\"NewSecureP@ss123\",\"password_confirmation\":\"NewSecureP@ss123\"}" }, "description": "Resets a user's password using a valid reset token.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status\": \"success\",\n \"message\": \"Your password has been updated successfully.\",\n \"data\": null\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"status\": \"error\",\n \"message\": \"Your token is incorrect or this account does not exist.\"\n}", "name": "" } ] }, { "name": "Activate User Account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/activate\/:token", "query": [], "raw": "{{baseUrl}}\/api\/v3\/activate\/:token", "variable": [ { "id": "token", "key": "token", "value": "9bdf52c2-2e13-4f9c-a53d-2b3f45ea9c20", "description": "The unique activation token sent by email." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Activates a user account based on the provided activation token.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status\": \"success\",\n \"message\": \"Your account has been activated. You may now log in.\",\n \"data\": null\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"status\": \"error\",\n \"message\": \"Activation failed. Please contact support or try again.\"\n}", "name": "" } ] }, { "name": "List Active SSO Providers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/oauth\/providers", "query": [], "raw": "{{baseUrl}}\/api\/v3\/oauth\/providers" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all enabled SSO providers available for the CLIENT scope.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status\": \"success\",\n \"message\": \"success\",\n \"data\": [\n {\n \"slug\": \"GitHubClientArea\"\n },\n {\n \"slug\": \"GoogleClientArea\"\n },\n {\n \"slug\": \"CustomClientArea\"\n }\n ]\n}", "name": "" } ] }, { "name": "OAuth2 Redirect", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/oauth\/redirect", "query": [], "raw": "{{baseUrl}}\/api\/v3\/oauth\/redirect" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"provider\":\"Google\"}" }, "description": "Returns provider authorization URL for the given provider slug.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status\": \"success\",\n \"message\": \"success\",\n \"data\": {\n \"url\": \"https:\/\/provider.url.com\",\n \"provider\": \"GitHubClientArea\",\n \"state\": \"enabled\"\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"status\": \"error\",\n \"message\": \"Invalid or unsupported authentication provider.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"status\": \"error\",\n \"message\": \"Incorrect OAuth provider configuration.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"success\": false,\n \"status\": \"error\",\n \"message\": \"An error occurred while creating the authorization URL.\"\n}", "name": "" } ] }, { "name": "OAuth2 Exchange", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/oauth\/callback", "query": [], "raw": "{{baseUrl}}\/api\/v3\/oauth\/callback" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"provider\":\"Google\",\"code\":\"4\\\/0AfJohXKXYZ...\",\"state\":\"abc123xyz\"}" }, "description": "Exchanges the authorization code from the frontend for an API access token.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status\": \"success\",\n \"message\": \"success\",\n \"data\": {\n \"id\": 112,\n \"name\": \"iPhone 13\",\n \"last_used_at\": \"-\",\n \"expires_at\": \"-\",\n \"token\": \"112|TT67ipL9gve55ujQNiVpI4CtK4OOW5F6rkzCdPV15cdccbc0\",\n \"created_at\": \"2025-10-21 15:47:12\"\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"status\": \"error\",\n \"message\": \"Unable to retrieve user email from the provider.\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"status\": \"error\",\n \"message\": \"The user account email@email.com is not active.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"status\": \"error\",\n \"message\": \"Invalid or unsupported authentication provider.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"status\": \"error\",\n \"message\": \"Unable to find user with email address: email@email.com.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"success\": false,\n \"status\": \"error\",\n \"message\": \"OAuth exchange failed\"\n}", "name": "" } ] }, { "name": "Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/logout", "query": [], "raw": "{{baseUrl}}\/api\/v3\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Revoke the current access token to log out the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status\": \"success\",\n \"message\": \"success\",\n \"data\": null\n}", "name": "" } ] } ] }, { "name": "Client Endpoints", "description": "", "item": [ { "name": "System", "description": "", "item": [ { "name": "Get Translations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/system\/translations\/:locale", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/system\/translations\/:locale", "variable": [ { "id": "locale", "key": "locale", "value": "en", "description": "The language code (e.g. \"en\", \"pl\")." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all language translations for the specified locale.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status\": \"success\",\n \"message\": \"success\",\n \"data\": {\n \"lang_error_toast_heading\": \"An error occurred!\",\n \"lang_success_toast_heading\": \"Success!\",\n \"log_in\": \"Log in\",\n \"log_out\": \"Log out\",\n \"tab\": {\n \"summary\": \"Summary\",\n \"detailed_information\": \"Detailed Information\",\n \"graphs\": \"Graphs\",\n \"traffic_statistics\": \"Traffic Statistics\",\n \"power_usage\": \"Power Usage\",\n \"reverse_dns\": \"Reverse DNS\",\n \"ip_management\": \"IP Address Management\",\n \"outlets\": \"Outlets\"\n },\n \"title\": {\n \"impersonating_as_client\": \"Logging in as client...\",\n \"activating_user\": \"Activating Account...\",\n \"oauth_callback\": \"Connecting Account...\"\n },\n \"messages\": {\n \"impersonating_description\": \"Please wait while we securely log you in as the selected client. This process may take a few seconds.\",\n \"activating_user_description\": \"Please wait while we activate your account. This will only take a moment.\",\n \"oauth_callback_description\": \"Please wait while we securely connect your account. This process may take a few seconds.\"\n },\n \"section_title\": {\n \"bandwidth\": \"Bandwidth\",\n \"power_usage\": \"Power Usage\",\n \"outlets\": \"Outlets\",\n \"detailed_information\": \"Detailed Information\",\n \"device_parts\": \"Device Parts\",\n \"graphs\": \"Graphs\",\n \"ip_addresses_management\": \"IP Addresses Management\",\n \"power_usage_statistic\": \"Power Usage Statistics\",\n \"bandwidth_intervals\": \"Bandwidth Intervals\",\n \"network_ports\": \"Network Ports\",\n \"ping_status\": \"Ping & Status\",\n \"name\": \"Name\"\n },\n \"boxes\": {\n \"bandwith_in\": \"Inbound Bandwidth\",\n \"bandwith_out\": \"Outbound Bandwidth\",\n \"bandwith_total\": \"Total Bandwidth\"\n },\n \"table_headers\": {\n \"base\": \"Base\",\n \"ipmi_settings\": \"IPMI Settings\",\n \"system\": \"System\",\n \"ssh_settings\": \"SSH Settings\",\n \"snmp_settings\": \"SNMP Settings\",\n \"type\": \"Type\",\n \"name\": \"Name\",\n \"label\": \"Label\",\n \"device\": \"Device\",\n \"last_hour_traffic\": \"Last Hour Traffic\",\n \"last_day_traffic\": \"Last Day Traffic\",\n \"last_month_traffic\": \"Last Month Traffic\",\n \"interval\": \"Interval\",\n \"bandwidth_in\": \"Inbound Bandwidth\",\n \"bandwidth_out\": \"Outbound Bandwidth\",\n \"bandwidth_total\": \"Total Bandwidth\",\n \"fingerprint\": \"Fingerprint\",\n \"status\": \"Status\",\n \"actions\": \"Actions\",\n \"id\": \"ID\",\n \"number\": \"Number\",\n \"power_usage\": \"Power Usage\",\n \"ip_address\": \"IP Address\",\n \"rdata\": \"RDATA\",\n \"hostname\": \"Hostname\",\n \"created\": \"Created\",\n \"description\": \"Description\",\n \"iso_url\": \"ISO URL\"\n },\n \"interval_table\": {\n \"last_1hour\": \"Last 1 Hour\",\n \"last_6hours\": \"Last 6 Hours\",\n \"last_1day\": \"Last 1 Day\",\n \"last_2days\": \"Last 2 Days\",\n \"last_1week\": \"Last 1 Week\",\n \"last_1month\": \"Last 1 Month\",\n \"last_6months\": \"Last 6 Months\",\n \"last_1year\": \"Last 1 Year\",\n \"current_month\": \"Current Month\"\n },\n \"power_usage_table\": {\n \"average_daily_usage\": \"Average Daily Usage\",\n \"average_weekly_usage\": \"Average Weekly Usage\",\n \"average_monthly_usage\": \"Average Monthly Usage\",\n \"previous_month_average_usage\": \"Previous Month Average Usage\"\n },\n \"chart\": {\n \"inbound_total\": \"Traffic IN\",\n \"outbound_total\": \"Traffic OUT\",\n \"total_bound_bits\": \"Traffic IN & OUT\",\n \"95_percentile\": \"95th Percentile\",\n \"power_usage\": \"Power Usage\"\n },\n \"stats\": {\n \"power_daily_usage\": \"Daily Usage\",\n \"power_weekly_usage\": \"Weekly Usage\",\n \"power_monthly_usage\": \"Monthly Usage\",\n \"power_previous_month_usage\": \"Previous Month\"\n },\n \"panel_branding\": {\n \"title\": \"Panel Branding\",\n \"allowed_formats\": \"SVG, PNG or JPG\",\n \"click_to_upload\": \"Click to upload\",\n \"change_logo\": \"Change Logo\",\n \"change_favicon\": \"Change Favicon\",\n \"choose_color_scheme\": \"Choose Color Scheme\",\n \"action_saved\": \"Save Changes\",\n \"action_restore\": \"Restore Defaults\"\n },\n \"login_page\": {\n \"login_title\": \"Login\",\n \"register\": \"Register\",\n \"impersonating_as_client\": \"Loading Client Panel Dashboard...\",\n \"reset_password_title\": \"Reset Your Password\",\n \"reset_password_desc\": \"Forgot your password? Enter your email address below to begin the reset process.\",\n \"message_sent_title\": \"Message Sent\",\n \"message_sent_desc\": \"We have sent a message to your email address with a link to reset your password.\"\n },\n \"dropdown\": {\n \"server_actions\": \"Server Actions\",\n \"power_control\": \"Power Control\"\n },\n \"status\": {\n \"active\": \"Active\"\n },\n \"nav\": {\n \"your_services\": \"Your Services\",\n \"iso_images\": \"ISO Images\",\n \"ssh_keys\": \"SSH Keys\",\n \"my_account\": \"My Account\",\n \"sign_out\": \"Sign Out\"\n },\n \"banner\": {\n \"services_title\": \"Your Services\",\n \"services_desc\": \"A list of all services assigned to your account.\",\n \"iso_images_title\": \"ISO Images\",\n \"iso_images_desc\": \"A list of all ISO Images created in your account.\",\n \"ssh_keys_title\": \"SSH Keys\",\n \"ssh_keys_desc\": \"A list of all SSH Keys created in your account.\",\n \"my_account_title\": \"My Account\",\n \"my_account_desc\": \"Summary of your account details and settings\"\n },\n \"inputs\": {\n \"first_name_title\": \"First Name\",\n \"first_name_placeholder\": \"First Name Placeholder\",\n \"last_name_title\": \"Last Name\",\n \"last_name_placeholder\": \"Last Name Placeholder\",\n \"company_name_title\": \"Company Name\",\n \"company_name_placeholder\": \"Company Name Placeholder\",\n \"email_address_title\": \"Email Address\",\n \"email_address_placeholder\": \"Email Address Placeholder\",\n \"languages_title\": \"Language\",\n \"languages_placeholder\": \"Language Placeholder\",\n \"timezones_title\": \"Timezone\",\n \"timezones_placeholder\": \"Timezone Placeholder\",\n \"current_password_title\": \"Current Password\",\n \"current_password_placeholder\": \"Current Password Placeholder\",\n \"new_password_title\": \"New Password\",\n \"new_password_placeholder\": \"New Password Placeholder\",\n \"confirm_new_password_title\": \"Confirm New Password\",\n \"confirm_new_password_placeholder\": \"Confirm New Password Placeholder\",\n \"generated_code_title\": \"Generated Code\",\n \"generated_code_placeholder\": \"Generated Code Placeholder\",\n \"template_title\": \"Template\",\n \"template_placeholder\": \"Template Placeholder\",\n \"hostname_title\": \"Hostname\",\n \"hostname_placeholder\": \"Hostname Placeholder\",\n \"username_title\": \"Username\",\n \"username_placeholder\": \"Username Placeholder\",\n \"root_password_title\": \"Root Password\",\n \"root_password_placeholder\": \"Root Password Placeholder\",\n \"password_title\": \"Password\",\n \"password_placeholder\": \"Password Placeholder\",\n \"ssh_keys_title\": \"SSH Keys\",\n \"ssh_keys_placeholder\": \"SSH Keys Placeholder\",\n \"disk_layout_title\": \"Disk Layout\",\n \"disk_layout_placeholder\": \"Disk Layout Placeholder\",\n \"extras_title\": \"Extras\",\n \"extras_placeholder\": \"Extras Placeholder\",\n \"remember_me_title\": \"Remember Me\"\n },\n \"general\": {\n \"all\": \"all\",\n \"save_changes\": \"Save Changes\",\n \"cancel\": \"Cancel\",\n \"confirm\": \"Confirm\",\n \"unknown\": \"Unknown\",\n \"unassigned\": \"Unassigned\",\n \"not_found_or_unauthorized\": \"The requested entity does not exist or does not belong to you.\",\n \"pdu_required\": \"PDU Management extension must be enabled to perform this action.\",\n \"manage\": \"Manage\"\n },\n \"auth\": {\n \"missing_bearer_token\": \"Missing bearer token.\",\n \"unauthorized_admin_access_only\": \"Unauthorized. Admin access only.\",\n \"invalid_email\": \"The provided email address is incorrect.\",\n \"email_send_error\": \"Unable to send email. Please contact your administrator.\",\n \"email_send_success\": \"Success! An email has been sent to your inbox.\",\n \"invalid_token\": \"Your token is incorrect or this account does not exist.\",\n \"validation_error\": \"Password reset failed due to validation errors.\",\n \"password_reset_success\": \"Your password has been updated successfully.\",\n \"activation_success\": \"Your account has been activated. You may now log in.\",\n \"activation_failed\": \"Activation failed. Please contact support or try again.\",\n \"user_not_found\": \"User not found.\",\n \"invalid_password\": \"The provided password is incorrect.\",\n \"your_account_is_inactive\": \"Your account is not active or has been banned.\",\n \"invalid_bearer_token\": \"Invalid bearer token.\",\n \"impersonated_user_not_found\": \"Impersonated user not found.\",\n \"impersonated_user_inactive\": \"Impersonated user account is inactive.\",\n \"only_admin_can_impersonate\": \"Only admin users are allowed to impersonate other users.\",\n \"missing_impersonate_ability\": \"Your access token does not have permission to impersonate other users.\",\n \"oauth_invalid_provider\": \"Invalid or unsupported authentication provider.\",\n \"oauth_incorrect_configuration\": \"Incorrect OAuth provider configuration.\",\n \"oauth_authorization_error\": \"An error occurred while creating the authorization URL: :error\",\n \"oauth_exchange_error\": \"OAuth exchange failed: :error\",\n \"oauth_missing_email\": \"Unable to retrieve user email from the provider.\",\n \"oauth_user_not_found\": \"Unable to find user with email address: :email.\",\n \"oauth_user_inactive\": \"The user account :email is not active.\",\n \"oauth_invalid_provider_response\": \"Invalid or unsupported authentication provider response.\",\n \"oauth_redirect_failed\": \"Failed to start OAuth login. Please try again later.\",\n \"oauth_connecting\": \"Connecting your account...\",\n \"oauth_missing_parameters\": \"Missing authorization parameters.\",\n \"oauth_invalid_state\": \"Invalid state parameter.\",\n \"oauth_authentication_failed\": \"Authentication failed. Please try again.\",\n \"oauth_exchange_failed\": \"OAuth exchange failed. Please try again later.\",\n \"login_with_GitHubClientArea\": \"Sign in with GitHub\",\n \"login_with_GoogleClientArea\": \"Sign in with Google\",\n \"login_with_CustomClientArea\": \"Sign in with OAuth Provider\"\n },\n \"service\": {\n \"not_found_or_unauthorized\": \"The requested service does not exist, is inactive, or does not belong to you.\",\n \"power_action_error\": \"An error occurred while attempting to perform the :action action on the server.\",\n \"outlet_action_error\": \"An error occurred while attempting to perform the :action action on the outlet.\"\n },\n \"2fa\": {\n \"already_enabled\": \"Two-factor authentication is already enabled.\",\n \"configuration_error\": \"There was an error while verifying the two-factor configuration.\",\n \"verification_failed\": \"Invalid code. Two-factor authentication failed.\",\n \"you_have_been_signed_in_using_backup_code_please_verify_your_two_factor_configuration\": \"You have signed in using a backup code. Please verify your two-factor configuration.\",\n \"please_provide_the_valid_password_for_your_account\": \"Please provide the valid password for your account.\",\n \"no_valid_backup_code_specified_into_configuration\": \"No valid backup code is stored in your configuration.\",\n \"invalid_or_empty_backup_code\": \"The backup code provided is invalid or has not been entered.\",\n \"enabled_successfully\": \"Two-factor authentication has been enabled successfully.\",\n \"disabled_successfully\": \"Two-factor authentication has been disabled successfully.\",\n \"enable_modal\": {\n \"title\": \"Two-Factor Authentication\",\n \"desc\": \"Please use an authenticator app, such as Google Authenticator, to scan the QR code below.\",\n \"backup_code_desc\": \"The backup code is needed to access your account in the event you cannot complete two-factor authentication. Backup codes are valid once only.\"\n },\n \"disable_modal\": {\n \"title\": \"Disable Two-Factor Authentication\",\n \"desc\": \"To disable two-factor authentication, please confirm your current account password.\",\n \"input_title\": \"Current Password\"\n },\n \"2fa_title\": \"Two-Factor Authentication\",\n \"2fa_code_desc\": \"To confirm your identity, please enter the six-digit authentication code from your app.\",\n \"2fa_backup_code_desc\": \"If you do not have access to the app, please enter a backup code below.\",\n \"input_title\": \"Authentication code\",\n \"input_placeholder\": \"Enter your 6-digit code\",\n \"or\": \"or\",\n \"use_backup_code\": \"Use Backup Code\",\n \"use_standard_code\": \"Use Authentication Code\"\n },\n \"login_backup_code\": {\n \"input_title\": \"Backup code\",\n \"input_placeholder\": \"Enter your backup code\"\n },\n \"actions\": {\n \"boot\": \"Boot\",\n \"reboot\": \"Reboot\",\n \"shutdown\": \"Shutdown\",\n \"boot_modal_title\": \"Boot Server\",\n \"boot_modal_desc\": \"Are you sure you want to boot this server?\",\n \"shutdown_modal_title\": \"Shutdown Server\",\n \"shutdown_modal_desc\": \"Are you sure you want to shut down this server?\",\n \"reboot_modal_title\": \"Reboot Server\",\n \"reboot_modal_desc\": \"Are you sure you want to reboot this server?\",\n \"cold_reset_modal_title\": \"Cold Reset BMC\",\n \"cold_reset_modal_desc\": \"This will force a cold reset of the BMC. Are you sure?\",\n \"rescue_mode_enable_title\": \"Enable Rescue Mode\",\n \"rescue_mode_enable_desc\": \"Do you really want to reboot the device in rescue mode?\",\n \"rescue_mode_enable_desc1\": \"If you confirm your request, your server will go into rescue mode and will reboot immediately. You will then receive an email containing the information required to log in to your server.\",\n \"rescue_mode_enable_desc2\": \"Downtime due to reboot: approximately 5 minutes.\",\n \"rescue_mode_disable_title\": \"Disable Rescue Mode\",\n \"rescue_mode_disable_desc\": \"This will boot the server into its normal OS. Proceed?\",\n \"osreinstall_modal_title\": \"Reinstall Operating System\",\n \"outletOn\": \"Outlet On\",\n \"outletOff\": \"Outlet Off\",\n \"outletReboot\": \"Outlet Reboot\"\n },\n \"service_widget\": {\n \"service\": \"Service\",\n \"ip_address\": \"IP Adress\",\n \"location\": \"Location\",\n \"rack\": \"Rack\",\n \"label\": \"Label\",\n \"device_status\": \"Device Status\",\n \"mac_address\": \"MAC Address\",\n \"uptime\": \"UpTime\",\n \"operating_system\": \"Operating System\"\n },\n \"graphs\": {\n \"aggregate_traffic\": \"Aggregate Traffic\",\n \"ping_response\": \"Ping Response\",\n \"status\": \"Status Graphs\",\n \"average_loads\": \"Average Loads For Device\",\n \"power_usage\": \"Server Power Usage\"\n },\n \"vnc_console\": {\n \"modal_title\": \"noVNC KVM Console\",\n \"connecting_desc\": \"We\u2019re establishing the console connection for you. This may take a moment, please wait.\",\n \"failed_desc\": \"The console connection has been established successfully! Please click the button below to open the console.\",\n \"connected_desc\": \"Failed to establish the console connection. Please try again or contact support if the problem persists.\",\n \"action_open\": \"Open Console\",\n \"action_try_again\": \"Try Again\",\n \"insert_username\": \"Insert Username\",\n \"insert_password\": \"Insert Password\",\n \"close_session\": \"Close Session\",\n \"console_status\": \"Console Status\",\n \"loading_desc\": \"We are loading the console. This may take a moment, please wait.\",\n \"error_message\": \"The connection has been lost! Please try to reconnect using the button below. If you continue to experience issues, contact the support team.\"\n },\n \"404\": {\n \"title\": \"Something's missing.\",\n \"desc\": \"The resource you are looking for does not exist or has been removed.\",\n \"back_to_services\": \"Back to Service List\",\n \"back_to_login\": \"Back to Login\"\n }\n }\n}", "name": "" } ] }, { "name": "Show System Configuration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/system-settings", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/system-settings" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns basic system configuration." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"company_name\":\"EasyDCIM\",\"default_client_area_language\":\"en\",\"languages\":{\"en\":\"English\",\"de\":\"German\",\"es\":\"Spanish\"},\"timezones\":{\"\":\"Select something...\",\"0\":\"Africa\/Abidjan\",\"1\":\"Africa\/Accra\",\"2\":\"Africa\/Addis_Ababa\",\"3\":\"Africa\/Algiers\",\"4\":\"Africa\/Asmara\",\"5\":\"Africa\/Bamako\",\"6\":\"Africa\/Bangui\",\"7\":\"Africa\/Banjul\",\"8\":\"Africa\/Bissau\",\"9\":\"Africa\/Blantyre\",\"10\":\"Africa\/Brazzaville\",\"11\":\"Africa\/Bujumbura\",\"12\":\"Africa\/Cairo\",\"13\":\"Africa\/Casablanca\",\"14\":\"Africa\/Ceuta\",\"15\":\"Africa\/Conakry\",\"16\":\"Africa\/Dakar\",\"17\":\"Africa\/Dar_es_Salaam\",\"18\":\"Africa\/Djibouti\",\"19\":\"Africa\/Douala\",\"20\":\"Africa\/El_Aaiun\",\"21\":\"Africa\/Freetown\",\"22\":\"Africa\/Gaborone\",\"23\":\"Africa\/Harare\",\"24\":\"Africa\/Johannesburg\",\"25\":\"Africa\/Juba\",\"26\":\"Africa\/Kampala\",\"27\":\"Africa\/Khartoum\",\"28\":\"Africa\/Kigali\",\"29\":\"Africa\/Kinshasa\",\"30\":\"Africa\/Lagos\",\"31\":\"Africa\/Libreville\",\"32\":\"Africa\/Lome\",\"33\":\"Africa\/Luanda\",\"34\":\"Africa\/Lubumbashi\",\"35\":\"Africa\/Lusaka\",\"36\":\"Africa\/Malabo\",\"37\":\"Africa\/Maputo\",\"38\":\"Africa\/Maseru\",\"39\":\"Africa\/Mbabane\",\"40\":\"Africa\/Mogadishu\",\"41\":\"Africa\/Monrovia\",\"42\":\"Africa\/Nairobi\",\"43\":\"Africa\/Ndjamena\",\"44\":\"Africa\/Niamey\",\"45\":\"Africa\/Nouakchott\",\"46\":\"Africa\/Ouagadougou\",\"47\":\"Africa\/Porto-Novo\",\"48\":\"Africa\/Sao_Tome\",\"49\":\"Africa\/Tripoli\",\"50\":\"Africa\/Tunis\",\"51\":\"Africa\/Windhoek\",\"52\":\"America\/Adak\",\"53\":\"America\/Anchorage\",\"54\":\"America\/Anguilla\",\"55\":\"America\/Antigua\",\"56\":\"America\/Araguaina\",\"57\":\"America\/Argentina\/Buenos_Aires\",\"58\":\"America\/Argentina\/Catamarca\",\"59\":\"America\/Argentina\/Cordoba\",\"60\":\"America\/Argentina\/Jujuy\",\"61\":\"America\/Argentina\/La_Rioja\",\"62\":\"America\/Argentina\/Mendoza\",\"63\":\"America\/Argentina\/Rio_Gallegos\",\"64\":\"America\/Argentina\/Salta\",\"65\":\"America\/Argentina\/San_Juan\",\"66\":\"America\/Argentina\/San_Luis\",\"67\":\"America\/Argentina\/Tucuman\",\"68\":\"America\/Argentina\/Ushuaia\",\"69\":\"America\/Aruba\",\"70\":\"America\/Asuncion\",\"71\":\"America\/Atikokan\",\"72\":\"America\/Bahia\",\"73\":\"America\/Bahia_Banderas\",\"74\":\"America\/Barbados\",\"75\":\"America\/Belem\",\"76\":\"America\/Belize\",\"77\":\"America\/Blanc-Sablon\",\"78\":\"America\/Boa_Vista\",\"79\":\"America\/Bogota\",\"80\":\"America\/Boise\",\"81\":\"America\/Cambridge_Bay\",\"82\":\"America\/Campo_Grande\",\"83\":\"America\/Cancun\",\"84\":\"America\/Caracas\",\"85\":\"America\/Cayenne\",\"86\":\"America\/Cayman\",\"87\":\"America\/Chicago\",\"88\":\"America\/Chihuahua\",\"89\":\"America\/Ciudad_Juarez\",\"90\":\"America\/Costa_Rica\",\"91\":\"America\/Creston\",\"92\":\"America\/Cuiaba\",\"93\":\"America\/Curacao\",\"94\":\"America\/Danmarkshavn\",\"95\":\"America\/Dawson\",\"96\":\"America\/Dawson_Creek\",\"97\":\"America\/Denver\",\"98\":\"America\/Detroit\",\"99\":\"America\/Dominica\",\"100\":\"America\/Edmonton\",\"101\":\"America\/Eirunepe\",\"102\":\"America\/El_Salvador\",\"103\":\"America\/Fort_Nelson\",\"104\":\"America\/Fortaleza\",\"105\":\"America\/Glace_Bay\",\"106\":\"America\/Goose_Bay\",\"107\":\"America\/Grand_Turk\",\"108\":\"America\/Grenada\",\"109\":\"America\/Guadeloupe\",\"110\":\"America\/Guatemala\",\"111\":\"America\/Guayaquil\",\"112\":\"America\/Guyana\",\"113\":\"America\/Halifax\",\"114\":\"America\/Havana\",\"115\":\"America\/Hermosillo\",\"116\":\"America\/Indiana\/Indianapolis\",\"117\":\"America\/Indiana\/Knox\",\"118\":\"America\/Indiana\/Marengo\",\"119\":\"America\/Indiana\/Petersburg\",\"120\":\"America\/Indiana\/Tell_City\",\"121\":\"America\/Indiana\/Vevay\",\"122\":\"America\/Indiana\/Vincennes\",\"123\":\"America\/Indiana\/Winamac\",\"124\":\"America\/Inuvik\",\"125\":\"America\/Iqaluit\",\"126\":\"America\/Jamaica\",\"127\":\"America\/Juneau\",\"128\":\"America\/Kentucky\/Louisville\",\"129\":\"America\/Kentucky\/Monticello\",\"130\":\"America\/Kralendijk\",\"131\":\"America\/La_Paz\",\"132\":\"America\/Lima\",\"133\":\"America\/Los_Angeles\",\"134\":\"America\/Lower_Princes\",\"135\":\"America\/Maceio\",\"136\":\"America\/Managua\",\"137\":\"America\/Manaus\",\"138\":\"America\/Marigot\",\"139\":\"America\/Martinique\",\"140\":\"America\/Matamoros\",\"141\":\"America\/Mazatlan\",\"142\":\"America\/Menominee\",\"143\":\"America\/Merida\",\"144\":\"America\/Metlakatla\",\"145\":\"America\/Mexico_City\",\"146\":\"America\/Miquelon\",\"147\":\"America\/Moncton\",\"148\":\"America\/Monterrey\",\"149\":\"America\/Montevideo\",\"150\":\"America\/Montserrat\",\"151\":\"America\/Nassau\",\"152\":\"America\/New_York\",\"153\":\"America\/Nome\",\"154\":\"America\/Noronha\",\"155\":\"America\/North_Dakota\/Beulah\",\"156\":\"America\/North_Dakota\/Center\",\"157\":\"America\/North_Dakota\/New_Salem\",\"158\":\"America\/Nuuk\",\"159\":\"America\/Ojinaga\",\"160\":\"America\/Panama\",\"161\":\"America\/Paramaribo\",\"162\":\"America\/Phoenix\",\"163\":\"America\/Port-au-Prince\",\"164\":\"America\/Port_of_Spain\",\"165\":\"America\/Porto_Velho\",\"166\":\"America\/Puerto_Rico\",\"167\":\"America\/Punta_Arenas\",\"168\":\"America\/Rankin_Inlet\",\"169\":\"America\/Recife\",\"170\":\"America\/Regina\",\"171\":\"America\/Resolute\",\"172\":\"America\/Rio_Branco\",\"173\":\"America\/Santarem\",\"174\":\"America\/Santiago\",\"175\":\"America\/Santo_Domingo\",\"176\":\"America\/Sao_Paulo\",\"177\":\"America\/Scoresbysund\",\"178\":\"America\/Sitka\",\"179\":\"America\/St_Barthelemy\",\"180\":\"America\/St_Johns\",\"181\":\"America\/St_Kitts\",\"182\":\"America\/St_Lucia\",\"183\":\"America\/St_Thomas\",\"184\":\"America\/St_Vincent\",\"185\":\"America\/Swift_Current\",\"186\":\"America\/Tegucigalpa\",\"187\":\"America\/Thule\",\"188\":\"America\/Tijuana\",\"189\":\"America\/Toronto\",\"190\":\"America\/Tortola\",\"191\":\"America\/Vancouver\",\"192\":\"America\/Whitehorse\",\"193\":\"America\/Winnipeg\",\"194\":\"America\/Yakutat\",\"195\":\"Antarctica\/Casey\",\"196\":\"Antarctica\/Davis\",\"197\":\"Antarctica\/DumontDUrville\",\"198\":\"Antarctica\/Macquarie\",\"199\":\"Antarctica\/Mawson\",\"200\":\"Antarctica\/McMurdo\",\"201\":\"Antarctica\/Palmer\",\"202\":\"Antarctica\/Rothera\",\"203\":\"Antarctica\/Syowa\",\"204\":\"Antarctica\/Troll\",\"205\":\"Antarctica\/Vostok\",\"206\":\"Arctic\/Longyearbyen\",\"207\":\"Asia\/Aden\",\"208\":\"Asia\/Almaty\",\"209\":\"Asia\/Amman\",\"210\":\"Asia\/Anadyr\",\"211\":\"Asia\/Aqtau\",\"212\":\"Asia\/Aqtobe\",\"213\":\"Asia\/Ashgabat\",\"214\":\"Asia\/Atyrau\",\"215\":\"Asia\/Baghdad\",\"216\":\"Asia\/Bahrain\",\"217\":\"Asia\/Baku\",\"218\":\"Asia\/Bangkok\",\"219\":\"Asia\/Barnaul\",\"220\":\"Asia\/Beirut\",\"221\":\"Asia\/Bishkek\",\"222\":\"Asia\/Brunei\",\"223\":\"Asia\/Chita\",\"224\":\"Asia\/Colombo\",\"225\":\"Asia\/Damascus\",\"226\":\"Asia\/Dhaka\",\"227\":\"Asia\/Dili\",\"228\":\"Asia\/Dubai\",\"229\":\"Asia\/Dushanbe\",\"230\":\"Asia\/Famagusta\",\"231\":\"Asia\/Gaza\",\"232\":\"Asia\/Hebron\",\"233\":\"Asia\/Ho_Chi_Minh\",\"234\":\"Asia\/Hong_Kong\",\"235\":\"Asia\/Hovd\",\"236\":\"Asia\/Irkutsk\",\"237\":\"Asia\/Jakarta\",\"238\":\"Asia\/Jayapura\",\"239\":\"Asia\/Jerusalem\",\"240\":\"Asia\/Kabul\",\"241\":\"Asia\/Kamchatka\",\"242\":\"Asia\/Karachi\",\"243\":\"Asia\/Kathmandu\",\"244\":\"Asia\/Khandyga\",\"245\":\"Asia\/Kolkata\",\"246\":\"Asia\/Krasnoyarsk\",\"247\":\"Asia\/Kuala_Lumpur\",\"248\":\"Asia\/Kuching\",\"249\":\"Asia\/Kuwait\",\"250\":\"Asia\/Macau\",\"251\":\"Asia\/Magadan\",\"252\":\"Asia\/Makassar\",\"253\":\"Asia\/Manila\",\"254\":\"Asia\/Muscat\",\"255\":\"Asia\/Nicosia\",\"256\":\"Asia\/Novokuznetsk\",\"257\":\"Asia\/Novosibirsk\",\"258\":\"Asia\/Omsk\",\"259\":\"Asia\/Oral\",\"260\":\"Asia\/Phnom_Penh\",\"261\":\"Asia\/Pontianak\",\"262\":\"Asia\/Pyongyang\",\"263\":\"Asia\/Qatar\",\"264\":\"Asia\/Qostanay\",\"265\":\"Asia\/Qyzylorda\",\"266\":\"Asia\/Riyadh\",\"267\":\"Asia\/Sakhalin\",\"268\":\"Asia\/Samarkand\",\"269\":\"Asia\/Seoul\",\"270\":\"Asia\/Shanghai\",\"271\":\"Asia\/Singapore\",\"272\":\"Asia\/Srednekolymsk\",\"273\":\"Asia\/Taipei\",\"274\":\"Asia\/Tashkent\",\"275\":\"Asia\/Tbilisi\",\"276\":\"Asia\/Tehran\",\"277\":\"Asia\/Thimphu\",\"278\":\"Asia\/Tokyo\",\"279\":\"Asia\/Tomsk\",\"280\":\"Asia\/Ulaanbaatar\",\"281\":\"Asia\/Urumqi\",\"282\":\"Asia\/Ust-Nera\",\"283\":\"Asia\/Vientiane\",\"284\":\"Asia\/Vladivostok\",\"285\":\"Asia\/Yakutsk\",\"286\":\"Asia\/Yangon\",\"287\":\"Asia\/Yekaterinburg\",\"288\":\"Asia\/Yerevan\",\"289\":\"Atlantic\/Azores\",\"290\":\"Atlantic\/Bermuda\",\"291\":\"Atlantic\/Canary\",\"292\":\"Atlantic\/Cape_Verde\",\"293\":\"Atlantic\/Faroe\",\"294\":\"Atlantic\/Madeira\",\"295\":\"Atlantic\/Reykjavik\",\"296\":\"Atlantic\/South_Georgia\",\"297\":\"Atlantic\/St_Helena\",\"298\":\"Atlantic\/Stanley\",\"299\":\"Australia\/Adelaide\",\"300\":\"Australia\/Brisbane\",\"301\":\"Australia\/Broken_Hill\",\"302\":\"Australia\/Darwin\",\"303\":\"Australia\/Eucla\",\"304\":\"Australia\/Hobart\",\"305\":\"Australia\/Lindeman\",\"306\":\"Australia\/Lord_Howe\",\"307\":\"Australia\/Melbourne\",\"308\":\"Australia\/Perth\",\"309\":\"Australia\/Sydney\",\"310\":\"Europe\/Amsterdam\",\"311\":\"Europe\/Andorra\",\"312\":\"Europe\/Astrakhan\",\"313\":\"Europe\/Athens\",\"314\":\"Europe\/Belgrade\",\"315\":\"Europe\/Berlin\",\"316\":\"Europe\/Bratislava\",\"317\":\"Europe\/Brussels\",\"318\":\"Europe\/Bucharest\",\"319\":\"Europe\/Budapest\",\"320\":\"Europe\/Busingen\",\"321\":\"Europe\/Chisinau\",\"322\":\"Europe\/Copenhagen\",\"323\":\"Europe\/Dublin\",\"324\":\"Europe\/Gibraltar\",\"325\":\"Europe\/Guernsey\",\"326\":\"Europe\/Helsinki\",\"327\":\"Europe\/Isle_of_Man\",\"328\":\"Europe\/Istanbul\",\"329\":\"Europe\/Jersey\",\"330\":\"Europe\/Kaliningrad\",\"331\":\"Europe\/Kirov\",\"332\":\"Europe\/Kyiv\",\"333\":\"Europe\/Lisbon\",\"334\":\"Europe\/Ljubljana\",\"335\":\"Europe\/London\",\"336\":\"Europe\/Luxembourg\",\"337\":\"Europe\/Madrid\",\"338\":\"Europe\/Malta\",\"339\":\"Europe\/Mariehamn\",\"340\":\"Europe\/Minsk\",\"341\":\"Europe\/Monaco\",\"342\":\"Europe\/Moscow\",\"343\":\"Europe\/Oslo\",\"344\":\"Europe\/Paris\",\"345\":\"Europe\/Podgorica\",\"346\":\"Europe\/Prague\",\"347\":\"Europe\/Riga\",\"348\":\"Europe\/Rome\",\"349\":\"Europe\/Samara\",\"350\":\"Europe\/San_Marino\",\"351\":\"Europe\/Sarajevo\",\"352\":\"Europe\/Saratov\",\"353\":\"Europe\/Simferopol\",\"354\":\"Europe\/Skopje\",\"355\":\"Europe\/Sofia\",\"356\":\"Europe\/Stockholm\",\"357\":\"Europe\/Tallinn\",\"358\":\"Europe\/Tirane\",\"359\":\"Europe\/Ulyanovsk\",\"360\":\"Europe\/Vaduz\",\"361\":\"Europe\/Vatican\",\"362\":\"Europe\/Vienna\",\"363\":\"Europe\/Vilnius\",\"364\":\"Europe\/Volgograd\",\"365\":\"Europe\/Warsaw\",\"366\":\"Europe\/Zagreb\",\"367\":\"Europe\/Zurich\",\"368\":\"Indian\/Antananarivo\",\"369\":\"Indian\/Chagos\",\"370\":\"Indian\/Christmas\",\"371\":\"Indian\/Cocos\",\"372\":\"Indian\/Comoro\",\"373\":\"Indian\/Kerguelen\",\"374\":\"Indian\/Mahe\",\"375\":\"Indian\/Maldives\",\"376\":\"Indian\/Mauritius\",\"377\":\"Indian\/Mayotte\",\"378\":\"Indian\/Reunion\",\"379\":\"Pacific\/Apia\",\"380\":\"Pacific\/Auckland\",\"381\":\"Pacific\/Bougainville\",\"382\":\"Pacific\/Chatham\",\"383\":\"Pacific\/Chuuk\",\"384\":\"Pacific\/Easter\",\"385\":\"Pacific\/Efate\",\"386\":\"Pacific\/Fakaofo\",\"387\":\"Pacific\/Fiji\",\"388\":\"Pacific\/Funafuti\",\"389\":\"Pacific\/Galapagos\",\"390\":\"Pacific\/Gambier\",\"391\":\"Pacific\/Guadalcanal\",\"392\":\"Pacific\/Guam\",\"393\":\"Pacific\/Honolulu\",\"394\":\"Pacific\/Kanton\",\"395\":\"Pacific\/Kiritimati\",\"396\":\"Pacific\/Kosrae\",\"397\":\"Pacific\/Kwajalein\",\"398\":\"Pacific\/Majuro\",\"399\":\"Pacific\/Marquesas\",\"400\":\"Pacific\/Midway\",\"401\":\"Pacific\/Nauru\",\"402\":\"Pacific\/Niue\",\"403\":\"Pacific\/Norfolk\",\"404\":\"Pacific\/Noumea\",\"405\":\"Pacific\/Pago_Pago\",\"406\":\"Pacific\/Palau\",\"407\":\"Pacific\/Pitcairn\",\"408\":\"Pacific\/Pohnpei\",\"409\":\"Pacific\/Port_Moresby\",\"410\":\"Pacific\/Rarotonga\",\"411\":\"Pacific\/Saipan\",\"412\":\"Pacific\/Tahiti\",\"413\":\"Pacific\/Tarawa\",\"414\":\"Pacific\/Tongatapu\",\"415\":\"Pacific\/Wake\",\"416\":\"Pacific\/Wallis\",\"417\":\"UTC\"}}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] } ] }, { "name": "Users", "description": "", "item": [ { "name": "Autologin with Token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/user\/autologin", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/user\/autologin" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"token\":\"e32cc8f1004a581583b2702c1fbf8354\"}" }, "description": "Logs the user in using a one-time autologin token and returns a new API access token.\nThe token will be valid for 10 minutes.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get Authenticated User", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/user", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/user" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the currently authenticated user's details." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":5367,\"username\":\"holden32\",\"firstname\":\"Omari\",\"lastname\":\"Champlin\",\"name\":\"Omari Champlin\",\"email\":\"moore.zechariah@example.net\",\"company\":null,\"avatar\":\"\/\/www.gravatar.com\/avatar\/77349117760f148b2c7f5dafd5d33a78?s=30&d=mm&r=g\",\"large_avatar\":\"\/\/www.gravatar.com\/avatar\/77349117760f148b2c7f5dafd5d33a78?s=130&d=mm&r=g\",\"gender\":\"0\",\"country_code\":null,\"country_name\":\"United States\",\"active\":1,\"status\":\"Active\",\"last_login\":null,\"locale\":null,\"timezone\":0,\"two_factor_enabled\":false}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Update User", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/user\/edit", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/user\/edit" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"user@example.com\",\"firstname\":\"John\",\"lastname\":\"Doe\",\"company\":\"Acme Inc.\",\"locale\":\"en\",\"timezone\":133}" }, "description": "Updates the currently authenticated user's details with the provided data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":5368,\"username\":\"jermey29\",\"firstname\":\"Lenora\",\"lastname\":\"Hermiston\",\"name\":\"Lenora Hermiston\",\"email\":\"kihn.julia@example.net\",\"company\":null,\"avatar\":\"\/\/www.gravatar.com\/avatar\/72a44b7b1f6b9ebf66c9581f14a6a691?s=30&d=mm&r=g\",\"large_avatar\":\"\/\/www.gravatar.com\/avatar\/72a44b7b1f6b9ebf66c9581f14a6a691?s=130&d=mm&r=g\",\"gender\":\"0\",\"country_code\":null,\"country_name\":\"United States\",\"active\":1,\"status\":\"Active\",\"last_login\":null,\"locale\":null,\"timezone\":0,\"two_factor_enabled\":false}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Update User Password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/user\/edit-password", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/user\/edit-password" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"current_password\":\"OldP@ssword123\",\"password\":\"NewSecureP@ss123\",\"password_confirmation\":\"NewSecureP@ss123\"}" }, "description": "Allows the authenticated user to change their password by providing the current password and a new one." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Generate Auto-Login Link", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/user\/autologin", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/user\/autologin" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Creates a one-time auto-login link for a specific user." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"link\":\"https:\/\/your-easydcim.com\/client\/impersonate?token=43128ab30d06c9bf5eb7a1c2f0274bf4\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] } ] }, { "name": "SSH Keys", "description": "", "item": [ { "name": "List SSH Keys", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/user\/ssh-keys", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, name, fingerprint, default, user_id, created_at.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, name, user_id.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/client\/user\/ssh-keys?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of SSH keys for the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":52,\"name\":\"excepturi officiis\",\"ssh_key\":\"ssh-rsa YTVjYjQyYWY3NWQwZTlmYjg1YTA0Y2FhYjVmZjdlYzNkYzg3MWFlMzJjYWU4ZTU4Mzk2ODdkMWIxM2I3NTJlZA== user@host\",\"default\":false,\"fingerprint\":\"73:e9:7c:43:1b:35:30:cf:25:ae:b1:a6:43:c2:dc:78\",\"created_at\":\"2026-07-10 09:49:37\"},{\"id\":53,\"name\":\"voluptates quisquam\",\"ssh_key\":\"ssh-rsa Mjc3NGQ4NjVkN2U0ZTlkOTZkNzIyNWRlYzcyNzY2NmQwZjU1M2IyYjBiZmYzNDI1M2I3N2E4MGUzNDUxNGI1OQ== user@host\",\"default\":false,\"fingerprint\":\"15:83:dc:17:d8:c4:64:f1:56:ac:d4:18:57:e0:df:7b\",\"created_at\":\"2026-07-10 09:49:37\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/client\/user\/ssh-keys?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/client\/user\/ssh-keys\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Create SSH Key", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/user\/ssh-keys", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/user\/ssh-keys" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Public Key\",\"ssh_key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCy...\",\"default\":true}" }, "description": "Creates a new SSH key associated with the authenticated client." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":54,\"name\":\"quibusdam numquam\",\"ssh_key\":\"ssh-rsa NzdlOWRjZjdlOWQyMmViYWRjNTdlZGQ1YmNkMjhkOGM2MzM0ODQyZDM5MmJmMWU1YWI4Y2JhMTcyMGQ2NTAwZg== user@host\",\"default\":false,\"fingerprint\":\"e3:d6:56:00:a1:d9:4a:b2:1f:aa:53:1c:71:21:1b:ee\",\"created_at\":\"2026-07-10 09:49:37\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Update SSH Key", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/user\/ssh-keys\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/user\/ssh-keys\/:id", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "The ID of the SSH key to update." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Public Key\",\"ssh_key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCy...\",\"default\":true}" }, "description": "Updates a given SSH key for the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":55,\"name\":\"accusamus deleniti\",\"ssh_key\":\"ssh-rsa ZjM3YzcxNmEyN2Y4NjIxZjY5MTYxOTg0MzkxMzgxZTFmYWE5YjU4YmI4MTYxN2Y0OTM1NjAxNWNlOTEwNTgzNQ== user@host\",\"default\":false,\"fingerprint\":\"44:82:b0:54:56:80:0b:7a:5c:47:dc:27:f2:d8:fe:f2\",\"created_at\":\"2026-07-10 09:49:37\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Set SSH Key as Default", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/user\/ssh-keys\/:id\/set-as-default", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/user\/ssh-keys\/:id\/set-as-default", "variable": [ { "id": "id", "key": "id", "value": "7", "description": "The ID of the SSH key to mark as default." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Sets a given SSH key as the default key for the authenticated client." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":56,\"name\":\"in voluptatem\",\"ssh_key\":\"ssh-rsa MjEwMjk0MzYzZjIzNmY0YmM4ZDM1ZDdjYzk2MmM3ZGRjNjhiYTBjNDI1MjY4MTcwMWIwMDA2NGE4YzIzMzQyZg== user@host\",\"default\":false,\"fingerprint\":\"d7:0a:cb:32:5b:a1:48:ff:48:03:67:d3:9f:ff:6c:db\",\"created_at\":\"2026-07-10 09:49:37\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Delete SSH Key", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/user\/ssh-keys\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/user\/ssh-keys\/:id", "variable": [ { "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": "Deletes a specific SSH key belonging to the authenticated client." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] } ] }, { "name": "Services", "description": "", "item": [ { "name": "List Services", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services", "query": [ { "key": "filter", "value": "active", "description": "optional Filter services by status group. Allowed values: all, active, inactive. Default: all.", "disabled": false }, { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, type, status, related.label, related.model, related.location, related.ip.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, type, status, related.label, related.model, related.location, related.ip.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/client\/services?filter=active&per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of services for the authenticated client." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":35,\"related_id\":1055,\"related\":{\"label\":\"eum\",\"model\":\"voluptatem\",\"location\":\"Renner-Renner\",\"location_flag\":\"Canada.png\",\"metadata\":[]},\"type\":\"Server\",\"status\":\"terminated\",\"created_at\":\"2026-07-10 09:49:41\"},{\"id\":36,\"related_id\":1056,\"related\":{\"label\":\"voluptate\",\"model\":\"delectus\",\"location\":\"Bernier-Torp\",\"location_flag\":\"Germany.png\",\"metadata\":[]},\"type\":\"Server\",\"status\":\"\",\"created_at\":\"2026-07-10 09:49:43\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/client\/services?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/client\/services\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Show Service", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns detailed information about a specific service." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":37,\"related_id\":1057,\"type\":\"Server\",\"status\":\"\",\"created_at\":\"2026-07-10 09:49:46\",\"related\":{\"label\":\"sint\",\"model\":\"omnis\",\"location\":\"Harber, Torp and Ward\",\"location_flag\":\"USA.png\",\"rack\":\"Unknown\",\"device_status\":\"running\",\"os_installation\":0,\"uptime\":{\"is_down\":false,\"value\":\"Unknown\"},\"image\":null,\"ip_addresses\":[],\"metadata\":[],\"metadataGroups\":[]},\"access_level\":{\"id\":59,\"name\":\"mollitia\",\"type\":\"Server\",\"default\":true,\"value\":\"a:5:{s:13:\\\"base_features\\\";a:5:{i:0;s:5:\\\"model\\\";i:1;s:8:\\\"position\\\";i:2;s:11:\\\"description\\\";i:3;s:5:\\\"label\\\";i:4;s:8:\\\"location\\\";}s:18:\\\"traffic_statistics\\\";a:5:{i:0;s:17:\\\"widget_last_month\\\";i:1;s:20:\\\"widget_network_ports\\\";i:2;s:23:\\\"widget_last_month_graph\\\";i:3;s:17:\\\"left_sidebar_link\\\";i:4;s:9:\\\"filtering\\\";}s:5:\\\"power\\\";a:6:{i:0;s:17:\\\"widget_last_month\\\";i:1;s:23:\\\"widget_last_month_graph\\\";i:2;s:17:\\\"left_sidebar_link\\\";i:3;s:9:\\\"filtering\\\";i:4;s:7:\\\"outlets\\\";i:5;s:20:\\\"widget_average_usage\\\";}s:4:\\\"ipam\\\";a:1:{i:0;s:30:\\\"ipam_widget_in_service_summary\\\";}s:11:\\\"dns-manager\\\";a:4:{i:0;s:11:\\\"update_rdns\\\";i:1;s:11:\\\"delete_rdns\\\";i:2;s:11:\\\"create_rdns\\\";i:3;s:22:\\\"rdns_left_sidebar_link\\\";}}\"}}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Get Service Bandwidth", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/bandwidth", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/bandwidth", "variable": [ { "id": "id", "key": "id", "value": "101", "description": "The ID of the service." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"startDate\":\"2024-01-01 00:00:00\",\"endDate\":\"2024-01-31 23:59:59\",\"units\":\"GB\",\"ports\":[12,100]}" }, "description": "Retrieves bandwidth usage for a specific service. If a date range is provided, it returns detailed traffic data for that period. Otherwise, it returns historical usage data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"raw\":{\"BW_TOTAL\":{\"rrd\":\"93.78 GB\",\"bytes\":93780000000},\"BW_IN\":{\"rrd\":\"43.04 GB\",\"bytes\":43040000000},\"BW_OUT\":{\"rrd\":\"50.74 GB\",\"bytes\":50740000000},\"95TH_PERC\":{\"rrd\":\"0.00\",\"bytes\":0},\"95TH_PERC_IN\":{\"rrd\":\"0.00\",\"bytes\":0},\"95TH_PERC_OUT\":{\"rrd\":\"0.00\",\"bytes\":0}},\"BW_TOTAL\":\"93.78\",\"BW_IN\":\"43.04\",\"BW_OUT\":\"50.74\",\"95TH_PERC\":\"0.00\",\"95TH_PERC_IN\":\"0.00\",\"95TH_PERC_OUT\":\"0.00\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Get Service Power Usage", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/powerusage", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/powerusage", "variable": [ { "id": "id", "key": "id", "value": "101", "description": "The ID of the service." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"startDate\":\"2024-01-01 00:00:00\",\"endDate\":\"2024-01-31 23:59:59\"}" }, "description": "Retrieves power usage data for a specific service. If a date range is provided, it returns detailed power data for that period. Otherwise, it returns historical usage data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"AVG_TOTAL_USAGE\":10,\"units\":\"Amps\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Assign Metadata To Service", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/assign-metadata", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/assign-metadata", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the service." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"slug\":\"ipmi.ip\",\"value\":\"192.168.56.180\"}" }, "description": "Assigns metadata for specified device associated with service." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Perform Power Action", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/power\/action", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/power\/action", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"action\":\"boot\",\"device_id\":1}" }, "description": "Executes a power-related action on a device assigned to the given service. This includes booting, rebooting, or shutting down the device." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] } ] }, { "name": "Parts", "description": "", "item": [ { "name": "List Service Parts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/parts", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, label, type.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, label, type.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/parts?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of parts related to a specific service." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":1058,\"label\":\"tenetur\",\"type\":\"doloribus\"},{\"id\":1059,\"label\":\"nobis\",\"type\":\"est\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/client\/services\/{id}\/parts?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/client\/services\/{id}\/parts\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] } ] }, { "name": "Power Ports", "description": "", "item": [ { "name": "List Service Power Ports", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/power-ports", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, name, port_number, port_label, user_label, power_usage, outlet_state.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, name, port_number, port_label, user_label, power_usage, outlet_state.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/power-ports?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of power ports related to a specific service." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":442,\"port_number\":8,\"port_label\":\"officiis\",\"user_label\":\"ut\",\"outlet_state\":\"Outlet On\",\"connected_item\":null,\"connected_port\":null,\"power_usage\":64,\"power_usage_units\":\"Amps\",\"power_usage_value\":64,\"power_usage_unit\":\"amps\",\"power_usage_label\":\"64 Amps\"},{\"id\":443,\"port_number\":4,\"port_label\":\"eum\",\"user_label\":\"omnis\",\"outlet_state\":\"Outlet On\",\"connected_item\":null,\"connected_port\":null,\"power_usage\":46,\"power_usage_units\":\"Amps\",\"power_usage_value\":46,\"power_usage_unit\":\"amps\",\"power_usage_label\":\"46 Amps\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/client\/services\/{id}\/power-ports?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/client\/services\/{id}\/power-ports\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Perform action on a specific Power Port", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/power-ports\/action", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/power-ports\/action", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"port_id\":45,\"action\":\"outletOff\"}" }, "description": "Executes an outlet action (outletOn, outletOff, outletReboot) for a given port." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":444,\"port_number\":38,\"port_label\":\"praesentium\",\"user_label\":\"suscipit\",\"outlet_state\":\"Outlet On\",\"connected_item\":null,\"connected_port\":null,\"power_usage\":49,\"power_usage_units\":\"Amps\",\"power_usage_value\":49,\"power_usage_unit\":\"amps\",\"power_usage_label\":\"49 Amps\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] } ] }, { "name": "Ports", "description": "", "item": [ { "name": "List Service Ports", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/ports", "query": [ { "key": "with_traffic", "value": "1", "description": "Include traffic statistics (last 1 hour, last 1 day, last 1 month) for each port.\n Default: false.", "disabled": false }, { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, name, port_number, port_label, user_label, description, if_type, adminstate, opstate, speed.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, name, port_number, port_label, user_label, description, if_type, adminstate, opstate.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/ports?with_traffic=1&per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of ports related to a specific service." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":7506,\"name\":null,\"port_number\":13,\"port_label\":\"ab\",\"user_label\":\"aperiam\",\"description\":\"Facere assumenda atque distinctio.\",\"if_type\":\"fibreChannel\",\"adminstate\":\"down\",\"opstate\":\"down\",\"connected_item\":null,\"connected_port\":null,\"connection\":\"Unknown\",\"speed\":\"1 kbps\"},{\"id\":7507,\"name\":null,\"port_number\":44,\"port_label\":\"est\",\"user_label\":\"voluptatibus\",\"description\":\"Aspernatur modi est maiores.\",\"if_type\":\"cnr\",\"adminstate\":\"up\",\"opstate\":\"up\",\"connected_item\":null,\"connected_port\":null,\"connection\":\"Unknown\",\"speed\":\"100 bps\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/client\/services\/{id}\/ports?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/client\/services\/{id}\/ports\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] } ] }, { "name": "Sensors", "description": "", "item": [ { "name": "List Sensors", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/sensors", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, item_id, name, class, type.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, item_id, name, class, type.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/sensors?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the service." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of sensors associated with the service." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":710,\"item_id\":1065,\"name\":\"atque\",\"class\":\"Power Supply\",\"type\":\"Thermal\",\"unit\":\"Amps\",\"index\":\"Thermal\",\"reading\":868,\"last_polled\":\"0000-00-00 00:00:00\",\"configuration\":[],\"created_at\":\"2026-07-10 09:50:00\",\"updated_at\":\"2026-07-10 09:50:00\"},{\"id\":711,\"item_id\":1066,\"name\":\"sit\",\"class\":\"Power Supply\",\"type\":\"Thermal\",\"unit\":\"Voltages\",\"index\":\"Thermal\",\"reading\":351,\"last_polled\":\"0000-00-00 00:00:00\",\"configuration\":[],\"created_at\":\"2026-07-10 09:50:02\",\"updated_at\":\"2026-07-10 09:50:02\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/client\/services\/{id}\/sensors?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/client\/services\/{id}\/sensors\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Show sensor", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/sensors\/:sensorId", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/sensors\/:sensorId", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the service." }, { "id": "sensorId", "key": "sensorId", "value": "11", "description": "The ID of the sensor." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Display detailed information about a single sensor associated with the service by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":712,\"item_id\":1067,\"name\":\"consequuntur\",\"class\":\"Power Supply\",\"type\":\"Thermal\",\"unit\":\"Voltages\",\"index\":\"Thermal\",\"reading\":348,\"last_polled\":\"0000-00-00 00:00:00\",\"configuration\":[],\"created_at\":\"2026-07-10 09:50:03\",\"updated_at\":\"2026-07-10 09:50:03\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] } ] }, { "name": "Graphs", "description": "", "item": [ { "name": "Export Graph", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/graphs\/:id\/export", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/graphs\/:id\/export", "variable": [ { "id": "id", "key": "id", "value": "42", "description": "The ID of the target." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"AggregateTraffic\",\"target\":\"service\",\"start\":\"2025-04-01 00:00:00\",\"end\":\"2025-04-30 23:59:59\",\"raw\":false}" }, "description": "Exports a graph data for a given target" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"datasets\":[{\"data\":[\"0.00186\",\"0.00000\",\"0.00231\",\"0.00231\",\"0.00228\",\"0.00229\",\"0.00006\",\"0.00219\",\"0.00245\",\"0.00336\",\"0.00337\",\"0.00191\",\"0.00000\"],\"dataset_name\":\"inboundtotal\"},{\"data\":[\"0.00045\",\"0.00046\",\"0.00321\",\"0.00321\",\"0.00000\",\"0.00232\",\"0.00198\",\"0.00193\",\"0.00036\",\"0.00036\",\"0.00145\",\"0.00286\",\"0.00000\"],\"dataset_name\":\"outboundtotal\"},{\"data\":[\"0.00232\",\"0.00046\",\"0.00552\",\"0.00552\",\"0.00228\",\"0.00461\",\"0.00204\",\"0.00412\",\"0.00281\",\"0.00372\",\"0.00482\",\"0.00478\",\"0.00000\"],\"dataset_name\":\"totalboundbits\"},{\"data\":[\"0.00336\",\"0.00336\",\"0.00336\",\"0.00336\",\"0.00336\",\"0.00336\",\"0.00336\",\"0.00336\",\"0.00336\",\"0.00336\",\"0.00336\",\"0.00336\",\"0.00336\"],\"dataset_name\":\"95_percentile\"}],\"labels\":[\"2025-10-21 13:35:00\",\"2025-10-21 13:40:00\",\"2025-10-21 13:45:00\",\"2025-10-21 13:50:00\",\"2025-10-21 13:55:00\",\"2025-10-21 14:00:00\",\"2025-10-21 14:05:00\",\"2025-10-21 14:10:00\",\"2025-10-21 14:15:00\",\"2025-10-21 14:20:00\",\"2025-10-21 14:25:00\",\"2025-10-21 14:30:00\",\"2025-10-21 14:35:00\"]},\"legend\":{\"header\":[\"Current\",\"Average\",\"Maximum\",\"95th %\"],\"rows\":[{\"label\":\"In\",\"color\":\"#62C45E\",\"values\":[632798.1868925721,1372582.1214573288,2053141.22367529,2053141.22367529]},{\"label\":\"Out\",\"color\":\"#2BA7FF\",\"values\":[639398.799042107,1396441.8722763401,1919831.1749942221,1919831.1749942221]}],\"format\":\"bits\",\"footer\":\"Total 670.81 GB (In 332.34 GB Out 338.47 GB)\"},\"units\":{\"traffic\":\"Mbps\",\"power_usage\":\"Amps\"},\"precision\":{\"traffic\":\"2\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] } ] }, { "name": "OS Installation", "description": "", "item": [ { "name": "List ISO Images", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/os\/isoimages", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, name, iso_url, status.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, name, iso_url, status.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/client\/os\/isoimages?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of ISO images available to the authenticated client." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":92,\"name\":\"illum-iso\",\"iso_url\":\"http:\/\/spinka.com\/cumque-molestiae-dolor-consequuntur-optio.html\",\"status\":1,\"download\":{\"status\":\"waiting\",\"message\":\"Waiting for ISO image download to start...\"},\"created_at\":\"2026-07-10 09:51:26\",\"updated_at\":\"2026-07-10 09:51:26\"},{\"id\":93,\"name\":\"rerum-iso\",\"iso_url\":\"http:\/\/hoeger.com\/\",\"status\":1,\"download\":{\"status\":\"waiting\",\"message\":\"Waiting for ISO image download to start...\"},\"created_at\":\"2026-07-10 09:51:26\",\"updated_at\":\"2026-07-10 09:51:26\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/client\/os\/isoimages?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/client\/os\/isoimages\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Create ISO Image", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/os\/isoimages", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/os\/isoimages" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Ubuntu Server ISO\",\"iso_url\":\"https:\\\/\\\/example.com\\\/images\\\/ubuntu.iso\"}" }, "description": "Creates a new ISO image for the authenticated client." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":94,\"name\":\"voluptates-iso\",\"iso_url\":\"https:\/\/reilly.com\/tempore-quaerat-voluptate-quia-rerum-sit-quas.html\",\"status\":1,\"download\":{\"status\":\"waiting\",\"message\":\"Waiting for ISO image download to start...\"},\"created_at\":\"2026-07-10 09:51:26\",\"updated_at\":\"2026-07-10 09:51:26\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Update ISO Image", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/os\/isoimages\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/os\/isoimages\/:id", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "The ID of the ISO image to update." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Updated ISO Name\"}" }, "description": "Updates the name of an existing ISO image for the authenticated client." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":95,\"name\":\"consequatur-iso\",\"iso_url\":\"http:\/\/okon.com\/quibusdam-tempore-aperiam-qui-adipisci-id-consequuntur-reiciendis\",\"status\":1,\"download\":{\"status\":\"waiting\",\"message\":\"Waiting for ISO image download to start...\"},\"created_at\":\"2026-07-10 09:51:26\",\"updated_at\":\"2026-07-10 09:51:26\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Delete ISO Image", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/os\/isoimages\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/os\/isoimages\/:id", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "The ID of the ISO image to delete." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes a specific ISO image belonging to the authenticated client." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "List OS Templates", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/os\/templates", "query": [ { "key": "with_addons", "value": "1", "description": "Optional. If set to true, includes a list of addons for each template.", "disabled": false }, { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, name, edition, architecture, family.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, name, edition, architecture, tags, family.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/os\/templates?with_addons=1&per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of OS templates available for the given service.\n\nOptionally, you can include a list of addons (based on template tags) by using the `with_addons` query parameter." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":219,\"template_id\":219,\"name\":\"mollitia\",\"tags\":[\"nihil\",\"impedit\",\"vel\",\"soluta\",\"pariatur\",\"itaque\"],\"architecture\":\"x86\",\"cache_folder\":\"sint\",\"mirror\":\"http:\/\/www.schowalter.biz\/totam-ad-esse-odio-quia-quaerat-id\",\"edition\":\"ad\",\"iso_url\":\"http:\/\/gleichner.com\/ut-et-accusamus-illo-mollitia-fugit-quod\",\"tftp_url\":\"http:\/\/www.blick.com\/aut-quia-alias-aut-praesentium-quos-aut.html\",\"license\":\"commodi\",\"gpxe\":\"Porro ut adipisci nam quis non perferendis corporis.\",\"disk_layout\":\"Ea perferendis rem quam nihil vero est ab ipsum.\",\"packages\":\"Perferendis non incidunt magnam officia deleniti et.\",\"post_installation\":\"Optio architecto veritatis hic aut et.\",\"first_boot\":\"Quia cum officiis quasi dolorum perspiciatis quasi.\",\"extras\":\"Error magnam aut et aliquid ipsum ut placeat atque.\",\"timezone\":\"Pacific\/Chatham\",\"language\":\"ha\",\"family\":\"\",\"is_windows\":false,\"is_rescue\":false},{\"id\":220,\"template_id\":220,\"name\":\"saepe\",\"tags\":[\"et\",\"delectus\",\"ut\",\"aut\",\"cumque\",\"iste\"],\"architecture\":\"x64\",\"cache_folder\":\"vero\",\"mirror\":\"http:\/\/wolff.net\/quaerat-aspernatur-minus-et-cupiditate-a-nesciunt-eius.html\",\"edition\":\"illum\",\"iso_url\":\"http:\/\/www.kemmer.com\/ipsum-corrupti-at-ab-sint-atque-non.html\",\"tftp_url\":\"https:\/\/parker.com\/doloribus-explicabo-doloribus-autem-ab-suscipit-vero.html\",\"license\":\"quis\",\"gpxe\":\"Qui sit officiis odit dolorum quidem mollitia minima.\",\"disk_layout\":\"Voluptas voluptatem ipsum et modi animi ut.\",\"packages\":\"Alias sed ipsum dolor dolorum voluptas.\",\"post_installation\":\"Odit exercitationem alias illum totam et et fugit.\",\"first_boot\":\"Eum earum ut consectetur culpa quia atque.\",\"extras\":\"Necessitatibus recusandae minima necessitatibus sunt cum nostrum quod.\",\"timezone\":\"America\/Detroit\",\"language\":\"rw\",\"family\":\"\",\"is_windows\":false,\"is_rescue\":false}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/client\/services\/{id}\/os\/templates?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/client\/services\/{id}\/os\/templates\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "List OS Addons", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/os\/addons", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, name, type.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, name, type, tag.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/os\/addons?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of OS addons available for the given service." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":86,\"name\":\"Sadie Medhurst\",\"description\":\"Autem et placeat aliquam est sint pariatur.\",\"type\":\"firstboot\",\"tag\":\"explicabo non\",\"tags\":[\"explicabo\",\"non\"],\"data\":\"Quia doloribus ut a.\"},{\"id\":87,\"name\":\"Prof. Garry Goodwin DDS\",\"description\":\"Sunt similique vel accusamus inventore consequatur ipsam sapiente.\",\"type\":\"disklayout\",\"tag\":\"qui cumque\",\"tags\":[\"qui\",\"cumque\"],\"data\":\"Autem veritatis accusamus culpa error nobis tempora.\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/client\/services\/{id}\/os\/addons?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/client\/services\/{id}\/os\/addons\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Install OS on Device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/os\/install", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/os\/install", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"template\":12,\"hostname\":\"server01.example.com\",\"username\":\"admin\",\"password\":\"secret123\",\"root_password\":\"rootsecret\",\"disk_addon\":1,\"extras\":[16],\"ssh_keys\":[8]}" }, "description": "Initiates OS installation on a device assigned to the given service" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":191,\"device_id\":1108,\"template_id\":221,\"message\":\"Aut voluptatem nostrum consequuntur vitae nam.\",\"log\":\"\",\"created_at\":\"2026-07-10 09:51:27\",\"updated_at\":\"2026-07-10 09:51:27\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Cancel OS Installation", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/os\/cancel", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/os\/cancel", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Attempts to cancel the operating system installation process" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "OS Installation Information", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/os\/install\/information", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/os\/install\/information", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns details about the current OS installation process" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":192,\"device_id\":1109,\"template_id\":222,\"message\":\"Deserunt quasi temporibus dignissimos itaque eos consectetur.\",\"log\":\"\",\"created_at\":\"2026-07-10 09:51:27\",\"updated_at\":\"2026-07-10 09:51:27\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Enable Rescue Mode", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/os\/rescue\/enable", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/os\/rescue\/enable", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Initiates rescue mode for the device assigned to the given service" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":193,\"device_id\":1110,\"template_id\":223,\"message\":\"Sunt inventore autem maxime omnis.\",\"log\":\"\",\"created_at\":\"2026-07-10 09:51:28\",\"updated_at\":\"2026-07-10 09:51:28\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Rescue Mode Status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/os\/rescue\/status", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/os\/rescue\/status", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the current rescue mode status" }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"inRescueMode\":false}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Lock OS Installation", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/os\/lock", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/os\/lock", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Added in 1.25.1<\/small>\nLocks the OS installation process for this device, preventing any OS reinstallation." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Unlock OS Installation", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/os\/unlock", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/os\/unlock", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Added in 1.25.1<\/small>\nUnlocks the OS installation process for this device." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] } ] }, { "name": "IPMI", "description": "", "item": [ { "name": "BMC Cold Reset", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/ipmi\/bmc-reset-cold", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/ipmi\/bmc-reset-cold", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Sends a cold reset command to the BMC (Baseboard Management Controller) of the device associated with the given service.\nThis action forces a full reboot of the BMC, which may temporarily interrupt device management features." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Start noVNC Session", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/ipmi\/novnc-connect", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/ipmi\/novnc-connect", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Initiates a remote IPMI proxy session to the BMC of the device associated with the given service.\nThe proxy allows web-based access to the BMC for remote management tasks like KVM, virtual media, or BIOS configuration.\n\nIf a session cannot be established, an error with logs may be returned for debugging purposes." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"id\":91,\"device_id\":1118,\"url\":\"https:\/\/192.168.203.150\/client\/console\/35762\/uEaQQKFF\/c1cd80059d82afc5a33a9195b7924161a0a8c40e\",\"status\":1,\"message\":\"Enim sit est necessitatibus ipsum.\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Show IPMI console session information", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/ipmi\/console\/information", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/ipmi\/console\/information" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"password\":\"3bf5By\",\"port\":5901,\"token\":\"1784360e52abb6d874b92747ea9df6fabde33a20\"}" }, "description": "Retrieves session-related data for an active IPMI proxy session", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status\": \"success\",\n \"message\": \"success\",\n \"data\": {\n \"ipmi_username\": \"ipmi_username\",\n \"ipmi_password\": \"ipmi_password\",\n \"disable_login_buttons\": \"0\"\n }\n}", "name": "" } ] }, { "name": "Update IPMI session activity", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/ipmi\/console\/activity", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/ipmi\/console\/activity" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"password\":\"3bf5By\",\"port\":5901,\"token\":\"1784360e52abb6d874b92747ea9df6fabde33a20\"}" }, "description": "Updates the `updated_at` timestamp of an active IPMI proxy session.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status\": \"success\",\n \"message\": \"2025-10-21 15:06:20\",\n \"data\": null\n}", "name": "" } ] }, { "name": "Close IPMI session", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/ipmi\/console\/close", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/ipmi\/console\/close" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"password\":\"3bf5By\",\"port\":5901,\"token\":\"1784360e52abb6d874b92747ea9df6fabde33a20\"}" }, "description": "Terminates the IPMI proxy session. This is typically used when the user exits the remote console.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"status\": \"success\",\n \"message\": \"success\",\n \"data\": null\n}", "name": "" } ] } ] }, { "name": "Two-Factor Authentication", "description": "", "item": [ { "name": "Enable two-factor authentication", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/two-factor\/enable", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/two-factor\/enable" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"module_name\":\"Totp\"}" }, "description": "Initializes the selected 2FA module for the logged-in client and returns configuration data\nsuch as a QR code and secret needed to complete setup." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"Two-factor authentication has been enabled successfully.\",\"data\":{\"qr_code\":\"data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAANwAAADcAQMAAAAhlF3CAAAABlBMVEX\/\/\/8AAABVwtN+AAAACXBIWXMAAA7EAAAOxAGVKw4bDDDCGUlEQVRYhe2YPW7DMAyFGXjw6CPoJvbFBMiAL5bcREfwqMEI+x6lxGmQWSzQaCgSfRpYPv5G5Hv+00mqug9ZLnqEsuxR9IYbvbrBKHLZU9bbnnTkPb6KjI4w4H7Qws9l0S2P9swZ0lpdA66SlssfgIL76Qij8tO7tb0h9YyBUmaR6YPYnaFFPOH55y0dOsN27L7M0yofTlcIa2ke9RTomTJebLn4wUGpYtYGJcCbIs19HhA5t9SqSRsnbfL6QaTgHYZa2AOsMt5PUT0gCiYNlYX39By+rqdvPSA+tDKud0GRorWjH0zZPAc9lXFu8p5iO0AzD7VytnLFRkdrWwp6wCFb4snMFKT7kIzMSDeYmHiIKHa7wheYB45TTweoCPaNpXPLJqos6LzqBxFb9oITibZgbwngAxP1HFgTUKkW+pBF9Klnf4gAu7KzceC2Co7pbchnxDvAx9xvL9TsDo6QkyRHOKtPmE04WG4qfjAy51axHQk1wZaT4dyR+kOU8dm6HadaZZRxWHKEdQOQ2lcYW6ovW6QPvFaTEWVqixJEfejpA20bmSetmxFeHOHlX+kNm6jwXLQixaqJwuUHbUfiGrDXjbb+BKB+0LZIMQHpSOsr8amnB2TER6sJnE0wuFFPb8jOC0NtkrRt6TU\/PWCkofYCzYV9ZXSEth6ZqMJtKQj73mNwcYAt4qEi2hsGtzoZ\/E6HrvB7vgfnBzwswUtTyEcKAAAAAElFTkSuQmCC\",\"secret_word\":\"DPVKWEKE6EOWOKWR\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Disable two-factor authentication", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/two-factor\/disable", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/two-factor\/disable" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"password\":\"user_current_password\"}" }, "description": "Validates the user's password and, if correct, disables 2FA and removes any stored configuration." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"Two-factor authentication has been disabled successfully.\",\"data\":null}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Store and verify 2FA configuration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/two-factor\/store", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/two-factor\/store" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"module_name\":\"Totp\",\"configuration\":{\"code\":\"123456\",\"secret_word\":\"JBSWY3DPEHPK3PXP\"}}" }, "description": "Verifies the provided 2FA code and secret, and stores the configuration if verification succeeds.\nAlso returns a backup code for account recovery." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"backup_code\":\"Wsg4Q 1ieF9 Rw6ID DIBrb\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Validate the second-factor authentication code after login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/two-factor\/validate", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/two-factor\/validate" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"configuration\":{\"code\":\"123456\"}}" }, "description": "Verifies the submitted 2FA code using the user's default 2FA module.\nOn success, marks the session as 2FA-authenticated." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] }, { "name": "Log in using a backup 2FA code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/two-factor\/backup-code", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/two-factor\/backup-code" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"MY-BACKUP-CODE-123\"}" }, "description": "Validates the backup code stored during 2FA setup and marks the session as verified." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":{\"backup_code\":\"Wsg4Q 1ieF9 Rw6ID DIBrb\"}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Unauthorized admin access only.|You do not have the appropriate rights for this action.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.\"}", "name": "Not Found" } ] } ] }, { "name": "IP Address Management", "description": "", "item": [ { "name": "List of IP addresses", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/ipaddresses", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, item_id, value, description, type, ip_type.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "value", "description": "Optional. Restrict search to specific fields. Allowed: value, description, type, ip_type.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/ipaddresses?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=value", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint returns a paginated collection of IP addresses associated with\nthe specified service." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":265,\"item_id\":38,\"device_label\":\"#38 web-prod-01 (PowerEdge R640)\",\"value\":\"200.94.209.231\",\"description\":\"\",\"type\":\"primary\",\"ip_type\":\"ipv4\",\"subnet\":{\"id\":12,\"pool\":\"200.94.209.0\",\"mask\":24,\"cidr\":\"200.94.209.0\/24\"},\"vlan\":{\"id\":7,\"name\":\"Production\",\"vlan_id\":100}},{\"id\":307,\"item_id\":44,\"value\":\"146.224.170.224\",\"description\":\"\",\"type\":\"primary\",\"ip_type\":\"ipv4\"},{\"id\":314,\"item_id\":45,\"value\":\"139.235.236.138\",\"description\":\"\",\"type\":\"primary\",\"ip_type\":\"ipv4\"},{\"id\":328,\"item_id\":47,\"value\":\"207.243.68.21\",\"description\":\"\",\"type\":\"primary\",\"ip_type\":\"ipv4\"},{\"id\":335,\"item_id\":48,\"value\":\"46.236.68.242\",\"description\":\"\",\"type\":\"primary\",\"ip_type\":\"ipv4\"},{\"id\":342,\"item_id\":49,\"value\":\"166.73.24.58\",\"description\":\"\",\"type\":\"primary\",\"ip_type\":\"ipv4\"},{\"id\":356,\"item_id\":51,\"value\":\"160.24.83.37\",\"description\":\"\",\"type\":\"primary\",\"ip_type\":\"ipv4\"},{\"id\":363,\"item_id\":52,\"value\":\"80.24.122.22\",\"description\":\"\",\"type\":\"primary\",\"ip_type\":\"ipv4\"},{\"id\":370,\"item_id\":53,\"value\":\"174.251.45.79\",\"description\":\"\",\"type\":\"primary\",\"ip_type\":\"ipv4\"},{\"id\":377,\"item_id\":54,\"value\":\"155.150.252.1\",\"description\":\"\",\"type\":\"primary\",\"ip_type\":\"ipv4\"}],\"links\":{\"first\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=1\",\"last\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=16\",\"prev\":null,\"next\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=2\"},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":16,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=2\",\"label\":\"2\",\"page\":2,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=3\",\"label\":\"3\",\"page\":3,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=4\",\"label\":\"4\",\"page\":4,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=5\",\"label\":\"5\",\"page\":5,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=6\",\"label\":\"6\",\"page\":6,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=7\",\"label\":\"7\",\"page\":7,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=8\",\"label\":\"8\",\"page\":8,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=9\",\"label\":\"9\",\"page\":9,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=10\",\"label\":\"10\",\"page\":10,\"active\":false},{\"url\":null,\"label\":\"...\",\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=15\",\"label\":\"15\",\"page\":15,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=16\",\"label\":\"16\",\"page\":16,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips?page=2\",\"label\":\"Next »\",\"page\":2,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/admin\/ipam\/ips\",\"per_page\":10,\"to\":10,\"total\":151,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Update IP address description", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/ipaddresses\/:entityId", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/ipaddresses\/:entityId", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." }, { "id": "entityId", "key": "entityId", "value": "456", "description": "The ID of the IP address entity." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"description\":\"Primary IP for web server\",\"ip_address\":\"192.168.56.1\"}" }, "description": "Updates the description of an IP address entity associated with the device assigned to the specified service." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "List of subnets", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/subnets", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, pool, mask, gateway, type.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "pool", "description": "Optional. Restrict search to specific fields. Allowed: pool, gateway, type.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/subnets?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=pool", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint returns a paginated collection of subnets associated with\nthe specified service." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":124,\"subnet\":\"118.163.50.0\/24\",\"pool\":\"118.163.50.0\",\"mask\":24,\"gateway\":null,\"type\":\"ipv4\"},{\"id\":125,\"subnet\":\"101.160.74.0\/24\",\"pool\":\"101.160.74.0\",\"mask\":24,\"gateway\":null,\"type\":\"ipv4\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/client\/services\/{id}\/subnets?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/client\/services\/{id}\/subnets\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] } ] }, { "name": "DNS Management", "description": "", "item": [ { "name": "List rDNS records", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/rdns", "query": [ { "key": "per_page", "value": "10", "description": "The number of items per page (min:1, max:100).", "disabled": false }, { "key": "page", "value": "1", "description": "The page number of results to return.", "disabled": false }, { "key": "sort_by", "value": "id", "description": "The field to sort by. Allowed: id, device_id, user_id, server_id, ip, from, name, ttl, created_at.", "disabled": false }, { "key": "sort_dir", "value": "asc", "description": "The direction of sorting. Allowed values: asc, desc.", "disabled": false }, { "key": "search_term", "value": "active%2Cpending", "description": "Search value. For in\/not_in provide comma-separated. For between provide two values comma-separated (from,to).", "disabled": false }, { "key": "search_op", "value": "like", "description": "How to apply search_term. Allowed: like (default), in, not_in, eq, neq, gt, gte, lt, lte, between.", "disabled": false }, { "key": "search_fields", "value": "id", "description": "Optional. Restrict search to specific fields. Allowed: id, device_id, user_id, server_id, ip, from, name, created_at.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/rdns?per_page=10&page=1&sort_by=id&sort_dir=asc&search_term=active%2Cpending&search_op=like&search_fields=id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint returns a paginated list of reverse DNS (rDNS) entries associated\nwith the device assigned to the specified service." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\",\"data\":[{\"id\":61,\"device_id\":1125,\"user_id\":5821,\"server_id\":91,\"ip\":\"194.126.98.255\",\"from\":\"osinski.com\",\"name\":\"fisher.com\",\"ttl\":\"3600\",\"created_at\":\"2026-07-10 09:51:37\",\"updated_at\":\"2026-07-10 09:51:37\"},{\"id\":62,\"device_id\":1126,\"user_id\":5829,\"server_id\":92,\"ip\":\"226.150.102.116\",\"from\":\"monahan.com\",\"name\":\"cruickshank.com\",\"ttl\":\"3600\",\"created_at\":\"2026-07-10 09:51:37\",\"updated_at\":\"2026-07-10 09:51:37\"}],\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"https:\/\/your-easydcim.com\/api\/v3\/client\/services\/{id}\/rdns?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"https:\/\/your-easydcim.com\/api\/v3\/client\/services\/{id}\/rdns\",\"per_page\":10,\"to\":1,\"total\":2,\"sort_by\":\"\",\"sort_dir\":null}}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Create rDNS record", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/rdns", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/rdns", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ip\":\"192.168.1.1\",\"rdata\":\"example.mydomain.com\",\"ttl\":3600}" }, "description": "Stores a new reverse DNS (rDNS) entry for the device assigned to the given service." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Update rDNS record", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/rdns\/:recordId", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/rdns\/:recordId", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." }, { "id": "recordId", "key": "recordId", "value": "456", "description": "The ID of the rDNS record." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"rdata\":\"updated.example.net\",\"ttl\":3600}" }, "description": "Updates an existing reverse DNS (rDNS) record." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] }, { "name": "Delete rDNS record", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/client\/services\/:id\/rdns\/:recordId", "query": [], "raw": "{{baseUrl}}\/api\/v3\/client\/services\/:id\/rdns\/:recordId", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the service." }, { "id": "recordId", "key": "recordId", "value": "456", "description": "The ID of the rDNS record." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes a reverse DNS (rDNS) record that belongs to the device assigned to the specified service." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"status\":\"success\",\"message\":\"success\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Missing bearer token.|Invalid bearer token|Token not provided.\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Your account is inactive or banned.|Your access token does not have permission to impersonate other users.|Only admin users are allowed to impersonate other users.\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"success\":false,\"status\":\"error\",\"message\":\"Requested resource not found.|Impersonated user not found.|Service not found, inactive, or does not belong to you.|The requested entity does not exist or does not belong to you.\"}", "name": "Not Found" } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "key", "type": "string" } ] } }